Query Data

This endpoint queries the raw text data over the existing vectors in the index after embedding it.

Request

data · string · required

The raw text data to embed and query.

topK · number · required

The total number of the vectors that you want to receive as a query result. The response will be sorted based on the distance metric score, and topK vectors will be returned.

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 data of the resulting vectors.

Response

The score is normalized to always be between 0 and 1. The closer the score is to 1, the more similar the vector is to the query vector. This does not depend on the distance metric you use.

Response · Array

Hide child attributes

id · string · required

The ID of the resulting vector.

score · number · required

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

vector · number[] · required

The resulting vector data.

metadata · Object

Whether to include the vector values of the resulting vector objects.

curl

curl https://better-dodo-20522-us1-vector.upstash.io/query-data \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{ "data": "What is Upstash?",
		"topK": 2,
  		"includeVectors": true,
  		"includeMetadata": true
	}'

200 OK

{
  "result" : [ 
	{
	    "id" : "id12",
	    "score" : 1.0,
	    "vector" : [ 0.42, 0.63, 0.05, 0.72, ..., 0.83, 0.49, 0.6, 0.48 ],
	    "metadata" : {"key":"value"}
  	}, 
	{
	    "id" : "id11",
	    "score" : 0.99996454,
	    "vector" : [ 0.44, 0.63, 0.05, 0.72, ..., 0.83, 0.49, 0.6, 0.48 ],
	    "metadata" : {"key":"value"}
  	} 
  ]
}