Action
v4.68でアップデート
Code Node内では、actionsクラスとapiクラスの関数を使用することができます。
Extensions（拡張機能）で利用可能
以下の関数はExtensionsでも利用できます。そこではapiオブジェクトを使用して、例えばapi.say()を実行することができます。
その他
actions.output / actions.say || api.output / api.say
Say Nodeのような、コンタクトへの基本的な出力を実行します。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| text | 文字列 | コンタクトに送信される出力テキスト |
| data | 任意 | コンタクトに送信される出力データ |
戻り値
void
actions.completeGoal || api.completeGoal
定義された目標を入力オブジェクトの completedGoals配列に追加します。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| key | 文字列 | completedGoals配列に追加される目標の名前。 |
戻り値
Promise
actions.setTimezoneOffset || api.setTimezoneOffset
UTCからのタイムゾーンオフセットを設定します。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| offset | 数値 | オフセット時間（時間単位） |
戻り値
void
actions.log || api.log
プロジェクトログにメッセージを書き込みます。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| level | 文字列 | ログレベル（例：debugやinfo） |
| text | 文字列 | ログへのメッセージ |
戻り値
void
actions.think || api.think
1回の呼び出しでFlowを再実行するために使用されます。
Flowは一旦停止した後、Start Nodeで実行を再開します。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| text | 文字列 | ユーザーからのシミュレーションメッセージテキスト。 |
| data | 任意 | ユーザーからのシミュレーションメッセージデータ。 |
戻り値
void
Context
actions.addToContext || api.addToContext
トークのコンテキストに情報を簡単に保存するために使用されます。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| key | 文字列 | コンテキストのデータの保存場所。 |
| value | 文字列 | コンテキストに保存する値。 |
| mode | 文字列 | simpleモードでは、既存の値を置き換えます。arrayモードでは、情報を配列に保存し、新しい結果をその配列にプッシュします。 |
戻り値
void
actions.getContext || api.getContext
keyによってコンテキストからデータを取得します。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| key | 文字列 | コンテキストからデータを取得する場所。 |
戻り値
any : The requested context data
actions.resetContext || api.resetContext¶
Resets the context.
パラメータ
none
戻り値
Promise
actions.removeFromContext || api.removeFromContext¶
トークのコンテキストから情報を削除します。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| key | 文字列 | 情報を削除するコンテキストのキー。 |
| value | 文字列 | 削除する値（arrayモード） |
| mode | 文字列 | simpleモードではプロパティが完全に削除され、arrayモードではその配列から一致する値が削除されます。 |
戻り値
void
actions.deleteContext || api.deleteContext
トークのコンテキストからキーとその値を削除します。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| key | 文字列 | 情報を削除するコンテキストのキー。 |
戻り値
void
State
actions .setState || api.setState
このトークの現在のStateを設定するために使用されます。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| state | 文字列 | 起動されるべきState(状態) |
戻り値
void
actions .getState || api.getState
現在のStateを返します。
パラメータ
none
戻り値
文字列：現在のState
actions .resetState || api.resetState
FlowのStateをデフォルトのStateにリセットします。
パラメータ
none
戻り値
Promise
Lexicon
actions .setKeyphrase || api.setKeyphrase¶
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| keyphrase | 文字列 | 設定したいキーフレーズ |
| tags | 文字列[] | キーフレーズにアタッチしたいタグ |
| synonyms (optional) | 文字列[] | キーフレーズにアタッチしたい類義語 |
戻り値
void
actions.addLexiconKeyphrase || api.addLexiconKeyphrase
新しいキーワードをLexiconに追加します。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| lexiconId | 文字列 | 更新したいLexiconのID |
| keyphrase | 文字列 | Lexiconに追加したいキーワード |
| tags | 任意 | キーフレーズにアタッチしたいタグ。 |
| synonyms | 任意 | キーフレーズにアタッチしたい類義語 |
戻り値
Promise
Profile
actions.activateProfile || api.activateProfile
ユーザーが誤ってデータ収集を無効にした場合や、再びデータ収集を許可したい場合に、無効にしたプロファイルを再び有効にするために使用します。
パラメータ
None
戻り値
Promise
actions.updateProfile || api.updateProfile
ユーザーのコンタクトプロファイルを更新するために使用されます。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| key | 文字列 | ユーザーのコンタクトプロファイルのうち、どのフィールドを更新するか。 |
| value | 文字列 | 設定したい値。 |
戻り値
Promise
actions.mergeProfile || api.mergeProfile
Nodeをヒットしたコンタクトのプロファイルを、別のコンタクトのプロファイルと結合するために使用されます。
これはオムニチャネル環境で有用です。コンタクトは異なるプラットフォームでFlowと話すことができますが、すべてのプラットフォームで同一人物として認識されたい場合に便利です。
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| contactId | 文字列 | Nodeをヒットした現在のコンタクトと結合したいコンタクトのID。 |
戻り値
Promise
actions.deactivateProfile || api.deactivateProfile
コンタクトがリクエストした場合に、特定のコンタクトプロファイルを無効にするために使用されます。
パラメータ
None
戻り値
Promise