Sign in
Chunks

List Chunks

Returns a paginated list of chunks within a document, optionally filtered by keyword or indexing status.

get/datasets/{dataset_id}/documents/{document_id}/segments

Path parameters

dataset_idstring uuid required

Knowledge base ID. Obtain it from List Knowledge Bases.

document_idstring uuid required

Document ID. Obtain it from List Documents.

Query parameters

pageinteger

Page number.

limitinteger

Number of items per page. Server caps at 100.

statusstring[]

Filter chunks by indexing status, e.g. completed, indexing, error.

keywordstring

Search keyword.

Response

List of chunks.

doc_formstring

Document chunking mode used by this document.

totalinteger

Total number of matching chunks.

has_moreboolean

Whether more items exist on the next page.

limitinteger

Number of items per page.

pageinteger

Current page number.

Changes

Changed in 1 of the 10 revisions of this API.21

  • 1647da47778921See the full diff
    • ●

      for the query request parameter limit, the min was set to 1.00

      request-parameter-min-set

    • ●

      for the query request parameter page, the min was set to 1.00

      request-parameter-min-set

    • ○

      added the non-success response with the status 400

      response-non-success-status-added