Miscellaneous Operations - List Operations

Servicio:

Azure AI Services

Versión de la API:

2024-11-30

Enumera todas las operaciones.

GET {endpoint}/documentintelligence/operations?api-version=2024-11-30

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string uri	Punto de conexión del servicio De inteligencia de documentos.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	PagedDocumentIntelligenceOperationDetails	La solicitud se ha realizado correctamente. Encabezados x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

Nombre	Description
https://cognitiveservices.azure.com/.default

Ejemplos

Get Operations

Solicitud de ejemplo

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?api-version=2024-11-30

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/documentintelligence/documentModels/myCustomModel",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}

Definiciones

Nombre	Description
AzureBlobContentSource	Contenido de Azure Blob Storage.
AzureBlobFileListContentSource	Lista de archivos en Azure Blob Storage.
ClassifierDocumentTypeDetails	Información del tipo de documento clasificador.
ContentSourceKind	Tipo de origen de contenido.
DocumentAnalysisFeature	Características de análisis de documentos que se van a habilitar.
DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
DocumentClassifierBuildOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentClassifierCopyToOperationDetails	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 de campo.
DocumentIntelligenceError	Objeto de error.
DocumentIntelligenceErrorResponse	Objeto de respuesta de error.
DocumentIntelligenceInnerError	Objeto que contiene información más específica sobre el error.
DocumentIntelligenceOperationStatus	Estado de la operación.
DocumentIntelligenceWarning	Objeto de error.
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.
OperationKind	Tipo de operación.
PagedDocumentIntelligenceOperationDetails	Colección paginada de elementos DocumentIntelligenceOperationDetails
SplitMode	Comportamiento de división de archivos.

AzureBlobContentSource

Contenido de Azure Blob Storage.

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

AzureBlobFileListContentSource

Lista de archivos en Azure Blob Storage.

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

ClassifierDocumentTypeDetails

Información del tipo de documento clasificador.

Nombre	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lista de archivos de Azure Blob Storage que especifica los datos de entrenamiento para un tipo de documento clasificador. Se debe especificar azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Ubicación de Azure Blob Storage que contiene los datos de entrenamiento de un tipo de documento clasificador. Se debe especificar azureBlobSource o azureBlobFileListSource.
sourceKind	ContentSourceKind	Tipo de origen de datos de entrenamiento.

ContentSourceKind

Tipo de origen de contenido.

Nombre	Tipo	Description
azureBlob	string	Archivos en una ruta de acceso dentro de un contenedor de Azure Blob Storage.
azureBlobFileList	string	Una lista de archivos que especifica archivos individuales en un contenedor de Azure Blob Storage.
base64	string	Contenido representado a través de la codificación Base64.
url	string	Contenido en una dirección URL específica.

DocumentAnalysisFeature

Características de análisis de documentos que se van a habilitar.

Nombre	Tipo	Description
barcodes	string	Habilite la detección de códigos de barras en el documento.
formulas	string	Habilite la detección de expresiones matemáticas en el documento.
keyValuePairs	string	Habilite la detección de pares de valores de clave general (campos de formulario) en el documento.
languages	string	Habilite la detección del idioma de contenido de texto.
ocrHighResolution	string	Realice OCR en una resolución más alta para controlar documentos con impresión fina.
queryFields	string	Habilite la extracción de campos adicionales a través del parámetro de consulta QueryFields.
styleFont	string	Habilite el reconocimiento de varios estilos de fuente.

DocumentBuildMode

Modo de compilación del modelo de documento personalizado.

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

DocumentClassifierBuildOperationDetails

Obtiene el objeto de respuesta Operation.

Nombre	Tipo	Description
apiVersion	string	Versión de API que se usa para crear esta operación.
createdDateTime	string	Fecha y hora (UTC) cuando se creó la operación.
error	DocumentIntelligenceError	Error encontrado.
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 destinado a esta operación.
result	DocumentClassifierDetails	Resultado de la operación tras la operación correcta.
status	DocumentIntelligenceOperationStatus	Estado de la operación. notStarted, running, completed o failed
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentClassifierCopyToOperationDetails

Obtiene el objeto de respuesta Operation.

Nombre	Tipo	Description
apiVersion	string	Versión de API que se usa para crear esta operación.
createdDateTime	string	Fecha y hora (UTC) cuando se creó la operación.
error	DocumentIntelligenceError	Error encontrado.
kind	string: documentClassifierCopyTo	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 destinado a esta operación.
result	DocumentClassifierDetails	Resultado de la operación tras la operación correcta.
status	DocumentIntelligenceOperationStatus	Estado de la operación. notStarted, running, completed o failed
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 que se usa para crear este clasificador de documentos.
baseClassifierId	string	ClassifierId base sobre el que se entrenó el clasificador.
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 en los que se va a clasificar.
expirationDateTime	string	Fecha y hora (UTC) cuando expire el clasificador de documentos.
modifiedDateTime	string	Fecha y hora (UTC) cuando se modificó por última vez el modelo de documento.
warnings	DocumentIntelligenceWarning[]	Lista de advertencias detectadas al compilar el clasificador.

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 de campo.

DocumentFieldType

Tipo de datos semántico del valor de 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 con el formato ISO 3166-1 alfa-3 (por ejemplo, EE. UU.).
currency	string	Importe de moneda con símbolo de moneda opcional y unidad.
date	string	Fecha, normalizada con formato ISO 8601 (AAAA-MM-DD).
integer	string	Número entero, normalizado a entero de 64 bits con signo.
number	string	Número de punto flotante, normalizado a punto flotante de precisión doble.
object	string	Lista con nombre de subcampos de tipos potencialmente diferentes.
phoneNumber	string	Número de teléfono, normalizado en formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matriz de valores de cadena seleccionados.
selectionMark	string	¿Está seleccionado el campo?
signature	string	¿Está presente la firma?
string	string	Texto sin formato.
time	string	Hora, normalizada a formato ISO 8601 (hh:mm:ss).

DocumentIntelligenceError

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	DocumentIntelligenceError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	DocumentIntelligenceError	Información de error.

DocumentIntelligenceInnerError

Objeto que contiene información más específica sobre el error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	DocumentIntelligenceInnerError	Error interno.
message	string	Representación legible del error.

DocumentIntelligenceOperationStatus

Estado de la operación.

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

DocumentIntelligenceWarning

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de advertencia.
message	string	Representación legible de la advertencia.
target	string	Destino del error.

DocumentModelBuildOperationDetails

Obtiene el objeto de respuesta Operation.

Nombre	Tipo	Description
apiVersion	string	Versión de API que se usa para crear esta operación.
createdDateTime	string	Fecha y hora (UTC) cuando se creó la operación.
error	DocumentIntelligenceError	Error encontrado.
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 destinado a esta operación.
result	DocumentModelDetails	Resultado de la operación tras la operación correcta.
status	DocumentIntelligenceOperationStatus	Estado de la operación. notStarted, running, completed o failed
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 que se usa para crear esta operación.
createdDateTime	string	Fecha y hora (UTC) cuando se creó la operación.
error	DocumentIntelligenceError	Error encontrado.
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 destinado a esta operación.
result	DocumentModelDetails	Resultado de la operación tras la operación correcta.
status	DocumentIntelligenceOperationStatus	Estado de la operación. notStarted, running, completed o failed
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 que se usa para crear esta operación.
createdDateTime	string	Fecha y hora (UTC) cuando se creó la operación.
error	DocumentIntelligenceError	Error encontrado.
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 destinado a esta operación.
result	DocumentModelDetails	Resultado de la operación tras la operación correcta.
status	DocumentIntelligenceOperationStatus	Estado de la operación. notStarted, running, completed o failed
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentModelDetails

Información del modelo de documento.

Nombre	Tipo	Valor predeterminado	Description
apiVersion	string		Versión de API que se usa para crear este modelo de documento.
azureBlobFileListSource	AzureBlobFileListContentSource		Lista de archivos de Azure Blob Storage que especifica los datos de entrenamiento. Se debe especificar azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Ubicación de Azure Blob Storage que contiene los datos de entrenamiento. Se debe especificar azureBlobSource o azureBlobFileListSource.
buildMode	DocumentBuildMode		Modo de compilación del modelo de documento personalizado.
classifierId	string		Para los modelos compuestos, el clasificador personalizado para dividir y clasificar el archivo de entrada.
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 documento admitidos.
expirationDateTime	string		Fecha y hora (UTC) cuando expire el modelo de documento.
modelId	string		Nombre único del modelo de documento.
modifiedDateTime	string		Fecha y hora (UTC) cuando se modificó por última vez el modelo de documento.
split	SplitMode	none	Para los modelos compuestos, el comportamiento de división de archivos.
tags	object		Lista de atributos de etiqueta clave-valor asociados al modelo de documento.
trainingHours	number		Número de horas de GPU equivalentes de V100 consumidas para el entrenamiento del modelo.
warnings	DocumentIntelligenceWarning[]		Lista de advertencias encontradas al compilar el modelo.

DocumentTypeDetails

Información de tipo de documento.

Nombre	Tipo	Description
buildMode	DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
confidenceThreshold	number	Realice un análisis solo si la confianza de docType está por encima del umbral.
description	string	Descripción del modelo de documento.
features	DocumentAnalysisFeature[]	Lista de características de análisis opcionales.
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.
maxDocumentsToAnalyze	integer	Número máximo de documentos del tipo especificado que se va a analizar. Default=all.
modelId	string	Modelo de documento que se va a usar para analizar documentos con el tipo especificado.
queryFields	string[]	Lista de campos adicionales que se van a extraer. Ex. "NumberOfGuests,StoreNumber"

OperationKind

Tipo de operación.

Nombre	Tipo	Description
documentClassifierBuild	string	Cree un nuevo modelo de clasificador personalizado.
documentClassifierCopyTo	string	Copie un clasificador de documentos existente en un recurso, región o suscripción diferente.
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.

PagedDocumentIntelligenceOperationDetails

Colección paginada de elementos DocumentIntelligenceOperationDetails

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de elementos
value	DocumentIntelligenceOperationDetails[]: DocumentClassifierBuildOperationDetails[] DocumentClassifierCopyToOperationDetails[] DocumentModelBuildOperationDetails[] DocumentModelComposeOperationDetails[] DocumentModelCopyToOperationDetails[]	Elementos DocumentIntelligenceOperationDetails de esta página

SplitMode

Comportamiento de división de archivos.

Nombre	Tipo	Description
auto	string	Dividir automáticamente el archivo en documentos.
none	string	Trate todo el archivo como un único documento.
perPage	string	Trate cada página del archivo como un documento independiente.