Deep link invocations

  • Deep link invocations enable users to access specific parts of your conversation using a global intent and a designated phrase.

  • These invocations are triggered when users combine your Action's display name with the deep link phrase, allowing them to jump directly to relevant content.

  • You create deep link invocations by defining global custom intents with training phrases that correspond to the desired user input.

  • Intents linked to deep link invocations can also be utilized for matching user input during an ongoing conversation.

Deep link invocations allow users to enter a specific part of your conversation, via a global intent. Users say your display name in combination with the deep link phrase to carry out a deep link invocation (for example, "Ok Google, talk to <display name> to <deep link phrase>")

To build deep link invocations, you create global custom intents with training phrases that define the user input that you want to set for the deep link.

To create deep link invocation, follow these steps:

  1. Create a sdk/custom/intents/<global_intent_name>.yaml file to define the deep link phrases for your invocation and any parameters you want to extract. For example, for a global intent that handles help requests, your training phrases might look like this:

    trainingPhrases:
    - help me
    - I need some help
    - Help
    
  2. Create a sdk/custom/global/<global_intent_name>.yaml file and define how to handle the intent. For example, this handler transitions to a scene to process the intent:

    transitionToScene: global_intent_scene
    
  3. Open the file sdk/actions/actions.yaml, and add the global intent key to the custom intents. The key is the same as the intent YAML file name without the extension. For the previous examples, the key would look like this:

    custom:
      actions.intent.MAIN: {}
      global_intent_name: {}