Class FacetKey (0.13.11) 

FacetKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Specifies how a facet is computed.

Attributes
Name Description
key str
Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
intervals MutableSequence[google.cloud.discoveryengine_v1beta.types.Interval]
Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
restricted_values MutableSequence[str]
Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
prefixes MutableSequence[str]
Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
contains MutableSequence[str]
Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
case_insensitive bool
True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
order_by str
The order in which documents are returned. Allowed values are: - "count desc", which means order by SearchResponse.Facet.values.count descending. - "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in `natural order