KnowledgeDocumentRead

Документ базы знаний в хранилище RAG, из которого чат-бот агента может извлекать информацию. Импортируется из текста или файла (markdown, pdf, csv, xlsx и т. д.) в извлекаемые единицы. Форма Detail дополнительно включает материализованные единицы.

idIdrequired

Уникальный числовой идентификатор записи.

product_id object

Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.

anyOf

• integer
• null

integer

agent_idAgent Idrequired

Идентификатор агента (настроенного ИИ-ассистента/бота), которому принадлежит запись.

directory_idDirectory Idrequired

Идентификатор директории-владельца. Каждый сохранённый документ базы знаний принадлежит ровно одной директории.

group_name object

Зеркало имени группы (legacy). Обычно совпадает с именем директории-владельца для совместимости.

anyOf

• string
• null

string

titleTitlerequired

Человекочитаемое название документа, обычно выводимое из имени файла или имени промпта.

source_typeKnowledgeDocumentSourceTyperequired

Исходный формат до извлечения текста.

Possible values: [text, markdown, csv, xls, pdf, xlsx]

retrieval_modeKnowledgeDocumentRetrievalModerequired

Как документ материализуется в извлекаемые единицы.

Possible values: [whole_document, section_under_heading, top_n_chunks, top_n_rows]

statusKnowledgeDocumentStatusrequired

Статус жизненного цикла загрузки документа.

Possible values: [pending, ready, failed]

source_path object

Канонический путь S3 к исходному артефакту.

anyOf

• string
• null

string

source_hash object

Хеш эффективного загруженного источника для обнаружения изменений.

anyOf

• string
• null

string

extracted_text object

Канонический извлечённый текст, полученный из исходника.

anyOf

• string
• null

string

structure_json objectrequired

Производные структурные метаданные (число разделов, строк или страниц).

property name*any

Производные структурные метаданные (число разделов, строк или страниц).

metadata_json objectrequired

Гибкие метаданные документа для происхождения, миграций и будущих подсказок извлечения.

property name*any

Гибкие метаданные документа для происхождения, миграций и будущих подсказок извлечения.

created_atdate-timerequired

Время создания (UTC, ISO 8601).

updated_atdate-timerequired

Время последнего изменения (UTC, ISO 8601).

unit_countUnit Count

Число материализованных на данный момент извлекаемых единиц документа.

Default value: 0

KnowledgeDocumentRead

{
  "id": 0,
  "product_id": 0,
  "agent_id": 0,
  "directory_id": 0,
  "group_name": "string",
  "title": "string",
  "source_type": "text",
  "retrieval_mode": "whole_document",
  "status": "pending",
  "source_path": "string",
  "source_hash": "string",
  "extracted_text": "string",
  "structure_json": {},
  "metadata_json": {},
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "unit_count": 0
}