Fetch - Upstash Documentation

Used to retrieve the vector by ID.

Arguments

IDsstring[] | number[]required

The IDs of the vectors you want to fetch.

FetchPayloadobjectrequired

idsstring[] | number[]

The IDs of the vectors you want to fetch.

prefixstring

An id prefix to match vector IDs.

For fetching larger datasets with prefix, it is recommended to use the paginated range command instead.

OptionsObject

includeMetadataboolean

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.

includeVectorsbodyboolean

Whether to include the vector themselves in the response.

includeDatabodyboolean

Whether to include the data field in the response.

namespacestring

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

Response

FetchResult[]Vector[]required

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

idstring | numberrequired

The ID of the resulting vector.

vectornumber[]

The vectors (if includeVectors is set to true)

sparseVectorSparseVector

The resulting sparseVector (if includeVectors is set to true)

metadataRecord<string, unknown>

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

datastring

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

Basic

await index.fetch(["2", "3"]);// [{ id: "2" }, { id: "3" }]

Vector Not Found

await index.fetch(["2", "3"]);// [{ id: "2" }, null]

ID prefix

await index.fetch({ prefix: "test-" });// [{ id: "test-1" }, { id: "test-2" }, { id: "test-3" }]