Перейти к основному содержимому
API docs by Redocly

Jay Knowledge Hub public API (1.0.0)

Download OpenAPI specification:Download

ProjectsPublic

Работа с проектами Jay Knowledge Hub.

Информация по проекту

Получение информации по текущему проекту базы знаний.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "status": "CREATED",
  • "resources": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Список источников

Получение информации по источникам проекта базы знаний.

Authorizations:
bearerAuth
query Parameters
createDateFrom
string <date>

Отбирать источники, добавленные начиная с указанной даты включительно.

createDateTo
string <date>

Отбирать источники, добавленные до указанной даты включительно.

sourceStatus
string

Отбирать источники с указанным статусом индексации. Возможные статусы:

  • READY_TO_INGEST — готов для индексации.
  • PROCESSING — в обработке.
  • INGESTED — проиндексирован.
  • FAILED_TO_INGEST — ошибка индексации.

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ]
}

Выгрузка источника

Выгрузка документа-источника из базы знаний.

Authorizations:
bearerAuth
path Parameters
sourceId
required
integer <int64> (LongId)

Идентификатор источника в проекте базы знаний.

Responses

QueriesPublic

Отправка запросов на поиск чанков и генерацию ответов (без учета истории диалога).

Поиск чанков (retrieving)

Получение чанков в базе знаний, релевантных для пользовательского ответа.

Authorizations:
bearerAuth
Request Body schema: application/json
required
query
required
string

Текст пользовательского запроса.

Array of objects (HistoryRecord)

История диалога. Записи отображаются в обратном хронологическом порядке (от поздних к ранним).

object (RetrievingSettings)

Настройки поиска чанков.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "history": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "chunks": [
    ]
}

Генерация ответа

Синхронный запрос на генерацию ответа на пользовательский запрос.

Учитывайте, что обработка запроса может занимать значительное время. Убедитесь, что используемый вами HTTP-клиент имеет установленный таймаут соединения более 1 минуты.

Authorizations:
bearerAuth
Request Body schema: application/json
required
query
required
string

Текст пользовательского запроса.

Array of objects (HistoryRecord)

История диалога. Записи отображаются в обратном хронологическом порядке (от поздних к ранним).

object (RagSettings)

Настройки обработки запроса.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "history": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "request": "string",
  • "response": "string",
  • "status": "READY_TO_PROCESS",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "relevantSources": [
    ]
}

Генерация ответа (асинхронный запрос)

Асинхронный запрос на генерацию ответа на пользовательский запрос.

Получить результат можно методом GET /api/knowledge-hub/query/{queryId}, где queryId — идентификатор запроса, полученный в текущем ответе.

Authorizations:
bearerAuth
Request Body schema: application/json
required
query
required
string

Текст пользовательского запроса.

Array of objects (HistoryRecord)

История диалога. Записи отображаются в обратном хронологическом порядке (от поздних к ранним).

object (RagSettings)

Настройки обработки запроса.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "history": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "request": "string",
  • "response": "string",
  • "status": "READY_TO_PROCESS",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "relevantSources": [
    ]
}

Статус обработки запроса на генерацию ответа

Возвращает текущий статус обработки запроса на генерацию ответа. Использует long-polling, если указан параметр waitTimeSeconds.

Authorizations:
bearerAuth
path Parameters
queryId
required
integer <int64> (LongId)

Идентификатор запроса на генерацию ответа.

query Parameters
waitTimeSeconds
integer <int32> [ 0 .. 30 ]
Default: 3

Время ожидания ответа в HTTP-запросе. Используется в long-polling.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "request": "string",
  • "response": "string",
  • "status": "READY_TO_PROCESS",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "relevantSources": [
    ]
}

Отмена обработки запроса на генерацию ответа

Authorizations:
bearerAuth
path Parameters
queryId
required
integer <int64> (LongId)

Идентификатор запроса на генерацию ответа.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "request": "string",
  • "response": "string",
  • "status": "READY_TO_PROCESS",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "relevantSources": [
    ]
}

ChatsPublic

Отправка запросов на поиск чанков и генерацию ответов (в рамках пользовательского чата).

Создание чата

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string

Название пользовательского чата.

object (RagSettings)

Настройки обработки запроса.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "settings": {
    }
}

Информация о пользовательском чате

Authorizations:
bearerAuth
path Parameters
chatId
required
integer <int64> (LongId)

Идентификатор чата в проекте базы знаний.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "settings": {
    }
}

Поиск чанков (retrieving)

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

Authorizations:
bearerAuth
path Parameters
chatId
required
integer <int64> (LongId)

Идентификатор чата в проекте базы знаний.

Request Body schema: application/json
required
query
required
string

Текст пользовательского запроса.

object (RetrievingSettings)

Настройки поиска чанков.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "chunks": [
    ]
}

Генерация ответа

Синхронный запрос на генерацию ответа на пользовательский запрос. При этом учитывается история сообщений в чате.

Учитывайте, что обработка запроса может занимать значительное время. Убедитесь, что используемый вами HTTP-клиент имеет установленный таймаут соединения более 1 минуты.

Authorizations:
bearerAuth
path Parameters
chatId
required
integer <int64> (LongId)

Идентификатор чата в проекте базы знаний.

Request Body schema: application/json
required
query
required
string

Текст пользовательского запроса.

object (RagSettings)

Настройки обработки запроса.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "chatId": 0,
  • "request": "string",
  • "response": "string",
  • "status": "READY_TO_PROCESS",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "relevantSources": [
    ]
}

Генерация ответа (асинхронный запрос)

Асинхронный запрос на генерацию ответа на пользовательский запрос. При этом учитывается история сообщений в чате.

Получить результат можно методом GET /api/knowledge-hub/chat/{chatId}/query/{queryId}, где queryId — идентификатор запроса, полученный в текущем ответе.

Authorizations:
bearerAuth
path Parameters
chatId
required
integer <int64> (LongId)

Идентификатор чата в проекте базы знаний.

Request Body schema: application/json
required
query
required
string

Текст пользовательского запроса.

object (RagSettings)

Настройки обработки запроса.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "chatId": 0,
  • "request": "string",
  • "response": "string",
  • "status": "READY_TO_PROCESS",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "relevantSources": [
    ]
}

Статус обработки запроса на генерацию ответа

Возвращает текущий статус обработки запроса на генерацию ответа в пользовательском чате. Использует long-polling, если указан параметр waitTimeSeconds.

Authorizations:
bearerAuth
path Parameters
chatId
required
integer <int64> (LongId)

Идентификатор чата в проекте базы знаний.

queryId
required
integer <int64> (LongId)

Идентификатор запроса на генерацию ответа.

query Parameters
waitTimeSeconds
integer <int32> [ 0 .. 30 ]
Default: 3

Время ожидания ответа в HTTP-запросе. Используется в long-polling.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "chatId": 0,
  • "request": "string",
  • "response": "string",
  • "status": "READY_TO_PROCESS",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "relevantSources": [
    ]
}

Отмена обработки чат-запроса

Authorizations:
bearerAuth
path Parameters
chatId
required
integer <int64> (LongId)

Идентификатор чата в проекте базы знаний.

queryId
required
integer <int64> (LongId)

Идентификатор запроса на генерацию ответа.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "chatId": 0,
  • "request": "string",
  • "response": "string",
  • "status": "READY_TO_PROCESS",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "relevantSources": [
    ]
}