QueryResult ¶

class QueryResult(TypedDict, closed=True):
    query_id: NotRequired["capo_kendra.types.query_id.QueryId"]
    """<p>The identifier 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.query_result_item_list.QueryResultItemList"
    ]
    """<p>The results of the search.</p>"""
    facet_results: NotRequired["capo_kendra.types.facet_result_list.FacetResultList"]
    """<p>Contains the facet results. A <code>FacetResult</code> contains the counts for each field/attribute key that was specified in the <code>Facets</code> input parameter.</p>"""
    total_number_of_results: NotRequired["capo_kendra.types.integer.Integer"]
    """<p>The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.</p>"""
    warnings: NotRequired["capo_kendra.types.warning_list.WarningList"]
    """<p>A list of warning codes and their messages on problems with your query.</p> <p>Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching with advanced query syntax</a>.</p>"""
    spell_corrected_queries: NotRequired[
        "capo_kendra.types.spell_corrected_query_list.SpellCorrectedQueryList"
    ]
    """<p>A list of information related to suggested spell corrections for a query.</p>"""
    featured_results_items: NotRequired[
        "capo_kendra.types.featured_results_item_list.FeaturedResultsItemList"
    ]
    """<p>The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.</p>"""