FacetResult interface

Package:

@azure/search-documents

A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval.

Properties

avg	The resulting total avg for the facet when a avg metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.
cardinality	The resulting total cardinality for the facet when a cardinality metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.
count	The approximate count of documents falling within the bucket described by this facet. NOTE: This property will not be serialized. It can only be populated by the server.
facets	The nested facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not contain any nested facets. NOTE: This property will not be serialized. It can only be populated by the server.
max	The resulting total max for the facet when a max metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.
min	The resulting total min for the facet when a min metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.
sum	The resulting total sum for the facet when a sum metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

avg

The resulting total avg for the facet when a avg metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.

avg?: number

Property Value

number

cardinality

The resulting total cardinality for the facet when a cardinality metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.

cardinality?: number

Property Value

number

count

The approximate count of documents falling within the bucket described by this facet. NOTE: This property will not be serialized. It can only be populated by the server.

count?: number

Property Value

number

facets

The nested facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not contain any nested facets. NOTE: This property will not be serialized. It can only be populated by the server.

facets?: {[propertyName: string]: FacetResult[]}

Property Value

{[propertyName: string]: FacetResult[]}

max

The resulting total max for the facet when a max metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.

max?: number

Property Value

number

min

The resulting total min for the facet when a min metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.

min?: number

Property Value

number

sum

The resulting total sum for the facet when a sum metric is requested. NOTE: This property will not be serialized. It can only be populated by the server.

sum?: number

Property Value

number