Cloudflare VectorizeInstall

Overview

This node integrates with Cloudflare Vectorize, a vector database service designed for semantic search and retrieval augmented generation (RAG) applications. It allows users to manage vector indexes, perform vector operations such as inserting or querying vectors, and configure metadata indexes to enable filtering during vector queries.

The Metadata - List Indexes operation specifically lists all metadata indexes configured for a given vector index. Metadata indexes enable efficient filtering on vector queries by indexing specific metadata properties.

Practical scenarios include:

• Retrieving all metadata indexes to understand which metadata fields can be used for filtering in semantic search.
• Auditing or managing metadata indexes to optimize query performance.
• Integrating with AI agents that require metadata-based filtering capabilities.

Properties

Output

The output JSON contains:

• metadataIndexes: An array listing all metadata indexes associated with the specified vector index. Each item describes a metadata property indexed for filtering.
• count: The total number of metadata indexes returned.

Example output structure:

{
  "metadataIndexes": [
    {
      "propertyName": "category",
      "type": "string"
    },
    {
      "propertyName": "rating",
      "type": "number"
    }
  ],
  "count": 2
}

This output helps users identify which metadata properties are indexed and available for filtering during vector queries.

Dependencies

• Requires an API key credential for authenticating with the Cloudflare Vectorize service.
• Relies on the external Cloudflare Vectorize API to perform metadata index management.
• The node uses utility functions from bundled helper modules to interact with the API.

Troubleshooting

• Common issues:
  • Providing an invalid or non-existent index name will likely cause errors when attempting to list metadata indexes.
  • Network or authentication failures may prevent successful API calls.
• Error messages:
  • "Unknown metadata operation": Indicates an unsupported operation was requested; ensure the operation is set to "List Indexes".
  • API errors related to authorization or resource not found should be resolved by verifying credentials and index existence.
• To resolve errors, verify the index name format (lowercase, alphanumeric, hyphens), confirm the index exists, and check API credentials.

Links and References

• Cloudflare Vectorize Documentation
• Semantic Search and Vector Databases Overview
• n8n Custom Node Development Guide