Skip to main content
POST
/
v5
/
vector-stores
/
{vector_store_name}
/
query
Query Vectors
curl --request POST \
  --url https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "content": {
    "text": "<string>",
    "type": "text"
  },
  "query_type": "semantic",
  "top_k": 10,
  "filter": {},
  "rerank_config": {
    "type": "base",
    "model": "<string>",
    "top_n": 2,
    "instruction": "<string>"
  },
  "rerank": false,
  "rerank_model": "<string>",
  "rerank_top_n": 2,
  "rerank_instruction": "<string>",
  "include_vectors": false
}
'
{
  "vectors": [
    {
      "id": "<string>",
      "content": {
        "text": "<string>",
        "type": "text"
      },
      "score": 123,
      "metadata": {},
      "vector": [
        123
      ]
    }
  ],
  "metadata": {
    "search_type": "<string>",
    "total_query_time_ms": 123,
    "embedding_config": {
      "type": "<string>",
      "model_deployment_id": "<string>"
    },
    "embedding_time_ms": 123,
    "index_query_time_ms": 123,
    "reranking_model": "<string>",
    "reranking_time_ms": 123
  }
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

vector_store_name
string
required

The name of the vector store

Body

application/json

Request to query documents.

content
Content · object
required

Query content for automatic embedding

query_type
enum<string>
default:semantic

Query type: semantic, lexical, or hybrid

Available options:
semantic,
lexical,
hybrid
top_k
integer
default:10

Number of search results to return

Required range: x >= 1
filter
Filter · object

Metadata filter expression

rerank_config
RerankConfig · object

Reranking configuration. Presence enables reranking; omit to disable. Pass an empty object ({}) to enable reranking with system defaults.

rerank
boolean
default:false

[Deprecated: use rerank_config] Enable reranking of search results

rerank_model
string

[Deprecated: use rerank_config.model] Reranking model to use

rerank_top_n
integer

[Deprecated: use rerank_config.top_n] Number of results after reranking

Required range: x >= 1
rerank_instruction
string

[Deprecated: use rerank_config.instruction] Custom instruction for reranker

include_vectors
boolean
default:false

Include embedding vectors in response

Response

Successful Response

Response for query operation.

vectors
QueryVectorDocumentResponse · object[]
required

Array of matching documents

metadata
QueryMetadata · object
required

Query execution metadata