Skip to main content

List Pipeline Document Chunks

GET 
/api/v1/pipelines/:pipeline_id/documents/:document_id/chunks

Return a list of chunks for a pipeline document.

Request​

Path Parameters

    pipeline_id uuidrequired
    document_id Document Idrequired

Cookie Parameters

    session any

Responses​

Successful Response

Schema

  • Array [

    • id_ Id (string)

    Unique ID of the node.

    embedding

    object

    Embedding of the node.

    anyOf

  • Array [

    • number

  • ]

    • extra_info object

    A flat dictionary of metadata fields

    excluded_embed_metadata_keys string[]

    Metadata keys that are excluded from text for the embed model.

    excluded_llm_metadata_keys string[]

    Metadata keys that are excluded from text for the LLM.

    relationships

    object

    A mapping of relationships to other node information.

    anyOf
    text Text (string)

    Text content of the node.

    mimetype Mimetype (string)

    Default value: text/plain

    MIME type of the node content.

    start_char_idx

    object

    Start char index of the node.

    anyOf

    integer

    end_char_idx

    object

    End char index of the node.

    anyOf

    integer

    text_template Text Template (string)

    Default value: `{metadata_str}

    {content}`

    Template for how text is formatted, with {content} and {metadata_str} placeholders.

    metadata_template Metadata Template (string)

    Default value: {key}: {value}

    Template for how metadata is formatted, with {key} and {value} placeholders.

    metadata_seperator Metadata Seperator (string)

    Default value:

    Separator between metadata fields when converting to string.

    class_name Class Name (string)

    Default value: TextNode

  • ]

Loading...