Предварительные условия
- Если вы зарегистрировали партнерскую учетную запись до 7 марта 2022 г., вам необходимо включить API Business Messages. См. раздел Включение API бизнес-коммуникаций и API бизнес-сообщений .
Создайте своего агента
В этом руководстве рассказывается, как создать агент с помощью примера приложения. Этот образец позволяет быстро изучить функциональные возможности агента и может послужить отправной точкой для разработки вашего агента. Если вы хотите изменить существующее приложение, включив в него агент, пример предлагает хорошую модель для логики вашего приложения.
В этом кратком руководстве вы выполните следующие действия:
- Зарегистрируйтесь как партнер
- Создать бренд и агента
- При желании изучите функции в разговоре с ботом-помощником Business Messages.
- Настройте своего агента для отправки и получения сообщений
Чтобы создать агент без использования примера, см. раздел Создание агента .
Зарегистрируйтесь как партнер
- Откройте консоль разработчика бизнес-коммуникаций .
- В разделе «Деловые сообщения» нажмите «Создать партнерскую учетную запись» .
Введите информацию о своем партнере:
Поле Ценить Ваше имя Ваше полное имя Имя партнера Название вашей организации Партнерский сайт Сайт вашей организации Область Регион, в котором вы хотите разместить службу бизнес-сообщений. Прочтите и примите Условия использования Business Messages .
Нажмите Создать .
Теперь вы зарегистрированы в качестве партнера Business Messages. Для вас создан новый проект Google Cloud с включенными API-интерфейсами Business Messages и Business Communications. У вас нет доступа к этому проекту, и он не будет мешать работе ни одного из ваших существующих проектов Google Cloud.
Теперь у вас есть доступ к API-интерфейсам Business Messages и Business Communications.
Создать учетную запись службы
- На домашней странице консоли разработчика Business Communications нажмите « Настройки партнерской учетной записи» .
- На панели навигации слева нажмите Учетная запись службы .
Нажмите «Создать ключ» , затем нажмите «Создать» .
Ваш браузер загружает ключ сервисной учетной записи. Храните его в безопасном месте. Этот ключ понадобится вам позже для развертывания веб-приложения и доступа к API бизнес-сообщений и бизнес-коммуникаций в будущем.
Создать бренд и агента
Агент — это диалоговое представление бренда — диалоговая сущность, с которой взаимодействуют пользователи. Вы создаете бренд, представляющий бизнес, и создаете агента, чтобы потребители могли с ним общаться.
- Откройте консоль разработчика Business Communications и войдите в свою учетную запись Google Business Messages.
- Нажмите Создать агента .
- В качестве типа агента выберите «Деловые сообщения» .
- Введите значения для названия бренда и имени агента .
- Выполните одно из следующих действий:
- Чтобы поговорить с вашим агентом и изучить доступные функции, выберите «Включить бота-помощника Business Messages» .
- Чтобы настроить агент и подготовить его к обработке сообщений, снимите флажок « Включить бота-помощника Business Messages» .
- Нажмите Создать агента .
Если вы включили бота-помощника Business Messages, вы можете немедленно начать разговор . В противном случае перейдите к настройке вашего агента для обработки сообщений .
Изучите возможности с помощью бота-помощника Business Messages
Бот-помощник Business Messages позволяет вам быстро начать разговор с вашим агентом, чтобы вы могли познакомиться с возможностями платформы. Включение бота-помощника не является обязательным, но настоятельно рекомендуется при создании первого агента.
Бот-помощник позволяет вам
- Откройте для себя богатые возможности
- Узнайте, как реализовать функции
- Найдите ресурсы для настройки агента
Когда бот-помощник включен, он отправляет и получает сообщения для вашего агента; вебхук не требуется. Вам необходимо отключить бота-помощника, прежде чем вы сможете установить веб-перехватчик или включить Dialogflow для обработки сообщений пользователя.
Начните разговор с ботом-помощником
После включения бота-помощника Business Messages вы сможете начать разговор. Сразу после создания агента открывается диалоговое окно, которое поможет вам начать работу.
Чтобы взаимодействовать с ботом-помощником, выполните следующие шаги в этом диалоговом окне:
Получите доступ к тестовым URL-адресам агента. Есть несколько способов сделать это:
- Нажмите кнопку Android или кнопку iOS . Затем отсканируйте QR-код соответствующим мобильным устройством и нажмите « Запустить» . Либо нажмите «Копировать URL-адрес Android» или «Копировать URL-адрес iOS», чтобы скопировать тестовый URL-адрес агента.
- Нажмите «Отправить» , чтобы отправить URL-адреса на ваш адрес электронной почты.
Откройте URL-адрес на своем мобильном устройстве. (Устройствам iOS требуется приложение Google Maps .)
Отключить бота-помощника
Прежде чем вы сможете настроить свой агент и подготовить его к запуску, вам необходимо отключить бот-помощник Business Messages.
Чтобы отключить бота-помощника,
- Откройте консоль разработчика бизнес-коммуникаций .
- Выберите своего агента.
- На панели навигации слева нажмите «Интеграции» .
- Для бота-помощника нажмите «Отключить» .
Когда бот-помощник отключен, он больше не отправляет и не получает сообщения для вашего агента. Теперь вы можете настроить своего агента для обработки потока сообщений.
Настройте свой агент для обработки сообщений
В этом руководстве вы развернете Echo Bot на Google Cloud Platform (GCP) с веб-перехватчиком, предназначенным для обработки пользовательских сообщений.
Echo Bot — это пример приложения, которое возвращает сообщения пользователю. Это позволяет вам экспериментировать с богатыми функциями, такими как предлагаемые действия и расширенные карточки , в разговоре с вашим агентом. Вы также можете использовать Echo Bot в качестве отправной точки для разработки своего агента.
Вы выполните следующие шаги:
- Развертывание образца Echo Bot в GCP
- Настройте URL-адрес веб-перехватчика для своей партнерской учетной записи Business Messages.
- Предоставьте основную информацию о вашем агенте
После прочтения этого руководства ваш агент будет готов отправлять и получать сообщения.
Разверните веб-приложение в GCP
Business Messages перенаправляет сообщения от пользователей на веб-перехватчик в вашей инфраструктуре. В этом руководстве вы развернете пример исходного кода Echo Bot в предварительно настроенном веб-перехватчике. Если у вас уже есть веб-инфраструктура, которую можно использовать для получения сообщений, вы можете создать новый веб-перехватчик для этой веб-службы, но вам придется настроить логику самостоятельно. Подробности см. в разделе Настройка веб-перехватчика на уровне партнера .
Создайте облачную среду
Для развертывания образца Echo Bot вам потребуется облачная среда.
Чтобы создать проект GCP в качестве облачной среды, выполните следующие действия:
Откройте инструмент выбора проектов Google Cloud Console .
Если вы никогда не создавали проект Google Cloud, вам необходимо принять Условия использования .
Нажмите Создать проект .
Введите имя и местоположение для вашего нового проекта
- Идентификатор вашего проекта генерируется автоматически и отображается под названием вашего проекта.
- В поле «Местоположение» нажмите «Обзор» , чтобы отобразить возможные местоположения для вашего проекта. Если вы не можете найти свою организацию Google Workspace, значит, вы не вошли в учетную запись Google Workspace. Вы можете создать проект без организации, но некоторые возможности ограничены. Дополнительные сведения см. в разделе «Преимущества ресурса организации» .
Нажмите Создать .
Нажмите «
.Нажмите «Оплата» .
Нажмите «Привязать платежный аккаунт» .
Создайте новую учетную запись для выставления счетов или добавьте в проект существующую учетную запись для выставления счетов. Чтобы узнать о вариантах оплаты, ознакомьтесь с функциями бесплатной программы Google Cloud .
Развертывание образца Echo Bot
- Установите интерфейс командной строки gcloud . Вы будете использовать это для развертывания примера кода в Google Cloud.
Загрузите и извлеките образец Echo Bot ( Node.js , Java , Python ).
Скопируйте файл учетных данных JSON, который вы скачали в разделе «Создание учетной записи службы», в папку ресурсов примера и переименуйте учетные данные в «bm-agent-service-account-credentials.json». Путь к этому файлу учетных данных зависит от загруженного вами образца.
./bm-nodejs-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json
./bm-java-echo-bot/full_sample/src/main/resources/bm-agent-service-account-credentials.json
./bm-python-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json
В терминале перейдите в каталог full_sample сэмпла.
Выполните следующие команды в терминале, чтобы развернуть образец:
gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy
PROJECT_ID — это идентификатор проекта, который вы создали в разделе «Создание облачной среды» . Идентификатор проекта указан на панели управления проектом в Google Cloud.
gcloud config set project PROJECT_ID
gcloud app create
mvn appengine:deploy
PROJECT_ID — это идентификатор проекта, который вы создали в разделе «Создание облачной среды» . Идентификатор проекта указан на панели управления проектом в Google Cloud.
gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy
PROJECT_ID — это идентификатор проекта, который вы создали в разделе «Создание облачной среды» . Идентификатор проекта указан на панели управления проектом в Google Cloud.
Обратите внимание на URL-адрес развернутого приложения в выводе последней команды. Это основа URL-адреса вашего веб-перехватчика:
Deployed service [default] to [https:// PROJECT_ID .appspot.com]
Установите свой вебхук
Теперь, когда Echo Bot развернут, вам необходимо указать URL-адрес веб-перехватчика (который вы используете), чтобы начать получать сообщения .
- Откройте настройки учетной записи в консоли разработчика Business Communications.
- Убедитесь, что выбран правильный партнерский аккаунт.
- Для URL-адреса веб-перехватчика Business Messages нажмите « Настроить» .
В качестве URL-адреса конечной точки Webhook введите URL-адрес вашего приложения + "/callback".
Ваша конечная точка будет иметь формат: « PROJECT_ID ».
Эта конечная точка предопределена в логике приложения примера, который вы развернули в GCP.
В консоли разработчика нажмите «Подтвердить» .
Когда Business Messages проверит ваш веб-перехватчик, диалоговое окно закроется.
Чтобы настроить веб-перехватчик с помощью API бизнес-коммуникаций, см. раздел Пример: обновление URL-адреса веб-перехватчика .
Вы можете использовать платформу тестирования Business Messages, чтобы проверить, успешно ли ваш веб-перехватчик реагирует на полезные данные Business Messages.
Введите информацию об агенте
Предоставьте некоторую базовую информацию для завершения настройки агента.
- Откройте консоль разработчика бизнес-коммуникаций .
- На панели навигации слева нажмите Информация об агенте .
Обновите значения по своему усмотрению или воспользуйтесь следующими предложениями:
Поле Ценить Приветственное сообщение Добро пожаловать в беседу с Echo Bot! Политика конфиденциальности https://policies.google.com/privacy Нажмите Сохранить .
Начать разговор
Чтобы взаимодействовать с Echo Bot, выполните следующие действия:
- Откройте консоль разработчика бизнес-коммуникаций .
- На панели навигации слева нажмите Информация об агенте .
- В разделе «Тестовые URL-адреса агента» нажмите кнопку Android или кнопку iOS .
Отсканируйте QR-код с помощью соответствующего мобильного устройства или нажмите «Копировать URL-адрес Android» или «Копировать URL-адрес iOS» , чтобы скопировать тестовый URL-адрес агента.
Вы также можете нажать «Отправить» , чтобы отправить URL-адреса на ваш адрес электронной почты.
Откройте URL-адрес на своем мобильном устройстве. (Устройствам iOS требуется приложение Google Maps .)
Вас приветствует приветственное сообщение вашего агента. На этом этапе вы можете взаимодействовать с Echo Bot. Он повторяет сообщения, которые вы отправляете вам обратно. Кроме того, вы можете вызывать расширенные функции, отправляя определенные строки: «карусель», «карта», «фишки».
Следующие шаги
Теперь, когда вы создали своего первого агента, узнайте больше о Business Messages и о том, что еще вы можете делать на платформе.
Узнайте больше о том, как работают бизнес-сообщения .
Ознакомьтесь с требованиями и рекомендациями к деловым сообщениям .
Измените Echo Bot и ответьте своей бизнес-логикой, просмотрев способы получения сообщений .