Azure Document Intelligence AI (Reconhecedor de Formulários)
Extrai texto (OCR impresso e manuscrito) e informações adicionais (tabelas, caixas de seleção, campos/pares de valor de chave) de PDFs, imagens ou documentos do Microsoft Office e formulários em dados estruturados com base em modelos pré-treinados (layout, fatura, recibo, ID, cartão de visita) ou modelo personalizado criado por um conjunto de formulários de treinamento representativos usando a compreensão de documentos de IA.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Todas as regiões do Power Automate , exceto as seguintes: - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Departamento de Defesa dos EUA (DoD) |
| Power Apps | - | Não disponível |
| Power Automate | Standard | Todas as regiões do Power Automate , exceto as seguintes: - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL | https://aka.ms/formrecognizer |
| formrecog_contact@microsoft.com |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://aka.ms/formrecognizer |
| Política de privacidade | https://aka.ms/form-recognizer/privacy |
| Categorias | IA; Business Intelligence |
O conector do IA do Azure para Informação de Documentos (antigo Reconhecimento de Formulários) fornece integração ao IA do Azure para Informação de Documentos. Ele permite analisar e extrair informações de Formulários, Faturas, Recibos, Cartões de Visita, Documentos de ID e vários outros tipos de documento.
Pré-requisitos
Para usar essa integração, você precisará de um recurso do IA do Azure para Informação de Documentos no portal do Azure. Criar link de recurso. Você obterá um ponto de extremidade e uma chave para autenticar seus aplicativos. Para fazer uma conexão, forneça a chave da conta, a URL do site e selecione Criar conexão. Para os custos de operação em sua conexão, saiba mais aqui.
Como obter credenciais
- Abra o recurso do Document Intelligence no portal do Azure (consulte Pré-requisitos).
- Selecionar chaves e ponto de extremidade no Gerenciamento de Recursos
- Copie o Ponto de Extremidade e a Chave e use-os para criar uma nova conexão.
Introdução ao conector
A maneira mais simples de experimentar o conector do Document Intelligence é usar modelos predefinidos (fatura predefinida, layout predefinido etc. ). Forneça PDF ou imagem do documento. Analise usando a operação do conector com base no tipo de documento e inspecione os campos detectados. Lista completa de modelos e recursos com suporte aqui.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Chave de API | Forneça o nome do recurso intellignce do documento e a chave de API. | Todas as regiões | Compartilhável |
| Identidade Gerenciada | Criar uma conexão usando uma Identidade Gerenciada | Somente LOGICAPPS | Compartilhável |
| Microsoft Entra ID Integrado | Usar a ID do Microsoft Entra para acessar | Todas as regiões | Não compartilhável |
| Padrão [PRETERIDO] | Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. | Todas as regiões | Não compartilhável |
Chave de API
ID de autenticação: keyBasedAuth
Aplicável: todas as regiões
Forneça o nome do recurso intellignce do documento e a chave de API.
Essa é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a visão geral dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de Conta | secureString | Chave da Conta do Document Intelligence | Verdade |
| URL do ponto de extremidade | cadeia | Url do ponto de extremidade do Document Intelligence (exemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Verdade |
Identidade Gerenciada
ID de autenticação: managedIdentityAuth
Aplicável: somente LOGICAPPS
Criar uma conexão usando uma Identidade Gerenciada
Essa é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a visão geral dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Identidade Gerenciada | managedIdentity | Entrar com uma identidade gerenciada | Verdade |
| URL do ponto de extremidade | cadeia | Url do ponto de extremidade do Document Intelligence (exemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Verdade |
Microsoft Entra ID Integrado
ID de autenticação: oauth
Aplicável: todas as regiões
Usar a ID do Microsoft Entra para acessar
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| URL do ponto de extremidade | cadeia | Url do ponto de extremidade do Document Intelligence (exemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Verdade |
Padrão [PRETERIDO]
Aplicável: todas as regiões
Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de Conta | secureString | Chave da Conta do Document Intelligence | Verdade |
| URL do ponto de extremidade | cadeia | Url do ponto de extremidade do Document Intelligence (exemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 1200 | 60 segundos |
Ações
| Analisar Cartão de Visita (preterido) [PRETERIDO] |
Extraia texto de campo e valores semânticos de um determinado documento de cartão de visita (preterido). |
| Analisar documento de ID (preterido) [PRETERIDO] |
Extraia texto de campo e valores semânticos de um determinado documento de ID (preterido). |
| Analisar documento para modelos predefinidos ou personalizados (API v3.x) |
Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (API v3.x). |
| Analisar documento para modelos predefinidos ou personalizados (API v4.x) |
Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (API v4.x). |
| Analisar fatura (preterida) [PRETERIDA] |
Extrair texto de campo e valores semânticos de um determinado documento de fatura (preterido). |
| Analisar formulário personalizado (preterido) [PRETERIDO] |
Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (preterido). |
| Analisar Layout (preterido) [PRETERIDO] |
Extraia informações de texto e layout de um determinado documento (preterido). |
| Analisar recibo (preterido) [PRETERIDO] |
Extraia texto de campo e valores semânticos de um determinado documento de recibo (preterido). |
| Classificar documento com classificador de documento (API v3.1) |
Classificar documento com classificador de documento (API v3.1). |
| Classificar documento com classificador de documento (API v4.x) |
Classificar documento com classificador de documento (API v4.x). |
Analisar Cartão de Visita (preterido) [PRETERIDO]
Extraia texto de campo e valores semânticos de um determinado documento de cartão de visita (preterido).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Incluir detalhes do texto
|
includeTextDetails | boolean |
Inclua linhas de texto e referências de elemento no resultado. Padrão: True (apenas para o Conector FR). |
|
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações da Fatura de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Local
|
locale | string |
Localidade da fatura. A localidade com suporte inclui: en-US. |
|
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG ou PNG) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
Retornos
Status e resultado da operação de análise na fila.
Analisar documento de ID (preterido) [PRETERIDO]
Extraia texto de campo e valores semânticos de um determinado documento de ID (preterido).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Incluir detalhes do texto
|
includeTextDetails | boolean |
Inclua linhas de texto e referências de elemento no resultado. Padrão: True (apenas para o Conector FR). |
|
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações da Fatura de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG ou PNG) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
Retornos
Status e resultado da operação de análise na fila.
- Corpo
- IdAnalyzeOperationResult
Analisar documento para modelos predefinidos ou personalizados (API v3.x)
Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (API v3.x).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Versão da API do Document Intelligence
|
api-version | True | string |
Versão da API do Document Intelligence. |
|
Identificador de modelo
|
modelId | True | string |
ModelIds predefinidos: predefinido- read, prebuilt-layout, prebuilt-document, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-vaccinationCard, prebuilt-healthInsuranceCard.us. Formato modelId personalizado – [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nome do modelo exclusivo. |
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações da Fatura de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Local
|
locale | string |
Dica de localidade para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a marca de idioma BCP 47 (ex. "en-US"). |
|
|
Tipo de índice de cadeia de caracteres
|
stringIndexType | string |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. Opções com suporte: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Recursos opcionais e Premium
|
features | array |
Lista de recursos opcionais de análise ( como ocrHighResolution, idiomas, códigos de barras, fórmulas, keyValuePairs e styleFont). |
|
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG, PNG, BMP, TIFF) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
Retornos
Status e resultado da operação de análise.
Analisar documento para modelos predefinidos ou personalizados (API v4.x)
Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (API v4.x).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Versão da API do Document Intelligence
|
api-version | True | string |
Versão da API do Document Intelligence. |
|
Identificador de modelo
|
modelId | True | string |
ModelIds predefinidas: leitura predefinida, prebuilt-layout, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-vaccinationCard, prebuilt-healthInsuranceCard.us, prebuilt-tax.us.1098, prebuilt-tax.us.1098E, prebuilt-tax.us.1098T, prebuilt-contract, etc. Formato modelId personalizado – [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nome do modelo exclusivo. |
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG, PNG, BMP, TIFF) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
|
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações da Fatura de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Local
|
locale | string |
Dica de localidade para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a marca de idioma BCP 47 (ex. "en-US"). |
|
|
Tipo de índice de cadeia de caracteres
|
stringIndexType | string |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. Opções com suporte: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Recursos opcionais e Premium
|
features | array |
Lista de recursos opcionais de análise ( como ocrHighResolution, idiomas, códigos de barras, fórmulas, keyValuePairs, styleFont e queryFields). |
|
|
Campos de consulta
|
queryFields | array |
Lista de campos adicionais a serem extraídos. Ex.: "NumberOfGuests,StoreNumber" |
|
|
Formato de conteúdo de saída
|
outputContentFormat | string |
Formato do conteúdo de nível superior do resultado de análise. |
Retornos
Status e resultado da operação de análise.
Analisar fatura (preterida) [PRETERIDA]
Extrair texto de campo e valores semânticos de um determinado documento de fatura (preterido).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Incluir detalhes do texto
|
includeTextDetails | boolean |
Inclua linhas de texto e referências de elemento no resultado. Padrão: True (apenas para o Conector FR). |
|
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações da Fatura de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Local
|
locale | string |
Localidade da fatura. A localidade com suporte inclui: en-US. |
|
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG ou PNG) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
Retornos
Status e resultado da operação de análise na fila.
Analisar formulário personalizado (preterido) [PRETERIDO]
Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (preterido).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de modelo
|
modelId | True | string |
Formato – uuid. Identificador de modelo. |
|
Incluir detalhes do texto
|
includeTextDetails | boolean |
Inclua linhas de texto e referências de elemento no resultado. Padrão: True (apenas para o Conector FR). |
|
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações da Fatura de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG ou PNG) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
Retornos
Status e resultado da operação de análise na fila.
Analisar Layout (preterido) [PRETERIDO]
Extraia informações de texto e layout de um determinado documento (preterido).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações da Fatura de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Linguagem
|
language | string |
O código de idioma BCP-47 do texto no documento. |
|
|
Ordem de Leitura
|
readingOrder | string |
Parâmetro opcional para especificar qual algoritmo de ordem de leitura deve ser aplicado ao ordenar os elementos de texto de extração. Pode ser "básico" ou "natural". O padrão será básico se não for especificado. |
|
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG ou PNG) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
Retornos
Status e resultado da operação de análise na fila.
Analisar recibo (preterido) [PRETERIDO]
Extraia texto de campo e valores semânticos de um determinado documento de recibo (preterido).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Incluir detalhes do texto
|
includeTextDetails | boolean |
Inclua linhas de texto e referências de elemento no resultado. Padrão: True (apenas para o Conector FR). |
|
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações da Fatura de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Local
|
locale | string |
Localidade da fatura. A localidade com suporte inclui: en-US. |
|
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG ou PNG) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
Retornos
Status e resultado da operação de análise na fila.
Classificar documento com classificador de documento (API v3.1)
Classificar documento com classificador de documento (API v3.1).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador do classificador
|
classifierId | True | string |
Formato - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nome do classificador exclusivo. |
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Local
|
locale | string |
Dica de localidade para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a marca de idioma BCP 47 (ex. "en-US"). |
|
|
Tipo de índice de cadeia de caracteres
|
stringIndexType | string |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. Opções com suporte: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG, PNG, BMP, TIFF) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
Retornos
Status e resultado da operação de análise.
Classificar documento com classificador de documento (API v4.x)
Classificar documento com classificador de documento (API v4.x).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Versão da API do Document Intelligence
|
api-version | True | string |
Versão da API do Document Intelligence. |
|
Identificador do classificador
|
classifierId | True | string |
Formato - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nome do classificador exclusivo. |
|
Conteúdo do arquivo de documento/imagem
|
inputFileContent | binary |
Um arquivo de documento ou imagem PDF (JPG, PNG, BMP, TIFF) a ser analisado. |
|
|
URL de Documento/Imagem
|
inputFileUrl | string |
Caminho da URL para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem. |
|
|
Modo de Divisão
|
split | string |
Comportamento de divisão de arquivos. |
|
|
Páginas
|
pages | string |
A seleção de página para documentos PDF e TIFF de várias páginas, para extrair informações de páginas individuais e um intervalo de páginas (como a página 2 e as páginas 5-7) inserindo os números de página e intervalos separados por vírgulas (por exemplo, '2, 5-7'). Se não for definido, todas as páginas serão processadas. |
|
|
Local
|
locale | string |
Dica de localidade para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a marca de idioma BCP 47 (ex. "en-US"). |
|
|
Tipo de índice de cadeia de caracteres
|
stringIndexType | string |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. Opções com suporte: textElements, unicodeCodePoint, utf16CodeUnit. |
Retornos
Status e resultado da operação de análise.
Definições
OperationStatus
LayoutAnalyzeOperationResult
Status e resultado da operação de análise na fila.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status da operação na fila. |
|
createdDateTime
|
createdDateTime | string |
Data e hora (UTC) que a operação de análise foi enviada. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data e hora (UTC) quando o status é atualizado pela última vez. |
|
analyzeResult
|
analyzeResult | LayoutAnalyzeResult |
Analisar o resultado da operação. |
InvoiceAnalyzeOperationResult
Status e resultado da operação de análise na fila.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status da operação na fila. |
|
createdDateTime
|
createdDateTime | string |
Data e hora (UTC) que a operação de análise foi enviada. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data e hora (UTC) quando o status é atualizado pela última vez. |
|
analyzeResult
|
analyzeResult | InvoiceAnalyzeResult |
Analisar o resultado da operação. |
BusinessCardAnalyzeOperationResult
Status e resultado da operação de análise na fila.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status da operação na fila. |
|
createdDateTime
|
createdDateTime | string |
Data e hora (UTC) que a operação de análise foi enviada. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data e hora (UTC) quando o status é atualizado pela última vez. |
|
analyzeResult
|
analyzeResult | BusinessCardAnalyzeResult |
Analisar o resultado da operação. |
ReceiptAnalyzeOperationResult
Status e resultado da operação de análise na fila.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status da operação na fila. |
|
createdDateTime
|
createdDateTime | string |
Data e hora (UTC) que a operação de análise foi enviada. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data e hora (UTC) quando o status é atualizado pela última vez. |
|
analyzeResult
|
analyzeResult | ReceiptAnalyzeResult |
Analisar o resultado da operação. |
IdAnalyzeOperationResult
Status e resultado da operação de análise na fila.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status da operação na fila. |
|
createdDateTime
|
createdDateTime | string |
Data e hora (UTC) que a operação de análise foi enviada. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data e hora (UTC) quando o status é atualizado pela última vez. |
|
analyzeResult
|
analyzeResult | IdAnalyzeResult |
Analisar o resultado da operação. |
CustomFormsAnalyzeOperationResult
Status e resultado da operação de análise na fila.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
Status da operação na fila. |
|
createdDateTime
|
createdDateTime | string |
Data e hora (UTC) que a operação de análise foi enviada. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data e hora (UTC) quando o status é atualizado pela última vez. |
|
analyzeResult
|
analyzeResult | CustomFormsAnalyzeResult |
Analisar o resultado da operação. |
FormOperationError
Erro relatado durante uma operação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
mensagem
|
message | string |
Mensagem de erro. |
LayoutAnalyzeResult
Analisar o resultado da operação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
versão
|
version | string |
Versão do esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído da entrada. |
|
pageResults
|
pageResults | array of PageResult |
Informações de nível de página extraídas da entrada. |
|
Erros
|
errors | array of FormOperationError |
Lista de erros relatados durante a operação de análise. |
InvoiceAnalyzeResult
Analisar o resultado da operação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
versão
|
version | string |
Versão do esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído da entrada. |
|
pageResults
|
pageResults | array of PageResult |
Informações de nível de página extraídas da entrada. |
|
documentResults
|
documentResults | array of InvoiceDocumentResult |
Informações no nível do documento extraídas da entrada. |
|
Erros
|
errors | array of FormOperationError |
Lista de erros relatados durante a operação de análise. |
BusinessCardAnalyzeResult
Analisar o resultado da operação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
versão
|
version | string |
Versão do esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído da entrada. |
|
pageResults
|
pageResults | array of PageResult |
Informações de nível de página extraídas da entrada. |
|
documentResults
|
documentResults | array of BusinessCardDocumentResult |
Informações no nível do documento extraídas da entrada. |
|
Erros
|
errors | array of FormOperationError |
Lista de erros relatados durante a operação de análise. |
ReceiptAnalyzeResult
Analisar o resultado da operação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
versão
|
version | string |
Versão do esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído da entrada. |
|
pageResults
|
pageResults | array of PageResult |
Informações de nível de página extraídas da entrada. |
|
documentResults
|
documentResults | array of ReceiptDocumentResult |
Informações no nível do documento extraídas da entrada. |
|
Erros
|
errors | array of FormOperationError |
Lista de erros relatados durante a operação de análise. |
IdAnalyzeResult
Analisar o resultado da operação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
versão
|
version | string |
Versão do esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído da entrada. |
|
pageResults
|
pageResults | array of PageResult |
Informações de nível de página extraídas da entrada. |
|
documentResults
|
documentResults | array of IdDocumentResult |
Informações no nível do documento extraídas da entrada. |
|
Erros
|
errors | array of FormOperationError |
Lista de erros relatados durante a operação de análise. |
CustomFormsAnalyzeResult
Analisar o resultado da operação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
versão
|
version | string |
Versão do esquema usado para este resultado. |
|
readResults
|
readResults | array of ReadResult |
Texto extraído da entrada. |
|
pageResults
|
pageResults | array of PageResult |
Informações de nível de página extraídas da entrada. |
|
documentResults
|
documentResults | array of CustomFormsDocumentResult |
Informações no nível do documento extraídas da entrada. |
|
Erros
|
errors | array of FormOperationError |
Lista de erros relatados durante a operação de análise. |
ReadResult
Texto extraído de uma página no documento de entrada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
O número de página baseado em 1 no documento de entrada. |
|
ângulo
|
angle | float |
A orientação geral do texto no sentido horário, medida em graus entre (-180, 180]. |
|
largura
|
width | float |
A largura da imagem/PDF em pixels/polegadas, respectivamente. |
|
height
|
height | float |
A altura da imagem/PDF em pixels/polegadas, respectivamente. |
|
unidade
|
unit | string |
A unidade usada pelas propriedades width, height e boundingBox. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada". |
|
Linhas
|
lines | array of TextLine |
Quando includeTextDetails é definido como true, uma lista de linhas de texto reconhecidas. O número máximo de linhas retornadas é de 300 por página. As linhas são classificadas de cima para baixo, da esquerda para a direita, embora em certos casos a proximidade seja tratada com prioridade mais alta. Como a ordem de classificação depende do texto detectado, ela pode ser alterada entre imagens e atualizações de versão do OCR. Portanto, a lógica de negócios deve ser criada sobre o local real da linha em vez da ordem. |
Linha de Texto
Um objeto que representa uma linha de texto extraída.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
O conteúdo do texto da linha. |
|
boundingBox
|
boundingBox | BoundingBox |
Caixa delimitadora quadrangle, com coordenadas especificadas em relação à parte superior esquerda da imagem original. Os oito números representam os quatro pontos, no sentido horário do canto superior esquerdo em relação à orientação de texto. Para a imagem, as coordenadas (x, y) são medidas em pixels. Para PDF, as coordenadas (x, y) são medidas em polegadas. |
|
words
|
words | array of TextWord |
Lista de palavras na linha de texto. |
TextWord
Um objeto que representa uma palavra.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
O conteúdo do texto da palavra. |
|
boundingBox
|
boundingBox | BoundingBox |
Caixa delimitadora quadrangle, com coordenadas especificadas em relação à parte superior esquerda da imagem original. Os oito números representam os quatro pontos, no sentido horário do canto superior esquerdo em relação à orientação de texto. Para a imagem, as coordenadas (x, y) são medidas em pixels. Para PDF, as coordenadas (x, y) são medidas em polegadas. |
|
confiança
|
confidence | Confidence |
Valor de confiança. |
BoundingBox
Caixa delimitadora quadrangle, com coordenadas especificadas em relação à parte superior esquerda da imagem original. Os oito números representam os quatro pontos, no sentido horário do canto superior esquerdo em relação à orientação de texto. Para a imagem, as coordenadas (x, y) são medidas em pixels. Para PDF, as coordenadas (x, y) são medidas em polegadas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
float |
PageResult
Informações extraídas de uma única página.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Número da página. |
|
clusterId
|
clusterId | integer |
Identificador de cluster. |
|
keyValuePairs
|
keyValuePairs | array of KeyValuePair |
Lista de pares chave-valor extraídos da página. |
|
tables
|
tables | array of DataTable |
Lista de tabelas de dados extraídas da página. |
KeyValuePair
Informações sobre o par chave-valor extraído.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
etiqueta
|
label | string |
Um rótulo definido pelo usuário para a entrada de par chave/valor. |
|
chave
|
key | KeyValueElement |
Informações sobre a chave extraída ou o valor em um par chave-valor. |
|
value
|
value | KeyValueElement |
Informações sobre a chave extraída ou o valor em um par chave-valor. |
|
confiança
|
confidence | Confidence |
Valor de confiança. |
KeyValueElement
Informações sobre a chave extraída ou o valor em um par chave-valor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
O conteúdo do texto da chave ou do valor. |
|
boundingBox
|
boundingBox | BoundingBox |
Caixa delimitadora quadrangle, com coordenadas especificadas em relação à parte superior esquerda da imagem original. Os oito números representam os quatro pontos, no sentido horário do canto superior esquerdo em relação à orientação de texto. Para a imagem, as coordenadas (x, y) são medidas em pixels. Para PDF, as coordenadas (x, y) são medidas em polegadas. |
|
Elementos
|
elements | array of ElementReference |
Quando includeTextDetails é definido como true, uma lista de referências aos elementos de texto que constituem essa chave ou valor. |
ElementReference
DataTable
Informações sobre a tabela extraída contida em uma página.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Linhas
|
rows | integer |
Número de linhas. |
|
columns
|
columns | integer |
Número de colunas. |
|
Células
|
cells | array of DataTableCell |
Lista de células contidas na tabela. |
DataTableCell
Informações sobre a célula extraída em uma tabela.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
rowIndex
|
rowIndex | integer |
Índice de linha da célula. |
|
columnIndex
|
columnIndex | integer |
Índice de coluna da célula. |
|
rowSpan
|
rowSpan | integer |
Número de linhas estendidas por essa célula. |
|
columnSpan
|
columnSpan | integer |
Número de colunas estendidas por essa célula. |
|
enviar SMS
|
text | string |
Conteúdo de texto da célula. |
|
boundingBox
|
boundingBox | BoundingBox |
Caixa delimitadora quadrangle, com coordenadas especificadas em relação à parte superior esquerda da imagem original. Os oito números representam os quatro pontos, no sentido horário do canto superior esquerdo em relação à orientação de texto. Para a imagem, as coordenadas (x, y) são medidas em pixels. Para PDF, as coordenadas (x, y) são medidas em polegadas. |
|
Elementos
|
elements | array of ElementReference |
Quando includeTextDetails é definido como true, uma lista de referências aos elementos de texto que constituem essa célula de tabela. |
|
isHeader
|
isHeader | boolean |
Retorne se a célula atual for uma célula de cabeçalho. |
|
isFooter
|
isFooter | boolean |
Retornará se a célula atual for uma célula de rodapé. |
InvoiceDocumentResult
Um conjunto de campos extraídos correspondentes ao documento de entrada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número da primeira e última página em que o documento é encontrado. |
|
fields
|
fields | InvoiceFields |
Campos de fatura para 2.1. |
BusinessCardDocumentResult
Um conjunto de campos extraídos correspondentes ao documento de entrada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número da primeira e última página em que o documento é encontrado. |
|
fields
|
fields | BusinessCardFields |
Campos BusinessCard para 2.1. |
CustomFormsDocumentResult
Um conjunto de campos extraídos correspondentes ao documento de entrada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número da primeira e última página em que o documento é encontrado. |
|
Fields
|
_fields | array of CustomFormsFields |
Matriz de campos com propriedades fieldName e fieldValue. |
ReceiptDocumentResult
Um conjunto de campos extraídos correspondentes ao documento de entrada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número da primeira e última página em que o documento é encontrado. |
|
fields
|
fields | ReceiptFields |
Campos de recibo para 2.1. |
IdDocumentResult
Um conjunto de campos extraídos correspondentes ao documento de entrada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | string |
Tipo de documento. |
|
pageRange
|
pageRange | array of integer |
Número da primeira e última página em que o documento é encontrado. |
|
fields
|
fields | IdFields |
Campos de documento de ID para 2.1. |
CustomFormsFields
Campos de formulário personalizados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do campo
|
fieldName | string | |
|
Valor do campo
|
fieldValue | FieldValue |
Objeto de valor de campo previsto. |
InvoiceFields
Campos de fatura para 2.1.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Valor devido (texto)
|
AmountDue.text | string |
Retorna o valor devido conforme gravado na fatura. |
|
Valor devido (número)
|
AmountDue.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança da quantidade devida
|
AmountDue.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Endereço para cobrança
|
BillingAddress.text | string | |
|
Confiança do endereço de cobrança
|
BillingAddress.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Destinatário do endereço de cobrança
|
BillingAddressRecipient.text | string | |
|
Confiança do destinatário do endereço de cobrança
|
BillingAddressRecipient.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Endereço do Cliente
|
CustomerAddress.text | string | |
|
Confiança do endereço do cliente
|
CustomerAddress.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Destinatário do endereço do cliente
|
CustomerAddressRecipient.text | string | |
|
Confiança do destinatário do endereço do cliente
|
CustomerAddressRecipient.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
ID do cliente
|
CustomerId.text | string | |
|
Confiança da ID do cliente
|
CustomerId.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Nome do Cliente
|
CustomerName.text | string | |
|
Confiança do nome do cliente
|
CustomerName.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Data de conclusão (texto)
|
DueDate.text | string |
Retorna a data de conclusão conforme escrito na fatura. |
|
Data de conclusão (data)
|
DueDate.valueDate | date |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança da data de conclusão
|
DueDate.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Data da fatura (texto)
|
InvoiceDate.text | string |
Retorna a data da fatura conforme escrito na fatura. |
|
Data da fatura (data)
|
InvoiceDate.valueDate | date |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança da data da fatura
|
InvoiceDate.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
ID da fatura
|
InvoiceId.text | string | |
|
Confiança da ID da fatura
|
InvoiceId.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Total da fatura (texto)
|
InvoiceTotal.text | string |
Retorna o total da fatura conforme gravado na fatura. |
|
Total da fatura (número)
|
InvoiceTotal.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança do total da fatura
|
InvoiceTotal.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Saldo não pago anterior (texto)
|
PreviousUnpaidBalance.text | string |
Retorna o saldo não pago anterior conforme gravado na fatura. |
|
Saldo não pago anterior (número)
|
PreviousUnpaidBalance.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança do saldo não pago anterior
|
PreviousUnpaidBalance.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Ordem de compra
|
PurchaseOrder.text | string | |
|
Confiança da ordem de compra
|
PurchaseOrder.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Endereço de remessa
|
RemittanceAddress.text | string | |
|
Confiança do endereço de remessa
|
RemittanceAddress.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Destinatário do endereço de remessa
|
RemittanceAddressRecipient.text | string | |
|
Confiança do destinatário do endereço de remessa
|
RemittanceAddressRecipient.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Endereço de serviço
|
ServiceAddress.text | string | |
|
Confiança do endereço de serviço
|
ServiceAddress.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Destinatário do endereço de serviço
|
ServiceAddressRecipient.text | string | |
|
Confiança do destinatário do endereço de serviço
|
ServiceAddressRecipient.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Data de término do serviço (texto)
|
ServiceEndDate.text | string |
Retorna a data de término do serviço, conforme escrito na fatura. |
|
Data de término do serviço (data)
|
ServiceEndDate.valueDate | date |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança da data de término do serviço
|
ServiceEndDate.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Data de início do serviço (texto)
|
ServiceStartDate.text | string |
Retorna a data de início do serviço conforme escrito na fatura. |
|
Data de início do serviço (data)
|
ServiceStartDate.valueDate | date |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança da data de início do serviço
|
ServiceStartDate.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Endereço de entrega
|
ShippingAddress.text | string | |
|
Confiança do endereço de envio
|
ShippingAddress.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Destinatário do endereço de envio
|
ShippingAddressRecipient.text | string | |
|
Confiança do destinatário do endereço de envio
|
ShippingAddressRecipient.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Subtotal (texto)
|
SubTotal.text | string |
Retorna o subtotal conforme escrito na fatura. |
|
Subtotal (número)
|
SubTotal.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança do subtotal
|
SubTotal.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Imposto total (texto)
|
TotalTax.text | string |
Retorna o imposto total conforme escrito na fatura. |
|
Imposto total (número)
|
TotalTax.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança do imposto total
|
TotalTax.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Endereço do fornecedor
|
VendorAddress.text | string | |
|
Confiança do endereço do fornecedor
|
VendorAddress.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Destinatário do endereço do fornecedor
|
VendorAddressRecipient.text | string | |
|
Confiança do destinatário do endereço do fornecedor
|
VendorAddressRecipient.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Nome do fornecedor
|
VendorName.text | string | |
|
Confiança do nome do fornecedor
|
VendorName.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Itens
|
Items.valueArray | array of object |
Matriz de itens de linha |
|
Quantidade (texto)
|
Items.valueArray.valueObject.Amount.text | string |
Retorna o valor conforme gravado na fatura. |
|
Quantidade (número)
|
Items.valueArray.valueObject.Amount.valueNumber | number |
Formatado como um número. Exemplo: 12. |
|
Confiança da quantidade
|
Items.valueArray.valueObject.Amount.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Description
|
Items.valueArray.valueObject.Description.text | string | |
|
Confiança da descrição
|
Items.valueArray.valueObject.Description.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Quantidade (texto)
|
Items.valueArray.valueObject.Quantity.text | string |
Retorna a quantidade conforme escrito na fatura. |
|
Quantidade (número)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Formatado como um número. Exemplo: 12. |
|
Confiança da quantidade
|
Items.valueArray.valueObject.Quantity.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Preço unitário (texto)
|
Items.valueArray.valueObject.UnitPrice.text | string |
Retorna o preço unitário conforme escrito na fatura. |
|
Preço unitário (número)
|
Items.valueArray.valueObject.UnitPrice.valueNumber | number |
Formatado como um número. Exemplo: 12. |
|
Confiança do preço unitário
|
Items.valueArray.valueObject.UnitPrice.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Código do produto
|
Items.valueArray.valueObject.ProductCode.text | string | |
|
Confiança do código do produto
|
Items.valueArray.valueObject.ProductCode.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Unidade
|
Items.valueArray.valueObject.Unit.text | string | |
|
Confiança da unidade
|
Items.valueArray.valueObject.Unit.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Data (texto)
|
Items.valueArray.valueObject.Date.text | string |
Retorna a data conforme gravada na fatura. |
|
Data (data)
|
Items.valueArray.valueObject.Date.valueDate | date |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança da data
|
Items.valueArray.valueObject.Date.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Imposto (texto)
|
Items.valueArray.valueObject.Tax.text | string |
Retorna o imposto conforme escrito na fatura. |
|
Imposto (número)
|
Items.valueArray.valueObject.Tax.valueNumber | number |
Formatado como um número. Exemplo: 12. |
|
Confiança dos impostos
|
Items.valueArray.valueObject.Tax.confidence | float |
Quão confiante o modelo está em sua previsão. |
BusinessCardFields
Campos BusinessCard para 2.1.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nomes de contato
|
ContactNames.valueArray | array of object |
Matriz de nomes de contato |
|
Nome
|
ContactNames.valueArray.valueObject.FirstName.text | string | |
|
Confiança do nome
|
ContactNames.valueArray.valueObject.FirstName.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Sobrenome
|
ContactNames.valueArray.valueObject.LastName.text | string | |
|
Confiança do sobrenome
|
ContactNames.valueArray.valueObject.LastName.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Nomes da empresa
|
CompanyNames.valueArray | array of object |
Matriz de nomes da empresa |
|
Nome da empresa
|
CompanyNames.valueArray.text | string | |
|
Confiança do nome da empresa
|
CompanyNames.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Departments
|
Departments.valueArray | array of object |
Matriz de departamentos |
|
Departamento
|
Departments.valueArray.text | string | |
|
Confiança do departamento
|
Departments.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Títulos de trabalho
|
JobTitles.valueArray | array of object |
Matriz de cargos |
|
Cargo
|
JobTitles.valueArray.text | string | |
|
Confiança do cargo
|
JobTitles.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Emails
|
Emails.valueArray | array of object |
Matriz de emails |
|
Email
|
Emails.valueArray.text | string | |
|
Confiança do email
|
Emails.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Sites
|
Websites.valueArray | array of object |
Matriz de sites |
|
Site
|
Websites.valueArray.text | string | |
|
Confiança do site
|
Websites.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Addresses
|
Addresses.valueArray | array of object |
Matriz de endereços |
|
Endereço
|
Addresses.valueArray.text | string | |
|
Confiança do endereço
|
Addresses.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Telemóveis
|
MobilePhones.valueArray | array of object |
Matriz de telefones celulares |
|
Telefone celular
|
MobilePhones.valueArray.text | string | |
|
Confiança do telefone celular
|
MobilePhones.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Faxes
|
Faxes.valueArray | array of object |
Matriz de faxes |
|
Fac-símile
|
Faxes.valueArray.text | string | |
|
Confiança do fax
|
Faxes.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Telefones de trabalho
|
WorkPhones.valueArray | array of object |
Matriz de telefones de trabalho |
|
Telefone comercial
|
WorkPhones.valueArray.text | string | |
|
Confiança do telefone de trabalho
|
WorkPhones.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Outros telefones
|
OtherPhones.valueArray | array of object |
Matriz de outros telefones |
|
Outro telefone
|
OtherPhones.valueArray.text | string | |
|
Confiança de outro telefone
|
OtherPhones.valueArray.confidence | float |
Quão confiante o modelo está em sua previsão. |
ReceiptFields
Campos de recibo para 2.1.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de recibo
|
ReceiptType.text | string | |
|
Confiança do tipo de recibo
|
ReceiptType.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Nome do comerciante
|
MerchantName.text | string | |
|
Confiança do nome do comerciante
|
MerchantName.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Número de telefone do comerciante
|
MerchantPhoneNumber.text | string | |
|
Confiança do número de telefone do comerciante
|
MerchantPhoneNumber.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Endereço do comerciante
|
MerchantAddress.text | string | |
|
Confiança do endereço do comerciante
|
MerchantAddress.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Data da transação (texto)
|
TransactionDate.text | string |
Retorna a data da transação conforme escrito na fatura. |
|
Data da transação (data)
|
TransactionDate.valueDate | date |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança da data da transação
|
TransactionDate.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Tempo de transação (texto)
|
TransactionTime.text | string |
Retorna o tempo da transação conforme gravado na fatura. |
|
Tempo de transação (hora)
|
TransactionTime.valueDate | time |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança do tempo de transação
|
TransactionTime.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Total (texto)
|
Total.text | string |
Retorna o total conforme escrito na fatura. |
|
Total (número)
|
Total.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança do total
|
Total.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Subtotal (texto)
|
Subtotal.text | string |
Retorna o subtotal conforme escrito na fatura. |
|
Subtotal (número)
|
Subtotal.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança do subtotal
|
Subtotal.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Imposto (texto)
|
Tax.text | string |
Retorna o imposto conforme escrito na fatura. |
|
Imposto (número)
|
Tax.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança dos impostos
|
Tax.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Dica (texto)
|
Tip.text | string |
Retorna a dica conforme escrito na fatura. |
|
Dica (número)
|
Tip.valueNumber | number |
Formatado como um número. Exemplo: 1234.98. |
|
Confiança da gorjeta
|
Tip.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Itens
|
Items.valueArray | array of object |
Matriz de itens de linha |
|
Nome
|
Items.valueArray.valueObject.Name.text | string | |
|
Confiança do nome
|
Items.valueArray.valueObject.Name.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Quantidade (texto)
|
Items.valueArray.valueObject.Quantity.text | string |
Retorna a quantidade conforme escrito na fatura. |
|
Quantidade (número)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Formatado como um número. Exemplo: 12. |
|
Confiança da quantidade
|
Items.valueArray.valueObject.Quantity.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Preço (texto)
|
Items.valueArray.valueObject.Price.text | string |
Retorna o preço conforme escrito na fatura. |
|
Preço (número)
|
Items.valueArray.valueObject.Price.valueNumber | number |
Formatado como um número. Exemplo: 12. |
|
Confiança do preço
|
Items.valueArray.valueObject.Price.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Preço total (texto)
|
Items.valueArray.valueObject.TotalPrice.text | string |
Retorna o preço total conforme escrito na fatura. |
|
Preço total (número)
|
Items.valueArray.valueObject.TotalPrice.valueNumber | number |
Formatado como um número. Exemplo: 12. |
|
Confiança do preço total
|
Items.valueArray.valueObject.TotalPrice.confidence | float |
Quão confiante o modelo está em sua previsão. |
IdFields
Campos de documento de ID para 2.1.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Região do País
|
CountryRegion.valueCountryRegion | string | |
|
Confiança da região do país
|
CountryRegion.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Data de expiração
|
DateOfExpiration.text | string |
Retorna a data de expiração, conforme escrito na fatura. |
|
Data de validade (data)
|
DateOfExpiration.valueDate | date |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança da data de validade
|
DateOfExpiration.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Data de nascimento (texto)
|
DateOfBirth.text | string |
Retorna a data de nascimento conforme escrito na fatura. |
|
Data de nascimento (data)
|
DateOfBirth.valueDate | date |
Formatado como uma data. Exemplo: 2019-05-31. |
|
Confiança da data de nascimento
|
DateOfBirth.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Número do documento
|
DocumentNumber.text | string | |
|
Confiança do número do documento
|
DocumentNumber.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Nome
|
FirstName.text | string | |
|
Confiança do nome
|
FirstName.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Sobrenome
|
LastName.text | string | |
|
Confiança do sobrenome
|
LastName.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Nationality
|
Nationality.valueCountryRegion | string | |
|
Confiança da nacionalidade
|
Nationality.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Sex
|
Sex.text | string | |
|
Confiança do sexo
|
Sex.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Zona legível do computador
|
MachineReadableZone.text | string | |
|
Confiança da zona legível do computador
|
MachineReadableZone.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Tipo de documento
|
DocumentType.text | string | |
|
Confiança do tipo de documento
|
DocumentType.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Endereço
|
Address.text | string | |
|
Confiança do endereço
|
Address.confidence | float |
Quão confiante o modelo está em sua previsão. |
|
Região
|
Region.text | string | |
|
Confiança da região
|
Region.confidence | float |
Quão confiante o modelo está em sua previsão. |
FieldValue
Objeto de valor de campo previsto.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | FieldValueType |
Tipo de dados semânticos do valor do campo. |
|
valueString
|
valueString | string |
Valor da cadeia. |
|
valueDate
|
valueDate | date-time |
Valor da data. |
|
valueTime
|
valueTime | date-time |
Valor de tempo. |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Valor do número de telefone. |
|
valueNumber
|
valueNumber | number |
Valor de ponto flutuante. |
|
valueInteger
|
valueInteger | integer |
Valor inteiro. |
|
enviar SMS
|
text | string | |
|
boundingBox
|
boundingBox | BoundingBox |
Caixa delimitadora quadrangle, com coordenadas especificadas em relação à parte superior esquerda da imagem original. Os oito números representam os quatro pontos, no sentido horário do canto superior esquerdo em relação à orientação de texto. Para a imagem, as coordenadas (x, y) são medidas em pixels. Para PDF, as coordenadas (x, y) são medidas em polegadas. |
|
confiança
|
confidence | Confidence |
Valor de confiança. |
|
Elementos
|
elements | array of ElementReference |
Quando includeTextDetails é definido como true, uma lista de referências aos elementos de texto que constituem esse campo. |
|
página
|
page | integer |
O número de página baseado em 1 no documento de entrada. |
FieldValueType
Confiança
ApiVersion_V30
AnalyzeResultOperation_V30
Status e resultado da operação de análise.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | string |
Status da operação. |
|
createdDateTime
|
createdDateTime | date-time |
Data e hora (UTC) quando a operação de análise foi enviada. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time |
Data e hora (UTC) quando o status foi atualizado pela última vez. |
|
erro
|
error | Error_V30 |
Informações de erro. |
|
analyzeResult
|
analyzeResult | AnalyzeResult_V30 |
Resultado da análise do documento. |
AnalyzeResult_V30
Resultado da análise do documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
apiVersion
|
apiVersion | ApiVersion_V30 |
Versão da API. |
|
modelId
|
modelId | ModelId_V30 |
Nome do modelo exclusivo. |
|
stringIndexType
|
stringIndexType | StringIndexType_V30 |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. |
|
conteúdo
|
content | string |
Concatenar a representação de cadeia de caracteres de todos os elementos textuais e visuais na ordem de leitura. |
|
formato de conteúdo
|
contentFormat | ContentFormat_V40 |
Formato do conteúdo no resultado analisado. |
|
Páginas
|
pages | array of DocumentPage_V30 |
Páginas analisadas. |
|
Parágrafos
|
paragraphs | array of DocumentParagraph_V30 |
Parágrafos extraídos. |
|
tables
|
tables | array of DocumentTable_V30 |
Tabelas extraídas. |
|
Figuras
|
figures | array of DocumentFigure_V40 |
Números extraídos. |
|
Seções
|
sections | array of DocumentSection_V40 |
Seções extraídas. |
|
keyValuePairs
|
keyValuePairs | array of DocumentKeyValuePair_V30 |
Pares chave-valor extraídos. |
|
entities
|
entities | array of DocumentEntity_V30 |
Entidades extraídas. |
|
Estilos
|
styles | array of DocumentStyle_V30 |
Estilos de fonte extraídos. |
|
Idiomas
|
languages | array of DocumentLanguage_V30 |
Idiomas detectados. |
|
Documentos
|
documents | array of Document_V30 |
Documentos extraídos. |
|
Avisos
|
warnings | array of Warning_V40 |
Lista de avisos encontrados. |
DocumentPage_V30
Elementos de layout e conteúdo extraídos de uma página da entrada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
variante
|
kind | string |
Tipo de página de documento. |
|
pageNumber
|
pageNumber | integer |
Número de página baseado em 1 no documento de entrada. |
|
ângulo
|
angle | number |
A orientação geral do conteúdo no sentido horário, medida em graus entre (-180, 180]. |
|
largura
|
width | number |
A largura da imagem/PDF em pixels/polegadas, respectivamente. |
|
height
|
height | number |
A altura da imagem/PDF em pixels/polegadas, respectivamente. |
|
unidade
|
unit | string |
A unidade usada pelas propriedades largura, altura e polígono. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada". |
|
spans
|
spans | array of DocumentSpan_V30 |
Local da página no conteúdo concatenado da ordem de leitura. |
|
words
|
words | array of DocumentWord_V30 |
Palavras extraídas da página. |
|
selectionMarks
|
selectionMarks | array of DocumentSelectionMark_V30 |
Marcas de seleção extraídas da página. |
|
images
|
images | array of DocumentImage_V30 |
Imagens extraídas da página. |
|
Linhas
|
lines | array of DocumentLine_V30 |
Linhas extraídas da página, potencialmente contendo elementos textuais e visuais. |
|
códigos de barras
|
barcodes | array of DocumentBarcode_V31 |
Códigos de barras extraídos da página. |
|
formulas
|
formulas | array of DocumentFormula_V31 |
Fórmulas extraídas da página. |
DocumentWord_V30
Um objeto de palavra que consiste em uma sequência contígua de caracteres. Para idiomas delimitados sem espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | string |
Conteúdo de texto da palavra. |
|
polígono
|
polygon | BoundingPolygon_V30 |
Polígono delimitado, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
|
span
|
span | DocumentSpan_V30 |
Região contígua da propriedade de conteúdo concatenado, especificada como um deslocamento e comprimento. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
DocumentSelectionMark_V30
Um objeto de marca de seleção que representa caixas de seleção, botões de opção e outros elementos que indicam uma seleção.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
estado
|
state | DocumentSelectionMarkState_V30 |
Estado da marca de seleção. |
|
polígono
|
polygon | BoundingPolygon_V30 |
Polígono delimitado, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
|
span
|
span | DocumentSpan_V30 |
Região contígua da propriedade de conteúdo concatenado, especificada como um deslocamento e comprimento. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
DocumentImage_V30
Um objeto de imagem detectado na página.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
polígono
|
polygon | BoundingPolygon_V30 |
Polígono delimitado, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
|
span
|
span | DocumentSpan_V30 |
Região contígua da propriedade de conteúdo concatenado, especificada como um deslocamento e comprimento. |
|
pageRef
|
pageRef | integer |
Índice baseado em 0 da matriz de páginas globais que contém o conteúdo da imagem. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
DocumentSelectionMarkState_V30
DocumentStyle_V30
Um objeto que representa os estilos de texto observados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
backgroundColor
|
backgroundColor | string |
Cor da tela de fundo em #rrggbb formato hexadecimal.. |
|
color
|
color | string |
Cor do primeiro plano em #rrggbb formato hexadecimal. |
|
fontStyle
|
fontStyle | string |
Estilo de fonte. |
|
fontWeight
|
fontWeight | string |
Peso da fonte. |
|
isHandwritten
|
isHandwritten | boolean |
O conteúdo é manuscrito. |
|
similarFontFamily
|
similarFontFamily | string |
Fonte visualmente mais semelhante entre o conjunto de famílias de fontes com suporte, com fontes de fallback seguindo a convenção CSS (por exemplo, 'Arial, sans-serif'). |
|
spans
|
spans | array of DocumentSpan_V30 |
Local dos elementos de texto no conteúdo concatenado ao qual o estilo se aplica. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
DocumentLanguage_V30
Um objeto que representa o idioma detectado para um determinado intervalo de texto.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
localidade
|
locale | string |
Idioma detectado. O valor pode ser um código de idioma ISO 639-1 (ex. "en", "fr") ou marca de idioma BCP 47 (por exemplo, "zh-Hans"). |
|
spans
|
spans | array of DocumentSpan_V30 |
Local dos elementos de texto no conteúdo concatenado ao qual o idioma se aplica. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
DocumentLine_V30
Um objeto de linha de conteúdo que consiste em uma sequência adjacente de elementos de conteúdo, como palavras e marcas de seleção.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | string |
Conteúdo concatenado dos elementos contidos na ordem de leitura. |
|
polígono
|
polygon | BoundingPolygon_V30 |
Polígono delimitado, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local da linha no conteúdo concatenado da ordem de leitura. |
DocumentParagraph_V30
Um objeto de parágrafo que consiste em linhas contíguas geralmente com alinhamento e espaçamento comuns.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
função
|
role | string |
Função semântica do parágrafo. |
|
conteúdo
|
content | string |
Conteúdo concatenado do parágrafo na ordem de leitura. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadoras que abrangem o parágrafo. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local do parágrafo no conteúdo concatenado da ordem de leitura. |
DocumentTable_V30
Um objeto de tabela que consiste em células de tabela organizadas em um layout retangular.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
rowCount
|
rowCount | integer |
Número de linhas na tabela. |
|
columnCount
|
columnCount | integer |
Número de colunas na tabela. |
|
Células
|
cells | array of DocumentTableCell_V30 |
Células contidas na tabela. |
|
barra de título
|
caption | DocumentCaption_V30 |
Um objeto que representa o local e o conteúdo de uma legenda de tabela. |
|
Rodapé
|
footnotes | array of DocumentFootnote_V30 |
Notas de rodapé associadas à tabela. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadoras que abrangem a tabela. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local da tabela no conteúdo concatenado da ordem de leitura. |
DocumentTableCell_V30
Um objeto que representa o local e o conteúdo de uma célula de tabela.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
variante
|
kind | string |
Tipo de célula de tabela. |
|
rowIndex
|
rowIndex | integer |
Índice de linha da célula. |
|
columnIndex
|
columnIndex | integer |
Índice de coluna da célula. |
|
rowSpan
|
rowSpan | integer |
Número de linhas estendidas por essa célula. |
|
columnSpan
|
columnSpan | integer |
Número de colunas estendidas por essa célula. |
|
conteúdo
|
content | string |
Conteúdo concatenado da célula da tabela na ordem de leitura. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadas que abrangem a célula da tabela. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local da célula da tabela no conteúdo concatenado da ordem de leitura. |
DocumentCaption_V30
Um objeto que representa o local e o conteúdo de uma legenda de tabela.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | string |
Conteúdo da legenda da tabela. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadoras que abrangem a legenda da tabela. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local da legenda da tabela no conteúdo concatenado da ordem de leitura. |
DocumentFootnote_V30
Um objeto que representa o local e o conteúdo de uma nota de rodapé da tabela.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | string |
Conteúdo da nota de rodapé da tabela. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadas que abrangem a nota de rodapé da tabela. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local da nota de rodapé da tabela no conteúdo concatenado da ordem de leitura. |
DocumentKeyValuePair_V30
Um objeto que representa um campo de formulário com rótulo de campo distinto (chave) e valor de campo (pode estar vazio).
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | DocumentKeyValueElement_V30 |
Um objeto que representa a chave de campo ou o valor em um par chave-valor. |
|
value
|
value | DocumentKeyValueElement_V30 |
Um objeto que representa a chave de campo ou o valor em um par chave-valor. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
DocumentKeyValueElement_V30
Um objeto que representa a chave de campo ou o valor em um par chave-valor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | string |
Conteúdo concatenado do elemento chave-valor na ordem de leitura. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadoras que abrangem o elemento chave-valor. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local do elemento chave-valor no conteúdo concatenado da ordem de leitura. |
DocumentEntity_V30
Um objeto que representa várias categorias de entidades.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categoria
|
category | string |
Tipo de entidade. |
|
subcategoria
|
subCategory | string |
Subtipo de entidade. |
|
conteúdo
|
content | string |
Conteúdo da entidade. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadoras que abrangem a entidade. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local da entidade no conteúdo concatenado da ordem de leitura. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
DocumentBarcode_V31
Um objeto de código de barras.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
|
variante
|
kind | string |
Tipo de código de barras. |
|
polígono
|
polygon | BoundingPolygon_V30 |
Polígono delimitado, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
|
span
|
span | DocumentSpan_V30 |
Região contígua da propriedade de conteúdo concatenado, especificada como um deslocamento e comprimento. |
|
value
|
value | string |
Valor do código de barras |
DocumentFormula_V31
Um objeto de fórmula.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
|
variante
|
kind | string |
Tipo de fórmula. |
|
polígono
|
polygon | BoundingPolygon_V30 |
Polígono delimitado, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
|
span
|
span | DocumentSpan_V30 |
Região contígua da propriedade de conteúdo concatenado, especificada como um deslocamento e comprimento. |
|
value
|
value | string |
Expressão LaTex que descreve a fórmula. |
DocumentFigure_V40
Um objeto que representa uma figura no documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadoras que abrangem a figura. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local da figura no conteúdo concatenado da ordem de leitura. |
|
Elementos
|
elements | array of DocumentElement_V40 |
Elementos filho da figura, excluindo qualquer legenda ou nota de rodapé. |
|
barra de título
|
caption | DocumentCaption_V30 |
Um objeto que representa o local e o conteúdo de uma legenda de tabela. |
|
Rodapé
|
footnotes | array of DocumentFootnote_V30 |
Lista de notas de rodapé associadas à figura. |
|
id
|
id | string |
ID da figura. |
DocumentSection_V40
Um objeto que representa uma seção no documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
spans
|
spans | array of DocumentSpan_V30 |
Local da seção no conteúdo concatenado da ordem de leitura. |
|
Elementos
|
elements | array of DocumentElement_V40 |
Elementos filho da seção. |
DocumentElement_V40
Um ponteiro JSON que faz referência a um elemento do documento, como parágrafo, tabela, seção etc.
Um ponteiro JSON que faz referência a um elemento do documento, como parágrafo, tabela, seção etc.
Warning_V40
O objeto de erro.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Um de um conjunto definido pelo servidor de códigos de aviso. |
|
mensagem
|
message | string |
Uma representação legível pelo ser humano do aviso. |
|
destino
|
target | string |
O destino do erro. |
ContentFormat_V40
Document_V30
Um objeto que descreve o local e o conteúdo semântico de um documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
docType
|
docType | DocType_V30 |
Nome do tipo de documento. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadoras que abrangem o documento. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local do documento no conteúdo concatenado da ordem de leitura. |
|
fields
|
fields | object |
Dicionário de valores de campo nomeados. |
|
Fields
|
_fields | array of DocumentFieldNameValue_V30 |
Matriz de campos com propriedades fieldName e fieldValue. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
BoundingPolygon_V30
Polígono delimitado, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
number |
BoundingRegion_V30
Delimitando o polígono em uma página específica da entrada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
pageNumber
|
pageNumber | integer |
Número de página com base em 1 página que contém a região delimitadora. |
|
polígono
|
polygon | BoundingPolygon_V30 |
Polígono delimitado, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
DocumentFieldType_V30
DocumentFieldNameValue_V30
Objeto de campo de documento com o nome do campo e seu valor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do campo
|
fieldName | string | |
|
fieldValue
|
fieldValue | DocumentField_V30 |
Um objeto que representa o conteúdo e o local de um valor de campo. |
DocumentField_V30
Um objeto que representa o conteúdo e o local de um valor de campo.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | DocumentFieldType_V30 |
Tipo de dados semânticos do valor do campo. |
|
valueString
|
valueString | string |
Valor da cadeia. |
|
valueDate
|
valueDate | date |
Valor de data no formato YYYY-MM-DD (ISO 8601). |
|
valueTime
|
valueTime | time |
Valor de tempo no formato hh:mm:ss (ISO 8601). |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Valor do número de telefone no formato E.164 (por exemplo, +19876543210). |
|
valueNumber
|
valueNumber | number |
Valor de ponto flutuante. |
|
valueInteger
|
valueInteger | integer |
Valor inteiro. |
|
valueSelectionMark
|
valueSelectionMark | DocumentSelectionMarkState_V30 |
Estado da marca de seleção. |
|
valueSignature
|
valueSignature | string |
Presença de assinatura. |
|
valueCountryRegion
|
valueCountryRegion | string |
Valor de código de país de 3 letras (ISO 3166-1 alfa-3). |
|
valueCurrency
|
valueCurrency | CurrencyValue_V30 |
Valor do campo moeda. |
|
valueAddress
|
valueAddress | AddressValue_V30 |
Valor do campo de endereço. |
|
valueBoolean
|
valueBoolean | boolean |
Valor booliano. |
|
conteúdo
|
content | string |
Conteúdo do campo. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiões delimitadoras que abrangem o campo. |
|
spans
|
spans | array of DocumentSpan_V30 |
Local do campo no conteúdo concatenado da ordem de leitura. |
|
confiança
|
confidence | Confidence_V30 |
Confiança de previsão. |
Confidence_V30
DocType_V30
DocumentSpan_V30
Região contígua da propriedade de conteúdo concatenado, especificada como um deslocamento e comprimento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
deslocamento
|
offset | integer |
Índice baseado em zero do conteúdo representado pelo intervalo. |
|
length
|
length | integer |
Número de caracteres no conteúdo representado pelo intervalo. |
StringIndexType_V30
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.
ModelId_V30
Error_V30
Informações de erro.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código de erro. |
|
mensagem
|
message | string |
Mensagem de erro. |
|
destino
|
target | string |
Destino do erro. |
|
details
|
details | array of InnerError_V30 |
Lista de erros detalhados. |
|
innererror
|
innererror | InnerError_V30 |
Erro detalhado. |
InnerError_V30
Erro detalhado.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código de erro. |
|
mensagem
|
message | string |
Mensagem de erro. |
CurrencyValue_V30
Valor do campo moeda.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
quantidade
|
amount | double |
Valor da moeda. |
|
código de moeda
|
currencyCode | string |
Código de moeda resolvido (ISO 4217), se houver. |
|
currencySymbol
|
currencySymbol | string |
Rótulo de símbolo de moeda, se houver. |
AddressValue_V30
Valor do campo de endereço.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
houseNumber
|
houseNumber | string |
Número da casa ou do prédio. |
|
Pobox
|
poBox | string |
Número da caixa postal. |
|
rodoviário
|
road | string |
Nome da rua. |
|
city
|
city | string |
Nome da cidade, cidade, vila etc. |
|
estado
|
state | string |
Divisão administrativa de primeiro nível. |
|
postalCode
|
postalCode | string |
Código postal usado para classificação de email. |
|
countryRegion
|
countryRegion | string |
País ou região. |
|
endereço de rua
|
streetAddress | string |
Endereço de nível de rua, excluindo cidade, estado, countryRegion e postalCode. |
|
cityDistrict
|
cityDistrict | string |
Distritos ou bairros dentro de uma cidade, como Brooklyn em Nova York ou Cidade de Westminster, em Londres. |
|
casa
|
house | string |
Nome da compilação, como World Trade Center. |
|
nível
|
level | string |
Número do piso, como 3F. |
|
stateDistrict
|
stateDistrict | string |
Divisão administrativa de segundo nível usada em determinadas localidades. |
|
subúrbio
|
suburb | string |
Nome não oficial da vizinhança, como Chinatown. |
|
unidade
|
unit | string |
Número do apartamento ou do escritório. |