Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

Analiza el documento con el modelo de documento.

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2023-07-31

With optional parameters:

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2023-07-31&features={features}

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).
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 solicitada.
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").
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+)?))*$
stringIndexType	query		StringIndexType	Método utilizado para calcular el desplazamiento y la longitud de la cadena.

Encabezado de la solicitud

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Clave secreta de la suscripción de Azure Cognitive Services.

Cuerpo de la solicitud

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Nombre	Tipo	Description
base64Source	string	Codificación base64 del documento que se va a analizar. Se debe especificar urlSource o base64Source.
urlSource	string	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 pone en cola correctamente. Headers Operation-Location: string
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

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

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

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Definiciones

Nombre	Description
AnalyzeDocumentRequest	Parámetros de análisis de documentos.
DocumentAnalysisFeature	Lista de características de análisis opcionales.
Error	Información de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Error detallado.
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. Se debe especificar urlSource o base64Source.
urlSource	string	Dirección URL del documento que se va a analizar. Se debe especificar urlSource o base64Source.

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 clave-valor generales (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.
styleFont	string	Habilite el reconocimiento de varios estilos de fuente.

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.

StringIndexType

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

Nombre	Tipo	Description
textElements	string	Carácter de presentació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. Usado por Python 3.
utf16CodeUnit	string	Unidad de caracteres representada por una unidad de código Unicode de 16 bits. Usado por JavaScript, Java y .NET.