GetQuerySuggestionsRequest ¶

class GetQuerySuggestionsRequest(TypedDict, closed=True):
    index_id: "capo_kendra.types.index_id.IndexId"
    """<p>The identifier of the index you want to get query suggestions from.</p>"""
    query_text: "capo_kendra.types.suggestion_query_text.SuggestionQueryText"
    """<p>The text of a user's query to generate query suggestions.</p> <p>A query is suggested if the query prefix matches what a user starts to type as their query.</p> <p>Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.</p>"""
    max_suggestions_count: NotRequired["capo_kendra.types.integer.Integer"]
    """<p>The maximum number of query suggestions you want to show to your users.</p>"""
    suggestion_types: NotRequired["capo_kendra.types.suggestion_types.SuggestionTypes"]
    """<p>The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.</p> <p>If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.</p> <p>If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.</p>"""
    attribute_suggestions_config: NotRequired[
        "capo_kendra.types.attribute_suggestions_get_config.AttributeSuggestionsGetConfig"
    ]
    """<p>Configuration information for the document fields/attributes that you want to base query suggestions on.</p>"""