Text Analysis Authoring - List Training Jobs
Listák a projekthez létrehozott nem lejárt betanítási feladatokat.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Támogatott Cognitive Services-végpont (pl. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
A használni kívánt projekt neve. |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
maxpagesize
|
query |
integer int32 |
Az egyetlen válaszba belefoglalandó erőforrások maximális száma. |
|
skip
|
query |
integer int32 |
Az első visszaadandó erőforrás gyűjteményének eltolása. |
|
top
|
query |
integer int32 |
A gyűjteményből visszatérni kívánt erőforrások maximális száma. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A betanítási feladatok listája. |
|
Other Status Codes |
Hibaválasz. |
Biztonság
AADToken
Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több, a REST API-khoz Azure Maps engedélyekkel rendelkező egyéni szerepkörrel.
A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.
Jegyzetek
- Ez a biztonsági definíció a fejléc használatával
x-ms-client-id
jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.
Ez Authorization URL
az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek.
* Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
* A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.
- Jelenleg az Azure Active Directory 1.0-s vagy 2.0-s verziója támogatja a Munkahelyi, iskolai és vendégfelhasználói verziót, de nem támogatja a személyes fiókokat.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Egy language service-erőforrás előfizetési kulcsa.
Típus:
apiKey
In:
header
Példák
Successful List Training Jobs
Mintakérelem
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs?api-version=2023-04-01
Mintaválasz
{
"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
}
Definíciók
Name | Description |
---|---|
Error |
A hibaobjektum. |
Error |
Emberi olvasásra alkalmas hibakód. |
Error |
Hibaválasz. |
Inner |
Emberi olvasásra alkalmas hibakód. |
Inner |
Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
A feladat állapota. |
Text |
A betanítási alművelet részletes állapotát jelöli. |
Text |
Egy betanítási feladat kimenetét jelöli. |
Text |
A beolvasott betanítási feladatok listáját jelöli. |
Text |
Egy betanítási feladat állapotát jelöli. |
Text |
A kérés végrehajtása során észlelt figyelmeztetést jelöli. |
Error
A hibaobjektum.
Name | Típus | Description |
---|---|---|
code |
A kiszolgáló által definiált hibakódok egyike. |
|
details |
Error[] |
A jelentett hibához vezető konkrét hibák részleteinek tömbje. |
innererror |
Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról. |
|
message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
A hiba célja. |
ErrorCode
Emberi olvasásra alkalmas hibakód.
Name | Típus | Description |
---|---|---|
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
Hibaválasz.
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
InnerErrorCode
Emberi olvasásra alkalmas hibakód.
Name | Típus | Description |
---|---|---|
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
Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Típus | Description |
---|---|---|
code |
A kiszolgáló által definiált hibakódok egyike. |
|
details |
object |
Hiba részletei. |
innererror |
Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról. |
|
message |
string |
Hibaüzenet. |
target |
string |
Hibacél. |
JobStatus
A feladat állapota.
Name | Típus | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringSubTrainingJobState
A betanítási alművelet részletes állapotát jelöli.
Name | Típus | Description |
---|---|---|
endDateTime |
string |
A záró dátum időpontját jelöli. |
percentComplete |
integer |
A folyamat százalékos arányát jelöli. |
startDateTime |
string |
A kezdési dátum időpontját jelöli. |
status |
Az alművelet állapotát jelöli. |
TextAnalysisAuthoringTrainingJobResult
Egy betanítási feladat kimenetét jelöli.
Name | Típus | Description |
---|---|---|
estimatedEndDateTime |
string |
A betanítás és a kiértékelés befejezési dátumának becslését jelöli. |
evaluationStatus |
A modell kiértékelési állapotát jelöli. |
|
modelLabel |
string |
Betanított modell címkéjét jelöli. |
trainingConfigVersion |
string |
A betanítási konfiguráció verzióját jelöli. |
trainingStatus |
A modell betanítása állapotát jelöli. |
TextAnalysisAuthoringTrainingJobs
A beolvasott betanítási feladatok listáját jelöli.
Name | Típus | Description |
---|---|---|
nextLink |
string |
A következő oldal hivatkozása. |
value |
A feladatok listája. |
TextAnalysisAuthoringTrainingJobState
Egy betanítási feladat állapotát jelöli.
Name | Típus | Description |
---|---|---|
createdDateTime |
string |
A feladat létrehozási dátumának időpontja. |
errors |
Error[] |
A feladat végrehajtása során előforduló hibák. |
expirationDateTime |
string |
A feladat lejárati dátumának időpontja. |
jobId |
string |
A feladat azonosítója. |
lastUpdatedDateTime |
string |
A feladat utolsó frissítésének dátuma. |
result |
A betanítási tevékenységek részletes eredményét jelöli. |
|
status |
A feladat állapota. |
|
warnings |
A feladat végrehajtása során észlelt figyelmeztetések. |
TextAnalysisAuthoringWarning
A kérés végrehajtása során észlelt figyelmeztetést jelöli.
Name | Típus | Description |
---|---|---|
code |
string |
A figyelmeztető kód. |
message |
string |
A figyelmeztető üzenet. |