Text Analysis Authoring - Get Training Status

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01

Ruft den Status für einen Schulungsauftrag ab.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2023-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string url	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Die Auftrags-ID.
projectName	path	True	string	Der neue Projektname.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	TextAnalysisAuthoringTrainingJobState	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

SuccessfulGetTrainStatus

Beispielanforderung

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus
TextAnalysisAuthoringSubTrainingJobState	Stellt den detaillierten Zustand eines Untervorgangs einer Schulung dar.
TextAnalysisAuthoringTrainingJobResult	Stellt die Ausgabe eines Schulungsauftrags dar.
TextAnalysisAuthoringTrainingJobState	Stellt den Status eines Schulungsauftrags dar.
TextAnalysisAuthoringWarning	Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Lesbarer Fehlercode.

Name	Typ	Beschreibung
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

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Lesbarer Fehlercode.

Name	Typ	Beschreibung
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

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

JobStatus

Name	Typ	Beschreibung
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

TextAnalysisAuthoringSubTrainingJobState

Stellt den detaillierten Zustand eines Untervorgangs einer Schulung dar.

Name	Typ	Beschreibung
endDateTime	string	Stellt die Enddatumszeit dar.
percentComplete	integer	Stellt den Statusprozentsatz dar.
startDateTime	string	Stellt die Startdatumszeit dar.
status	JobStatus	Stellt den Status des Untervorgangs dar.

TextAnalysisAuthoringTrainingJobResult

Stellt die Ausgabe eines Schulungsauftrags dar.

Name	Typ	Beschreibung
estimatedEndDateTime	string	Stellt die geschätzte Enddatumszeit für Schulungen und Auswertungen dar.
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	Stellt den Modellauswertungsstatus dar.
modelLabel	string	Stellt eine trainierte Modellbezeichnung dar.
trainingConfigVersion	string	Stellt die Schulungskonfigurationsversion dar.
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	Stellt den Modellzugstatus dar.

TextAnalysisAuthoringTrainingJobState

Stellt den Status eines Schulungsauftrags dar.

Name	Typ	Beschreibung
createdDateTime	string	Das Erstellungsdatum des Auftrags.
errors	Error[]	Fehler beim Ausführen des Auftrags.
expirationDateTime	string	Die Ablaufzeit des Auftrags.
jobId	string	Die Auftrags-ID.
lastUpdatedDateTime	string	Das letzte Datum, zu dem der Auftrag aktualisiert wurde.
result	TextAnalysisAuthoringTrainingJobResult	Stellt das detaillierte Ergebnis von Schulungsaufgaben dar.
status	JobStatus	Der Auftragsstatus.
warnings	TextAnalysisAuthoringWarning[]	Die Warnungen, die beim Ausführen des Auftrags aufgetreten sind.

TextAnalysisAuthoringWarning

Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist.

Name	Typ	Beschreibung
code	string	Der Warncode.
message	string	Die Warnmeldung.

Freigeben über