CreateSemanticJob - DataWorks - Alibaba Cloud Documentation Center

Menyimpan definisi pekerjaan semantik yang dapat digunakan kembali. Jika Anda menggunakan sumber file tunggal, ajukan dan selesaikan pengunggahan lampiran terlebih dahulu. Setelah pembuatan, panggil RunSemanticJob dengan Name yang dikembalikan.

Deskripsi operasi

Skenario

Membuat dan menyimpan definisi pekerjaan semantik yang dapat digunakan kembali. Operasi ini hanya menyimpan konfigurasi sumber data, kelompok sumber daya, dan file referensi tanpa segera menjalankan pekerjaan.

Alur kerja yang direkomendasikan

Saat Source.type=singleTableFile, panggil UploadSemanticFile terlebih dahulu, gunakan Data.UploadUrl yang dikembalikan untuk menyelesaikan pengunggahan PUT, lalu tentukan Data.FileId di ReferenceFileIds. Atau, Anda dapat menyediakan URI tunggal yang dapat diakses.
Konfigurasikan Source, ProjectId, dan ResourceGroupId, lalu panggil operasi ini untuk menyimpan pekerjaan.
Gunakan Data.Name dari tanggapan untuk memanggil RunSemanticJob. Setelah pekerjaan selesai, gunakan DownloadSemanticResults untuk mengambil output.

Sebelum Anda memulai

Name harus unik dalam penyewa saat ini. Aturan kuantitas file referensi berbeda antara sumber file tunggal dan sumber lainnya. Untuk detailnya, lihat deskripsi bidang ReferenceFileIds dan ReferenceFileUris.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
Name	string	Yes	Nama pekerjaan semantik, yang juga berfungsi sebagai pengidentifikasi pekerjaan untuk panggilan berikutnya ke RunSemanticJob, DeleteSemanticJob, ListSemanticJobRuns, dan DownloadSemanticResults. Nama harus unik dalam penyewa saat ini.	semantic-job-demo
ProjectId	integer	No	ID ruang kerja DataWorks. Parameter ini diperlukan untuk semua nilai Source.type kecuali singleTableFile. Data.ProjectId dalam hasil pembuatan dapat digunakan kembali untuk GetSemanticJobDetail, GetSemanticJobLog, dan KillSemanticJob.	100
ResourceGroupId	string	Yes	ID kelompok sumber daya yang digunakan untuk menjalankan pekerjaan semantik. RunSemanticJob tidak menerima parameter ini dan sebaliknya menggunakan kelompok sumber daya yang disimpan selama pembuatan.	rg-demo
Source	object	Yes	Konfigurasi sumber data input untuk node semantik. Bidang type wajib diisi. Parameter ini menentukan data yang akan dianalisis dan bukan output YAML semantic_model. Bidang domain adalah string yang berfungsi sebagai identitas domain bisnis dan fokus node, seperti sales. Tipe yang didukung: 1) maxcompute: Gunakan pinnedScopeInfo untuk menentukan cakupan (dalam OAuth). Elemen array berisi type dan name. Saat type=project, name adalah nama proyek MaxCompute. Saat type=schema, project adalah nama proyek dan name adalah nama skema. Untuk cakupan tingkat tabel, project adalah nama proyek, schema opsional, dan name adalah nama tabel. 2) holo atau starrocks: Selain type, Anda harus menentukan dataSourceName dan dataSourceEnv, serta meneruskan ProjectId di tingkat atas permintaan. Anda dapat menggunakan pinnedScopeInfo untuk membatasi cakupan (dalam OAuth) ke skema atau tabel. Elemen name adalah nama skema atau tabel, dan elemen schema untuk cakupan tingkat tabel adalah database atau skema. 3) singleTableFile: ProjectId tidak diperlukan. Untuk aturan referensi file, lihat ReferenceFileIds dan ReferenceFileUris. Setelah node berhasil dijalankan, gunakan DownloadSemanticResults untuk mengambil YAML semantic_model dan file hasil lainnya. Contoh menunjukkan cakupan (dalam OAuth) tingkat proyek MaxCompute.	{"type":"maxcompute","domain":"sales","pinnedScopeInfo":[{"type":"Proyek","name":"mc_project"}]}
ReferenceFileIds	array	No	Daftar ID file referensi yang diunggah. Saat Source.type=singleTableFile, gunakan parameter ini atau ReferenceFileUris, dan array yang dipilih harus berisi tepat satu elemen yang tidak kosong. ID harus berasal dari Data.FileId yang dikembalikan oleh UploadSemanticFile, dan hanya file CSV atau XLSX yang didukung. Untuk nilai Source.type lainnya, Anda dapat meneruskan beberapa ID. Layanan memvalidasi setiap ID selama pembuatan, dan Anda juga dapat meneruskan ReferenceFileUris secara bersamaan.
	string	No	Daftar ID file referensi yang diunggah opsional.	semantic-job-value
ReferenceFileUris	array	No	Daftar URI file referensi yang dapat diakses oleh pemanggil. Saat Source.type=singleTableFile, gunakan parameter ini atau ReferenceFileIds, dan array yang dipilih harus berisi tepat satu URI yang tidak kosong. Untuk nilai Source.type lainnya, Anda dapat meneruskan beberapa URI dan juga meneruskan ReferenceFileIds secara bersamaan. Saat menggunakan jalur unggahan dari UploadSemanticFile, teruskan Data.FileId setelah pengunggahan PUT selesai, bukan UploadUrl berumur pendek.
	string	No	Daftar URI file referensi yang dapat diakses opsional.	semantic-job-value

Susun parameter panggilan berdasarkan deskripsi setiap bidang permintaan.

Elemen respons

Element	Type	Description	Example
	object	Tanggapan standar untuk membuat pekerjaan semantik. Data berisi definisi pekerjaan yang disimpan. Panggilan berikutnya menggunakan Name, ProjectId, dan informasi file referensi dari Data.
RequestId	string	ID permintaan. Digunakan untuk melacak log dan memecahkan masalah.	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	Menunjukkan apakah permintaan berhasil.
Data	object	Definisi pekerjaan semantik yang disimpan. Gunakan Data.Name untuk memanggil RunSemanticJob, DeleteSemanticJob, ListSemanticJobRuns, dan DownloadSemanticResults.
Id	integer	ID unik internal definisi pekerjaan, yang mengidentifikasi pekerjaan yang dibuat oleh panggilan ini.	1
Name	string	Nama pekerjaan yang disimpan. Gunakan nilai ini untuk operasi berikutnya seperti Berjalan, menghapus, mengkueri catatan jalankan, dan mengunduh hasil.	semantic-job-demo
UserId	string	Pengidentifikasi pengguna yang membuat pekerjaan.	user-demo
Creator	string	Pengidentifikasi pembuat pekerjaan, setara dengan UserId, digunakan untuk menampilkan kepemilikan pembuatan.	user-demo
ProjectId	integer	ID ruang kerja DataWorks tempat pekerjaan berada. Gunakan nilai ini sebagai ProjectId untuk GetSemanticJobDetail, GetSemanticJobLog, dan KillSemanticJob.	100
Type	string	Tipe sumber data Source.type yang disimpan, digunakan untuk mengidentifikasi dengan cepat tipe input pekerjaan.	maxcompute
Source	object	Konfigurasi sumber data input yang disimpan, sesuai dengan Source dalam permintaan pembuatan. Cakupan (dalam OAuth) data yang akan dianalisis ditentukan berdasarkan konfigurasi ini pada waktu proses.
ReferenceFileIds	array	Daftar ID file yang diunggah terkait. Untuk singleTableFile, satu file dalam daftar ini dibaca pada waktu proses.
	string	FileId yang dikembalikan oleh UploadSemanticFile setelah pengunggahan PUT selesai.	FID1
ReferenceFileUris	array	Daftar URI file referensi eksternal terkait. Untuk singleTableFile, satu file dalam daftar ini dibaca pada waktu proses.
	string	URI file referensi yang dapat diakses yang disediakan oleh pemanggil.	https://example.com/reference.pdf
GmtCreate	integer	Waktu pembuatan definisi pekerjaan, dinyatakan sebagai stempel waktu UNIX dalam milidetik.	1700000000000
GmtModified	integer	Waktu modifikasi terakhir definisi pekerjaan, dinyatakan sebagai stempel waktu UNIX dalam milidetik.	1700000000000
ResourceGroupId	string	ID kelompok sumber daya yang digunakan saat Berjalan pekerjaan ini.	rg-demo

Untuk arti bidang tanggapan dan hubungannya dengan panggilan berikutnya, lihat deskripsi bidang masing-masing.

Contoh

Respons sukses

JSONformat

{
  "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"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.