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

document_id Document Idrequired
pipeline_id uuidrequired

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

id_ Id (string)

Unique ID of the node.

embedding

object

Embedding of the node.

anyOf

MOD1

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.

property name*

object

anyOf

RelatedNodeInfo

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4]

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

MOD2

Array [

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4]

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

]

text Text (string)
Text content of the node.
Default value:
mimetype Mimetype (string)
MIME type of the node content.
Default value: text/plain

start_char_idx

object

Start char index of the node.

anyOf

MOD1

integer

end_char_idx

object

End char index of the node.

anyOf

MOD1

integer

text_template Text Template (string)
Template for how text is formatted, with {content} and {metadata_str} placeholders.
Default value: {metadata_str} {content}
metadata_template Metadata Template (string)
Template for how metadata is formatted, with {key} and {value} placeholders.
Default value: {key}: {value}
metadata_seperator Metadata Seperator (string)
Separator between metadata fields when converting to string.
Default value:
class_name Class Name (string)
Default value: TextNode

• ]

Example (from schema)

[
  {
    "id_": "string",
    "embedding": [
      null
    ],
    "extra_info": {},
    "excluded_embed_metadata_keys": [
      "string"
    ],
    "excluded_llm_metadata_keys": [
      "string"
    ],
    "relationships": {},
    "text": "string",
    "mimetype": "text/plain",
    "start_char_idx": 0,
    "end_char_idx": 0,
    "text_template": "{metadata_str}\n\n{content}",
    "metadata_template": "{key}: {value}",
    "metadata_seperator": "\n",
    "class_name": "TextNode"
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...