Краткие сведения

Типы запросов	POST
Описание	Получение подсказок
Название	QuestionAndAnswering
URL	/v1/line/qna/

Описание

Метод позволяет получить варианты ответов на вопрос пользователя в базе знаний.

После получения подсказок можно отправить сообщение в чат пользователю, воспользовавшись методом 4.2.3.1. Отправить сообщение по линии поддержки.
Отправить или не отправить решаете вы на стороне своего приложения.

Обязательные условия:

С момента публикации последнего сообщения пользователя прошло не более 20 сек. (Текст сообщения в запрос не предается. Используется сохраненное сообщение пользователя);
В учетной системе на вкладке “Чат-бот” настроек линии поддержки включена опция “Использовать чат-бот для работы с обращениями“;
Уровень уверенности в ответе больше 80% (0.8).

Запрос к серверу

Поле	Тип	Описание

Поле	Тип	Описание
line_id	UUID	ID линии поддержки
user_id	UUID	ID пользователя
skip_greetings	Boolean?	Не использовать “Единая база приветствий и поддержки диалогов“
skip_goodbyes	Boolean?	Не использовать “Единая база завершения диалогов“

Ответ от сервера

Поле	Тип	Описание

Поле	Тип	Описание
question	String	Текст вопроса, на который пытался дать варианты
request_id	UUID	ID запроса
answers	Array	Массив с вариантами ответов Отсортированы по уровню уверенности
id	UUID	ID статьи базы знаний
text	String	Текст ответа
accuracy	Float	Уровень уверенности (max. 1.0 - 100%)
answer_source	String	База знаний, из которой получен ответ: GREETINGS - приветствия GOODBYES - прощания OURS - любая из ваших

Пример

HTTP запрос

POST /v1/line/qna/ HTTP/1.1
Host: push.1c-connect.com
Accept: application/json
Authorization: Basic dGVzdDp0ZXN0
Content-Type: application/json
Content-Length: 102

{"line_id": "da16b37c-513e-11ea-80fd-0025904f970d", "user_id": "26c44945-56f4-11e1-bd8d-92568227dc5f"}

Curl

curl -i -X POST "https://push.1c-connect.com/v1/line/qna/" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u test:test \
-d "{\"line_id\": \"da16b37c-513e-11ea-80fd-0025904f970d\", \"user_id\": \"26c44945-56f4-11e1-bd8d-92568227dc5f\"}"

Ответ сервера

Найден один вариант

{
    "request_id": "6ef77427-8243-4707-adcf-b2ff2e81d2d7",
    "question": "Доброе утро",
    "answers": [
        {
            "id": "16e75098-0d7a-4fa0-aa75-6e5fab9252a3",
            "text": "Доброе утро!\nC чем пришли?",
            "accuracy": 1,
            "answer_source": "GREETINGS"
        }
    ]
}

Не найдено ни одного варианта

Ошибки

Код	Описание

Код	Описание
400	Запрос содержит ошибку
401	Пользователь не авторизован
403	Недостаточно прав
422	Ошибка сервиса или запрос не прошел по требованиям

Публичная документация

4.3.1.5. Получение подсказок из баз знаний