Miscellaneous - List Operations

Servicio:

Azure AI Services

Versión de la API:

2023-07-31

Listas todas las operaciones.

GET {endpoint}/formrecognizer/operations?api-version=2023-07-31

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Versión de API solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Clave secreta de la suscripción de Azure Cognitive Services.

Respuestas

Nombre	Tipo	Description
200 OK	GetOperationsResponse	Aceptar.
Other Status Codes	ErrorResponse	Error encontrado.

Seguridad

Ocp-Apim-Subscription-Key

Clave secreta de la suscripción de Azure Cognitive Services.

Tipo: apiKey
En: header

Ejemplos

Get Operations

Solicitud de ejemplo

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?api-version=2023-07-31

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
      "apiVersion": "2023-07-31"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData"
}

Definiciones

Nombre	Description
Error	Información de error.
ErrorResponse	Objeto de respuesta de error.
GetOperationsResponse	Objeto de respuesta List Operations.
InnerError	Error detallado.
OperationKind	Tipo de operación.
OperationStatus	Estado de la operación.
OperationSummary	Información de la operación.

Error

Información de error.

Nombre	Tipo	Description
code	string	Código de error.
details	Error[]	Lista de errores detallados.
innererror	InnerError	Error detallado.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error.

GetOperationsResponse

Objeto de respuesta List Operations.

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de operaciones.
value	OperationSummary[]	Lista de operaciones.

InnerError

Error detallado.

Nombre	Tipo	Description
code	string	Código de error.
innererror	InnerError	Error detallado.
message	string	Mensaje de error.

OperationKind

Tipo de operación.

Nombre	Tipo	Description
documentClassifierBuild	string	Cree un nuevo modelo de clasificador personalizado.
documentModelBuild	string	Cree un nuevo modelo de documento personalizado.
documentModelCompose	string	Cree un nuevo modelo de documento personalizado a partir de modelos existentes.
documentModelCopyTo	string	Copie un modelo de documento existente en un recurso, región o suscripción diferente.

OperationStatus

Estado de la operación.

Nombre	Tipo	Description
canceled	string	Se ha cancelado la operación.
failed	string	Se produjeron errores en la operación.
notStarted	string	La operación aún no se ha iniciado.
running	string	La operación está en curso.
succeeded	string	La operación se ha realizado correctamente.

OperationSummary

Información de la operación.

Nombre	Tipo	Description
apiVersion	string	Versión de API usada para crear esta operación.
createdDateTime	string	Fecha y hora (UTC) cuando se creó la operación.
kind	OperationKind	Tipo de operación.
lastUpdatedDateTime	string	Fecha y hora (UTC) cuando se actualizó por última vez el estado.
operationId	string	Id. de operación
percentCompleted	integer	Progreso de la operación (0-100).
resourceLocation	string	Dirección URL del recurso de destino de esta operación.
status	OperationStatus	Estado de la operación.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.