Skip to content

RetrievedReference

Source code in docs_src/capo_bedrock_agent_runtime/types/retrieved_reference.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class RetrievedReference(TypedDict, closed=True):
    content: NotRequired[
        "capo_bedrock_agent_runtime.types.retrieval_result_content.RetrievalResultContent"
    ]
    """<p>Contains the cited text from the data source.</p>"""
    location: NotRequired[
        "capo_bedrock_agent_runtime.types.retrieval_result_location.RetrievalResultLocation"
    ]
    """<p>Contains information about the location of the data source.</p>"""
    metadata: NotRequired[
        "capo_bedrock_agent_runtime.types.retrieval_result_metadata.RetrievalResultMetadata"
    ]
    """<p>Contains metadata attributes and their values for the file in the data source. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata">Metadata and filtering</a>.</p>"""

content instance-attribute 

content: NotRequired[RetrievalResultContent]

Contains the cited text from the data source.

location instance-attribute 

location: NotRequired[RetrievalResultLocation]

Contains information about the location of the data source.

metadata instance-attribute 

metadata: NotRequired[RetrievalResultMetadata]

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