Create Chunk Relation

POST

https://host.com/v3/collections/:collection_name/chunks/:chunk_id/relations

POST

/v3/collections/:collection_name/chunks/:chunk_id/relations

1 import requests
2 
3 url = "https://host.com/v3/collections/collection_name/chunks/chunk_id/relations"
4 
5 payload = {
6     "target_chunk_id": "chunk_ipcc_summary_014",
7     "relation_type": "cites",
8     "target_document_id": "doc_ipcc_summary_2023",
9     "metadata": { "citation": "IPCC AR6 WGII Chapter 5" }
10 }
11 headers = {"Content-Type": "application/json"}
12 
13 response = requests.post(url, json=payload, headers=headers)
14 
15 print(response.json())

1 {
2   "relation": {
3     "relation_id": "relation_id",
4     "source_chunk_id": "source_chunk_id",
5     "target_chunk_id": "target_chunk_id",
6     "relation_type": "relation_type",
7     "target_document_id": "target_document_id",
8     "target_status": "found",
9     "metadata": {
10       "key": "value"
11     },
12     "created_at": "created_at",
13     "updated_at": "updated_at"
14   }
15 }

Create a typed relation from one chunk to another chunk.

Path parameters

collection_namestringRequired

chunk_idstringRequired

Request

This endpoint expects an object.

target_chunk_idstringRequired

relation_typestringRequired

target_document_idstringOptional

metadatamap from strings to anyOptional

Response

Successful Response

relationobject

Errors

400

Create Chunk Relation V3request Bad Request Error

401

Create Chunk Relation V3request Unauthorized Error

403

Create Chunk Relation V3request Forbidden Error

404

Create Chunk Relation V3request Not Found Error