$rag.chat.create

Метод создает чат в базе знаний.

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

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

Синтаксис

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

Аргумент	Тип	Описание	Обязательный
secretName	Строка	Название токена для базы знаний.	Да
name	Строка	Название чата.	Нет
settings	Объект	Настройки обработки запроса. По умолчанию используются настройки из проекта Jay Knowledge Hub. Формат settings совпадает с форматом одноименного объекта в запросе POST /api/knowledge-hub/chat в Jay Knowledge Hub API.	Нет
timeout	Число	Таймаут в миллисекундах на выполнение метода. Если таймаут превышен, возникнет ошибка. По умолчанию таймаут не установлен.	Нет

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

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

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

await $rag.chat.create("MyKnowledgeHub", "Мой чат", undefined, 5000);

Через объект

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

await $rag.chat.create({
    secretName: "MyKnowledgeHub",
    name: "Мой чат",
    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": "Мой чат"
}

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

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

В этом стейте бот создает новый чат с базой знаний и отправляет его идентификатор:

state: NewChat
    intent!: /новый чат
    scriptEs6:
        const chat = await $rag.chat.create("MyKnowledgeHub", "Мой чат");
        $reactions.answer("Идентификатор чата: " + chat.id);