Skip to content

CitationsDelta

Source code in docs_src/capo_bedrock_runtime/types/citations_delta.py
class CitationsDelta(TypedDict, closed=True):
    title: NotRequired["str"]
    """<p>The title or identifier of the source document being cited.</p>"""
    source: NotRequired["str"]
    """<p>The source from the original search result that provided the cited content.</p>"""
    source_content: NotRequired[
        "capo_bedrock_runtime.types.citation_source_content_list_delta.CitationSourceContentListDelta"
    ]
    """<p>The specific content from the source document that was referenced or cited in the generated response.</p>"""
    location: NotRequired[
        "capo_bedrock_runtime.types.citation_location.CitationLocation"
    ]
    """<p>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.</p>"""

location instance-attribute

location: NotRequired[CitationLocation]

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 instance-attribute

source: NotRequired[str]

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

source_content instance-attribute

source_content: NotRequired[CitationSourceContentListDelta]

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

title instance-attribute

title: NotRequired[str]

The title or identifier of the source document being cited.