Начало работы с примером корпоративного чата JavaScript с помощью RAG

В этой статье показано, как развернуть и запустить пример приложения корпоративного чата для JavaScript. В этом примере реализовано приложение чата с помощью JavaScript, Службы Azure OpenAI и получения дополненного поколения (RAG) в службе "Поиск ИИ Azure" , чтобы получить ответы о свойствах аренды. Приложение чата свойств аренды заполняется данными из файлов markdown (*.md), включая политику конфиденциальности, условия обслуживания и поддержку.

• Демонстрация JavaScript — видео полноэкзакционного приложения
• Демонстрация JavaScript — внешний интерфейс с видео с серверной частью Python

Начать сейчас

Следуя инструкциям в этой статье, вы получите следующее:

• Разверните приложение чата в Azure.
• Получите ответы на сведения о веб-сайте аренды свойств.
• Измените параметры, чтобы изменить поведение ответов.

Завершив эту статью, вы можете начать изменение нового проекта с помощью пользовательского кода и данных.

Эта статья является частью коллекции статей, демонстрирующих создание приложения чата с помощью Службы OpenAI Azure и поиска ИИ Azure. Другие статьи в коллекции включают:

• .NET
• Java
• Python

Обзор архитектуры

Простая архитектура приложения чата показана на следующей схеме:

Пример приложения чата создан для вымышленной компании Contoso Real Estate, и интеллектуальный интерфейс чата позволяет своим клиентам задавать вопросы о поддержке использования своих продуктов. Пример данных содержит набор документов, описывающих условия обслуживания, политику конфиденциальности и руководство по поддержке. Документы отправляются в архитектуру во время развертывания

Приложение выполняется из нескольких компонентов, в том числе:

• служба : серверная служба, предоставляющая возможности поиска и извлечения.
• Служба индексатора: служба, которая индексирует данные и создает индексы поиска.
• Веб-приложение: интерфейсное веб-приложение, которое предоставляет пользовательский интерфейс и управляет взаимодействием между пользователем и внутренними службами.

Себестоимость

Большинство ресурсов в этой архитектуре используют базовую или ценовую категорию потребления. Цены на потребление основаны на использовании, что означает, что вы оплачиваете только то, что вы используете. Чтобы завершить эту статью, будет взиматься плата, но она будет минимальной. Когда вы закончите работу со статьей, вы можете удалить ресурсы для прекращения расходов.

Дополнительные сведения о затратах в примере репозитория.

Необходимые компоненты

Среда контейнера разработки доступна со всеми зависимостями, необходимыми для выполнения этой статьи. Контейнер разработки можно запустить в GitHub Codespaces (в браузере) или локально с помощью Visual Studio Code.

Чтобы использовать эту статью, вам потребуются следующие предварительные требования:

Пространства кода (рекомендуется)

1. подписка Azure — создайте бесплатную учетную запись.
2. Разрешения учетной записи Azure. Учетная запись Azure должна иметь разрешения Microsoft.Authorization/roleAssignments/write, такие как доступ пользователей Администратор istrator или владелец.
3. Доступ, предоставленный Azure OpenAI в требуемой подписке Azure. В настоящее время доступ к этой службе предоставляется только приложением. Вы можете подать заявку на доступ к Azure OpenAI, выполнив форму по адресу https://aka.ms/oai/access. Если у вас возникли проблемы, создайте соответствующий запрос в этом репозитории, чтобы связаться с нами.
4. учетная запись GitHub;

Visual Studio Code

1. подписка Azure — создайте бесплатную учетную запись.
2. Разрешения учетной записи Azure. Учетная запись Azure должна иметь разрешения Microsoft.Authorization/roleAssignments/write, такие как доступ пользователей Администратор istrator или владелец.
3. Доступ, предоставленный Azure OpenAI в требуемой подписке Azure. В настоящее время доступ к этой службе предоставляется только приложением. Вы можете подать заявку на доступ к Azure OpenAI, выполнив форму по адресу https://aka.ms/oai/access. Если у вас возникли проблемы, создайте соответствующий запрос в этом репозитории, чтобы связаться с нами.
4. Интерфейс командной строки разработчика Azure
5. Docker Desktop — запустите Docker Desktop , если он еще не запущен
6. Visual Studio Code
7. Расширение контейнера разработки

Открытие среды разработки

Начните с среды разработки, которая содержит все зависимости, установленные для выполнения этой статьи.

Пространства кода GitHub (рекомендуется)

GitHub Codespaces запускает контейнер разработки, управляемый GitHub, с Помощью Visual Studio Code для Интернета в качестве пользовательского интерфейса. Для наиболее простой среды разработки используйте GitHub Codespaces, чтобы у вас были правильные средства разработчика и зависимости, предварительно установленные для выполнения этой статьи.

Внимание

Все учетные записи GitHub могут использовать пространства Кода до 60 часов бесплатно каждый месяц с 2 основными экземплярами. Дополнительные сведения см. в GitHub Codespaces ежемесячно включаемых в хранилище и основные часы.

1. Запустите процесс создания нового пространства кода GitHub в main ветви Azure-Samples/azure-search-openai-javascript репозитория GitHub.

2. Щелкните правой кнопкой мыши следующую кнопку и выберите "Открыть ссылку" в новых окнах , чтобы одновременно иметь среду разработки и документацию.

   Открытие этого проекта в GitHub Codespaces

3. На странице "Создание пространства кода" просмотрите параметры конфигурации пространства кода и выберите "Создать новое пространство кода"

   

4. Дождитесь запуска пространства кода. Этот процесс запуска может занять несколько минут.

5. В терминале в нижней части экрана войдите в Azure с помощью Интерфейса командной строки разработчика Azure.

   azd auth login
   

6. Скопируйте код из терминала и вставьте его в браузер. Следуйте инструкциям по проверке подлинности с помощью учетной записи Azure.

7. Остальные задачи в этой статье выполняются в контексте этого контейнера разработки.

Visual Studio Code

Расширение "Контейнеры разработки" для Visual Studio Code требует установки Docker на локальном компьютере. Расширение размещает контейнер разработки локально с помощью узла Docker с правильными средствами разработчика и предустановленными зависимостями для выполнения этой статьи.

1. Откройте Visual Studio Code в контексте пустого каталога.

2. Убедитесь, что у вас есть расширение "Контейнеры разработки" в Visual Studio Code.

3. Откройте новый терминал в редакторе.

   Совет

   Вы можете использовать главное меню для перехода к параметру меню терминала , а затем выберите пункт "Новый терминал ".

   

4. Войдите в Azure с помощью Интерфейса командной строки разработчика Azure.

   azd auth login
   

   Скопируйте код из терминала и вставьте его в браузер. Следуйте инструкциям по проверке подлинности с помощью учетной записи Azure.

5. Создайте папку и инициализируйте ее для использования примера проекта с azure Developer CLI:

   azd init -t azure-search-openai-javascript
   

   Клонировать этот репозиторий не нужно.

6. Откройте палитру команд, найдите команды "Контейнеры разработки", а затем выберите "Контейнеры разработки: снова открыть в контейнере".

   Совет

   Visual Studio Code может автоматически запрашивать повторно открыть существующую папку в контейнере разработки. Это функционально эквивалентно использованию палитры команд для повторного открытия текущей рабочей области в контейнере.

7. Снова откройте окно терминала (CTRL + `) и оставьте его открытым.

8. Остальные упражнения в этом проекте происходят в контексте этого контейнера разработки.

Развертывание и запуск

Пример репозитория содержит все файлы кода и конфигурации, необходимые для развертывания приложения чата в Azure. Ниже приведены инструкции по развертыванию примера в Azure.

Развертывание приложения чата в Azure

Внимание

Ресурсы Azure, созданные в этом разделе, несут немедленные затраты, в первую очередь из ресурса поиска ИИ Azure. Эти ресурсы могут начислять затраты, даже если вы прерываете команду до его полного выполнения.

1. Выполните следующую команду Командной строки разработчика Azure, чтобы подготовить ресурсы Azure и развернуть исходный код:

   azd up
   

2. Когда вам будет предложено ввести имя среды, сохраните его коротким и строчным регистром. Например, myenv. Он используется в качестве части имени группы ресурсов.

3. При появлении запроса выберите подписку, чтобы создать ресурсы.

4. Когда появится запрос на выбор расположения в первый раз, выберите расположение рядом с вами. Это расположение используется для большинства ресурсов, включая размещение.

5. Если вам будет предложено указать расположение для модели OpenAI, выберите расположение, которое находится рядом с вами. Если то же расположение доступно в качестве первого расположения, выберите это.

6. Дождитесь развертывания приложения. Для завершения развертывания может потребоваться 5–10 минут.

7. После успешного развертывания приложения вы увидите URL-адрес, отображаемый в терминале.

8. Выберите этот URL-адрес, чтобы Deploying service web открыть приложение чата в браузере.

   

Использование приложения чата для получения ответов из файлов Markdown

Приложение чата предварительно загружено с информацией о аренде из каталога файлов Markdown. Вы можете использовать приложение чата, чтобы задать вопросы о процессе аренды. В следующих шагах описан процесс использования приложения чата.

1. В браузере выберите или введите политику возврата в текстовом поле в нижней части страницы.

   

2. В ответе выберите "Показать мыслительный процесс".

   

3. На правой панели используйте вкладки, чтобы понять, как был создан ответ.

   Вкладка	Описание
   Процесс мысли	Это сценарий взаимодействия в чате. Вы можете просмотреть системный запрос (content) и вопрос пользователя (content).
   Вспомогательное содержимое	Сюда входят сведения для ответа на ваш вопрос и исходный материал. Количество ссылок на исходные материалы отмечается в параметрах разработчика. Значение по умолчанию — 3.
   Источник	Откроется исходная страница, содержащая ссылку.

4. По завершении нажмите кнопку скрытия, обозначаемую X над вкладками.

Использование параметров приложения чата для изменения поведения ответов

Аналитика приложения чата определяется моделью OpenAI и параметрами, которые используются для взаимодействия с моделью.

Параметр	Description
Переопределение шаблона запроса	Это запрос, используемый для создания ответа.
Получение этого большого количества результатов поиска	Это количество результатов поиска, используемых для создания ответа. Эти источники отображаются в процессе мысли и вкладках содержимого поддержки ссылки.
Исключить категорию	Это категория документов, исключенных из результатов поиска.
Использование семантического ранга для извлечения	Это функция службы "Поиск ИИ Azure", использующая машинное обучение для повышения релевантности результатов поиска.
Использование сводок в контекстном запросе вместо целых документов	Use semantic ranker Если оба и Use query-contextual summaries проверка, LLM использует подпись, извлеченные из ключевых проходов, а не все проходы, в документах с наивысшим рейтингом.
Советы по дальнейшим вопросам	Предложите в приложении чата дальнейшие вопросы на основе ответа.
Режим извлечения	Vectors + Text означает, что результаты поиска основаны на тексте документов и внедрении документов. Векторы означает, что результаты поиска основаны на внедрениях документов. Текст означает, что результаты поиска основаны на тексте документов.
Ответы на завершение чата потоковой передачи	Поток ответа вместо ожидания, пока полный ответ не будет доступен для ответа.

Ниже описан процесс изменения параметров.

1. В браузере выберите вкладку "Разработчик Параметры".

2. Проверьте сводки с использованием контекстных запросов вместо проверка box и задайте один и тот же вопрос еще раз.

   What happens if the rental doesn't fit the description?
   

   Чат вернулся с более кратким ответом, например следующим.

Очистка ресурсов

Очистка ресурсов Azure

Ресурсы Azure, созданные в этой статье, выставляются в подписку Azure. Если вы не ожидаете, что эти ресурсы потребуются в будущем, удалите их, чтобы избежать дополнительных расходов.

Выполните следующую команду Командной строки разработчика Azure, чтобы удалить ресурсы Azure и удалить исходный код:

azd down --purge

Очистка GitHub Codespaces

GitHub Codespaces

Удаление среды GitHub Codespaces гарантирует, что вы можете максимально увеличить объем бесплатных прав на базовые часы, которые вы получаете для вашей учетной записи.

Внимание

Дополнительные сведения о правах учетной записи GitHub см . в GitHub Codespaces ежемесячно включено в хранилище и основные часы.

1. Войдите на панель мониторинга GitHub Codespaces (https://github.com/codespaces).

2. Найдите текущие пространства кода, полученные из Azure-Samples/azure-search-openai-javascript репозитория GitHub.

   

3. Откройте контекстное меню для пространства кода и нажмите кнопку "Удалить".

   

Visual Studio Code

Для очистки локальной среды не обязательно требуется, но вы можете остановить запущенный контейнер разработки и вернуться к запуску Visual Studio Code в контексте локальной рабочей области.

1. Откройте палитру команд, найдите команды "Контейнеры разработки", а затем выберите "Контейнеры разработки: открыть папку локально".

   

Совет

Visual Studio Code остановит запущенный контейнер разработки, но контейнер по-прежнему существует в Docker в остановленном состоянии. Вы всегда можете удалить экземпляр контейнера, образ контейнера и тома из Docker, чтобы освободить больше места на локальном компьютере.

Получить помощь

Этот пример репозитория предлагает сведения об устранении неполадок.

Если ваш выпуск не устранен, зайдите в журнал проблемы репозитория.

Следующие шаги

• Репозиторий приложения корпоративного чата GitHub
• Создание приложения чата с помощью архитектуры решения Azure OpenAI
• Управление доступом в созданных приложениях ИИ с помощью службы "Поиск ИИ Azure"
• Создание готового решения OpenAI enterprise с помощью Azure Управление API
• Перебор векторного поиска с гибридными возможностями извлечения и ранжирования