Miscellaneous - Get Operation

Service:

Azure AI Services

API Version:

2023-07-31

Obtiene la información de la operación.

GET {endpoint}/formrecognizer/operations/{operationId}?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).
operationId	path	True	string uuid	Identificador de operación único. Regex pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
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	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails DocumentClassifierBuildOperationDetails	Aceptar.
Other Status Codes	ErrorResponse	Error encontrado.

Seguridad

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

Ejemplos

Get Operation

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Sample Response

Status code:

200

{
  "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2023-07-31"
  }
}

Definiciones

Nombre	Description
AzureBlobContentSource	Azure Blob Storage contenido.
AzureBlobFileListContentSource	Lista de archivos en Azure Blob Storage.
ClassifierDocumentTypeDetails	Información del tipo de documento clasificador.
DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
DocumentClassifierBuildOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentClassifierDetails	Información del clasificador de documentos.
DocumentFieldSchema	Descripción del esquema semántico de campo mediante una sintaxis de estilo de esquema JSON.
DocumentFieldType	Tipo de datos semántico del valor del campo.
DocumentModelBuildOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentModelComposeOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentModelCopyToOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentModelDetails	Información del modelo de documento.
DocumentTypeDetails	Información de tipo de documento.
Error	Información de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Error detallado.
OperationStatus	Estado de la operación.

AzureBlobContentSource

Azure Blob Storage contenido.

Nombre	Tipo	Description
containerUrl	string	Azure Blob Storage dirección URL del contenedor.
prefix	string	Prefijo de nombre de blob.

AzureBlobFileListContentSource

Lista de archivos en Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string	Azure Blob Storage dirección URL del contenedor.
fileList	string	Ruta de acceso a un archivo JSONL dentro del contenedor que especifica un subconjunto de documentos para el entrenamiento.

ClassifierDocumentTypeDetails

Información del tipo de documento clasificador.

Nombre	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage lista de archivos que especifican los datos de entrenamiento para un tipo de documento clasificador. Debe especificarse azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage ubicación que contiene los datos de entrenamiento para un tipo de documento clasificador. Debe especificarse azureBlobSource o azureBlobFileListSource.

DocumentBuildMode

Modo de compilación del modelo de documento personalizado.

Nombre	Tipo	Description
neural	string	Compatibilidad con documentos con diversas plantillas visuales.
template	string	Destinos de documentos con plantillas visuales similares.

DocumentClassifierBuildOperationDetails

Obtiene el objeto de respuesta Operation.

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.
error	Error	Se encontró un error.
kind	string: documentClassifierBuild	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.
result	DocumentClassifierDetails	Resultado de la operación cuando se ha realizado correctamente.
status	OperationStatus	Estado de la operación.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentClassifierDetails

Información del clasificador de documentos.

Nombre	Tipo	Description
apiVersion	string	Versión de API usada para crear este clasificador de documentos.
classifierId	string	Nombre único del clasificador de documentos.
createdDateTime	string	Fecha y hora (UTC) cuando se creó el clasificador de documentos.
description	string	Descripción del clasificador de documentos.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documento con los que clasificar.
expirationDateTime	string	Fecha y hora (UTC) cuando expire el clasificador de documentos.

DocumentFieldSchema

Descripción del esquema semántico de campo mediante una sintaxis de estilo de esquema JSON.

Nombre	Tipo	Description
description	string	Descripción del campo.
example	string	Contenido de campo de ejemplo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento de matriz.
properties	<string,  DocumentFieldSchema>	Subcampos con nombre del campo de objeto.
type	DocumentFieldType	Tipo de datos semántico del valor del campo.

DocumentFieldType

Tipo de datos semántico del valor del campo.

Nombre	Tipo	Description
address	string	Dirección analizada.
array	string	Lista de subcampos del mismo tipo.
boolean	string	Valor booleano, normalizado en true o false.
countryRegion	string	País o región, normalizado al formato ALFA-3166-1 ISO 3 (por ejemplo, EE. UU.).
currency	string	Importe de moneda con símbolo de moneda opcional y unidad.
date	string	Fecha, normalizada en formato ISO 8601 (AAAA-MM-DD).
integer	string	Número entero, normalizado en entero de 64 bits con signo.
number	string	Número de punto flotante, normalizado a punto flotante de doble precisión.
object	string	Lista con nombre de subcampos de tipos potencialmente diferentes.
phoneNumber	string	Número de teléfono, normalizado a formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionMark	string	¿Está seleccionado el campo?
signature	string	¿Está presente la firma?
string	string	Texto sin formato.
time	string	Tiempo, normalizado al formato ISO 8601 (hh:mm:ss).

DocumentModelBuildOperationDetails

Obtiene el objeto de respuesta Operation.

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.
error	Error	Se encontró un error.
kind	string: documentModelBuild	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.
result	DocumentModelDetails	Resultado de la operación cuando se ha realizado correctamente.
status	OperationStatus	Estado de la operación.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentModelComposeOperationDetails

Obtiene el objeto de respuesta Operation.

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.
error	Error	Se encontró un error.
kind	string: documentModelCompose	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.
result	DocumentModelDetails	Resultado de la operación cuando se ha realizado correctamente.
status	OperationStatus	Estado de la operación.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentModelCopyToOperationDetails

Obtiene el objeto de respuesta Operation.

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.
error	Error	Se encontró un error.
kind	string: documentModelCopyTo	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.
result	DocumentModelDetails	Resultado de la operación cuando se ha realizado correctamente.
status	OperationStatus	Estado de la operación.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentModelDetails

Información del modelo de documento.

Nombre	Tipo	Description
apiVersion	string	Versión de API usada para crear este modelo de documento.
createdDateTime	string	Fecha y hora (UTC) cuando se creó el modelo de documento.
description	string	Descripción del modelo de documento.
docTypes	<string,  DocumentTypeDetails>	Tipos de documentos admitidos.
expirationDateTime	string	Fecha y hora (UTC) cuando expire el modelo de documento.
modelId	string	Nombre único del modelo de documento.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentTypeDetails

Información de tipo de documento.

Nombre	Tipo	Description
buildMode	DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
description	string	Descripción del modelo de documento.
fieldConfidence	object	Confianza estimada para cada campo.
fieldSchema	<string,  DocumentFieldSchema>	Descripción del esquema semántico del documento mediante una sintaxis de estilo de esquema JSON.

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.

InnerError

Error detallado.

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

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.