Text Analysis Authoring - Get Training Status

Referencia

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Lekéri egy betanítási feladat állapotát.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?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).
jobId	path	True	string	A feladat azonosítója.
projectName	path	True	string	A használni kívánt projekt neve.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	TextAnalysisAuthoringTrainingJobState	A betanítási feladat eredménye.
Other Status Codes	ErrorResponse	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 Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. 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 rest API-Azure Maps ra vonatkozó engedélyből álló 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ás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. 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ése 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 az alkalmazások konfigurációalapú beállítását több használati esetben.

Az Azure Active Directory 1.0-s vagy 2.0-s verziója jelenleg a munkahelyi, iskolai és vendégfelhasználói fiókokat támogatja, de nem támogatja a személyes fiókokat.

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

Scopes

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Egy nyelvi szolgáltatási erőforrás előfizetői kulcsa.

Type: apiKey
In: header

Példák

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"
}

Definíciók

Name	Description
Error	A hibaobjektum.
ErrorCode	Emberi olvasásra alkalmas hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Emberi olvasásra alkalmas hibakód.
InnerErrorModel	Egy objektum, amely pontosabb információkat tartalmaz a hibáról. A Microsoft One API irányelveinek megfelelően : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	A feladat állapota.
TextAnalysisAuthoringSubTrainingJobState	A betanítási alművelet részletes állapotát jelöli.
TextAnalysisAuthoringTrainingJobResult	Egy betanítási feladat kimenetét jelöli.
TextAnalysisAuthoringTrainingJobState	Egy betanítási feladat állapotát jelöli.
TextAnalysisAuthoringWarning	Egy figyelmeztetést jelöl, amely a kérés végrehajtásakor lépett fel.

Error

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	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	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt 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	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 pontosabb információkat tartalmaz a hibáról. A Microsoft One API irányelveinek megfelelően : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt 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 befejezési 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	JobStatus	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 az értékelés befejezési dátumának becslését jelöli.
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	A modell kiértékelési állapotát jelöli.
modelLabel	string	Betanított modellcímkét jelöl.
trainingConfigVersion	string	A betanítási konfiguráció verzióját jelöli.
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	A modell betanítása állapotát jelöli.

TextAnalysisAuthoringTrainingJobState

Egy betanítási feladat állapotát jelöli.

Name	Típus	Description
createdDateTime	string	A feladat létrehozási dátuma.
errors	Error[]	A feladat végrehajtása során észlelt hibák.
expirationDateTime	string	A feladat lejárati dátuma.
jobId	string	A feladat azonosítója.
lastUpdatedDateTime	string	A feladat utolsó frissítésének dátuma.
result	TextAnalysisAuthoringTrainingJobResult	A betanítási tevékenységek részletes eredményét jelöli.
status	JobStatus	A feladat állapota.
warnings	TextAnalysisAuthoringWarning[]	A feladat végrehajtása során észlelt figyelmeztetések.

TextAnalysisAuthoringWarning

Egy figyelmeztetést jelöl, amely a kérés végrehajtásakor lépett fel.

Name	Típus	Description
code	string	A figyelmeztető kód.
message	string	A figyelmeztető üzenet.