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

新しいエージェントセッションを作成し、セッション ID を返します。

操作説明

操作の説明

この操作は、新しいエージェント会話を作成します。
_meta.agent.agentName を使用して、バインドするエージェント名を指定します。このパラメーターは必須です。
- dataworks_data_agent: DataWorks 組み込みエージェント — Data Agent。Data Integration、開発、運用保守、ガバナンス、データ分析の全パイプラインをカバーするインテリジェントなデータ開発 AI 機能を提供します。
- dataworks_chatbi_agent: DataWorks 組み込みエージェント — チャットBI。自然言語プロセスとインテリジェント分析を使用し、要件の解析、データ抽出、自動コード生成から可視化レポートの出力まで、チャット型インタラクションを通じて分析ワークフロー全体を自動化します。
- dataworks_ai_assistant_agent: DataWorks 組み込みエージェント — AI アシスタントサービス。OpenClaw や Hermes Agent などのオープンソースフレームワーク上に構築された、DataWorks のエンタープライズグレードの専用 AI アシスタントです。
_meta.config.sessionSource を使用して、ソースによる後続の取得のために会話ソース識別子を渡します。
_meta.config.sessionTags[].sessionTagCode を使用して、会話タグを渡します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:CreateAgentSession

create

*すべてのリソース。

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Jsonrpc	string	任意	JSON-RPC バージョン。固定値: 2.0。	2.0
Id	string	任意	呼び出し元によって渡されるリクエスト ID。値はそのまま返されます。	4758330557805415712
Params	object	任意	ビジネスパラメーター。
Meta	object	任意	エージェントバインディング、セッションソース、タグ、およびその他の情報を保持する拡張メタデータ。
Agent	object	任意	セッションのエージェント構成。有効な値は、ListAgents 操作によって返される結果です。
AgentName	string	任意	セッションにバインドされるエージェントの名前。このパラメーターは必須です。 dataworks_data_agent: DataWorks 組み込みエージェント — Data Agent。Data Integration、開発、運用保守、ガバナンス、データ分析の全パイプラインをカバーするインテリジェントなデータ開発 AI 機能を提供します。 dataworks_chatbi_agent: DataWorks 組み込みエージェント — チャットBI。自然言語プロセスとインテリジェント分析を使用し、要件の解析、データ抽出、自動コード生成から可視化レポートの出力まで、チャット型インタラクションを通じて分析ワークフロー全体を自動化します。 dataworks_ai_assistant_agent: DataWorks 組み込みエージェント — AI アシスタントサービス。OpenClaw や Hermes Agent などのオープンソースフレームワーク上に構築された、DataWorks のエンタープライズグレードの専用 AI アシスタントです。	dataworks_data_エージェント
Config	object	任意	セッションのパラメータ設定 (セッションソースやセッションタグに基づくパラメータ設定のフィルターなど)。
SessionSource	string	任意	ソースによる取得のためのセッションソース識別子。たとえば、エージェントがページ A とページ B の両方で使用されており、ページ A にページ A で作成されたセッションのみを表示したい場合は、このパラメーターでフィルターできます。値の長さは最大 128 文字で、英字、数字、ハイフン (-)、アンダースコア (_) を含めることができます。	openapi_sdk
SessionTags	array<object>	任意	セッションタグのリスト。セッションタグを使用して、検索およびフィルターを行えます。
	object	任意
SessionTagCode	string	任意	セッションタグ。タグでセッションをフィルターできます。たとえば、固定の RAM ユーザーを使用して OpenAPI を呼び出すが、呼び出し元のシステムに独自のアカウントシステムがある場合、このタグとして呼び出し元システムのアカウント ID を渡すことで、アカウント ID でセッションリストをフィルターできます。値の長さは最大 128 文字で、英字、数字、ハイフン (-)、アンダースコア (_) を含めることができます。	チャットbi
InitialConfigOptions	object	任意	エージェント実行環境の高度なパラメータ設定。
ExecutionLane	string	任意	実行パターン。有効な値: chat: チャットモードのみ。単純な Q&A シナリオに適しています。長所: 応答が速く、トークン消費量が少ない。短所: 複雑な問題をハンドルできない。 cli: サンドボックスパターン。複雑なデータ分析、データプロセス、コード記述シナリオに適しています。長所: 複雑な問題をハンドルでき、モデルが自律的に分析と問題解決を実行する。短所: チャットパターンと比較してプロセス速度が遅く、トークン消費量が多い。	チャット,cli
Mode	string	任意	スクリプト実行の権限付与モード。現在、OpenAPI は yolo モードのみをサポートしています。有効な値: yolo: 自動権限付与。手動介入は必須ではなく、モデルはタスクを自動的に処理できます。	yolo
ResourceGroupId	string	任意	初期化に使用されるリソースグループの ID。	Serverless_res_グループ_123123123_564657857
Skills	string	任意	ロードするカスタムスキルの名前。複数の名前はコンマ (,) で区切ります。	skill-name-1,skill-name2,skill-name-3

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス要素 (結果)。
JsonRpcResponse	object	JSON-RPC 応答。
Id	string	呼び出し元によって渡されるリクエスト ID。値はそのまま返されます。	1
Jsonrpc	string	JSON-RPC バージョン。固定値: 2.0。	2.0
Result	object	ビジネスデータ。エラーが発生した場合、値は null です。
SessionId	string	作成されたセッションの ID。	sess_0f12abc34
RequestId	string	リクエスト ID。	8A9D5E6C-5817-5837-9715-6E3967EC6123

例

成功レスポンス

JSONJSON

{
  "JsonRpcResponse": {
    "Id": "1",
    "Jsonrpc": "2.0",
    "Result": {
      "SessionId": "sess_0f12abc34"
    }
  },
  "RequestId": "8A9D5E6C-5817-5837-9715-6E3967EC6123"
}

エラーコード

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

変更履歴

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