Document Classifiers - Get Classify Result

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-07-31-preview

Obtém o resultado do classificador de documentos.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-07-31-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
classifierId	path	True	string	Nome exclusivo do classificador de documentos. Padrão Regex: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
endpoint	path	True	string uri	O ponto de extremidade do serviço de Inteligência de Documentos.
resultId	path	True	string uuid	Analise o ID do resultado da operação.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	AnalyzeResultOperation	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

Name	Description
https://cognitiveservices.azure.com/.default

Exemplos

Get Classify Document Result

Pedido de amostra

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview

Resposta da amostra

Código de estado:: 200

{
  "status": "succeeded",
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "analyzeResult": {
    "apiVersion": "2024-07-31-preview",
    "modelId": "myClassifier",
    "stringIndexType": "textElements",
    "contentFormat": "text",
    "content": "",
    "pages": [
      {
        "pageNumber": 1,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 2,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 3,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      }
    ],
    "documents": [
      {
        "docType": "formA",
        "boundingRegions": [
          {
            "pageNumber": 1,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          },
          {
            "pageNumber": 2,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      },
      {
        "docType": "formB",
        "boundingRegions": [
          {
            "pageNumber": 3,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      }
    ]
  }
}

Definições

Name	Description
AddressValue	Valor do campo Endereço.
AnalyzeResult	Resultado da análise documental.
AnalyzeResultOperation	Status e resultado da operação de análise.
BoundingRegion	Polígono delimitador em uma página específica da entrada.
ContentFormat	Formato do conteúdo no resultado analisado.
CurrencyValue	Valor do campo de moeda.
Document	Um objeto que descreve a localização e o conteúdo semântico de um documento.
DocumentBarcode	Um objeto de código de barras.
DocumentBarcodeKind	Tipo de código de barras.
DocumentCaption	Um objeto caption que descreve uma tabela ou figura.
DocumentField	Um objeto que representa o conteúdo e o local de um valor de campo.
DocumentFieldType	Tipo de dados semânticos do valor do campo.
DocumentFigure	Um objeto que representa uma figura no documento.
DocumentFootnote	Um objeto de nota de rodapé que descreve uma tabela ou figura.
DocumentFormula	Um objeto de fórmula.
DocumentFormulaKind	Tipo de fórmula.
DocumentKeyValueElement	Um objeto que representa a chave de campo ou o valor em um par chave-valor.
DocumentKeyValuePair	Um objeto que representa um campo de formulário com rótulo de campo (chave) e valor de campo distintos (pode estar vazio).
DocumentLanguage	Um objeto que representa o idioma detetado para uma determinada extensão de texto.
DocumentLine	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.
DocumentPage	Elementos de conteúdo e layout extraídos de uma página da entrada.
DocumentParagraph	Um objeto de parágrafo que consiste em linhas contíguas, geralmente com alinhamento e espaçamento comuns.
DocumentSection	Um objeto que representa uma seção no documento.
DocumentSelectionMark	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.
DocumentSelectionMarkState	Estado da marca de seleção.
DocumentSignatureType	Presença de assinatura.
DocumentSpan	Região contígua da propriedade de conteúdo concatenado, especificada como deslocamento e comprimento.
DocumentStyle	Um objeto que representa estilos de texto observados.
DocumentTable	Um objeto de tabela que consiste em células de tabela organizadas em um layout retangular.
DocumentTableCell	Um objeto que representa o local e o conteúdo de uma célula da tabela.
DocumentTableCellKind	Tipo de célula da tabela.
DocumentWord	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.
Error	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
FontStyle	Estilo da fonte.
FontWeight	Espessura da fonte.
InnerError	Um objeto que contém informações mais específicas sobre o erro.
LengthUnit	A unidade usada pelas propriedades de largura, altura e polígono. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".
OperationStatus	Estado da operação.
ParagraphRole	Papel semântico do parágrafo.
StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.
Warning	O objeto de erro.

AddressValue

Valor do campo Endereço.

Name	Tipo	Description
city	string	Nome da cidade, vila, aldeia, etc.
cityDistrict	string	Distritos ou distritos dentro de uma cidade, como Brooklyn em Nova York ou City of Westminster em Londres.
countryRegion	string	País/região.
house	string	Nome da construção, como World Trade Center.
houseNumber	string	Número da casa ou edifício.
level	string	Número do andar, como 3F.
poBox	string	Número da caixa postal.
postalCode	string	Código postal utilizado para a triagem de correio.
road	string	Nome da rua.
state	string	Divisão administrativa de primeiro nível.
stateDistrict	string	Divisão administrativa de segundo nível usada em determinadas localidades.
streetAddress	string	Endereço no nível da rua, excluindo cidade, estado, paísRegião e código postal.
suburb	string	Nome de bairro não oficial, como Chinatown.
unit	string	Número do apartamento ou escritório

AnalyzeResult

Resultado da análise documental.

Name	Tipo	Description
apiVersion	string	Versão da API usada para produzir esse resultado.
content	string	Concatenar a representação de cadeia de caracteres de todos os elementos textuais e visuais em ordem de leitura.
contentFormat	ContentFormat	Formato do conteúdo de nível superior do resultado da análise.
documents	Document[]	Documentos extraídos.
figures	DocumentFigure[]	Números extraídos.
keyValuePairs	DocumentKeyValuePair[]	Pares chave-valor extraídos.
languages	DocumentLanguage[]	Idiomas detetados.
modelId	string	ID do modelo de documento usado para produzir esse resultado.
pages	DocumentPage[]	Páginas analisadas.
paragraphs	DocumentParagraph[]	Parágrafos extraídos.
sections	DocumentSection[]	Secções extraídas.
stringIndexType	StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.
styles	DocumentStyle[]	Estilos de fonte extraídos.
tables	DocumentTable[]	Tabelas extraídas.
warnings	Warning[]	Lista de avisos encontrados.

AnalyzeResultOperation

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

Name	Tipo	Description
analyzeResult	AnalyzeResult	Resultado da análise documental.
createdDateTime	string	Data e hora (UTC) em que a operação de análise foi enviada.
error	Error	Erro encontrado durante a análise do documento.
lastUpdatedDateTime	string	Data e hora (UTC) em que o estado foi atualizado pela última vez.
status	OperationStatus	Estado da operação. notIniciado, em execução, bem-sucedido ou com falha

BoundingRegion

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

Name	Tipo	Description
pageNumber	integer	Número de página baseado em 1 página que contém a região delimitadora.
polygon	number[]	Polígono delimitador na página ou a página inteira, se não for especificado. 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.

ContentFormat

Formato do conteúdo no resultado analisado.

Name	Tipo	Description
markdown	string	Representação Markdown do conteúdo do documento com títulos de seção, tabelas, etc.
text	string	Representação em texto simples do conteúdo do documento sem qualquer formatação.

CurrencyValue

Valor do campo de moeda.

Name	Tipo	Description
amount	number	Valor da moeda.
currencyCode	string	Código de moeda resolvido (ISO 4217), se houver.
currencySymbol	string	Rótulo do símbolo da moeda, se houver.

Document

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

Name	Tipo	Description
boundingRegions	BoundingRegion[]	Regiões delimitadoras que abrangem o documento.
confidence	number	Confiança de extrair corretamente o documento.
docType	string	Tipo de documento.
fields	<string, DocumentField>	Dicionário de valores de campos nomeados.
spans	DocumentSpan[]	Localização do documento na ordem de leitura conteúdo concatenado.

DocumentBarcode

Um objeto de código de barras.

Name	Tipo	Description
confidence	number	Confiança de extrair corretamente o código de barras.
kind	DocumentBarcodeKind	Tipo de código de barras.
polygon	number[]	Polígono delimitador do código de barras, 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	DocumentSpan	Localização do código de barras na ordem de leitura conteúdo concatenado.
value	string	Valor do código de barras.

DocumentBarcodeKind

Tipo de código de barras.

Name	Tipo	Description
Aztec	string	Código asteca, conforme definido na ISO/IEC 24778:2008.
Codabar	string	Código de barras Codabar, tal como definido na norma ANSI/AIM BC3-1995.
Code128	string	Código de barras 128, conforme definido na ISO/IEC 15417:2007.
Code39	string	Código de barras 39, conforme definido na ISO/IEC 16388:2007.
Code93	string	Código de barras 93, tal como definido na norma ANSI/AIM BC5-1995.
DataBar	string	Código de barras GS1 DataBar.
DataBarExpanded	string	Código de barras expandido GS1 DataBar.
DataMatrix	string	Código da matriz de dados, conforme definido na ISO/IEC 16022:2006.
EAN13	string	GS1 Número internacional do artigo de 13 dígitos (número do artigo europeu).
EAN8	string	GS1 Número internacional do artigo de 8 dígitos (Número do artigo europeu).
ITF	string	Intercalado 2 de 5 código de barras, conforme definido em ANSI/AIM BC2-1995.
MaxiCode	string	MaxiCode, conforme definido na ISO/IEC 16023:2000.
MicroQRCode	string	Micro código QR, conforme definido na ISO/IEC 23941:2022.
PDF417	string	PDF417, conforme definido na ISO 15438.
QRCode	string	Código QR, conforme definido na ISO/IEC 18004:2015.
UPCA	string	Código Universal do Produto GS1 de 12 dígitos.
UPCE	string	Código Universal do Produto GS1 de 6 dígitos.

DocumentCaption

Um objeto caption que descreve uma tabela ou figura.

Name	Tipo	Description
boundingRegions	BoundingRegion[]	Regiões delimitadoras cobrindo a legenda.
content	string	Conteúdo da legenda.
elements	string[]	Elementos filho da legenda.
spans	DocumentSpan[]	Localização da legenda na ordem de leitura conteúdo concatenado.

DocumentField

Um objeto que representa o conteúdo e o local de um valor de campo.

Name	Tipo	Description
boundingRegions	BoundingRegion[]	Regiões delimitadoras que cobrem o campo.
confidence	number	Confiança de extrair corretamente o campo.
content	string	Conteúdo do campo.
spans	DocumentSpan[]	Localização do campo na ordem de leitura conteúdo concatenado.
type	DocumentFieldType	Tipo de dados do valor do campo.
valueAddress	AddressValue	Valor do endereço.
valueArray	DocumentField[]	Matriz de valores de campo.
valueBoolean	boolean	Valor booleano.
valueCountryRegion	string	Valor do código de país de 3 letras (ISO 3166-1 alpha-3).
valueCurrency	CurrencyValue	Valor da moeda.
valueDate	string	Valor de data no formato AAAA-MM-DD (ISO 8601).
valueInteger	integer	Valor inteiro.
valueNumber	number	Valor de ponto flutuante.
valueObject	<string, DocumentField>	Dicionário de valores de campos nomeados.
valuePhoneNumber	string	Valor do número de telefone no formato E.164 (ex. +19876543210).
valueSelectionGroup	string[]	Valor do grupo de seleção.
valueSelectionMark	DocumentSelectionMarkState	Valor da marca de seleção.
valueSignature	DocumentSignatureType	Presença de assinatura.
valueString	string	Valor da cadeia de caracteres.
valueTime	string	Valor de tempo no formato hh:mm:ss (ISO 8601).

DocumentFieldType

Tipo de dados semânticos do valor do campo.

Name	Tipo	Description
address	string	Endereço analisado.
array	string	Lista de subcampos do mesmo tipo.
boolean	string	Valor booleano, normalizado para verdadeiro ou falso.
countryRegion	string	País/região, normalizado para o formato ISO 3166-1 alpha-3 (ex. EUA).
currency	string	Valor da moeda com símbolo e unidade de moeda opcionais.
date	string	Data, normalizada para o formato ISO 8601 (AAAA-MM-DD).
integer	string	Número inteiro, normalizado para inteiro assinado de 64 bits.
number	string	Número de ponto flutuante, normalizado para ponto flutuante de precisão dupla.
object	string	Lista nomeada de subcampos de tipos potencialmente diferentes.
phoneNumber	string	Número de telefone, normalizado para o formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matriz de valores de cadeia de caracteres selecionados.
selectionMark	string	O campo está selecionado?
signature	string	A assinatura está presente?
string	string	Texto simples.
time	string	Tempo, normalizado para o formato ISO 8601 (hh:mm:ss).

DocumentFigure

Um objeto que representa uma figura no documento.

Name	Tipo	Description
boundingRegions	BoundingRegion[]	Regiões delimitadoras cobrindo a figura.
caption	DocumentCaption	Legenda associada à figura.
elements	string[]	Elementos filhos da figura, excluindo qualquer legenda ou notas de rodapé.
footnotes	DocumentFootnote[]	Lista de notas de rodapé associadas à figura.
id	string	ID da figura.
spans	DocumentSpan[]	Localização da figura na ordem de leitura conteúdo concatenado.

DocumentFootnote

Um objeto de nota de rodapé que descreve uma tabela ou figura.

Name	Tipo	Description
boundingRegions	BoundingRegion[]	Regiões delimitadoras que abrangem a nota de rodapé.
content	string	Conteúdo da nota de rodapé.
elements	string[]	Elementos filho da nota de rodapé.
spans	DocumentSpan[]	Localização da nota de rodapé na ordem de leitura conteúdo concatenado.

DocumentFormula

Um objeto de fórmula.

Name	Tipo	Description
confidence	number	Confiança de extrair corretamente a fórmula.
kind	DocumentFormulaKind	Tipo de fórmula.
polygon	number[]	Polígono delimitador da fórmula, 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	DocumentSpan	Localização da fórmula na ordem de leitura conteúdo concatenado.
value	string	Expressão LaTex que descreve a fórmula.

DocumentFormulaKind

Tipo de fórmula.

Name	Tipo	Description
display	string	Uma fórmula no modo de exibição que ocupa uma linha inteira.
inline	string	Uma fórmula incorporada no conteúdo de um parágrafo.

DocumentKeyValueElement

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

Name	Tipo	Description
boundingRegions	BoundingRegion[]	Regiões delimitadoras que abrangem o elemento chave-valor.
content	string	Conteúdo concatenado do elemento chave-valor na ordem de leitura.
spans	DocumentSpan[]	Localização do elemento chave-valor no conteúdo concatenado da ordem de leitura.

DocumentKeyValuePair

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

Name	Tipo	Description
confidence	number	Confiança de extrair corretamente o par chave-valor.
key	DocumentKeyValueElement	Rótulo de campo do par chave-valor.
value	DocumentKeyValueElement	Valor de campo do par chave-valor.

DocumentLanguage

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

Name	Tipo	Description
confidence	number	Confiança de identificar corretamente a língua.
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	DocumentSpan[]	Localização dos elementos de texto no conteúdo concatenado ao qual o idioma se aplica.

DocumentLine

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	Tipo	Description
content	string	Conteúdo concatenado dos elementos contidos em ordem de leitura.
polygon	number[]	Polígono delimitador da linha, 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	DocumentSpan[]	Localização da linha na ordem de leitura conteúdo concatenado.

DocumentPage

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

Name	Tipo	Description
angle	number	A orientação geral do conteúdo no sentido horário, medida em graus entre (-180, 180).
barcodes	DocumentBarcode[]	Códigos de barras extraídos da página.
formulas	DocumentFormula[]	Fórmulas extraídas da página.
height	number	A altura da imagem/PDF em pixels/polegadas, respectivamente.
lines	DocumentLine[]	Linhas extraídas da página, potencialmente contendo elementos textuais e visuais.
pageNumber	integer	Número de página baseado em 1 no documento de entrada.
selectionMarks	DocumentSelectionMark[]	Marcas de seleção extraídas da página.
spans	DocumentSpan[]	Localização da página na ordem de leitura conteúdo concatenado.
unit	LengthUnit	A unidade usada pelas propriedades de largura, altura e polígono. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".
width	number	A largura da imagem/PDF em pixels/polegadas, respectivamente.
words	DocumentWord[]	Palavras extraídas da página.

DocumentParagraph

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

Name	Tipo	Description
boundingRegions	BoundingRegion[]	Regiões delimitadoras que abrangem o parágrafo.
content	string	Conteúdo concatenado do parágrafo em ordem de leitura.
role	ParagraphRole	Papel semântico do parágrafo.
spans	DocumentSpan[]	Localização do parágrafo na ordem de leitura conteúdo concatenado.

DocumentSection

Um objeto que representa uma seção no documento.

Name	Tipo	Description
elements	string[]	Elementos filho da secção.
spans	DocumentSpan[]	Localização da seção na ordem de leitura conteúdo concatenado.

DocumentSelectionMark

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	Tipo	Description
confidence	number	Confiança de extrair corretamente a marca de seleção.
polygon	number[]	Polígono delimitador da marca de seleção, 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	DocumentSpan	Localização da marca de seleção no conteúdo concatenado por ordem de leitura.
state	DocumentSelectionMarkState	Estado da marca de seleção.

DocumentSelectionMarkState

Estado da marca de seleção.

Name	Tipo	Description
selected	string	A marca de seleção é selecionada, geralmente indicada por uma verificação ✓ ou cruz X dentro da marca de seleção.
unselected	string	A marca de seleção não está selecionada.

DocumentSignatureType

Presença de assinatura.

Name	Tipo	Description
signed	string	Uma assinatura é detetada.
unsigned	string	Não são detetadas assinaturas.

DocumentSpan

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

Name	Tipo	Description
length	integer	Número de caracteres no conteúdo representado pela extensão.
offset	integer	Índice baseado em zero do conteúdo representado pela extensão.

DocumentStyle

Um objeto que representa estilos de texto observados.

Name	Tipo	Description
backgroundColor	string	Cor de fundo em #rrggbb formato hexadecimal..
color	string	Cor de primeiro plano em #rrggbb formato hexadecimal.
confidence	number	Confiança de identificar corretamente o estilo.
fontStyle	FontStyle	Estilo da fonte.
fontWeight	FontWeight	Espessura da fonte.
isHandwritten	boolean	O conteúdo é escrito à mão?
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	DocumentSpan[]	Localização dos elementos de texto no conteúdo concatenado ao qual o estilo se aplica.

DocumentTable

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

Name	Tipo	Description
boundingRegions	BoundingRegion[]	Regiões delimitadoras cobrindo a tabela.
caption	DocumentCaption	Legenda associada à tabela.
cells	DocumentTableCell[]	Células contidas na tabela.
columnCount	integer	Número de colunas na tabela.
footnotes	DocumentFootnote[]	Lista de notas de rodapé associadas à tabela.
rowCount	integer	Número de linhas na tabela.
spans	DocumentSpan[]	Localização da tabela na ordem de leitura conteúdo concatenado.

DocumentTableCell

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

Name	Tipo	Default value	Description
boundingRegions	BoundingRegion[]		Regiões delimitadoras que cobrem a célula da tabela.
columnIndex	integer		Índice da coluna da célula.
columnSpan	integer	1	Número de colunas atravessadas por esta célula.
content	string		Conteúdo concatenado da célula da tabela em ordem de leitura.
elements	string[]		Elementos filho da célula da tabela.
kind	DocumentTableCellKind	content	Tipo de célula da tabela.
rowIndex	integer		Índice de linha da célula.
rowSpan	integer	1	Número de linhas atravessadas por esta célula.
spans	DocumentSpan[]		Localização da célula da tabela na ordem de leitura conteúdo concatenado.

DocumentTableCellKind

Tipo de célula da tabela.

Name	Tipo	Description
columnHeader	string	Descreve o conteúdo da coluna.
content	string	Contém o conteúdo/dados principais.
description	string	Descreve o conteúdo em (partes da) tabela.
rowHeader	string	Descreve o conteúdo da linha.
stubHead	string	Descreve os cabeçalhos de linha, geralmente localizados no canto superior esquerdo de uma tabela.

DocumentWord

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	Tipo	Description
confidence	number	Confiança de extrair corretamente a palavra.
content	string	Conteúdo textual da palavra.
polygon	number[]	Polígono delimitador da palavra, 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	DocumentSpan	Localização da palavra na ordem de leitura conteúdo concatenado.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

ErrorResponse

Objeto de resposta de erro.

Name	Tipo	Description
error	Error	Informações de erro.

FontStyle

Estilo da fonte.

Name	Tipo	Description
italic	string	Os personagens são visualmente inclinados para a direita.
normal	string	Os caracteres são representados normalmente.

FontWeight

Espessura da fonte.

Name	Tipo	Description
bold	string	Os caracteres são representados com traços mais grossos.
normal	string	Os caracteres são representados normalmente.

InnerError

Um objeto que contém informações mais específicas sobre o erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

LengthUnit

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

Name	Tipo	Description
inch	string	Unidade de comprimento para ficheiros PDF.
pixel	string	Unidade de comprimento para arquivos de imagem.

OperationStatus

Estado da operação.

Name	Tipo	Description
canceled	string	A operação foi cancelada.
completed	string	A operação foi concluída.
failed	string	A operação falhou.
notStarted	string	A operação ainda não começou.
running	string	A operação está em curso.
succeeded	string	A operação foi bem sucedida.

ParagraphRole

Papel semântico do parágrafo.

Name	Tipo	Description
footnote	string	Uma nota geralmente colocada após o conteúdo principal de uma página.
formulaBlock	string	Um bloco de fórmulas, muitas vezes com alinhamento compartilhado.
pageFooter	string	Texto perto da borda inferior da página.
pageHeader	string	Texto perto da borda superior da página.
pageNumber	string	Número da página.
sectionHeading	string	Subtítulo que descreve uma secção do documento.
title	string	Título de nível superior que descreve todo o documento.

StringIndexType

Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

Name	Tipo	Description
textElements	string	Caractere de exibição percebido pelo usuário ou cluster de grafemas, conforme definido pelo Unicode 8.0.0.
unicodeCodePoint	string	Unidade de caracteres representada por um único ponto de código unicode. Usado por Python 3.
utf16CodeUnit	string	Unidade de caracteres representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET.

Warning