Text Analysis Authoring - Get Training Status

Ruft den Status für einen Schulungsauftrag ab.

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

URI-Parameter

Name In Required Type Description
Endpoint
path True
  • string

Unterstützte kognitive Dienste-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).

jobId
path True
  • string

Die Auftrags-ID.

projectName
path True
  • string

Der Name des zu verwendenden Projekts.

api-version
query True
  • string

Client-API-Version.

Anforderungsheader

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Ein Abonnementschlüssel für eine Sprachdienstressource.

Antworten

Name Type Description
200 OK

Das Ergebnis des Schulungsauftrags.

Other Status Codes

Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Type: apiKey
In: header

Beispiele

Successful Get Train Status

Sample Request

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

Sample Response

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

Error

Das Fehlerobjekt.

ErrorCode

Fehlercode für menschenlesbare Fehler.

ErrorResponse

Fehlerantwort.

InnerErrorCode

Fehlercode für menschenlesbare Fehler.

InnerErrorModel

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

JobStatus

Der Auftragsstatus.

TextAnalysisAuthoringSubTrainingJobState

Stellt den detaillierten Zustand eines Schulungsuntervorgangs dar.

TextAnalysisAuthoringTrainingJobResult

Stellt die Ausgabe eines Schulungsauftrags dar.

TextAnalysisAuthoringTrainingJobState

Stellt den Zustand eines Schulungsauftrags dar.

TextAnalysisAuthoringWarning

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

Error

Das Fehlerobjekt.

Name Type Description
code

Eine serverdefinierte Gruppe von Fehlercodes.

details

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.

innererror

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

message
  • string

Eine menschliche lesbare Darstellung des Fehlers.

target
  • string

Das Ziel des Fehlers.

ErrorCode

Fehlercode für menschenlesbare Fehler.

Name Type 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

Fehlerantwort.

Name Type Description
error

Das Fehlerobjekt.

InnerErrorCode

Fehlercode für menschenlesbare Fehler.

Name Type 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

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

Name Type Description
code

Eine serverdefinierte Gruppe von Fehlercodes.

details
  • object

Fehlerdetails.

innererror

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

message
  • string

Fehlermeldung.

target
  • string

Fehlerziel.

JobStatus

Der Auftragsstatus.

Name Type Description
cancelled
  • string
cancelling
  • string
failed
  • string
notStarted
  • string
partiallyCompleted
  • string
running
  • string
succeeded
  • string

TextAnalysisAuthoringSubTrainingJobState

Stellt den detaillierten Zustand eines Schulungsuntervorgangs dar.

Name Type Description
endDateTime
  • string

Stellt die Enddatumszeit dar.

percentComplete
  • integer

Stellt den Fortschrittsanteil dar.

startDateTime
  • string

Stellt die Startdatumszeit dar.

status

Stellt den Status des Untervorgangs dar.

TextAnalysisAuthoringTrainingJobResult

Stellt die Ausgabe eines Schulungsauftrags dar.

Name Type Description
estimatedEndDateTime
  • string

Stellt die Geschätzte Enddatumszeit für Schulung und Auswertung dar.

evaluationStatus

Stellt den Status der Modellbewertung dar.

modelLabel
  • string

Stellt die trainierte Modellbezeichnung dar.

trainingConfigVersion
  • string

Stellt die Konfigurationsversion der Schulung dar.

trainingStatus

Stellt den Modellzugstatus dar.

TextAnalysisAuthoringTrainingJobState

Stellt den Zustand eines Schulungsauftrags dar.

Name Type Description
createdDateTime
  • string

Das Erstellungsdatum des Auftrags.

errors

Die fehler beim Ausführen des Auftrags.

expirationDateTime
  • string

Das Ablaufdatum des Auftrags.

jobId
  • string

Die Auftrags-ID.

lastUpdatedDateTime
  • string

Das letzte Datum, an dem der Auftrag aktualisiert wurde.

result

Stellt detailliertes Ergebnis für Schulungsaufgaben dar.

status

Der Auftragsstatus.

warnings

Die Warnungen, die beim Ausführen des Auftrags aufgetreten sind.

TextAnalysisAuthoringWarning

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

Name Type Description
code
  • string

Der Warncode.

message
  • string

Die Warnmeldung.