Skip to content

AttributeSuggestionsGetConfig

Used by
Source code in docs_src/capo_kendra/types/attribute_suggestions_get_config.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class AttributeSuggestionsGetConfig(TypedDict, closed=True):
    suggestion_attributes: NotRequired[
        "capo_kendra.types.document_attribute_key_list.DocumentAttributeKeyList"
    ]
    """<p>The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.</p>"""
    additional_response_attributes: NotRequired[
        "capo_kendra.types.document_attribute_key_list.DocumentAttributeKeyList"
    ]
    """<p>The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.</p>"""
    attribute_filter: NotRequired["capo_kendra.types.attribute_filter.AttributeFilter"]
    """<p>Filters the search results based on document fields/attributes.</p>"""
    user_context: NotRequired["capo_kendra.types.user_context.UserContext"]
    """<p>Applies user context filtering so that only users who are given access to certain documents see these document in their search results.</p>"""

additional_response_attributes instance-attribute 

additional_response_attributes: NotRequired[DocumentAttributeKeyList]

The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

attribute_filter instance-attribute 

attribute_filter: NotRequired[AttributeFilter]

Filters the search results based on document fields/attributes.

suggestion_attributes instance-attribute 

suggestion_attributes: NotRequired[DocumentAttributeKeyList]

The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.

user_context instance-attribute 

user_context: NotRequired[UserContext]

Applies user context filtering so that only users who are given access to certain documents see these document in their search results.