Agent Retrieve

Overview

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

Note: Starting in July 2025, the output schema of Amazon Bedrock Snaps has been updated to eliminate fields with null values. This simplifies the output, making it easier to scan the fields in the preview. Additionally, the output preview displays metadata field values without needing to click through nested structures.

Agent Retrieve Overview

Prerequisites

Snap views

Type 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
Learn more about Error handling.

Snap settings

Legend:
  • Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
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
Choose 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