Text Analysis Authoring - Get Training Status

Ссылка

Служба:: Azure AI Services

Версия API:: 2023-04-01

Возвращает состояние задания обучения.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string url	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Идентификатор задания.
projectName	path	True	string	Имя нового проекта.
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	TextAnalysisAuthoringTrainingJobState	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

SuccessfulGetTrainStatus

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
}

Определения

Имя	Описание
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ на ошибку.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus
TextAnalysisAuthoringSubTrainingJobState	Представляет подробное состояние подработки обучения.
TextAnalysisAuthoringTrainingJobResult	Представляет выходные данные задания обучения.
TextAnalysisAuthoringTrainingJobState	Представляет состояние задания обучения.
TextAnalysisAuthoringWarning	Представляет предупреждение, обнаруженное при выполнении запроса.

Error

Объект ошибки.

Имя	Тип	Описание
code	ErrorCode	Один из определяемых сервером кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
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

Ответ на ошибку.

Имя	Тип	Описание
error	Error	Объект ошибки.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
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

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из определяемых сервером кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

JobStatus

Имя	Тип	Описание
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

TextAnalysisAuthoringSubTrainingJobState

Представляет подробное состояние подработки обучения.

Имя	Тип	Описание
endDateTime	string	Представляет время окончания даты.
percentComplete	integer	Представляет процент хода выполнения.
startDateTime	string	Представляет время начала.
status	JobStatus	Представляет состояние вложенной операции.

TextAnalysisAuthoringTrainingJobResult

Представляет выходные данные задания обучения.

Имя	Тип	Описание
estimatedEndDateTime	string	Представляет время окончания оценки для обучения и оценки.
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	Представляет состояние оценки модели.
modelLabel	string	Представляет обученную метку модели.
trainingConfigVersion	string	Представляет версию конфигурации обучения.
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	Представляет состояние обучения модели.

TextAnalysisAuthoringTrainingJobState

Представляет состояние задания обучения.

Имя	Тип	Описание
createdDateTime	string	Время создания задания.
errors	Error[]	Ошибки, возникшие при выполнении задания.
expirationDateTime	string	Время окончания срока действия задания.
jobId	string	Идентификатор задания.
lastUpdatedDateTime	string	Дата последнего обновления задания.
result	TextAnalysisAuthoringTrainingJobResult	Представляет подробный результат задач обучения.
status	JobStatus	Состояние задания.
warnings	TextAnalysisAuthoringWarning[]	Предупреждения, которые были обнаружены при выполнении задания.

TextAnalysisAuthoringWarning

Представляет предупреждение, обнаруженное при выполнении запроса.

Имя	Тип	Описание
code	string	Код предупреждения.
message	string	Предупреждение.

Поделиться через