Skip to content

SourceDocument

Source code in docs_src/capo_kendra/types/source_document.py 
13
14
15
16
17
18
19
20
21
22
23
class SourceDocument(TypedDict, closed=True):
    document_id: NotRequired["capo_kendra.types.string.String"]
    """<p>The identifier of the document used for a query suggestion.</p>"""
    suggestion_attributes: NotRequired[
        "capo_kendra.types.document_attribute_key_list.DocumentAttributeKeyList"
    ]
    """<p>The document fields/attributes used for a query suggestion.</p>"""
    additional_attributes: NotRequired[
        "capo_kendra.types.document_attribute_list.DocumentAttributeList"
    ]
    """<p>The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.</p>"""

additional_attributes instance-attribute 

additional_attributes: NotRequired[DocumentAttributeList]

The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

document_id instance-attribute 

document_id: NotRequired[String]

The identifier of the document used for a query suggestion.

suggestion_attributes instance-attribute 

suggestion_attributes: NotRequired[DocumentAttributeKeyList]

The document fields/attributes used for a query suggestion.