Recognize Printed Text - Recognize Printed Text

Referência

Service:: Cognitive Services - Computer Vision

API Version:: 2.1

O Reconhecimento Ótico de Carateres (OCR) deteta texto numa imagem e extrai os carateres reconhecidos para um fluxo de carateres utilizável por computador. Após o êxito, os resultados do OCR serão devolvidos. Após a falha, o código de erro juntamente com uma mensagem de erro será devolvido. O código de erro pode ser um de InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage ou InternalServerError.

POST {Endpoint}/vision/v2.1/ocr?detectOrientation={detectOrientation}

With optional parameters:

POST {Endpoint}/vision/v2.1/ocr?detectOrientation={detectOrientation}&language={language}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados.
detectOrientation	query	True	boolean	Se detetar a orientação do texto na imagem. Com detectOrientation=true, o serviço OCR tenta detetar a orientação da imagem e corrigi-la antes de continuar o processamento (por exemplo, se estiver de cabeça para baixo).
language	query		OcrLanguages	O código de idioma BCP-47 do texto a ser detetado na imagem. O valor predefinido é "unk".

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

Name	Necessário	Tipo	Description
url	True	string	URL acessível publicamente de uma imagem.

Respostas

Name	Tipo	Description
200 OK	OcrResult	O OCR resulta na hierarquia de região/linha/palavra. Os resultados incluem texto, caixa delimitadora para regiões, linhas e palavras. O ângulo, em radianos, do texto detetado relativamente à direção horizontal ou vertical mais próxima. Depois de rodar a imagem de entrada no sentido dos ponteiros do relógio por este ângulo, as linhas de texto reconhecidas tornam-se horizontais ou verticais. Em combinação com a propriedade de orientação, pode ser utilizada para sobrepor resultados de reconhecimento corretamente na imagem original, rodando a imagem original ou os resultados de reconhecimento por um ângulo adequado em torno do centro da imagem original. Se não for possível detetar com confiança o ângulo, esta propriedade não está presente. Se a imagem contiver texto em ângulos diferentes, apenas uma parte do texto será reconhecida corretamente.
Other Status Codes	ComputerVisionError	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

Successful RecognizePrintedText request

Sample Request

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v2.1/ocr?detectOrientation=true&language=en


"{url}"

Sample Response

Status code:: 200

{
  "language": "en",
  "textAngle": -2.0000000000000338,
  "orientation": "Up",
  "regions": [
    {
      "boundingBox": "462,379,497,258",
      "lines": [
        {
          "boundingBox": "462,379,497,74",
          "words": [
            {
              "boundingBox": "462,379,41,73",
              "text": "A"
            },
            {
              "boundingBox": "523,379,153,73",
              "text": "GOAL"
            },
            {
              "boundingBox": "694,379,265,74",
              "text": "WITHOUT"
            }
          ]
        },
        {
          "boundingBox": "565,471,289,74",
          "words": [
            {
              "boundingBox": "565,471,41,73",
              "text": "A"
            },
            {
              "boundingBox": "626,471,150,73",
              "text": "PLAN"
            },
            {
              "boundingBox": "801,472,53,73",
              "text": "IS"
            }
          ]
        },
        {
          "boundingBox": "519,563,375,74",
          "words": [
            {
              "boundingBox": "519,563,149,74",
              "text": "JUST"
            },
            {
              "boundingBox": "683,564,41,72",
              "text": "A"
            },
            {
              "boundingBox": "741,564,153,73",
              "text": "WISH"
            }
          ]
        }
      ]
    }
  ]
}

Definições

Name	Description
ComputerVisionError	Detalhes sobre o erro do pedido de API.
ComputerVisionErrorCodes	O código de erro.
ImageUrl
OcrLanguages	O código de idioma BCP-47 do texto a ser detetado na imagem. O valor predefinido é "unk".
OcrLine	Um objeto que descreve uma única linha de texto reconhecida.
OcrRegion	Uma região consiste em múltiplas linhas (por exemplo, uma coluna de texto num documento com várias colunas).
OcrResult
OcrWord	Informações sobre uma palavra reconhecida.

ComputerVisionError

Detalhes sobre o erro do pedido de API.

Name	Tipo	Description
code	ComputerVisionErrorCodes	O código de erro.
message	string	Uma mensagem a explicar o erro comunicado pelo serviço.
requestId	string	Um identificador de pedido exclusivo.

ComputerVisionErrorCodes

O código de erro.

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

ImageUrl

Name	Tipo	Description
url	string	URL acessível publicamente de uma imagem.

OcrLanguages

O código de idioma BCP-47 do texto a ser detetado na imagem. O valor predefinido é "unk".

Name	Tipo	Description
ar	string
cs	string
da	string
de	string
el	string
en	string
es	string
fi	string
fr	string
hu	string
it	string
ja	string
ko	string
nb	string
nl	string
pl	string
pt	string
ro	string
ru	string
sk	string
sr-Cyrl	string
sr-Latn	string
sv	string
tr	string
unk	string
zh-Hans	string
zh-Hant	string

OcrLine

Um objeto que descreve uma única linha de texto reconhecida.

Name	Tipo	Description
boundingBox	string	Caixa delimitadora de uma linha reconhecida. Os quatro números inteiros representam a coordenada x da margem esquerda, a coordenada y da margem superior, largura e altura da caixa delimitadora, no sistema de coordenadas da imagem de entrada, depois de ter sido rodada ao redor do respetivo centro de acordo com o ângulo de texto detetado (ver propriedade textAngle), com a origem no canto superior esquerdo e o eixo y a apontar para baixo.
words	OcrWord[]	Uma matriz de objetos, em que cada objeto representa uma palavra reconhecida.

OcrRegion

Uma região consiste em múltiplas linhas (por exemplo, uma coluna de texto num documento com várias colunas).

Name	Tipo	Description
boundingBox	string	Caixa delimitadora de uma região reconhecida. Os quatro números inteiros representam a coordenada x da margem esquerda, a coordenada y da margem superior, largura e altura da caixa delimitadora, no sistema de coordenadas da imagem de entrada, depois de ter sido rodada ao redor do respetivo centro de acordo com o ângulo de texto detetado (ver propriedade textAngle), com a origem no canto superior esquerdo e o eixo y a apontar para baixo.
lines	OcrLine[]	Uma matriz de linhas de texto reconhecidas.

OcrResult

Name	Tipo	Description
language	string	O código de idioma BCP-47 do texto na imagem.
orientation	string	Orientação do texto reconhecido na imagem, se solicitado. O valor (para cima, para baixo, para a esquerda ou para a direita) refere-se à direção que a parte superior do texto reconhecido está virada, depois de a imagem ter sido rodada ao redor do centro, de acordo com o ângulo de texto detetado (ver propriedade textAngle). Se a deteção da orientação não tiver sido pedida ou não for detetado texto, o valor será "NotDetected".
regions	OcrRegion[]	Uma matriz de objetos, onde cada objeto representa uma região de texto reconhecido.
textAngle	number	O ângulo, em radianos, do texto detetado relativamente à direção horizontal ou vertical mais próxima. Depois de rodar a imagem de entrada no sentido dos ponteiros do relógio por este ângulo, as linhas de texto reconhecidas tornam-se horizontais ou verticais. Em combinação com a propriedade de orientação, pode ser utilizada para sobrepor resultados de reconhecimento corretamente na imagem original, rodando a imagem original ou os resultados de reconhecimento por um ângulo adequado em torno do centro da imagem original. Se não for possível detetar com confiança o ângulo, esta propriedade não está presente. Se a imagem contiver texto em ângulos diferentes, apenas uma parte do texto será reconhecida corretamente.

OcrWord

Informações sobre uma palavra reconhecida.

Name	Tipo	Description
boundingBox	string	Caixa delimitadora de uma palavra reconhecida. Os quatro números inteiros representam a coordenada x da margem esquerda, a coordenada y da margem superior, largura e altura da caixa delimitadora, no sistema de coordenadas da imagem de entrada, depois de ter sido rodada ao redor do respetivo centro de acordo com o ângulo de texto detetado (ver propriedade textAngle), com a origem no canto superior esquerdo e o eixo y a apontar para baixo.
text	string	Valor da cadeia de uma palavra reconhecida.

Partilhar via