ComfyUI Node: ⚙️ CR Get Parameter From Prompt

⚙️ CR Get Parameter From Prompt:

The CR Get Parameter From Prompt node is designed to extract specific parameters from a given prompt string. This node is particularly useful when you need to parse and retrieve values embedded within a prompt, allowing for dynamic and flexible prompt handling. By identifying and extracting parameters based on predefined search strings, this node helps streamline the process of managing and utilizing complex prompt structures. It is an essential tool for AI artists who need to manipulate and utilize prompt data efficiently, ensuring that the desired parameters are easily accessible for further processing or decision-making.

⚙️ CR Get Parameter From Prompt Input Parameters:

prompt

The prompt parameter is the input string from which the node will attempt to extract the desired parameter. This string can contain various embedded parameters that the node will search for and retrieve based on the specified search criteria. The prompt should be formatted in a way that the parameters are easily identifiable, typically using a key-value structure. There are no specific minimum or maximum values for this parameter, but it should be a well-formed string to ensure accurate extraction.

search_string

The search_string parameter specifies the key or identifier that the node will look for within the prompt. This string acts as a marker to locate the desired parameter within the prompt. The search string should be unique and clearly defined to avoid ambiguity during the extraction process. There are no specific minimum or maximum values for this parameter, but it should be a well-formed string that matches the format used in the prompt.

⚙️ CR Get Parameter From Prompt Output Parameters:

return_prompt

The return_prompt output parameter provides the original prompt string after the extraction process. This allows you to retain the original prompt for reference or further processing, ensuring that the initial data is not lost or altered during the extraction.

return_string

The return_string output parameter contains the extracted parameter value from the prompt. This string represents the value associated with the specified search string, allowing you to utilize this extracted data in subsequent operations or decision-making processes.

return_value

The return_value output parameter is an integer that indicates the success or failure of the extraction process. A value of 0 typically indicates that the extraction was unsuccessful, while a non-zero value indicates success. This parameter helps in determining the outcome of the extraction and can be used for error handling or conditional processing.

return_boolean

The return_boolean output parameter is a boolean value that indicates whether the extraction was successful. A value of True indicates a successful extraction, while False indicates failure. This parameter provides a straightforward way to check the success of the extraction process and can be used for conditional logic in subsequent operations.

show_help

The show_help output parameter provides a URL to the documentation or help page for the node. This URL directs you to additional resources and information about the node, offering guidance on its usage and capabilities. It is a useful reference for understanding the node's functionality and troubleshooting any issues that may arise.

⚙️ CR Get Parameter From Prompt Usage Tips:

• Ensure that the prompt string is well-formed and follows a consistent key-value structure to facilitate accurate parameter extraction.
• Use unique and clearly defined search strings to avoid ambiguity and ensure that the correct parameters are extracted from the prompt.
• Utilize the return_value and return_boolean output parameters to implement error handling and conditional logic based on the success of the extraction process.

⚙️ CR Get Parameter From Prompt Common Errors and Solutions:

Parameter not found in prompt

• Explanation: The specified search string was not found within the prompt, resulting in an unsuccessful extraction.
• Solution: Verify that the search string is correctly defined and matches the format used in the prompt. Ensure that the prompt contains the specified parameter.

Malformed prompt string

• Explanation: The prompt string is not well-formed, making it difficult for the node to accurately extract the desired parameter.
• Solution: Ensure that the prompt follows a consistent key-value structure and is properly formatted. Correct any syntax errors or inconsistencies in the prompt.

Extraction failed due to missing quotes

• Explanation: The parameter value is not enclosed in quotes, causing the extraction process to fail.
• Solution: Ensure that the parameter values in the prompt are enclosed in quotes to facilitate accurate extraction. Adjust the prompt format if necessary.