RetrieveResultItem ¶

class RetrieveResultItem(TypedDict, closed=True):
    id: NotRequired["capo_kendra.types.result_id.ResultId"]
    """<p>The identifier of the relevant passage result.</p>"""
    document_id: NotRequired["capo_kendra.types.document_id.DocumentId"]
    """<p>The identifier of the document.</p>"""
    document_title: NotRequired["capo_kendra.types.document_title.DocumentTitle"]
    """<p>The title of the document.</p>"""
    content: NotRequired["capo_kendra.types.content.Content"]
    """<p>The contents of the relevant passage.</p>"""
    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 fields/attributes assigned to a document in the search results. For example, the document author (<code>_author</code>) or the source URI (<code>_source_uri</code>) of the document.</p>"""
    score_attributes: NotRequired["capo_kendra.types.score_attributes.ScoreAttributes"]
    """<p>The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.</p>"""