Chunks

Get chunk

Retrieves one generated chunk by document and chunk IDs. Use it to inspect a known stored passage; use List chunks to discover chunk IDs or Search documents when starting from a natural-language query.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.

Learn more about API scopes.

get/api/datasphere/documents/{documentId}/chunks/{chunkId}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/datasphere/documents/{documentId}/chunks/{chunkId}
  • Auth
    HTTP basic

Path parameters

documentIdstring uuid required

Universal Unique Identifier.

Unique ID of the parent Document.

chunkIdstring uuid required

Universal Unique Identifier.

Unique ID of a Chunk.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

datasphere_document_idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

status'submitted' | 'in_progress' | 'completed' | 'failed' required

The current Status of the Chunk.

tagsstring[] required

The tags of the document associated with the chunk.

contentstring required

Content of the chunk.

created_atstring date-time required

Chunk Creation Date.

updated_atstring date-time required

Chunk Update Date.

Example response

{
  "tags": [
    "sports",
    "football",
    "game"
  ],
  "content": "This is the content from the original document that was chunked.",
  "created_at": "2024-05-06T12:20-12Z",
  "updated_at": "2024-05-06T12:20-12Z"
}

Changes

No operation changes found yet. Some revisions have not been checked.