Files

object (ConfigFile)

Multiple config files.

string

Relative path of the config file from the project root in the SDK file structure. Each file types below have an allowed file path. Eg: settings/settings.yaml

object (Manifest)

Single manifest file. Allowed file path: manifest.yaml

object (Actions)

Single actions file with all the actions defined. Allowed file paths: actions/{language}?/actions.yaml

object (Settings)

Single settings config which includes non-localizable settings and settings for the project's default locale (if specified). For a locale override file, only localizedSettings field will be populated. Allowed file paths: settings/{language}?/settings.yaml Note that the non-localized settings file settings/settings.yaml must be present in the write flow requests.

object (Webhook)

Single webhook definition. Allowed file path: webhooks/{WebhookName}.yaml

object (Intent)

Single intent definition. Allowed file paths: custom/intents/{language}?/{IntentName}.yaml

object (Type)

Single type definition. Allowed file paths: custom/types/{language}?/{TypeName}.yaml

object (EntitySet)

Single entity set definition. Allowed file paths: custom/entitySets/{language}?/{EntitySetName}.yaml

object (GlobalIntentEvent)

Single global intent event definition. Allowed file paths: custom/global/{GlobalIntentEventName}.yaml The file name (GlobalIntentEventName) should be the name of the intent that this global intent event corresponds to.

object (Scene)

Single scene definition. Allowed file paths: custom/scenes/{SceneName}.yaml

object (StaticPrompt)

Single static prompt definition. Allowed file paths: custom/prompts/{language}?/{StaticPromptName}.yaml

object (AccountLinkingSecret)

Metadata corresponding to the client secret used in account linking. Allowed file path: settings/accountLinkingSecret.yaml

object (Struct format)

Single resource bundle, which is a map from a string to a string or list of strings. Resource bundles could be used for localizing strings in static prompts. Allowed file paths: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

string

Version of the file format. The current file format version is 1.0 Example: "1.0"

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

Map from intents to custom Actions to configure invocation for the project. The invocation intents could either be system or custom intents defined in the "custom/intents/" package. All intents defined here (system intents & custom intents) must have a corresponding intent file in the "custom/global/" package.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (Engagement)

Engagement mechanisms associated with the action to help end users subscribe to push notifications and daily updates. Note that the intent name specified in daily updates/push notifications slot config needs to match the intent corresponding to this action for end users to subscribe to these updates.

string

The title of the engagement that will be sent to end users asking for their permission to receive updates. The prompt sent to end users for daily updates will look like "What time would you like me to send your daily {title}" and for push notifications will look like "Is it ok if I send push notifications for {title}". This field is localizable.

object (PushNotification)

Push notification settings that this engagement supports.

object (ActionLink)

Link config for an action which determines whether sharing links is enabled for the action and if so, contains the user friendly display name for the link. ActionLink is deprecated. Use AssistantLink instead.

object (AssistantLink)

Link config for an action which determines whether sharing links is enabled for the action and if so, contains the user friendly display name for the link.

object (DailyUpdate)

Daily update settings that this engagement supports.

string

User friendly display title for the link.

string

User friendly display title for the link.

string

Actions project id.

string

Locale which is default for the project. For all files except under resources/ with no locale in the path, the localized data is attributed to this defaultLocale. For files under resources/ no locale means that the resource is applicable to all locales.

string

Represents the regions where users can invoke your Actions, which is based on the user's location of presence. Cannot be set if disabledRegions is set. If both enabledRegions and disabledRegions are not specified, users can invoke your Actions in all regions. Each region is represented using the Canonical Name of Adwords geotargets. See https://developers.google.com/adwords/api/docs/appendix/geotargeting Examples include: - "Germany" - "Ghana" - "Greece" - "Grenada" - "United Kingdom" - "United States" - "United States Minor Outlying Islands" - "Uruguay"

string

Represents the regions where your Actions are blocked, based on the user's location of presence. Cannot be set if enabledRegions is set. Each region is represented using the Canonical Name of Adwords geotargets. See https://developers.google.com/adwords/api/docs/appendix/geotargeting Examples include: - "Germany" - "Ghana" - "Greece" - "Grenada" - "United Kingdom" - "United States" - "United States Minor Outlying Islands" - "Uruguay"

enum (Category)

The category for this Actions project.

boolean

Whether Actions can use transactions (for example, making reservations, taking orders, etc.). If false, then attempts to use the Transactions APIs fail.

boolean

Whether Actions can perform transactions for digital goods.

boolean

Whether Actions use Interactive Canvas.

boolean

Whether Actions use the home storage feature.

boolean

Whether Actions content is designed for family (DFF).

boolean

Whether Actions contains alcohol or tobacco related content.

boolean

Whether Actions may leave mic open without an explicit prompt during conversation.

object (SurfaceRequirements)

The surface requirements that a client surface must support to invoke Actions in this project.

string

Free-form testing instructions for Actions reviewer (for example, account linking instructions).

object (LocalizedSettings)

Localized settings for the project's default locale. Every additional locale should have its own settings file in its own directory.

object (AccountLinking)

Allow users to create or link accounts through Google sign-in and/or your own OAuth service.

string

Android apps selected to acccess Google Play purchases for transactions. This is a selection from the Android apps connected to the actions project to verify brand ownership and enable additional features. See https://developers.google.com/assistant/console/brand-verification for more information.

object (CapabilityRequirement)

The minimum set of capabilities needed to invoke the Actions in your project. If the surface is missing any of these, the Action will not be triggered.

enum (SurfaceCapability)

The type of capability.

string

Required. The default display name for this Actions project (if there is no translation available)

string

Required. The pronunciation of the display name to invoke it within a voice (spoken) context.

string

Required. The default short description for the Actions project (if there is no translation available). 80 character limit.

string

Required. The default long description for the Actions project (if there is no translation available). 4000 character limit.

string

Required. Small square image, 192 x 192 px. This should be specified as a reference to the corresponding image in the resources/images/ directory. For example, $resources.images.foo (without the extension) for image in resources/images/foo.jpg When working on a project pulled from Console, the Google-managed URL pulled could be used. URLs from external sources are not allowed.

string

Optional. Large landscape image, 1920 x 1080 px. This should be specified as a reference to the corresponding image in the resources/images/ directory. For example, $resources.images.foo (without the extension) for image in resources/images/foo.jpg When working on a project pulled from Console, the Google-managed URL pulled could be used. URLs from external sources are not allowed.

string

Required. The name of the developer to be displayed to users.

string

Required. The contact email address for the developer.

string

Optional. The terms of service URL.

string

Required. The Google Assistant voice type that users hear when they interact with your Actions. The supported values are "male_1", "male_2", "female_1", and "female_2".

string

Optional. The locale for the specified voice. If not specified, this resolves to the user's Assistant locale. If specified, the voice locale must have the same root language as the locale specified in LocalizedSettings.

string

Required. The privacy policy URL.

string

Optional. Sample invocation phrases displayed as part of your Actions project's description in the Assistant directory. This will help users learn how to use it.

object (ThemeCustomization)

Optional. Theme customizations for visual components of your Actions.

string

Background color of cards. Acts as a fallback if background_image is not provided by developers or background_image doesn't fit for certain surfaces. Example usage: #FAFAFA

string

Primary theme color of the Action will be used to set text color of title, action item background color for Actions on Google cards. Example usage: #FAFAFA

string

The font family that will be used for title of cards. Supported fonts: - 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)

Border style of foreground image of cards. For example, can be applied on the foreground image of a basic card or carousel card.

string

Landscape mode (minimum 1920x1200 pixels). This should be specified as a reference to the corresponding image in the resources/images/ directory. Eg: $resources.images.foo (without the extension) for image in resources/images/foo.jpg When working on a project pulled from Console the Google managed url pulled could be used.

string

Portrait mode (minimum 1200x1920 pixels). This should be specified as a reference to the corresponding image in the resources/images/ directory. Eg: $resources.images.foo (without the extension) for image in resources/images/foo.jpg When working on a project pulled from Console the Google managed url pulled could be used.

boolean

Required. If true, users are allowed to sign up for new accounts via voice. If false, account creation is only allowed on your website. Select this option if you want to display your terms of service or obtain user consents during sign-up. linkingType cannot be GOOGLE_SIGN_IN when this is false. linkingType cannot be OAUTH when this is true.

enum (LinkingType)

Required. The linking type to use. See https://developers.google.com/assistant/identity for further details on the linking types.

enum (AuthGrantType)

Optional. Indicates the type of authentication for OAUTH linkingType.

string

Optional. Client ID issued by your App to Google. This is the OAuth2 Client ID identifying Google to your service. Only set when using OAuth.

string

Optional. Endpoint for your sign-in web page that supports OAuth2 code or implicit flows. URL must use HTTPS. Only set when using OAuth.

string

Optional. OAuth2 endpoint for token exchange. URL must use HTTPS. This is not set when only using OAuth with IMPLICIT grant as the linking type. Only set when using OAuth.

string

Optional. List of permissions the user must consent to in order to use your service. Only set when using OAuth. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.

string

Optional. This is the web page on your service which describes the permissions the user is granting to Google. Only set if using OAuth and Google Sign In. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.

boolean

Optional. If true, allow Google to transmit client ID and secret via HTTP basic auth header. Otherwise, Google uses the client ID and secret inside the post body. Only set when using OAuth. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.

object (Handler)

List of handlers for this webhook.

object (HttpsEndpoint)

Custom webhook HTTPS endpoint.

object (InlineCloudFunction)

Metadata for cloud function deployed from code in the webhooks folder.

string

Required. Name of the handler. Must be unique across all handlers the Actions project. You can check the name of this handler to invoke the correct function in your fulfillment source code.

string

The HTTPS base URL for your fulfillment endpoint (HTTP is not supported). Handler names are appended to the base URL path after a colon (following the style guide in https://cloud.google.com/apis/design/custom_methods). For example a base URL of 'https://gactions.service.com/api' would receive requests with URL 'https://gactions.service.com/api:{method}'.

map (key: string, value: string)

Map of HTTP parameters to be included in the POST request.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

integer

Version of the protocol used by the endpoint. This is the protocol shared by all fulfillment types and not specific to Google fulfillment type.

string

The name of the Cloud Function entry point. The value of this field should match the name of the method exported from the source code.

object (IntentParameter)

The list of parameters within the training phrases. All parameters must be defined here to be used in the training phrase.

string

Training phrases allow Google’s NLU to automatically match intents with user input. The more unique phrases that are provided, the better chance this intent will be matched. The following is the format of training phrase part which are annotated. Note that auto field is optional and the default behavior when auto is not specified is equivalent to auto=false. ($<paramName> '<sample text>' auto=<true or false>) auto = true means the part was auto annotated by NLU. auto = false means the part was annotated by the user. This is the default when auto is not specified. Example: "Book a flight from ($source 'San Francisco' auto=false) to ($dest 'Vancouver')"

string

Required. Unique name of the intent parameter. Can be used in conditions and responses to reference intent parameters extracted by NLU with $intent.params.[name].resolved

object (ClassReference)

Optional. Declares the data type of this parameter. This should not be set for built-in intents.

object (EntitySetReferences)

Optional. References to the sets of allowed entities for this intent parameter. Only valid for parameters of a built-in intent. These references point to entity sets in the 'custom/entitySets' directory.

string

Required. Name of a built-in type or custom type of the parameter. Examples: PizzaToppings, actions.type.Number

boolean

Optional. Indicates whether the data type represents a list of values.

object (EntitySetReference)

Required. Entity set references for an intent parameter.

string

Required. Identifies the specific collection of entities to be considered for a given parameter. The corresponding entity set definition should be present in the custom/entitySets/ directory.

string

Set of exceptional words/phrases that shouldn't be matched by type. Note: If word/phrase is matched by the type but listed as an exclusion it won't be returned in parameter extraction result. This field is localizable.

object (SynonymType)

Synonyms type, which is essentially an enum.

object (RegularExpressionType)

Regex type, allows regular expression matching.

object (FreeTextType)

FreeText type.

enum (MatchType)

Optional. The match type for the synonym.

boolean

Optional. When set to true this will match unknown words or phrases based on surrounding input and intent training data, such as items that might be added to a grocery list.

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

Required. Named map of synonym entities.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (EntityDisplay)

Optional. The entity display details.

string

Optional. The list of synonyms for the entity. This field is localizable.

string

Optional. Title of the icon.

string

Required. Url of the icon.

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

Required. Named map of entities which each contain Regex strings.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (EntityDisplay)

Optional. Elements that will be displayed on the canvas once an entity is extracted from a query. Only relevant for canvas enabled apps.

string

Required. Uses RE2 regex syntax (See https://github.com/google/re2/wiki/Syntax for more details)

object (EntityDisplay)

Optional. Elements that will be displayed on the canvas once an entity is extracted from a query. Only relevant for canvas enabled apps.

object (Entity)

Required. The list of entities this entity set supports.

string

Required. The ID of the entity. For a list of built-in-intent parameters and their supported entities, see https://developers.google.com/assistant/conversational/build/built-in-intents

string

Optional. Destination scene which the conversation should jump to. The state of the current scene is destroyed on the transition.

object (EventHandler)

Optional. Event handler which is triggered when the intent is matched. Should execute before transitioning to the destination scene. Useful to generate Prompts in response to events.

string

Name of the webhook handler to call.

object (StaticPrompt)

Inlined static prompt. Can contain references to string resources in bundles.

string

Name of the static prompt to invoke.

object (StaticPromptCandidate)

The list of candidate prompts to be sent to the client. Each prompt has a selector to determine when it can be used. The first selector that matches a request will be sent and the rest will be ignored.

object (Selector)

Optional. The criteria for whether this prompt matches a request. If the selector is empty, this prompt will always be triggered.

object (StaticPromptResponse)

The prompt response associated with the selector.

object (SurfaceCapabilities)

The set of required surface capabilities.

enum (Capability)

Required. The capabilities of the surface making a request to the Action.

object (StaticSimplePrompt)

Optional. The first voice and text-only response.

object (StaticContentPrompt)

Optional. A content like a card, list or media to display to the user.

object (StaticSimplePrompt)

Optional. The last voice and text-only response.

object (Suggestion)

Optional. Suggestions to be displayed to the user which will always appear at the end of the response. If the append field in the containing prompt is true the titles defined in this field will be added to titles defined in any previously defined suggestions prompts and duplicate values will be removed.

object (StaticLinkPrompt)

Optional. An additional suggestion chip that can link out to the associated app or site. The chip will be rendered with the title "Open ". Max 20 chars.

boolean

Optional. Mode for how this messages should be merged with previously defined messages. true will clear all previously defined messages (first and last simple, content, suggestions link and canvas) and add messages defined in this prompt. false will add messages defined in this prompt to messages defined in previous responses. Setting this field to false will also enable appending to some fields inside Simple prompts, the Suggestions prompt and the Canvas prompt (part of the Content prompt). The Content and Link messages will always be overwritten if defined in the prompt. Default value is false.

object (StaticCanvasPrompt)

A response to be used for interactive canvas experience.

object (Variant)

List of possible variants.

string

Optional. Represents the speech to be spoken to the user. Can be SSML or text to speech. By default, speech will be appended to previous Simple prompt's speech. If the override field in the containing prompt is true the speech defined in this field will override previous Simple prompt's speech.

string

Optional. Text to display in the chat bubble. If not given, a display rendering of the speech field above will be used. Limited to 640 chars. By default, text will be appended to previous Simple prompt's text. If the override field in the containing prompt is true the text defined in this field will override previous Simple prompt's text.

object (StaticCardPrompt)

A basic card.

object (StaticImagePrompt)

An image.

object (StaticTablePrompt)

Table card.

object (StaticMediaPrompt)

Response indicating a set of media to be played.

object (StaticListPrompt)

A card for presenting a list of options to select from.

object (StaticCollectionPrompt)

A card presenting a list of options to select from.

object (StaticCollectionBrowsePrompt)

A card presenting a collection of web pages to open.

string

Optional. Overall title of the card.

string

Optional. Subtitle of the card.

string

Required. Body text of the card which is needed unless image is present. Supports a limited set of markdown syntax for formatting.

object (StaticImagePrompt)

Optional. A hero image for the card. The height is fixed to 192dp.

enum (ImageFill)

Optional. How the image background will be filled.

object (StaticLinkPrompt)

Optional. A clickable button to be shown in the Card.

string

Required. The source url of the image. Images can be JPG, PNG and GIF (animated and non-animated). For example,https://www.agentx.com/logo.png.

string

Required. A text description of the image to be used for accessibility, e.g. screen readers.

integer

Optional. The height of the image in pixels.

integer

Optional. The width of the image in pixels.

string

Name of the link

object (OpenUrl)

Defines behavior when the user opens the link.

string

The url field which could be any of: - http/https urls for opening an App-linked App or a webpage

enum (UrlHint)

Indicates a hint for the url type.

string

Optional. Overall title of the table. Must be set if subtitle is set.

string

Optional. Subtitle for the table.

object (StaticImagePrompt)

Optional. Image associated with the table.

object (TableColumn)

Optional. Headers and alignment of columns.

object (TableRow)

Optional. Row data of the table. The first 3 rows are guaranteed to be shown but others might be cut on certain surfaces. Please test with the simulator to see which rows will be shown for a given surface. On surfaces that support the WEB_BROWSER capability, you can point the user to a web page with more data.

object (StaticLinkPrompt)

Optional. Button.

string

Header text for the column.

enum (HorizontalAlignment)

Horizontal alignment of content w.r.t column. If unspecified, content will be aligned to the leading edge.

object (TableCell)

Cells in this row. The first 3 cells are guaranteed to be shown but others might be cut on certain surfaces. Please test with the simulator to see which cells will be shown for a given surface.

boolean

Indicates whether there should be a divider after each row.

string

Text content of the cell.

enum (MediaType)

Media type of this response.

string (Duration format)

Start offset of the first media object.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

enum (OptionalMediaControls)

Optional media control types this media response session can support. If set, request will be made to 3p when a certain media event happens. If not set, 3p must still handle two default control type, FINISHED and FAILED.

object (MediaObject)

List of media objects.

enum (RepeatMode)

Repeat mode for the list of Media Objects.

string

Name of this media object.

string

Description of this media object.

string

The url pointing to the media content.

object (MediaImage)

Image to show with the media card.

object (StaticImagePrompt)

A large image, such as the cover of the album, etc.

object (StaticImagePrompt)

A small image icon displayed on the right from the title. It's resized to 36x36 dp.

string

Optional. Title of the list.

string

Optional. Subtitle of the list.

object (ListItem)

Required. List items.

string

Required. The NLU key that matches the entry key name in the associated type. When item tapped, this key will be posted back as a select option parameter.

string

Required. Title of the item. When tapped, this text will be posted back to the conversation verbatim as if the user had typed it. Each title must be unique among the set of items.

string

Optional. Body text of the item.

object (StaticImagePrompt)

Optional. Item image.

string

Optional. Title of the collection.

string

Optional. Subtitle of the collection.

object (CollectionItem)

Required. Collection items.

enum (ImageFill)

Optional. Type of image display option.

string

Required. The NLU key that matches the entry key name in the associated Type. When item tapped, this key will be posted back as a select option parameter.

string

Required. Title of the item. When tapped, this text will be posted back to the conversation verbatim as if the user had typed it. Each title must be unique among the set of items.

string

Optional. Body text of the item.

object (StaticImagePrompt)

Optional. Item image.

object (CollectionBrowseItem)

Items in the browse collection. The list size should be in the range [2, 10].

enum (ImageFill)

Image display option for images in the collection.

string

Required. Title of the collection item.

string

Description of the collection item.

string

Footer text for the collection item, displayed below the description. Single line of text, truncated with an ellipsis.

object (StaticImagePrompt)

Image for the collection item.

object (OpenUrl)

Required. URI to open if the item selected.

string

Required. The text shown in the suggestion chip. When tapped, this text will be posted back to the conversation verbatim as if the user had typed it. Each title must be unique among the set of suggestion chips. Max 25 chars

string

Required. URL of the web view to load.

value (Value format)

Optional. JSON data to be passed through to the immersive experience web page as an event. If the override field in the containing prompt is false data values defined in this Canvas prompt will be added after data values defined in previous Canvas prompts.

boolean

Optional. A true value means that the mic won't be opened for capturing input after this immersive response is presented to the user.

boolean

Optional. If true, conversation related metadata is included and send back to the canvas application.

boolean

Optional. If true the canvas application occupies the full screen and won't have a header at the top. A toast message will also be displayed on the loading screen that includes the Action's display name, the developer's name, and instructions for exiting the Action. Default value: false.

object (EventHandler)

Handler to invoke when transitioning into this scene.

object (IntentEvent)

The list of events that trigger based on intents. These events can be triggered at any time after the on_load Handler has been called. Important - these events define the set of intents which are scoped to this scene and will take precedence over any globally defined events that have the same intents or their triggering phrases. Intent names must be unique within a scene.

object (ConditionalEvent)

The list of events to trigger based on conditional statements. These are evaluated after the form has been filled or immediately after on_load if this scene does not have a form (evaluation is only done once). Only the first matching event will be triggered.

object (Slot)

Ordered list of slots. Each slot defines the type of data that it will resolve and configuration to customize the experience of this resolution (e.g. prompts).

object (EventHandler)

Handler called when there is a change in state of a slot not caused by updates within another Handler. This allows slots to be invalidated, the scene invalidated or other changes to scene state.

string

Required. Intent triggering the event.

string

Optional. Destination scene which the conversation should jump to. The state of the current scene is destroyed on the transition.

object (EventHandler)

Optional. Event handler which is triggered when the intent is matched. Should execute before transitioning to the destination scene. Useful to generate prompts in response to events.

string

Required. Filter condition for this event to trigger. If condition is evaluated to true then the associated handler will be triggered. The following variable references are supported: $session - To reference data in session storage. $user - To reference data in user storage. The following boolean operators are supported (with examples): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) The following comparisons are supported: ==, !=, <, >, <=, >= The following list and string operators are supported (with examples): in - "Watermelon" in session.params.fruitList size - size(session.params.fruitList) > 2 substring - session.params.fullName.contains("John")

string

Optional. Destination scene which the conversation should jump to when the associated condition is evaluated to true. The state of the current scene is destroyed on the transition.

object (EventHandler)

Optional. Event handler which is triggered when the associated condition is evaluated to true. Should execute before transitioning to the destination scene. Useful to generate Prompts in response to events.

string

Required. Name of the slot.

object (ClassReference)

Required. Declares the data type of this slot.

boolean

Optional. Indicates whether the slot is required to be filled before advancing. Required slots that are not filled will trigger a customizable prompt to the user.

object (PromptSettings)

Optional. Registers Prompts for different stages of slot filling.

object (CommitBehavior)

Optional. Commit behavior associated with the slot.

value (Value format)

Optional. Additional configuration associated with the slot which is used for filling the slot. The format of the config is specific to the type of the slot. Resource references to user or session parameter can be added to this config. This config is needed for filling slots related to transactions and user engagement.

Example: For a slot of type actions.type.CompletePurchaseValue, the following config proposes a digital good order with a reference to a client defined session parameter userSelectedSkuId:

{ "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } }

object (DefaultValue)

Optional. Configuration to populate a default value for this slot.

object (EventHandler)

Prompt for the slot value itself. Example: "What size did you want?"

object (EventHandler)

Prompt to give when the user's input does not match the expected value type for the slot for the first time. Example: "Sorry, I didn't get that."

object (EventHandler)

Prompt to give when the user's input does not match the expected value type for the slot for the second time. Example: "Sorry, I didn't get that."

object (EventHandler)

Prompt to give when the user's input does not match the expected value type for the slot for the last time. Example: "Sorry, I didn't get that."

object (EventHandler)

Prompt to give when the user does not provide an input for the first time. Example: "Sorry, I didn't get that."

object (EventHandler)

Prompt to give when the user does not provide an input for the second time. Example: "Sorry, I didn't get that."

object (EventHandler)

Prompt to give when the user does not provide an input for the last time. Example: "Sorry, I didn't get that."

string

The session parameter to write the slot value after it is filled. Note that nested paths are not currently supported. "$$" is used to write the slot value to a session parameter with same name as the slot. Eg: writeSessionParam = "fruit" corresponds to "$session.params.fruit". writeSessionParam = "ticket" corresponds to "$session.params.ticket".

string

Optional. The session parameter to be used to initialize the slot value, if it has a non-empty value. The type of the value must match the type of the slot. Note that nested paths are not currently supported. Eg: sessionParam = "fruit" corresponds to $session.params.fruit. sessionParam = "ticket" corresponds to $session.params.ticket.

value (Value format)

Optional. Constant default value for the slot. This will only be used if a value for this slot was not populated through the sessionParam. The type for this value must match the type of the slot.

object (DataFile)

Multiple data files.

string

Relative path of the data file from the project root in the SDK file structure. Allowed file paths: - Images: resources/images/{multiple directories}?/{ImageName}.{extension} - Audio: resources/audio/{multiple directories}?/{AudioFileName}.{extension} - Inline Cloud Function Code: webhooks/{WebhookName}.zip Allowed extensions: - Images: png, jpg, jpeg - Audio: mp3, mpeg - Inline Cloud Functions: zip

string

Required. The content type of this asset. Example: text/html. The content type must comply with the specification (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html). Cloud functions must be in zip format and the content type should be application/zip;zip_type=cloud_function. The zip_type parameter indicates that the zip is for a cloud function.

string (bytes format)

Content of the data file. Examples would be raw bytes of images, audio files, or cloud function zip format. There is 10 MB strict limit on the payload size.

A base64-encoded string.