Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Analiza el documento con el modelo de documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Punto de conexión del servicio Document Intelligence.
modelId	path	True	string	Nombre único del modelo de documento. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Versión de API que se usará para la 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").
outputContentFormat	query		ContentFormat	Formato del contenido de análisis de nivel superior del resultado.
pages	query		string	Lista de números de página basados en 1 que se van a analizar. Por ejemplo, "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lista de campos adicionales que se van a extraer. Por ejemplo, "NumberOfGuests, StoreNumber"
stringIndexType	query		StringIndexType	Método utilizado para calcular el desplazamiento y la longitud de la cadena.

Cuerpo de la solicitud

Nombre	Tipo	Description
base64Source	string	Codificación base64 del documento que se va a analizar. Debe especificarse urlSource o base64Source.
urlSource	string	Dirección URL del documento que se va a analizar. Debe especificarse 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. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Ejemplos

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

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

Analyze Document from Url

Sample Request

HTTP

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

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

Sample Response

Status code:

202

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

Definiciones

Nombre	Description
AnalyzeDocumentRequest	Parámetros de análisis de documentos.
ContentFormat	Formato del contenido en el resultado analizado.
DocumentAnalysisFeature	Lista de características de análisis opcionales.
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 utilizado para calcular el desplazamiento y la longitud de la cadena.

AnalyzeDocumentRequest

Parámetros de análisis de documentos.

Nombre	Tipo	Description
base64Source	string	Codificación base64 del documento que se va a analizar. Debe especificarse urlSource o base64Source.
urlSource	string	Dirección URL del documento que se va a analizar. Debe especificarse urlSource o base64Source.

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, etc.
text	string	Representación de texto sin formato del contenido del documento sin formato.

DocumentAnalysisFeature

Lista de características de análisis opcionales.

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 valor 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 utilizado 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 y como se define en Unicode 8.0.0.
unicodeCodePoint	string	Unidad de caracteres representada por un único punto de código unicode. Se usa en 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.