POST
/
api
/
chunk
/
suggestions

Authorizations

Authorization
string
headerrequired

Headers

TR-Dataset
string
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json
context
string | null

Context is the context of the query. This can be any string under 15 words and 200 characters. The context will be used to generate the suggested queries. Defaults to None.

filters
object

Filters is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata.

query
string | null

The query to base the generated suggested queries off of using RAG. A hybrid search for 10 chunks from your dataset using this query will be performed and the context of the chunks will be used to generate the suggested queries.

search_type
enum<string>
Available options:
fulltext,
semantic,
hybrid,
bm25
suggestion_type
enum<string>
Available options:
question,
keyword,
semantic

Response

200 - application/json
queries
string[]
required