Skip to content

FacetResult

Source code in docs_src/capo_kendra/types/facet_result.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class FacetResult(TypedDict, closed=True):
    document_attribute_key: NotRequired[
        "capo_kendra.types.document_attribute_key.DocumentAttributeKey"
    ]
    """<p>The key for the facet values. This is the same as the <code>DocumentAttributeKey</code> provided in the query.</p>"""
    document_attribute_value_type: NotRequired[
        "capo_kendra.types.document_attribute_value_type.DocumentAttributeValueType"
    ]
    """<p>The data type of the facet value. This is the same as the type defined for the index field when it was created.</p>"""
    document_attribute_value_count_pairs: NotRequired[
        "capo_kendra.types.document_attribute_value_count_pair_list.DocumentAttributeValueCountPairList"
    ]
    """<p>An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.</p>"""

document_attribute_key instance-attribute 

document_attribute_key: NotRequired[DocumentAttributeKey]

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

document_attribute_value_count_pairs instance-attribute 

document_attribute_value_count_pairs: NotRequired[DocumentAttributeValueCountPairList]

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

document_attribute_value_type instance-attribute 

document_attribute_value_type: NotRequired[DocumentAttributeValueType]

The data type of the facet value. This is the same as the type defined for the index field when it was created.