Skip to content

SuggestableConfig

Source code in docs_src/capo_kendra/types/suggestable_config.py
class SuggestableConfig(TypedDict, closed=True):
    attribute_name: NotRequired[
        "capo_kendra.types.document_attribute_key.DocumentAttributeKey"
    ]
    """<p>The name of the document field/attribute.</p>"""
    suggestable: NotRequired["capo_kendra.types.object_boolean.ObjectBoolean"]
    """<p> <code>TRUE</code> means the document field/attribute is suggestible, so the contents within the field can be used for query suggestions.</p>"""

attribute_name instance-attribute

attribute_name: NotRequired[DocumentAttributeKey]

The name of the document field/attribute.

suggestable instance-attribute

suggestable: NotRequired[ObjectBoolean]

TRUE means the document field/attribute is suggestible, so the contents within the field can be used for query suggestions.