Analyzer - Analyze Id Document

Servicio:
Azure AI Services
Versión de la API:
2.1

Extraiga el texto de campo y los valores semánticos de un documento de identificador determinado. El documento de entrada debe ser de uno de los tipos de contenido admitidos: "application/pdf", "image/jpeg", "image/png", "image/tiff" o "image/bmp". Como alternativa, use el tipo "application/json" para especificar la ubicación (URI) del documento que se va a analizar.

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze
Con parámetros opcionales: 
POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze?includeTextDetails={includeTextDetails}&pages={pages}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus2.api.cognitive.microsoft.com).
includeTextDetails
 query

boolean

Incluya líneas de texto y referencias de elementos en el resultado.
pages
 query

string[]

Números de página personalizados para documentos de varias páginas (PDF/TIFF), escriba el número de páginas que desea obtener el resultado de OCR. Para un intervalo de páginas, use un guión. Separe cada página o intervalo con una coma.

Encabezado de la solicitud

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Nombre Requerido Tipo Description
Ocp-Apim-Subscription-Key True

string

Cuerpo de la solicitud

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Nombre Tipo Description
source

string

minLength: 0
maxLength: 2048

Ruta de acceso de origen del archivo.

Respuestas

Nombre Tipo Description
202 Accepted

La solicitud se pone en cola correctamente.

Encabezados

Operation-Location: string
Other Status Codes

ErrorResponse

Entidad de respuesta que acompaña a respuestas no correctas que contienen detalles adicionales sobre el error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Analyze ID

Solicitud de ejemplo

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze

Respuesta de muestra

status code:
202 
Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definiciones

Nombre Description
ErrorInformation
ErrorResponse
SourcePath

Uri o ruta de acceso local a los datos de origen.

ErrorInformation

Objeto
Nombre Tipo Description
code

string

message

string

ErrorResponse

Objeto
Nombre Tipo Description
error

ErrorInformation

SourcePath

Objeto

Uri o ruta de acceso local a los datos de origen.

Nombre Tipo Description
source

string

minLength: 0
maxLength: 2048

Ruta de acceso de origen del archivo.