$rag.chat.create

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

Синтаксис

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

Аргумент	Тип	Описание	Обязательный
secretName	Строка	Название токена для базы знаний.	Да
name	Строка	Название чата.	Нет
settings	Объект	Настройки чата.	Нет

подсказка

Формат settings совпадает с форматом одноименного объекта в запросе POST /api/knowledge-hub/chat в Jay Knowledge Hub API.

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

await $rag.chat.create(secretName, name, settings);

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

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

{
    "id": 12345,
    "settings": {
        "pipeline": "semantic",
        "search": {
            "similarityTopK": 5,
            "numCandidates": 50,
            "candidateRadius": 0,
            "rephraseUserQuery": null,
            "segment": null
        },
        "llm": {
            "model": "openai/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);