Osmi
Справочник API

База документов

Получить все базы документов

HTTP
GET /document-store/store Возвращает список всех баз документов
Авторизация
string required
bearerAuth JWT-токен

Коды ответов:

  • 200 — успешно (массив объектов)
  • 500 — внутренняя ошибка

Добавить или обновить документ в базе документов

HTTP
POST /document-store/upsert/{id}Добавить новый документ или обновить существующий в базе документов
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
string required
id (string · uuid) — ID базы документов
Тело (application/json):
docId (string · uuid | nullable) — ID документа внутри базы документов (при передаче — переиспользуется конфигурация)metadata (object | nullable) — метаданные (напр. {"foo":"bar"})replaceExisting (boolean | nullable) — заменить существующий загрузчик новыми чанками (не удаляет эмбеддинги из БД векторов)createNewDocStore (boolean | nullable) — создать новую базу документовdocStore (object | nullable) — конфиг новогой базы документов (если createNewDocStore=true)loader (object | nullable) — конфиг загрузчикаsplitter (object | nullable) — конфиг сплиттераembedding (object | nullable) — конфиг эмбеддинговvectorStore (object | nullable) — конфиг БД вектораrecordManager (object | nullable) — конфиг БД записей

Коды ответов:

  • 200 — операция выполнена
  • 400 — некорректное тело запроса
  • 500 — внутренняя ошибка
Пример ответа
{
  "numAdded": 1,
  "numDeleted": 1,
  "numUpdated": 1,
  "numSkipped": 1,
  "addedDocs": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": { "author": "John Doe", "date": "2024-08-24" }
    }
  ]
}

Повторно обработать и добавить или обновить все документы в базе документов

HTTP
POST /document-store/refresh/{id} Повторно обработать и добавить или обновить все существующие документы в базе документов
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
string required
id (string · uuid) — ID базы документов
Тело (application/json):
items (object ) — массив конфигов для отдельных документов (docId, metadata, loader, splitter, embedding, vectorStore, recordManager, и т.д.)

Коды ответов:

  • 200 — операция выполнена (массив результатов)
  • 400 — некорректное тело запроса
  • 500 — внутренняя ошибка

Запрос на поиск в БД векторов

HTTP
POST /document-store/vectorstore/queryЗапрос на поиск для вставленных (upserted) фрагментов
Авторизация
string required
bearerAuth JWT-токен
Тело (application/json):
storeId (string) — ID базы документов query (string) — текст запроса

Коды ответов:

  • 200 — успешно (время выполнения и список найденных документов)
  • 400 — некорректное тело запроса
  • 500 — внутренняя ошибка
Пример ответа
{
  "timeTaken": 1,
  "docs": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": { "author": "John Doe", "date": "2024-08-24" }
    }
  ]
}

Создать новую базу документов

HTTP
POST /document-store/storeСоздаёт базу документов с переданными параметрами.
Авторизация
string required
bearerAuth JWT-токен
Тело (application/json):
id (string · uuid) — уникальный ID базы документовname (string) — имяdescription (string) — описаниеloaders (string) — загрузчики (JSON-строка)whereUsed (string) — места использования (JSON-строка)status (string · enum) — статус: EMPTY|SYNC|SYNCING|STALE|NEW|UPSERTING|UPSERTEDvectorStoreConfig (string) — конфиг БД вектора (JSON-строка)embeddingConfig (string) — конфиг эмбеддинга (JSON-строка)recordManagerConfig (string) — конфиг БД записей (JSON-строка)createdDate (string · date-time) — дата созданияupdatedDate (string · date-time) — дата обновления

Коды ответов:

  • 200 — успешно создано
  • 400 — некорректное тело запроса
  • 500 — внутренняя ошибка

Обновить конкретный чанк

HTTP
PUT /document-store/chunks/{storeId}/{loaderId}/{chunkId}Обновляет выбранный чанк у загрузчика документов.
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
storeId (string) — ID базы документовloaderId (string) — ID загрузчикаchunkId (string) — ID чанка
Тело (application/json):
pageContent (string) — содержимое metadata (object) — метаданные (напр. {"author":"John Doe","date":"2024-08-24"})

Коды ответов:

  • 200 — успешно (возвращает обновлённый список чанков и метаданные файла)
  • 404 — хранилище не найдено
  • 500 — внутренняя ошибка

Обновить базу документов по ID

HTTP
PUT /document-store/store/{id}Обновляет сведения о базе документов по его ID.
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
id (string · uuid) — ID базы документов
Тело (application/json):
(поля — как при создании)

Коды ответов:

  • 200 — успешно обновлено
  • 404 — хранилище не найдено
  • 500 — внутренняя ошибка

Удалить базу документов по ID

HTTP
DELETE /document-store/store/{id}Удаляет базу документов.
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
required
id (string · uuid) — ID базы документов

Коды ответов:

  • 200 — успешно удалено (без содержимого)
  • 404 — хранилище не найдено
  • 500 — внутренняя ошибка

Удалить конкретный чанк

HTTP
DELETE /document-store/chunks/{storeId}/{loaderId}/{chunkId}Удаляет указанный чанк из загрузчика документов.
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
required
storeId (string) — ID хранилищаloaderId (string) — ID загрузчикаchunkId (string) — ID чанка

Коды ответов:

  • 200 — чанк удалён (без содержимого)
  • 400 — некорректный ID
  • 404 — хранилище не найдено
  • 500 — внутренняя ошибка

Удалить загрузчик и связанные чанки

HTTP
DELETE /document-store/loader/{storeId}/{loaderId}Удаляет конкретный загрузчик и его чанки из хранилища. Данные из БД векторов не удаляются.
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
required
storeId (string) — ID хранилищаloaderId (string) — ID загрузчика

Коды ответов:

  • 200 — загрузчик удалён (без содержимого)
  • 400 — некорректный ID
  • 404 — хранилище не найдено
  • 500 — внутренняя ошибка

Удалить данные из БД векторов

HTTP
DELETE /document-store/vectorstore/{id}Удаляться будут только данные, которые были добавлены или обновлены с помощью БД записей, из БД векторов.
Авторизация
string required
bearerAuth JWT-токен

Коды ответов:

  • 200 — данные удалены (без содержимого)
  • 400 — некорректный ID
  • 404 — хранилище не найдено
  • 500 — внутренняя ошибка

Агенты

Создавайте простых ассистентов и чат-ботов для решения конкретных задач

Обратная связь