Cloudflare API | Vectorize › Indexes › Get Vectors By Identifier

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/vectorize/v2/indexes/$INDEX_NAME \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "config": {
      "dimensions": 768,
      "metric": "cosine"
    },
    "created_on": "2022-11-15T18:25:44.442097Z",
    "description": "This is my example index.",
    "modified_on": "2022-11-15T18:25:44.442097Z",
    "name": "example-index"
  },
  "success": true
}

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.

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

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

result: unknown

Array of vectors with matching ids.

success: true

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/vectorize/v2/indexes/$INDEX_NAME/get_by_ids \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "ids": [
        "5121db81354a40c6aedc3fe1ace51c59",
        "f90eb49c2107486abdfd78c67e853430"
      ]
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "some-vector-id",
      "metadata": {
        "another-key": "another-value",
        "customer-id": 442
      },
      "values": [
        0.812,
        0.621,
        0.261
      ]
    },
    {
      "id": "other-vector-id",
      "metadata": {
        "another-key": "with-a-value",
        "customer-id": 2151
      },
      "namespace": "namespaced",
      "values": [
        0.961,
        0.751,
        0.661
      ]
    }
  ],
  "success": true
}

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.

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 }

Vectorize Indexes

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.