Set up actions for your AI agent
Actions let your AI agent perform specific tasks by interacting with APIs or services. For example, you could create an action that checks the status of a customer’s order, or retrieves information about an incident.
アクションを設定することで、エージェントの機能を拡張し、一般的なサポート タスクを自動化できます。アクションはいくつでも作成でき、各アクションはいつでも有効または無効にできます。
The AI agent currently only supports read-only actions.
アクションを作成する
To create an action for your AI agent:
エージェント設定で、サイドバーから [アクション] を選択します。
[アクションを作成] を選択します。
アクションの詳細を入力します。
アクション名: アクションのわかりやすい名前を入力します (例: 「注文状況の確認」)。
説明: アクションの実行内容を説明します。これは、エージェントがそれをいつ使用すべきかを理解するのに役立ちます。
アクション タイプ: 現在、この機能ではデータを取得するアクション (データ取得) のみがサポートされています。
有効: このチェックボックスを選択すると、エージェントがアクションを使用できるようになります。
API 操作をセットアップ
メソッド: アクションで実行する必要がある内容に基づいて、HTTP メソッド (GET、POST) を選択します。
Server (ベース URL):API サーバーのベース URL を入力します (例:
https://api.example.com)。リクエスト URL (パス):スラッシュで始まる特定のエンドポイント パスを入力します (例:
/orders/status)。
Server (ベース URL) とリクエスト URL (パス) を取得するには、接続先の API のドキュメントをご確認ください。
クエリ パラメーターを追加する
API でクエリ パラメーターが必要な場合
[クエリ パラメーター] で [ クエリ パラメーターを追加] を選択します。
各パラメーターのキーと値を入力します。
${orderId}などの値を入力して変数を使用できます。追加 を選択します 。
ヘッダーを追加する
API でヘッダーが必要な場合、次の手順に従います。
[ヘッダー] で [ヘッダーの追加] を選択します。
キーと値 (例:
AuthorizationとBearer ${apiKey}) を入力します。追加 を選択します 。
リクエスト本文を追加する
POST メソッドを使用する際に、API 呼び出しにリクエスト本文を含めることができます。リクエスト本文は、キーと値のペアを含む JSON 形式にする必要があります。
{
"key1": "${variable1}",
"key2": "${variable2}",
"...": "..."
}したがって、次のデータを送信する場合、
名前
メール
リクエスト本文は次のようになります。
{
"name": "${name}"
"email": "${email_address}"
}キーが API エンドポイントで要求されるパラメーター名と一致し、変数として追加されていることを確認します。
変数を定義する
変数を使用すると、アクションの実行時にユーザーが入力できる入力パラメーターなど、アクション全体で使用できる動的な値を定義できます。
[変数] で [変数を追加] を選択します。
変数名、説明、データ タイプ (文字列、数値、整数、ブール値から選択) を入力します。
API 呼び出しに変数が必要な場合は、[必須] ボックスをチェックしてください。必須変数のマークに失敗すると、アクション パラメーターが期待どおりに入力されない可能性があります。
[変数を追加] を選択します。
変数の名前は、クエリ パラメーターのキーまたは JSON 本文のキーと一致している必要があります。
例
クエリ パラメーターで、次の手順に従います。
キー:
product値:
${product}
変数で、次の手順に従います。
名前:
product説明:
The product to check for incidentsデータ タイプ:
String
認証
アクションが API に接続する方法は、認証タイプによって定義されます。現在利用できる唯一のオプションは、認証を行わないことです。
アクションを保存、テスト、公開する
[Create action (アクションを作成 )] を選択してアクションを保存します。
[テスト] ボタンを使用してアクションを試し、想定通りに動作することを確認します。
You can review the steps your agent has taken in Conversation review. Read more about reviewing conversations.
準備ができたら、[公開] を選択してエージェントがアクションを利用できるようにします。
この内容はお役に立ちましたか?