Actions26
- Delete Collection
- Get Collection
- Check Collection Exists
- Create Collection
- Update Collection
- Retrieve Point
- Retrieve Points
- Upsert Points
- Delete Points
- Update Vectors
- Delete Vectors
- Set Payload
- Overwrite Payload
- Delete Payload
- Clear Payload
- Batch Update Points
- Scroll Points
- Count Points
- Query Points
- Query Batch Points
- Query Points Groups
- Matrix Pairs
- Matrix Offsets
- Payload Facets
- Create Payload Index
- Delete Payload Index
Overview
The node provides an interface to the Qdrant vector search engine, specifically implementing the "Clear Payload" operation for a collection of points. This operation clears (removes) the payload data associated with specified points in a given collection. Payloads typically contain metadata or additional information attached to points.
This node is useful when you want to clean up or reset metadata on certain points without deleting the points themselves. For example, if you have a collection of vectors representing documents and you want to remove outdated tags or attributes from specific documents, this operation will clear those payload fields efficiently.
Practical examples:
- Removing sensitive or obsolete metadata from selected points before sharing or exporting data.
- Resetting payload fields to prepare points for new annotations or classifications.
- Clearing payloads conditionally based on filters or shard keys to maintain data consistency.
Properties
| Name | Meaning |
|---|---|
| Collection Name | The name of the collection in which points reside. |
| Points | A JSON array listing the IDs of points whose payloads should be cleared. |
| Filter | A JSON object specifying conditions to select points whose payloads will be cleared. |
| Shard Key | A JSON value specifying which shards to target for the operation; if omitted, all shards are used. |
| Wait | Boolean flag indicating whether to wait for the changes to be fully applied before continuing. |
| Ordering | Defines ordering guarantees for the operation; options are: Weak, Medium, Strong. |
Output
The node outputs JSON data reflecting the result of the clear payload operation. Typically, this includes confirmation of success or details about the affected points. The exact structure depends on the Qdrant API response but generally confirms that the payloads were cleared as requested.
If the node supports binary data output, it would relate to any raw responses or logs, but this operation primarily deals with JSON payload clearing, so no binary output is expected.
Dependencies
- Requires connection to a Qdrant service instance.
- Needs an API key credential for authenticating requests to Qdrant.
- The base URL for the Qdrant API must be configured in the node credentials.
- The node uses HTTP requests with JSON content type to communicate with Qdrant.
Troubleshooting
Common issues:
- Incorrect collection name: Ensure the collection exists in Qdrant.
- Invalid point IDs or empty points list: Provide valid point IDs to clear payloads.
- Malformed JSON in Points, Filter, or Shard Key fields: Validate JSON syntax carefully.
- Insufficient permissions or invalid API key: Verify API credentials and access rights.
- Network connectivity problems: Confirm the Qdrant service URL is reachable.
Error messages:
- "Collection not found": Check the collection name spelling and existence.
- "Invalid point ID": Verify that point IDs are correct and exist in the collection.
- "Unauthorized": Recheck API key or authentication setup.
- "Malformed request": Review JSON inputs for syntax errors.
Resolving these usually involves verifying input parameters, ensuring proper credentials, and confirming network access.
Links and References
- Qdrant Official Website
- Qdrant API Documentation
- n8n documentation on creating custom nodes and using HTTP request nodes for API integration