api.ai

api.aiのActions and Parameterの概要

More than 1 year has passed since last update.

https://api.ai/docs/actions-and-parameters

Actions

あなたのアプリケーションのステップに対応するActionはユーザの入力によって特定のIntentが発火したときに働く。Actionはユーザのリクエストから抽出した情報に対するパラメータを持つことができ、下記のJSONフォーマットの中に出現する。

{“action”:”action_name”}
{“parameter_name”:”parameter_value”}

アクション名とパラメータはどちらもIntent内のActionセクションで定義される。例えば、メッセージを送るためのアプリケーションを構築しているとき、Actionセクションは自動または手動で追加されたパラメータと同様に、アクション名をもつ。

Parameters

Parametersは一般的にユーザの応答とEntityを接続するために使われる要素である。クエリに対応するJSONレスポンス内では、Parameterは下記のフォーマットで返される。

{“parameter_name”:”parameter_value”}

Parametersは2つの異なる領域に表示される。User Saysセクションでは、例が追加された後、既知のEntityに関連するParametersがハイライトされて表示される。1つの例(=User Saysの1行)内のアノテーションされた単語をクリックすると、選択されたEntity上のデータがテーブルに表示される。

IntentないのParametersのテーブルは、Actionセクションの下部に表示される。このテーブルは、現在のIntentに含まれる全てのUser Saysで使われている全てのパラメータを表現している。

Defining Parameters

Automatic(Default)

User Saysセクションに例を入力したときに、system entityやdeveloper entityに対応する単語がハイライトされ、Parameterが自動的にパラメータテーブルに追加される。

Manual

Parameterの値を手動で編集したりていぎしたりする必要があるときがあるだろう。例えば、あなたのアプリケーションがロボットの歩行モーターを制御する場合、Parameterに対して固定値を割り当てたい。そんなときはそれらの値を手動で設定する。

Deleting Prameters

Parameterの右側の☓ボタンから削除できる。

The Parameter Table

User SaysやActionパラメータテーブルの両方のエントリは、手動で定義・編集することができる。User Saysテーブルでのパラメータの変更は、選択されたUser Syasの例にしか影響しない。アクションテーブルでのパラメータの変更は、現在のIntent内にあるそのパラメータ全てに影響する。

COLUMN DESCRIPTION
REQUIRED チェックすると必須パラメータになる。これが有効なとき、Promptsカラムが出現する。これは、必須パラメータが取得できなかったときのレスポンスとなる。
PARAMETER NAME パラメータ名。JSONのキーになる。
ENTITY パラメータとリンクさせるEntity。リンクされたEntityは現在のプロパティを選択して検索リストから新しいEntityを選択することで変更ができる
VALUE パラメータにアサインされる値。User Saysテーブルにおいて、特定の例から得られた解決された値が表示される。アクションテーブルにおいては、$とパラメータ名で表現されている。
IS LIST このプロパティはパラメータの値をリストとして保持するかを設定する。ユーザの入力が列挙を含むときに理想的である。例えば、 “I would like apples, bananas, and oranges.”

Defining Values