Versions Compared

Key

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

...

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

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

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

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

  • Удаление БЗ

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

user_token - строковый ключ пользователя (access token, apikey) для доступа к CRUD API. Токен пользователя можно узнать в UI , для этого надо кликнуть в правом верхнем углу на свой логин.получить в разделе "Настройки” -> “Параметры прямого подключения к базам знаний через API"

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

...

REST JSON CRUD API:  https://app.swaggerhub.com/apis-docs/denis_kiselev/autofaq_crud_api/1.0 

Квоты

Квоты на доступ к учетной записи (user_token):
100 запросов в минуту
100000 запросов в день

...

Отправить обратную связь: https://autofaq.ai/api_doc#rec56022196 

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

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

Как узнать service_token для доступа опубликованной БЗ можно получить зная 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 используется для QNA API query.

Пример

service_token передается в теле запроса JSON POST . Схема запроса и параметры см в примере ниже.

Пример

В качестве примера query.

Code Block
curl -v -H "Content-Type: application/json" -XPOST https://chat.autofaq.ai/core-api/query/api/v1/query -d '
{"query": "привет, сколько стоит", "top_k": 3, "service_id": 107742, "service_token": "{service_token}"}
'

Подробнее примеры использования см вызовы методов /query и /click в click во вложении в демо скипте test_winnie_pooh.py и в документации  https://autofaq.ai/api_doc#rec56009662  

Квоты

Квоты на доступ к одной опубликованной БЗ (service_token):
900 запросов в минуту
200000 запросов в день

...