ComfyUI Node: Prompt Stash Passthrough

Prompt Stash Passthrough:

The PromptStashPassthrough node is designed to facilitate the management and modification of text prompts within a workflow, particularly in scenarios where user interaction is required to edit or update prompts. This node allows for the seamless integration of user input into automated processes by providing a mechanism to pause execution, enabling users to make necessary edits to the prompt text before continuing. The node's primary function is to ensure that the workflow can be dynamically adjusted based on user input, enhancing flexibility and control over the creative process. By allowing for pauses and edits, it ensures that the final output aligns more closely with the user's artistic vision, making it an invaluable tool for AI artists who wish to maintain a high degree of interactivity and customization in their workflows.

Prompt Stash Passthrough Input Parameters:

use_input_text

This parameter is a boolean option that determines whether the node should use the provided input text or the default prompt text. When set to True, the node will prioritize the input text over the prompt text, allowing for dynamic updates based on user input. The default value is False, meaning the node will use the prompt text unless specified otherwise. This option is useful for scenarios where the input text needs to be dynamically altered during the workflow.

text

The text parameter is a string input that allows users to provide optional text that can be used in place of the default prompt text. This parameter is marked as forceInput, meaning it requires user input when use_input_text is enabled. It is designed to be lazy-loaded, ensuring that the text is only processed when necessary. This flexibility allows users to inject specific content into the workflow, enhancing the customization of the output.

prompt_text

This parameter is a multiline string input that serves as the default text prompt for the node. Users can enter the desired prompt text here, which will be used unless overridden by the text parameter. The prompt_text acts as the foundational content for the node's operations, providing a starting point for any modifications or interactions that occur during the workflow.

pause_to_edit

The pause_to_edit parameter is a boolean option that, when enabled, pauses the node's execution to allow users to edit the prompt text. This feature is particularly useful for workflows that require user intervention to refine or adjust the prompt before proceeding. The default value is False, meaning the node will not pause unless explicitly instructed to do so. This option enhances the interactivity of the workflow, giving users the opportunity to make real-time adjustments.

unique_id

This hidden parameter is used internally to uniquely identify each instance of the node within a workflow. It ensures that the node's operations are correctly tracked and managed, particularly when handling pauses and edits. This parameter is not intended for user modification.

extra_pnginfo

Another hidden parameter, extra_pnginfo, is used to store additional metadata related to the workflow. It can include information such as the workflow structure or other relevant data that may be needed for processing. This parameter is managed internally and is not exposed to users.

prompt

The prompt hidden parameter is used to store the current state of the prompt, including any modifications made during the workflow. It ensures that the node can accurately reflect the latest version of the prompt text, maintaining consistency across the workflow. This parameter is crucial for managing the dynamic aspects of the node's operations.

Prompt Stash Passthrough Output Parameters:

text

The output parameter text is a string that represents the final version of the prompt text after any modifications or user interactions have been applied. This output is crucial for ensuring that the workflow continues with the most up-to-date and relevant prompt, reflecting any changes made during the pause-to-edit phase. It serves as the primary output of the node, providing the necessary content for subsequent nodes or processes in the workflow.

Prompt Stash Passthrough Usage Tips:

• To maximize the node's flexibility, consider enabling pause_to_edit when you anticipate needing to make real-time adjustments to the prompt text. This allows for greater control over the final output.
• Use the use_input_text parameter to dynamically switch between default prompts and user-provided text, enabling more adaptive workflows that can respond to changing requirements or inputs.

Prompt Stash Passthrough Common Errors and Solutions:

Node remains paused indefinitely

• Explanation: This issue may occur if the node is set to pause for editing, but the continue signal is not received, possibly due to network issues or misconfiguration.
• Solution: Ensure that the frontend is correctly configured to send the continue signal and that there are no connectivity issues. Verify that the node ID is correctly passed in the continue request.

Edited text not applied

• Explanation: This error can happen if the edited text is not correctly stored or retrieved during the pause-to-edit process.
• Solution: Check that the edited text is correctly sent from the frontend and that the node's internal storage (edited_text_by_id) is updated. Ensure that the node ID matches between the frontend and backend.