Text Analysis Authoring - Train
Memicu pekerjaan pelatihan untuk proyek.
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:train?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). |
project
|
path | True |
string |
Nama proyek yang akan digunakan. |
api-version
|
query | True |
string |
Versi API klien. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
modelLabel | True |
string |
Mewakili label model output. |
trainingConfigVersion | True |
string |
Mewakili versi konfigurasi pelatihan. |
evaluationOptions |
Mewakili opsi evaluasi. Secara default, jenis evaluasi adalah persentase, dengan persentase pemisahan pelatihan sebagai 80, dan menguji persentase pemisahan sebagai 20. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
202 Accepted |
Hasil call yang sukses dengan header Operasi-Lokasi yang digunakan untuk memeriksa status pekerjaan. Header operation-location: string |
|
Other Status Codes |
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 akun sumber daya atau sub-sumber daya Azure Maps. 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 pemodelan 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 meminta 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.
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Kunci langganan untuk sumber daya layanan Bahasa.
Jenis:
apiKey
Dalam:
header
Contoh
Successful Train Project
Permintaan sampel
POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:train?api-version=2023-04-01
{
"modelLabel": "model1",
"trainingConfigVersion": "latest",
"evaluationOptions": {
"kind": "percentage",
"testingSplitPercentage": 20,
"trainingSplitPercentage": 80
}
}
Respon sampel
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definisi
Nama | Deskripsi |
---|---|
Error |
Objek kesalahan. |
Error |
Kode kesalahan yang dapat dibaca manusia. |
Error |
Respons kesalahan. |
Evaluation |
Mewakili jenis evaluasi. Secara default, jenis evaluasi diatur ke persentase. |
Inner |
Kode kesalahan yang dapat dibaca manusia. |
Inner |
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. |
Text |
Mewakili opsi yang digunakan untuk menjalankan evaluasi. |
Text |
Mewakili opsi untuk memulai pekerjaan pelatihan baru. |
Error
Objek kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
Salah satu set kode kesalahan yang ditentukan server. |
|
details |
Error[] |
Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini. |
innererror |
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 |
Objek kesalahan. |
EvaluationKind
Mewakili jenis evaluasi. Secara default, jenis evaluasi diatur ke persentase.
Nama | Jenis | Deskripsi |
---|---|---|
manual |
string |
Pisahkan data sesuai dengan himpunan data yang dipilih untuk setiap contoh dalam data. |
percentage |
string |
Pisahkan data menjadi set pelatihan dan pengujian sesuai dengan persentase yang ditentukan pengguna. |
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 |
Salah satu set kode kesalahan yang ditentukan server. |
|
details |
object |
Detail kesalahan. |
innererror |
Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
TextAnalysisAuthoringEvaluationOptions
Mewakili opsi yang digunakan untuk menjalankan evaluasi.
Nama | Jenis | Deskripsi |
---|---|---|
kind |
Mewakili jenis evaluasi. Secara default, jenis evaluasi diatur ke persentase. |
|
testingSplitPercentage |
integer |
Mewakili persentase pemisahan himpunan data pengujian. Hanya diperlukan jika jenis evaluasi adalah persentase. |
trainingSplitPercentage |
integer |
Mewakili persentase pemisahan himpunan data pelatihan. Hanya diperlukan jika jenis evaluasi adalah persentase. |
TextAnalysisAuthoringTrainingJobOptions
Mewakili opsi untuk memulai pekerjaan pelatihan baru.
Nama | Jenis | Deskripsi |
---|---|---|
evaluationOptions |
Mewakili opsi evaluasi. Secara default, jenis evaluasi adalah persentase, dengan persentase pemisahan pelatihan sebagai 80, dan menguji persentase pemisahan sebagai 20. |
|
modelLabel |
string |
Mewakili label model output. |
trainingConfigVersion |
string |
Mewakili versi konfigurasi pelatihan. |