Actions27
- Collection Actions
- Payload Actions
- Point Actions
- Search Actions
- Vector Actions
Payload → Create Payload Index
AI-generatedOverview
This node operation creates an index on a specified field within a collection in Qdrant. It is useful for optimizing search and retrieval performance on that field. For example, if you have a collection of documents and want to speed up queries filtering by a specific field, you can create an index on that field using this operation.
Use Case Examples
- Creating an index on the 'author' field in a 'books' collection to speed up author-based searches.
- Indexing a 'category' field in a product catalog to improve filtering performance.
Properties
| Name | Meaning |
|---|---|
| Collection Name | Specifies the collection in which the index will be created. It can be selected from a list of existing collections or entered by name. |
| Field Name | The name of the field within the collection to create the index for. |
| Field Schema | The JSON schema defining the structure of the field to be indexed. |
| Wait | Boolean flag indicating whether to wait for the index creation operation to complete before proceeding. |
| Ordering | Defines the ordering guarantees for the index creation operation, affecting consistency and performance. |
| Request Options | Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration. |
Output
JSON
success- Indicates whether the index creation operation was successful.details- Additional details or response data from the index creation operation.
Dependencies
- Qdrant REST API
- An API key credential for authentication
Troubleshooting
- Ensure the collection name exists and is correctly specified; otherwise, the operation will fail.
- Verify the field name and schema are valid and conform to Qdrant's expected format.
- If the 'Wait' option is enabled, the operation may take longer; consider disabling it for asynchronous behavior.
- Check network connectivity and proxy settings if requests fail.
- If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
Links
- Qdrant Payload Index Documentation - Official documentation on payload indexes in Qdrant, explaining their purpose and usage.