Create or Upsert Group or Groups
curl --request POST \
--url https://api.trieve.ai/api/chunk_group \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '
{
"description": "All versions and colorways of the oversized t-shirt",
"metadata": {
"color": "black",
"size": "large"
},
"name": "Versions of Oversized T-Shirt",
"tag_set": [
"tshirt",
"oversized",
"clothing"
],
"tracking_id": "SNOVERSIZEDTSHIRT",
"upsert_by_tracking_id": false
}
'import requests
url = "https://api.trieve.ai/api/chunk_group"
payload = {
"description": "All versions and colorways of the oversized t-shirt",
"metadata": {
"color": "black",
"size": "large"
},
"name": "Versions of Oversized T-Shirt",
"tag_set": ["tshirt", "oversized", "clothing"],
"tracking_id": "SNOVERSIZEDTSHIRT",
"upsert_by_tracking_id": False
}
headers = {
"TR-Dataset": "<tr-dataset>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'TR-Dataset': '<tr-dataset>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
description: 'All versions and colorways of the oversized t-shirt',
metadata: {color: 'black', size: 'large'},
name: 'Versions of Oversized T-Shirt',
tag_set: ['tshirt', 'oversized', 'clothing'],
tracking_id: 'SNOVERSIZEDTSHIRT',
upsert_by_tracking_id: false
})
};
fetch('https://api.trieve.ai/api/chunk_group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trieve.ai/api/chunk_group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'All versions and colorways of the oversized t-shirt',
'metadata' => [
'color' => 'black',
'size' => 'large'
],
'name' => 'Versions of Oversized T-Shirt',
'tag_set' => [
'tshirt',
'oversized',
'clothing'
],
'tracking_id' => 'SNOVERSIZEDTSHIRT',
'upsert_by_tracking_id' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"TR-Dataset: <tr-dataset>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trieve.ai/api/chunk_group"
payload := strings.NewReader("{\n \"description\": \"All versions and colorways of the oversized t-shirt\",\n \"metadata\": {\n \"color\": \"black\",\n \"size\": \"large\"\n },\n \"name\": \"Versions of Oversized T-Shirt\",\n \"tag_set\": [\n \"tshirt\",\n \"oversized\",\n \"clothing\"\n ],\n \"tracking_id\": \"SNOVERSIZEDTSHIRT\",\n \"upsert_by_tracking_id\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TR-Dataset", "<tr-dataset>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trieve.ai/api/chunk_group")
.header("TR-Dataset", "<tr-dataset>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"All versions and colorways of the oversized t-shirt\",\n \"metadata\": {\n \"color\": \"black\",\n \"size\": \"large\"\n },\n \"name\": \"Versions of Oversized T-Shirt\",\n \"tag_set\": [\n \"tshirt\",\n \"oversized\",\n \"clothing\"\n ],\n \"tracking_id\": \"SNOVERSIZEDTSHIRT\",\n \"upsert_by_tracking_id\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trieve.ai/api/chunk_group")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"All versions and colorways of the oversized t-shirt\",\n \"metadata\": {\n \"color\": \"black\",\n \"size\": \"large\"\n },\n \"name\": \"Versions of Oversized T-Shirt\",\n \"tag_set\": [\n \"tshirt\",\n \"oversized\",\n \"clothing\"\n ],\n \"tracking_id\": \"SNOVERSIZEDTSHIRT\",\n \"upsert_by_tracking_id\": false\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "Bad Request"
}{
"message": "Bad Request"
}Chunk Group
Create or Upsert Group or Groups
Create new chunk_group(s). This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Only 1000 chunk groups can be created at a time. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
POST
/
api
/
chunk_group
Create or Upsert Group or Groups
curl --request POST \
--url https://api.trieve.ai/api/chunk_group \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '
{
"description": "All versions and colorways of the oversized t-shirt",
"metadata": {
"color": "black",
"size": "large"
},
"name": "Versions of Oversized T-Shirt",
"tag_set": [
"tshirt",
"oversized",
"clothing"
],
"tracking_id": "SNOVERSIZEDTSHIRT",
"upsert_by_tracking_id": false
}
'import requests
url = "https://api.trieve.ai/api/chunk_group"
payload = {
"description": "All versions and colorways of the oversized t-shirt",
"metadata": {
"color": "black",
"size": "large"
},
"name": "Versions of Oversized T-Shirt",
"tag_set": ["tshirt", "oversized", "clothing"],
"tracking_id": "SNOVERSIZEDTSHIRT",
"upsert_by_tracking_id": False
}
headers = {
"TR-Dataset": "<tr-dataset>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'TR-Dataset': '<tr-dataset>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
description: 'All versions and colorways of the oversized t-shirt',
metadata: {color: 'black', size: 'large'},
name: 'Versions of Oversized T-Shirt',
tag_set: ['tshirt', 'oversized', 'clothing'],
tracking_id: 'SNOVERSIZEDTSHIRT',
upsert_by_tracking_id: false
})
};
fetch('https://api.trieve.ai/api/chunk_group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trieve.ai/api/chunk_group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'All versions and colorways of the oversized t-shirt',
'metadata' => [
'color' => 'black',
'size' => 'large'
],
'name' => 'Versions of Oversized T-Shirt',
'tag_set' => [
'tshirt',
'oversized',
'clothing'
],
'tracking_id' => 'SNOVERSIZEDTSHIRT',
'upsert_by_tracking_id' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"TR-Dataset: <tr-dataset>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trieve.ai/api/chunk_group"
payload := strings.NewReader("{\n \"description\": \"All versions and colorways of the oversized t-shirt\",\n \"metadata\": {\n \"color\": \"black\",\n \"size\": \"large\"\n },\n \"name\": \"Versions of Oversized T-Shirt\",\n \"tag_set\": [\n \"tshirt\",\n \"oversized\",\n \"clothing\"\n ],\n \"tracking_id\": \"SNOVERSIZEDTSHIRT\",\n \"upsert_by_tracking_id\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TR-Dataset", "<tr-dataset>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trieve.ai/api/chunk_group")
.header("TR-Dataset", "<tr-dataset>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"All versions and colorways of the oversized t-shirt\",\n \"metadata\": {\n \"color\": \"black\",\n \"size\": \"large\"\n },\n \"name\": \"Versions of Oversized T-Shirt\",\n \"tag_set\": [\n \"tshirt\",\n \"oversized\",\n \"clothing\"\n ],\n \"tracking_id\": \"SNOVERSIZEDTSHIRT\",\n \"upsert_by_tracking_id\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trieve.ai/api/chunk_group")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"All versions and colorways of the oversized t-shirt\",\n \"metadata\": {\n \"color\": \"black\",\n \"size\": \"large\"\n },\n \"name\": \"Versions of Oversized T-Shirt\",\n \"tag_set\": [\n \"tshirt\",\n \"oversized\",\n \"clothing\"\n ],\n \"tracking_id\": \"SNOVERSIZEDTSHIRT\",\n \"upsert_by_tracking_id\": false\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "Bad Request"
}{
"message": "Bad Request"
}Authorizations
Headers
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 cretea a chunk_group(s)
- single · object
- single · object[]
Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for.
Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group.
Name to assign to the chunk_group. Does not need to be unique.
Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group.
Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.
Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists.
Response
Returns the created chunk_group if a single chunk_group was specified or an array of all chunk_groups which were created
Was this page helpful?