Get Chunk by ID

GET

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

GET

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

1 import requests
2 
3 url = "https://host.com/v3/collections/collection_name/chunks/chunk_id"
4 
5 querystring = {"document_id":"document_id","include_regions":"true","include_metadata":"true"}
6 
7 response = requests.get(url, params=querystring)
8 
9 print(response.json())

1 {
2   "collection_name": "research_library",
3   "chunk": {
4     "chunk_id": "chunk_agri_report_001",
5     "document_id": "doc_climate_agriculture_2024",
6     "text": "Recent studies show that climate change affects crop yields through heat stress, shifting precipitation, and more frequent extreme weather events.",
7     "location": {
8       "page_start": 12,
9       "page_end": 13,
10       "chunk_index": 4,
11       "parent_chunk_index": 1,
12       "start_seconds": 1.1,
13       "end_seconds": 1.1,
14       "sheet_name": "sheet_name",
15       "row_start": 1,
16       "row_end": 1,
17       "col_start": 1,
18       "col_end": 1
19     },
20     "regions": [
21       {
22         "type": "text",
23         "text": "Projected maize yield declines under high temperature scenarios",
24         "page": 12,
25         "bbox": {
26           "x": 0.18,
27           "y": 0.24,
28           "width": 0.62,
29           "height": 0.08
30         },
31         "confidence": "high"
32       },
33       {
34         "type": "chart",
35         "page": 13,
36         "bbox": {
37           "x": 0.12,
38           "y": 0.31,
39           "width": 0.76,
40           "height": 0.42
41         },
42         "confidence": "medium",
43         "image_url": "https://storage.example.com/previews/climate-agriculture-chart-p13.png",
44         "description": "Chart comparing projected crop yield changes by region."
45       }
46     ],
47     "custom_metadata": {
48       "review_status": "peer_reviewed",
49       "topic": "agriculture"
50     },
51     "metadata": {
52       "section": "Projected yield impacts",
53       "page_count": 2
54     }
55   },
56   "warnings": [
57     "warnings"
58   ]
59 }

Fetch one chunk by ID with optional regions and metadata.

Path parameters

collection_namestringRequired

chunk_idstringRequired

Query parameters

document_idstringOptional

include_regionsbooleanOptionalDefaults to false

include_metadatabooleanOptionalDefaults to true

Response

Get Chunk response.

collection_namestring

chunkobject

warningslist of strings

Errors

401

Get Chunk V3request Unauthorized Error

403

Get Chunk V3request Forbidden Error

404

Get Chunk V3request Not Found Error

422

Get Chunk V3request Unprocessable Entity Error