REST ClientDatasphere

list_chunks

View as MarkdownOpen in Claude

List chunks belonging to a document. Chunks are the individual text segments created when a document is processed for vector search.

Path parameters

documentIdstringRequiredformat: "uuid"
Unique ID of the Document.

Query parameters

page_numberintegerOptional>=0Defaults to 0
The page number to retrieve (0-indexed).
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
page_tokenstringOptional
Token for cursor-based pagination. Required when `page_number` > 0.

Response

datalist of objectsRequired
A list of chunks.

Response Example

Response
1{
2  "data": [
3    {
4      "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
5      "datasphere_document_id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
6      "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
7      "status": "completed",
8      "tags": [
9        "sports",
10        "football",
11        "game"
12      ],
13      "content": "This is the content from the original document that was chunked.",
14      "created_at": "2024-05-06T12:20-12Z",
15      "updated_at": "2024-05-06T12:20-12Z"
16    }
17  ],
18  "links": {
19    "self": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50",
20    "first": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50",
21    "next": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
22    "prev": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50&page_token=PBbff61159-faab-48b3-959a-3021a8f5beca"
23  }
24}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9chunks = client.datasphere.documents.list_chunks("document-id")
10for chunk in chunks.get("data", []):
11    print(chunk.get("id"), chunk.get("text")[:80])