Skip to main content
The range method is used to retrieve vectors in chunks with pagination. This method supports a variety of options to configure the query to your needs.
The range command is stateless, meaning you need to pass all of the parameters in each subsequent request.

​
Arguments

​
cursor
string | number
required
The cursor to the last retrieved vector. Should be set to 0 in the initial range request.
​
prefix
string
An string prefix to match vector IDs. All vectors with IDs that start with this prefix will be retrieved.
​
limit
number
required
The number of maximum vectors wanted in the response of range. (page size)
​
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.

​
Response

​
RangeResponse
required
const responseRange = await index.range(
  {
    cursor: 0,
    limit: 2,
    includeMetadata: true,
  },
  { namespace: "my-namespace" }
);

/*
{
  nextCursor: '2',
  vectors: [
    { 
      id: '0',
      metadata: {
        keyword: "Vector"
      } 
    },
    { 
      id: '19',
      metadata: {
        keyword: "Redis"
      } 
    }
  ]
}
*/

const responseRange = await index.range({
  cursor: 0,
  limit: 2,
  prefix: "test-",
});

/*
{
  nextCursor: '2',
  vectors: [
    { id: 'test-1' },
    { id: 'test-2' },
  ]
}
*/

type Metadata = {
  title: string;
  genre: "sci-fi" | "fantasy" | "horror" | "action";
};

const responseRange = await index.range<Metadata>({
  cursor: 0,
  limit: 2,
  includeMetadata: true,
});

if (responseRange[0].metadata) {
  // Since we passed the Metadata type parameter above,
  // we can interact with metadata fields without having to
  // do any typecasting.
  const { title, genre } = results[0].metadata;
  console.log(`The best match in fantasy was ${title}`);
}