{
   "$schema":"http://json-schema.org/draft-07/schema#",
   "description":"Pizza Order Schema",
   "title":"Pizza Order Schema",
   "type":"object",
   "properties":{
      "size":{
         "description":"The pizza size",
         "type":"string"
      },
      "orderid":{
         "description":"The pizza orderid",
         "type":"string"
      },
      "type":{
         "description":"The pizza type",
         "type":"string"
      },
      "topping":{
         "description":"The pizza topping",
         "type":"string"
      }
   }
}

スキルがイベントに応答するには、そのイベントのフローを追加し、イベントの発生時に「ユーザーに通知」状態を使用してメッセージを表示します:

1. イベントを使用するスキルで、をクリックし、「+フローの追加」をクリックします。
2. フロー名を入力して、「作成」をクリックします。
3. フロー開始のメニューをクリックし、「開始状態の追加」をクリックして「状態の追加」ダイアログを開きます。
   
   
   
   
4. 「サービス統合」→「ユーザーに通知」を選択し、状態の名前を入力して、「挿入」をクリックします。
5. 挿入された「ユーザーに通知」状態のプロパティ・インスペクタで、「コンポーネント」タブを選択し、「通知メッセージ」フィールドに、イベントの発生時にユーザーに表示するメッセージを入力します。

   このメッセージでは、次の形式の式を使用して、イベントのデータにアクセスできます。

   ${skill.system.event.value.application.data.<propertyName>}

   ノート
   
   次のタイプの式を使用して、イベントからコンテキスト情報にアクセスすることもできます:

   ${skill.system.event.value.application.context.<attributeName>}

   使用可能なコンテキスト属性の詳細は、「イベント・コンテキスト属性」を参照してください。
6. オプションで、「ユーザーID」プロパティに、フロー内(カスタム・コンポーネントなど)から動的に決定できる特定のユーザーのIDを入力します。このプロパティは、主に、ユーザーIDがイベント・ペイロードで送信されておらず、かつユーザーが統合ユーザーで、「統合ユーザーとの関連付け」プロパティがtrueに設定されているOAuth 2.0コンポーネントを使用して認証されている場合に役立ちます。統合ユーザーの詳細は、統合ユーザー・アイデンティティの構成を参照してください。

イベントを特定のユーザーにターゲット指定する必要があるが、そのユーザーがイベント自体で指定されていない場合は、イベントを処理するフロー内のユーザーを決定できる場合があります。その作業を行う一般的なステップは次のとおりです:

1. イベントを処理するフローの開始時に、(イベント・ペイロードまたはカスタム・ロジック(あるいはその両方)に基づいて)ユーザーIDを決定するカスタム・コンポーネントを追加し、そのIDを変数に割り当てます。
2. カスタム・コンポーネントの状態の後、ユーザーに通知コンポーネントを挿入し、そのコンポーネントの「ユーザーID」プロパティをカスタム・コンポーネントによって返される変数に設定します。

スキルがイベントを受信するには、メイン・フローでそのイベントのイベント・ハンドラを作成します。イベント・ハンドラで、イベントを受信するために作成した通知ユーザー状態を含むフローにイベントをマップします。

1. フローのリストで、「メイン・フロー」を選択します。
2. そのフローの「イベント」タブで、「アプリケーション・イベント」セクションの横にあるをクリックします。
3. 「アプリケーション・イベント・ハンドラの作成」ダイアログで、イベント・タイプ、イベント・タイプのバージョンおよびイベントのマップ先のフローを選択し、「閉じる」をクリックします。
   ノート
   
   「確定済」イベント・タイプのみが「未解決イベント・タイプ」フィールドに提供されます。

スキルが外部イベントを使用するには、デジタル・アシスタントの一部である必要があります。イベントをデジタル・アシスタントに消費するように構成されたスキルを追加するには:

1. をクリックしてサイド・メニューを開き、開発→デジタル・アシスタントを選択して、使用するデジタル・アシスタントをダブルクリックします。

2. 「スキルの追加」をクリックします。

3. イベントを使用するように構成されているスキルのタイルで、を選択します。

   探しているスキルが見つからない場合は、言語モードがデジタル・アシスタントの言語モードと互換性がない可能性があります。デジタル・アシスタントにスキルを追加するための条件を参照してください。

4. 「完了」ボタンをクリックしてスキル・カタログを閉じ、デジタル・アシスタントでスキルのページを表示します。

5. ページの「対話モデル」セクションまでスクロールし、「起動」の値が、ユーザーがスキルの起動に使用する名前であることを確認します。

   この名前は、これらの起動名のガイドラインに従う必要があります。

6. ユーザーがスキルを起動する方法に典型的な発話例をいくつか指定します。

   これらの発話は、デジタル・アシスタントのデフォルトのようこそ状態およびヘルプ状態で選択可能なオプションとして使用されます。

次の例は、イベントを送信するための構造化形式の使用を示しています。

curl --location --request POST 'https://<server>/events/v2/listeners/appevent/channels/<id>' \
--header 'Content-Type: application/cloudevents+json' \
--header 'X-Hub-Signature: sha256=<SHA256 encoded request body using the channel's secret key>' \
--data-raw \

'{
    "specversion": "1.0",           //Version # of Digital Assistant's Events support
    "type": "<event_name>",         //The event type that the skill is listening for
    "source": "< event source>",    //URI-reference - identifies the context in which an event happened
    "id": "<event id>",             //Unique id for the event
    "version":"<event version>",    //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "data": {                       //The business data that matches with the schema defined for the event  
           
          }
}'

async pushEvent(eventName, eventVersion, userId, channelName, eventData){
  try {

    // Build event data
    const event = {
      specversion: "1.0",           //Version # of Digital Assistant's Events support
      type: eventName, // Name of Event you created in ODA
	  source: "< event source>",    //URI-reference - identifies the context in which an event happened
      id: "<event id>",             //Unique id for the event
      time: "2022-09-07T21:19:24Z", // Any Date value will do now
      channelname: <channelName>,   // Can be set to System_Global_Test if you want to test in tester
      version: <eventVersion>, // version of the event that you defined in Digital Assistant
      userid: <userId>,
      datacontenttype: "application/json",
      data: <eventData> // JSON object represting your payload which should confirm to the event's JSON schema
    };

    // Build Required headers
    const headers = {
      "X-Hub-Signature" : this._buildSignatureHeader(event, <EVENTS_CHANNEL_SECRET_KEY> , "utf8"),
      "Content-Type" : "application/cloudevents+json"
    };

    // POST to EVENT_LISTENER_CHANNEL_URL
    ....
    
  } catch (error) {
    logger.error(error.message);
    const errorMessage = `Error pushing event [ ${eventData} ] to Digital Assistant`;
    logger.debug(errorMessage);

    throw new Error(error.message);	
  }
}



_buildSignatureHeader(body, secret, encoding) {
  const buf = Buffer.from(JSON.stringify(body), "utf8");
  return "sha256=" + this._buildSignature(buf, secret, encoding);
}

_buildSignature(buf, secret, encoding) {
  const hmac = crypto.createHmac("sha256", Buffer.from(secret || "", encoding || "utf8"));
  if (buf) {
    hmac.update(buf);
  }
  return hmac.digest("hex");
}

次に、イベント・ペイロードで使用できる一般的な属性を示します。

• specversion: (必須) Digital Assistantのイベント・サポートのバージョン番号。現在、有効な値は1.0のみです。
• type: (必須)スキルがリスニングしているイベント・タイプ。これは、「イベント・タイプの定義」タスクで指定したイベント・タイプの名前に対応している必要があります。
• source: (必須)イベントが発生したコンテキストを識別します。自由形式の文字列を指定できます。
• id: (必須)アプリケーションによってイベントに対して生成される一意のID。
• version: (必須)送信するイベント・タイプのバージョンの名前。この属性の値は、イベント・ペイロードに含める必要であり、「外部イベントのハンドラの作成」タスクで指定したイベント・タイプ・バージョンに指定した値と一致する必要があります。
  ノート
  
  この属性は、拡張属性の1つであり、CloudEvent仕様の一部ではないことを意味します。
• data: (必須)イベントに定義されたスキーマと一致するビジネス・データ。

生成されるイベントごとに、デジタル・アシスタントによって、イベントが生成されるコンテキストを説明する拡張属性が追加されます。ツールとアプリケーション・コードでは、この情報を使用して、生成されたイベントのソースやその他のイベントとの関係などを識別できます。イベント・ペイロードでこれらの属性の値も指定できます。

拡張属性(すべてString型)のリストを次に示します。

• version: 送信されるイベント・タイプのバージョンの名前。この属性の値は、イベント・ペイロードに含める必要であり、「外部イベントのハンドラの作成」タスクで指定したイベント・タイプ・バージョンに指定した値と一致する必要があります。
• userid: メッセージのターゲットとなっているユーザーのID。次の2つの形式のいずれかを取ります。
  • OCI IAMユーザーID。この場合、ペイロードにusertenancy属性も含める必要があります。
  • チャネルによって提供されるユーザーID。この場合、ペイロードにchannelname属性も含める必要があります。
    ノート
    
    Twilioの場合、この値はユーザーの携帯電話番号になります。
• usertenancy: ユーザーのアイデンティティ・プロバイダのOIC IAMテナンシの名前。
• channelname: デジタル・アシスタントが公開されるチャネルの名前。
• tenancy: デジタル・アシスタント・インスタンスのOracle Cloud Infrastructureテナンシの名前。(通常、テナンシに関する情報はリクエスト・ヘッダーに渡されるため、この属性を明示的に含める必要はありません。)

{
    "specversion": "1.0",
    "type": "com.pizzastore.pizza.ordercreated",
    "source": "pizzastore/orders",
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "time": "2022-08-10T12:31:00Z",
    "contenttype": "application/json",
    "tenancy": "mydigitalassistantinstance",
    "version": "1.0",
    "data": {"size": "Large",
            "type": "Veg"
          }
}

ペイロードでユーザーのOCI IAMユーザーIDを渡す必要がある場合は、useridおよびusertenancy属性も指定します。

{
    "specversion": "1.0",           //Version # of Digital Assistant's Events support
    "type": "<event_name>",         //The event type that the skill is listening for
    "source": "< event source>",    //URI-reference - identifies the context in which an event happened
    "id": "<event id>",             //Unique id for the event
    "version":"<event version>",    //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "userid":"<IAM user id>",      //An extension attribute(not part of CloudEvent spec) for the user ID  
    "usertenancy":<IAM tenancy>",  //Extension attribute, IAM
    "data": {                       //The business data that matches with the schema defined for the event  
           
          }
}

TwilioおよびWebチャネルを介して公開されるデジタル・アシスタントの場合、外部アプリケーションはチャネル名とチャネルによって提供されるユーザーIDを指定してユーザーに通知することもできます。

{
    "specversion": "1.0",            //Version # of Digital Assistant's Events support
    "type": "<name_of_event_type>",  //The event type that the skill is listening for
    "source": "< event source>",     //URI-reference - identifies the context in which an event happened
    "id": "<event id>",              //Unique id for the event
    "version":"<event version>",     //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "userid":"<channel user id>",    //An extension attribute(not part of CloudEvent spec) for the user ID
    "channelname":"<channel name>",  //Name of the channel through which the digital assistant is exposed
    "data": {                        //The business data that matches with the schema defined for the event  
           
          }
}