Cloudflare 向量存储

🌐 Cloudflare Vector Store

CloudflareVector 类使用 Cloudflare Vectorize 提供向量搜索，这是一种与 Cloudflare 边缘网络集成的向量数据库服务。

🌐 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()

更新索引中某个特定 ID 的向量或元数据。

🌐 Updates a vector or metadata for a specific ID within an index.

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 vector and/or metadata to update

deleteVector()

删除索引中某个特定 ID 的向量及其相关元数据。

🌐 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

响应类型

🌐 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：你的 Cloudflare 账户 ID
• CLOUDFLARE_API_TOKEN：具有 Vectorize 权限的 Cloudflare API 令牌

相关

🌐 Related

• 元数据过滤器