Document Models - Analyze Document

Servicio:: Azure AI Services

Versión de la API:: 2024-11-30

Analiza el documento con el modelo de documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30

Con parámetros opcionales:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30&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 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nombre único del modelo de documento.
api-version	query	True	string minLength: 1	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		DocumentContentFormat	Formato del contenido de nivel superior de análisis de resultados.
pages	query		string pattern: ^(\d+(-\d+)?)(,\s(\d+(-\d+)?))$	Números de página basados en 1 que se van a analizar. Ex. "1-3,5,7-9"
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	Tipo	Description
base64Source	string (byte)	Codificación base64 del documento que se va a analizar. Se debe especificar urlSource o base64Source.
urlSource	string (uri)	Dirección URL del documento que se va a analizar. Se debe especificar urlSource o base64Source.

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	DocumentIntelligenceErrorResponse	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

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

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Solicitud de ejemplo

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Respuesta de muestra

status code:: 202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Analyze Document from Url

Solicitud de ejemplo

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

Respuesta de muestra

status code:: 202

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

Definiciones

Nombre	Description
AnalyzeDocumentRequest	Parámetros de análisis de documentos.
AnalyzeOutputOption	Salidas adicionales que se van a generar durante el análisis.
DocumentAnalysisFeature	Características de análisis de documentos que se van a habilitar.
DocumentContentFormat	Formato del contenido en el resultado analizado.
DocumentIntelligenceError	Objeto de error.
DocumentIntelligenceErrorResponse	Objeto de respuesta de error.
DocumentIntelligenceInnerError	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.

AnalyzeDocumentRequest

Objeto

Parámetros de análisis de documentos.

Nombre	Tipo	Description
base64Source	string (byte)	Codificación base64 del documento que se va a analizar. Se debe especificar urlSource o base64Source.
urlSource	string (uri)	Dirección URL del documento que se va a analizar. Se debe especificar urlSource o base64Source.

AnalyzeOutputOption

Enumeración

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

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

DocumentAnalysisFeature

Enumeración

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

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

DocumentContentFormat

Enumeración

Formato del contenido en el resultado analizado.

Valor	Description
text	Representación de texto sin formato del contenido del documento sin formato.
markdown	Representación de Markdown del contenido del documento con encabezados de sección, tablas, etc.

DocumentIntelligenceError

Objeto

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

Objeto de respuesta de error.

Nombre	Tipo	Description
error	DocumentIntelligenceError	Información de error.

DocumentIntelligenceInnerError

Objeto

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.

StringIndexType

Enumeración

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

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