Text Analysis Authoring - List Trained Models
Lists model terlatih milik proyek.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models?top={top}&skip={skip}&maxpagesize={maxpagesize}&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. |
maxpagesize
|
query |
integer int32 |
Jumlah maksimum sumber daya untuk disertakan dalam satu respons. |
|
skip
|
query |
integer int32 |
Offset ke dalam kumpulan sumber daya pertama yang dikembalikan. |
|
top
|
query |
integer int32 |
Jumlah maksimum sumber daya yang akan dikembalikan dari koleksi. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Daftar semua model terlatih. |
|
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 List Models
Permintaan sampel
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models?api-version=2023-04-01
Respon sampel
{
"value": [
{
"label": "model1",
"modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
"lastTrainedDateTime": "2022-04-18T15:47:49Z",
"lastTrainingDurationInSeconds": 186,
"modelExpirationDate": "2022-10-28",
"modelTrainingConfigVersion": "2022-05-01",
"hasSnapshot": true
},
{
"label": "model2",
"modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99",
"lastTrainedDateTime": "2022-04-18T17:25:22Z",
"lastTrainingDurationInSeconds": 192,
"modelExpirationDate": "2022-10-28",
"modelTrainingConfigVersion": "2022-05-01",
"hasSnapshot": true
}
],
"nextLink": null
}
Definisi
Nama | Deskripsi |
---|---|
Error |
Objek kesalahan. |
Error |
Kode kesalahan yang dapat dibaca manusia. |
Error |
Respons kesalahan. |
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 model terlatih. |
Text |
Mewakili daftar model terlatih yang diambil. |
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. |
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. |
TextAnalysisAuthoringProjectTrainedModel
Mewakili model terlatih.
Nama | Jenis | Deskripsi |
---|---|---|
hasSnapshot |
boolean |
Bendera untuk menunjukkan apakah model terlatih memiliki rekam jepret yang siap. |
label |
string |
Label model terlatih. |
lastTrainedDateTime |
string |
Waktu tanggal model terakhir yang dilatih. |
lastTrainingDurationInSeconds |
integer |
Durasi permintaan pelatihan terakhir model dalam hitungan detik. |
modelExpirationDate |
string |
Tanggal kedaluwarsa model. |
modelId |
string |
ID model. |
modelTrainingConfigVersion |
string |
Versi konfigurasi pelatihan model. |
TextAnalysisAuthoringProjectTrainedModels
Mewakili daftar model terlatih yang diambil.
Nama | Jenis | Deskripsi |
---|---|---|
nextLink |
string |
Tautan halaman berikutnya. |
value |
Daftar pekerjaan yang diambil. |