RetrievedReference¶
Structure Class¶
dataclass
¶
Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
-
RetrieveAndGenerate response -- in the
retrievedReferencesfield -
InvokeAgent response -- in the
retrievedReferencesfield
Attributes¶
class-attribute
instance-attribute
¶
content: RetrievalResultContent | None = field(repr=False, default=None)
Contains the cited text from the data source.
class-attribute
instance-attribute
¶
location: RetrievalResultLocation | None = field(repr=False, default=None)
Contains information about the location of the data source.
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.