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

POST /api/v1/knowledges

URL

https://app.helpfy.ai/api/v1/knowledges

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

Заголовки

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

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

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

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

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

Поле	Тип	Обязательно	Описание
document_id	строка	Нет	Уникальный идентификатор документа.
bot_unique_id	строка	Да	Уникальный идентификатор бота.
knowledge_group_unique_id	строка	Да	Уникальный идентификатор группы базы знаний.
name	строка	Да	Название документа.
type	FILE, SITE, TEXT	Да	Тип документа: текст, файл или страница сайта.
content	строка	Да	Текст документа базы знаний.
source	строка	Нет	Ссылка или примечание к источнику, из которого взята информация.
is_private_source	логическое значение	Нет	Скрывать ссылку на источник в ответах. Содержимое документа при этом может использоваться. (по умолчанию: true)
is_indexed	логическое значение	Нет	Участвует ли содержимое документа в поиске информации для ответов. (по умолчанию: true)

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

curl --request POST 'https://app.helpfy.ai/api/v1/knowledges' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "bot_unique_id": "11111111-1111-4111-8111-111111111111",
  "knowledge_group_unique_id": "11111111-1111-4111-8111-111111111111",
  "name": "Служба поддержки",
  "type": "FILE",
  "content": "Адрес доставки можно изменить до передачи заказа в доставку."
}
JSON

Ответы

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

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

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

{
  "message": "Knowledge successfully created",
  "is_exists": true,
  "data": {
    "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
    "type": "FILE",
    "name": "Руководство пользователя",
    "hash_sum": "7a667b56cecb6137b7486d17b6e4c8a4ff922af1218425a5442b946acbf67860",
    "document_id": "",
    "source": "https://example.com/article/1",
    "is_private_source": true,
    "is_indexed": true,
    "created_at": "2024-10-18T14:13:46.180Z",
    "updated_at": "2024-10-18T14:13:46.180Z",
    "bot": {
      "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "name": "Main knowledge bot",
      "primary_language": "ru",
      "first_line_greeting_enabled": true,
      "first_line_greeting_text": "Hello! How can I assist you today?",
      "rag_clarify_enabled": true,
      "scenario_clarify_enabled": false,
      "scenario_clarify_min_confidence": 55,
      "scenario_clarify_margin": 12,
      "allow_public_sources_in_support": true,
      "tools_enabled": false,
      "anonymize_pii": false,
      "max_output_tokens": 1000,
      "created_at": "2024-10-18T14:13:46.180Z",
      "updated_at": "2024-10-18T14:13:46.180Z"
    }
  }
}