Text Analysis Authoring - Get Training Status
Obtiene el estado de un trabajo de entrenamiento.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2023-04-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). |
job
|
path | True |
string |
Identificador del trabajo. |
project
|
path | True |
string |
Nombre del proyecto que se va a usar. |
api-version
|
query | True |
string |
Versión de API del cliente. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Resultado del trabajo de entrenamiento. |
|
Other Status Codes |
Respuesta de error. |
Seguridad
AADToken
Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.
Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Notas
- Esta definición de seguridad requiere el uso del
x-ms-client-id
encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.
Authorization URL
es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory.
* El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
* El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Actualmente, Azure Active Directory v1.0 o v2.0 admite Cuentas profesionales, educativas e invitados, pero no admite cuentas personales.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Una clave de suscripción para un recurso de servicio de lenguaje.
Type:
apiKey
In:
header
Ejemplos
Successful Get Train Status
Sample Request
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-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"
}
Definiciones
Nombre | Description |
---|---|
Error |
Objeto de error. |
Error |
Código de error legible. |
Error |
Respuesta de error. |
Inner |
Código de error legible. |
Inner |
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. |
Job |
Estado del trabajo. |
Text |
Representa el estado detallado de una suboperaciones de entrenamiento. |
Text |
Representa la salida de un trabajo de entrenamiento. |
Text |
Representa el estado de un trabajo de entrenamiento. |
Text |
Representa una advertencia que se encontró al ejecutar la solicitud. |
Error
Objeto de error.
Nombre | Tipo | Description |
---|---|---|
code |
Uno de los conjuntos de códigos de error definidos por el servidor. |
|
details |
Error[] |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
innererror |
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
Código de error legible.
Nombre | Tipo | 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
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
InnerErrorCode
Código de error legible.
Nombre | Tipo | 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
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 |
Uno de los conjuntos de códigos de error definidos por el servidor. |
|
details |
object |
Detalles del error. |
innererror |
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
Estado del trabajo.
Nombre | Tipo | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringSubTrainingJobState
Representa el estado detallado de una suboperaciones de entrenamiento.
Nombre | Tipo | Description |
---|---|---|
endDateTime |
string |
Representa la fecha y hora de finalización. |
percentComplete |
integer |
Representa el porcentaje de progreso. |
startDateTime |
string |
Representa la fecha y hora de inicio. |
status |
Representa el estado de la suboperaciones. |
TextAnalysisAuthoringTrainingJobResult
Representa la salida de un trabajo de entrenamiento.
Nombre | Tipo | Description |
---|---|---|
estimatedEndDateTime |
string |
Representa la fecha y hora de finalización de la estimación para el entrenamiento y la evaluación. |
evaluationStatus |
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 |
Representa el estado de entrenamiento del modelo. |
TextAnalysisAuthoringTrainingJobState
Representa el estado de un trabajo de entrenamiento.
Nombre | Tipo | Description |
---|---|---|
createdDateTime |
string |
Fecha de creación del trabajo. |
errors |
Error[] |
Errores detectados al ejecutar el trabajo. |
expirationDateTime |
string |
Fecha de expiración del trabajo. |
jobId |
string |
Identificador del trabajo. |
lastUpdatedDateTime |
string |
La última fecha en que se actualizó el trabajo. |
result |
Representa el resultado detallado de las tareas de entrenamiento. |
|
status |
Estado del trabajo. |
|
warnings |
Advertencias que se encontraron al ejecutar el trabajo. |
TextAnalysisAuthoringWarning
Representa una advertencia que se encontró al ejecutar la solicitud.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de advertencia. |
message |
string |
El mensaje de advertencia. |