LogoCloudflare API

Vectorize

vectorize

Vectorize

Indexes

vectorize.indexes

Methods

Create Vectorize Index -> Envelope<
CreateIndex
>
post/accounts/{account_id}/vectorize/v2/indexes

Creates and returns a new Vectorize Index.

Delete Vectorize Index -> Envelope<unknown>
delete/accounts/{account_id}/vectorize/v2/indexes/{index_name}

Deletes the specified Vectorize Index.

Delete Vectors By Identifier -> Envelope<{ mutationId }>
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids

Delete a set of vectors from an index by their vector identifiers.

Get Vectorize Index -> Envelope<
CreateIndex
>
get/accounts/{account_id}/vectorize/v2/indexes/{index_name}

Returns the specified Vectorize Index.

Get Vectors By Identifier -> Envelope<unknown>
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids

Get a set of vectors from an index by their vector identifiers.

Get Vectorize Index Info -> Envelope<{ dimensions, processedUpToDatetime, processedUpToMutation, 1 more... }>
get/accounts/{account_id}/vectorize/v2/indexes/{index_name}/info

Get information about a vectorize index.

Insert Vectors -> Envelope<{ mutationId }>
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert

Inserts vectors into the specified index and returns a mutation id corresponding to the vectors enqueued for insertion.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Parameters
account_id: string

Identifier

index_name: string
unparsable-behavior:
Optional

Behavior for ndjson parse failures.

"error"
"discard"
Response fields
errors: Array<
ResponseInfo
>
messages: Array<
ResponseInfo
>
result: { mutationId }
success: true

Whether the API call was successful

Request example
200Example
List Vectorize Indexes -> SinglePage<
CreateIndex
>
get/accounts/{account_id}/vectorize/v2/indexes

Returns a list of Vectorize Indexes

Query Vectors -> Envelope<{ count, matches }>
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query

Finds vectors closest to a given vector in an index.

Upsert Vectors -> Envelope<{ mutationId }>
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert

Upserts vectors into the specified index, creating them if they do not exist and returns a mutation id corresponding to the vectors enqueued for upsertion.

Domain types

CreateIndex = { config, created_on, description, 2 more... }
IndexDeleteVectorsByID = { count, ids }
IndexDimensionConfiguration = { dimensions, metric }
IndexInsert = { count, ids }
IndexQuery = { count, matches }
IndexUpsert = { count, ids }
VectorizeIndexes

Metadata Index

vectorize.indexes.metadata_index

Methods

Create Metadata Index -> Envelope<{ mutationId }>
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create

Enable metadata filtering based on metadata property. Limited to 10 properties.

Delete Metadata Index -> Envelope<{ mutationId }>
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete

Allow Vectorize to delete the specified metadata index.

List Metadata Indexes -> Envelope<{ metadataIndexes }>
get/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list

List Metadata Indexes for the specified Vectorize Index.