Text Analysis Authoring - List Training Jobs

Layanan:

Azure AI Services

Versi API:

2022-05-01

Mencantumkan pekerjaan pelatihan yang belum kedaluwarsa yang dibuat untuk proyek.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?api-version=2022-05-01

Dengan parameter opsional:

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2022-05-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	Nama proyek yang akan digunakan.
api-version	query	True	string	Versi API klien.
maxpagesize	query		integer (int32)	Jumlah maksimum sumber daya yang akan disertakan dalam satu respons.
skip	query		integer (int32)	Offset ke dalam kumpulan sumber daya pertama yang akan dikembalikan.
top	query		integer (int32)	Jumlah maksimum sumber daya yang akan dikembalikan dari koleksi.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string	Kunci langganan untuk sumber daya layanan Bahasa.

Respons

Nama	Jenis	Deskripsi
200 OK	TextAnalysisAuthoringTrainingJobs	Daftar pekerjaan pelatihan.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Kunci langganan untuk sumber daya layanan Bahasa.

Jenis: apiKey
Dalam: header

Contoh

Successful List Training Jobs

Permintaan sampel

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs?api-version=2022-05-01

Respon sampel

Kode status:

200

{
  "value": [
    {
      "result": {
        "modelLabel": "model1",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T15:45:06.8190649Z",
          "endDateTime": "2022-04-18T15:47:19.2639682Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T15:47:19.2734976Z",
          "endDateTime": "2022-04-18T15:47:23.8378892Z",
          "status": "succeeded"
        }
      },
      "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
      "createdDateTime": "2022-04-18T15:44:44Z",
      "lastUpdatedDateTime": "2022-04-18T15:47:50Z",
      "expirationDateTime": "2022-04-25T15:44:44Z",
      "status": "succeeded"
    },
    {
      "result": {
        "modelLabel": "model2",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:22:39.3663023Z",
          "endDateTime": "2022-04-18T17:24:51.9440947Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:24:51.9571747Z",
          "endDateTime": "2022-04-18T17:24:58.1427823Z",
          "status": "succeeded"
        }
      },
      "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000",
      "createdDateTime": "2022-04-18T17:22:11Z",
      "lastUpdatedDateTime": "2022-04-18T17:25:23Z",
      "expirationDateTime": "2022-04-25T17:22:11Z",
      "status": "succeeded"
    },
    {
      "result": {
        "modelLabel": "model2",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:44:41.388358Z",
          "endDateTime": "2022-04-18T17:50:29.5675101Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:50:29.5808461Z",
          "endDateTime": "2022-04-18T17:50:35.3482185Z",
          "status": "succeeded"
        }
      },
      "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000",
      "createdDateTime": "2022-04-18T17:44:04Z",
      "lastUpdatedDateTime": "2022-04-18T17:51:11Z",
      "expirationDateTime": "2022-04-25T17:44:04Z",
      "status": "succeeded"
    }
  ],
  "nextLink": null
}

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. 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 dari pekerjaan pelatihan.
TextAnalysisAuthoringTrainingJobs	Mewakili daftar pekerjaan pelatihan yang diambil.
TextAnalysisAuthoringTrainingJobState	Mewakili keadaan pekerjaan pelatihan.
TextAnalysisAuthoringWarning	Mewakili peringatan yang ditemui saat menjalankan permintaan.

Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	ErrorCode	Salah satu sekumpulan 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

Enumeration

Kode kesalahan yang dapat dibaca manusia.

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

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerErrorCode

Enumeration

Kode kesalahan yang dapat dibaca manusia.

Nilai	Deskripsi
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. 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 sekumpulan 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

Enumeration

Status pekerjaan.

Nilai	Deskripsi
notStarted
running
succeeded
failed
cancelled
cancelling
partiallyCompleted

TextAnalysisAuthoringSubTrainingJobState

Objek

Mewakili status terperinci dari sub-operasi pelatihan.

Nama	Jenis	Deskripsi
endDateTime	string (date-time)	Mewakili waktu tanggal akhir.
percentComplete	integer (int32)	Mewakili persentase kemajuan.
startDateTime	string (date-time)	Mewakili tanggal mulai waktu.
status	JobStatus	Mewakili status sub-operasi.

TextAnalysisAuthoringTrainingJobResult

Objek

Mewakili output dari pekerjaan pelatihan.

Nama	Jenis	Deskripsi
estimatedEndDateTime	string (date-time)	Mewakili perkiraan waktu tanggal akhir 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 kereta model.

TextAnalysisAuthoringTrainingJobs

Objek

Mewakili daftar pekerjaan pelatihan yang diambil.

Nama	Jenis	Deskripsi
nextLink	string	Tautan halaman berikutnya.
value	TextAnalysisAuthoringTrainingJobState[]	Daftar pekerjaan.

TextAnalysisAuthoringTrainingJobState

Objek

Mewakili keadaan pekerjaan pelatihan.

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

TextAnalysisAuthoringWarning

Objek

Mewakili peringatan yang ditemui saat menjalankan permintaan.

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