AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.
docs(blocks): clarify HumanInTheLoop output descriptions for agent builder (#12069)
Otto36aeb0b2b3d0
diff --git a/autogpt_platform/backend/backend/blocks/human_in_the_loop.py b/autogpt_platform/backend/backend/blocks/human_in_the_loop.pyindex 568ac4b33f..d31f90ec81 100644--- a/autogpt_platform/backend/backend/blocks/human_in_the_loop.py+++ b/autogpt_platform/backend/backend/blocks/human_in_the_loop.py@@ -21,43 +21,71 @@ logger = logging.getLogger(__name__)class HumanInTheLoopBlock(Block):"""- This block pauses execution and waits for human approval or modification of the data.-- When executed, it creates a pending review entry and sets the node execution status- to REVIEW. The execution will remain paused until a human user either:- - Approves the data (with or without modifications)- - Rejects the data-- This is useful for workflows that require human validation or intervention before- proceeding to the next steps.+ Pauses execution and waits for human approval or rejection of the data.++ When executed, this block creates a pending review entry and sets the node execution+ status to REVIEW. The execution remains paused until a human user either approves+ or rejects the data.++ **How it works:**+ - The input data is presented to a human reviewer+ - The reviewer can approve or reject (and optionally modify the data if editable)+ - On approval: the data flows out through the `approved_data` output pin+ - On rejection: the data flows out through the `rejected_data` output pin++ **Important:** The output pins yield the actual data itself, NOT status strings.+ The approval/rejection decision determines WHICH output pin fires, not the value.+ You do NOT need to compare the output to "APPROVED" or "REJECTED" - simply connect+ downstream blocks to the appropriate output pin for each case.++ **Example usage:**+ - Connect `approved_data` → next step in your workflow (data was approved)+ - Connect `rejected_data` → error handling or notification (data was rejected)"""class Input(BlockSchemaInput):- data: Any = SchemaField(description="The data to be reviewed by a human user")+ data: Any = SchemaField(+ description="The data to be reviewed by a human user. "+ "This exact data will be passed through to either approved_data or "+ "rejected_data output based on the reviewer's decision."+ )name: str = SchemaField(- description="A descriptive name for what this data represents",+ description="A descriptive name for what this data represents. "+ "This helps the reviewer understand what they are reviewing.",)editable: bool = SchemaField(- description="Whether the human reviewer can edit the data",+ description="Whether the human reviewer can edit the data before "+ "approving or rejecting it",default=True,advanced=True,)class Output(BlockSchemaOutput):approved_data: Any = SchemaField(- description="The data when approved (may be modified by reviewer)"+ description="Outputs the input data when the reviewer APPROVES it. "+ "The value is the actual data itself (not a status string like 'APPROVED'). "+ "If the reviewer edited the data, this contains the modified version. "+ "Connect downstream blocks here for the 'approved' workflow path.")rejected_data: Any = SchemaField(- description="The data when rejected (may be modified by reviewer)"+ description="Outputs the input data when the reviewer REJECTS it. "+ "The value is the actual data itself (not a status string like 'REJECTED'). "+ "If the reviewer edited the data, this contains the modified version. "+ "Connect downstream blocks here for the 'rejected' workflow path.")review_message: str = SchemaField(- description="Any message provided by the reviewer", default=""+ description="Optional message provided by the reviewer explaining their "+ "decision. Only outputs when the reviewer provides a message; "+ "this pin does not fire if no message was given.",+ default="",)def __init__(self):super().__init__(id="8b2a7b3c-6e9d-4a5f-8c1b-2e3f4a5b6c7d",- description="Pause execution and wait for human approval or modification of data",+ description="Pause execution for human review. Data flows through "+ "approved_data or rejected_data output based on the reviewer's decision. "+ "Outputs contain the actual data, not status strings.",categories={BlockCategory.BASIC},input_schema=HumanInTheLoopBlock.Input,output_schema=HumanInTheLoopBlock.Output,diff --git a/docs/integrations/README.md b/docs/integrations/README.mdindex 97a4d98709..a471ef3533 100644--- a/docs/integrations/README.md+++ b/docs/integrations/README.md@@ -61,7 +61,7 @@ Below is a comprehensive list of all available blocks, categorized by their prim| [Get List Item](block-integrations/basic.md#get-list-item) | Returns the element at the given index || [Get Store Agent Details](block-integrations/system/store_operations.md#get-store-agent-details) | Get detailed information about an agent from the store || [Get Weather Information](block-integrations/basic.md#get-weather-information) | Retrieves weather information for a specified location using OpenWeatherMap API |-| [Human In The Loop](block-integrations/basic.md#human-in-the-loop) | Pause execution and wait for human approval or modification of data |+| [Human In The Loop](block-integrations/basic.md#human-in-the-loop) | Pause execution for human review || [List Is Empty](block-integrations/basic.md#list-is-empty) | Checks if a list is empty || [List Library Agents](block-integrations/system/library_operations.md#list-library-agents) | List all agents in your personal library || [Note](block-integrations/basic.md#note) | A visual annotation block that displays a sticky note in the workflow editor for documentation and organization purposes |diff --git a/docs/integrations/block-integrations/basic.md b/docs/integrations/block-integrations/basic.mdindex 5a73fd5a03..08def38ede 100644--- a/docs/integrations/block-integrations/basic.md+++ b/docs/integrations/block-integrations/basic.md@@ -975,7 +975,7 @@ A travel planning application could use this block to provide users with current## Human In The Loop### What it is-Pause execution and wait for human approval or modification of data+Pause execution for human review. Data flows through approved_data or rejected_data output based on the reviewer's decision. Outputs contain the actual data, not status strings.### How it works<!-- MANUAL: how_it_works -->@@ -988,18 +988,18 @@ This enables human oversight at critical points in automated workflows, ensuring| Input | Description | Type | Required ||-------|-------------|------|----------|-| data | The data to be reviewed by a human user | Data | Yes |-| name | A descriptive name for what this data represents | str | Yes |-| editable | Whether the human reviewer can edit the data | bool | No |+| data | The data to be reviewed by a human user. This exact data will be passed through to either approved_data or rejected_data output based on the reviewer's decision. | Data | Yes |+| name | A descriptive name for what this data represents. This helps the reviewer understand what they are reviewing. | str | Yes |+| editable | Whether the human reviewer can edit the data before approving or rejecting it | bool | No |### Outputs| Output | Description | Type ||--------|-------------|------|| error | Error message if the operation failed | str |-| approved_data | The data when approved (may be modified by reviewer) | Approved Data |-| rejected_data | The data when rejected (may be modified by reviewer) | Rejected Data |-| review_message | Any message provided by the reviewer | str |+| approved_data | Outputs the input data when the reviewer APPROVES it. The value is the actual data itself (not a status string like 'APPROVED'). If the reviewer edited the data, this contains the modified version. Connect downstream blocks here for the 'approved' workflow path. | Approved Data |+| rejected_data | Outputs the input data when the reviewer REJECTS it. The value is the actual data itself (not a status string like 'REJECTED'). If the reviewer edited the data, this contains the modified version. Connect downstream blocks here for the 'rejected' workflow path. | Rejected Data |+| review_message | Optional message provided by the reviewer explaining their decision. Only outputs when the reviewer provides a message; this pin does not fire if no message was given. | str |### Possible use case<!-- MANUAL: use_case -->