$rag.retrieveChunks

Метод возвращает чанки, которые релевантны для запроса пользователя.

Синтаксис

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

Аргумент	Тип	Описание	Обязательный
secretName	Строка	Название токена для базы знаний.	Да
query	Строка	Текстовый запрос пользователя.	Да
history	Массив	История диалога с базой знаний.	Нет
settings	Объект	Настройки поиска чанков. По умолчанию используются настройки из проекта Jay Knowledge Hub.	Нет

подсказка

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

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

await $rag.retrieveChunks(secretName, query, history, settings);

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

Метод возвращает объект со списком чанков. Они отсортированы в порядке убывания релевантности.

{
    "chunks": [
        {
            "score": 0.7486038,
            "content": "Сервис Example обрабатывает запросы пользователей …",
            "docId": "Документация.pdf",
            "metadata": null
        },
        {
            "score": 0.7337575,
            "content": "Сервис Example может выдерживать большую нагрузку …",
            "docId": "Сервисы.pdf",
            "metadata": null
        }
    ]
}

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

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

В этом стейте бот отправит пользователю самый релевантный чанк:

state: Chunks
    intent!: /вопрос
    scriptEs6:
        const chunks = await $rag.retrieveChunks("MyKnowledgeHub", $request.query);
        $reactions.answer(chunks.chunks[0].content);