Skip to content

ExpandedResultItem

Source code in docs_src/capo_kendra/types/expanded_result_item.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ExpandedResultItem(TypedDict, closed=True):
    id: NotRequired["capo_kendra.types.result_id.ResultId"]
    """<p>The identifier for the expanded result.</p>"""
    document_id: NotRequired["capo_kendra.types.document_id.DocumentId"]
    """<p>The idenitifier of the document.</p>"""
    document_title: NotRequired[
        "capo_kendra.types.text_with_highlights.TextWithHighlights"
    ]
    document_excerpt: NotRequired[
        "capo_kendra.types.text_with_highlights.TextWithHighlights"
    ]
    document_uri: NotRequired["capo_kendra.types.url.Url"]
    """<p>The URI of the original location of the document.</p>"""
    document_attributes: NotRequired[
        "capo_kendra.types.document_attribute_list.DocumentAttributeList"
    ]
    """<p>An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.</p>"""

document_attributes instance-attribute 

document_attributes: NotRequired[DocumentAttributeList]

An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.

document_excerpt instance-attribute 

document_excerpt: NotRequired[TextWithHighlights]

document_id instance-attribute 

document_id: NotRequired[DocumentId]

The idenitifier of the document.

document_title instance-attribute 

document_title: NotRequired[TextWithHighlights]

document_uri instance-attribute 

document_uri: NotRequired[Url]

The URI of the original location of the document.

id instance-attribute 

id: NotRequired[ResultId]

The identifier for the expanded result.