List Chunk Relations

GET

https://api.runcaptain.com/v3/collections/:collection_name/chunks/:chunk_id/relations

GET

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

1 import json
2 import requests
3 
4 BASE_URL = "https://api.runcaptain.com"
5 API_KEY = "your_api_key"
6 COLLECTION_NAME = "my_documents"
7 CHUNK_ID = "doc_abc123:0"
8 
9 headers = {
10     "Authorization": f"Bearer {API_KEY}",
11 }
12 
13 params = {
14     "relation_types": [
15         "example_relation_types"
16     ],
17     "relation_direction": "outgoing"
18 }
19 
20 response = requests.get(
21     f"{BASE_URL}/v3/collections/{COLLECTION_NAME}/chunks/{CHUNK_ID}/relations",
22     headers=headers,
23     params=params,
24     timeout=30.0
25 )
26 
27 print(json.dumps(response.json(), indent=2))

1 {
2   "chunk_id": "chunk_agri_report_001",
3   "relations": [
4     {
5       "relation_id": "rel_agri_cites_001",
6       "source_chunk_id": "chunk_agri_report_001",
7       "target_chunk_id": "chunk_ipcc_summary_014",
8       "relation_type": "cites",
9       "target_document_id": "doc_ipcc_summary_2023",
10       "target_status": "found",
11       "metadata": {
12         "citation": "IPCC AR6 WGII Chapter 5"
13       },
14       "created_at": "2024-05-22T14:31:00Z",
15       "updated_at": "2024-05-22T14:31:00Z"
16     },
17     {
18       "relation_id": "rel_agri_supports_002",
19       "source_chunk_id": "chunk_agri_report_001",
20       "target_chunk_id": "chunk_yield_spreadsheet_018",
21       "relation_type": "supports",
22       "target_document_id": "doc_crop_yield_timeseries",
23       "target_status": "found",
24       "metadata": {
25         "note": "Yield table supports the claim in this paragraph."
26       },
27       "created_at": "2024-05-22T14:36:00Z",
28       "updated_at": "2024-05-22T14:36:00Z"
29     }
30   ]
31 }

List typed graph relations connected to a chunk.

Path parameters

collection_namestringRequired

chunk_idstringRequired

Query parameters

relation_typeslist of strings or nullOptional

relation_directionenumOptionalDefaults to outgoing

Allowed values:

Response

List Chunk Relations response.

chunk_idstring

relationslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error