Connect guides to external services with data actions

前提条件 
  • Virtual Agent enabled in your organization. For more information, contact your designated Customer Success Manager.
  • AI Studio permissions for Guides. For more information about all the required permissions, see AI Studio permissions. 

Data actions enable your AI agents to access external data sources and use the retrieved data to perform the task at hand. During a conversation, your AI agent can retrieve relevant information about a contact from a CRM database, such as name, address, contact numbers, account number, or account status.

For more information about creating a custom data action, see Create a custom action for integrations.

Use data actions

  1. 管理をクリックします。
  2. Under AI Studio, click Guides. 
  3. Open an existing guide or create a new one.
  4. In the Instructions tab, place your cursor where you want to insert a data action and type /. 
    A pop-up dialog box appears showing options to insert a data action or variable.
  5. Select Data Actions. The dialog box now lists the available data actions. 
  6. Select the required data action. The editor highlights variables present in your guide by a blue underline.
  7. To view more details about the data action, click the data action name. 
    The right panel expands and displays information about the data action. Click View to open the specific data action in a new browser tab or click Done to close the panel and return to the instructions tab.
  8. 保存するをクリックします。

メモ: 
  • The maximum number of data actions that you can have in a guide is five.
  • The maximum number of input parameters of a data action that you can use in a guide is four.
  • The number of data action invocations in a guide counts toward the data action execution limits per session.

Data actions availability

  • Secure data actions are unavailable in guides. 
  • Data actions may not be available for selection in guides if they are configured as follows:
    • Data actions with null value parameters
    • Data actions with more than four input parameters
    • Data actions with incorrect naming. The data action’s name must conform to the following requirements:
      • Must be less than 100 characters
      • Must start with an alphanumeric character
      • Must contain alphanumeric characters, underscores, or hyphens only
      • Must not contain consecutive underscores or hyphens
Note: If you do not see a data action in the available data actions list, try refreshing the page. The list of available data actions are retrieved on page load.

Use parameters of a data action

To use a data action’s input or output parameter in your guides, specify the exact name of the parameter, for example, Save OrderStatus. Avoid creating variables for data action parameters unless you want to send that data to or receive that data from Architect. 

If you must create a variable for a data action parameter, add a step in your guides to help the system map the data action output to the guide’s variable. For example, Save OrderStatus as CustomerOrderStatus.

For more information about writing instructions and publishing a guide, see Write and publish guides.