$rag.chat.processQueryAsync
Метод создает запрос на генерацию ответа в базе знаний. При ответе будет учитываться история в чате базы знаний.
Метод доступен только в среде ECMAScript 6 и является асинхронным.
Синтаксис
Метод принимает аргументы:
Аргумент | Тип | Описание | Обязательный |
---|---|---|---|
secretName | Строка | Название токена для базы знаний. | Да |
chatId | Число |
$rag.chat.create . | Да |
query | Строка | Текстовый запрос пользователя. | Да |
settings | Объект | Настройки обработки запроса. По умолчанию используются настройки из чата. Форматsettings совпадает с форматом одноименного объекта в запросе POST /api/knowledge-hub/async/chat/{chatId}/query в Jay Knowledge Hub API. | Нет |
timeout | Число | Таймаут в миллисекундах на выполнение метода. Если таймаут превышен, возникнет ошибка. По умолчанию таймаут не установлен. | Нет |
Вы можете передавать аргументы в метод разными способами.
- Позиционные аргументы
- Через объект
Укажите аргументы по порядку:
await $rag.chat.processQueryAsync("MyKnowledgeHub", 12345, "Что делает сервис Example?", undefined, 5000);
Передайте объект, поля которого совпадают с названиями аргументов:
await $rag.chat.processQueryAsync({
secretName: "MyKnowledgeHub",
chatId: 12345,
query: "Что делает сервис Example?",
timeout: 5000
});
Возвращаемое значение
Метод возвращает объект с информацией о созданном запросе.
{
"id": 11111,
"chatId": 12345,
"request": "Что делает сервис Example?",
"status": "READY_TO_PROCESS",
"createdAt": "2024-12-03T17:05:22.928610258Z",
"response": null,
"updatedAt": "2024-12-03T17:05:22.928613255Z",
"comment": null
}
Объект имеет такой же формат, как ответ на запрос POST /api/knowledge-hub/async/chat/{chatId}/query
в Jay Knowledge Hub API.
Использование в сценарии
state: Answer
intent!: /вопрос
scriptEs6:
$client.chat = $client.chat || await $rag.chat.create("MyKnowledgeHub", "Мой чат");
const ragRequest = await $rag.chat.processQueryAsync("MyKnowledgeHub", $client.chat.id, $request.query);
$session.currentId = ragRequest.id
В этом стейте:
- Если чата еще нет, бот создает чат.
- Бот создает запрос и сохраняет его идентификатор.
Далее этот идентификатор можно использовать в методах $rag.chat.getQueryAnswer
и $rag.chat.cancelRecordProcessing
.