Generate suggested queries

This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.

POST /api/chunk/suggestions

Generate suggested queries

cURL

curl --request POST \
  --url https://api.trieve.ai/api/chunk/suggestions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '
{
  "context": "<string>",
  "filters": {
    "must": [
      {
        "field": "tag_set",
        "match_all": [
          "A",
          "B"
        ]
      },
      {
        "field": "num_value",
        "range": {
          "gte": 10,
          "lte": 25
        }
      }
    ]
  },
  "is_ecommerce": true,
  "is_followup": true,
  "query": "<string>",
  "suggestions_to_create": 1
}
'

200

{
  "queries": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Headers

TR-Dataset · string<uuid> · 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

JSON request payload to get alternative suggested queries

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 | null

ChunkFilter 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.

Show child attributes

Example:

{
  "must": [
    {
      "field": "tag_set",
      "match_all": ["A", "B"]
    },
    {
      "field": "num_value",
      "range": { "gte": 10, "lte": 25 }
    }
  ]
}

is_ecommerce · boolean | null

Whether of not the suggested queries are being generated for ecommerce.

is_followup · boolean | null

Whether or not the suggested queries are being generated for a followup question. If true, the suggested queries will be generated for a followup question. If false, the suggested queries will be generated for a new question.

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> | null

Available options: fulltext, semantic, hybrid, bm25

suggestion_type · enum<string> | null

Available options: question, keyword, semantic

suggestions_to_create · integer | null

The number of suggested queries to create, defaults to 10

Required range: x >= 0

Response

200

application/json

A JSON object containing a list of alternative suggested queries

queries · string[] · required