POST
/
api
/
chunk_group
/
recommend
curl --request POST \
  --url https://api.trieve.ai/api/chunk_group/recommend \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "filters": {
    "must": [
      {
        "field": "tag_set",
        "match_all": [
          "A",
          "B"
        ]
      },
      {
        "field": "num_value",
        "range": {
          "gte": 10,
          "lte": 25
        }
      }
    ]
  },
  "group_size": 1,
  "limit": 1,
  "metadata": "<any>",
  "negative_group_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "negative_group_tracking_ids": [
    "<string>"
  ],
  "positive_group_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "positive_group_tracking_ids": [
    "<string>"
  ],
  "recommend_type": "semantic",
  "slim_chunks": true,
  "strategy": "average_vector",
  "user_id": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "results": [
    {
      "chunks": [
        {
          "chunk": {
            "chunk_html": "<p>Some HTML content</p>",
            "content": "Some content",
            "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "link": "https://example.com",
            "metadata": {
              "key1": "value1",
              "key2": "value2"
            },
            "time_stamp": "2021-01-01 00:00:00.000",
            "weight": 0.5
          },
          "highlights": [
            "highlight is two tokens: high, light",
            "whereas hello is only one token: hello"
          ],
          "score": 0.5
        }
      ],
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "group": {
        "created_at": "2021-01-01 00:00:00.000",
        "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
        "description": "All versions and colorways of the oversized t-shirt",
        "metadata": {
          "foo": "bar"
        },
        "name": "Versions of Oversized T-Shirt",
        "tag_set": [
          "tshirt",
          "oversized",
          "clothing"
        ],
        "tracking_id": "SNOVERSIZEDTSHIRT",
        "updated_at": "2021-01-01 00:00:00.000"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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.

​
X-API-Version
enum<string>

The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.

Available options:
V1,
V2

Body

application/json
JSON request payload to get recommendations of chunks similar to the chunks in the request

The body is of type object.

Response

200
application/json
JSON body representing the groups which are similar to the positive groups and dissimilar to the negative ones

The response is of type object.