Document Classifiers - Get Classify Result
Obtém o resultado do classificador de documento.
GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-07-31-preview
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
classifier
|
path | True |
string |
Nome do classificador de documento exclusivo. Padrão Regex: |
endpoint
|
path | True |
string uri |
O ponto de extremidade do serviço do Document Intelligence. |
result
|
path | True |
string uuid |
Analisar a ID do resultado da operação. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A solicitação foi bem-sucedida. |
|
Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
Ocp-Apim-Subscription-Key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
URL do Token:
https://login.microsoftonline.com/common/oauth2/token
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exemplos
Get Classify Document Result
Solicitação de exemplo
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview
Resposta de exemplo
{
"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
Nome | Description |
---|---|
Address |
Valor do campo de endereço. |
Analyze |
Resultado da análise do documento. |
Analyze |
Status e resultado da operação de análise. |
Bounding |
Delimitando o polígono em uma página específica da entrada. |
Content |
Formato do conteúdo no resultado analisado. |
Currency |
Valor do campo moeda. |
Document |
Um objeto que descreve o local e o conteúdo semântico de um documento. |
Document |
Um objeto de código de barras. |
Document |
Tipo de código de barras. |
Document |
Um objeto de legenda que descreve uma tabela ou figura. |
Document |
Um objeto que representa o conteúdo e o local de um valor de campo. |
Document |
Tipo de dados semânticos do valor do campo. |
Document |
Um objeto que representa uma figura no documento. |
Document |
Um objeto de nota de rodapé que descreve uma tabela ou figura. |
Document |
Um objeto de fórmula. |
Document |
Tipo de fórmula. |
Document |
Um objeto que representa a chave de campo ou o valor em um par chave-valor. |
Document |
Um objeto que representa um campo de formulário com rótulo de campo distinto (chave) e valor de campo (pode estar vazio). |
Document |
Um objeto que representa o idioma detectado para um determinado intervalo de texto. |
Document |
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. |
Document |
Elementos de layout e conteúdo extraídos de uma página da entrada. |
Document |
Um objeto de parágrafo que consiste em linhas contíguas geralmente com alinhamento e espaçamento comuns. |
Document |
Um objeto que representa uma seção no documento. |
Document |
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. |
Document |
Estado da marca de seleção. |
Document |
Presença de assinatura. |
Document |
Região contígua da propriedade de conteúdo concatenado, especificada como um deslocamento e comprimento. |
Document |
Um objeto que representa os estilos de texto observados. |
Document |
Um objeto de tabela que consiste em células de tabela organizadas em um layout retangular. |
Document |
Um objeto que representa o local e o conteúdo de uma célula de tabela. |
Document |
Tipo de célula de tabela. |
Document |
Um objeto de palavra que consiste em uma sequência contígua de caracteres. Para idiomas delimitados sem espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra. |
Error |
O objeto de erro. |
Error |
Objeto de resposta de erro. |
Font |
Estilo de fonte. |
Font |
Peso da fonte. |
Inner |
Um objeto que contém informações mais específicas sobre o erro. |
Length |
A unidade usada pelas propriedades largura, altura e polígono. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada". |
Operation |
Status da operação. |
Paragraph |
Função semântica do parágrafo. |
String |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. |
Warning |
O objeto de erro. |
AddressValue
Valor do campo de endereço.
Nome | Tipo | Description |
---|---|---|
city |
string |
Nome da cidade, cidade, vila etc. |
cityDistrict |
string |
Distritos ou bairros dentro de uma cidade, como Brooklyn em Nova York ou Cidade de Westminster, em Londres. |
countryRegion |
string |
País/região. |
house |
string |
Nome da compilação, como World Trade Center. |
houseNumber |
string |
Número da casa ou do prédio. |
level |
string |
Número do piso, como 3F. |
poBox |
string |
Número da caixa postal. |
postalCode |
string |
Código postal usado para classificação de email. |
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 de nível de rua, excluindo cidade, estado, countryRegion e postalCode. |
suburb |
string |
Nome não oficial da vizinhança, como Chinatown. |
unit |
string |
Número do apartamento ou do escritório |
AnalyzeResult
Resultado da análise do documento.
Nome | 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 na ordem de leitura. |
contentFormat |
Formato do conteúdo de nível superior do resultado de análise. |
|
documents |
Document[] |
Documentos extraídos. |
figures |
Números extraídos. |
|
keyValuePairs |
Pares chave-valor extraídos. |
|
languages |
Idiomas detectados. |
|
modelId |
string |
ID do modelo de documento usada para produzir esse resultado. |
pages |
Páginas analisadas. |
|
paragraphs |
Parágrafos extraídos. |
|
sections |
Seções extraídas. |
|
stringIndexType |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. |
|
styles |
Estilos de fonte extraídos. |
|
tables |
Tabelas extraídas. |
|
warnings |
Warning[] |
Lista de avisos encontrados. |
AnalyzeResultOperation
Status e resultado da operação de análise.
Nome | Tipo | Description |
---|---|---|
analyzeResult |
Resultado da análise do documento. |
|
createdDateTime |
string |
Data e hora (UTC) quando a operação de análise foi enviada. |
error |
Erro encontrado durante a análise do documento. |
|
lastUpdatedDateTime |
string |
Data e hora (UTC) quando o status foi atualizado pela última vez. |
status |
Status da operação. notStarted, running, succeeded ou failed |
BoundingRegion
Delimitando o polígono em uma página específica da entrada.
Nome | Tipo | Description |
---|---|---|
pageNumber |
integer |
Número de página com base em 1 página que contém a região delimitadora. |
polygon |
number[] |
Polígono delimitado na página ou na página inteira, se não for especificado. Coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
ContentFormat
Formato do conteúdo no resultado analisado.
Nome | Tipo | Description |
---|---|---|
markdown |
string |
Representação markdown do conteúdo do documento com títulos de seção, tabelas etc. |
text |
string |
Representação de texto sem formatação do conteúdo do documento sem nenhuma formatação. |
CurrencyValue
Valor do campo moeda.
Nome | Tipo | Description |
---|---|---|
amount |
number |
Valor da moeda. |
currencyCode |
string |
Código de moeda resolvido (ISO 4217), se houver. |
currencySymbol |
string |
Rótulo de símbolo de moeda, se houver. |
Document
Um objeto que descreve o local e o conteúdo semântico de um documento.
Nome | Tipo | Description |
---|---|---|
boundingRegions |
Regiões delimitadoras que abrangem o documento. |
|
confidence |
number |
Confiança de extrair corretamente o documento. |
docType |
string |
Tipo de documento. |
fields |
<string,
Document |
Dicionário de valores de campo nomeados. |
spans |
Local do documento no conteúdo concatenado da ordem de leitura. |
DocumentBarcode
Um objeto de código de barras.
Nome | Tipo | Description |
---|---|---|
confidence |
number |
Confiança de extrair corretamente o código de barras. |
kind |
Tipo de código de barras. |
|
polygon |
number[] |
Polígono delimitado do código de barras, com coordenadas especificadas em relação à parte superior esquerda da página. Os números representam os valores x, y dos vértices de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
span |
Local do código de barras no conteúdo concatenado da ordem de leitura. |
|
value |
string |
Valor do código de barras. |
DocumentBarcodeKind
Tipo de código de barras.
Nome | Tipo | Description |
---|---|---|
Aztec |
string |
Código asteca, conforme definido em ISO/IEC 24778:2008. |
Codabar |
string |
Código de barras de barras, conforme definido em ANSI/AIM BC3-1995. |
Code128 |
string |
Código 128 código de barras, conforme definido em ISO/IEC 15417:2007. |
Code39 |
string |
Código 39 código de barras, conforme definido em ISO/IEC 16388:2007. |
Code93 |
string |
Código 93 código de barras, conforme definido em 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 de matriz de dados, conforme definido em ISO/IEC 16022:2006. |
EAN13 |
string |
Número do Artigo Internacional do GS1 de 13 dígitos (Número do Artigo Europeu). |
EAN8 |
string |
Número do Artigo Internacional do GS1 de 8 dígitos (Número do Artigo Europeu). |
ITF |
string |
Intercalado 2 de 5 códigos de barras, conforme definido em ANSI/AIM BC2-1995. |
MaxiCode |
string |
MaxiCode, conforme definido em ISO/IEC 16023:2000. |
MicroQRCode |
string |
Micro código QR, conforme definido em ISO/IEC 23941:2022. |
PDF417 |
string |
PDF417, conforme definido na ISO 15438. |
QRCode |
string |
Código QR, conforme definido em ISO/IEC 18004:2015. |
UPCA |
string |
Código do Produto Universal de 12 dígitos GS1. |
UPCE |
string |
Código do Produto Universal de 6 dígitos GS1. |
DocumentCaption
Um objeto de legenda que descreve uma tabela ou figura.
Nome | Tipo | Description |
---|---|---|
boundingRegions |
Regiões delimitadas que abrangem a legenda. |
|
content |
string |
Conteúdo da legenda. |
elements |
string[] |
Elementos filho da legenda. |
spans |
Local da legenda no conteúdo concatenado da ordem de leitura. |
DocumentField
Um objeto que representa o conteúdo e o local de um valor de campo.
Nome | Tipo | Description |
---|---|---|
boundingRegions |
Regiões delimitadoras que abrangem o campo. |
|
confidence |
number |
Confiança de extrair corretamente o campo. |
content |
string |
Conteúdo do campo. |
spans |
Local do campo no conteúdo concatenado da ordem de leitura. |
|
type |
Tipo de dados do valor do campo. |
|
valueAddress |
Valor do endereço. |
|
valueArray |
Matriz de valores de campo. |
|
valueBoolean |
boolean |
Valor booliano. |
valueCountryRegion |
string |
Valor de código de país de 3 letras (ISO 3166-1 alfa-3). |
valueCurrency |
Valor da moeda. |
|
valueDate |
string |
Valor de data no formato YYYY-MM-DD (ISO 8601). |
valueInteger |
integer |
Valor inteiro. |
valueNumber |
number |
Valor de ponto flutuante. |
valueObject |
<string,
Document |
Dicionário de valores de campo nomeados. |
valuePhoneNumber |
string |
Valor do número de telefone no formato E.164 (por exemplo, +19876543210). |
valueSelectionGroup |
string[] |
Valor do grupo de seleção. |
valueSelectionMark |
Valor da marca de seleção. |
|
valueSignature |
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.
Nome | Tipo | Description |
---|---|---|
address |
string |
Endereço analisado. |
array |
string |
Lista de subcampos do mesmo tipo. |
boolean |
string |
Valor booliano normalizado como verdadeiro ou falso. |
countryRegion |
string |
País/região, normalizado para o formato alfa-3 ISO 3166-1 (por exemplo, EUA). |
currency |
string |
Valor de moeda com símbolo e unidade de moeda opcionais. |
date |
string |
Data, normalizada para o formato ISO 8601 (YYYY-MM-DD). |
integer |
string |
Número inteiro, normalizado para inteiro com sinal 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 sem formatação. |
time |
string |
Hora, normalizada para o formato ISO 8601 (hh:mm:ss). |
DocumentFigure
Um objeto que representa uma figura no documento.
Nome | Tipo | Description |
---|---|---|
boundingRegions |
Regiões delimitadoras que abrangem a figura. |
|
caption |
Legenda associada à figura. |
|
elements |
string[] |
Elementos filho da figura, excluindo qualquer legenda ou nota de rodapé. |
footnotes |
Lista de notas de rodapé associadas à figura. |
|
id |
string |
ID da figura. |
spans |
Local da figura no conteúdo concatenado da ordem de leitura. |
DocumentFootnote
Um objeto de nota de rodapé que descreve uma tabela ou figura.
Nome | Tipo | Description |
---|---|---|
boundingRegions |
Regiões delimitadas que abrangem a nota de rodapé. |
|
content |
string |
Conteúdo da nota de rodapé. |
elements |
string[] |
Elementos filho da nota de rodapé. |
spans |
Local da nota de rodapé no conteúdo concatenado da ordem de leitura. |
DocumentFormula
Um objeto de fórmula.
Nome | Tipo | Description |
---|---|---|
confidence |
number |
Confiança de extrair corretamente a fórmula. |
kind |
Tipo de fórmula. |
|
polygon |
number[] |
Polígono delimitado 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 de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
span |
Local da fórmula no conteúdo concatenado da ordem de leitura. |
|
value |
string |
Expressão LaTex que descreve a fórmula. |
DocumentFormulaKind
Tipo de fórmula.
Nome | Tipo | Description |
---|---|---|
display |
string |
Uma fórmula no modo de exibição que ocupa uma linha inteira. |
inline |
string |
Uma fórmula inserida no conteúdo de um parágrafo. |
DocumentKeyValueElement
Um objeto que representa a chave de campo ou o valor em um par chave-valor.
Nome | Tipo | Description |
---|---|---|
boundingRegions |
Regiões delimitadoras que abrangem o elemento chave-valor. |
|
content |
string |
Conteúdo concatenado do elemento chave-valor na ordem de leitura. |
spans |
Local 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 distinto (chave) e valor de campo (pode estar vazio).
Nome | Tipo | Description |
---|---|---|
confidence |
number |
Confiança de extrair corretamente o par chave-valor. |
key |
Rótulo de campo do par chave-valor. |
|
value |
Valor do campo do par chave-valor. |
DocumentLanguage
Um objeto que representa o idioma detectado para um determinado intervalo de texto.
Nome | Tipo | Description |
---|---|---|
confidence |
number |
Confiança de identificar corretamente o idioma. |
locale |
string |
Idioma detectado. O valor pode ser um código de idioma ISO 639-1 (ex. "en", "fr") ou marca de idioma BCP 47 (por exemplo, "zh-Hans"). |
spans |
Local 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.
Nome | Tipo | Description |
---|---|---|
content |
string |
Conteúdo concatenado dos elementos contidos na ordem de leitura. |
polygon |
number[] |
Polígono delimitado 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 de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
spans |
Local da linha no conteúdo concatenado da ordem de leitura. |
DocumentPage
Elementos de layout e conteúdo extraídos de uma página da entrada.
Nome | Tipo | Description |
---|---|---|
angle |
number |
A orientação geral do conteúdo no sentido horário, medida em graus entre (-180, 180]. |
barcodes |
Códigos de barras extraídos da página. |
|
formulas |
Fórmulas extraídas da página. |
|
height |
number |
A altura da imagem/PDF em pixels/polegadas, respectivamente. |
lines |
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 |
Marcas de seleção extraídas da página. |
|
spans |
Local da página no conteúdo concatenado da ordem de leitura. |
|
unit |
A unidade usada pelas propriedades 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 |
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.
Nome | Tipo | Description |
---|---|---|
boundingRegions |
Regiões delimitadoras que abrangem o parágrafo. |
|
content |
string |
Conteúdo concatenado do parágrafo na ordem de leitura. |
role |
Função semântica do parágrafo. |
|
spans |
Local do parágrafo no conteúdo concatenado da ordem de leitura. |
DocumentSection
Um objeto que representa uma seção no documento.
Nome | Tipo | Description |
---|---|---|
elements |
string[] |
Elementos filho da seção. |
spans |
Local da seção no conteúdo concatenado da ordem de leitura. |
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.
Nome | 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 de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
span |
Local da marca de seleção no conteúdo concatenado da ordem de leitura. |
|
state |
Estado da marca de seleção. |
DocumentSelectionMarkState
Estado da marca de seleção.
Nome | Tipo | Description |
---|---|---|
selected |
string |
A marca de seleção é selecionada, geralmente indicada por uma verificação ✓ ou cruze X dentro da marca de seleção. |
unselected |
string |
A marca de seleção não está selecionada. |
DocumentSignatureType
Presença de assinatura.
Nome | Tipo | Description |
---|---|---|
signed |
string |
Uma assinatura é detectada. |
unsigned |
string |
Nenhuma assinatura é detectada. |
DocumentSpan
Região contígua da propriedade de conteúdo concatenado, especificada como um deslocamento e comprimento.
Nome | Tipo | Description |
---|---|---|
length |
integer |
Número de caracteres no conteúdo representado pelo intervalo. |
offset |
integer |
Índice baseado em zero do conteúdo representado pelo intervalo. |
DocumentStyle
Um objeto que representa os estilos de texto observados.
Nome | Tipo | Description |
---|---|---|
backgroundColor |
string |
Cor da tela de fundo em #rrggbb formato hexadecimal.. |
color |
string |
Cor do primeiro plano em #rrggbb formato hexadecimal. |
confidence |
number |
Confiança de identificar corretamente o estilo. |
fontStyle |
Estilo de fonte. |
|
fontWeight |
Peso da fonte. |
|
isHandwritten |
boolean |
O conteúdo é manuscrito? |
similarFontFamily |
string |
Fonte visualmente mais semelhante entre o conjunto de famílias de fontes com suporte, com fontes de fallback seguindo a convenção CSS (por exemplo, 'Arial, sans-serif'). |
spans |
Local 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.
Nome | Tipo | Description |
---|---|---|
boundingRegions |
Regiões delimitadoras que abrangem a tabela. |
|
caption |
Legenda associada à tabela. |
|
cells |
Células contidas na tabela. |
|
columnCount |
integer |
Número de colunas na tabela. |
footnotes |
Lista de notas de rodapé associadas à tabela. |
|
rowCount |
integer |
Número de linhas na tabela. |
spans |
Local da tabela no conteúdo concatenado da ordem de leitura. |
DocumentTableCell
Um objeto que representa o local e o conteúdo de uma célula de tabela.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
boundingRegions |
Regiões delimitadas que abrangem a célula da tabela. |
||
columnIndex |
integer |
Índice de coluna da célula. |
|
columnSpan |
integer |
1 |
Número de colunas estendidas por essa célula. |
content |
string |
Conteúdo concatenado da célula da tabela na ordem de leitura. |
|
elements |
string[] |
Elementos filho da célula da tabela. |
|
kind | content |
Tipo de célula de tabela. |
|
rowIndex |
integer |
Índice de linha da célula. |
|
rowSpan |
integer |
1 |
Número de linhas estendidas por essa célula. |
spans |
Local da célula da tabela no conteúdo concatenado da ordem de leitura. |
DocumentTableCellKind
Tipo de célula de tabela.
Nome | Tipo | Description |
---|---|---|
columnHeader |
string |
Descreve o conteúdo da coluna. |
content |
string |
Contém o conteúdo/os 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 delimitados sem espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra.
Nome | Tipo | Description |
---|---|---|
confidence |
number |
Confiança de extrair corretamente a palavra. |
content |
string |
Conteúdo de texto da palavra. |
polygon |
number[] |
Polígono delimitado 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 de polígono, no sentido horário da esquerda (-180 graus inclusivos) em relação à orientação do elemento. |
span |
Local da palavra no conteúdo concatenado da ordem de leitura. |
Error
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
details |
Error[] |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
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 pelo ser humano do erro. |
target |
string |
O destino do erro. |
ErrorResponse
Objeto de resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
Informações de erro. |
FontStyle
Estilo de fonte.
Nome | Tipo | Description |
---|---|---|
italic |
string |
Os caracteres são inclinados visualmente para a direita. |
normal |
string |
Os caracteres são representados normalmente. |
FontWeight
Peso da fonte.
Nome | Tipo | Description |
---|---|---|
bold |
string |
Os caracteres são representados com traços mais espessos. |
normal |
string |
Os caracteres são representados normalmente. |
InnerError
Um objeto que contém informações mais específicas sobre o erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
innererror |
Erro interno. |
|
message |
string |
Uma representação legível pelo ser humano do erro. |
LengthUnit
A unidade usada pelas propriedades largura, altura e polígono. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".
Nome | Tipo | Description |
---|---|---|
inch |
string |
Unidade de comprimento para arquivos PDF. |
pixel |
string |
Unidade de comprimento para arquivos de imagem. |
OperationStatus
Status da operação.
Nome | 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 foi iniciada. |
running |
string |
A operação está em andamento. |
succeeded |
string |
A operação foi bem-sucedida. |
ParagraphRole
Função semântica do parágrafo.
Nome | Tipo | Description |
---|---|---|
footnote |
string |
Uma anotação geralmente colocada após o conteúdo principal em uma página. |
formulaBlock |
string |
Um bloco de fórmulas, geralmente com alinhamento compartilhado. |
pageFooter |
string |
Texto próximo à borda inferior da página. |
pageHeader |
string |
Texto próximo à borda superior da página. |
pageNumber |
string |
Número da página. |
sectionHeading |
string |
Subtítele que descreve uma seção do documento. |
title |
string |
Título de nível superior que descreve o documento inteiro. |
StringIndexType
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.
Nome | Tipo | Description |
---|---|---|
textElements |
string |
Caractere de exibição percebido pelo usuário ou cluster grapheme, conforme definido pelo Unicode 8.0.0. |
unicodeCodePoint |
string |
Unidade de caractere representada por um único ponto de código unicode. Usado pelo Python 3. |
utf16CodeUnit |
string |
Unidade de caractere representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET. |
Warning
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de aviso. |
message |
string |
Uma representação legível pelo ser humano do aviso. |
target |
string |
O destino do erro. |