Text Analysis Authoring - Get Training Status

Pobiera stan zadania szkoleniowego.

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

Parametry identyfikatora URI

Name In Required Type Description
Endpoint
path True
  • string

Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).

jobId
path True
  • string

Identyfikator zadania.

projectName
path True
  • string

Nazwa projektu do użycia.

api-version
query True
  • string

Wersja interfejsu API klienta.

Nagłówek żądania

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

Klucz subskrypcji zasobu usługi językowej.

Odpowiedzi

Name Type Description
200 OK

Wynik zadania szkoleniowego.

Other Status Codes

Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Type: apiKey
In: header

Przykłady

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

Definicje

Error

Obiekt błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

ErrorResponse

Odpowiedź na błąd.

InnerErrorCode

Kod błędu czytelny dla człowieka.

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

JobStatus

Stan zadania.

TextAnalysisAuthoringSubTrainingJobState

Reprezentuje szczegółowy stan podrzędnej operacji trenowania.

TextAnalysisAuthoringTrainingJobResult

Reprezentuje dane wyjściowe zadania szkoleniowego.

TextAnalysisAuthoringTrainingJobState

Reprezentuje stan zadania szkoleniowego.

TextAnalysisAuthoringWarning

Reprezentuje ostrzeżenie, które zostało napotkane podczas wykonywania żądania.

Error

Obiekt błędu.

Name Type Description
code

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

details

Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.

innererror

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

message
  • string

Czytelna dla człowieka reprezentacja błędu.

target
  • string

Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

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

Odpowiedź na błąd.

Name Type Description
error

Obiekt błędu.

InnerErrorCode

Kod błędu czytelny dla człowieka.

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

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

details
  • object

Szczegóły błędu.

innererror

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

message
  • string

Komunikat o błędzie.

target
  • string

Błąd docelowy.

JobStatus

Stan zadania.

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

TextAnalysisAuthoringSubTrainingJobState

Reprezentuje szczegółowy stan podrzędnej operacji trenowania.

Name Type Description
endDateTime
  • string

Reprezentuje godzinę zakończenia.

percentComplete
  • integer

Reprezentuje procent postępu.

startDateTime
  • string

Reprezentuje datę rozpoczęcia o godzinie.

status

Reprezentuje stan podrzędnej operacji.

TextAnalysisAuthoringTrainingJobResult

Reprezentuje dane wyjściowe zadania szkoleniowego.

Name Type Description
estimatedEndDateTime
  • string

Reprezentuje szacowaną datę zakończenia trenowania i oceny.

evaluationStatus

Reprezentuje stan oceny modelu.

modelLabel
  • string

Reprezentuje wyszkoloną etykietę modelu.

trainingConfigVersion
  • string

Reprezentuje wersję konfiguracji trenowania.

trainingStatus

Reprezentuje stan trenowania modelu.

TextAnalysisAuthoringTrainingJobState

Reprezentuje stan zadania szkoleniowego.

Name Type Description
createdDateTime
  • string

Data utworzenia zadania.

errors

Błędy napotkane podczas wykonywania zadania.

expirationDateTime
  • string

Data wygaśnięcia zadania.

jobId
  • string

Identyfikator zadania.

lastUpdatedDateTime
  • string

Data ostatniej aktualizacji zadania.

result

Reprezentuje szczegółowy wynik zadań szkoleniowych.

status

Stan zadania.

warnings

Ostrzeżenia, które zostały napotkane podczas wykonywania zadania.

TextAnalysisAuthoringWarning

Reprezentuje ostrzeżenie, które zostało napotkane podczas wykonywania żądania.

Name Type Description
code
  • string

Kod ostrzegawczy.

message
  • string

Komunikat ostrzegawczy.