Partilhar via


Azure AI Document Intelligence (reconhecedor de formulários)

Extrai texto (OCR impresso e manuscrito) e informações adicionais (tabelas, caixas de seleção, campos / pares de valores-chave) de PDFs, imagens ou documentos e formulários do Microsoft Office 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 alimentada por IA.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Standard Todas as regiões do Power Automatic , exceto as seguintes:
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power - Não disponível
Automatize o poder Standard Todas as regiões do Power Automatic , exceto as seguintes:
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Microsoft
URL https://aka.ms/formrecognizer
Email formrecog_contact@microsoft.com
Metadados do conector
Editora Microsoft
Sítio Web https://aka.ms/formrecognizer
Política de privacidade https://aka.ms/form-recognizer/privacy
Categorias IA; Inteligência de Negócios

O conector Azure AI Document Intelligence (anteriormente Form Recognizer) fornece integração ao Azure AI Document Intelligence. Ele permite analisar e extrair informações de formulários, faturas, recibos, cartões de visita, documentos de identificação e vários outros tipos de documentos.

Pré-requisitos

Para usar essa integração, você precisará de um recurso do Azure AI Document Intelligence no portal do Azure. Criar link de recurso. Você receberá um ponto de extremidade e uma chave para autenticar seus aplicativos. Para estabelecer uma ligação, forneça a chave da conta, o URL do site e selecione Criar ligação. Para saber mais sobre os custos de operação da sua conexão, saiba mais aqui.

Como obter credenciais

  1. Abra o recurso Document Intelligence no portal do Azure (consulte Pré-requisitos).
  2. Selecione Chaves e Ponto Final em Gerenciamento de Recursos
  3. Copie o Ponto Final e a Chave e use-os para criar uma nova conexão.

Introdução ao conector

A maneira mais simples de experimentar o conector Document Intelligence é usar qualquer modelo pré-construído (fatura pré-embutida, layout pré-construído, etc.). Forneça PDF ou imagem do seu documento. Analise usando a operação do conector com base no seu tipo de documento e inspecione os campos detetados. Lista completa de modelos e recursos suportados aqui.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Chave da API Forneça o nome do recurso Document Intellignce e a Chave da API. Todas as regiões Compartilhável
Identidade gerenciada de aplicativos lógicos Criar uma conexão usando uma identidade gerenciada do LogicApps Apenas LOGICAPPS Compartilhável
Microsoft Entra ID Integrado Use o Microsoft Entra ID para acessar Todas as regiões Não compartilhável
Padrão [DEPRECATED] Esta 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 Document Intellignce e a Chave da API.

Esta é 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 de conectores para aplicativos de tela - Power Apps | Documentos Microsoft

Nome Tipo Description Obrigatório
Chave da conta securestring Chave de Conta de Inteligência Documental Verdade
URL do ponto de extremidade cadeia (de caracteres) URL do ponto de extremidade do Document Intelligence (exemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) Verdade

Identidade gerenciada de aplicativos lógicos

ID de autenticação: managedIdentityAuth

Aplicável: apenas LOGICAPPS

Criar uma conexão usando uma identidade gerenciada do LogicApps

Esta é 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 de conectores para aplicativos de tela - Power Apps | Documentos Microsoft

Nome Tipo Description Obrigatório
Identidade gerenciada do LogicApps managedIdentity Entrar com uma identidade gerenciada de aplicativos lógicos Verdade
URL do ponto de extremidade cadeia (de caracteres) 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

Use o Microsoft Entra ID para acessar

Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) URL do ponto de extremidade do Document Intelligence (exemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) Verdade

Padrão [DEPRECATED]

Aplicável: Todas as regiões

Esta 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.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave da conta securestring Chave de Conta de Inteligência Documental Verdade
URL do ponto de extremidade cadeia (de caracteres) URL do ponto de extremidade do Document Intelligence (exemplo: https://your-documentintelligence-resource.cognitiveservices.azure.com/) Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 1200 60 segundos

Ações

Analisar Cartão de Visita (preterido) [PRETERIDO]

Extraia o texto do campo e os valores semânticos de um determinado documento de cartão de visita (preterido).

Analisar documento de identificação (preterido) [PRETERIDO]

Extraia o texto do campo e os valores semânticos de um determinado documento de ID (preterido).

Analisar documento para modelos pré-construídos 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 pré-construídos ou personalizados (API v4.x)

Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (API v4.x).

Analisar fatura (preterido) [PRETERIDO]

Extraia o texto do campo e os 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) [DEPRECATED]

Extraia o texto do campo e os valores semânticos de um determinado documento de recibo (preterido).

Classificar documento com classificador de documentos (API v4.x)

Classifique o documento com o classificador de documentos (API v4.x).

Classificar documento com classificador de documentos (v3.1 API)

Classifique o documento com o classificador de documentos (v3.1 API).

Analisar Cartão de Visita (preterido) [PRETERIDO]

Extraia o texto do campo e os valores semânticos de um determinado documento de cartão de visita (preterido).

Parâmetros

Name Chave Necessário Tipo Description
Incluir detalhes do texto
includeTextDetails boolean

Inclua linhas de texto e referências de elementos no resultado. Padrão: True (apenas para FR Connector).

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações da fatura de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), introduzindo os números de página e os intervalos separados por vírgulas (por exemplo, «2, 5-7»). Se não estiver definido, todas as páginas serão processadas.

Localidade
locale string

Localidade da fatura. A localidade suportada inclui: en-US.

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG ou PNG) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Devoluções

Status e resultado da operação de análise em fila.

Analisar documento de identificação (preterido) [PRETERIDO]

Extraia o texto do campo e os valores semânticos de um determinado documento de ID (preterido).

Parâmetros

Name Chave Necessário Tipo Description
Incluir detalhes do texto
includeTextDetails boolean

Inclua linhas de texto e referências de elementos no resultado. Padrão: True (apenas para FR Connector).

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações da fatura de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), introduzindo os números de página e os intervalos separados por vírgulas (por exemplo, «2, 5-7»). Se não estiver definido, todas as páginas serão processadas.

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG ou PNG) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Devoluções

Status e resultado da operação de análise em fila.

Analisar documento para modelos pré-construídos ou personalizados (API v3.x)

Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (API v3.x).

Parâmetros

Name Chave Necessário Tipo Description
Versão da API de Inteligência Documental
api-version True string

Versão da API de Inteligência Documental.

Identificador do modelo
modelId True string

ModelIds pré-construídos: prebuilt-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 exclusivo do modelo.

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações da fatura de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), introduzindo os números de página e os intervalos separados por vírgulas (por exemplo, «2, 5-7»). Se não estiver definido, todas as páginas serão processadas.

Localidade
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 suportadas: textElements, unicodeCodePoint, utf16CodeUnit.

Funcionalidades opcionais e Premium
features array

Lista de recursos de análise opcionais (como ocrHighResolution, idiomas, códigos de barras, fórmulas, keyValuePairs e styleFont).

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG, PNG, BMP, TIFF) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Devoluções

Status e resultado da operação de análise.

Analisar documento para modelos pré-construídos ou personalizados (API v4.x)

Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (API v4.x).

Parâmetros

Name Chave Necessário Tipo Description
Versão da API de Inteligência Documental
api-version True string

Versão da API de Inteligência Documental.

Identificador do modelo
modelId True string

ModelIds pré-construídos: prebuilt-read, 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 exclusivo do modelo.

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG, PNG, BMP, TIFF) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações da fatura de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), introduzindo os números de página e os intervalos separados por vírgulas (por exemplo, «2, 5-7»). Se não estiver definido, todas as páginas serão processadas.

Localidade
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 suportadas: textElements, unicodeCodePoint, utf16CodeUnit.

Funcionalidades opcionais e Premium
features array

Lista de recursos de análise opcionais (como ocrHighResolution, idiomas, códigos de barras, fórmulas, keyValuePairs, styleFont e queryFields).

Campos de consulta
queryFields array

Lista de campos adicionais a extrair. Ex. "NúmerodeConvidados, Número da Loja"

Formato de conteúdo de saída
outputContentFormat string

Formato do conteúdo de nível superior do resultado da análise.

Devoluções

Status e resultado da operação de análise.

Analisar fatura (preterido) [PRETERIDO]

Extraia o texto do campo e os valores semânticos de um determinado documento de fatura (preterido).

Parâmetros

Name Chave Necessário Tipo Description
Incluir detalhes do texto
includeTextDetails boolean

Inclua linhas de texto e referências de elementos no resultado. Padrão: True (apenas para FR Connector).

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações da fatura de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), introduzindo os números de página e os intervalos separados por vírgulas (por exemplo, «2, 5-7»). Se não estiver definido, todas as páginas serão processadas.

Localidade
locale string

Localidade da fatura. A localidade suportada inclui: en-US.

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG ou PNG) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Devoluções

Status e resultado da operação de análise em fila.

Analisar formulário personalizado (preterido) [PRETERIDO]

Extraia pares chave-valor, tabelas e valores semânticos de um determinado documento (preterido).

Parâmetros

Name Chave Necessário Tipo Description
Identificador do modelo
modelId True string

Formato - uuid. Identificador do modelo.

Incluir detalhes do texto
includeTextDetails boolean

Inclua linhas de texto e referências de elementos no resultado. Padrão: True (apenas para FR Connector).

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações da fatura de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), introduzindo os números de página e os intervalos separados por vírgulas (por exemplo, «2, 5-7»). Se não estiver definido, todas as páginas serão processadas.

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG ou PNG) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Devoluções

Status e resultado da operação de análise em fila.

Analisar layout (preterido) [PRETERIDO]

Extraia informações de texto e layout de um determinado documento (preterido).

Parâmetros

Name Chave Necessário Tipo Description
Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações da fatura de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), introduzindo os números de página e os intervalos separados por vírgulas (por exemplo, «2, 5-7»). Se não estiver definido, todas as páginas serão processadas.

Linguagem
language string

O código linguístico BCP-47 do texto do 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 documento PDF ou arquivo de imagem (JPG ou PNG) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Devoluções

Status e resultado da operação de análise em fila.

Analisar Recibo (preterido) [DEPRECATED]

Extraia o texto do campo e os valores semânticos de um determinado documento de recibo (preterido).

Parâmetros

Name Chave Necessário Tipo Description
Incluir detalhes do texto
includeTextDetails boolean

Inclua linhas de texto e referências de elementos no resultado. Padrão: True (apenas para FR Connector).

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações da fatura de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), introduzindo os números de página e os intervalos separados por vírgulas (por exemplo, «2, 5-7»). Se não estiver definido, todas as páginas serão processadas.

Localidade
locale string

Localidade da fatura. A localidade suportada inclui: en-US.

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG ou PNG) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Devoluções

Status e resultado da operação de análise em fila.

Classificar documento com classificador de documentos (API v4.x)

Classifique o documento com o classificador de documentos (API v4.x).

Parâmetros

Name Chave Necessário Tipo Description
Versão da API de Inteligência Documental
api-version True string

Versão da API de Inteligência Documental.

Identificador do classificador
classifierId True string

Formato - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nome exclusivo do classificador.

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG, PNG, BMP, TIFF) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Modo Split
split string

Comportamento de divisão de ficheiros.

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), inserindo os números de página e os intervalos separados por vírgulas (por exemplo, "2, 5-7"). Se não estiver definido, todas as páginas serão processadas.

Localidade
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 suportadas: textElements, unicodeCodePoint, utf16CodeUnit.

Devoluções

Status e resultado da operação de análise.

Classificar documento com classificador de documentos (v3.1 API)

Classifique o documento com o classificador de documentos (v3.1 API).

Parâmetros

Name Chave Necessário Tipo Description
Identificador do classificador
classifierId True string

Formato - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nome exclusivo do classificador.

Páginas
pages string

A seleção de páginas para documentos PDF e TIFF de várias páginas, para extrair informações de páginas individuais e de um intervalo de páginas (como a página 2 e as páginas 5-7), inserindo os números de página e os intervalos separados por vírgulas (por exemplo, "2, 5-7"). Se não estiver definido, todas as páginas serão processadas.

Localidade
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 suportadas: textElements, unicodeCodePoint, utf16CodeUnit.

Conteúdo do arquivo de documento/imagem
inputFileContent binary

Um documento PDF ou arquivo de imagem (JPG, PNG, BMP, TIFF) para analisar.

URL do documento/imagem
inputFileUrl string

Caminho de url para o arquivo de entrada. Alternativa ao conteúdo do arquivo de documento/imagem.

Devoluções

Status e resultado da operação de análise.

Definições

OperationStatus

Status da operação em fila.

Status da operação em fila.

LayoutAnalyzeOperationResult

Status e resultado da operação de análise em fila.

Name Caminho Tipo Description
estado
status OperationStatus

Status da operação em fila.

createdDateTime
createdDateTime string

Data e hora (UTC) em que a operação de análise foi submetida.

lastUpdatedDateTime
lastUpdatedDateTime string

Data e hora (UTC) em que o estado é atualizado pela última vez.

analyzeResult
analyzeResult LayoutAnalyzeResult

Analise o resultado da operação.

InvoiceAnalyzeOperationResult

Status e resultado da operação de análise em fila.

Name Caminho Tipo Description
estado
status OperationStatus

Status da operação em fila.

createdDateTime
createdDateTime string

Data e hora (UTC) em que a operação de análise foi submetida.

lastUpdatedDateTime
lastUpdatedDateTime string

Data e hora (UTC) em que o estado é atualizado pela última vez.

analyzeResult
analyzeResult InvoiceAnalyzeResult

Analise o resultado da operação.

Cartão de VisitaAnalisarOperaçãoResultado

Status e resultado da operação de análise em fila.

Name Caminho Tipo Description
estado
status OperationStatus

Status da operação em fila.

createdDateTime
createdDateTime string

Data e hora (UTC) em que a operação de análise foi submetida.

lastUpdatedDateTime
lastUpdatedDateTime string

Data e hora (UTC) em que o estado é atualizado pela última vez.

analyzeResult
analyzeResult BusinessCardAnalyzeResult

Analise o resultado da operação.

ReceiptAnalyzeOperationResult

Status e resultado da operação de análise em fila.

Name Caminho Tipo Description
estado
status OperationStatus

Status da operação em fila.

createdDateTime
createdDateTime string

Data e hora (UTC) em que a operação de análise foi submetida.

lastUpdatedDateTime
lastUpdatedDateTime string

Data e hora (UTC) em que o estado é atualizado pela última vez.

analyzeResult
analyzeResult ReceiptAnalyzeResult

Analise o resultado da operação.

IdAnalyzeOperationResult

Status e resultado da operação de análise em fila.

Name Caminho Tipo Description
estado
status OperationStatus

Status da operação em fila.

createdDateTime
createdDateTime string

Data e hora (UTC) em que a operação de análise foi submetida.

lastUpdatedDateTime
lastUpdatedDateTime string

Data e hora (UTC) em que o estado é atualizado pela última vez.

analyzeResult
analyzeResult IdAnalyzeResult

Analise o resultado da operação.

CustomFormsAnalyzeOperationResult

Status e resultado da operação de análise em fila.

Name Caminho Tipo Description
estado
status OperationStatus

Status da operação em fila.

createdDateTime
createdDateTime string

Data e hora (UTC) em que a operação de análise foi submetida.

lastUpdatedDateTime
lastUpdatedDateTime string

Data e hora (UTC) em que o estado é atualizado pela última vez.

analyzeResult
analyzeResult CustomFormsAnalyzeResult

Analise o resultado da operação.

FormOperationError

Erro reportado durante uma operação.

Name Caminho Tipo Description
mensagem
message string

Mensagem de erro.

LayoutAnalyzeResult

Analise o resultado da operação.

Name Caminho Tipo Description
versão
version string

Versão do esquema usado para este resultado.

readResultados
readResults array of ReadResult

Texto extraído da entrada.

páginaResultados
pageResults array of PageResult

Informações no nível da página extraídas da entrada.

erros
errors array of FormOperationError

Lista de erros relatados durante a operação de análise.

InvoiceAnalyzeResult

Analise o resultado da operação.

Name Caminho Tipo Description
versão
version string

Versão do esquema usado para este resultado.

readResultados
readResults array of ReadResult

Texto extraído da entrada.

páginaResultados
pageResults array of PageResult

Informações no nível da página extraídas da entrada.

documentarResultados
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

Analise o resultado da operação.

Name Caminho Tipo Description
versão
version string

Versão do esquema usado para este resultado.

readResultados
readResults array of ReadResult

Texto extraído da entrada.

páginaResultados
pageResults array of PageResult

Informações no nível da página extraídas da entrada.

documentarResultados
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

Analise o resultado da operação.

Name Caminho Tipo Description
versão
version string

Versão do esquema usado para este resultado.

readResultados
readResults array of ReadResult

Texto extraído da entrada.

páginaResultados
pageResults array of PageResult

Informações no nível da página extraídas da entrada.

documentarResultados
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

Analise o resultado da operação.

Name Caminho Tipo Description
versão
version string

Versão do esquema usado para este resultado.

readResultados
readResults array of ReadResult

Texto extraído da entrada.

páginaResultados
pageResults array of PageResult

Informações no nível da página extraídas da entrada.

documentarResultados
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

Analise o resultado da operação.

Name Caminho Tipo Description
versão
version string

Versão do esquema usado para este resultado.

readResultados
readResults array of ReadResult

Texto extraído da entrada.

páginaResultados
pageResults array of PageResult

Informações no nível da página extraídas da entrada.

documentarResultados
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.

Name 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.

altura
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 ordenadas de cima para baixo, da esquerda para a direita, embora em certos casos a proximidade seja tratada com maior prioridade. Como a ordem de classificação depende do texto detetado, ela pode mudar nas imagens e nas atualizações de versão do OCR. Assim, a lógica de negócios deve ser construída sobre a localização real da linha em vez da ordem.

Linha de texto

Um objeto que representa uma linha de texto extraída.

Name Caminho Tipo Description
enviar SMS
text string

O conteúdo do texto da linha.

Caixa de delimitação
boundingBox BoundingBox

Caixa delimitadora quadrangular, com coordenadas especificadas em relação ao canto superior esquerdo da imagem original. Os oito números representam os quatro pontos, no sentido horário a partir do canto superior esquerdo em relação à orientação do 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.

Palavra de texto

Um objeto que representa uma palavra.

Name Caminho Tipo Description
enviar SMS
text string

O conteúdo textual da palavra.

Caixa de delimitação
boundingBox BoundingBox

Caixa delimitadora quadrangular, com coordenadas especificadas em relação ao canto superior esquerdo da imagem original. Os oito números representam os quatro pontos, no sentido horário a partir do canto superior esquerdo em relação à orientação do 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 quadrangular, com coordenadas especificadas em relação ao canto superior esquerdo da imagem original. Os oito números representam os quatro pontos, no sentido horário a partir do canto superior esquerdo em relação à orientação do texto. Para a imagem, as coordenadas (x, y) são medidas em pixels. Para PDF, as coordenadas (x, y) são medidas em polegadas.

Name Caminho Tipo Description
Itens
float

PageResult

Informações extraídas de uma única página.

Name 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.

Name Caminho Tipo Description
etiqueta
label string

Um rótulo definido pelo usuário para a entrada do par chave/valor.

chave
key KeyValueElement

Informações sobre a chave ou o valor extraído em um par chave-valor.

valor
value KeyValueElement

Informações sobre a chave ou o valor extraído em um par chave-valor.

confiança
confidence Confidence

Valor de confiança.

KeyValueElement

Informações sobre a chave ou o valor extraído em um par chave-valor.

Name Caminho Tipo Description
enviar SMS
text string

O conteúdo de texto da chave ou valor.

Caixa de delimitação
boundingBox BoundingBox

Caixa delimitadora quadrangular, com coordenadas especificadas em relação ao canto superior esquerdo da imagem original. Os oito números representam os quatro pontos, no sentido horário a partir do canto superior esquerdo em relação à orientação do 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

Referência a uma linha ou palavra.

Referência a uma linha ou palavra.

Tabela de dados

Informações sobre a tabela extraída contida em uma página.

Name 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.

Name Caminho Tipo Description
rowIndex [en]
rowIndex integer

Índice de linha da célula.

columnIndex
columnIndex integer

Índice da coluna da célula.

rowSpan
rowSpan integer

Número de linhas atravessadas por esta célula.

columnSpan
columnSpan integer

Número de colunas atravessadas por esta célula.

enviar SMS
text string

Conteúdo de texto da célula.

Caixa de delimitação
boundingBox BoundingBox

Caixa delimitadora quadrangular, com coordenadas especificadas em relação ao canto superior esquerdo da imagem original. Os oito números representam os quatro pontos, no sentido horário a partir do canto superior esquerdo em relação à orientação do 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 da tabela.

isHeader
isHeader boolean

Retorne se a célula atual for uma célula de cabeçalho.

isFooter
isFooter boolean

Retorne se a célula atual for uma célula de rodapé.

InvoiceDocumentResult

Um conjunto de campos extraídos correspondentes ao documento de entrada.

Name Caminho Tipo Description
docType
docType string

Tipo de documento.

Intervalo de páginas
pageRange array of integer

Número da primeira e da última página onde o documento se encontra.

campos
fields InvoiceFields

Campos da fatura para 2.1.

BusinessCardDocumentResult

Um conjunto de campos extraídos correspondentes ao documento de entrada.

Name Caminho Tipo Description
docType
docType string

Tipo de documento.

Intervalo de páginas
pageRange array of integer

Número da primeira e da última página onde o documento se encontra.

campos
fields BusinessCardFields

Campos BusinessCard para 2.1.

CustomFormsDocumentResult

Um conjunto de campos extraídos correspondentes ao documento de entrada.

Name Caminho Tipo Description
docType
docType string

Tipo de documento.

Intervalo de páginas
pageRange array of integer

Número da primeira e da última página onde o documento se encontra.

Campos
_fields array of CustomFormsFields

Matriz de campos com propriedades fieldName e fieldValue.

ReceiptDocumentResult

Um conjunto de campos extraídos correspondentes ao documento de entrada.

Name Caminho Tipo Description
docType
docType string

Tipo de documento.

Intervalo de páginas
pageRange array of integer

Número da primeira e da última página onde o documento se encontra.

campos
fields ReceiptFields

Campos de recibo para 2.1.

IdDocumentResult

Um conjunto de campos extraídos correspondentes ao documento de entrada.

Name Caminho Tipo Description
docType
docType string

Tipo de documento.

Intervalo de páginas
pageRange array of integer

Número da primeira e da última página onde o documento se encontra.

campos
fields IdFields

Campos Documento de identificação para 2.1.

CustomFormsFields

Campos Formulário personalizado.

Name Caminho Tipo Description
Nome do campo
fieldName string
Valor de Campo
fieldValue FieldValue

Objeto de valor de campo previsto.

Campos da Fatura

Campos da fatura para 2.1.

Name Caminho Tipo Description
Montante devido (texto)
AmountDue.text string

Devolve o valor devido conforme escrito na fatura.

Montante devido (número)
AmountDue.valueNumber number

Formatado como um número. Exemplo: 1234.98.

Confiança no montante devido
AmountDue.confidence float

Quão confiante o modelo está em sua previsão.

Endereço de faturação
BillingAddress.text string
Confiança no endereço de faturação
BillingAddress.confidence float

Quão confiante o modelo está em sua previsão.

Endereço de faturação do destinatário
BillingAddressRecipient.text string
Confiança do destinatário do endereço de faturação
BillingAddressRecipient.confidence float

Quão confiante o modelo está em sua previsão.

Endereço do cliente
CustomerAddress.text string
Confiança no endereço do cliente
CustomerAddress.confidence float

Quão confiante o modelo está em sua previsão.

Endereço do cliente destinatário
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 na identificação do cliente
CustomerId.confidence float

Quão confiante o modelo está em sua previsão.

Nome do cliente
CustomerName.text string
Confiança no nome do cliente
CustomerName.confidence float

Quão confiante o modelo está em sua previsão.

Data de vencimento (texto)
DueDate.text string

Devolve a data de vencimento conforme escrito na fatura.

Data de vencimento (data)
DueDate.valueDate date

Formatado como uma data. Exemplo: 2019-05-31.

Confiança na data de vencimento
DueDate.confidence float

Quão confiante o modelo está em sua previsão.

Data da fatura (texto)
InvoiceDate.text string

Devolve 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 no ID da fatura
InvoiceId.confidence float

Quão confiante o modelo está em sua previsão.

Total da fatura (texto)
InvoiceTotal.text string

Devolve o total da fatura conforme escrito 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

Devolve o saldo não pago anterior, conforme escrito 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 na ordem de compra
PurchaseOrder.confidence float

Quão confiante o modelo está em sua previsão.

Endereço de envio
RemittanceAddress.text string
Confiança no endereço de remessa
RemittanceAddress.confidence float

Quão confiante o modelo está em sua previsão.

Endereço de remessa destinatário
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 do 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.

Endereço do serviço destinatário
ServiceAddressRecipient.text string
Confiança do destinatário do endereço do serviço
ServiceAddressRecipient.confidence float

Quão confiante o modelo está em sua previsão.

Data de fim do serviço (texto)
ServiceEndDate.text string

Devolve a data de fim do serviço conforme indicado na fatura.

Data de fim do serviço (data)
ServiceEndDate.valueDate date

Formatado como uma data. Exemplo: 2019-05-31.

Confiança na 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

Devolve a data de início do serviço conforme indicado na fatura.

Data de início do serviço (data)
ServiceStartDate.valueDate date

Formatado como uma data. Exemplo: 2019-05-31.

Confiança na data de início do serviço
ServiceStartDate.confidence float

Quão confiante o modelo está em sua previsão.

Endereço de envio
ShippingAddress.text string
Confiança do endereço de envio
ShippingAddress.confidence float

Quão confiante o modelo está em sua previsão.

Endereço de envio destinatário
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

Devolve 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.

Total do imposto (texto)
TotalTax.text string

Devolve o imposto total conforme escrito na fatura.

Total de impostos (número)
TotalTax.valueNumber number

Formatado como um número. Exemplo: 1234.98.

Confiança no 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.

Endereço do fornecedor destinatário
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

Montante (texto)
Items.valueArray.valueObject.Amount.text string

Devolve o valor conforme escrito na fatura.

Montante (número)
Items.valueArray.valueObject.Amount.valueNumber number

Formatado como um número. Exemplo: 12.

Confiança na 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 na 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

Devolve a quantidade conforme escrito na fatura.

Quantidade (número)
Items.valueArray.valueObject.Quantity.valueNumber number

Formatado como um número. Exemplo: 12.

Confiança na quantidade
Items.valueArray.valueObject.Quantity.confidence float

Quão confiante o modelo está em sua previsão.

Preço/ud (texto)
Items.valueArray.valueObject.UnitPrice.text string

Devolve o preço unitário conforme indicado na fatura.

Preço/ud (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 no 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

Data de devolução conforme escrito 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.

Fiscalidade (texto)
Items.valueArray.valueObject.Tax.text string

Declara o imposto conforme escrito na fatura.

Número de contribuinte
Items.valueArray.valueObject.Tax.valueNumber number

Formatado como um número. Exemplo: 12.

Confiança fiscal
Items.valueArray.valueObject.Tax.confidence float

Quão confiante o modelo está em sua previsão.

BusinessCardFields

Campos BusinessCard para 2.1.

Name Caminho Tipo Description
Nomes de contato
ContactNames.valueArray array of object

Matriz de nomes de contato

Nome próprio
ContactNames.valueArray.valueObject.FirstName.text string
Confiança do primeiro nome
ContactNames.valueArray.valueObject.FirstName.confidence float

Quão confiante o modelo está em sua previsão.

Apelido
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 de empresas
CompanyNames.valueArray array of object

Matriz de nomes de empresas

Nome da empresa
CompanyNames.valueArray.text string
Confiança no nome da empresa
CompanyNames.valueArray.confidence float

Quão confiante o modelo está em sua previsão.

Departmentos
Departments.valueArray array of object

Variedade 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.

Cargos
JobTitles.valueArray array of object

Variedade de cargos

Cargo
JobTitles.valueArray.text string
Confiança no cargo
JobTitles.valueArray.confidence float

Quão confiante o modelo está em sua previsão.

E-mails
Emails.valueArray array of object

Variedade de e-mails

Email
Emails.valueArray.text string
Confiança do e-mail
Emails.valueArray.confidence float

Quão confiante o modelo está em sua previsão.

Sites
Websites.valueArray array of object

Variedade de sites

Sítio Web
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

Address
Addresses.valueArray.text string
Confiança de endereço
Addresses.valueArray.confidence float

Quão confiante o modelo está em sua previsão.

Telemóveis
MobilePhones.valueArray array of object

Variedade de telefones celulares

Telemóvel
MobilePhones.valueArray.text string
Confiança do telemóvel
MobilePhones.valueArray.confidence float

Quão confiante o modelo está em sua previsão.

Faxes
Faxes.valueArray array of object

Matriz de faxes

Fax
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

Variedade de telefones de trabalho

Telefone de trabalho
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

Variedade de outros telefones

Outro telefone
OtherPhones.valueArray.text string
Confiança do outro telefone
OtherPhones.valueArray.confidence float

Quão confiante o modelo está em sua previsão.

ReceiptFields

Campos de recibo para 2.1.

Name 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 no 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

Devolve 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 na 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

Devolve o tempo de transação conforme escrito na fatura.

Tempo de transação (time)
TransactionTime.valueDate time

Formatado como uma data. Exemplo: 2019-05-31.

Confiança no tempo de transação
TransactionTime.confidence float

Quão confiante o modelo está em sua previsão.

Total (texto)
Total.text string

Devolve 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

Devolve 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.

Fiscalidade (texto)
Tax.text string

Declara o imposto conforme escrito na fatura.

Número de contribuinte
Tax.valueNumber number

Formatado como um número. Exemplo: 1234.98.

Confiança fiscal
Tax.confidence float

Quão confiante o modelo está em sua previsão.

Dica (texto)
Tip.text string

Devolve gorjeta conforme escrito na fatura.

Dica (número)
Tip.valueNumber number

Formatado como um número. Exemplo: 1234.98.

Confiança na ponta
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 no 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

Devolve a quantidade conforme escrito na fatura.

Quantidade (número)
Items.valueArray.valueObject.Quantity.valueNumber number

Formatado como um número. Exemplo: 12.

Confiança na 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

Devolve 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 no 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

Devolve 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 no preço total
Items.valueArray.valueObject.TotalPrice.confidence float

Quão confiante o modelo está em sua previsão.

IdFields

Campos Documento de identificação para 2.1.

Name Caminho Tipo Description
Região do País
CountryRegion.valueCountryRegion string
Confiança do País Região
CountryRegion.confidence float

Quão confiante o modelo está em sua previsão.

Data de expiração
DateOfExpiration.text string

Devolve a data de validade conforme escrito na fatura.

Data de expiração (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

Devolve a data de nascimento conforme indicado na fatura.

Data de nascimento (data)
DateOfBirth.valueDate date

Formatado como uma data. Exemplo: 2019-05-31.

Confiança na 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 no número do documento
DocumentNumber.confidence float

Quão confiante o modelo está em sua previsão.

Nome próprio
FirstName.text string
Confiança do primeiro nome
FirstName.confidence float

Quão confiante o modelo está em sua previsão.

Apelido
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 na nacionalidade
Nationality.confidence float

Quão confiante o modelo está em sua previsão.

Sex
Sex.text string
Confiança no sexo
Sex.confidence float

Quão confiante o modelo está em sua previsão.

Zona de leitura ótica
MachineReadableZone.text string
Confiança da zona de leitura ótica
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.

Address
Address.text string
Confiança de 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.

Valor do campo

Objeto de valor de campo previsto.

Name Caminho Tipo Description
tipo
type FieldValueType

Tipo de dados semânticos do valor do campo.

valueString
valueString string

Valor da cadeia de caracteres.

Data-Valor
valueDate date-time

Valor da data.

valorTempo
valueTime date-time

Valor do tempo.

valorTelefoneNúmero
valuePhoneNumber string

Valor do número de telefone.

valorNúmero
valueNumber number

Valor de ponto flutuante.

valorInteiro
valueInteger integer

Valor inteiro.

enviar SMS
text string
Caixa de delimitação
boundingBox BoundingBox

Caixa delimitadora quadrangular, com coordenadas especificadas em relação ao canto superior esquerdo da imagem original. Os oito números representam os quatro pontos, no sentido horário a partir do canto superior esquerdo em relação à orientação do 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

Tipo de dados semânticos do valor do campo.

Tipo de dados semânticos do valor do campo.

Confiança

Valor de confiança.

Valor de confiança.

ApiVersion_V30

Versão da API.

Versão da API.

AnalyzeResultOperation_V30

Status e resultado da operação de análise.

Name Caminho Tipo Description
estado
status string

Estado da operação.

createdDateTime
createdDateTime date-time

Data e hora (UTC) em que a operação de análise foi enviada.

lastUpdatedDateTime
lastUpdatedDateTime date-time

Data e hora (UTC) em que o estado foi atualizado pela última vez.

erro
error Error_V30

Informações de erro.

analyzeResult
analyzeResult AnalyzeResult_V30

Resultado da análise documental.

AnalyzeResult_V30

Resultado da análise documental.

Name Caminho Tipo Description
apiVersion
apiVersion ApiVersion_V30

Versão da API.

modelId
modelId ModelId_V30

Nome exclusivo do modelo.

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 em ordem de leitura.

contentFormat
contentFormat ContentFormat_V40

Formato do conteúdo no resultado analisado.

pages
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.

Números
figures array of DocumentFigure_V40

Números extraídos.

secções
sections array of DocumentSection_V40

Secções extraídas.

keyValuePairs
keyValuePairs array of DocumentKeyValuePair_V30

Pares chave-valor extraídos.

entidades
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 detetados.

Documentação
documents array of Document_V30

Documentos extraídos.

Advertências
warnings array of Warning_V40

Lista de avisos encontrados.

DocumentPage_V30

Elementos de conteúdo e layout extraídos de uma página da entrada.

Name Caminho Tipo Description
tipo
kind string

Tipo de página do documento.

Número da página
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.

altura
height number

A altura da imagem/PDF em pixels/polegadas, respectivamente.

unidade
unit string

A unidade usada pelas propriedades de largura, altura e polígono. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".

spans
spans array of DocumentSpan_V30

Localização da página na ordem de leitura conteúdo concatenado.

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 não delimitados por espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra.

Name Caminho Tipo Description
conteúdo
content string

Conteúdo textual da palavra.

polygon
polygon BoundingPolygon_V30

Polígono delimitador, com coordenadas especificadas em relação ao canto superior esquerdo da página. Os números representam os valores x, y dos vértices do polígono, no sentido horário a partir da esquerda (-180 graus inclusive) em relação à orientação do elemento.

span
span DocumentSpan_V30

Região contígua da propriedade de conteúdo concatenado, especificada como deslocamento e comprimento.

confiança
confidence Confidence_V30

Confiança na 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.

Name Caminho Tipo Description
state
state DocumentSelectionMarkState_V30

Estado da marca de seleção.

polygon
polygon BoundingPolygon_V30

Polígono delimitador, com coordenadas especificadas em relação ao canto superior esquerdo da página. Os números representam os valores x, y dos vértices do polígono, no sentido horário a partir da esquerda (-180 graus inclusive) em relação à orientação do elemento.

span
span DocumentSpan_V30

Região contígua da propriedade de conteúdo concatenado, especificada como deslocamento e comprimento.

confiança
confidence Confidence_V30

Confiança na previsão.

DocumentImage_V30

Um objeto de imagem detetado na página.

Name Caminho Tipo Description
polygon
polygon BoundingPolygon_V30

Polígono delimitador, com coordenadas especificadas em relação ao canto superior esquerdo da página. Os números representam os valores x, y dos vértices do polígono, no sentido horário a partir da esquerda (-180 graus inclusive) em relação à orientação do elemento.

span
span DocumentSpan_V30

Região contígua da propriedade de conteúdo concatenado, especificada como 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 na previsão.

DocumentSelectionMarkState_V30

Estado da marca de seleção.

Estado da marca de seleção.

DocumentStyle_V30

Um objeto que representa estilos de texto observados.

Name Caminho Tipo Description
backgroundColor
backgroundColor string

Cor de fundo em #rrggbb formato hexadecimal..

color
color string

Cor de primeiro plano em #rrggbb formato hexadecimal.

fontStyle
fontStyle string

Estilo da fonte.

fontWeight
fontWeight string

Espessura da fonte.

isManuscrito
isHandwritten boolean

O conteúdo é escrito à mão.

similarFontFamily
similarFontFamily string

Fonte visualmente mais semelhante entre o conjunto de famílias de fontes suportadas, com fontes de fallback seguindo a convenção CSS (ex. 'Arial, sans-serif').

spans
spans array of DocumentSpan_V30

Localização dos elementos de texto no conteúdo concatenado ao qual o estilo se aplica.

confiança
confidence Confidence_V30

Confiança na previsão.

DocumentLanguage_V30

Um objeto que representa o idioma detetado para uma determinada extensão de texto.

Name Caminho Tipo Description
região
locale string

Idioma detetado. O valor pode ser um código de idioma ISO 639-1 (ex. "en", "fr") ou uma marca de idioma BCP 47 (ex. "zh-Hans").

spans
spans array of DocumentSpan_V30

Localização dos elementos de texto no conteúdo concatenado ao qual o idioma se aplica.

confiança
confidence Confidence_V30

Confiança na 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.

Name Caminho Tipo Description
conteúdo
content string

Conteúdo concatenado dos elementos contidos em ordem de leitura.

polygon
polygon BoundingPolygon_V30

Polígono delimitador, com coordenadas especificadas em relação ao canto superior esquerdo da página. Os números representam os valores x, y dos vértices do polígono, no sentido horário a partir da esquerda (-180 graus inclusive) em relação à orientação do elemento.

spans
spans array of DocumentSpan_V30

Localização da linha na ordem de leitura conteúdo concatenado.

DocumentParagraph_V30

Um objeto de parágrafo que consiste em linhas contíguas, geralmente com alinhamento e espaçamento comuns.

Name Caminho Tipo Description
função
role string

Papel semântico do parágrafo.

conteúdo
content string

Conteúdo concatenado do parágrafo em ordem de leitura.

boundingRegions
boundingRegions array of BoundingRegion_V30

Regiões delimitadoras que abrangem o parágrafo.

spans
spans array of DocumentSpan_V30

Localização do parágrafo na ordem de leitura conteúdo concatenado.

DocumentTable_V30

Um objeto de tabela que consiste em células de tabela organizadas em um layout retangular.

Name 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.

legenda
caption DocumentCaption_V30

Um objeto que representa o local e o conteúdo de uma legenda de tabela.

Notas de rodapé
footnotes array of DocumentFootnote_V30

Notas de rodapé associadas à tabela.

boundingRegions
boundingRegions array of BoundingRegion_V30

Regiões delimitadoras cobrindo a tabela.

spans
spans array of DocumentSpan_V30

Localização da tabela na ordem de leitura conteúdo concatenado.

DocumentTableCell_V30

Um objeto que representa o local e o conteúdo de uma célula da tabela.

Name Caminho Tipo Description
tipo
kind string

Tipo de célula da tabela.

rowIndex [en]
rowIndex integer

Índice de linha da célula.

columnIndex
columnIndex integer

Índice da coluna da célula.

rowSpan
rowSpan integer

Número de linhas atravessadas por esta célula.

columnSpan
columnSpan integer

Número de colunas atravessadas por esta célula.

conteúdo
content string

Conteúdo concatenado da célula da tabela em ordem de leitura.

boundingRegions
boundingRegions array of BoundingRegion_V30

Regiões delimitadoras que cobrem a célula da tabela.

spans
spans array of DocumentSpan_V30

Localização da célula da tabela na ordem de leitura conteúdo concatenado.

DocumentCaption_V30

Um objeto que representa o local e o conteúdo de uma legenda de tabela.

Name Caminho Tipo Description
conteúdo
content string

Conteúdo da legenda da tabela.

boundingRegions
boundingRegions array of BoundingRegion_V30

Regiões delimitadoras que cobrem a legenda da tabela.

spans
spans array of DocumentSpan_V30

Localização da legenda da tabela na ordem de leitura conteúdo concatenado.

DocumentFootnote_V30

Um objeto que representa o local e o conteúdo de uma nota de rodapé da tabela.

Name Caminho Tipo Description
conteúdo
content string

Conteúdo da nota de rodapé da tabela.

boundingRegions
boundingRegions array of BoundingRegion_V30

Regiões delimitadoras que abrangem a nota de rodapé da tabela.

spans
spans array of DocumentSpan_V30

Localização da nota de rodapé da tabela na ordem de leitura conteúdo concatenado.

DocumentKeyValuePair_V30

Um objeto que representa um campo de formulário com rótulo de campo (chave) e valor de campo distintos (pode estar vazio).

Name Caminho Tipo Description
chave
key DocumentKeyValueElement_V30

Um objeto que representa a chave de campo ou o valor em um par chave-valor.

valor
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 na previsão.

DocumentKeyValueElement_V30

Um objeto que representa a chave de campo ou o valor em um par chave-valor.

Name 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

Localização do elemento chave-valor no conteúdo concatenado da ordem de leitura.

DocumentEntity_V30

Um objeto que representa várias categorias de entidades.

Name 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

Localização da entidade na ordem de leitura conteúdo concatenado.

confiança
confidence Confidence_V30

Confiança na previsão.

DocumentBarcode_V31

Um objeto de código de barras.

Name Caminho Tipo Description
confiança
confidence Confidence_V30

Confiança na previsão.

tipo
kind string

Tipo de código de barras.

polygon
polygon BoundingPolygon_V30

Polígono delimitador, com coordenadas especificadas em relação ao canto superior esquerdo da página. Os números representam os valores x, y dos vértices do polígono, no sentido horário a partir da esquerda (-180 graus inclusive) em relação à orientação do elemento.

span
span DocumentSpan_V30

Região contígua da propriedade de conteúdo concatenado, especificada como deslocamento e comprimento.

valor
value string

Valor do código de barras

DocumentFormula_V31

Um objeto de fórmula.

Name Caminho Tipo Description
confiança
confidence Confidence_V30

Confiança na previsão.

tipo
kind string

Tipo de fórmula.

polygon
polygon BoundingPolygon_V30

Polígono delimitador, com coordenadas especificadas em relação ao canto superior esquerdo da página. Os números representam os valores x, y dos vértices do polígono, no sentido horário a partir da esquerda (-180 graus inclusive) em relação à orientação do elemento.

span
span DocumentSpan_V30

Região contígua da propriedade de conteúdo concatenado, especificada como deslocamento e comprimento.

valor
value string

Expressão LaTex que descreve a fórmula.

DocumentFigure_V40

Um objeto que representa uma figura no documento.

Name Caminho Tipo Description
boundingRegions
boundingRegions array of BoundingRegion_V30

Regiões delimitadoras cobrindo a figura.

spans
spans array of DocumentSpan_V30

Localização da figura na ordem de leitura conteúdo concatenado.

elementos
elements array of DocumentElement_V40

Elementos filhos da figura, excluindo qualquer legenda ou notas de rodapé.

legenda
caption DocumentCaption_V30

Um objeto que representa o local e o conteúdo de uma legenda de tabela.

Notas de 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.

Name Caminho Tipo Description
spans
spans array of DocumentSpan_V30

Localização da seção na ordem de leitura conteúdo concatenado.

elementos
elements array of DocumentElement_V40

Elementos filho da secção.

DocumentElement_V40

Um ponteiro JSON fazendo referência a um elemento do documento, como parágrafo, tabela, seção, etc.

Um ponteiro JSON fazendo referência a um elemento do documento, como parágrafo, tabela, seção, etc.

Warning_V40

O objeto de erro.

Name Caminho Tipo Description
código
code string

Um de um conjunto de códigos de aviso definido pelo servidor.

mensagem
message string

Uma representação legível por humanos do aviso.

destino
target string

O alvo do erro.

ContentFormat_V40

Formato do conteúdo no resultado analisado.

Formato do conteúdo no resultado analisado.

Document_V30

Um objeto que descreve a localização e o conteúdo semântico de um documento.

Name 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

Localização do documento na ordem de leitura conteúdo concatenado.

campos
fields object

Dicionário de valores de campos nomeados.

Campos
_fields array of DocumentFieldNameValue_V30

Matriz de campos com propriedades fieldName e fieldValue.

confiança
confidence Confidence_V30

Confiança na previsão.

BoundingPolygon_V30

Polígono delimitador, com coordenadas especificadas em relação ao canto superior esquerdo da página. Os números representam os valores x, y dos vértices do polígono, no sentido horário a partir da esquerda (-180 graus inclusive) em relação à orientação do elemento.

Name Caminho Tipo Description
Itens
number

BoundingRegion_V30

Polígono delimitador em uma página específica da entrada.

Name Caminho Tipo Description
Número da página
pageNumber integer

Número de página baseado em 1 página que contém a região delimitadora.

polygon
polygon BoundingPolygon_V30

Polígono delimitador, com coordenadas especificadas em relação ao canto superior esquerdo da página. Os números representam os valores x, y dos vértices do polígono, no sentido horário a partir da esquerda (-180 graus inclusive) em relação à orientação do elemento.

DocumentFieldType_V30

Tipo de dados semânticos do valor do campo.

Tipo de dados semânticos do valor do campo.

DocumentFieldNameValue_V30

Objeto de campo de documento com nome de campo e seu valor.

Name 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.

Name Caminho Tipo Description
tipo
type DocumentFieldType_V30

Tipo de dados semânticos do valor do campo.

valueString
valueString string

Valor da cadeia de caracteres.

Data-Valor
valueDate date

Valor de data no formato AAAA-MM-DD (ISO 8601).

valorTempo
valueTime time

Valor de tempo no formato hh:mm:ss (ISO 8601).

valorTelefoneNúmero
valuePhoneNumber string

Valor do número de telefone no formato E.164 (ex. +19876543210).

valorNúmero
valueNumber number

Valor de ponto flutuante.

valorInteiro
valueInteger integer

Valor inteiro.

valorSeleçãoMarca
valueSelectionMark DocumentSelectionMarkState_V30

Estado da marca de seleção.

valorAssinatura
valueSignature string

Presença de assinatura.

valorPaísRegião
valueCountryRegion string

Valor do código de país de 3 letras (ISO 3166-1 alpha-3).

valorMoeda
valueCurrency CurrencyValue_V30

Valor do campo de moeda.

valueAddress
valueAddress AddressValue_V30

Valor do campo Endereço.

valorBooleano
valueBoolean boolean

Valor booleano.

conteúdo
content string

Conteúdo do campo.

boundingRegions
boundingRegions array of BoundingRegion_V30

Regiões delimitadoras que cobrem o campo.

spans
spans array of DocumentSpan_V30

Localização do campo na ordem de leitura conteúdo concatenado.

confiança
confidence Confidence_V30

Confiança na previsão.

Confidence_V30

Confiança na previsão.

Confiança na previsão.

DocType_V30

Nome do tipo de documento.

Nome do tipo de documento.

DocumentSpan_V30

Região contígua da propriedade de conteúdo concatenado, especificada como deslocamento e comprimento.

Name Caminho Tipo Description
offset
offset integer

Índice baseado em zero do conteúdo representado pela extensão.

length
length integer

Número de caracteres no conteúdo representado pela extensão.

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

Nome exclusivo do modelo.

Nome exclusivo do modelo.

Error_V30

Informações de erro.

Name Caminho Tipo Description
código
code string

Código de erro.

mensagem
message string

Mensagem de erro.

destino
target string

Alvo do erro.

details
details array of InnerError_V30

Lista de erros detalhados.

innererror
innererror InnerError_V30

Erro detalhado.

InnerError_V30

Erro detalhado.

Name Caminho Tipo Description
código
code string

Código de erro.

mensagem
message string

Mensagem de erro.

CurrencyValue_V30

Valor do campo de moeda.

Name Caminho Tipo Description
Montante
amount double

Valor da moeda.

código da moeda
currencyCode string

Código de moeda resolvido (ISO 4217), se houver.

currencySymbol
currencySymbol string

Rótulo do símbolo da moeda, se houver.

AddressValue_V30

Valor do campo Endereço.

Name Caminho Tipo Description
número da casa
houseNumber string

Número da casa ou edifício.

poBox
poBox string

Número da caixa postal.

estrada
road string

Nome da rua.

city
city string

Nome da cidade, vila, aldeia, etc.

state
state string

Divisão administrativa de primeiro nível.

postalCode
postalCode string

Código postal utilizado para a triagem de correio.

paísRegião
countryRegion string

País ou região.

endereço de rua
streetAddress string

Endereço no nível da rua, excluindo cidade, estado, paísRegião e código postal.

cidadeDistrito
cityDistrict string

Distritos ou distritos dentro de uma cidade, como Brooklyn em Nova York ou City of Westminster em Londres.

Casa
house string

Nome da construção, como World Trade Center.

nível
level string

Número do andar, como 3F.

estadoDistrito
stateDistrict string

Divisão administrativa de segundo nível usada em determinadas localidades.

subúrbio
suburb string

Nome de bairro não oficial, como Chinatown.

unidade
unit string

Número do apartamento ou escritório.