Skip to content

CitationsDelta

Structure Class

CitationsDelta dataclass

Bases: _SerdeShape

Contains incremental updates to citation information during streaming responses. This allows clients to build up citation data progressively as the response is generated.

Attributes

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

Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

source class-attribute instance-attribute
source: str | None = ...

The source from the original search result that provided the cited content.

source_content class-attribute instance-attribute
source_content: list[CitationSourceContentDelta] | None = ...

The specific content from the source document that was referenced or cited in the generated response.

title class-attribute instance-attribute
title: str | None = ...

The title or identifier of the source document being cited.