Replace Chunk Metadata

PUT

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

PUT

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

1 import json
2 import requests
3 import uuid
4 
5 BASE_URL = "https://api.runcaptain.com"
6 API_KEY = "your_api_key"
7 COLLECTION_NAME = "my_documents"
8 CHUNK_ID = "doc_abc123:0"
9 
10 headers = {
11     "Authorization": f"Bearer {API_KEY}",
12     "Content-Type": "application/json",
13     "Idempotency-Key": str(uuid.uuid4()),
14 }
15 
16 response = requests.put(
17     f"{BASE_URL}/v3/collections/{COLLECTION_NAME}/chunks/{CHUNK_ID}/metadata",
18     headers=headers,
19     json={
20     "metadata": {}
21 },
22     timeout=30.0
23 )
24 
25 print(json.dumps(response.json(), indent=2))

1 {
2   "chunk_id": "chunk_agri_report_001",
3   "metadata": {
4     "review_status": "peer_reviewed",
5     "topic": "agriculture",
6     "owner": "research-team",
7     "priority": "high"
8   },
9   "updated_at": "2024-05-22T14:31:00Z"
10 }

Replace the custom metadata object attached to a chunk.

Path parameters

collection_namestringRequired

chunk_idstringRequired

Request

This endpoint expects an object.

metadataobjectOptional

Response

Replace Chunk Metadata response.

chunk_idstring

metadataobject

updated_atstring or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error