Skip to main content

List Documents

GET 
/documents

A list of Datasphere Documents

Request​

Responses​

The request has succeeded.

Schema

    data

    object[]

    required

  • Array [

    • id uuidrequired

    Unique ID of a Document.

    filename stringrequired

    Name of the Document.

    status DocumentStatus (string)required

    Possible values: [submitted, in_progress, completed, failed]

    The current Status of the Document.

    tags string[]required

    Document tags.

    chunking_strategy ChunkingStrategy (string)required

    Possible values: [sentence, paragraph, page, sliding]

    Strategy to use when chunking the document.

    max_sentences_per_chunk stringrequired

    Max Sentences per Chunk (only used for chunking type 'sentence')

    split_newlines booleanrequired

    Split on Newlines (only used for chunking type 'sentence')

    overlap_size stringrequired

    Overlap Size (only used for chunking type 'sliding')

    chunk_size stringrequired

    Chunk Size (only used for chunking type 'sliding')

    number_of_chunks integerrequired

    Number of Chunks in the Document.

    created_at date-timerequired

    Document Creation Date.

    updated_at date-timerequired

    Document Update Date.

  • ]

    • links

    object

    required

    self urirequired

    Link of the current page

    first urirequired

    Link to the first page

    next urirequired

    Link to the next page

Loading...