Gets a Document from a DocumentCollection by UUID

Deprecated

GET

https://api.getzep.com/api/v2/collections/:collectionName/documents/uuid/:documentUUID

GET

/api/v2/collections/:collectionName/documents/uuid/:documentUUID

1 from zep_cloud import Zep
2 
3 client = Zep()
4 
5 client.document.gets_a_document_from_a_document_collection_by_uuid(
6     collection_name="collectionName",
7     document_uuid="documentUUID",
8 )

1 {
2   "content": "This document contains the quarterly financial report for Q1 2024, including revenue, expenses, and profit analysis.",
3   "created_at": "2024-04-15T09:30:00Z",
4   "document_id": "doc-789456123",
5   "embedding": [
6     0.12345,
7     -0.98765,
8     0.45678,
9     0.23456,
10     -0.34567,
11     0.56789,
12     -0.12345,
13     0.6789,
14     -0.23456,
15     0.34567
16   ],
17   "is_embedded": true,
18   "metadata": {
19     "author": "Jane Doe",
20     "department": "Finance",
21     "confidential": false,
22     "tags": [
23       "financial",
24       "Q1",
25       "report"
26     ]
27   },
28   "updated_at": "2024-04-20T16:45:00Z",
29   "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
30 }

Returns specified Document from a DocumentCollection.

Path parameters

collectionNamestringRequired

Name of the Document Collection

documentUUIDstringRequired

UUID of the Document to be updated

Response

contentstringOptional

created_atstringOptional

document_idstringOptional

embeddinglist of doublesOptional

is_embeddedbooleanOptional

metadatamap from strings to anyOptional

updated_atstringOptional

uuidstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error