Text Analysis Authoring - Get Training Status

Servicio:

Azure AI Services

Versión de la API:

2022-05-01

Obtiene el estado de un trabajo de entrenamiento.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Identificador del trabajo.
projectName	path	True	string maxLength: 100	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de la API de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Una clave de suscripción para un recurso de servicio de lenguaje.

Respuestas

Nombre	Tipo	Description
200 OK	TextAnalysisAuthoringTrainingJobState	Resultado del trabajo de entrenamiento.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Tipo: apiKey
En: header

Ejemplos

Successful Get Train Status

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible para personas.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Estado del trabajo.
TextAnalysisAuthoringSubTrainingJobState	Representa el estado detallado de una suboperaciones de entrenamiento.
TextAnalysisAuthoringTrainingJobResult	Representa la salida de un trabajo de entrenamiento.
TextAnalysisAuthoringTrainingJobState	Representa el estado de un trabajo de entrenamiento.
TextAnalysisAuthoringWarning	Representa una advertencia que se encontró al ejecutar la solicitud.

Error

Object

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

JobStatus

Enumeración

Estado del trabajo.

Valor	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringSubTrainingJobState

Object

Representa el estado detallado de una suboperaciones de entrenamiento.

Nombre	Tipo	Description
endDateTime	string (date-time)	Representa la fecha y hora de finalización.
percentComplete	integer (int32)	Representa el porcentaje de progreso.
startDateTime	string (date-time)	Representa la fecha y hora de inicio.
status	JobStatus	Representa el estado de la suboperaciones.

TextAnalysisAuthoringTrainingJobResult

Object

Representa la salida de un trabajo de entrenamiento.

Nombre	Tipo	Description
estimatedEndDateTime	string (date-time)	Representa la fecha y hora de finalización de la estimación para el entrenamiento y la evaluación.
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	Representa el estado de evaluación del modelo.
modelLabel	string	Representa la etiqueta del modelo entrenado.
trainingConfigVersion	string	Representa la versión de configuración de entrenamiento.
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	Representa el estado del entrenamiento del modelo.

TextAnalysisAuthoringTrainingJobState

Object

Representa el estado de un trabajo de entrenamiento.

Nombre	Tipo	Description
createdDateTime	string (date-time)	Fecha de creación de la hora del trabajo.
errors	Error[]	Errores detectados al ejecutar el trabajo.
expirationDateTime	string (date-time)	Fecha de expiración del trabajo.
jobId	string	Identificador del trabajo.
lastUpdatedDateTime	string (date-time)	La última fecha en que se actualizó el trabajo.
result	TextAnalysisAuthoringTrainingJobResult	Representa el resultado detallado de las tareas de entrenamiento.
status	JobStatus	Estado del trabajo.
warnings	TextAnalysisAuthoringWarning[]	Advertencias que se encontraron al ejecutar el trabajo.

TextAnalysisAuthoringWarning

Object

Representa una advertencia que se encontró al ejecutar la solicitud.

Nombre	Tipo	Description
code	string	El código de advertencia.
message	string	Mensaje de advertencia.