Actions27
- Collection Actions
- Payload Actions
- Point Actions
- Search Actions
- Vector Actions
Payload → Payload Facets
AI-generatedOverview
This node operation interacts with the Qdrant vector search engine to retrieve facet information from the payload of points within a specified collection. It is useful for analyzing and summarizing the distribution of values for a specific payload key across points in a collection, which can help in data exploration, filtering, and aggregation tasks.
Use Case Examples
- A user wants to get a summary of all unique values and their counts for a specific attribute (payload key) in a collection of points to understand the data distribution.
- A user applies filters and limits to retrieve facet counts only for points that meet certain criteria, enabling targeted data analysis.
Properties
| Name | Meaning |
|---|---|
| Collection Name | Specifies the name of the collection from which to retrieve payload facets. It can be selected from a list of collections or entered by name. |
| Key | The payload key for which to compute facets, i.e., the attribute in the payload to analyze. |
| Filter | JSON object defining conditions to filter points before faceting, allowing selection of only points that satisfy these conditions. |
| Limit | Maximum number of facet results to return, controlling the size of the output. |
| Exact | Boolean flag to indicate whether to perform an exact count for each facet value, which is more computationally expensive but accurate. |
| Shard Key | JSON object specifying which shards to search within; if not set, all shards are searched. |
| Consistency | Defines the read consistency guarantees for the operation, with options like Majority, Quorum, or All. |
| Timeout | Overrides the global timeout for this request in seconds. |
| Request Options | Additional request settings such as batching, SSL certificate validation, proxy configuration, and HTTP timeout. |
Output
JSON
facets- An array of facet objects representing the distribution of values for the specified payload key within the collection.
Dependencies
- Requires Qdrant REST API credentials for authentication and access to the Qdrant service.
Troubleshooting
- Common issues include incorrect collection names or keys, resulting in empty or error responses. Verify collection existence and key correctness.
- Invalid JSON in the filter or shardKey properties can cause request failures; ensure valid JSON syntax.
- Timeout errors may occur if the server is slow or the timeout is set too low; increase the timeout setting if needed.
- If exact counting is enabled, the operation may be slower or more resource-intensive; consider disabling exact if performance is a concern.
Links
- Qdrant Payload Documentation - Official documentation on payloads and faceting in Qdrant.
- Qdrant API Reference - API details for interacting with Qdrant, including payload facets endpoint.