Page Comparison

...

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

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

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

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

• Удаление БЗ

...

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 запросов в день

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

REST JSON CRUD API:  https://app.swaggerhub.com/apis/AutoFAQ.ai/aq_kb_crud/1.0

Квоты

100 запросов в минуту
100000 запросов в день

Knowledge base QNA API (run-time).

QNA API служит для запросов к опубликованной базе знаний (БЗ) и сбора обратной связи.Отправить

• Как отправить запрос в

...

• БЗ

...

• Как отправить запрос сразу в несколько БЗ

...

• Как Отправить обратную связь

...

• (для дообучения БЗ посредством создания рекомендаций документов и формулировок)

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

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

...

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

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

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

Примеры

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

Пример добавления документа с формулировками:

...

HTTP 400, 403, 401
JSON response:

{

...

 "error":  {

...

"type": "string",

...

"enum": ["paraphrases_quota_exceeded", "similar_paraphrase", "similar_document"]

...

},

...

 "message": {"type": "string"},

...

"similar_service_id": {"type": "integer"},

...

 "similar_document_id":  {"type": "integer"},

...

 "similar_paraphrase_id":  {"type": "integer"},

...

"similar_paraphrase": {"type": "string"}

...

}

Описание error:

• paraphrases_quota_exceeded - превышено ограничение на количество формулировок в документе

• similar_paraphrase - в этом документе уже существует похожая формулировка

• similar_document - в другом документе уже существует похожая формулировка

...