LogoCloudflare API

Vectorize

Vectorize

Vectorize

Indexes

Vectorize.Indexes

Methods

list(, ):
SinglePage
<
CreateIndex
>
get/accounts/{account_id}/vectorize/v2/indexes

Returns a list of Vectorize Indexes

get(, , ):
CreateIndex
| null
get/accounts/{account_id}/vectorize/v2/indexes/{index_name}

Returns the specified Vectorize Index.

create(, ):
CreateIndex
| null
post/accounts/{account_id}/vectorize/v2/indexes

Creates and returns a new Vectorize Index.

delete(, , ):
IndexDeleteResponse
| null
delete/accounts/{account_id}/vectorize/v2/indexes/{index_name}

Deletes the specified Vectorize Index.

insert(, , ):
IndexInsertResponse
| null
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.

query(, , ):
IndexQueryResponse
| null
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query

Finds vectors closest to a given vector in an index.

upsert(, , ):
IndexUpsertResponse
| null
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.

deleteByIds(, , ):
IndexDeleteByIDsResponse
| null
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids

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

getByIds(, , ):
IndexGetByIDsResponse
| null
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids

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

info(, , ):
IndexInfoResponse
| null
get/accounts/{account_id}/vectorize/v2/indexes/{index_name}/info

Get information about a vectorize index.

listVectors(, , ):
IndexListVectorsResponse
| null
get/accounts/{account_id}/vectorize/v2/indexes/{index_name}/list

Returns a paginated list of vector identifiers from the specified index.

Domain types

CreateIndex{…}
IndexDeleteVectorsByID{…}
IndexDimensionConfiguration{…}
IndexInsert{…}
IndexQuery{…}
IndexUpsert{…}
VectorizeIndexes

Metadata Index

Vectorize.Indexes.MetadataIndex

Methods

list(, , ):
MetadataIndexListResponse
| null
get/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list

List Metadata Indexes for the specified Vectorize Index.

create(, , ):
MetadataIndexCreateResponse
| null
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create

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

delete(, , ):
MetadataIndexDeleteResponse
| null
post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete

Allow Vectorize to delete the specified metadata index.