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

再利用可能なセマンティックタスク定義を保存します。単一ファイルソースを使用する場合は、事前に添付ファイルのアップロードを申請して完了してください。作成後、返された Name を使用して RunSemanticJob を呼び出します。

操作説明

シナリオ

再利用可能なセマンティックタスク定義を作成および保存します。この操作は、データソース、リソースグループ、およびリファレンスファイルの構成のみを保存し、タスクを即時には実行しません。

推奨ワークフロー

Source.type=singleTableFile の場合、まず UploadSemanticFile を呼び出し、返された Data.UploadUrl を使用して PUT アップロードを完了してから、ReferenceFileIds に Data.FileId を指定します。または、アクセス可能な単一の URI を指定することもできます。
Source、ProjectId、および ResourceGroupId を設定し、この操作を呼び出してタスクを保存します。
応答の Data.Name を使用して RunSemanticJob を呼び出します。タスク完了後、DownloadSemanticResults を使用して出力を取得します。

事前準備

Name は現在のテナント内で一意である必要があります。リファレンスファイルの数量ルールは、単一ファイルソースとその他のソースで異なります。詳細については、ReferenceFileIds および ReferenceFileUris フィールドの説明を参照してください。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	セマンティックタスク名。これは、後続の RunSemanticJob、DeleteSemanticJob、ListSemanticJobRuns、および DownloadSemanticResults の呼び出しにおけるタスク識別子としても機能します。名前は現在のテナント内で一意である必要があります。	semantic-job-demo
ProjectId	integer	任意	DataWorks ワークスペース ID。このパラメーターは、singleTableFile を除くすべての Source.type 値に対して必須です。作成結果の Data.ProjectId は、GetSemanticJobDetail、GetSemanticJobLog、および KillSemanticJob で再利用できます。	100
ResourceGroupId	string	必須	セマンティックタスクの実行に使用されるリソースグループの ID。RunSemanticJob はこのパラメーターを受け付けず、代わりに作成時に保存されたリソースグループを使用します。	rg-demo
Source	object	必須	セマンティックノードの入力データソース構成。type フィールドは必須です。このパラメーターは分析対象のデータを指定するものであり、semantic_model YAML 出力ではありません。domain フィールドは、sales など、ノードのビジネスドメインおよびフォーカスの ID として機能する文字列です。サポートされているタイプ: 1) maxcompute: pinnedScopeInfo を使用して範囲を指定します。配列要素には type と name が含まれます。type=project の場合、name は MaxCompute プロジェクト名です。type=schema の場合、project はプロジェクト名、name はスキーマ名です。テーブルレベルの範囲の場合、project はプロジェクト名、schema は任意、name はテーブル名です。2) holo または starrocks: type に加えて、dataSourceName と dataSourceEnv を指定する必要があり、リクエストの最上位レベルで ProjectId を渡します。pinnedScopeInfo を使用して範囲をスキーマまたはテーブルに制限できます。name 要素はスキーマまたはテーブル名であり、テーブルレベルの範囲に対する schema 要素はデータベースまたはスキーマです。3) singleTableFile: ProjectId は不要です。ファイルリファレンスルールについては、ReferenceFileIds および ReferenceFileUris を参照してください。ノードが正常に実行された後、DownloadSemanticResults を使用して semantic_model YAML およびその他の結果ファイルを取得します。例は MaxCompute プロジェクトレベルの範囲を示しています。	{"type":"maxcompute","domain":"sales","pinnedScopeInfo":[{"type":"project","name":"mc_project"}]}
ReferenceFileIds	array	任意	アップロードされたリファレンスファイル ID のリスト。Source.type=singleTableFile の場合、このパラメーターまたは ReferenceFileUris のいずれかを使用し、選択した配列には空でない要素が正確に 1 つ含まれている必要があります。ID は UploadSemanticFile によって返された Data.FileId から取得する必要があり、CSV または XLSX ファイルのみがサポートされています。その他の Source.type 値の場合、複数の ID を渡すことができます。サービスは作成時に各 ID を検証し、同時に ReferenceFileUris を渡すこともできます。
	string	任意	アップロードされたリファレンスファイル ID のオプションリスト。	semantic-job-value
ReferenceFileUris	array	任意	呼び出し元がアクセス可能なリファレンスファイル URI のリスト。Source.type=singleTableFile の場合、このパラメーターまたは ReferenceFileIds のいずれかを使用し、選択した配列には空でない URI が正確に 1 つ含まれている必要があります。その他の Source.type 値の場合、複数の URI を渡すことができ、同時に ReferenceFileIds を渡すこともできます。UploadSemanticFile からのアップロードパスを使用する場合、短期有効の UploadUrl ではなく、PUT アップロード完了後に Data.FileId を渡します。
	string	任意	アクセス可能なリファレンスファイル URI のオプションリスト。	semantic-job-value

各リクエストフィールドの説明に基づいて呼び出しパラメーターを構築します。

レスポンスフィールド

フィールド	型	説明	例
	object	セマンティックタスク作成時の標準応答。Data には保存されたタスク定義が含まれます。後続の呼び出しでは、Data の Name、ProjectId、およびリファレンスファイル情報を使用します。
RequestId	string	リクエスト ID。ログの特定や問題のトラブルシューティングに使用されます。	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	リクエストが成功したかどうかを示します。
Data	object	保存されたセマンティックタスク定義。Data.Name を使用して、RunSemanticJob、DeleteSemanticJob、ListSemanticJobRuns、および DownloadSemanticResults を呼び出します。
Id	integer	タスク定義の内部一意 ID。この呼び出しで作成されたタスクを識別します。	1
Name	string	保存されたタスク名。実行中、削除、実行記録の照会、結果のダウンロードなどの後続の操作にこの値を使用します。	semantic-job-demo
UserId	string	タスクを作成したユーザーの識別子。	user-demo
Creator	string	タスク作成者の識別子。UserId と同等であり、作成所有権を表示するために使用されます。	user-demo
ProjectId	integer	タスクが属する DataWorks ワークスペースの ID。GetSemanticJobDetail、GetSemanticJobLog、および KillSemanticJob の ProjectId としてこの値を使用します。	100
Type	string	保存された Source.type データソースタイプ。タスク入力タイプを迅速に識別するために使用されます。	maxcompute
Source	object	保存された入力データソース構成。作成リクエストの Source に対応します。分析対象のデータ範囲は、ランタイム時にこの構成に基づいて決定されます。
ReferenceFileIds	array	関連付けられたアップロード済みファイル ID のリスト。singleTableFile の場合、ランタイム時にこのリスト内の単一ファイルが読み取りされます。
	string	PUT アップロード完了後に UploadSemanticFile によって返された FileId。	FID1
ReferenceFileUris	array	関連付けられた外部リファレンスファイル URI のリスト。singleTableFile の場合、ランタイム時にこのリスト内の単一ファイルが読み取りされます。
	string	呼び出し元によって提供されたアクセス可能なリファレンスファイル URI。	https://example.com/reference.pdf
GmtCreate	integer	タスク定義の作成時間。ミリ秒単位の UNIX タイムスタンプで表されます。	1700000000000
GmtModified	integer	タスク定義の最終更新時間。ミリ秒単位の UNIX タイムスタンプで表されます。	1700000000000
ResourceGroupId	string	このタスクの実行中に使用されるリソースグループの ID。	rg-demo

応答フィールドの意味および後続の呼び出しとの関係については、各フィールドの説明を参照してください。

例

成功レスポンス

JSONJSON

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "Id": 1,
    "Name": "semantic-job-demo",
    "UserId": "user-demo",
    "Creator": "user-demo",
    "ProjectId": 100,
    "Type": "maxcompute",
    "Source": {
      "test": "test",
      "test2": 1
    },
    "ReferenceFileIds": [
      "FID1"
    ],
    "ReferenceFileUris": [
      "https://example.com/reference.pdf"
    ],
    "GmtCreate": 1700000000000,
    "GmtModified": 1700000000000,
    "ResourceGroupId": "rg-demo"
  }
}

エラーコード

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

変更履歴

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