Query a knowledge base

POST

knowledge-base

datasets

{dataset_id}

query

Query a knowledge base

curl --request POST \
  --url https://api.anyreach.ai/knowledge-base/datasets/{dataset_id}/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "what is the return window?",
  "results_count": 5
}
'

{
  "results": [
    {
      "content": "<string>",
      "score": 123,
      "source_id": "<string>",
      "dataset_id": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Personal access token. See Authentication.

Path Parameters

dataset_id

string<uuid>

required

The knowledge base ID.

Body

application/json

query

string

required

The natural-language query to embed and search with.

results_count

integer

default:5

Maximum number of chunks to return.

Response

Matching chunks, most relevant first.

results

object[]

Show child attributes

OverviewAttach and detach sources to a knowledge base.

Query a knowledge base

curl --request POST \
  --url https://api.anyreach.ai/knowledge-base/datasets/{dataset_id}/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "what is the return window?",
  "results_count": 5
}
'

{
  "results": [
    {
      "content": "<string>",
      "score": 123,
      "source_id": "<string>",
      "dataset_id": "<string>"
    }
  ]
}