Bedrock Agent Runtime  >  Structures  >  KnowledgeBaseRetrievalResult

KnowledgeBaseRetrievalResult

Structure Class

KnowledgeBaseRetrievalResult dataclass

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

Attributes

content class-attribute instance-attribute

content: RetrievalResultContent = field(repr=False)

Contains information about the content of the chunk.

document_id class-attribute instance-attribute

document_id: str | None = None

The unique identifier of the document. Use with GetDocumentContent to retrieve the full document.

location class-attribute instance-attribute

location: RetrievalResultLocation | None = field(repr=False, default=None)

Contains information about the location of the data source.

metadata class-attribute instance-attribute

metadata: dict[str, Document] | None = field(repr=False, default=None)

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

score class-attribute instance-attribute

score: float | None = None

The level of relevance of the result to the query.