カスタムペイロードスニペット

このヘルプページの情報は、CXone StudioとDesktop Studioの両方に適用されます。

このスニペットは、Voicebot ExchangeやTextbot Conversationなど、customPayloadプロパティを持つアクションで使用します。CXoneから仮想エージェントライブの人間のエージェントの代わりに顧客とのやり取りを処理するソフトウェアアプリケーション。プロバイダーにデータを渡すために使用されます。仮想エージェントからカスタムデータを受信する必要がある場合は、customPayloadVarName (out)変数を使用します。

このスニペットは、次の仮想エージェントに必要です。

Amazon Lex V1およびAmazon Lex V2：バーチャルエージェントにデータを渡す必要がない場合でも、Lex V1とLex V2にはカスタムペイロードスニペットが必要です。バーチャルエージェントは、customPayload プロパティを通じて渡されたデータを使用して、Amazon側のSessionAttributesプロパティにデータを入力します。
Google Dialogflow ES：カスタムペイロードは、Dialogflow ES仮想エージェントがインテントコンタクトが発言または入力した内容の背後にある意味や目的。コンタクトが伝えたいことや達成したいこと。を判断するために使用するコンテキスト情報を渡します。カスタムペイロードデータをGoogle Dialogflow ESと統合するための推奨されるベストプラクティスに従います。

他のすべての仮想エージェントでは、ボットに渡すカスタムペイロードデータがある場合にのみ、スニペットを含める必要があります。DialogflowCXを使用している場合、カスタムペイロードを含めるためのベストプラクティスに従ってください。

プレースホルダを渡す

Amazon Lex V1またはAmazon Lex V2を使用していて、バーチャルエージェントに情報を渡す必要がない場合は、次の例に従います。

DYNAMIC customPayload 
 customPayload.placeholder=""

バーチャルエージェントに情報を渡す必要がある場合は、次のセクションの例に従ってください。

データを渡す

すべてのバーチャルエージェントプロバイダーについて、この例に従ってバーチャルエージェントに情報を渡します。例のパラメータを渡す必要のある情報に置き換えます。


customPayload.context.id="information"
customPayload.context.lifespan=1
customPayload.context.parameters.name="Fenrir"
customPayload.context.parameters.age="19"
customPayload.context.parameters.date="20201020"

Google Dialogflow CXカスタムペイロードのベストプラクティス

DialogflowCXは、DialogflowESのようにデータをDialogflowインテントコンタクトが発言または入力した内容の背後にある意味や目的。コンタクトが伝えたいことや達成したいこと。に渡すためにコンテキストを使用しません。
カスタムデータはJSONキー値ペアを使用してDialogflow CXに渡すことができます。スクリプト内のSnippetaction アクションで、ダイナミックcustomPayloadオブジェクトを作成して、それにキー値ペアを追加します。例：
```
DYNAMIC customPayload
customPayload.ani = ani
customPayload.contactID = contactId
customPayload.masterContactId = masterId
customPayloadJSON = "{customPayload.asJSON()}"	
```
スクリプトのExchangeまたはConversationアクションで、値にasJSON()関数を持つ変数でcustomPayloadプロパティを構成します。この変数はcustomPayloadオブジェクトにあります。
QueryParametersのPayloadプロパティを使用して、customPayloadJSONをバーチャルエージェントに渡します。 Google Dialogflow CX用のQueryParametersに関するGoogleのドキュメンテーションを参照してください。
QueryParametersによってパスされるデータはDialogflowCXのwebhookが受け取ります。パスされるデータを処理するために、Dialogflow CXコンソールでコードとを作成することができます。
customPayloadオブジェクトの中にオブジェクトをネストしないでください。ネストされたオブジェクトはリテラル文字列として送信されます。
DialogflowCXバーチャルエージェントからスクリプトにカスタムデータを渡すには、DialogflowCXコンソールのカスタムペイロードフィールドを使用します。 CXoneで使用している仮想エージェントのコンソールにいることを確認してください。スクリプトの音声またはチャットStudioアクションでcustomPayloadVarName (out)変数を使用して、これをスクリプトにマッピングします。たとえば、これを使用して次のプロンプトの動作を設定できます。
customPayloadを使用して設定されたパラメーターは、外部Webhookでのみ使用できます。外部Webhookの外部で使用するパラメーターを設定する場合は、session_paramsフィールドを持つSnippetアクションにそれらを設定します。例：
```
{
	"session_params":
	{ 
		"name": "Winnie Le Pooh"
		"job": "Food critic"
		"location": "Hundred Acre Wood"
	}
}
```
次の構文を使用して、DialogflowCXエージェントインテントのセッションパラメタにアクセスします。

$session.params.name = Winnie Le Pooh

$session.params.job = Food critic

$session.params.location = 100 Acre Wood

セッションパラメーターは、DialogflowCXバーチャルエージェントでのみ使用されます。 DialogflowESボットで同様の結果を得るには、コンテキストを使用します。
スピーチコンテキストのヒントは、speechContextsパラメーターにカスタムペイロードで渡すことができます。 speechContexts.phrases の値は、提供したいヒントのGoogleクラストークンでなければなりません。このトークンは、コンタクトの言語およびロケールと一致している必要があります。例：
```
DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		
```
VOICEBOT EXCHANGEを使用するとき：コンタクトが話している途中一時停止したときにバーチャルエージェントが待機する時間を構成するには、maxPostEnergySilenceMSパラメーターをNext Prompt BehaviorsまたはDefault Next Prompt BehaviorsSnippetアクションに追加します。

Google Dialogflow ESカスタムペイロードのベストプラクティス

CustomPayloadはインテントコンタクトが発言または入力した内容の背後にある意味や目的。コンタクトが伝えたいことや達成したいこと。のためにコンテキストを渡すために使用します。コンテキストはバーチャルエージェントがユーザーのインテントを理解するために役立ちます。コンテキストは必須ではありませんが、バーチャルエージェントが発話コンタクトが発言または入力すること。をインテントに一致させるために役立ちます。
スクリプトのSnippet アクションで、RESTリソース用のGoogle Dialogflow ESドキュメンテーションで概説されている形式に従うcustomPayloadオブジェクトを作成します: projects.agent.sessions.context Studioオンラインヘルプには、ダナミックデータ変数およびオブジェクトに関する詳細情報が用意されています。
また、コンテンツなしのcustomPayloadでカスタムデータを渡すことができます。そのためには、標準JSONキー値ペアをダイナミックデータオブジェクトに含めるようにします。
音声コンテキストは、speech_contactパラメーターのカスタムペイロードで渡されます。このパラメーターの内容は、Studioのトレースやアプリケーションログで確認できます。
スクリプト例に示すように、customPayloadDYNAMICオブジェクトはJSONのバーチャルエージェントパラメーターとして渡されます。
スピーチコンテキストのヒントは、speechContextsパラメーターにカスタムペイロードで渡すことができます。 speechContexts.phrases の値は、提供したいヒントのGoogleクラストークンでなければなりません。このトークンは、コンタクトの言語およびロケールと一致している必要があります。例：
```
DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		
```