Text Analysis Authoring - Get Training Status

Referensi

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Mendapatkan status untuk pekerjaan pelatihan.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2023-04-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	ID pekerjaan.
projectName	path	True	string	Nama proyek yang akan digunakan.
api-version	query	True	string	Versi API klien.

Respons

Nama	Jenis	Deskripsi
200 OK	TextAnalysisAuthoringTrainingJobState	Hasil pekerjaan pelatihan.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

AADToken

Ini adalah Alur OAuth2 Azure Active Directory . Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa Azure Maps akun sumber daya atau sub-sumber daya. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi direktori Azure Active. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

Saat ini, Azure Active Directory v1.0 atau v2.0 mendukung Kantor, Sekolah, dan Tamu tetapi tidak mendukung akun Pribadi.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Kunci langganan untuk sumber daya layanan Bahasa.

Type: apiKey
In: header

Contoh

Successful Get Train Status

Sample Request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01

Sample Response

Status code:: 200

{
  "result": {
    "modelLabel": "model1",
    "trainingConfigVersion": "2022-05-01",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

Definisi

Nama	Deskripsi
Error	Objek kesalahan.
ErrorCode	Kode kesalahan yang dapat dibaca manusia.
ErrorResponse	Respons kesalahan.
InnerErrorCode	Kode kesalahan yang dapat dibaca manusia.
InnerErrorModel	Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Status pekerjaan.
TextAnalysisAuthoringSubTrainingJobState	Mewakili status terperinci dari sub-operasi pelatihan.
TextAnalysisAuthoringTrainingJobResult	Mewakili output pekerjaan pelatihan.
TextAnalysisAuthoringTrainingJobState	Mewakili status pekerjaan pelatihan.
TextAnalysisAuthoringWarning	Mewakili peringatan yang ditemui saat menjalankan permintaan.

Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	ErrorCode	Salah satu set kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorCode

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerErrorCode

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nama	Jenis	Deskripsi
code	InnerErrorCode	Salah satu set kode kesalahan yang ditentukan server.
details	object	Detail kesalahan.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

JobStatus

Status pekerjaan.

Nama	Jenis	Deskripsi
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

TextAnalysisAuthoringSubTrainingJobState

Mewakili status terperinci dari sub-operasi pelatihan.

Nama	Jenis	Deskripsi
endDateTime	string	Mewakili waktu tanggal selesai.
percentComplete	integer	Mewakili persentase kemajuan.
startDateTime	string	Mewakili waktu tanggal mulai.
status	JobStatus	Mewakili status sub-operasi.

TextAnalysisAuthoringTrainingJobResult

Mewakili output pekerjaan pelatihan.

Nama	Jenis	Deskripsi
estimatedEndDateTime	string	Mewakili perkiraan waktu tanggal selesai untuk pelatihan dan evaluasi.
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	Mewakili status evaluasi model.
modelLabel	string	Mewakili label model terlatih.
trainingConfigVersion	string	Mewakili versi konfigurasi pelatihan.
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	Mewakili status pelatihan model.

TextAnalysisAuthoringTrainingJobState

Mewakili status pekerjaan pelatihan.

Nama	Jenis	Deskripsi
createdDateTime	string	Waktu tanggal pembuatan pekerjaan.
errors	Error[]	Kesalahan yang ditemui saat menjalankan pekerjaan.
expirationDateTime	string	Waktu tanggal kedaluwarsa pekerjaan.
jobId	string	ID pekerjaan.
lastUpdatedDateTime	string	Waktu tanggal terakhir pekerjaan diperbarui.
result	TextAnalysisAuthoringTrainingJobResult	Mewakili hasil terperinci tugas pelatihan.
status	JobStatus	Status pekerjaan.
warnings	TextAnalysisAuthoringWarning[]	Peringatan yang ditemui saat menjalankan pekerjaan.

TextAnalysisAuthoringWarning

Mewakili peringatan yang ditemui saat menjalankan permintaan.

Nama	Jenis	Deskripsi
code	string	Kode peringatan.
message	string	Pesan peringatan.