Knowledge bases

Test a search

POSThttps://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/search

Run the search an agent runs during a call, and see the passages it would get with their scores. Passages marked relevant: false score below the cut-off and are not given to agents.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the agents.view permission.

X-API-KeyAuthorization: Beareragents.view

Path parameters

kb_idstringrequired

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

querystringrequired

1 to 2000 characters

limitintegerdefault: 5

1 to 20

Response

200Success.

resultsobject[]

Show item attributes

kb_idstring

source_idstring

source_namestring

textstring

scorenumber

Cosine similarity, 0 to 1.

relevantboolean

Above the cut-off the agent uses during calls.

latency_msinteger

Total time, including embedding the query.

embed_msinteger

search_msnumber

min_scorenumber

Passages below this score are not given to the agent.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request POST \ --url 'https://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/search?timezone=Asia/Kolkata' \ --header 'X-API-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "query": "query", "limit": 5 }'

import requests url = "https://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/search" params = { "timezone": "Asia/Kolkata", } headers = { "X-API-Key": "<api-key>", } payload = { "query": "query", "limit": 5, } response = requests.post(url, params=params, headers=headers, json=payload) print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/search?timezone=Asia/Kolkata", { method: "POST", headers: { "X-API-Key": "<api-key>", "Content-Type": "application/json", }, body: JSON.stringify({ "query": "query", "limit": 5 }), }) const data = await response.json() console.log(response.status, data)

{ "results": [ { "kb_id": "kb", "source_id": "source", "source_name": "source_name", "text": "text", "score": 0, "relevant": true } ], "latency_ms": 0, "embed_ms": 0, "search_ms": 0, "min_score": 0 }