Read - Read

Servicio:

Azure AI Services

Versión de la API:

3.2-preview.2

Use esta interfaz para obtener el resultado de una operación de lectura, utilizando los algoritmos de reconocimiento óptico de caracteres (OCR) de última generación optimizados para documentos pesados de texto. Cuando se usa la interfaz Read, la respuesta contiene un campo denominado "Operation-Location". El campo "Operation-Location" contiene la dirección URL que debe usar para la operación "GetReadResult" para acceder a los resultados de OCR.

POST {Endpoint}/vision/v3.2-preview/read/analyze

Con parámetros opcionales:

POST {Endpoint}/vision/v3.2-preview/read/analyze?language={language}&Pages={Pages}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos.
language	query		OcrDetectionLanguage	Código de idioma BCP-47 del texto del documento. Actualmente, solo se admiten inglés ('en'), neerlandés ('nl'), francés ('fr'), alemán ('de'), italiano ('it'), portugués ('pt') y español ('es'). Read admite la identificación automática del idioma y los documentos de varios idiomas, por lo que solo debe proporcionar un código de idioma si desea forzar que el documento se procese como ese idioma específico.
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. Separa cada página o intervalo con una coma o espacio.

Encabezado de la solicitud

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

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
url	True	string	Dirección URL accesible públicamente de una imagen.

Respuestas

Nombre	Tipo	Description
202 Accepted		El servicio ha aceptado la solicitud y comenzará a procesarse más adelante. Encabezados Operation-Location: string
Other Status Codes	ComputerVisionError	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful Analyze request

Solicitud de ejemplo

HTTP

POST {Endpoint}/vision/v3.2-preview/read/analyze?language=en&Pages=2,3


{
  "url": "{url}"
}

Respuesta de muestra

status code:

202

Definiciones

Nombre	Description
ComputerVisionError	Detalles sobre el error de solicitud de API.
ComputerVisionErrorCodes	Código de error.
ImageUrl
OcrDetectionLanguage	Código de idioma BCP-47 del texto del documento. Actualmente, solo se admiten inglés ('en'), neerlandés ('nl'), francés ('fr'), alemán ('de'), italiano ('it'), portugués ('pt') y español ('es'). Read admite la identificación automática del idioma y los documentos de varios idiomas, por lo que solo debe proporcionar un código de idioma si desea forzar que el documento se procese como ese idioma específico.

ComputerVisionError

Object

Detalles sobre el error de solicitud de API.

Nombre	Tipo	Description
code	ComputerVisionErrorCodes	Código de error.
message	string	Mensaje que explica el error notificado por el servicio.
requestId	string	Identificador de solicitud único.

ComputerVisionErrorCodes

Enumeración

Código de error.

Valor	Description
BadArgument
CancelledRequest
DetectFaceError
FailedToProcess
InternalServerError
InvalidDetails
InvalidImageFormat
InvalidImageSize
InvalidImageUrl
InvalidModel
InvalidPageRange
InvalidThumbnailSize
NotSupportedFeature
NotSupportedImage
NotSupportedLanguage
NotSupportedVisualFeature
StorageException
Timeout
Unspecified
UnsupportedMediaType

ImageUrl

Object

Nombre	Tipo	Description
url	string	Dirección URL accesible públicamente de una imagen.

OcrDetectionLanguage

Enumeración

Código de idioma BCP-47 del texto del documento. Actualmente, solo se admiten inglés ('en'), neerlandés ('nl'), francés ('fr'), alemán ('de'), italiano ('it'), portugués ('pt') y español ('es'). Read admite la identificación automática del idioma y los documentos de varios idiomas, por lo que solo debe proporcionar un código de idioma si desea forzar que el documento se procese como ese idioma específico.

Valor	Description
de
en
es
fr
it
nl
pt