Payload field facets

Retrieves facets for the specified payload field.

Request counts of points for each unique value of a payload key

keystringRequired

Payload key to use for faceting.

shard_keystring or uint64 or list of strings or uint64s or object or anyOptional

limitinteger or nullOptional>=1

Max number of hits to return. Default is 10.

filterobject or anyOptional

Filter conditions - only consider points that satisfy these conditions.

exactboolean or nullOptional

Whether to do a more expensive exact count for each of the values in the facet. Default is false.

successful operation

usageobject or any

timedouble

Time spent to process this request

statusstring

resultobject

1	from qdrant_client import QdrantClient, models
2
3	client = QdrantClient(url="http://localhost:6333")
4
5	client.facet(
6	collection_name="{collection_name}",
7	key="my-payload-key",
8	facet_filter=models.Filter(must=[models.Match("color", "red")]),
9	limit=10,
10	)