Resume

Resumes a previously started query to fetch additional results.

POST /resumable-query-next

curl

curl $UPSTASH_VECTOR_REST_URL/resumable-query-next \
  -X POST \
  -H "Authorization: Bearer $UPSTASH_VECTOR_REST_TOKEN" \
  -d '{
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "additionalK": 2
  }'

200

{
  "Scores": [
    {
      "id": "<string>",
      "score": 123,
      "vector": [
        123
      ],
      "sparseVector": [
        {
          "indices": [
            123
          ],
          "values": [
            123
          ]
        }
      ],
      "metadata": {},
      "data": "<string>"
    }
  ]
}

Request

uuid · string · required

The unique identifier returned from the start resumable query request.

additionalK · number · required

The number of additional results to fetch.

Response

Scores · Object[]

Hide child attributes

id · string · required

The id of the vector.

score · number · required

The similarity score of the vector, calculated based on the distance metric of your index.

vector · number[]

The dense vector value for dense and hybrid indexes.

sparseVector · Object[]

The sparse vector value for sparse and hybrid indexes.

Hide child attributes

indices · number[]

Indices of the non-zero valued dimensions.

values · number[]

Values of the non-zero valued dimensions.

metadata · Object

The metadata of the vector, if any.

data · string

The unstructured data of the vector, if any.

curl

curl $UPSTASH_VECTOR_REST_URL/resumable-query-next \
  -X POST \
  -H "Authorization: Bearer $UPSTASH_VECTOR_REST_TOKEN" \
  -d '{
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "additionalK": 2
  }'