Analyzer - Analyze Business Card

  • Referência
Serviço:
Azure AI Services
Versão da API:
2.1

Extrair o texto do campo e os valores semânticos de um determinado documento de cartão de visita. O documento de entrada deve ser de um dos tipos de conteúdo com suporte : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' ou 'image/bmp'. Como alternativa, use o tipo 'application/json' para especificar o local (URI) do documento a ser analisado.

POST {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/analyze
Com parâmetros opcionais: 
POST {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/analyze?includeTextDetails={includeTextDetails}&locale={locale}&pages={pages}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string

Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
includeTextDetails
 query

boolean

Inclua linhas de texto e referências de elemento no resultado.
locale
 query

Locale

Localidade do documento de entrada. As localidades com suporte incluem: en-AU, en-CA, en-GB, en-IN, en-US(default).
pages
 query

string[]

Números de página personalizados para documentos de várias páginas (PDF/TIFF), insira o número de páginas que você deseja obter o resultado do OCR. Para um intervalo de páginas, use um hífen. Separe cada página ou intervalo com uma vírgula.

Cabeçalho da solicitação

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

Nome Obrigatório Tipo Description
Ocp-Apim-Subscription-Key True

string

Corpo da solicitação

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

Nome Tipo Description
source

string

Caminho de origem do arquivo.

Respostas

Nome Tipo Description
202 Accepted

A solicitação é enfileirada com êxito.

Cabeçalhos

Operation-Location: string
Other Status Codes

ErrorResponse

Entidade de resposta que acompanha respostas não bem-sucedidas que contêm detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Analyze Business Card

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
202 
Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definições

Nome Description
ErrorInformation
ErrorResponse
Locale

Localidade do documento de entrada. As localidades com suporte incluem: en-AU, en-CA, en-GB, en-IN, en-US(default).
SourcePath

URI ou caminho local para os dados de origem.

ErrorInformation

Nome Tipo Description
code

string

message

string

ErrorResponse

Nome Tipo Description
error

ErrorInformation

Locale

Localidade do documento de entrada. As localidades com suporte incluem: en-AU, en-CA, en-GB, en-IN, en-US(default).

Nome Tipo Description
en-AU

string

en-CA

string

en-GB

string

en-IN

string

en-US

string

SourcePath

URI ou caminho local para os dados de origem.

Nome Tipo Description
source

string

Caminho de origem do arquivo.