Skip to content

RelevantContent

Source code in docs_src/capo_qbusiness/types/relevant_content.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class RelevantContent(TypedDict, closed=True):
    content: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The actual content of the relevant item.</p>"""
    document_id: NotRequired["capo_qbusiness.types.document_id.DocumentId"]
    """<p>The unique identifier of the document containing the relevant content.</p>"""
    document_title: NotRequired["capo_qbusiness.types.title.Title"]
    """<p>The title of the document containing the relevant content.</p>"""
    document_uri: NotRequired["capo_qbusiness.types.url.Url"]
    """<p>The URI of the document containing the relevant content.</p>"""
    document_attributes: NotRequired[
        "capo_qbusiness.types.document_attributes.DocumentAttributes"
    ]
    """<p>Additional attributes of the document containing the relevant content.</p>"""
    score_attributes: NotRequired[
        "capo_qbusiness.types.score_attributes.ScoreAttributes"
    ]
    """<p>Attributes related to the relevance score of the content.</p>"""

content instance-attribute 

content: NotRequired[String]

The actual content of the relevant item.

document_attributes instance-attribute 

document_attributes: NotRequired[DocumentAttributes]

Additional attributes of the document containing the relevant content.

document_id instance-attribute 

document_id: NotRequired[DocumentId]

The unique identifier of the document containing the relevant content.

document_title instance-attribute 

document_title: NotRequired[Title]

The title of the document containing the relevant content.

document_uri instance-attribute 

document_uri: NotRequired[Url]

The URI of the document containing the relevant content.

score_attributes instance-attribute 

score_attributes: NotRequired[ScoreAttributes]

Attributes related to the relevance score of the content.