Skip to content

RetrieveResponse

Source code in docs_src/capo_bedrock_agent_runtime/types/retrieve_response.py 
15
16
17
18
19
20
21
22
23
class RetrieveResponse(TypedDict, closed=True):
    retrieval_results: "capo_bedrock_agent_runtime.types.knowledge_base_retrieval_results.KnowledgeBaseRetrievalResults"
    """<p>A list of results from querying the knowledge base.</p>"""
    guardrail_action: NotRequired[
        "capo_bedrock_agent_runtime.types.guadrail_action.GuadrailAction"
    ]
    """<p>Specifies if there is a guardrail intervention in the response.</p>"""
    next_token: NotRequired["capo_bedrock_agent_runtime.types.next_token.NextToken"]
    """<p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>"""

guardrail_action instance-attribute 

guardrail_action: NotRequired[GuadrailAction]

Specifies if there is a guardrail intervention in the response.

next_token instance-attribute 

next_token: NotRequired[NextToken]

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.

retrieval_results instance-attribute 

retrieval_results: KnowledgeBaseRetrievalResults

A list of results from querying the knowledge base.