Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

 

CRUD API (design-time stage).

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

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

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

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

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

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

  • Удаление БЗ

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

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

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

Предпочтительный: http header AUTOFAQ-User-Token

Удобный для HTTP GET запросов: URL query string parameter user_token

Пример

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

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

CRUDAPI_URL=https://api.autofaq.ai/v1/setup USER_TOKEN=9d9d68ee3cc14c4d997f7ca076ed14ac \
python3 tutorial_crud_paraphrase.py 

RESTful версия CRUD API, которая описана на https://app.swaggerhub.com/apis-docs/denis_kiselev/autofaq_crud_api/1.0 

Квоты

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

QNA API (run-time stage).

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

"Отправить запрос": https://autofaq.ai/api_doc#rec56009662 

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

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

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

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

Пример

В качестве примера использования см вызовы методов /query и /click в демо скипте test_winnie_pooh.py

Квоты

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

Коды ошибок при добавлении/обновлении документов и формулировок

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 - в другом документе уже существует похожая формулировка

similar_paraphrase - текст конфликтующей формулировки (из similar_service_id/similar_document_id/similar_paraphrase_id)

  • No labels