KnowledgeBaseRetrievalResult¶
Structure Class¶
KnowledgeBaseRetrievalResult
dataclass
¶
Bases: _SerdeShape
Details about a result from querying the knowledge base.
This data type is used in the following API operations:
- Retrieve
response
-- in the
retrievalResultsfield
Attributes¶
content
instance-attribute
¶
content: RetrievalResultContent
Contains information about the content of the chunk.
document_id
class-attribute
instance-attribute
¶
document_id: str | None = ...
The unique identifier of the document. Use with GetDocumentContent to
retrieve the full document.
location
class-attribute
instance-attribute
¶
location: RetrievalResultLocation | None = ...
Contains information about the location of the data source.
metadata
class-attribute
instance-attribute
¶
Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.