Skip to content

AttributeSuggestionsUpdateConfig

Used by
Source code in docs_src/capo_kendra/types/attribute_suggestions_update_config.py 
12
13
14
15
16
17
18
19
20
class AttributeSuggestionsUpdateConfig(TypedDict, closed=True):
    suggestable_config_list: NotRequired[
        "capo_kendra.types.suggestable_config_list.SuggestableConfigList"
    ]
    """<p>The list of fields/attributes that you want to set as suggestible for query suggestions.</p>"""
    attribute_suggestions_mode: NotRequired[
        "capo_kendra.types.attribute_suggestions_mode.AttributeSuggestionsMode"
    ]
    """<p>You can set the mode to <code>ACTIVE</code> or <code>INACTIVE</code>. You must also set <code>SuggestionTypes</code> as either <code>QUERY</code> or <code>DOCUMENT_ATTRIBUTES</code> and then call <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html">GetQuerySuggestions</a>. If <code>Mode</code> to use query history is set to <code>ENABLED</code> when calling <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a> and <code>AttributeSuggestionsMode</code> to use fields/attributes is set to <code>ACTIVE</code>, and you haven't set your <code>SuggestionTypes</code> preference to <code>DOCUMENT_ATTRIBUTES</code>, then Amazon Kendra uses the query history.</p>"""

attribute_suggestions_mode instance-attribute 

attribute_suggestions_mode: NotRequired[AttributeSuggestionsMode]

You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.

suggestable_config_list instance-attribute 

suggestable_config_list: NotRequired[SuggestableConfigList]

The list of fields/attributes that you want to set as suggestible for query suggestions.