Создайте дополнение для Google Chat с помощью Dialogflow ES

Developer Preview: доступно в рамках программы Google Workspace Developer Preview , которая предоставляет ранний доступ к определенным функциям.

На этой странице объясняется, как создать приложение Google Chat в виде дополнения к Google Workspace, использующего Dialogflow ES для понимания естественного языка и реагирования на него. Вы также можете использовать Dialogflow CX , который напрямую интегрирован с Google Chat, для создания приложения Dialogflow CX Google Chat, следуя руководству по Dialogflow CX Google Chat .

Цели

• Настройте свою среду.
• Создайте и разверните агент Dialogflow ES.
• Создайте и разверните приложение чата на базе агента Dialogflow ES.
• Протестируйте приложение «Чат».

Предпосылки

• Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .
• Проект Google Cloud с включённым биллингом. Чтобы проверить, включён ли биллинг для существующего проекта, см. раздел Проверка статуса биллинга ваших проектов . Чтобы создать проект и настроить биллинг, см. раздел Создание проекта Google Cloud .

Архитектура

На следующей диаграмме показана архитектура приложения чата, созданного с помощью Dialogflow:

На предыдущей диаграмме пользователь, взаимодействующий с приложением Dialogflow Chat, имеет следующий поток информации:

1. Пользователь отправляет сообщение в чате в приложение чата, либо в личном сообщении, либо в чат-пространстве.
2. Виртуальный агент Dialogflow, который находится в , получает и обрабатывает сообщение для создания ответа.
3. При желании, используя веб-перехватчик Dialogflow , агент Dialogflow может взаимодействовать с внешними сторонними службами, такими как система управления проектами или инструмент управления тикетами.
4. Агент Dialogflow отправляет ответ обратно в службу приложения Chat в Chat.
5. Ответ отправляется в чат.

Настройте среду

Перед использованием API Google необходимо включить их в проекте Google Cloud. Вы можете включить один или несколько API в одном проекте Google Cloud.

1. В консоли API Google включите API Google Chat и API Dialogflow.

   Включить API

2. Подтвердите, что вы включаете API в правильном облачном проекте, затем нажмите Далее .

3. Подтвердите, что вы включаете правильные API, затем нажмите Включить .

Создать агента Dialogflow ES

Если у вас нет существующего агента Dialogflow ES:

1. Перейдите в консоль Dialogflow ES .
2. Нажмите «Создать агента» .
3. Дайте ему имя, выберите язык по умолчанию и часовой пояс.
4. Свяжите его с вашим облачным проектом.
5. Нажмите «Создать» .
6. Создайте свои намерения и сущности, необходимые для чат-процесса вашего приложения. Вы можете начать с приветственного намерения.
7. Запишите идентификатор вашего проекта .

Подробное руководство смотрите в разделе Создание агента .

Создайте приложение чата и подключите его к агенту Dialogflow

После создания агента Dialogflow ES выполните следующие действия, чтобы превратить его в приложение чата:

1. В консоли Google API перейдите в раздел Google Chat API. Найдите «Google Chat API» и нажмите «Google Chat API », затем нажмите «Управление» .

   Перейти к API чата

2. Нажмите «Конфигурация» и настройте приложение чата:

   1. В поле «Имя приложения» введите Dialogflow App .
   2. В поле URL аватара введите https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png .
   3. В поле Описание введите Responds to real human conversation .
   4. В разделе «Функциональность» выберите Присоединяйтесь к пространствам и групповым беседам .
   5. В разделе «Настройки подключения» выберите Dialogflow .
   6. В разделе «Настройки Dialogflow» выберите Dialogflow ES .
   7. Сделайте это приложение чата доступным для определенных людей и групп в вашем домене и введите свой адрес электронной почты.
   8. В разделе Журналы выберите Записывать ошибки в Журнал .

3. Нажмите « Сохранить ».

Приложение Chat готово принимать и отвечать на сообщения в Chat.

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

Протестируйте приложение Dialogflow ES Chat, отправив ему сообщение в Google Chat.

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

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

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

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

   Примечание: Если вы не видите свое приложение Chat в списке результатов, убедитесь, что вы включили свою учетную запись Google Workspace в настройки видимости на странице конфигурации API Chat в консоли API Google.

5. В новом прямом сообщении с приложением введите Hello и нажмите enter .

   Приложение Dialogflow Chat отвечает приветственным сообщением.

Текстовые ответы

Текстовые ответы отправляются в Google Chat в виде текстовых сообщений . С помощью этого форматирования вы можете сделать текст жирным или курсивным, заключив его в определённые символы (обведённые в Markdown Light).

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

"fulfillmentMessages": [
{
   "text": {
   "text": [
        "This is a test."
   ]
},
  "platform": "GOOGLE_HANGOUTS"
},

Карты

Ответы на карты отправляются в Google Chat как сообщения карты .

Изображения

Ответы-изображения отправляются в Google Chat в виде виджетов изображений Google Chat .

Пользовательская полезная нагрузка

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

Пользовательская полезная нагрузка Google Chat позволяет создавать более сложные карточки. Карточка может содержать один или несколько разделов. Каждый раздел может иметь заголовок. Вы можете ознакомиться со справочным руководством по карточкам чата Google Workspace Add-on , чтобы узнать о возможных комбинациях. Однако использование пользовательских полезных нагрузок подразумевает необходимость предоставления формата JSON.

Примечание: При копировании и вставке примеров из справочного руководства в поле пользовательской нагрузки Dialogflow убедитесь, что редактор не содержит ошибок линтинга. Вы не можете протестировать результаты в Dialogflow Simulator, но можете протестировать их непосредственно в Google Chat.

Вот пример пользовательской полезной нагрузки для создания сообщения с картой:

{ "hangouts": { "hostAppDataAction": { "chatDataAction": {
  "createMessageAction": { "message": { "cardsV2": [{
    "cardId": "pizza",
    "card": {
      "header": {
        "title": "Pizza Delivery Customer Support",
        "subtitle": "[e-mail]",
        "imageUrl": "https://goo.gl/aeDtrS"
      },
      "sections": [{ "widgets": [{ "textParagraph": {
        "text": " Your pizza is here!"
      }}]}]
    }
  }]}}
}}}}

Ограничения и соображения

• При использовании дополнений Google Workspace с Dialogflow объекты событий Chat имеют следующие ограничения и особенности:
  • События App Home: Поддержка событий APP_HOME пока недоступна.
  • Входные данные запроса Dialogflow: текст, отправляемый в качестве входных данных запроса агенту Dialogflow, зависит от типа события:
    • MESSAGE : Значение поля argumentText из сообщения чата.
    • APP_COMMAND : Строка "APP_COMMAND_PAYLOAD" .
    • ADDED_TO_SPACE : отправляется приветственное событие по умолчанию.
    • REMOVED_FROM_SPACE : Строка "REMOVED_FROM_SPACE_PAYLOAD" .
    • CARD_CLICKED : Строка "BUTTON_CLICKED_PAYLOAD" .
    • WIDGET_UPDATED : Строка "WIDGET_UPDATED_PAYLOAD" (используется для автозаполнения).
  • Полная полезная нагрузка события: Полная полезная нагрузка JSON события взаимодействия чата отправляется в Dialogflow в поле WebhookRequest.payload . Вы можете получить к нему доступ в веб-хуке Dialogflow. Подробнее см. в документации по запросам веб-хуков Dialogflow ES .
• Рекомендации по реагированию на команды и получению данных с карточек или диалогов :
  • Если агенту Dialogflow необходимо обработать полезную нагрузку JSON события взаимодействия чата , он может сделать это, используя веб-перехватчик Dialogflow для проверки пользовательской полезной нагрузки в параметре запроса.
  • Чтобы отобразить диалог из Dialogflow Agent, отправьте ответ с помощью одной пользовательской полезной нагрузки JSON, содержащей объект RenderActions с навигационной pushCard .
  • Для обработки данных, введенных с карт, вы можете использовать веб-перехватчик Dialogflow и ответить одной пользовательской полезной нагрузкой JSON, содержащей соответствующее действие .
• Предварительный просмотр ссылок не поддерживается.
• Если агент Dialogflow отвечает только одним сообщением, оно отправляется в Google Chat синхронно. Если агент Dialogflow отвечает несколькими сообщениями, все сообщения отправляются в Chat асинхронно, путём вызова метода create ресурса spaces.messages в Chat API один раз для каждого сообщения.
• При использовании интеграции Dialogflow ES с Chat агент Dialogflow и приложение Chat должны быть настроены в одном проекте Google Cloud.

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

Чтобы отладить приложение Chat, начните с просмотра журналов ошибок. Поскольку это приложение использует Dialogflow, вам доступны несколько ресурсов для ведения журналов и устранения неполадок:

• Журналы дополнений Google Workspace: запросы к журналам для получения подробной информации о поведении дополнения, включая его взаимодействие с чатом. См. раздел Журналы запросов для дополнений Google Workspace .

• Ошибки приложения Google Chat: общие сообщения об ошибках приложения Chat и способы их устранения см. в разделе Устранение неполадок и исправление ошибок приложения Chat .

• История диалогов Dialogflow ES: История | Dialogflow ES

• Общие проблемы с устранением неполадок в Dialogflow: Устранение неполадок | Dialogflow

Уборка

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

Внимание: удаление проекта имеет следующие последствия:

• Всё в проекте будет удалено. Если для этого руководства вы использовали существующий проект, при его удалении будет удалена и вся остальная работа, проделанная вами в этом проекте.
• Пользовательские идентификаторы проектов утеряны. При создании этого проекта вы могли создать собственный идентификатор проекта, который хотите использовать в будущем. Чтобы сохранить URL-адреса, использующие этот идентификатор проекта, например URL-адрес на appspot.com, удалите выбранные ресурсы внутри проекта, а не весь проект.

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

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

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

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

Похожие темы

• Dialogflow CX — это еще один способ использования Dialogflow с приложением чата.