GenerateAIAgentCall API 呼び出しによる AI エージェント起動とチャンネル参加 - IMS - Alibaba Cloud - Intelligent Media Services

エージェントインスタンスを作成し、チャンネルに参加するためのチャンネル、ユーザー名、トークンを返します。

操作説明

この API は、指定された AI エージェント ID (AIAgentId) を使用してエージェントインスタンスを作成します。応答内の情報を使用して、対応するチャンネルに参加し、エージェントとの会話を開始できます。

重要指定された AI エージェント ID が有効であることを確認し、必要に応じてオプションのパラメーターを設定してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ice:GenerateAIAgentCall

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AIAgentId	string	必須	AI エージェント ID。	39f8e0bc005e4f309379701645f4****
Expire	integer	任意	オプション。トークンの有効期間 (秒単位) です。デフォルト値：3600。値の範囲：0～604800。	3600
UserId	string	任意	チャンネル内のユーザー名。ユーザー名を指定しない場合、自動的に生成されます。ユーザー名は最大 64 文字です。	877ae632caae49b1afc81c2e8194ffb4
TemplateConfig `deprecated`	AIAgentTemplateConfig	任意	この構成は、コンソール内のエージェントテンプレート構成とマージされます。このパラメーターを省略した場合、エージェントはコンソールのデフォルト構成を使用します。説明エージェントテンプレート構成。このパラメーターは非推奨です。代わりに AgentConfig パラメーターを使用してください。
UserData	string	任意	ユーザーデータ。	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	任意	会話の一意の識別子。指定しない場合、新しい会話が作成されます。	fw1gr0bc005e4f309379701645f4****
AgentConfig	AIAgentConfig	任意	エージェントテンプレート構成。指定した構成は、コンソール内のエージェントテンプレート構成とマージされます。このパラメーターを省略した場合、エージェントはコンソールのデフォルト構成を使用します。説明 `TemplateConfig` との互換性：`AgentConfig` のフィールドが優先されます。フィールドが `TemplateConfig` で指定され、`AgentConfig` で指定されていない場合、システムは `TemplateConfig` の値を使用します。`TemplateConfig` の代わりに `AgentConfig` を使用することを推奨します。
ChatSyncConfig	object	任意	チャット同期構成。
IMAIAgentId	string	任意	インスタントメッセージング (IM) エージェントの ID。	****005e4f309379701645f4**
ReceiverId	string	任意	受信者のユーザー ID。	4167626d312034b2b1c3b7f2f3e41884

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ
AIAgentUserId	string	Alibaba Real-time Communication (ARTC) チャンネル内のエージェントの名前。	877ae632caae49b1afc81c2e8194ffb4
ChannelId	string	ARTC チャンネルの ID。	70f22d5784194938a7e387052f2b3208
InstanceId	string	生成されたエージェントインスタンスの ID。	39f8e0bc005e4f309379701645f4****
RequestId	string	リクエスト ID。	7B117AF5-2A16-412C-B127-FA6175ED1AD0
Token	string	クライアント側の ARTC トークン。	eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
UserId	string	ARTC チャンネル内のユーザー名。	user123
AvatarUserId	string	チャンネル内のアバターのユーザー ID。	avatar_39f8e0bc005e4f309379701645f4****

例

成功レスポンス

JSONJSON

{
  "AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
  "ChannelId": "70f22d5784194938a7e387052f2b3208",
  "InstanceId": "39f8e0bc005e4f309379701645f4****",
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
  "UserId": "user123",
  "AvatarUserId": "avatar_39f8e0bc005e4f309379701645f4****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。