Properties
| Name | Type | Description |
|---|---|---|
| shard_key | object | |
| key | string | Payload key to use for faceting. |
| limit | integer | Max number of hits to return. Default is 10. |
| filter | object | Filter conditions - only consider points that satisfy these conditions. |
| exact | boolean | Whether to do a more expensive exact count for each of the values in the facet. Default is false. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/FacetRequest",
"title": "FacetRequest",
"type": "object",
"required": [
"key"
],
"properties": {
"shard_key": {
"anyOf": [
{
"$ref": "#/components/schemas/ShardKeySelector"
},
{
"nullable": true
}
]
},
"key": {
"description": "Payload key to use for faceting.",
"type": "string"
},
"limit": {
"description": "Max number of hits to return. Default is 10.",
"type": "integer",
"format": "uint",
"minimum": 1,
"nullable": true
},
"filter": {
"description": "Filter conditions - only consider points that satisfy these conditions.",
"anyOf": [
{
"$ref": "#/components/schemas/Filter"
},
{
"nullable": true
}
]
},
"exact": {
"description": "Whether to do a more expensive exact count for each of the values in the facet. Default is false.",
"type": "boolean",
"nullable": true
}
}
}