Cloudflare vector store

The CloudflareVector class provides vector search using Cloudflare Vectorize, a vector database service integrated with Cloudflare's edge network.

Constructor options

accountId:

string

Cloudflare account ID

apiToken:

string

Cloudflare API token with Vectorize permissions

Methods

createIndex()

indexName:

string

Name of the index to create

dimension:

number

Vector dimension (must match your embedding model)

metric?:

'cosine' | 'euclidean' | 'dotproduct'

= cosine

Distance metric for similarity search (dotproduct maps to dot-product)

upsert()

indexName:

string

Name of the index to upsert into

vectors:

number[][]

Array of embedding vectors

metadata?:

Record<string, any>[]

Metadata for each vector

ids?:

string[]

Optional vector IDs (auto-generated if not provided)

query()

indexName:

string

Name of the index to query

queryVector:

number[]

Query vector to find similar vectors

topK?:

number

= 10

Number of results to return

filter?:

Record<string, any>

Metadata filters for the query

includeVector?:

boolean

= false

Whether to include vectors in the results

listIndexes()

Returns an array of index names as strings.

describeIndex()

indexName:

string

Name of the index to describe

Returns:

interface IndexStats {
  dimension: number
  count: number
  metric: 'cosine' | 'euclidean' | 'dotproduct'
}

deleteIndex()

indexName:

string

Name of the index to delete

createMetadataIndex()

Creates an index on a metadata field to enable filtering.

indexName:

string

Name of the index containing the metadata field

propertyName:

string

Name of the metadata field to index

indexType:

'string' | 'number' | 'boolean'

Type of the metadata field

deleteMetadataIndex()

Removes an index from a metadata field.

indexName:

string

Name of the index containing the metadata field

propertyName:

string

Name of the metadata field to remove indexing from

listMetadataIndexes()

Lists all metadata field indexes for an index.

indexName:

string

Name of the index to list metadata indexes for

updateVector()

Updates the vector and optionally the metadata for a specific ID within an index. Vectorize has no partial-update operation, so update.vector is required. Metadata-only updates aren't supported and throw an error.

indexName:

string

Name of the index containing the ID to update

id:

string

Unique identifier of the vector or metadata to update

update:

{ vector: number[]; metadata?: Record<string, any>; }

Object containing the new vector values, and optionally the metadata to update. The vector values are required

deleteVector()

Deletes a vector and its associated metadata for a specific ID within an index.

indexName:

string

Name of the index containing the ID to delete

id:

string

Unique identifier of the vector and metadata to delete

deleteVectors()

Deletes multiple vectors and their associated metadata by ID. Vectorize has no filtered-delete operation, so deleting by metadata filter isn't supported and throws an error.

indexName:

string

Name of the index containing the vectors to delete

ids:

string[]

Unique identifiers of the vectors to delete. Must contain at least one ID, and cannot be combined with filter

filter?:

Record<string, any>

Not supported by Vectorize. Passing a filter throws an error

Response types

Query results are returned in this format:

interface QueryResult {
  id: string
  score: number
  metadata: Record<string, any>
  vector?: number[]
}

Error handling

The store throws typed errors that can be caught:

try {
  await store.query({
    indexName: 'index_name',
    queryVector: queryVector,
  })
} catch (error) {
  if (error instanceof VectorStoreError) {
    console.log(error.code) // 'connection_failed' | 'invalid_dimension' | etc
    console.log(error.details) // Additional error context
  }
}

Environment variables

Required environment variables:

• CLOUDFLARE_ACCOUNT_ID: Your Cloudflare account ID
• CLOUDFLARE_API_TOKEN: Your Cloudflare API token with Vectorize permissions

Related

• Metadata Filters