Найти похожие документы

POST /api/v1/knowledge-integrity/semantic-duplicates/scan

Ищет похожие по смыслу пары документов в базе знаний одного бота.

URL

https://app.helpfy.ai/api/v1/knowledge-integrity/semantic-duplicates/scan

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Для JSON-тела передайте Content-Type: application/json.

Подробнее — авторизация API.

Параметры запроса

Тело запроса (application/json)

Поле	Тип	Обязательно	Описание
bot_unique_id	строка	Да	Идентификатор целевого бота.
similarity_threshold	число	Нет	Минимальная схожесть от 0,75 до 0,99. Чем выше значение, тем строже отбор.
max_neighbors	число	Нет	Сколько ближайших фрагментов проверять перед объединением результатов в пары документов.
max_issues	число	Нет	Максимальное количество пар документов в результатах проверки.

Пример запроса

curl --request POST 'https://app.helpfy.ai/api/v1/knowledge-integrity/semantic-duplicates/scan' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "bot_unique_id": "f27bd861-8ad5-432d-9945-4e22458d6049"
}
JSON

Ответы

HTTP	Описание
201	Успешный ответ

Пример ответа — HTTP 201

Сокращённый пример; показаны клиентские поля. Значения условные.

{
  "message": "Integrity scan started",
  "scan_id": "7827d9b8-8bb8-428b-984a-7bfcf3221f1f"
}