KnowledgeUnitRead

idIdrequired

RAG unit id.

document_idDocument Idrequired

Parent knowledge document id.

unit_typeKnowledgeUnitTyperequired

How this unit was materialized: document, section, chunk, or row.

Possible values: [document, section, chunk, row]

title object

Unit title used as semantic context, for example a section heading or document title.

anyOf

• string
• null

string

heading_path object

Full heading breadcrumb for section-like units, if available.

anyOf

• string
• null

string

contentContentrequired

Primary text payload returned to the chatbot when this unit is selected.

search_textSearch Textrequired

Normalized retrieval text used for lexical matching and as the basis for embeddings.

ordinalOrdinalrequired

Stable order of the unit inside its document.

row_index object

Original row number for row-based units, if applicable.

anyOf

• integer
• null

integer

metadata_json objectrequired

Flexible per-unit metadata such as sheet name, headers, values, or section title.

property name*any

Flexible per-unit metadata such as sheet name, headers, values, or section title.

created_atdate-timerequired

When this unit was created in the RAG database.

KnowledgeUnitRead

{
  "id": 0,
  "document_id": 0,
  "unit_type": "document",
  "title": "string",
  "heading_path": "string",
  "content": "string",
  "search_text": "string",
  "ordinal": 0,
  "row_index": 0,
  "metadata_json": {},
  "created_at": "2024-07-29T15:51:28.071Z"
}