Used to retrieve the vector by ID.

Arguments

IDs
string[] | number[]
required

The IDs of the vectors you want to fetch.

Options
Object
includeMetadata
boolean

Whether to include the metadata of the vectors in the response. Setting this true would be the best practice, since it will make it easier to identify the vectors.

includeVectors
boolean

Whether to include the vector themselves in the response.

includeData
boolean

Whether to include the data field in the response.

namespace
string

Namespace to fetch from. If not set, default namespace is used.

Response

FetchResponse
Vector[]
required

This field is null if no vector with the specified id is found.

id
string | number
required

The ID of the resulting vector.

vector
number[]

The vectors (if includeVectors is set to true)

metadata
Record<string, unknown>

The metadata of the vectors (if includeMetadata is set to true)

data
string

The data of the vector (if includeData is set to true)