FeaturedResultsItem ¶

class FeaturedResultsItem(TypedDict, closed=True):
    id: NotRequired["capo_kendra.types.result_id.ResultId"]
    """<p>The identifier of the featured result.</p>"""
    type: NotRequired["capo_kendra.types.query_result_type.QueryResultType"]
    """<p>The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.</p>"""
    additional_attributes: NotRequired[
        "capo_kendra.types.additional_result_attribute_list.AdditionalResultAttributeList"
    ]
    """<p>One or more additional attributes associated with the featured result.</p>"""
    document_id: NotRequired["capo_kendra.types.document_id.DocumentId"]
    """<p>The identifier of the featured 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 source URI location of the featured document.</p>"""
    document_attributes: NotRequired[
        "capo_kendra.types.document_attribute_list.DocumentAttributeList"
    ]
    """<p>An array of document attributes assigned to a featured 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>"""
    feedback_token: NotRequired["capo_kendra.types.feedback_token.FeedbackToken"]
    """<p>A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html">Submitting feedback</a>.</p>"""