Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • от имени пользователя вести переписку с сервисом AutoFAQ, включая переписку с ботом и операторами сервиса

  • создавать рассылки пользователям

  • управлять настройками сервиса

https://app.swaggerhub.com/apis-docs/AutoFAQ.ai/external-api/2.1.4 Swagger документация API

Knowledge base CRUD API для управления базами знаний

...

/core-api/crud/

CRUD API служит для создания Баз Знаний, наполения наполнения их документами и публикации (design-time).

Для удобства все PUT JSON вызовы работают как REST JSON PATCH - то есть можно передать только те поля, значения которых необходимо обновить (нет нужды передавать полное состояние)

https://app.swaggerhub.com/apis-docs/AutoFAQ.ai/aq_kb_crud/1.0 Swagger документация

Жизненный цикл БЗ:

  • Создание. БЗ имеет имя, настройки языка, режима дообучения и apikey service_token для доступа к опубликованному сервису QNA.

  • Наполнение документами. Документ - это (вопрос, ответ, опционально формулировки вопроса, файловые атачи)

  • Публикация. Опубликованная БЗ предоставляет сервис ответов на вопросы (см QNA API ниже)

  • Редактирование контента, модерация и прием рекоммендаций документов и формулировок.

  • Удаление БЗ

...

  • 100 запросов в минуту

  • 100000 запросов в день

Knowledge base QNA API

...

/core-api/query/

QNA API служит для запросов на классификацию в опубликованной базе знаний и отправке обратной связи для дообучения базы знаний (run-time).

API позволяет

  • отправить запрос на классификацию текста по одной базе знаний

  • отправить пакетный запрос на классификацию по нескольким базам знаний сразу

  • отправить информацию для дообучения базы знаний (расширению обучающей выборки существующих записей или созданию новых записей)

...

service_token - строковый ключ опубликованный БЗ к QNA API (access token, apikey) .Как узнать service_token для доступа опубликованной БЗ.

Ключ можно получить из UI на странице настроек БЗ либо из CRUD API зная user_token запросом CRUD API GET /core-api/crud/api/v1/services/{service_id}

Code Block
curl -H "AUTOFAQ-User-Token: {user_token}" https://chat.autofaq.ai/core-api/crud/api/v1/services/{service_id}

...

Пример

service_token передается в теле запроса JSON POST query.

...