Skip to content

DocumentAttributeValueCountPair

Source code in docs_src/capo_kendra/types/document_attribute_value_count_pair.py 
13
14
15
16
17
18
19
20
21
class DocumentAttributeValueCountPair(TypedDict, closed=True):
    document_attribute_value: NotRequired[
        "capo_kendra.types.document_attribute_value.DocumentAttributeValue"
    ]
    """<p>The value of the attribute/field. For example, "HR".</p>"""
    count: NotRequired["capo_kendra.types.integer.Integer"]
    """<p>The number of documents in the response that have the attribute/field value for the key.</p>"""
    facet_results: NotRequired["capo_kendra.types.facet_result_list.FacetResultList"]
    """<p>Contains the results of a document attribute/field that is a nested facet. A <code>FacetResult</code> contains the counts for each facet nested within a facet.</p> <p>For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.</p> <p></p> <p></p>"""

count instance-attribute 

count: NotRequired[Integer]

The number of documents in the response that have the attribute/field value for the key.

document_attribute_value instance-attribute 

document_attribute_value: NotRequired[DocumentAttributeValue]

The value of the attribute/field. For example, "HR".

facet_results instance-attribute 

facet_results: NotRequired[FacetResultList]

Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.