Invoke Agent

Overview

You can use this Snap to invoke the Amazon Bedrock Invoke Agent operation on the Amazon Bedrock service.


Invoke Agent

Prerequisites

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap supports a maximum of one binary or document input view. The binary input is inserted into the Prompt field.
Note: If you select the Binary input view, the Prompt field is hidden.
Output This Snap has at the most one document output view. The output contains citations, text response, metadata, and traces if the Enable trace option is selected. Mapper
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when the Snap encounters an error.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Note:
  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (): Indicates that you can add fields in the field set.
  • Remove icon (): Indicates that you can remove fields from the field set.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Invoke Agent

Example: Automated Incident Response
Agent ID String/Expression/Suggestion

Required. Specify the unique identifier of the agent to use.

Default value: N/A

Example: QA88RLKS:genaiappbuilder-agent-1
Agent alias ID String/Expression

Required. Specify the corresponding alias ID of the agent.

Default value: N/A

Example: STATAILSDS:AgentTestAlias
Prompt String/Expression

Appears when you select Document as the Input type.

Required. Specify the prompt to send to the Invoke Agent endpoint as the input text.

Default value: N/A

Example: $msg
Session ID String/Expression
Specify the session's unique identifier. The ID must be a minimum of 2 and a maximum of 100 characters.
Note: You must use the same value to continue the same conversation across requests. If you do not provide a value, a random UUID is generated and used as the Session ID.

Default value: N/A

Example: $msg
Advanced configuration Use this field set to configure the options to invoke the agent.
Enable trace Checkbox/Expression

Select this checkbox to enable trace logging to trace the agent’s reasoning process.

Default status: Deselected
Snap execution Dropdown list
Select one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only. Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.

Default value: Validate & Execute

Example: Execute only

Troubleshooting

Invalid configuration to execute invoke agent.

The value for Prompt field is missing.

Specify a Prompt and try again.

Examples