Page Comparison

...

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

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

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

Swagger документация API

...

KB CRUD API для управления

...

Базами Знаний /core-api/crud/

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

...

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

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

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

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

• Удаление БЗ

Аутентификация

Возможны 2 варианта аутентификации

1. user_token - строковый ключ пользователя (access token, apikey) можно узнать

...

1. у администратора.

2. jwt cookie полученная при авторизации в UI на странице /login либо через API вызов /api/ext/v2/login

При использовании user_token может быть передан несколькими способами:

1. Предпочтительный: Standard Basic Auth HTTP header - Authorization: Bearer {user_token}

2. Альтернативный: Private HTTP header AUTOFAQ-User-Token: {user_token}

3. Для отладки: Через URL query query parameter - user_token={user_token}

Квоты

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

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

...

KB QNA API /core-api/query/

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

...

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

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

service_token передается в теле запроса вместе с запрашиваемой БЗ service_id:

...

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

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

Квоты

Квоты на доступ к одной опубликованной БЗ (service_token):

...

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

...

Примеры

Тривиальный пример жизненного цикла см скрипт test_winnie_pooh.py во вложении выше на этой странице .

...