$rag.chat.get

Метод возвращает информацию о чате базы знаний.

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

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

Синтаксис

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

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

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

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

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

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

Через объект

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

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

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

Метод возвращает объект с информацией о чате.

{
    "id": 12345,
    "settings": {
        "pipeline": "semantic",
        "search": {
            "similarityTopK": 5,
            "numCandidates": 50,
            "candidateRadius": 0,
            "rephraseUserQuery": null,
            "segment": null
        },
        "llm": {
            "model": "GPT-4o",
            "contextWindow": 16000,
            "maxTokens": 1000,
            "temperature": 0,
            "topP": 1,
            "frequencyPenalty": 0,
            "presencePenalty": 0
        },
        "responseGeneration": {
            "prompt": "You help users look for information in the documentation…"
        }
    },
    "name": "Мой чат"
}

Объект имеет такой же формат, как ответ на запрос GET /api/knowledge-hub/chat/{chatId} в Jay Knowledge Hub API.

Использование в сценарии

state: NewChat
    intent!: /новый чат
    scriptEs6:
        const chat = await $rag.chat.create("MyKnowledgeHub", "Мой чат");
        var chatInfo = await $rag.chat.get("MyKnowledgeHub", chat.id);
        $reactions.answer("Название чата: " + chatInfo.name);

В этом стейте:

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