Skip to content

RetrievedReference

Structure Class

RetrievedReference dataclass

Bases: _SerdeShape

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

Attributes

content class-attribute instance-attribute
content: RetrievalResultContent | None = ...

Contains the cited text from the data source.

location class-attribute instance-attribute
location: RetrievalResultLocation | None = ...

Contains information about the location of the data source.

metadata class-attribute instance-attribute
metadata: dict[str, Document] | None = ...

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