Class Vectorize

Provides a TypeScript client for interacting with the Cloudflare Vectorize API.

The Vectorize class enables management and querying of vector indexes, including creating, deleting, listing, and updating indexes, as well as inserting, upserting, deleting, and querying vectors within those indexes.

Authentication is handled via Cloudflare API credentials (API key or token).

Example

const vectorize = new Vectorize({
  credentials: {
    accountId: "your-account-id",
    email: "your-email@example.com",
    apiKey: "your-api-key"
  }
});

// Create a new index
await vectorize.createVectorizeIndex({ name: "my-index", description: "Test index", config: { ... } });

// Insert vectors
const ndjson = vectorize.toNDJSON([{ id: "vec1", values: [0.1, 0.2, 0.3] }]);
await vectorize.insertVectorsIndex({ indexName: "my-index", ndjson });

// Query vectors
const result = await vectorize.queryVectors({
  indexName: "my-index",
  vector: [0.1, 0.2, 0.3],
  topK: 5
});

Remarks

All methods return Promises that resolve to the API response types.
NDJSON utilities are provided for bulk vector operations.
Error handling includes parsing Cloudflare error messages.

Index

Constructors

constructor

Methods

createVectorizeIndex deleteVectorizeIndex deleteVectorsByIdentifier getVectorizeIndex getVectorizeIndexInfo getVectorsByIdentifier insertVectorsIndex listVectorizeIndex queryVectors toNDJSON upsertVectors

Constructors

constructor

new Vectorize(options: VectorizeParams): Vectorize
Parameters
- options: VectorizeParams
Returns Vectorize
- Defined in main.ts:84

Methods

createVectorizeIndex

createVectorizeIndex(
params: CreateVectorizeIndexParams,
): Promise<CreateVectorizeIndexResponse>
Creates a new vectorize index with the specified parameters.
Parameters
- params: CreateVectorizeIndexParams
  The parameters for creating the vectorize index, including:
  
  name: The name of the index.
  
  description: A description of the index.
  
  config: Configuration options for the index.
Returns Promise<CreateVectorizeIndexResponse>
A promise that resolves to the response of the create vectorize index operation.
- Defined in main.ts:142

deleteVectorizeIndex

deleteVectorizeIndex(
params: DeleteVectorizeIndexParams,
): Promise<DeleteVectorizeIndexResponse>
Deletes a vectorize index by its name.
Parameters
- params: DeleteVectorizeIndexParams
  The parameters containing the index name to delete.
Returns Promise<DeleteVectorizeIndexResponse>
A promise that resolves with the response of the delete operation.
- Defined in main.ts:171

deleteVectorsByIdentifier

deleteVectorsByIdentifier(
params: DeleteVectorsByIdentifierParams,
): Promise<DeleteVectorsByIdentifierResponse>
Deletes vectors from the specified index by their identifiers.
Parameters
- params: DeleteVectorsByIdentifierParams
  The parameters for deleting vectors by identifier.
  - indexName
    The name of the index from which to delete vectors.
  - ids
    An array of vector identifiers to delete.
Returns Promise<DeleteVectorsByIdentifierResponse>
A promise that resolves to the response of the delete operation.
- Defined in main.ts:194

getVectorizeIndex

getVectorizeIndex(
params: GetVectorizeIndexParams,
): Promise<GetVectorizeIndexResponse>
Retrieves information about a specific vectorize index.
Parameters
- params: GetVectorizeIndexParams
  The parameters required to get the vectorize index, including the index name.
Returns Promise<GetVectorizeIndexResponse>
A promise that resolves to the response containing details of the vectorize index.
- Defined in main.ts:220

getVectorizeIndexInfo

getVectorizeIndexInfo(
params: GetVectorizeIndexInfoParams,
): Promise<GetVectorizeIndexInfoResponse>
Retrieves detailed information about a vectorize index.
Parameters
- params: GetVectorizeIndexInfoParams
  The parameters containing the index name.
Returns Promise<GetVectorizeIndexInfoResponse>
The response from the API.
- Defined in main.ts:268

getVectorsByIdentifier

getVectorsByIdentifier(
params: GetVectorsByIdentifierParams,
): Promise<GetVectorsByIdentifierResponse>
Retrieves vectors from the specified index by their unique identifiers.
Parameters
- params: GetVectorsByIdentifierParams
  The parameters for fetching vectors by identifier.
  - indexName
    The name of the index to query.
  - ids
    An array of unique identifiers for the vectors to retrieve.
Returns Promise<GetVectorsByIdentifierResponse>
A promise that resolves to the response containing the requested vectors.
- Defined in main.ts:243

insertVectorsIndex

insertVectorsIndex(
params: InsertVectorizeIndexParams,
): Promise<InsertVectorizeIndexResponse>
Inserts vectors into a specified index in the Cloudflare Vectorize service.
Parameters
- params: InsertVectorizeIndexParams
  The parameters for inserting vectors.
  - indexName
    The name of the index to insert vectors into.
  - ndjson
    The NDJSON string containing the vectors to insert.
  - unparsableBehavior
    Optional behavior for handling unparsable vectors.
Returns Promise<InsertVectorizeIndexResponse>
A promise that resolves to the response of the insert operation.
- Defined in main.ts:292

listVectorizeIndex

listVectorizeIndex(): Promise<ListVectorizeIndexResponse>
Retrieves a list of vectorize indexes from the Cloudflare Vectorize API.

Returns Promise<ListVectorizeIndexResponse>
A promise that resolves to a ListVectorizeIndexResponse containing the vectorize index data.
Example
```
const indexes = await listVectorizeIndex();
```
- Defined in main.ts:323

queryVectors

queryVectors(params: QueryVectorsParams): Promise<QueryVectorsResponse>
Queries a vector index with the provided vector and optional filters.
Parameters
- params: QueryVectorsParams
  The parameters for querying vectors.
  - indexName
    The name of the vector index to query.
  - vector
    The query vector to search with.
  - filter
    Optional filter to apply to the query.
  - returnMetadata
    Specifies the metadata to return ("none" by default).
  - returnValues
    Optional flag to indicate if vector values should be returned.
  - topK
    The number of top results to return.
Returns Promise<QueryVectorsResponse>
A promise that resolves to the query response containing matched vectors and metadata.
- Defined in main.ts:348

toNDJSON

toNDJSON(items: object[]): string
Converts an array of objects into an NDJSON (Newline Delimited JSON) string.

Each object in the input array is serialized to a JSON string and separated by a newline character.
Parameters
- items: object[]
  An array of objects to be converted to NDJSON format.
Returns string
A string representing the NDJSON serialization of the input objects.
- Defined in main.ts:419

upsertVectors

upsertVectors(params: UpsertVectorsParams): Promise<UpsertVectorsResponse>
Upserts vectors into the specified index.

Sends a POST request to the {indexName}/upsert endpoint with NDJSON data. Optionally handles unparsable vectors according to the provided behavior.
Parameters
- params: UpsertVectorsParams
  The parameters for upserting vectors.
  - indexName
    The name of the index to upsert vectors into.
  - ndjson
    The NDJSON string containing vector data.
  - unparsableBehavior
    Optional behavior for handling unparsable vectors.
Returns Promise<UpsertVectorsResponse>
A promise that resolves to the upsert vectors response.
- Defined in main.ts:388

Class Vectorize

Example

Remarks

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Vectorize

Methods

createVectorizeIndex

Parameters

Returns Promise<CreateVectorizeIndexResponse>

deleteVectorizeIndex

Parameters

Returns Promise<DeleteVectorizeIndexResponse>

deleteVectorsByIdentifier

Parameters

indexName

ids

Returns Promise<DeleteVectorsByIdentifierResponse>

getVectorizeIndex

Parameters

Returns Promise<GetVectorizeIndexResponse>

getVectorizeIndexInfo

Parameters

Returns Promise<GetVectorizeIndexInfoResponse>

getVectorsByIdentifier

Parameters

indexName

ids

Returns Promise<GetVectorsByIdentifierResponse>

insertVectorsIndex

Parameters

indexName

ndjson

unparsableBehavior

Returns Promise<InsertVectorizeIndexResponse>

listVectorizeIndex

Returns Promise<ListVectorizeIndexResponse>

Example

queryVectors

Parameters

indexName

vector

filter

returnMetadata

returnValues

topK

Returns Promise<QueryVectorsResponse>

toNDJSON

Parameters

Returns string

upsertVectors

Parameters

indexName

ndjson

unparsableBehavior

Returns Promise<UpsertVectorsResponse>

Settings

On This Page