Copilot - Custom and System Field Mapping

Example: Copilot DirectLine - System Field Mapping 

💡In the following we want to focus our attention to the values of “text” and “value” of the Copilot API JSON response. 

As Nimbus identifies parameter with a $-sign, you can map the response as follows:

  1. Into the field Answer Raw map your type: $['text'].
     
  2. Using “Copilot” Topics: 
    1. If are not working with Topics in Copilot, map your bot response $['text'] "hello, bot" in our example above – to the Exit field in Nimbus
      ☝Note: that this raw text can be quite long and contain a lot of “extra fluff", so your Regular Expressions need to be complex enough to catch the response you are looking for.
    2. If you are working with Topics in Copilot, map the Exit to $['value'] - “Handover” in our example aboveto the Exit field in Nimbus
      💡Good to know: Copilot topics trigger controlled responses can be followed with an event activity. The event consists of a name – e.g. “Exit” in our example above – and a value . Nimbus is exclusively interested in the value portion, the name 
  3. The “Exit” field will use any values, e.g. $['value'] or $['text'] for the “Exit” condition check in your Conversation Handling Activities  > “Add Virtual User” activity. Regular Regular Expressions can be used to find the necessary words in a response, e.g. our “Handover” phrase.
Exit validation via Regex within the “Add Virtual User” activity

Example: Copilot DirectLine - Custom Field Mapping

💡This part is optional, depending if you want to continue using the bot response for other purposes, e.g. for easier referencing in Nimbus Workflows or as Conversation Context.

  1. Map the $['text'] field to a Custom Parameter for later usage, e.g. within your Flow Actions.
  2. You can also map $['value'] from your Event activity if you want to work with the topic.
  3. Repeat this for any other JSON field / value pairs you want to map to parameters.
Example of mapping API JSON response text and values to Nimbus Parameter

Table of Contents