Fetch - Upstash Documentation

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

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

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

Used to retrieve the vector by ID.

Arguments

string[] | number[]

required

The IDs of the vectors you want to fetch.

object

required

Hide child attributes

string[] | number[]

The IDs of the vectors you want to fetch.

string

An id prefix to match vector IDs.

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

Object

Hide child attributes

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.

boolean

Whether to include the vector themselves in the response.

boolean

Whether to include the data field in the response.

string

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

Response

Vector[]

required

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

Hide child attributes

string | number

required

The ID of the resulting vector.

number[]

The vectors (if includeVectors is set to true)

SparseVector

The resulting sparseVector (if includeVectors is set to true)

Record<string, unknown>

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

string

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

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

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

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

​Arguments

​Response

Arguments

Response