Cloudflare VectorizeInstall

Overview

This node integrates with Cloudflare Vectorize, a vector database service designed for managing and querying vector embeddings. It supports operations on vector indexes such as creating, listing, deleting, and retrieving index information. The node is useful in scenarios involving semantic search, recommendation systems, or any application requiring similarity search over high-dimensional vectors.

For the Index - List operation specifically, the node lists all available vector indexes in the connected Cloudflare Vectorize account. This is beneficial when you want to retrieve an overview of all your existing vector indexes to manage or select one for further operations.

Practical example:

• You have multiple vector indexes for different datasets (e.g., product embeddings, user profiles) and want to display or choose from them dynamically in your workflow. Using this node’s list operation, you can fetch all indexes and use their names downstream.

Properties

For the List operation on the Index resource, no input properties are required.

Output

The output JSON contains two main fields:

• indexes: An array of objects representing each vector index available in the account. Each object typically includes metadata about the index such as its name, configuration, and description.
• count: The total number of indexes returned.

Example output structure:

{
  "indexes": [
    {
      "name": "example-index",
      "description": "An example vector index",
      "config": {
        "dimensions": 1536,
        "metric": "cosine"
      },
      // ... other index details
    }
    // ... more indexes
  ],
  "count": 1
}

This output allows workflows to iterate over or select from existing vector indexes.

Dependencies

• Requires an API key credential for authenticating with the Cloudflare Vectorize service.
• The node depends on utility functions (CloudflareVectorizeUtils) that handle API requests to Cloudflare Vectorize.
• Proper network access to Cloudflare Vectorize endpoints is necessary.

Troubleshooting

• Common issues:

  • Authentication failures due to invalid or missing API credentials.
  • Network connectivity problems preventing access to Cloudflare Vectorize.
  • Permissions issues if the API key does not have rights to list indexes.

• Error messages:

  • "Unknown resource: index": Occurs if the resource parameter is incorrectly set; ensure it is exactly "index".
  • "Unknown index operation: list": Indicates an unsupported operation was requested; verify the operation parameter is "list".
  • API errors related to authentication or rate limits will be passed through; check your API key validity and usage quotas.

• Resolutions:

  • Verify and configure the correct API key credential in n8n.
  • Confirm the resource and operation parameters are correctly set.
  • Check network connectivity and firewall settings.
  • Review Cloudflare Vectorize account permissions and quota.

Links and References

• Cloudflare Vectorize Documentation
• Semantic Search and Vector Databases Overview
• n8n Documentation on Creating Custom Nodes