Скачать журнал похожих документов в CSV
GET /api/v1/knowledge-integrity/semantic-duplicates/journal/csv
Выгружает историю поиска похожих документов для доступного вам бота.
URL
https://app.helpfy.ai/api/v1/knowledge-integrity/semantic-duplicates/journal/csv
Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.
Заголовки
| Заголовок | Значение |
|---|---|
Authorization | Basic <base64(email:api_key)> |
Accept | application/json |
Подробнее — авторизация API.
Параметры запроса
Параметры строки запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
unique_id | строка | Нет | Отбирать проверки по идентификатору. |
bot_unique_id | строка | Да | Отбирать проверки по боту. |
kind | STRUCTURAL, SEMANTIC_DUPLICATES | Нет | Отбирать проверки по виду. |
scope | GLOBAL, USER, BOT | Нет | Отбирать проверки по области действия. |
status | RUNNING, COMPLETED, FAILED | Нет | Отбирать проверки по статусу. |
start_date | строка | Нет | Первый день периода проверок в формате ГГГГ-ММ-ДД. |
end_date | строка | Нет | Последний день периода проверок в формате ГГГГ-ММ-ДД. |
skip | число | Нет | Количество записей, которые нужно пропустить при просмотре списка. |
take | число | Нет | Количество записей, возвращаемых за один запрос. |
Пример запроса
curl --request GET 'https://app.helpfy.ai/api/v1/knowledge-integrity/semantic-duplicates/journal/csv' \
--user 'user@example.com:api_key' \
--header 'Accept: application/json' \
--get \
--data-urlencode 'bot_unique_id=f27bd861-8ad5-432d-9945-4e22458d6049'
Ответы
| HTTP | Описание |
|---|---|
| 200 | Файл в формате CSV. |
Пример ответа
JSON-тело ответа не описано в API этого метода. Ориентируйтесь на HTTP-статус.