Files

{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}

object ( ConfigFile )

Несколько файлов конфигурации.

{
  "filePath": string,

  // Union field file can be only one of the following:
  "manifest": {
    object (Manifest)
  },
  "actions": {
    object (Actions)
  },
  "settings": {
    object (Settings)
  },
  "webhook": {
    object (Webhook)
  },
  "intent": {
    object (Intent)
  },
  "type": {
    object (Type)
  },
  "entitySet": {
    object (EntitySet)
  },
  "globalIntentEvent": {
    object (GlobalIntentEvent)
  },
  "scene": {
    object (Scene)
  },
  "staticPrompt": {
    object (StaticPrompt)
  },
  "accountLinkingSecret": {
    object (AccountLinkingSecret)
  },
  "resourceBundle": {
    object
  }
  // End of list of possible types for union field file.
}

string

Относительный путь к файлу конфигурации из корня проекта в файловой структуре SDK. Для каждого типа файлов ниже указан разрешенный путь к файлу. Например: настройки/settings.yaml

object ( Manifest )

Один файл манифеста. Разрешенный путь к файлу: manifest.yaml

object ( Actions )

Один файл действий, содержащий все определенные действия. Разрешенные пути к файлам: actions/{language}?/actions.yaml

object ( Settings )

Конфигурация единых настроек, которая включает нелокализуемые настройки и настройки для локали проекта по умолчанию (если указано). Для файла переопределения локали будет заполнено только поле localizedSettings. Разрешенные пути к файлам: settings/{language}?/settings.yaml Обратите внимание, что нелокализованный файл настроек settings/settings.yaml должен присутствовать в запросах потока записи.

object ( Webhook )

Определение одного вебхука. Разрешенный путь к файлу: webhooks/{WebhookName}.yaml

object ( Intent )

Определение единого намерения. Разрешенные пути к файлам: custom/intents/{language}?/{IntentName}.yaml

object ( Type )

Определение одного типа. Разрешенные пути к файлам: custom/types/{language}?/{TypeName}.yaml

object ( EntitySet )

Определение набора отдельных сущностей. Разрешенные пути к файлам: custom/entitySets/{language}?/{EntitySetName}.yaml

object ( GlobalIntentEvent )

Определение единого глобального события намерения. Разрешенные пути к файлам: custom/global/{GlobalIntentEventName}.yaml Имя файла (GlobalIntentEventName) должно быть именем намерения, которому соответствует это глобальное событие намерения.

object ( Scene )

Определение одной сцены. Разрешенные пути к файлам: custom/scenes/{SceneName}.yaml

object ( StaticPrompt )

Определение единого статического приглашения. Разрешенные пути к файлам: custom/prompts/{language}?/{StaticPromptName}.yaml

object ( AccountLinkingSecret )

Метаданные, соответствующие секрету клиента, используемому при привязке учетной записи. Разрешенный путь к файлу: settings/accountLinkingSecret.yaml

object ( Struct format)

Один пакет ресурсов, который представляет собой сопоставление строки со строкой или списком строк. Пакеты ресурсов можно использовать для локализации строк в статических подсказках. Разрешенные пути к файлам: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

{
  "version": string
}

string

Версия формата файла. Текущая версия формата файла — 1.0. Пример: «1.0».

{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}

map (key: string, value: object ( CustomAction ))

Сопоставьте намерения с настраиваемыми действиями, чтобы настроить вызов проекта. Намерения вызова могут быть либо системными, либо пользовательскими намерениями, определенными в пакете «custom/intents/». Все намерения, определенные здесь (системные и пользовательские намерения), должны иметь соответствующий файл намерений в пакете «custom/global/».

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

{
  "engagement": {
    object (Engagement)
  }
}

object ( Engagement )

Механизмы взаимодействия, связанные с действием, помогают конечным пользователям подписаться на push-уведомления и ежедневные обновления. Обратите внимание, что имя намерения, указанное в конфигурации слота ежедневных обновлений/push-уведомлений, должно совпадать с намерением, соответствующим этому действию, чтобы конечные пользователи могли подписаться на эти обновления.

{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}

string

Название взаимодействия, которое будет отправлено конечным пользователям с просьбой дать разрешение на получение обновлений. Запрос, отправляемый конечным пользователям для ежедневных обновлений, будет выглядеть так: «В какое время вы хотите, чтобы я отправлял ваши ежедневные уведомления по {title}», а для push-уведомлений — «Ничего, если я отправлю push-уведомления для {title}». Это поле является локализуемым.

object ( PushNotification )

Настройки push-уведомлений, которые поддерживает это взаимодействие.

object ( ActionLink )

Конфигурация ссылки для действия, которая определяет, включен ли общий доступ к ссылкам для этого действия, и если да, содержит понятное пользователю отображаемое имя для ссылки. ActionLink устарел. Вместо этого используйте AssistantLink.

object ( AssistantLink )

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

object ( DailyUpdate )

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

{
  "title": string
}

string

Удобный заголовок для ссылки.

{
  "title": string
}

string

Удобный заголовок для ссылки.

{
  "projectId": string,
  "defaultLocale": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "category": enum (Category),
  "usesTransactionsApi": boolean,
  "usesDigitalPurchaseApi": boolean,
  "usesInteractiveCanvas": boolean,
  "usesHomeStorage": boolean,
  "designedForFamily": boolean,
  "containsAlcoholOrTobaccoContent": boolean,
  "keepsMicOpen": boolean,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  },
  "testingInstructions": string,
  "localizedSettings": {
    object (LocalizedSettings)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "selectedAndroidApps": [
    string
  ]
}

string

Идентификатор проекта действий.

string

Языковой стандарт, используемый в проекте по умолчанию. Для всех файлов, кроме resources/ в пути которых нет локали, локализованные данные присваиваются этому defaultLocale . Для файлов в папке resources/ no locale это означает, что ресурс применим ко всем локали.

string

Представляет регионы, в которых пользователи могут вызывать ваши действия, в зависимости от местоположения пользователя. Невозможно установить, если установлен disabledRegions . Если оба enabledRegions и disabledRegions не указаны, пользователи могут вызывать ваши действия во всех регионах. Каждый регион представлен с использованием канонического названия геотаргетов Adwords. См . https://developers.google.com/adwords/api/docs/appendix/geotargeting. Примеры: – «Германия» – «Гана» – «Греция» – «Гренада» – «Великобритания» – «Соединённые Штаты» – «Малые отдаленные острова США» — «Уругвай».

string

Представляет регионы, в которых ваши действия заблокированы, в зависимости от местоположения пользователя. Невозможно установить, если установлен enabledRegions . Каждый регион представлен с использованием канонического названия геотаргетов Adwords. См . https://developers.google.com/adwords/api/docs/appendix/geotargeting. Примеры: – «Германия» – «Гана» – «Греция» – «Гренада» – «Великобритания» – «Соединённые Штаты» – «Малые отдаленные острова США» — «Уругвай».

enum ( Category )

Категория для этого проекта Actions.

boolean

Могут ли Действия использовать транзакции (например, бронирование, прием заказов и т. д.). Если значение false, то попытки использовать API транзакций завершаются неудачно.

boolean

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

boolean

Используют ли действия интерактивный холст.

boolean

Используют ли Действия функцию домашнего хранилища.

boolean

Предназначен ли контент Actions для всей семьи (DFF).

boolean

Содержит ли «Действия» контент, связанный с алкоголем или табаком.

boolean

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

object ( SurfaceRequirements )

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

string

Инструкции по тестированию в свободной форме для рецензента действий (например, инструкции по связыванию аккаунтов).

object ( LocalizedSettings )

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

object ( AccountLinking )

Разрешите пользователям создавать или связывать учетные записи с помощью входа в Google и/или вашей собственной службы OAuth.

string

Приложения Android, выбранные для доступа к покупкам в Google Play для транзакций. Это подборка приложений для Android, подключенных к проекту действий для подтверждения владения брендом и включения дополнительных функций. Дополнительную информацию см. на странице https://developers.google.com/assistant/console/brand-verification .

{
  "minimumRequirements": [
    {
      object (CapabilityRequirement)
    }
  ]
}

object ( CapabilityRequirement )

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

{
  "capability": enum (SurfaceCapability)
}

enum ( SurfaceCapability )

Тип возможности.

{
  "displayName": string,
  "pronunciation": string,
  "shortDescription": string,
  "fullDescription": string,
  "smallLogoImage": string,
  "largeBannerImage": string,
  "developerName": string,
  "developerEmail": string,
  "termsOfServiceUrl": string,
  "voice": string,
  "voiceLocale": string,
  "privacyPolicyUrl": string,
  "sampleInvocations": [
    string
  ],
  "themeCustomization": {
    object (ThemeCustomization)
  }
}

string

Необходимый. Отображаемое имя по умолчанию для этого проекта Actions (если перевод недоступен).

string

Необходимый. Произношение отображаемого имени для вызова его в голосовом (речевом) контексте.

string

Необходимый. Краткое описание проекта Actions по умолчанию (если перевод недоступен). Ограничение в 80 символов.

string

Необходимый. Полное описание по умолчанию для проекта Actions (если перевод недоступен). Ограничение в 4000 символов.

string

Необходимый. Небольшое квадратное изображение, 192 x 192 пикселей. Это должно быть указано как ссылка на соответствующее изображение в каталоге resources/images/ . Например, $resources.images.foo (без расширения) для изображения в resources/images/foo.jpg При работе над проектом, полученным из консоли, можно использовать полученный URL-адрес, управляемый Google. URL-адреса из внешних источников не допускаются.

string

Необязательный. Большое альбомное изображение, 1920 x 1080 пикселей. Это должно быть указано как ссылка на соответствующее изображение в каталоге resources/images/ . Например, $resources.images.foo (без расширения) для изображения в resources/images/foo.jpg При работе над проектом, полученным из консоли, можно использовать полученный URL-адрес, управляемый Google. URL-адреса из внешних источников не допускаются.

string

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

string

Необходимый. Контактный адрес электронной почты разработчика.

string

Необязательный. Условия использования URL.

string

Необходимый. Тип голоса Google Ассистента, который слышат пользователи, когда взаимодействуют с вашими действиями. Поддерживаемые значения: «мужской_1», «мужской_2», «женский_1» и «женский_2».

string

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

string

Необходимый. URL-адрес политики конфиденциальности.

string

Необязательный. Примеры фраз вызова, отображаемые как часть описания вашего проекта Actions в каталоге Assistant. Это поможет пользователям научиться его использовать.

object ( ThemeCustomization )

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

{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}

string

Цвет фона карточек. Действует как запасной вариант, если разработчиками не предоставлен background_image или background_image не подходит для определенных поверхностей. Пример использования: #FAFAFA

string

Основной цвет темы действия будет использоваться для установки цвета текста заголовка и цвета фона элемента действия для действий на картах Google. Пример использования: #FAFAFA

string

Семейство шрифтов, которое будет использоваться для названий карточек. Поддерживаемые шрифты: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospace - Cursive - Sans Serif Smallcaps

enum ( ImageCornerStyle )

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

string

Пейзажный режим (минимум 1920х1200 пикселей). Это должно быть указано как ссылка на соответствующее изображение в каталоге resources/images/ . Например: $resources.images.foo (без расширения) для изображения в resources/images/foo.jpg При работе над проектом, полученным из консоли, можно использовать полученный URL-адрес, управляемый Google.

string

Портретный режим (минимум 1200х1920 пикселей). Это должно быть указано как ссылка на соответствующее изображение в каталоге resources/images/ . Например: $resources.images.foo (без расширения) для изображения в resources/images/foo.jpg При работе над проектом, полученным из консоли, можно использовать полученный URL-адрес, управляемый Google.

{
  "enableAccountCreation": boolean,
  "linkingType": enum (LinkingType),
  "authGrantType": enum (AuthGrantType),
  "appClientId": string,
  "authorizationUrl": string,
  "tokenUrl": string,
  "scopes": [
    string
  ],
  "learnMoreUrl": string,
  "useBasicAuthHeader": boolean
}

boolean

Необходимый. Если true , пользователям разрешено регистрировать новые учетные записи с помощью голоса. Если false , создание учетной записи разрешено только на вашем веб-сайте. Выберите этот вариант, если вы хотите отобразить свои условия обслуживания или получить согласие пользователя во время регистрации. linkingType не может быть GOOGLE_SIGN_IN, если это false . linkingType не может быть OAUTH, если это true .

enum ( LinkingType )

Необходимый. Используемый тип ссылки. Дополнительную информацию о типах ссылок см. на странице https://developers.google.com/assistant/identity .

enum ( AuthGrantType )

Необязательный. Указывает тип аутентификации для OAUTH linkingType.

string

Необязательный. Идентификатор клиента, выданный вашим приложением Google. Это идентификатор клиента OAuth2, идентифицирующий Google для вашего сервиса. Устанавливается только при использовании OAuth.

string

Необязательный. Конечная точка вашей веб-страницы входа, которая поддерживает код OAuth2 или неявные потоки. URL-адрес должен использовать HTTPS. Устанавливается только при использовании OAuth.

string

Необязательный. Конечная точка OAuth2 для обмена токенами. URL-адрес должен использовать HTTPS. Это значение не устанавливается при использовании OAuth только с грантом IMPLICIT в качестве типа связи. Устанавливается только при использовании OAuth.

string

Необязательный. Список разрешений, на которые пользователь должен согласиться, чтобы использовать ваш сервис. Устанавливается только при использовании OAuth. При указании этого поля обязательно укажите Условия обслуживания в информации каталога в разделе LocalizedSettings.terms_of_service_url.

string

Необязательный. Это веб-страница вашего сервиса, на которой описаны разрешения, которые пользователь предоставляет Google. Устанавливается только при использовании OAuth и входа в Google. При указании этого поля обязательно укажите Условия обслуживания в информации каталога в разделе LocalizedSettings.terms_of_service_url.

boolean

Необязательный. Если это правда, разрешите Google передавать идентификатор клиента и секрет через заголовок базовой аутентификации HTTP. В противном случае Google использует идентификатор клиента и секретный код внутри тела сообщения. Устанавливается только при использовании OAuth. При указании этого поля обязательно укажите Условия обслуживания в информации каталога в разделе LocalizedSettings.terms_of_service_url.

{
  "handlers": [
    {
      object (Handler)
    }
  ],

  // Union field webhook_type can be only one of the following:
  "httpsEndpoint": {
    object (HttpsEndpoint)
  },
  "inlineCloudFunction": {
    object (InlineCloudFunction)
  }
  // End of list of possible types for union field webhook_type.
}

object ( Handler )

Список обработчиков для этого вебхука.

object ( HttpsEndpoint )

Пользовательская конечная точка HTTPS веб-перехватчика.

object ( InlineCloudFunction )

Метаданные для облачной функции, развернутые из кода в папке веб-перехватчиков.

{
  "name": string
}

string

Необходимый. Имя обработчика. Должно быть уникальным для всех обработчиков проекта Actions. Вы можете проверить имя этого обработчика, чтобы вызвать правильную функцию в исходном коде выполнения.

{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}

string

Базовый URL-адрес HTTPS для вашей конечной точки выполнения (HTTP не поддерживается). Имена обработчиков добавляются к базовому URL-пути после двоеточия (в соответствии с руководством по стилю в https://cloud.google.com/apis/design/custom_methods) . Например, базовый URL-адрес «https://gactions.service.com/api» будет получать запросы с URL-адресом «https://gactions.service.com/api:{method}».

map (key: string, value: string)

Карта параметров HTTP, которые будут включены в запрос POST.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

integer

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

{
  "executeFunction": string
}

string

Имя точки входа в облачную функцию. Значение этого поля должно совпадать с именем метода, экспортированного из исходного кода.

{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}

object ( IntentParameter )

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

string

Обучающие фразы позволяют NLU Google автоматически сопоставлять намерения с вводом пользователя. Чем больше уникальных фраз будет предоставлено, тем больше шансов, что это намерение будет соответствовать. Ниже приведен формат обучающей части фразы, которая снабжена аннотациями. Обратите внимание, что поле auto является необязательным, и поведение по умолчанию, если auto не указано, эквивалентно auto=false . ($<paramName> '<sample text>' auto=<true or false>) auto = true означает, что часть была автоматически аннотирована NLU. auto = false означает, что часть была аннотирована пользователем. Это значение по умолчанию, если не указано значение auto. Пример: «Забронируйте рейс из ($source 'Сан-Франциско' auto=false) в ($dest 'Ванкувер')»

{
  "name": string,

  // Union field parameter_type can be only one of the following:
  "type": {
    object (ClassReference)
  },
  "entitySetReferences": {
    object (EntitySetReferences)
  }
  // End of list of possible types for union field parameter_type.
}

string

Необходимый. Уникальное имя параметра намерения. Может использоваться в условиях и ответах для ссылки на параметры намерения, извлеченные NLU с помощью $intent.params.[name].resolved

object ( ClassReference )

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

object ( EntitySetReferences )

Необязательный. Ссылки на наборы разрешенных сущностей для этого параметра намерения. Действительно только для параметров встроенного намерения. Эти ссылки указывают на наборы сущностей в каталоге custom/entitySets.

{
  "name": string,
  "list": boolean
}

string

Необходимый. Имя встроенного типа или пользовательского типа параметра. Примеры: PizzaToppings , actions.type.Number

boolean

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

{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}

object ( EntitySetReference )

Необходимый. Ссылки на наборы сущностей для параметра намерения.

{
  "entitySet": string
}

string

Необходимый. Идентифицирует конкретную коллекцию сущностей, которые следует учитывать для данного параметра. Соответствующее определение набора сущностей должно присутствовать в каталоге custom/entitySets/.

{
  "exclusions": [
    string
  ],

  // Union field sub_type can be only one of the following:
  "synonym": {
    object (SynonymType)
  },
  "regularExpression": {
    object (RegularExpressionType)
  },
  "freeText": {
    object (FreeTextType)
  }
  // End of list of possible types for union field sub_type.
}

string

Набор исключительных слов/фраз, которые не должны совпадать по типу. Примечание. Если слово/фраза соответствует типу, но указано как исключение, оно не будет возвращено в результате извлечения параметров. Это поле является локализуемым.

object ( SynonymType )

Тип Synonyms, который по сути является перечислением.

object ( RegularExpressionType )

Тип Regex, допускает сопоставление регулярных выражений.

object ( FreeTextType )

Тип произвольного текста.

{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}

enum ( MatchType )

Необязательный. Тип соответствия синонима.

boolean

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

map (key: string, value: object ( Entity ))

Необходимый. Именованная карта объектов-синонимов.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

{
  "display": {
    object (EntityDisplay)
  },
  "synonyms": [
    string
  ]
}

object ( EntityDisplay )

Необязательный. Подробности отображения сущности.

string

Необязательный. Список синонимов сущности. Это поле является локализуемым.

{
  "iconTitle": string,
  "iconUrl": string
}

string

Необязательный. Название иконы.

string

Необходимый. URL значка.

{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}

map (key: string, value: object ( Entity ))

Необходимый. Именованная карта сущностей, каждая из которых содержит строки Regex.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}

object ( EntityDisplay )

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

string

Необходимый. Использует синтаксис регулярных выражений RE2 (подробнее см. https://github.com/google/re2/wiki/Syntax ).

{
  "display": {
    object (EntityDisplay)
  }
}

object ( EntityDisplay )

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

{
  "entities": [
    {
      object (Entity)
    }
  ]
}

object ( Entity )

Необходимый. Список сущностей, которые поддерживает этот набор сущностей.

{
  "id": string
}

string

Необходимый. Идентификатор сущности. Список встроенных параметров намерения и поддерживаемых ими объектов см. на странице https://developers.google.com/assistant/conversational/build/built-in-intents .

{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}

string

Необязательный. Конечная сцена, к которой должен перейти разговор. Состояние текущей сцены уничтожается при переходе.

object ( EventHandler )

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

{
  "webhookHandler": string,

  // Union field prompt can be only one of the following:
  "staticPrompt": {
    object (StaticPrompt)
  },
  "staticPromptName": string
  // End of list of possible types for union field prompt.
}

string

Имя вызываемого обработчика веб-перехватчика.

object ( StaticPrompt )

Встроенная статическая подсказка. Может содержать ссылки на строковые ресурсы в пакетах.

string

Имя статического приглашения для вызова.

{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}

object ( StaticPromptCandidate )

Список кандидатов-подсказок для отправки клиенту. У каждого приглашения есть селектор, позволяющий определить, когда его можно использовать. Будет отправлен первый селектор, соответствующий запросу, а остальные будут игнорироваться.

{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}

object ( Selector )

Необязательный. Критерии соответствия этого запроса запросу. Если селектор пуст, это приглашение будет активироваться всегда.

object ( StaticPromptResponse )

Быстрый ответ, связанный с селектором.

{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}

object ( SurfaceCapabilities )

Набор необходимых возможностей поверхности.

{
  "capabilities": [
    enum (Capability)
  ]
}

enum ( Capability )

Необходимый. Возможности поверхности, делающей запрос к Action.

{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}

object ( StaticSimplePrompt )

Необязательный. Первый голосовой и текстовый ответ.

object ( StaticContentPrompt )

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

object ( StaticSimplePrompt )

Необязательный. Последний голосовой и текстовый ответ.

object ( Suggestion )

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

object ( StaticLinkPrompt )

Необязательный. Дополнительный чип предложения, который может ссылаться на соответствующее приложение или сайт. Чип будет отображаться с заголовком «Открыть». ". Макс. 20 символов.

boolean

Необязательный. Режим объединения этих сообщений с ранее определенными сообщениями. true очистит все ранее определенные сообщения (первое и последнее простое, содержимое, ссылку на предложения и холст) и добавит сообщения, определенные в этом приглашении. false добавит сообщения, определенные в этом приглашении, к сообщениям, определенным в предыдущих ответах. Установка для этого поля значения false также позволит добавлять к некоторым полям простые приглашения, приглашение «Предложения» и приглашение «Холст» (часть приглашения «Содержимое»). Сообщения о содержимом и ссылках всегда будут перезаписаны, если они определены в приглашении. Значение по умолчанию — false .

object ( StaticCanvasPrompt )

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

{
  "variants": [
    {
      object (Variant)
    }
  ]
}

object ( Variant )

Список возможных вариантов.

{
  "speech": string,
  "text": string
}

string

Необязательный. Представляет речь, которая будет произнесена пользователю. Это может быть SSML или преобразование текста в речь. По умолчанию речь будет добавлена ​​к речи предыдущей простой подсказки. Если поле override в содержащем приглашении имеет значение true , речь, определенная в этом поле, будет переопределять речь предыдущего простого приглашения.

string

Необязательный. Текст для отображения в чате. Если не задано, будет использоваться отображение речевого поля выше. Ограничено 640 символами. По умолчанию текст будет добавлен к тексту предыдущего простого приглашения. Если поле override в содержащем приглашении имеет значение true , текст, определенный в этом поле, будет переопределять текст предыдущего простого приглашения.

{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}

object ( StaticCardPrompt )

Базовая карта.

object ( StaticImagePrompt )

Изображение.

object ( StaticTablePrompt )

Настольная карта.

object ( StaticMediaPrompt )

Ответ, указывающий набор медиафайлов для воспроизведения.

object ( StaticListPrompt )

Карточка для представления списка вариантов на выбор.

object ( StaticCollectionPrompt )

Карточка со списком вариантов для выбора.

object ( StaticCollectionBrowsePrompt )

Карточка с набором веб-страниц, которые нужно открыть.

{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}

string

Необязательный. Общее название карты.

string

Необязательный. Подзаголовок карты.

string

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

object ( StaticImagePrompt )

Необязательный. Изображение героя для карты. Высота фиксирована и равна 192dp.

enum ( ImageFill )

Необязательный. Как будет заполнен фон изображения.

object ( StaticLinkPrompt )

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

{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}

string

Необходимый. Исходный URL изображения. Изображения могут быть в формате JPG, PNG и GIF (анимированные и неанимированные). Например, https://www.agentx.com/logo.png .

string

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

integer

Необязательный. Высота изображения в пикселях.

integer

Необязательный. Ширина изображения в пикселях.

{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}

string

Название ссылки

object ( OpenUrl )

Определяет поведение, когда пользователь открывает ссылку.

{
  "url": string,
  "hint": enum (UrlHint)
}

string

Поле URL-адреса, которое может быть любым из: URL-адреса http/https для открытия приложения, связанного с приложением, или веб-страницы.

enum ( UrlHint )

Указывает подсказку для типа URL-адреса.

{
  "title": string,
  "subtitle": string,
  "image": {
    object (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}

string

Необязательный. Общее название таблицы. Должно быть установлено, если установлены субтитры.

string

Необязательный. Подзаголовок к таблице.

object ( StaticImagePrompt )

Необязательный. Изображение, связанное с таблицей.

object ( TableColumn )

Необязательный. Заголовки и выравнивание столбцов.

object ( TableRow )

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

object ( StaticLinkPrompt )

Необязательный. Кнопка.

{
  "header": string,
  "align": enum (HorizontalAlignment)
}

string

Текст заголовка столбца.

enum ( HorizontalAlignment )

Горизонтальное выравнивание содержимого по столбцу. Если не указано, содержимое будет выровнено по переднему краю.

{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}

object ( TableCell )

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

boolean

Указывает, должен ли быть разделитель после каждой строки.

{
  "text": string
}

string

Текстовое содержимое ячейки.

{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode)
}

enum ( MediaType )

Тип носителя этого ответа.

string ( Duration format)

Начальное смещение первого медиа-объекта.

Длительность в секундах, содержащая до девяти дробных цифр, заканчивающаяся символом « s ». Пример: "3.5s" .

enum ( OptionalMediaControls )

Дополнительные типы управления мультимедиа, которые может поддерживать этот сеанс ответа на мультимедиа. Если установлено, запрос будет отправлен на 3p, когда произойдет определенное медиа-событие. Если не установлено, 3p все равно должен обрабатывать два типа управления по умолчанию: FINISHED и FAILED.

object ( MediaObject )

Список медиа-объектов.

enum ( RepeatMode )

Режим повтора для списка медиа-объектов.

{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}

string

Имя этого медиа-объекта.

string

Описание этого медиа-объекта.

string

URL-адрес, указывающий на медиа-контент.

object ( MediaImage )

Изображение для показа вместе с медиа-картой.

{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}

object ( StaticImagePrompt )

Большое изображение, например обложка альбома и т. д.

object ( StaticImagePrompt )

Небольшой значок изображения отображается справа от заголовка. Его размер изменен до 36x36 dp.

{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}

string

Необязательный. Название списка.

string

Необязательный. Подзаголовок списка.

object ( ListItem )

Необходимый. Перечислить предметы.

{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}

string

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

string

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

string

Необязательный. Основной текст элемента.

object ( StaticImagePrompt )

Необязательный. Изображение предмета.

{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}

string

Необязательный. Название сборника.

string

Необязательный. Подзаголовок сборника.

object ( CollectionItem )

Необходимый. Предметы коллекции.

enum ( ImageFill )

Необязательный. Тип опции отображения изображения.

{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}

string

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

string

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

string

Необязательный. Основной текст элемента.

object ( StaticImagePrompt )

Необязательный. Изображение предмета.

{
  "items": [
    {
      object (CollectionBrowseItem)
    }
  ],
  "imageFill": enum (ImageFill)
}

object ( CollectionBrowseItem )

Элементы в коллекции просмотра. Размер списка должен находиться в диапазоне [2, 10].

enum ( ImageFill )

Опция отображения изображений для изображений в коллекции.

{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (StaticImagePrompt)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}

string

Необходимый. Название предмета коллекции.

string

Описание предмета коллекции.

string

Текст нижнего колонтитула элемента коллекции, отображаемый под описанием. Одна строка текста, обрезанная многоточием.

object ( StaticImagePrompt )

Изображение предмета коллекции.

object ( OpenUrl )

Необходимый. URI для открытия, если элемент выбран.

{
  "title": string
}

string

Необходимый. Текст, отображаемый в чипе предложения. При нажатии этот текст будет дословно отправлен обратно в беседу, как если бы пользователь его набрал. Каждое название должно быть уникальным среди набора фишек предложений. Макс. 25 символов

{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}

string

Необходимый. URL-адрес веб-представления для загрузки.

value ( Value format)

Необязательный. Данные JSON, которые будут переданы на веб-страницу иммерсивного опыта как событие. Если поле override в содержащем приглашении содержит false значения данных, определенные в этом приглашении Canvas, будут добавлены после значений данных, определенных в предыдущих приглашениях Canvas.

boolean

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

boolean

Необязательный. Если true , метаданные, связанные с диалогом, включаются и отправляются обратно в приложение Canvas.

boolean

Необязательный. Если true приложение Canvas занимает весь экран и не имеет заголовка вверху. На экране загрузки также будет отображаться всплывающее сообщение, содержащее отображаемое имя действия, имя разработчика и инструкции по выходу из действия. Значение по умолчанию: false .

{
  "onEnter": {
    object (EventHandler)
  },
  "intentEvents": [
    {
      object (IntentEvent)
    }
  ],
  "conditionalEvents": [
    {
      object (ConditionalEvent)
    }
  ],
  "slots": [
    {
      object (Slot)
    }
  ],
  "onSlotUpdated": {
    object (EventHandler)
  }
}

object ( EventHandler )

Обработчик, вызываемый при переходе в эту сцену.

object ( IntentEvent )

Список событий, которые срабатывают в зависимости от намерений. Эти события могут быть вызваны в любое время после того, как обработчик on_load был вызван. Важно - эти события определяют набор намерений, которые подходят к этой сцене и будут иметь приоритет над любыми глобально определенными событиями, которые имеют одинаковые намерения или их запускающие фразы. Имена намерений должны быть уникальными в сцене.

object ( ConditionalEvent )

Список событий для запуска на основе условных утверждений. Они оцениваются после того, как форма была заполнена или сразу после on_load, если эта сцена не имеет формы (оценка проводится только один раз). Только первое совпадающее событие будет вызвано.

object ( Slot )

Заказанный список слотов. Каждый слот определяет тип данных, которые он будет разрешать и конфигурацию для настройки опыта этого разрешения (например, подсказок).

object ( EventHandler )

Хэндлер позвонил, когда произошло изменение состояния слота, не вызванного обновлениями в другом обработчике. Это позволяет недействительно слотам, сцена недействительна или другие изменения в состоянии сцены.

{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}

string

Необходимый. Намерение вызвать событие.

string

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

object ( EventHandler )

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

{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}

string

Необходимый. Условие фильтра для этого события, чтобы запустить. Если условие оценивается в True, то связанный handler будет запускается. Поддерживаются следующие ссылки на переменные: $session - для ссылки на данные в хранилище сеанса. $user - ссылаться на данные в пользовательском хранилище. Поддерживаются следующие логические операторы (с примерами): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) Поддерживаются следующие сравнения: == ,! != , < , > , <= , >= следующие операторы и строковые операторы поддерживаются (с примерами): in - "Aarmelon "В session.params.fruitList size - size(session.params.fruitList) > 2 substring - session.params.fullName.contains("John")

string

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

object ( EventHandler )

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

{
  "name": string,
  "type": {
    object (ClassReference)
  },
  "required": boolean,
  "promptSettings": {
    object (PromptSettings)
  },
  "commitBehavior": {
    object (CommitBehavior)
  },
  "config": value,
  "defaultValue": {
    object (DefaultValue)
  }
}

string

Необходимый. Название слота.

object ( ClassReference )

Необходимый. Объявляет тип данных этого слота.

boolean

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

object ( PromptSettings )

Необязательный. Регистры подсказки для разных этапов наполнения слота.

object ( CommitBehavior )

Необязательный. Поведение совершают поведение, связанное с слотом.

value ( Value format)

Необязательный. Дополнительная конфигурация, связанная с слотом, который используется для заполнения слота. Формат конфигурации специфичен для типа слота. Ссылки на ресурсы на параметр пользователя или сеанса могут быть добавлены в эту конфигурацию. Эта конфигурация необходима для заполнения слотов, связанных с транзакциями и вовлечением пользователей.

Пример: для слота типов Actions.type.completeprechasevalue, в следующем конфигурации предлагается цифровой хороший порядок со ссылкой на определенную клиенту, определенное параметры сеанса, userSelectedSkuId ,:

{"@type": "type.googleapis.com/ google.actions.transactions.v3.completepurchasevaluespec", "skuid": {"skutype": "sku_type_in_app", "id": "$ session.suserseledskuid", " "PackageName": "com.example.company"}}

object ( DefaultValue )

Необязательный. Конфигурация для заполнения значения по умолчанию для этого слота.

{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}

object ( EventHandler )

Подсказка для самого значения слота. Пример: "Какой размер вы хотели?"

object ( EventHandler )

Запрос о том, когда ввод пользователя не соответствует ожидаемому типу значения для слота впервые. Пример: «Извините, я этого не понял».

object ( EventHandler )

Запрос о том, когда вход пользователя не соответствует ожидаемому типу значения для слота во второй раз. Пример: «Извините, я этого не понял».

object ( EventHandler )

Запрос о том, когда ввод пользователя не соответствует ожидаемому типу значения для слота в последний раз. Пример: «Извините, я этого не понял».

object ( EventHandler )

Подсказка дает, когда пользователь не предоставляет вход в первый раз. Пример: «Извините, я этого не понял».

object ( EventHandler )

Подсказка, когда пользователь не предоставляет вход во второй раз. Пример: «Извините, я этого не понял».

object ( EventHandler )

Подсказка дает, когда пользователь не предоставляет вход в последний раз. Пример: «Извините, я этого не понял».

{
  "writeSessionParam": string
}

string

Параметр сеанса, чтобы написать значение слота после его заполнения. Обратите внимание, что вложенные пути в настоящее время не поддерживаются. «$$» используется для написания значения слота в параметр сеанса с тем же именем, что и слот. Например: wrisessessionparam = "fruit" соответствует "$ session.params.fruit". wrisessessionparam = "билет" соответствует "$ session.params.ticket".

{
  "sessionParam": string,
  "constant": value
}

string

Необязательный. Параметр сеанса, который будет использоваться для инициализации значения слота, если он имеет непутное значение. Тип значения должен соответствовать типу слота. Обратите внимание, что вложенные пути в настоящее время не поддерживаются. Например: sessionParam = "fruit" соответствует $session.params.fruit . sessionParam = "ticket" соответствует $session.params.ticket .

value ( Value format)

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

{
  "dataFiles": [
    {
      object (DataFile)
    }
  ]
}

object ( DataFile )

Несколько файлов данных.

{
  "filePath": string,
  "contentType": string,
  "payload": string
}

string

Относительный путь файла данных из корневого проекта в структуре файла SDK. Разрешенные пути файла: - Images: resources/images/{multiple directories}?/{ImageName}.{extension} resources/audio/{multiple directories}?/{AudioFileName}.{extension} webhooks/{WebhookName}.zip разрешенные расширения: - Изображения: png , jpg , jpeg - Audio: mp3 , mpeg - Встроенные облачные функции: zip

string

Необходимый. Тип контента этого актива. Пример: text/html . Тип контента должен соответствовать спецификации ( http://www.w3.org/protocols/rfc1341/4_content-type.html) . Облачные функции должны быть в формате ZIP, а тип контента должен быть application/zip;zip_type=cloud_function . Параметр ZIP_TYPE указывает, что ZIP предназначен для облачной функции.

string ( bytes format)

Содержание файла данных. Примерами могут быть необработанные байты изображений, аудиофайлов или формата ZIP облачной функции. Существует 10 МБ строгих ограничений на размер полезной нагрузки.

Строка в кодировке Base64.