POST
/
query
curl --request POST \
  --url http://localhost:8000/query \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "filters": {},
  "k": 4,
  "min_score": 0,
  "use_reranking": true,
  "use_colpali": true,
  "graph_name": "<string>",
  "hop_depth": 2,
  "include_paths": true,
  "max_tokens": 123,
  "temperature": 123,
  "prompt_overrides": {
    "entity_extraction": {
      "prompt_template": "<string>",
      "examples": [
        {
          "label": "<string>",
          "type": "<string>",
          "properties": {}
        }
      ]
    },
    "entity_resolution": {
      "prompt_template": "<string>",
      "examples": [
        {
          "canonical": "<string>",
          "variants": [
            "<string>"
          ]
        }
      ]
    },
    "query": {
      "prompt_template": "<string>"
    }
  }
}'
{
  "completion": "<string>",
  "usage": {},
  "finish_reason": "<string>",
  "sources": [],
  "metadata": {}
}

Headers

​
authorization
string

Body

application/json

Request model for completion generation

​
query
string
required
Minimum length: 1
​
filters
object | null
​
k
integer
default:4
Required range: x > 0
​
min_score
number
default:0
​
use_reranking
boolean | null
​
use_colpali
boolean | null
​
graph_name
string | null

Name of the graph to use for knowledge graph-enhanced retrieval

​
hop_depth
integer | null
default:1

Number of relationship hops to traverse in the graph

Required range: 1 <= x <= 3
​
include_paths
boolean | null
default:false

Whether to include relationship paths in the response

​
max_tokens
integer | null
​
temperature
number | null
​
prompt_overrides
object | null

Optional customizations for entity extraction, resolution, and query prompts

Response

200
application/json
Successful Response

Response from completion generation

​
completion
string
required
​
usage
object
required
​
finish_reason
string | null
​
sources
object[]

Source information for a chunk used in completion

​
metadata
object | null