Перейти к основному содержимому

KnowledgeDocumentDetailRead

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

idIdrequired

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

product_id object

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

anyOf
integer
agent_idAgent Idrequired

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

directory_idDirectory Idrequired

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

group_name object

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

anyOf
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
source_hash object

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

anyOf
string
extracted_text object

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

anyOf
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
units object[]

Полностью материализованные извлекаемые единицы, принадлежащие документу.

  • Array [
    • idIdrequired

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

    document_idDocument Idrequired

    Идентификатор родительского документа базы знаний.

    unit_typeKnowledgeUnitTyperequired

    Как материализована единица — document, section, chunk или row.

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

    title object

    Заголовок единицы, используемый как смысловой контекст (например, заголовок раздела или название документа).

    anyOf
    string
    heading_path object

    Полная «хлебная крошка» заголовков для единиц-разделов, если доступна.

    anyOf
    string
    contentContentrequired

    Основной текст, возвращаемый чат-боту при выборе этой единицы.

    search_textSearch Textrequired

    Нормализованный текст для лексического сопоставления и как основа для эмбеддингов.

    ordinalOrdinalrequired

    Стабильный порядок единицы внутри документа.

    row_index object

    Исходный номер строки для строковых единиц, если применимо.

    anyOf
    integer
    metadata_json objectrequired

    Гибкие метаданные единицы (имя листа, заголовки, значения или название раздела).

    property name*any

    Гибкие метаданные единицы (имя листа, заголовки, значения или название раздела).

    created_atdate-timerequired

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

  • ]
    • KnowledgeDocumentDetailRead
    {
      "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,
      "units": [
        {
          "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"
        }
      ]
    }