Query Vectors (Deprecated)

Deprecated

POST /accounts/{account_id}/vectorize/indexes/{index_name}/query

Copy endpoint

https://api.cloudflare.com/client/v4

Finds vectors closest to a given vector in an index.

Parameters

path Path Parameters

Name	Type
`account_id` required	type VectorizeIdentifier = string
`index_name` required	type VectorizeIndexName = string

Request Body

application/json required

interface VectorizeIndexQueryRequest {
filter?: {};
returnMetadata?: boolean;
returnValues?: boolean;
topK?: number;
vector: number[];
}

Responses

200 application/json

Query Vectors Response

type VectorizeApiResponseSingle = never & { result?:

VectorizeIndexQueryResponse

interface VectorizeIndexQueryResponse {
count?: number;
matches?: {
id?: VectorizeVectorIdentifier;
metadata?: {} | null;
score?: number;
values?: number[] | null;
}[];
}

; }

Client Errors

4XX application/json

Query Vectors Failure Response

type VectorizeApiResponseSingle = never & { result?: {} | null; } & interface VectorizeApiResponseCommonFailure {
errors:

VectorizeMessages

type VectorizeMessages = { code: number;message: string; }[]

;
messages:

VectorizeMessages

type VectorizeMessages = { code: number;message: string; }[]

;
result: null;
success: false;
}