Jay Knowledge Hub public API (1.0.0)

Download OpenAPI specification:Download

ProjectsPublic

Работа с проектом базы знаний.

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

Возвращает информацию по текущему проекту базы знаний.

Authorizations:

bearerAuth

Responses

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"status": "CREATED",
"resources": {"llmModels": ["string"
]
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

QueriesPublic

Одиночные запросы на поиск чанков и генерацию ответов. Дополнительно можно передать в запросе историю сообщений.

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

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

Authorizations:

bearerAuth

Request Body schema: application/json
required

query required	string Текст пользовательского запроса.
	Array of objects (HistoryRecord) История диалога. Записи отображаются в обратном хронологическом порядке (от поздних к ранним).
	object (RetrievingSettings) Настройки поиска чанков.

Responses

Request samples

Payload

Content type

application/json

{"query": "string",
"history": [{"content": "string",
"role": "user"
}
],
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
}
}
}

Response samples

200
400

Content type

application/json

{"chunks": [{"score": 0.1,
"content": "string",
"docId": "string",
"metadata": {"sourcePath": "string",
"sourceUrl": "string",
"segment": "string"
},
"source": {"id": 0,
"path": "string",
"externalLink": "string"
}
}
]
}

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

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

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

Authorizations:

bearerAuth

Request Body schema: application/json
required

query required	string Текст пользовательского запроса.
	Array of objects (HistoryRecord) История диалога. Записи отображаются в обратном хронологическом порядке (от поздних к ранним).
	object (RagSettings) Настройки обработки запроса.

Responses

Request samples

Payload

Content type

application/json

{"query": "string",
"history": [{"content": "string",
"role": "user"
}
],
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
},
"responseGeneration": {"prompt": "string",
"showRelevantSources": true
}
}
}

Response samples

200
400

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": [{"id": 0,
"path": "string",
"externalLink": "string"
}
]
}

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

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

Получить результат можно методом 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

Payload

Content type

application/json

{"query": "string",
"history": [{"content": "string",
"role": "user"
}
],
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
},
"responseGeneration": {"prompt": "string",
"showRelevantSources": true
}
}
}

Response samples

200
400

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": [{"id": 0,
"path": "string",
"externalLink": "string"
}
]
}

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

Возвращает текущий статус обработки запроса на генерацию ответа. Использует 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

200
400

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": [{"id": 0,
"path": "string",
"externalLink": "string"
}
]
}

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

Authorizations:

bearerAuth

path Parameters

queryId

required

integer <int64> (LongId)

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

Responses

Response samples

200
400

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": [{"id": 0,
"path": "string",
"externalLink": "string"
}
]
}

ChatsPublic

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

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

Authorizations:

bearerAuth

Request Body schema: application/json
required

name	string Название пользовательского чата.
	object (RagSettings) Настройки обработки запроса.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
},
"responseGeneration": {"prompt": "string",
"showRelevantSources": true
}
}
}

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
},
"responseGeneration": {"prompt": "string",
"showRelevantSources": true
}
}
}

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

Authorizations:

bearerAuth

path Parameters

chatId

required

integer <int64> (LongId)

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

Responses

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
},
"responseGeneration": {"prompt": "string",
"showRelevantSources": true
}
}
}

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

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

Authorizations:

bearerAuth

path Parameters

chatId

required

integer <int64> (LongId)

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

Request Body schema: application/json
required

query required	string Текст пользовательского запроса.
	object (RetrievingSettings) Настройки поиска чанков.

Responses

Request samples

Payload

Content type

application/json

{"query": "string",
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
}
}
}

Response samples

200
400

Content type

application/json

{"chunks": [{"score": 0.1,
"content": "string",
"docId": "string",
"metadata": {"sourcePath": "string",
"sourceUrl": "string",
"segment": "string"
},
"source": {"id": 0,
"path": "string",
"externalLink": "string"
}
}
]
}

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

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

Учитывайте, что обработка запроса может занимать значительное время. Убедитесь, что используемый вами 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

Payload

Content type

application/json

{"query": "string",
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
},
"responseGeneration": {"prompt": "string",
"showRelevantSources": true
}
}
}

Response samples

200
400

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": [{"id": 0,
"path": "string",
"externalLink": "string"
}
]
}

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

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

Получить результат можно методом 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

Payload

Content type

application/json

{"query": "string",
"settings": {"pipeline": "semantic",
"search": {"similarityTopK": 5,
"candidateRadius": 10,
"reranker": {"type": "manual",
"minScore": -10,
"maxChunksPerDocument": 1,
"maxChunks": 1,
"scoreReductionLimit": 1
},
"fullTextSearch": {"strategy": "hybrid",
"semanticPortion": 10,
"ftsPortion": 1,
"threshold": 1,
"useOnlyInSegment": true
},
"rephraseUserQuery": {"prompt": "Прочитай историю диалога, переформулируй текущий вопрос пользователя с учетом истории, добавив ее в виде контекста. Сделай вопрос более понятным, четким и структурированным. Добавь к вопросу похожие запросы и заголовок, верни текст с заголовком."
},
"segment": "FAQ"
},
"llm": {"model": "string",
"contextWindow": 4000,
"maxTokens": 500,
"temperature": 1,
"topP": 1,
"frequencyPenalty": -2,
"presencePenalty": -2
},
"responseGeneration": {"prompt": "string",
"showRelevantSources": true
}
}
}

Response samples

200
400

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": [{"id": 0,
"path": "string",
"externalLink": "string"
}
]
}

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

Возвращает текущий статус обработки запроса на генерацию ответа в пользовательском чате. Использует 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

200
400

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": [{"id": 0,
"path": "string",
"externalLink": "string"
}
]
}

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

Authorizations:

bearerAuth

path Parameters

chatId required	integer <int64> (LongId) Идентификатор чата в проекте базы знаний.
queryId required	integer <int64> (LongId) Идентификатор запроса на генерацию ответа.

Responses

Response samples

200
400

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": [{"id": 0,
"path": "string",
"externalLink": "string"
}
]
}

SourcesPublic

Работа с источниками базы знаний.

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

Возвращает информацию об источниках базы знаний.

Authorizations:

bearerAuth

query Parameters

createDateFrom	string <date> Отбирать источники, добавленные начиная с указанной даты включительно.
createDateTo	string <date> Отбирать источники, добавленные до указанной даты включительно.
sourceStatus	string Отбирать источники с указанным статусом индексации. Возможные статусы: `READY_TO_INGEST` — готов для индексации. `PROCESSING` — в обработке. `INGESTED` — проиндексирован. `FAILED_TO_INGEST` — ошибка индексации.

Responses

Response samples

200
400

Content type

application/json

{"sources": [{"id": 0,
"name": "string",
"segment": "string",
"status": "string",
"lastError": "string",
"version": "string",
"sizeBytes": 0,
"sizeChars": 0,
"createdAt": "2019-08-24T14:15:22Z"
}
]
}

Добавление по ссылке

Загружает файл по ссылке и добавляет его в качестве источника в базу знаний. После добавления источника автоматически запускается его индексация.

Authorizations:

bearerAuth

Request Body schema: application/json
required

name	string Название источника. Должно быть уникальным в рамках проекта. Если не указано, формируется автоматически.
link required	string Ссылка на файл. См. требования к файлам. Если по ссылке HTML-страница, загружается только HTML, без изображений.
segment	string Тег (сегмент) базы знаний. Если указан, источник будет доступен при поиске по этому тегу.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"link": "string",
"segment": "string"
}

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"segment": "string",
"status": "string",
"lastError": "string",
"version": "string",
"sizeBytes": 0,
"sizeChars": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Обновление по ссылке

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

Authorizations:

bearerAuth

Request Body schema: application/json
required

name	string Название источника. Если в базе знаний нет источника с таким названием, возвращается ошибка.
link required	string Ссылка на файл. См. требования к файлам. Если по ссылке HTML-страница, загружается только HTML, без изображений.
segment	string Тег (сегмент) базы знаний. Если указан, источник будет доступен при поиске по этому тегу.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"link": "string",
"segment": "string"
}

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"segment": "string",
"status": "string",
"lastError": "string",
"version": "string",
"sizeBytes": 0,
"sizeChars": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Добавление из текста

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

Authorizations:

bearerAuth

Request Body schema: application/json
required

name	string Название источника. Должно быть уникальным в рамках проекта. Если не указано, формируется автоматически.
text required	string Текст источника. Максимальный размер указан в требованиях к файлам.
segment	string Тег (сегмент) базы знаний. Если указан, источник будет доступен при поиске по этому тегу.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"text": "string",
"segment": "string"
}

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"segment": "string",
"status": "string",
"lastError": "string",
"version": "string",
"sizeBytes": 0,
"sizeChars": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Обновление из текста

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

Authorizations:

bearerAuth

Request Body schema: application/json
required

name	string Название источника. Если в базе знаний нет источника с таким названием, возвращается ошибка.
text required	string Текст источника. Максимальный размер указан в требованиях к файлам.
segment	string Тег (сегмент) базы знаний. Если указан, источник будет доступен при поиске по этому тегу.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"text": "string",
"segment": "string"
}

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"segment": "string",
"status": "string",
"lastError": "string",
"version": "string",
"sizeBytes": 0,
"sizeChars": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Добавление из файла

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

Authorizations:

bearerAuth

Request Body schema: multipart/form-data
required

file required	string <binary> Загружаемый файл. См. требования к файлам.
name	string Название источника. Должно быть уникальным в рамках проекта. Если не указано, формируется автоматически.
segment	string Тег (сегмент) базы знаний. Если указан, источник будет доступен при поиске по этому тегу.

Responses

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"segment": "string",
"status": "string",
"lastError": "string",
"version": "string",
"sizeBytes": 0,
"sizeChars": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Обновление из файла

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

Authorizations:

bearerAuth

Request Body schema: multipart/form-data
required

file required	string <binary> Загружаемый файл. См. требования к файлам.
name	string Название источника. Если в базе знаний нет источника с таким названием, возвращается ошибка.
segment	string Тег (сегмент) базы знаний. Если указан, источник будет доступен при поиске по этому тегу.

Responses

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"segment": "string",
"status": "string",
"lastError": "string",
"version": "string",
"sizeBytes": 0,
"sizeChars": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Информация об источнике

Возвращает информацию об источнике базы знаний.

Authorizations:

bearerAuth

path Parameters

sourceId

required

integer <int64> (LongId)

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

Responses

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"segment": "string",
"status": "string",
"lastError": "string",
"version": "string",
"sizeBytes": 0,
"sizeChars": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Удаление источника

Удаляет источник из базы знаний.

Authorizations:

bearerAuth

path Parameters

sourceId

required

integer <int64> (LongId)

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

Responses

Response samples

400

Content type

application/json

{"code": "string",
"description": "string"
}

Скачивание источника

Скачивает файл-источник из базы знаний.

Authorizations:

bearerAuth

path Parameters

sourceId

required

integer <int64> (LongId)

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

Responses

Response samples

400

Content type

application/json

{"code": "string",
"description": "string"
}

IntegrationsPublic

Работа с интеграциями базы знаний.

Создание интеграции

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

Authorizations:

bearerAuth

Request Body schema: application/json
required

name required	string Название интеграции.
autoSync	boolean Признак необходимости автоматически синхронизировать данные.
downloadAttachmentFiles	boolean Признак необходимости загружать прикрепленные к страницам файлы в допустимых форматах, см. требования к файлам. Эта настройка не влияет на загрузку изображений: они загружаются всегда.
syncIntervalMinutes	integer Период обновления в минутах. Не менее 30 минут.
required	object (IntegrationSettings) Настройки интеграции.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"autoSync": true,
"downloadAttachmentFiles": true,
"syncIntervalMinutes": 0,
"settings": {"baseUrl": "string"
}
}

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"autoSync": true,
"syncIntervalMinutes": 0,
"settings": {"baseUrl": "string"
},
"status": "ACTIVE",
"lastError": "string"
}

Список интеграций

Возвращает список интеграций базы знаний.

Authorizations:

bearerAuth

Responses

Response samples

200
400

Content type

application/json

{"integrations": [{"id": 0,
"name": "string",
"autoSync": true,
"syncIntervalMinutes": 0,
"settings": {"baseUrl": "string"
},
"status": "ACTIVE",
"lastError": "string"
}
]
}

Информация об интеграции

Возвращает информацию об интеграции.

Authorizations:

bearerAuth

path Parameters

integrationId

required

integer <int64> (LongId)

Идентификатор интеграции.

Responses

Response samples

200
400

Content type

application/json

{"id": 0,
"name": "string",
"autoSync": true,
"syncIntervalMinutes": 0,
"settings": {"baseUrl": "string"
},
"status": "ACTIVE",
"lastError": "string"
}

Удаление интеграции

Удаляет интеграцию из базы знаний.

Authorizations:

bearerAuth

path Parameters

integrationId

required

integer <int64> (LongId)

Идентификатор интеграции.

Responses

Response samples

400

Content type

application/json

{"code": "string",
"description": "string"
}

Jay Knowledge Hub public API (1.0.0)

ProjectsPublic

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

Authorizations:

Responses

Response samples

QueriesPublic

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

path Parameters

query Parameters

Responses

Response samples

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

Authorizations:

path Parameters

Responses

Response samples

ChatsPublic

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

path Parameters

Responses

Response samples

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

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

path Parameters

query Parameters

Responses

Response samples

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

Authorizations:

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required