ComfyUI Node: CreateRequestMetadata

CreateRequestMetadata:

The CreateRequestMetadata node is designed to manage and track metadata for prompt requests within your workflow. This node creates a JSON file that stores information about the state and outputs of a request, ensuring that all relevant data is systematically recorded and easily accessible. It provides static methods to access and modify this JSON file, allowing you to add resources, update the request state, and retrieve metadata as needed. The primary goal of this node is to maintain a structured and organized record of each request, which is crucial for managing complex workflows and ensuring consistency. It is important to note that only one instance of this node should be present in a prompt to avoid conflicts.

CreateRequestMetadata Input Parameters:

request_id

The request_id parameter is a string that uniquely identifies the request. It is essential for tracking and managing the metadata associated with a specific request. The request_id must be set correctly to avoid conflicts with subsequent requests. The default value is "insert_id", which should be replaced with a unique identifier for each request. If the request_id is not set or is empty, the node will raise an error, indicating that the request ID is missing or improperly set.

CreateRequestMetadata Output Parameters:

This node does not produce any direct output parameters. Instead, it updates the metadata JSON file with the relevant information about the request's state and outputs.

CreateRequestMetadata Usage Tips:

• Ensure that the request_id is unique for each request to avoid conflicts and ensure accurate tracking of metadata.
• Use the static methods provided by the node to add resources and update the request state as needed. This will help maintain a comprehensive record of the request's progress and outputs.
• Only include one instance of the CreateRequestMetadata node in your workflow to prevent conflicts and ensure that the metadata is accurately recorded.

CreateRequestMetadata Common Errors and Solutions:

Request ID in CreateRequestMetadata node with value: 'insert_id'

• Explanation: This error occurs when the request_id parameter is not properly set and retains its default value of "insert_id".
• Solution: Ensure that you set a unique request_id for each request to avoid this error.

Request ID is equal to previously set ID

• Explanation: This error indicates that the request_id for the current request is the same as a previously set ID, which can cause conflicts in metadata tracking.
• Solution: Verify that each request has a unique request_id to prevent this issue.

Metadata file not found: <filename>

• Explanation: This error occurs when the node attempts to access a metadata file that does not exist.
• Solution: Ensure that the correct request_id is set and that the metadata file is created and accessible in the specified directory.

Request ID was not set. CreateRequestMetadata node might be missing.

• Explanation: This error indicates that the request_id was not set, possibly because the CreateRequestMetadata node is missing from the workflow.
• Solution: Include the CreateRequestMetadata node in your workflow and set a valid request_id.

Request ID was set to empty. Check if it is being properly set to avoid conflicts with subsequent requests.

• Explanation: This error occurs when the request_id is set to an empty string, which can lead to conflicts with other requests.
• Solution: Ensure that the request_id is properly set to a non-empty, unique value for each request.