Powered by

# Chunks

Ein Chunk ist der kleinste Textabschnitt innerhalb eines Dokuments , für den ein Embedding berechnet wird und der zur Beantwortung von Fragen herangezogen werden kann. Grundbegriffe (Hierarchie, ignore) und die gemeinsame Pagination finden Sie im Datenimport-Überblick . Voraussetzungen für alle Anfragen (Basis-URL, Authorization- und kauz-chatbot-Header) finden Sie im Überblick .

# GET /partner/v1/chunks

Listet die Chunks eines Dokuments auf, optional sortiert.

# Anfrage

Parameter Typ Pflicht Beschreibung
documentId string ja ID des Dokuments, dessen Chunks aufgelistet werden sollen.
sortBy string nein createdAt, updatedAt, text, numberOfWords oder status. Standardwert createdAt.
sortOrder string nein asc oder desc. Standardwert asc.
limit number nein 1–200, Standardwert 50.
offset number nein ≥ 0, Standardwert 0.

# Antwort

Feld Typ Beschreibung
chunks[] array Die Chunks dieser Seite, siehe Felder unten.
total number Gesamtzahl der Treffer.
limit number Angewandtes limit.
offset number Angewandtes offset.

Felder je Chunk:

Feld Typ Beschreibung
id string Eindeutige ID des Chunks.
documentId string ID des übergeordneten Dokuments.
text string Textinhalt des Chunks.
name string Name des Chunks.
heading string Zugehörige Überschrift.
isHeading boolean Ob der Chunk selbst eine Überschrift ist.
ignore boolean Ob der Chunk von der Antwortgenerierung ausgeschlossen ist.
vectorized boolean Ob für den Chunk bereits ein Embedding berechnet wurde.
status string empty, chunked, vectorized oder failed.
type string text, image, table, website_text oder transcription.
createdAt string Anlagezeitpunkt (ISO 8601).
updatedAt string Zeitpunkt der letzten Änderung (ISO 8601).

Zusätzlich enthält jeder Chunk aggregierte Zählwerte, jeweils als Gesamtzahl, bereits vektorisiert und aktiv (nicht ignoriert):

Kennzahl Gesamt Vektorisiert Aktiv
Wörter numberOfWords numberOfVectorizedWords numberOfActiveWords
Tokens numberOfTokens numberOfVectorizedTokens numberOfActiveTokens 
curl --location "https://example.kauz.ai/partner/v1/chunks?documentId=51a156da-9393-4a0a-af1e-e76d4d5dbfc7&limit=20" \
--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
--header "kauz-chatbot: helpdesk"
 
{
  "chunks": [
    {
      "id": "a0f2c1de-5f0b-4c1e-9d33-1b8a1f0c4e77",
      "documentId": "51a156da-9393-4a0a-af1e-e76d4d5dbfc7",
      "text": "Die Garantie gilt für 24 Monate ab Kaufdatum.",
      "isHeading": false,
      "ignore": false,
      "vectorized": true,
      "status": "vectorized",
      "type": "text",
      "createdAt": "2026-07-24T16:21:22.720Z",
      "updatedAt": "2026-07-24T16:21:22.720Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

# POST /partner/v1/chunks

Legt einen Chunk direkt an.

# Anfrage

Alle Felder außer documentId und text sind optional.

Feld Typ Pflicht Beschreibung
documentId string ja ID des übergeordneten Dokuments.
text string ja Textinhalt des Chunks.
name string nein Name des Chunks.
heading string nein Zugehörige Überschrift.
isHeading boolean nein Ob der Chunk selbst eine Überschrift ist. Standardwert false.
author string nein Urheber*in.
type string nein text, image, table, website_text oder transcription.
precedingChunkId string nein ID des Chunks, hinter dem der neue Chunk einsortiert werden soll.
tag string nein Freies Tag.
editorAnswerId string nein ID einer verknüpften Editor-Antwort.
editorTags array<string> nein Editor-Tags.
ignore boolean nein Standardwert false.
ignoreShortChunks boolean nein Standardwert false.
fieldsToEmbed array<string> nein Felder, die ins Embedding einfließen. Ohne Angabe gelten die für das Korpus konfigurierten Felder.
userGroup array<string> nein Nutzergruppen, denen der Chunk zugeordnet ist.
leftOverlap / rightOverlap string nein Überlappender Text zum vorherigen bzw. nächsten Chunk.
imageLink string nein Bild-URL (bei type: "image").
imageClass string nein Klassifikation des Bildinhalts.
createdAt string nein ISO 8601. Standardwert ist der Anfragezeitpunkt.
updatedAt string nein ISO 8601. Standardwert ist der Anfragezeitpunkt.

# Antwort

Enthält die gesendeten Felder sowie id.

{
  "documentId": "string",
  "text": "string",
  "name": "string",
  "heading": "string",
  "isHeading": false,
  "ignore": false
}
 
curl --location --request POST "https://example.kauz.ai/partner/v1/chunks" \
--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
--header "kauz-chatbot: helpdesk" \
--header "Content-Type: application/json" \
--data-raw "{
   \"documentId\":\"51a156da-9393-4a0a-af1e-e76d4d5dbfc7\",
   \"text\":\"Die Garantie gilt für 24 Monate ab Kaufdatum.\"
}"

# GET `/partner/v1/chunks/

Enthält zusätzlich zu den Listenfeldern corpusId. documentId ist hier – anders als in der Liste – ebenfalls optional: Bei Chunks ohne die vom Dokument geerbten Daten fehlen documentId und corpusId beide. updatedAt ist hier ebenfalls optional, da nicht jeder Chunk einen Änderungszeitpunkt trägt.

curl --location "https://example.kauz.ai/partner/v1/chunks/a0f2c1de-5f0b-4c1e-9d33-1b8a1f0c4e77" \
--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
--header "kauz-chatbot: helpdesk"

# PATCH `/partner/v1/chunks/

Aktualisiert einzelne Felder eines bestehenden Chunks.

# Anfrage

Feld Typ Pflicht Beschreibung
text string nein Textinhalt des Chunks.
ignore boolean nein Ob der Chunk von der Antwortgenerierung ausgeschlossen wird.

# Antwort

id, text, ignore.

curl --location --request PATCH "https://example.kauz.ai/partner/v1/chunks/a0f2c1de-5f0b-4c1e-9d33-1b8a1f0c4e77" \
--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
--header "kauz-chatbot: helpdesk" \
--header "Content-Type: application/json" \
--data-raw "{ \"ignore\": true }"

# DELETE `/partner/v1/chunks/

Löscht den Chunk unwiderruflich. Antwort: 200 ohne Inhalt.

curl --location --request DELETE "https://example.kauz.ai/partner/v1/chunks/a0f2c1de-5f0b-4c1e-9d33-1b8a1f0c4e77" \
--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
--header "kauz-chatbot: helpdesk"