Versions Compared

Key

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

...

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

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

  • Создание. БЗ имеет имя, настройки языка, режима дообучения и 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}

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

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

...