Skip to content

RetrieveResult

Source code in docs_src/capo_kendra/types/retrieve_result.py 
12
13
14
15
16
17
18
class RetrieveResult(TypedDict, closed=True):
    query_id: NotRequired["capo_kendra.types.query_id.QueryId"]
    """<p>The identifier of query used for the search. You also use <code>QueryId</code> to identify the search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">Submitfeedback</a> API.</p>"""
    result_items: NotRequired[
        "capo_kendra.types.retrieve_result_item_list.RetrieveResultItemList"
    ]
    """<p>The results of the retrieved relevant passages for the search.</p>"""

query_id instance-attribute 

query_id: NotRequired[QueryId]

The identifier of query used for the search. You also use QueryId to identify the search when using the Submitfeedback API.

result_items instance-attribute 

result_items: NotRequired[RetrieveResultItemList]

The results of the retrieved relevant passages for the search.