AgentsforBedrockRuntime / Paginator / Retrieve

Retrieve

class AgentsforBedrockRuntime.Paginator.Retrieve

paginator = client.get_paginator('retrieve')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgentsforBedrockRuntime.Client.retrieve().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    knowledgeBaseId='string',
    retrievalConfiguration={
        'vectorSearchConfiguration': {
            'numberOfResults': 123,
            'overrideSearchType': 'HYBRID'|'SEMANTIC'
        }
    },
    retrievalQuery={
        'text': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• knowledgeBaseId (string) –

  [REQUIRED]

  The unique identifier of the knowledge base to query.

• retrievalConfiguration (dict) –

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

  • vectorSearchConfiguration (dict) – [REQUIRED]

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

    • 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.

• retrievalQuery (dict) –

  [REQUIRED]

  Contains the query to send the knowledge base.

  • text (string) – [REQUIRED]

    The text of the query made to the knowledge base.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'retrievalResults': [
        {
            'content': {
                'text': 'string'
            },
            'location': {
                's3Location': {
                    'uri': 'string'
                },
                'type': 'S3'
            },
            'score': 123.0
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • retrievalResults (list) –

    A list of results from querying the knowledge base.

    • (dict) –

      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 (dict) –

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

        • text (string) –

          The cited text from the data source.

      • location (dict) –

        Contains information about the location of the data source.

        • s3Location (dict) –

          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.

      • score (float) –

        The level of relevance of the result to the query.

  • NextToken (string) –

    A token to resume pagination.