OBotMLでダイアログ・フローを記述する方法

ダイアログ・フロー内の特定のパスでダイアログ・エンジンを設定するには、状態の遷移プロパティを設定します。遷移は、変数値が設定されている場合または設定されていない場合に、ダイアログがどのように分岐するかを記述します。これにより、会話の典型的なルート(ハッピー・フロー)をプロットしたり、値の欠落や予期しないユーザーの動作に対応する代替ルートを設定できます。

  unresolved:
    component: "System.Output"
    properties:
      text: "Sorry! I don't understand that question!"
    transitions:
      return: "unresolved"

transitions:
    error: "handleMe"

transitions:
  actions:
    error: "handleMe"

state_name:
  component: "component name"
  properties:
    component_property: "value"
    component_proprety: "value"
  transitions:
    next: "go_to_state"
    error: "go_to_error_handler"
    actions:
      action_string1: "go_to_state1"
      action_string2: "go_to_state2"

next遷移を使用して、デフォルトの次の状態を指定します。状態がerror遷移、actions遷移およびnext遷移を組み合せた場合、next遷移は、コンポーネントがerror遷移またはactions遷移を満たす文字列を返すことができない場合にのみトリガーされます。

context:
  variables:
    name: "string"
defaultTransitions:
  next: "nextRules"
states: 
  getName:
    component: "System.Text"
    properties:
      prompt: "What's your name please?"
      variable: "name"
    transitions: 
      next: "printName"
  printName:
    component: "System.Output"
    properties:
      text: "Hello ${name.value}." 
    transitions:
      return: "done"
  nextRules:
    component: "System.Output"
    properties:
      text: "Hello ${name.value}. I told you! Next transitions rule the game!" 
    transitions:
      return: "done"

同じデジタル・アシスタント内の第2スキルでなんらかの作業を実行するために、エンゲージしているスキルを一時的に離れる明示的オプションをユーザーに提供する場合があります。たとえば、ショッピング・スキル内でいくつかの選択を行った後、銀行取引スキルにジャンプして(購入に十分な金額があることを確認するため)、その後ショッピング・スキルに戻ってオーダーを完了できるようにするボタンを表示できます。

YAMLダイアログ・フローでこれに対処するために、同じデジタル・アシスタント内の別のスキルとの対話を開始して、その後元のフローに戻るようにスキルのアクションを構成できます。

この仕組みは次のとおりです:

1. System.CommonResponseコンポーネントを使用して、別のスキルでなんらかの作業を実行するためのボタンをユーザーに表示します。

   このボタンはポストバック・アクション(ターゲット・スキルに誘導する発話を提供するようにペイロードを構成する)に基づきます。そのターゲット・スキルにルーティングされる可能性を最大化するために、発話にそのスキルの起動名を含める(つまり、明示的な起動)ことが理想的です。基本的に、これを行うことによって、目的のインテントをトリガーする発話をハードコードします。

   そのコードのフォーマットは次のとおりです:

   
     component: "System.CommonResponse"
     properties:
       metadata:
       ...
         responseItems:
           - type: "cards"
             ...
             actions:
                 ...
               - label: "Press me to switch to different skill"
                 type: "postback"
                 payload:
                   action: "system.textReceived"
                   variables:
                     system.text: "utterance with invocation name that you want passed to the digital assistant"
                   ...

   system.textReceivedアクションを使用してsystem.text変数にテキストを指定することで、ポストバックが、デジタル・アシスタントによって正しくルーティングできるユーザー・メッセージとして処理されます。

   ノート
   
   このようにsystem.textReceivedを使用する場合、system.textがポストバック・ペイロードで定義できる唯一の変数です。ペイロード内のその他の変数はすべて無視されます。
2. textReceived遷移を、System.Intentコンポーネントを含む状態に設定します。

   
     transitions:
       actions:
         ....
         textReceived: "Name of the state for the System.Intent component"

   これは、デジタル・アシスタントにターゲット・スキルが含まれていない場合に、デジタル・アシスタントによって適切なフォールバック・レスポンスが提供されるようにするために必要です。

   これが機能するには、スキルのSystem.IntentコンポーネントでdaInterceptプロパティが"always" (デフォルト)に設定されている必要があります。

ターゲット・スキルがデジタル・アシスタント内にある場合、デジタル・アシスタントは明示的な起動を認識し、リクエスト(通常はコンポーネントによって処理される)を制御して、このリクエストをターゲット・スキルのSystem.Intentコンポーネントにルーティングします。ターゲット・スキルのフローが終了すると、ユーザーはコール・スキルに戻ります。

ターゲット・スキルがデジタル・アシスタント内にない場合(またはコール・スキルがデジタル・アシスタントなしで公開されている場合)、コール・スキルのSystem.Intentコンポーネントが起動され、インテントはunresolvedIntentに解決されます。

system.text: "ask  ${system.config.daCrcPizzaFinSkillInvocationName}, what is my balance"

たとえば、ここでは、ユーザーがオーダーを完了する前に銀行口座残高を確認するオプションを提供する、ピザのオーダー(OrderPizza)インテントを示します。口座残高は、別のスキル(CashBank)によって提供されます。ユーザーがCheck Balanceオプションを選択すると、「ask CashBank, what is my balance」というテキストがデジタル・アシスタントにポストされ、ユーザーはCashBankスキル内の該当するインテントにルーティングされます。

OrderPizza:
  component: "System.CommonResponse"
  properties:
    metadata:
    ...
      responseItems:
        - type: "cards"
          headerText: "Our pizzas:"
          cardLayout: "vertical"
          name: "PizzaCards"
          actions:
            - label: "More Pizzas"
              ...
            - label: "Check bank account balance"
              type: "postback"
              payload:
                action: "system.textReceived"
                variables:
                  system.text: "ask CashBank, do I have enough money?"
                ...
    processUserMessage: true
  transitions:
    actions:
      order: "AskPizzaSize"
      more: "OrderPizza"
      textReceived: "Intent" # where the value of textReceived is the name CashBank's System.Intent state
  ...

ピザ・スキルがCash Bankスキルと同じデジタル・アシスタント内にあると仮定すると、デジタル・アシスタントをテスターで開き、ピザ・スキルにアクセスしてから「Check bank account balance」をクリックした場合のように表示されます。

テスターの「ルーティング」タブで、明示的な起動が認識され、明示的な起動が優先されていることを確認できます:

図skill-routing-explicit.pngの説明

さらに、Cash BankスキルのCheck Balanceインテントが一致していることを確認できます:

図skill-routing-intent.pngの説明

"${user.age.value}"などの式を使用して、格納されているユーザー値を設定する、次のコンポーネントのvalueプロパティを定義します。

YAMLダイアログ・フローの場合、自動採番機能は、グローバル・スケール(ダイアログ・フロー定義で指定したすべてのコンポーネントに影響を及ぼす)またはポストバック・アクションをトリガーするコンポーネントのコンポーネント・レベル(System.List、 System.CommonResponse、System.ResolveEntities、System.QnA、System.Webview、System.OAuthAccountLinkComponentおよびSystem.OAuth2AccountLinkComponentコンポーネント)で設定できます。