[ aws . bedrock-agent-runtime ]

retrieve

Description

Queries a knowledge base and retrieves information from it.

See also: AWS API Documentation

retrieve uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

retrieve is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: retrievalResults

Synopsis

  retrieve
--knowledge-base-id <value>
[--retrieval-configuration <value>]
--retrieval-query <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--knowledge-base-id (string)

The unique identifier of the knowledge base to query.

--retrieval-configuration (structure)

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations .

vectorSearchConfiguration -> (structure)

Contains details about how the results from the vector search should be returned. For more information, see Query configurations .

filter -> (tagged union structure)

Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, equals, greaterThan, greaterThanOrEquals, in, lessThan, lessThanOrEquals, notEquals, notIn, orAll, startsWith.

andAll -> (list)

Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

(tagged union structure)

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations .

This data type is used in the following API operations:

• Retrieve request – in the filter field
• RetrieveAndGenerate request – in the filter field

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, equals, greaterThan, greaterThanOrEquals, in, lessThan, lessThanOrEquals, notEquals, notIn, orAll, startsWith.

andAll -> (list)

Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

( … recursive … )

equals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

greaterThan -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

greaterThanOrEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

in -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

lessThan -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

lessThanOrEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

notEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn’t match the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

notIn -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn’t in the list specified in the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

orAll -> (list)

Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

( … recursive … )

startsWith -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

equals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

greaterThan -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

greaterThanOrEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

in -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

lessThan -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

lessThanOrEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

notEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn’t match the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

notIn -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn’t in the list specified in the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

orAll -> (list)

Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

(tagged union structure)

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations .

This data type is used in the following API operations:

• Retrieve request – in the filter field
• RetrieveAndGenerate request – in the filter field

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, equals, greaterThan, greaterThanOrEquals, in, lessThan, lessThanOrEquals, notEquals, notIn, orAll, startsWith.

andAll -> (list)

Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

( … recursive … )

equals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

greaterThan -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

greaterThanOrEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

in -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

lessThan -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

lessThanOrEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

notEquals -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn’t match the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

notIn -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn’t in the list specified in the value in this object are returned.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

orAll -> (list)

Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

( … recursive … )

startsWith -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

startsWith -> (structure)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

key -> (string)

The name that the metadata attribute must match.

value -> (document)

The value to whcih to compare the value of the metadata attribute.

numberOfResults -> (integer)

The number of source chunks to retrieve.

overrideSearchType -> (string)

By default, Amazon Bedrock decides a search strategy for you. If you’re using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base .

JSON Syntax:

{
  "vectorSearchConfiguration": {
    "filter": {
      "andAll": [
        {
          "andAll": [
            { ... recursive ... }
            ...
          ],
          "equals": {
            "key": "string",
            "value": {...}
          },
          "greaterThan": {
            "key": "string",
            "value": {...}
          },
          "greaterThanOrEquals": {
            "key": "string",
            "value": {...}
          },
          "in": {
            "key": "string",
            "value": {...}
          },
          "lessThan": {
            "key": "string",
            "value": {...}
          },
          "lessThanOrEquals": {
            "key": "string",
            "value": {...}
          },
          "notEquals": {
            "key": "string",
            "value": {...}
          },
          "notIn": {
            "key": "string",
            "value": {...}
          },
          "orAll": [
            { ... recursive ... }
            ...
          ],
          "startsWith": {
            "key": "string",
            "value": {...}
          }
        }
        ...
      ],
      "equals": {
        "key": "string",
        "value": {...}
      },
      "greaterThan": {
        "key": "string",
        "value": {...}
      },
      "greaterThanOrEquals": {
        "key": "string",
        "value": {...}
      },
      "in": {
        "key": "string",
        "value": {...}
      },
      "lessThan": {
        "key": "string",
        "value": {...}
      },
      "lessThanOrEquals": {
        "key": "string",
        "value": {...}
      },
      "notEquals": {
        "key": "string",
        "value": {...}
      },
      "notIn": {
        "key": "string",
        "value": {...}
      },
      "orAll": [
        {
          "andAll": [
            { ... recursive ... }
            ...
          ],
          "equals": {
            "key": "string",
            "value": {...}
          },
          "greaterThan": {
            "key": "string",
            "value": {...}
          },
          "greaterThanOrEquals": {
            "key": "string",
            "value": {...}
          },
          "in": {
            "key": "string",
            "value": {...}
          },
          "lessThan": {
            "key": "string",
            "value": {...}
          },
          "lessThanOrEquals": {
            "key": "string",
            "value": {...}
          },
          "notEquals": {
            "key": "string",
            "value": {...}
          },
          "notIn": {
            "key": "string",
            "value": {...}
          },
          "orAll": [
            { ... recursive ... }
            ...
          ],
          "startsWith": {
            "key": "string",
            "value": {...}
          }
        }
        ...
      ],
      "startsWith": {
        "key": "string",
        "value": {...}
      }
    },
    "numberOfResults": integer,
    "overrideSearchType": "HYBRID"|"SEMANTIC"
  }
}

--retrieval-query (structure)

Contains the query to send the knowledge base.

text -> (string)

The text of the query made to the knowledge base.

Shorthand Syntax:

text=string

JSON Syntax:

{
  "text": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

nextToken -> (string)

If there are more results than can fit in the response, the response returns a nextToken . Use this token in the nextToken field of another request to retrieve the next batch of results.

retrievalResults -> (list)

A list of results from querying the knowledge base.

(structure)

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

• Retrieve response – in the retrievalResults field

content -> (structure)

Contains a chunk of text from a data source in the knowledge base.

text -> (string)

The cited text from the data source.

location -> (structure)

Contains information about the location of the data source.

s3Location -> (structure)

Contains the S3 location of the data source.

uri -> (string)

The S3 URI of the data source.

type -> (string)

The type of the location of the data source.

metadata -> (map)

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering .

key -> (string)

value -> (document)

score -> (double)

The level of relevance of the result to the query.