$rag.chat.cancelRecordProcessing

Метод отменяет генерацию ответа в чате базе знаний.

предупреждение

Метод доступен только в среде ECMAScript 6 и является асинхронным.

Синтаксис

Метод принимает аргументы:

Аргумент	Тип	Описание	Обязательный
secretName	Строка	Название токена для базы знаний.	Да
chatId	Число	chatId — идентификатор чата. Используйте идентификатор, который вернул метод $rag.chat.create.	Да
queryId	Число	Идентификатор запроса на генерацию ответа. Используйте идентификатор, который вернул метод $rag.chat.processQueryAsync.	Да
timeout	Число	Таймаут в миллисекундах на выполнение метода. Если таймаут превышен, возникнет ошибка. По умолчанию таймаут не установлен.	Нет

Вы можете передавать аргументы в метод разными способами.

Позиционные аргументы

Укажите аргументы по порядку:

await $rag.chat.cancelRecordProcessing("MyKnowledgeHub", 12345, 11111, 5000);

Через объект

Передайте объект, поля которого совпадают с названиями аргументов:

await $rag.chat.cancelRecordProcessing({
    secretName: "MyKnowledgeHub",
    chatId: 12345,
    queryId: 11111,
    timeout: 5000
});

Возвращаемое значение

Метод возвращает объект с информацией о запросе на генерацию ответа. Если запрос отменен успешно, то указан статус CANCELED.

{
    "id": 11111,
    "chatId": 12345,
    "request": "Что делает сервис Example?",
    "status": "CANCELED",
    "createdAt": "2024-12-04T07:44:48.401037Z",
    "response": null,
    "updatedAt": "2024-12-04T07:44:48.401039Z",
    "comment": null
}

Объект имеет такой же формат, как ответ на запрос POST /api/knowledge-hub/chat/{chatId}/query/{queryId}/cancel в 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);

        var cancelRequest =  await $rag.chat.cancelRecordProcessing("MyKnowledgeHub", $client.chat.id, ragRequest.id)
        $reactions.answer("Статус запроса:" + cancelRequest.status)

1. Если чата еще нет, бот создает чат.
2. Бот создает запрос и сохраняет его идентификатор.
3. Бот отменяет запрос по этому идентификатору и отправляет статус пользователю.