Partilhar via

@azure/ai-form-recognizer package

  • Referência

Classes

AzureKeyCredential

Uma credencial baseada em chave estática que oferece suporte à atualização do valor da chave subjacente.
DocumentAnalysisClient

Um cliente para interagir com os recursos de análise do serviço Form Recognizer.

Exemplos:

O serviço Form Recognizer e os clientes suportam dois meios de autenticação:

Azure Ative Directory

import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentAnalysisClient(endpoint, credential);

Chave de API (Chave de Subscrição)

import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentAnalysisClient(endpoint, credential);
DocumentModelAdministrationClient

Um cliente para interagir com os recursos de gerenciamento de modelo do serviço Reconhecimento de Formulários, como criar, ler, listar, excluir e copiar modelos.

Exemplos:

Azure Ative Directory

import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentModelAdministrationClient(endpoint, credential);

Chave de API (Chave de Subscrição)

import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentModelAdministrationClient(endpoint, credential);

Interfaces

AddressValue

Valor do campo Endereço.
AnalyzeDocumentOptions

Opções para a operação de análise de documentos.
AnalyzeResult

O resultado de uma operação de análise. O tipo de documento pode ser determinado pelo modelo utilizado para realizar a análise.
AnalyzeResultCommon

Os campos comuns de todos os tipos semelhantes a AnalyzeResult, como LayoutResult, ReadResult e GeneralDocumentResult.
AnalyzedDocument

Um objeto de documento extraído.

Um AnalyzedDocument é uma instância de um dos tipos de documento dentro de um modelo. Seus campos correspondem ao esquema de campo do tipo de documento.
AzureBlobFileListSource

Uma fonte de dados de treinamento definida por um Contêiner de Blob do Azure e uma lista de arquivos JSONL dentro do contêiner.
AzureBlobFileListSourceDetails

Lista de ficheiros no Armazenamento de Blobs do Azure.
AzureBlobSource

Uma fonte de dados de treinamento definida por um Contêiner de Blob do Azure.
AzureBlobSourceDetails

Conteúdo do Armazenamento de Blobs do Azure.
BeginBuildDocumentClassifierOptions

Opções para a operação de compilação do classificador de documentos.
BeginBuildDocumentModelOptions

Opções para a operação de construção do modelo.
BeginComposeDocumentModelOptions

Opções para a operação de composição do modelo.
BeginCopyModelOptions

Opções para a operação do modelo de cópia.
BoundingRegion

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

Informações do tipo de documento do classificador.
ClassifyDocumentOptions

Opções para a operação de classificação de documentos.
CommonModelCreationOptions

Opções comuns a todas as operações que definem novos modelos, como beginBuildDocumentModel, beginComposeDocumentModele getCopyAuthorization.
CopyAuthorization

Autorização para copiar um modelo de documento para o recurso de destino especificado e modelId.
CreateDocumentModelOptions

Opções para a operação de criação do modelo.
CurrencyValue

Valor do campo de moeda.
CustomDocumentModelsDetails

Detalhes sobre modelos de documentos personalizados.
DeleteDocumentModelOptions

Opções para exclusão de modelo.
DocumentAddressField

Um campo de documento que descreve um endereço físico estruturado.
DocumentAnalysisClientOptions

Opções configuráveis para DocumentAnalysisClient.
DocumentAnalysisPollOperationState

O estado de uma operação de análise, que acabará por produzir o tipo de resultado que corresponde ao modelo.
DocumentAnnotation

Um elemento de anotação visual no documento, como uma marca de seleção ou cruz.
DocumentArrayField

Um DocumentField que consiste em uma matriz de campos aninhados. Todos os campos na matriz terão o mesmo tipo.
DocumentBarcode

Um código de barras extraído.
DocumentBooleanField

Um DocumentField que tem um valor booleano.
DocumentCaption

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

Obter objeto de resposta Operation.
DocumentClassifierDetails

Informações do classificador de documentos.
DocumentClassifierDocumentTypeSources

Um conjunto de fontes usadas para criar um classificador de documentos. Este é um mapa de nomes de tipos de documentos para fontes que serão usados para treinar o modelo para classificar documentos do tipo de fonte correspondente.
DocumentClassifierOperationState

O estado de uma operação de criação de modelo.
DocumentCountryRegionField

Um DocumentField que tem um valor que indica um país ou região, representado como uma cadeia de caracteres.
DocumentCurrencyField

Um DocumentField que descreve uma quantidade de uma determinada moeda.
DocumentDateField

Um DocumentField que tem um valor Data.
DocumentFieldCommon

Campos que são comuns a todas as variantes de DocumentField.
DocumentFieldSchema

Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.
DocumentFootnote

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

Uma fórmula extraída.
DocumentIntegerField

Um DocumentField que tem um valor inteiro.
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.
DocumentModel

Uma especificação de modelo bem conhecida que suporta a extração de documentos estruturados.

Consulte o método beginAnalyzeDocument de DocumentAnalysisClient, que suporta o consumo desses objetos DocumentModel em vez de cadeias de caracteres de ID de modelo para fornecer tipos de resultados mais fortes.
DocumentModelAdministrationClientOptions

Opções configuráveis para DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails

Obter objeto de resposta Operation.
DocumentModelComposeOperationDetails

Obter objeto de resposta Operation.
DocumentModelCopyToOperationDetails

Obter objeto de resposta Operation.
DocumentModelDetails

Informações do modelo do documento.
DocumentModelOperationState

O estado de uma operação de criação de modelo.
DocumentModelSummary

Resumo do modelo de documento.
DocumentNumberField

Um DocumentField que tem um valor numérico.
DocumentObjectField

Um DocumentField que consiste em várias propriedades nomeadas que têm seus próprios valores DocumentField.
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.
DocumentPhoneNumberField

Um DocumentField que tem um valor de número de telefone, representado como uma cadeia de caracteres.
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.
DocumentSelectionMarkField

Um DocumentField que é tem um valor que indica um estado de marca de seleção (como uma caixa de seleção ou botão de opção), representado como uma cadeia de caracteres.
DocumentSignatureField

Um DocumentField que indica o estado de uma assinatura, representada como uma cadeia de caracteres.
DocumentSpan

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

Um DocumentField que tem um valor de cadeia de caracteres.
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.
DocumentTimeField

Um DocumentField que tem um valor de tempo, representado como uma cadeia de caracteres.
DocumentTypeDetails

Informações sobre o tipo de documento.
DocumentValueField

Um campo simples que tem um valor primitivo, como uma cadeia de caracteres, número etc.
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.
ErrorModel

Informações de erro.
GetCopyAuthorizationOptions

Opções para o método de autorização get copy.
GetModelOptions

Opções para recuperar informações do modelo.
GetOperationOptions

Opções para recuperar um estado de operação.
GetResourceDetailsOptions

Opções para recuperar informações de recursos do Reconhecimento de Formulário.
HasBoundingPolygon

Elementos simples do documento, como palavras, marcas de seleção e linhas, são limitados pelo polígono.
InnerError

Erro detalhado.
ListModelsOptions

Opções para listar modelos.
ListOperationsOptions

Opções para operações de listagem.
ModelAdministrationOperationStateCommon

O conjunto de campos comuns a todas as operações de administração.
OperationDetails

Obter objeto de resposta Operation.
OperationSummary

Informações da operação.
Point2D

Representa um ponto usado para definir polígonos delimitadores. A unidade é 'pixel' ou 'polegada' (Ver LengthUnit).
PollerOptions

Opções para operações de longa duração (pollers) nos clientes do Form Recognizer.
QuotaDetails

Cota usada, limite e próxima data/hora de redefinição.
ResourceDetails

Informações gerais sobre o recurso atual.

Aliases de Tipo

AnalysisPoller

Uma operação de longa duração (poller) que rastreia o estado de uma operação de análise, eventualmente produzindo o tipo de resultado que corresponde ao modelo.
AnalyzeResultOperationStatus

Define valores para AnalyzeResultOperationStatus.
DocumentBarcodeKind

Define valores para DocumentBarcodeKind.
KnownDocumentBarcodeKind pode ser usado de forma intercambiável com DocumentBarcodeKind, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

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

Define valores para DocumentBuildMode.
KnownDocumentBuildMode pode ser usado de forma intercambiável com DocumentBuildMode, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

modelo: Documentos de destino com modelos visuais semelhantes.
neurais : Documentos de suporte com diversos modelos visuais.
DocumentClassifierPoller

Uma operação de longa duração (poller) que rastreia o estado de uma operação de criação de classificador personalizado, eventualmente produzindo um DocumentClassifierDetails.
DocumentClassifierSource

Uma fonte de conteúdo que pode ser usada para criar um classificador de documentos.

Um dos seguintes:

  • BlobSource
  • BlobFileListSource
DocumentField

Um campo extraído. A propriedade kind identifica (discrimina) o tipo de DocumentField.
DocumentFieldType

Define valores para DocumentFieldType.
KnownDocumentFieldType pode ser usado de forma intercambiável com DocumentFieldType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

string: Texto simples.
data: Data, normalizada para o formato ISO 8601 (AAAA-MM-DD).
tempo: Tempo, normalizado para o formato ISO 8601 (hh:mm:ss).
número de telefone: Número de telefone, normalizado para o formato E.164 (+{CountryCode}{SubscriberNumber}).
número: Número de ponto flutuante, normalizado para ponto flutuante de precisão dupla.
inteiro: Número inteiro, normalizado para inteiro assinado de 64 bits.
selectionMark: O campo está selecionado?
paísRegião: País/região, normalizado para o formato ISO 3166-1 alpha-3 (ex. EUA).
assinatura: A assinatura está presente?
matriz: Lista de subcampos do mesmo tipo.
objeto: Lista nomeada de subcampos de tipos potencialmente diferentes.
moeda: Valor da moeda com símbolo e unidade de moeda opcionais.
endereço: Endereço analisado.
booleano : Valor booleano, normalizado para verdadeiro ou falso.
DocumentFormulaKind

Define valores para DocumentFormulaKind.
KnownDocumentFormulaKind pode ser usado de forma intercambiável com DocumentFormulaKind, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

embutido : uma fórmula incorporada no conteúdo de um parágrafo.
de exibição : uma fórmula no modo de exibição que ocupa uma linha inteira.
DocumentModelBuildMode

Modos de construção de modelo suportados. O modo de construção do modelo seleciona o mecanismo que o serviço usa para treinar o modelo com base nos dados de treinamento rotulados.

As opções são:

  • "neural", que produz a mais alta qualidade de modelo capaz de extrair dados de classes de documentos que têm a mesma estrutura de dados, mas layouts diferentes (por exemplo, formulários fiscais W2, que podem variar de empresa para empresa, mas sempre contêm as mesmas informações).
  • "modelo", que exige que todos os documentos tenham o mesmo layout fixo (modelo).

Consulte o seguinte link para obter mais informações: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller

Uma operação de longa duração (poller) que rastreia o estado de uma operação de criação de modelo, eventualmente produzindo um DocumentModelDetails.
DocumentModelSource

Uma fonte de conteúdo que pode ser usada para criar um modelo de documento.

Um dos seguintes:

  • BlobSource
  • BlobFileListSource
DocumentSignatureType

Define valores para DocumentSignatureType.
KnownDocumentSignatureType pode ser usado de forma intercambiável com DocumentSignatureType, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

assinado: Uma assinatura é detetada.
não assinado: Não são detetadas assinaturas.
DocumentTableCellKind

Define valores para DocumentTableCellKind.
KnownDocumentTableCellKind pode ser usado de forma intercambiável com DocumentTableCellKind, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

conteúdo: Contém o conteúdo/dados principais.
rowHeader: Descreve o conteúdo da linha.
columnHeader: Descreve o conteúdo da coluna.
stubHead: Descreve os cabeçalhos de linha, geralmente localizados no canto superior esquerdo de uma tabela.
descrição: Descreve o conteúdo em (partes da) tabela.
FontStyle

Define valores para FontStyle.
KnownFontStyle pode ser usado de forma intercambiável com FontStyle, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

normal : Os caracteres são representados normalmente.
itálico: Os caracteres são visualmente inclinados para a direita.
FontWeight

Define valores para FontWeight.
KnownFontWeight pode ser usado de forma intercambiável com FontWeight, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

normal : Os caracteres são representados normalmente.
negrito: Os caracteres são representados com traços mais grossos.
FormRecognizerFeature

Recursos adicionais (recursos) que podem ser habilitados para a solicitação.

Para obter mais informações sobre os recursos disponíveis no Form Recognizer, consulte a documentação do serviço:

https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody

Uma entrada de solicitação que pode ser carregada como dados binários para o serviço Form Recognizer. O Form Recognizer trata string entradas como URLs, portanto, para enviar uma cadeia de caracteres como uma entrada de binária, primeiro converta a cadeia de caracteres em um dos seguintes tipos de entrada.
LengthUnit

Define valores para LengthUnit.
KnownLengthUnit pode ser usado de forma intercambiável com LengthUnit, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

pixel: Unidade de comprimento para arquivos de imagem.
polegadas: Unidade de comprimento para ficheiros PDF.
OperationDetailsUnion

Detalhes sobre qualquer um dos vários tipos diferentes de operações de gerenciamento do Reconhecimento de Formulário.
OperationKind

Define valores para OperationKind.
KnownOperationKind pode ser usado de forma intercambiável com OperationKind, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

documentModelBuild: Crie um novo modelo de documento personalizado.
documentModelCompose: Componha um novo modelo de documento personalizado a partir de modelos existentes.
documentModelCopyTo: copie um modelo de documento existente para um recurso, região ou assinatura potencialmente diferente.
documentClassifierBuild: Crie um novo modelo de classificador personalizado.
OperationStatus

Define valores para OperationStatus.
ParagraphRole

Define valores para ParagraphRole.
KnownParagraphRole pode ser usado de forma intercambiável com ParagraphRole, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

pageHeader: Texto perto da borda superior da página.
pageFooter: Texto perto da borda inferior da página.
pageNumber: Número da página.
título: Título de nível superior que descreve todo o documento.
secçãoTítulo: Subtítulo que descreve uma secção do documento.
nota de rodapé: Uma nota geralmente colocada após o conteúdo principal de uma página.
formulaBlock: Um bloco de fórmulas, geralmente com alinhamento compartilhado.
SelectionMarkState

Define valores para SelectionMarkState.
KnownSelectionMarkState pode ser usado de forma intercambiável com SelectionMarkState, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

selecionado: A marca de seleção é selecionada, geralmente indicada por uma seleção ✓ ou cruz X dentro da marca de seleção.
desmarcada: A marca de seleção não está selecionada.
StringIndexType

Tipos de índice de cadeia de caracteres válidos suportados pelo serviço Form Recognizer e clientes SDK.

Enumerações

KnownDocumentBarcodeKind

Os valores conhecidos de DocumentBarcodeKind que o serviço aceita.
KnownDocumentBuildMode

Os valores conhecidos de DocumentBuildMode que o serviço aceita.
KnownDocumentFieldType

Os valores conhecidos de DocumentFieldType que o serviço aceita.
KnownDocumentFormulaKind

Os valores conhecidos de DocumentFormulaKind que o serviço aceita.
KnownDocumentSignatureType

Os valores conhecidos de DocumentSignatureType que o serviço aceita.
KnownDocumentTableCellKind

Os valores conhecidos de DocumentTableCellKind que o serviço aceita.
KnownFontStyle

Os valores conhecidos de FontStyle que o serviço aceita.
KnownFontWeight

Os valores conhecidos de FontWeight que o serviço aceita.
KnownLengthUnit

Os valores conhecidos de LengthUnit que o serviço aceita.
KnownOperationKind

Os valores conhecidos de OperationKind que o serviço aceita.
KnownParagraphRole

Os valores conhecidos de ParagraphRole que o serviço aceita.
KnownSelectionMarkState

Os valores conhecidos de SelectionMarkState que o serviço aceita.