Used to retrieve the vector by ID.
Arguments#
The IDs of the vectors you want to fetch.
OR
Response#
This field is null if no vector with the specified id is found.
Fetch
2 min read
Skip to main contentDocumentation index
Fetch the complete documentation index at: /llms.txt
Ask it with GET /ask?q=<keywords or question>. Short keywords rank best.
Use these to discover all available pages before exploring further.
Feature requests: /common/help/feature-requests.md lists what users asked for and how to vote for a request or add one.
Page rating: `GET /feedback?path=<this page's path>&helpful=true` (or `false`) records whether this page helped. An optional `comment` (URL-encoded, at most 500 characters) says what was missing or wrong. It is anonymous and needs no key. Comments hold no code, secrets or personal data.
Used to retrieve the vector by ID.
The IDs of the vectors you want to fetch.
OR
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.
Whether to include the vector themselves in the response.
Whether to include the data field in the response.
Namespace to fetch from. If not set, default namespace is used.
This field is null if no vector with the specified id is found.
The ID of the resulting vector.
The vectors (if includeVectors is set to true)
The resulting sparseVector (if includeVectors is set to true)
The metadata of the vectors (if includeMetadata is set to true)
The data of the vector (if includeData is set to true)
Was this page helpful?
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" }]