Agent Retrieve

Overview

You can use this Snap to query a knowledge base and retrieve information from it based on the specified prompt.


Agent Retrieve Overview

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 Retrieval query field.
Note: If you select the Binary input view, the Retrieval query field is hidden.
Output This Snap has at the most one document output view. The output document contains content, data, location, and metadata. 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: Agent Retrieve

Example: Retrieve Federal Fire Data
Knowledge base ID String/Expression/Suggestion

Required. Specify the unique identifier of the Knowledge base that is queried. The suggested option for the Knowledge base is in the following format:

KNOWLEDGE_BASE_ID:KNOWLEDGE_BASE_NAME

Default value: N/A

Example: YJ4ASDF84:samplekb
Retrieval query String/Expression
Required. Specify the query to send to the knowledge base.
Note: If you select the Binary input view, the Retrieval query field is hidden.

Default value: N/A

Example: "What is the number of Federal fires in 2018?"
Retrieve options Use this field set to configure the retrieve options to use for the request.
Number of results Integer/Expression
Required. Specify the number of source chunks to retrieve.
Note: If you do not provide any value in this field, Amazon Bedrock uses the default value.

Minimum value: 1

Maximum value: 100

Default value: N/A

Example: 100
Search type Dropdown list/Expression
Choose the type of resource to query. The available options are:
  • DEFAULT: Allows Amazon Bedrock to determine the Search type to use.
  • SEMANTIC: Uses only vector embeddings.
  • HYBRID: Uses both vector embeddings and raw text. HYBRID is only valid if you are using an Amazon OpenSearch Serverless vector store that contains a filterable text field.
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 retrieve.

The value for the Retrieval query field is missing.

Provide a value for the Retrieval query field.

Examples