Append metadata to a document

1 from r2r import R2RClient 2 3 client = R2RClient() 4 # when using auth, do client.login(...) 5 6 response = client.documents.append_metadata( 7 id="9fbe403b-c11c-5aae-8ade-ef22980c3ad1", 8 metadata=[{"key": "new_key", "value": "new_value"}] 9 )

1 { 2 "results": { 3 "id": "123e4567-e89b-12d3-a456-426614174000", 4 "collection_ids": [ 5 "123e4567-e89b-12d3-a456-426614174000" 6 ], 7 "owner_id": "123e4567-e89b-12d3-a456-426614174000", 8 "document_type": "pdf", 9 "metadata": { 10 "title": "Sample Document" 11 }, 12 "version": "1.0", 13 "title": "Sample Document", 14 "size_in_bytes": 123456, 15 "ingestion_status": "pending", 16 "extraction_status": "pending", 17 "created_at": "2021-01-01T00:00:00Z", 18 "updated_at": "2021-01-01T00:00:00Z", 19 "ingestion_attempt_number": 0, 20 "summary": "A summary of the document", 21 "summary_embedding": [ 22 0.1, 23 0.2, 24 0.3 25 ], 26 "total_tokens": 1000, 27 "chunks": [ 28 { 29 "key": "value" 30 } 31 ] 32 } 33 }

Appends metadata to a document. This endpoint allows adding new metadata fields or updating existing ones.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

The ID of the document to append metadata to.

Request

Metadata to append to the document.

Response

Successful Response

resultsobject

Base class for document information handling.

Authentication

Path parameters

Headers

Request

Response

Errors