Range Vectors

This endpoint returns a range of vectors starting with(including) cursor until the end of the vectors in the index or given limit.

Request

cursor

string

required

The offset to the last retrieved vector. Should be set to "0" in the initial range.

limit

number

required

The number of maximum vectors that you want 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

The metadata of the vector. This is used to make it easier to identify the vector on queries.

Response

nextCursor

string

required

The offset for the next range. You should place this in the cursor field for the next range.Empty if there are no other vectors in the index.

vectors

Object[]

required

Hide child attributes

id

string

required

The ID of the vector

vector

number[]

required

The embedding data

metadata

Object

Whether to include the vector data of the resulting vectors.