Skip to content

Citation

Source code in docs_src/capo_qconnect/types/citation.py
class Citation(TypedDict, closed=True):
    content_id: NotRequired["capo_qconnect.types.uuid.Uuid"]
    """<p>The identifier of the content being cited.</p>"""
    title: NotRequired["capo_qconnect.types.sensitive_string.SensitiveString"]
    """<p>The title of the cited content.</p>"""
    knowledge_base_id: NotRequired["capo_qconnect.types.uuid.Uuid"]
    """<p>The identifier of the knowledge base containing the cited content.</p>"""
    citation_span: "capo_qconnect.types.citation_span.CitationSpan"
    source_url: NotRequired["capo_qconnect.types.sensitive_string.SensitiveString"]
    """<p>The source URL for the citation.</p>"""
    reference_type: "capo_qconnect.types.reference_type.ReferenceType"
    """<p>A type to define the KB origin of a cited content</p>"""

citation_span instance-attribute

citation_span: CitationSpan

content_id instance-attribute

content_id: NotRequired[Uuid]

The identifier of the content being cited.

knowledge_base_id instance-attribute

knowledge_base_id: NotRequired[Uuid]

The identifier of the knowledge base containing the cited content.

reference_type instance-attribute

reference_type: ReferenceType

A type to define the KB origin of a cited content

source_url instance-attribute

source_url: NotRequired[SensitiveString]

The source URL for the citation.

title instance-attribute

title: NotRequired[SensitiveString]

The title of the cited content.