Document Models - Analyze Batch Documents

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-07-31-preview

Analiza documentos por lotes con el modelo de documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-07-31-preview

Con parámetros opcionales:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-07-31-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

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.
modelId	path	True	string	Nombre único del modelo de documento. Patrón de Regex: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
features	query		DocumentAnalysisFeature[]	Lista de características de análisis opcionales.
locale	query		string	Sugerencia de configuración regional para el reconocimiento de texto y el análisis de documentos. El valor solo puede contener el código de idioma (por ejemplo, "en", "fr") o la etiqueta de idioma BCP 47 (por ejemplo, "en-US").
output	query		AnalyzeOutputOption[]	Salidas adicionales que se van a generar durante el análisis.
outputContentFormat	query		ContentFormat	Formato del contenido de nivel superior de análisis de resultados.
pages	query		string	Lista de números de página basados en 1 que se van a analizar. Ex. "1-3,5,7-9" Patrón de Regex: `^(\d+(-\d+)?)(,\s(\d+(-\d+)?))$`
queryFields	query		string[]	Lista de campos adicionales que se van a extraer. Ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Método usado para calcular el desplazamiento y la longitud de la cadena.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
resultContainerUrl	True	string	Dirección URL del contenedor de Azure Blob Storage donde se almacenarán los archivos de resultados de análisis.
azureBlobFileListSource		AzureBlobFileListContentSource	Lista de archivos de Azure Blob Storage que especifica los documentos por lotes. Se debe especificar azureBlobSource o azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Ubicación de Azure Blob Storage que contiene los documentos por lotes. Se debe especificar azureBlobSource o azureBlobFileListSource.
overwriteExisting		boolean	¿Sobrescribir los archivos de resultados de análisis existentes?
resultPrefix		string	Prefijo de nombre de blob de los archivos de resultados.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

202 Accepted

La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Encabezados

Operation-Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

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

Analyze Batch Documents

Solicitud de ejemplo

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyzeBatch?api-version=2024-07-31-preview&pages=1-5&locale=en-US&stringIndexType=textElements

{
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "resultContainerUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer?mySasToken",
  "resultPrefix": "trainingDocsResult/",
  "overwriteExisting": true
}

Respuesta de muestra

status code:: 202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeBatchResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Definiciones

Nombre	Description
AnalyzeBatchDocumentsRequest	Parámetros de análisis de documentos por lotes.
AnalyzeOutputOption	Salidas adicionales que se van a generar durante el análisis.
AzureBlobContentSource	Contenido de Azure Blob Storage.
AzureBlobFileListContentSource	Lista de archivos en Azure Blob Storage.
ContentFormat	Formato del contenido en el resultado analizado.
DocumentAnalysisFeature	Características de análisis de documentos que se van a habilitar.
Error	Objeto de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Objeto que contiene información más específica sobre el error.
StringIndexType	Método usado para calcular el desplazamiento y la longitud de la cadena.

AnalyzeBatchDocumentsRequest

Parámetros de análisis de documentos por lotes.

Nombre	Tipo	Valor predeterminado	Description
azureBlobFileListSource	AzureBlobFileListContentSource		Lista de archivos de Azure Blob Storage que especifica los documentos por lotes. Se debe especificar azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Ubicación de Azure Blob Storage que contiene los documentos por lotes. Se debe especificar azureBlobSource o azureBlobFileListSource.
overwriteExisting	boolean	False	¿Sobrescribir los archivos de resultados de análisis existentes?
resultContainerUrl	string		Dirección URL del contenedor de Azure Blob Storage donde se almacenarán los archivos de resultados de análisis.
resultPrefix	string		Prefijo de nombre de blob de los archivos de resultados.

AnalyzeOutputOption

Salidas adicionales que se van a generar durante el análisis.

Nombre	Tipo	Description
figures	string	Genere imágenes recortadas de figuras detectadas.
pdf	string	Generar una salida PDF en la que se puede buscar.

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.

ContentFormat

Formato del contenido en el resultado analizado.

Nombre	Tipo	Description
markdown	string	Representación de Markdown del contenido del documento con encabezados de sección, tablas etcetera.
text	string	Representación de texto sin formato del contenido del documento sin formato.

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.

Error

Objeto de error.

Nombre	Tipo	Description
code	string	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	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.

ErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error.

InnerError

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	InnerError	Error interno.
message	string	Representación legible del error.

StringIndexType

Método usado para calcular el desplazamiento y la longitud de la cadena.

Nombre	Tipo	Description
textElements	string	Carácter de visualización percibido por el usuario o clúster de grafos, tal como se define en Unicode 8.0.0.
unicodeCodePoint	string	Unidad de caracteres representada por un único punto de código unicode. Usado por Python 3.
utf16CodeUnit	string	Unidad de caracteres representada por una unidad de código Unicode de 16 bits. Se usa en JavaScript, Java y .NET.

Compartir a través de

Document Models - Analyze Batch Documents

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Analyze Batch Documents

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AnalyzeBatchDocumentsRequest

AnalyzeOutputOption

AzureBlobContentSource

AzureBlobFileListContentSource

ContentFormat

DocumentAnalysisFeature

Error

ErrorResponse

InnerError

StringIndexType

Recursos adicionales