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

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

カスタムペイロードスニペットは、customPayloadプロパティを持つアクションを使用するときにスクリプトで必要です。例えば、Voicebot ExchangeやTextbot Conversationです。 CXone Mpowerから仮想エージェントライブの人間のエージェントの代わりに顧客とのやり取りを処理するソフトウェアアプリケーション。プロバイダーにデータを渡すために使用されます。仮想エージェントからカスタムデータを受信する必要がある場合は、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 V2やAmazon Lex V1など、情報を渡す必要のない仮想エージェントを使用する場合は、次の例に従ってください。

DYNAMIC customPayload 
 customPayload.placeholder=""

データを渡す

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

DYNAMIC customPayload
ASSIGN customPayload.context.id="information"
ASSIGN customPayload.context.lifespan=1
ASSIGN customPayload.context.parameters.name="Fenrir"
ASSIGN customPayload.context.parameters.age="19"
ASSIGN 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 アクションで、customPayloadプロパティを構成します。このプロパティは、値にasJSON()関数を含む変数で構成されます。この変数はcustomPayloadオブジェクトにあります。
QueryParametersのPayloadプロパティを使用して、customPayloadJSONをバーチャルエージェントに渡します。 Google Dialogflow CX用のQueryParametersに関するGoogleのドキュメンテーションを参照してください。
QueryParametersによってパスされるデータはDialogflowCXのwebhookが受け取ります。パスされるデータを処理するために、Dialogflow CXコンソールでコードとを作成することができます。
customPayloadオブジェクトの中にオブジェクトをネストしないでください。ネストされたオブジェクトはリテラル文字列として送信されます。
DialogflowCXバーチャルエージェントからスクリプトにカスタムデータを渡すには、DialogflowCXコンソールのカスタムペイロードフィールドを使用します。 CXone Mpowerで使用している仮想エージェントのコンソールにいることを確認してください。スクリプトのcustomPayloadVarName (out)またはVOICEBOT EXCHANGE TEXTBOT EXCHANGEアクションでStudio変数を使用して、これをスクリプトにマップします。たとえば、これを使用して次のプロンプトの動作を設定できます。
スクリプトからDialogflow CXにカスタムデータを渡すには、session_paramsをcustomPayloadオブジェクトのSnippetアクションで使用します。例：
```
DYNAMIC customPayload
customPayload.session_params.name = "Winnie le Pooh" 
customPayload.session_params.job = "Food critic" 
customPayload.session_params.location = "Hundred Acre Wood"	
```
次の構文を使用して、DialogflowCXエージェントインテントのセッションパラメタにアクセスします。
```
$session.params.name = Winnie Le Pooh
$session.params.job = Food critic
$session.params.location = 100 Acre Wood
                
```
セッションパラメーターは、DialogflowCXバーチャルエージェントでのみ使用されます。 DialogflowESボットで同様の結果を得るには、コンテキストを使用します。
音声コンテキストのヒントとカスタム会話IDを設定して、Dialogflow CX仮想エージェントに会話を転送するカスタムペイロードスニペット内にあります。
VOICEBOT EXCHANGEを使用するとき：コンタクトが話している途中一時停止したときにバーチャルエージェントが待機する時間を構成するには、maxPostEnergySilenceMSパラメーターをNext Prompt BehaviorsまたはDefault Next Prompt BehaviorsSnippetアクションに追加します。

Dialogflow CXのための音声コンテキストのヒント

音声コンテキストヒントは、カスタムペイロードスニペットの speechContexts パラメーターで渡すことができます。 speechContexts.phrases の値は、提供したいヒントのGoogleクラストークン中央から右上に向かって矢印が伸びている正方形。でなければなりません。このトークンは、コンタクトの言語およびロケールと一致している必要があります。例：

DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10

これらのパラメータを次のように設定します。

speechContexts.phrases：提供したいヒントのGoogleクラストークン。このトークンは、コンタクトの言語およびロケールと一致している必要があります。複数のトークンを追加したい場合は、トークンごとにspeechContexts.phrasesパラメーターを追加します。
speechContexts.boost：1〜20の間で指定されたphraseに重み付けされた数値。トランスクリプションサービスは、オーディオデータ内の単語に対して可能なトランスクリプションを選択する際に、この値を使用します。値が高いほど、トランスクリプションサービスが代替からその単語やフレーズを選ぶ可能性が高くなります。

このパラメーターの内容は、Studioトレースおよびアプリケーションログで確認できます。

CXバーチャルエージェント間でのコンタクトDialogflow転送

コンタクトの転送をあるDialogflowCXバーチャルエージェントから別のDialogflowCXバーチャルエージェントに設定するには、カスタムペイロードスニペットに次の行を含めます。 custom_value を、会話 ID を保持する変数名に置き換えます。

{
  “cxone_override_conversation“: {custom_value} 
}

使用する変数にこのパラメータを入力するようにスクリプトを設定してください。

スクリプトは、

cxone_override_conversationパラメーターは、ボットセッション状態スニペットで設定されたボットセッション状態IDに似ています。どちらも、仮想エージェントがターン間の会話のコンテキストを維持するのに役立ちます。ボットセッション状態IDと会話IDの値が正しい場所に表示されるように、スクリプトを慎重に設定する必要があります。ボットのセッション状態は、常にcxone_override_conversationパラメーターよりも優先されます。スクリプトを次のように設定します。

バーチャルエージェント#	回る#	設定
1	1	またはアクションのVoicebot EXCHANGEbotSessionStateTextbot EXCHANGEプロパティが空です。ターンはボットセッション状態IDを返し、botSessionStateVarName (out)を入力します。これはボットセッション状態ID #1です。
1	この仮想エージェントで2ターン以降	このスクリプトは、ボットセッション状態ID #1をDialogflow CXバーチャルエージェント#1に送信します。同じ ID がスクリプトに返されます。
2	3 (最初はこの仮想エージェントで)	またはアクションのVoicebot EXCHANGEbotSessionStateTextbot EXCHANGEプロパティが空です。このターンのカスタムペイロードスニペットにはcxone_override_conversation = [variable]が含まれています。このターンは、一意のボットセッション状態IDを返し、botSessionStateVarName (out)を入力し、すでに含まれている値を上書きします。これはボットセッション状態 ID #2 です。
2	4(このバーチャルエージェントで2ターン目)	スクリプトは、ボットセッション状態ID #2をDialogflow CX仮想エージェント#2に送信します。同じ ID がスクリプトに返されます。

Dialogflow CX のインスタンスを 2 つ以上使用する場合、パターンは前の表で確立したとおりに続行されます。

この仮想エージェント間の転送方法は、2つ以上のDialogflow CX仮想エージェント間で転送する場合にのみ必要です。他のバーチャルエージェントプロバイダー間で転送する場合は、ボットセッション状態IDを使用できます。

Google Dialogflow ESカスタムペイロード

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

DialogflowESの音声コンテキストのヒント

DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10

これらのパラメータを次のように設定します。

speechContexts.phrases：提供したいヒントのGoogleクラストークン。このトークンは、コンタクトの言語およびロケールと一致している必要があります。複数のトークンを追加したい場合は、トークンごとにspeechContexts.phrasesパラメーターを追加します。
speechContexts.boost：1〜20の間で指定されたphraseに重み付けされた数値。トランスクリプションサービスは、オーディオデータ内の単語に対して可能なトランスクリプションを選択する際に、この値を使用します。値が高いほど、トランスクリプションサービスが代替からその単語やフレーズを選ぶ可能性が高くなります。

このパラメーターの内容は、Studioトレースおよびアプリケーションログで確認できます。