POST
/
api
/
chunk_group
/
group_oriented_autocomplete
curl --request POST \
  --url https://api.trieve.ai/api/chunk_group/group_oriented_autocomplete \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "filters": {
    "must": [
      {
        "field": "metadata.key2",
        "match": [
          "value3",
          "value4"
        ],
        "range": {
          "gt": 0,
          "gte": 0,
          "lt": 1,
          "lte": 1
        }
      }
    ],
    "must_not": [
      {
        "field": "metadata.key3",
        "match": [
          "value5",
          "value6"
        ],
        "range": {
          "gt": 0,
          "gte": 0,
          "lt": 1,
          "lte": 1
        }
      }
    ],
    "should": [
      {
        "field": "metadata.key1",
        "match": [
          "value1",
          "value2"
        ],
        "range": {
          "gt": 0,
          "gte": 0,
          "lt": 1,
          "lte": 1
        }
      }
    ]
  },
  "highlight_delimiters": [
    "?",
    ",",
    ".",
    "!"
  ],
  "highlight_results": true,
  "page": 1,
  "page_size": 10,
  "query": "Some search query",
  "recency_bias": 1,
  "score_threshold": 0.5,
  "search_type": "semantic",
  "use_weights": true
}'
{
  "corrected_query": "<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"
      }
    }
  ],
  "total_pages": 123
}

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 semantically search for groups

The body is of type object.

Response

200
application/json

Groups with embedding vectors which are similar to those in the request body

The response is of type object.