Управляйте проектами с помощью Google Chat, Vertex AI и Firestore.

В этом руководстве показано, как создать приложение Google Chat, которое команда сможет использовать для управления проектами в режиме реального времени. Приложение Chat использует Vertex AI, чтобы помочь командам писать пользовательские истории (которые представляют собой функции программной системы с точки зрения пользователя, которые команда должна разработать) и сохраняет эти истории в базе данных Firestore.

Предварительные требования

• Корпоративный аккаунт Google Workspace с доступом к Google Chat .

• Для выполнения следующих действий необходим доступ к сервисам Google Cloud:

  • Создайте проект в Google Cloud.
  • Привяжите учетную запись Google Cloud для выставления счетов к проекту Cloud. Чтобы узнать, есть ли у вас доступ, см. раздел «Разрешения, необходимые для включения выставления счетов» .

  • Используйте неаутентифицированные вызовы Google Cloud Function , что можно проверить, определив, использует ли ваша организация Google Cloud ограниченный доступ к ресурсам домена .

  При необходимости обратитесь к администратору Google Cloud за доступом или разрешением.

• Если вы используете Google Cloud CLI , вам потребуется среда разработки Node.js, настроенная для работы с gcloud CLI. См. раздел «Настройка среды разработки Node.js» .

Цели

• Разработайте чат-приложение для управления гибкими проектами по разработке программного обеспечения.
• Помогите пользователям создавать пользовательские истории с помощью инструментов для написания историй, использующих генеративный искусственный интеллект, разработанных компанией Vertex AI:
  • Генерировать и обновлять описания сюжетов.
  • Расширьте описание сюжета, перейдя от примечаний к полному перечню требований.
  • Исправьте грамматические ошибки, чтобы исправить опечатки.
• Поддерживайте актуальность данных, записывая и считывая информацию из базы данных Firestore.
• Упростите совместную работу в чате, позволив пользователям создавать, редактировать, назначать задачи и начинать работу над ними непосредственно из беседы.

Используемые продукты

Приложение для управления проектами использует следующие продукты Google Workspace и Google Cloud:

• API чата : API для разработки приложений Google Chat, которые получают и обрабатывают события взаимодействия в чате, такие как сообщения. Приложение Google Chat для управления проектами использует API чата для получения и обработки событий взаимодействия, отправляемых чатом, а также для настройки атрибутов, определяющих внешний вид в чате, таких как имя и изображение аватара.
• Vertex AI API : платформа генеративного искусственного интеллекта. Приложение Google Chat для управления проектами использует Vertex AI API для написания заголовков и описаний пользовательских историй.
• Firestore : Бессерверная база данных документов. Приложение Google Chat для управления проектами использует Firebase для хранения данных о пользовательских историях.

• Cloud Functions : Легковесный бессерверный вычислительный сервис, позволяющий создавать отдельные автономные функции, способные реагировать на события взаимодействия в чате без необходимости управления сервером или средой выполнения. Приложение Google Chat для управления проектами использует Cloud Functions в качестве HTTP-терминала, на который чат отправляет события взаимодействия, а также в качестве вычислительной платформы для выполнения логики, обрабатывающей эти события и реагирующей на них.

  Для создания, обработки событий взаимодействия и размещения вычислительных ресурсов Cloud Functions использует следующие продукты Google Cloud:

  • Cloud Build : Полностью управляемая платформа непрерывной интеграции, доставки и развертывания, которая запускает автоматизированные сборки.
  • Pub/Sub : асинхронная и масштабируемая служба обмена сообщениями, которая отделяет службы, генерирующие сообщения, от служб, обрабатывающих эти сообщения.
  • Cloud Run Admin API : Полностью управляемая среда для запуска контейнеризированных приложений.

Архитектура

Архитектура приложения Google Chat для управления проектами принимает и обрабатывает события взаимодействия в чате через HTTP-терминал, использует Vertex AI для помощи в написании пользовательских историй и хранит подробную информацию о пользовательских историях в базе данных Firestore. На следующей диаграмме показана архитектура используемых ресурсов Google Workspace и Google Cloud.

Приложение Google Chat для управления проектами работает следующим образом:

1. Пользователь отправляет сообщение в чате и вызывает приложение Google Chat для управления проектами, либо отправив сообщение напрямую, либо упомянув пользователя в пробеле, либо введя команду с косой чертой.

2. Чат отправляет синхронный HTTP-запрос на HTTP-конечную точку облачной функции.

3. Приложение Google Chat для управления проектами обрабатывает HTTP-запрос:

   1. Vertex AI помогает писать или обновлять пользовательские истории.

   2. База данных Firestore хранит, извлекает, обновляет или удаляет данные пользовательских историй.

4. Cloud Functions возвращает HTTP-ответ в чат, который отображает его пользователю либо в виде сообщения, либо в виде диалогового окна.

Подготовьте окружающую среду

В этом разделе показано, как создать и настроить проект Google Cloud для приложения «Чат».

Создайте проект в Google Cloud.

Консоль Google Cloud

1. В консоли Google Cloud перейдите в menu > IAM и администрирование > Создать проект .

   Перейдите в раздел «Создать проект».

2. В поле «Название проекта» введите описательное название для вашего проекта.

   Необязательно: чтобы изменить идентификатор проекта , нажмите «Редактировать» . Идентификатор проекта нельзя изменить после его создания, поэтому выберите идентификатор, который будет соответствовать вашим потребностям на протяжении всего срока действия проекта.

3. В поле «Местоположение» нажмите «Обзор» , чтобы отобразить возможные места для вашего проекта. Затем нажмите «Выбрать» .
4. Нажмите «Создать» . Консоль Google Cloud перенаправит вас на страницу «Панель управления», и ваш проект будет создан в течение нескольких минут.

gcloud CLI

В одной из следующих сред разработки получите доступ к интерфейсу командной строки Google Cloud ( gcloud ):

• Cloud Shell : Чтобы использовать онлайн-терминал с уже настроенным интерфейсом командной строки gcloud, активируйте Cloud Shell.
  Активировать Cloud Shell
• Локальная оболочка : Для использования локальной среды разработки установите и инициализируйте интерфейс командной строки gcloud.
  Для создания облачного проекта используйте команду ` gcloud projects create :

  gcloud projects create PROJECT_ID

  Замените PROJECT_ID на идентификатор проекта, который вы хотите создать.

Включить выставление счетов для облачного проекта

Консоль Google Cloud

1. В консоли Google Cloud перейдите в menu «Биллинг» . Нажмите меню > Биллинг > Мои проекты .

   Перейдите в раздел «Оплата моих проектов».

2. В разделе «Выберите организацию» выберите организацию, связанную с вашим проектом Google Cloud.
3. В строке проекта откройте меню «Действия» ( more_vert ), нажмите «Изменить выставление счетов» и выберите учетную запись Cloud Billing.
4. Нажмите «Настроить учетную запись» .

gcloud CLI

1. Чтобы отобразить список доступных платежных аккаунтов, выполните следующую команду:

   gcloud billing accounts list

2. Свяжите платежный аккаунт с проектом Google Cloud:

   gcloud billing projects link PROJECT_ID --billing-account=BILLING_ACCOUNT_ID

   Заменить следующее:

   • PROJECT_ID — это идентификатор проекта в облаке, для которого вы хотите включить выставление счетов.
   • BILLING_ACCOUNT_ID — это идентификатор платежного аккаунта , который будет связан с проектом Google Cloud.

Включите API

Аутентификация и авторизация

Для выполнения данного руководства настройка аутентификации и авторизации не требуется.

Для вызова API Firestore и Vertex AI в этом руководстве используются учетные данные приложения по умолчанию с учетной записью службы по умолчанию, привязанной к облачной функции, которую вам не нужно настраивать. В контексте производственной среды вы обычно создаете и привязываете учетную запись службы к облачной функции.

Создайте и разверните приложение Google Чат.

Теперь, когда ваш проект Google Cloud создан и настроен, вы готовы к сборке и развертыванию приложения Google Chat. В этом разделе вы выполните следующие действия:

1. Создайте базу данных Firestore для хранения и извлечения пользовательских историй.
2. При желании, ознакомьтесь с примером кода.
3. Создайте облачную функцию для размещения и выполнения кода приложения «Чат» в ответ на события, полученные от «Чата» в виде HTTP-запросов.
4. Создайте и разверните приложение Google Chat на странице конфигурации API Google Chat.

Создайте базу данных Firestore.

В этом разделе вы создадите базу данных Firestore для сохранения и извлечения пользовательских историй, но не будете определять модель данных. Модель данных задается неявно в примере кода с помощью файлов model/user-story.js и model/user.js .

В базе данных приложения для управления проектами и чата используется модель данных NoSQL, основанная на документах class , организованных в коллекции collections_bookmark . Для получения дополнительной информации см. модель данных Firestore .

На следующей диаграмме представлен общий обзор модели данных приложения Google Chat для управления проектами:

Корневая коллекция — это spaces , где каждый документ представляет собой пространство, в котором приложение чата создавало истории. Каждая пользовательская история представлена ​​документом в подколлекции userStories , а каждый пользователь — документом в подколлекции users .

Вот как создать базу данных Firestore:

Ознакомьтесь с примером кода.

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

Посмотреть на GitHub

Вот краткий обзор каждого файла:

env.js

Для развертывания приложения «Чат» в указанном проекте Google Cloud и регионе необходимо обновить переменные конфигурации в этом файле.

package.json и package-lock.json

Настройки и зависимости проекта Node.js.

index.js

Точка входа для облачной функции приложения «Чат». Она считывает событие чата из HTTP-запроса, вызывает обработчик приложения и отправляет HTTP-ответ в виде объекта JSON.

controllers/app.js

Основная логика приложения. Обрабатывает события взаимодействия , используя упоминания в чате и команды с косой чертой. Для ответа на клики по карточкам вызывает файл app-action-handler.js .

controllers/app-action-handler.js

Логика приложения для обработки событий взаимодействия в чате при клике на карточку.

services/space-service.js , services/user-service.js и services/user-story-service.js

Эти файлы содержат части логики приложения, специфичные для работы с чатами, пользователями и пользовательскими историями. Функции в этих файлах вызываются из app.js или app-action-handler.js . Для выполнения операций с базой данных функции в этих файлах вызывают функции из firestore-service.js .

services/firestore-service.js

Обрабатывает операции с базой данных. Функции в этом файле вызываются файлами services/space-service.js , services/user-service.js и services/user-story-service.js .

services/aip-service.js

Вызывает API Vertex AI для генеративного прогнозирования текста с помощью ИИ.

model/*.js

Эти файлы содержат определения классов и перечислений, которые службы приложения используют для хранения и передачи данных между функциями. Они задают модель данных для базы данных Firestore.

views/*.js

Каждый файл в этом каталоге создает объект карточки , который приложение «Чат» затем отправляет обратно в «Чат» либо в виде сообщения карточки , либо в виде ответа на диалоговое действие .

views/widgets/*.js

Каждый файл создает экземпляр объекта виджета определенного типа, который приложение использует для построения карточек в каталоге views/ .

test/**/*.test.js

Каждый файл в этом каталоге и его подкаталогах содержит модульные тесты для соответствующей функции, контроллера, сервиса, представления или виджета. Вы можете запустить все модульные тесты, выполнив команду npm run test в корневом каталоге проекта.

Создайте и разверните облачную функцию.

В этом разделе вы создадите и развернете облачную функцию, которая включает в себя логику приложения «Чат» для управления проектами.

Функция Cloud Function запускается в ответ на HTTP-запрос от Chat, содержащий событие взаимодействия с чатом. При запуске код Cloud Function обрабатывает событие и возвращает ответ в Chat, который Chat отображает в виде сообщения, диалога или другого типа взаимодействия с пользователем. При необходимости Cloud Function также считывает данные из базы данных Firestore или записывает в нее данные.

Вот как создать облачную функцию:

1. После завершения развертывания функции скопируйте свойство url из ответа. Это URL-адрес триггера, который вы будете использовать в следующем разделе для настройки приложения Google Chat.

Настройте приложение Google Chat в консоли Google Cloud.

В этом разделе показано, как настроить API чата в консоли Google Cloud, указав информацию о вашем приложении чата, включая его название, поддерживаемые команды с косой чертой и URL-адрес триггера облачной функции приложения чата, на которую отправляются события взаимодействия в чате.

1. В консоли Google Cloud перейдите menu > Дополнительные продукты > Google Workspace > Библиотека продуктов > Google Chat API > Управление > Конфигурация .

   Перейдите в раздел «Настройка API чата».

2. В поле «Название приложения» введите Project Manager .

3. В поле "URL аватара" введите https://developers.google.com/add-ons/samples/images/quickstart-app-avatar.png .

4. В поле «Описание» укажите Manages projects with user stories.

5. Переведите переключатель «Включить интерактивные функции» в положение «Вкл.».

6. В разделе «Функциональность» выберите «Присоединяйтесь к пространствам и групповым беседам» .

7. В разделе «Настройки подключения» выберите «URL конечной точки HTTP» .

8. Скопируйте адрес электронной почты учетной записи службы . Этот адрес электронной почты понадобится вам при авторизации дополнения для вызова вашей функции.

9. В разделе «Триггеры» выберите «Использовать общий URL-адрес конечной точки HTTP для всех триггеров» .

10. В поле URL REGION адреса HTTP-конечной точки - URL .cloudfunctions.net/project-management-tutorial адрес запуска облачной PROJECT_ID в формате https:// . Если вы развернули облачную функцию с помощью CLI gcloud, это будет свойство url .

11. Зарегистрируйте команды, использующие косую черту, в приложении «Чат». Чтобы зарегистрировать команду, использующую косую черту:

    1. В разделе «Команды» нажмите «Добавить команду» .

    2. Для каждой команды, подробно описанной в следующей таблице, введите идентификатор команды (Command ID) , в поле «Описание» (Description) выберите «Тип команды » ( Camera Slash command) , введите имя команды, выберите «Диалоговое окно» (Dialog ), а затем нажмите « Готово» (Daily) :

       Идентификатор команды	Описание	Название команды с косой чертой	Диалог
       1	Создайте историю с указанным заголовком.	/createUserStory	Невыбранный
       2	Отображает список всех историй, назначенных пользователю.	/myUserStories	Невыбранный
       3	Отображает текущий статус указанной истории.	/userStory	Невыбранный
       4	Открывает диалоговое окно, в котором можно редактировать тексты.	/manageUserStories	Выбранный
       5	Удаляет все истории в этом пространстве.	/cleanupUserStories	Невыбранный

12. В разделе «Видимость» выберите «Сделать это приложение Google Chat доступным для определенных людей и групп в вашем домене Workspace» и введите свой адрес электронной почты.

13. При желании в разделе «Журналы» выберите пункт «Записывать ошибки в журнал» .

14. Нажмите «Сохранить» . Появится сообщение о сохранении конфигурации.

Приложение «Чат» готово к приему и ответам на сообщения в чате.

Протестируйте приложение для чата

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

1. Откройте Google Chat, используя учетную запись Google Workspace, которую вы указали при добавлении себя в качестве доверенного тестировщика.

   Перейдите в Google Чат

2. Нажмите add новый чат» .
3. В поле «Добавить 1 или более человек» введите название вашего приложения для чата.

4. Выберите ваше приложение для чата из результатов поиска. Откроется личное сообщение.

5. В новом личном сообщении в приложении введите Hello и нажмите enter . Приложение «Чат для управления проектами» ответит меню справки с подробным описанием своих функций.
6. Чтобы создать пользовательскую историю, введите /createUserStory Test story в строке сообщения и отправьте её. Приложение чата для управления проектами ответит карточкой с подробным описанием созданной для вас пользовательской истории, разработанной с помощью генеративного ИИ от Vertex AI.

7. В консоли проверьте базу данных Firestore, чтобы просмотреть записи, созданные о пространстве, в которое вы добавили приложение «Чат», пользователях, которые взаимодействовали с ним, и созданной вами пользовательской истории.

   Перейдите в Firestore

8. Вернуться в чат Google.

   Перейдите в Google Чат

9. При желании, чтобы отредактировать текст, нажмите «Редактировать» . Когда вы будете удовлетворены результатом, нажмите «Сохранить» .
10. Проверьте каждую команду с косой чертой, поддерживаемую приложением. Чтобы увидеть их, введите / или упомяните приложение «Чат».
11. Удалите тестовую пользовательскую историю, выполнив команду /cleanupUserStories . В качестве альтернативы, удалите или деинсталлируйте приложение . При удалении приложение удалит все пользовательские истории, созданные в этом пространстве.

Устранение неполадок

Когда приложение или карточка Google Chat выдает ошибку, интерфейс чата отображает сообщение «Что-то пошло не так» или «Не удалось обработать ваш запрос». Иногда интерфейс чата не отображает никаких сообщений об ошибке, но приложение или карточка чата выдает неожиданный результат; например, сообщение на карточке может не появиться.

Хотя сообщение об ошибке может не отображаться в пользовательском интерфейсе чата, подробные сообщения об ошибках и данные журнала доступны для исправления ошибок, если включено ведение журнала ошибок для приложений чата. Для получения помощи по просмотру, отладке и исправлению ошибок см. раздел «Устранение неполадок и исправление ошибок Google Chat» .

Уборка

Чтобы избежать списания средств с вашего аккаунта Google Cloud за ресурсы, использованные в этом руководстве, мы рекомендуем удалить проект Cloud.

1. В консоли Google Cloud перейдите на страницу «Управление ресурсами» menu > IAM и администрирование > Управление ресурсами .

   Перейдите в Диспетчер ресурсов

2. В списке проектов выберите проект, который хотите удалить, и нажмите кнопку «Удалить delete .
3. В диалоговом окне введите идентификатор проекта, а затем нажмите «Завершить» , чтобы удалить проект.

Похожие темы

• Планируйте поездки с помощью ИИ-агента, доступного во всем Google Workspace.
• Отвечайте на вопросы, основанные на диалогах в чате, с помощью приложения Gemini AI Chat.
• Реагирование на инциденты с помощью Google Chat, Vertex AI, Apps Script и аутентификации пользователей.
• Проверка фактов с помощью агента ADK AI и модели Gemini.
• Интегрируйте фундаментальные концепции искусственного интеллекта в чат-приложения.
• Создайте приложение для чата в качестве дополнения к Google Workspace с помощью Apps Script.