StartAIAgentInstance - - Alibaba Cloud ドキュメントセンター

IMS で構成された AI エージェントインスタンスを起動します。

操作説明

この API を使用して、設定済みの AI エージェントインスタンスを起動し、チャットに参加させることができます。エージェント ID (AIAgentId)、ランタイム構成 (RuntimeConfig)、およびオプションでテンプレート構成 (TemplateConfig) とユーザー定義データ (UserData) を指定します。AI エージェントインスタンスが正常に起動すると、API は追跡またはさらなる操作のための一意の InstanceId を返します。

今すぐお試しください

この 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:StartAIAgentInstance

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AIAgentId	string	必須	IMS コンソールで設定されたエージェント ID。	39f8e0bc005e4f309379701645f4****
RuntimeConfig	AIAgentRuntimeConfig	必須	ランタイム時にエージェントに必要な構成。
AgentConfig	AIAgentConfig	任意	エージェントのテンプレート構成。指定する値は、コンソールで設定されたテンプレート構成とマージされます。このパラメーターを省略した場合、エージェントはコンソールからのデフォルト構成を使用します。説明このフィールドは TemplateConfig と互換性があります。AgentConfig のフィールドが優先されます。TemplateConfig に AgentConfig で定義されていないフィールドが含まれている場合、それらのフィールドが使用されます。TemplateConfig の代わりに AgentConfig を使用してください。
UserData	string	任意	ユーザー定義データ。	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	任意	チャットセッションの一意の識別子。このパラメーターはオプションです。	f213fbc005e4f309379701645f4****
ChatSyncConfig	object	任意	チャット履歴同期構成。
IMAIAgentId	string	任意	IM エージェント ID。	****005e4f309379701645f4**
ReceiverId	string	任意	受信者ユーザー ID。	4167626d312034b2b1c3b7f2f3e41884
TemplateConfig `deprecated`	AIAgentTemplateConfig	任意	エージェントのテンプレート構成。指定する値は、コンソールで設定されたテンプレート構成とマージされます。このパラメーターを省略した場合、エージェントはコンソールからのデフォルト構成を使用します。説明エージェントのテンプレート構成。このフィールドは非推奨です。AgentConfig フィールドをご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	7B117AF5-2A16-412C-B127-FA6175ED1AD0
InstanceId	string	AI エージェントインスタンスの一意の ID。	39f8e0bc005e4f309379701645f4****

例

成功レスポンス

JSONJSON

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "InstanceId": "39f8e0bc005e4f309379701645f4****"
}

エラーコード

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

変更履歴

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