Partilhar via


@azure/ai-form-recognizer package

Classes

AzureKeyCredential

Uma credencial baseada em chave estática que suporta a atualização do valor da chave subjacente.

DocumentAnalysisClient

Um cliente para interagir com as funcionalidades de análise do serviço Reconhecedor de Formulários.

Exemplos:

O serviço Reconhecedor de Formulários e os clientes suportam dois meios de autenticação:

Azure Active 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 as funcionalidades de gestão de modelos do serviço Reconhecedor de Formulários, como criar, ler, listar, eliminar e copiar modelos.

Exemplos:

Azure Active 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 de 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 efetuar a análise.

AnalyzeResultCommon

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

AnalyzedDocument

Um objeto de documento extraído.

Um AnalisadoDocumento é uma instância de um dos tipos de documento dentro de um modelo. Os respetivos campos correspondem ao esquema de campo do tipo de documento.

AzureBlobFileListSource

Uma origem de dados de preparação definida por um Contentor de Blobs do Azure e uma lista de ficheiros JSONL no contentor.

AzureBlobFileListSourceDetails

Lista de ficheiros no Armazenamento de Blobs do Azure.

AzureBlobSource

Uma origem de dados de preparação definida por um Contentor de Blobs do Azure.

AzureBlobSourceDetails

Armazenamento de Blobs do Azure conteúdo.

BeginBuildDocumentClassifierOptions

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

BeginBuildDocumentModelOptions

Opções para a operação de compilação de modelos.

BeginComposeDocumentModelOptions

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

BeginCopyModelOptions

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

BoundingRegion

A vincular o polígono numa 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 de modelos.

CurrencyValue

Valor do campo moeda.

CustomDocumentModelsDetails

Detalhes sobre modelos de documentos personalizados.

DeleteDocumentModelOptions

Opções para eliminação de modelos.

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 irá eventualmente produzir o tipo de resultado que corresponde ao modelo.

DocumentAnnotation

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

DocumentArrayField

Um DocumentField que consiste numa 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 a localização e o conteúdo de uma tabela legenda.

DocumentClassifierBuildOperationDetails

Obter o objeto de resposta operação.

DocumentClassifierDetails

Informações do classificador de documentos.

DocumentClassifierDocumentTypeSources

Um conjunto de origens utilizadas para criar um classificador de documentos. Este é um mapa de nomes de tipos de documento para origens que serão utilizados para preparar o modelo para classificar documentos do tipo de origem correspondente.

DocumentClassifierOperationState

O estado de uma operação de criação de modelos.

DocumentCountryRegionField

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

DocumentCurrencyField

Um DocumentField que descreve uma quantidade de uma determinada moeda.

DocumentDateField

Um DocumentField que tenha um valor Data.

DocumentFieldCommon

Campos comuns a todas as variantes do DocumentField.

DocumentFieldSchema

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

DocumentFootnote

Um objeto que representa a localização e o conteúdo de uma nota de rodapé de tabela.

DocumentFormula

Uma fórmula extraída.

DocumentIntegerField

Um DocumentField com um valor inteiro.

DocumentKeyValueElement

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

DocumentKeyValuePair

Um objeto que representa um campo de formulário com etiqueta de campo (chave) distinta e valor de campo (pode estar vazio).

DocumentLanguage

Um objeto que representa o idioma detetado para um determinado intervalo de texto.

DocumentLine

Um objeto de linha de conteúdo que consiste numa 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.

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

DocumentModelAdministrationClientOptions

Opções configuráveis para DocumentModelAdministrationClient.

DocumentModelBuildOperationDetails

Obter o objeto de resposta operação.

DocumentModelComposeOperationDetails

Obter o objeto de resposta operação.

DocumentModelCopyToOperationDetails

Obter o objeto de resposta operação.

DocumentModelDetails

Informações do modelo de documentos.

DocumentModelOperationState

O estado de uma operação de criação de modelos.

DocumentModelSummary

Resumo do modelo de documento.

DocumentNumberField

Um DocumentField com um valor numérico.

DocumentObjectField

Um DocumentField que consiste em várias propriedades nomeadas que têm os seus próprios valores DocumentField.

DocumentPage

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

DocumentParagraph

Um objeto de parágrafo composto por linhas contíguas geralmente com alinhamento e espaçamento comuns.

DocumentPhoneNumberField

Um DocumentField que tenha um valor de número de telefone, representado como uma cadeia.

DocumentSelectionMark

Um objeto de marca de seleção que representa caixas de verificaçã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 verificação ou botão de opção), representado como uma cadeia.

DocumentSignatureField

Um DocumentField que indica o estado de uma assinatura, representado como uma cadeia.

DocumentSpan

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

DocumentStringField

Um DocumentField com um valor de cadeia.

DocumentStyle

Um objeto que representa estilos de texto observados.

DocumentTable

Um objeto de tabela que consiste em células de tabela dispostas num esquema retangular.

DocumentTableCell

Um objeto que representa a localização e o conteúdo de uma célula de tabela.

DocumentTimeField

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

DocumentTypeDetails

Informações do tipo de documento.

DocumentValueField

Um campo simples que tem um valor primitivo, como uma cadeia, número, etc.

DocumentWord

Um objeto de palavra que consiste numa sequência contígua de carateres. Para idiomas delimitados sem espaço, como chinês, japonês e coreano, cada caráter é representado como a sua própria palavra.

ErrorModel

Informações de erro.

GetCopyAuthorizationOptions

Opções para obter o método de autorização de cópia.

GetModelOptions

Opções para obter informações do modelo.

GetOperationOptions

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

GetResourceDetailsOptions

Opções para obter informações de recursos Reconhecedor de Formulários.

HasBoundingPolygon

Elementos de documento simples, como palavras, marcas de seleção e linhas, são delimitados 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 comum a todas as operações de administração.

OperationDetails

Obter objeto de resposta Operação.

OperationSummary

Informações da operação.

Point2D

Representa um ponto utilizado para definir polígonos delimitadores. A unidade é "pixel" ou "polegada" (consulte LengthUnit).

PollerOptions

Opções para operações de execução prolongada (pollers) no Reconhecedor de Formulários clientes.

QuotaDetails

Quota utilizada, limite e próxima data/hora de reposição.

ResourceDetails

Informações gerais sobre o recurso atual.

Aliases de Tipo

AnalysisPoller

Uma operação de execução prolongada (poller) que controla o estado de uma operação de análise, acabando por produzir o tipo de resultado que corresponde ao modelo.

AnalyzeResultOperationStatus

Define valores para AnalyzeResultOperationStatus.

DocumentBarcodeKind

Define valores para DocumentBarcodeKind.
KnownDocumentBarcodeKind pode ser utilizado alternadamente com DocumentBarcodeKind, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

QRCode: código QR, conforme definido em ISO/IEC 18004:2015.
PDF417: PDF417, conforme definido em ISO 15438.
UPCA: GS1 Código de Produto Universal de 12 dígitos.
UPCE: GS1 Código de Produto Universal de 6 dígitos.
Código39: Código 39 código de barras, conforme definido em ISO/IEC 16388:2007.
Código128: Código 128 código de barras, conforme definido em ISO/IEC 15417:2007.
EAN8: Número do Artigo Internacional GS1 de 8 dígitos (Número do Artigo Europeu).
EAN13: Número do Artigo Internacional GS1 de 13 dígitos (Número do Artigo Europeu).
Barra de Dados: código de barras GS1 DataBar.
Código93: código de barras 93, conforme definido em ANSI/AIM BC5-1995.
Codabar: Codabar barcode, conforme definido em ANSI/AIM BC3-1995.
DataBarExpanded: código de barras expandido da Barra de Dados GS1.
ITF: Intercalado 2 de 5 códigos de barras, conforme definido em ANSI/AIM BC2-1995.
MicroQRCode: código Micro QR, conforme definido em ISO/IEC 23941:2022.
Aztec: código da Aztec, conforme definido em ISO/IEC 24778:2008.
DataMatrix: código de matriz de dados, conforme definido em ISO/IEC 16022:2006.
MaxiCode: MaxiCode, conforme definido em ISO/IEC 16023:2000.

DocumentBuildMode

Define valores para DocumentBuildMode.
KnownDocumentBuildMode pode ser utilizado alternadamente com DocumentBuildMode, esta enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

modelo: documentos de destino com modelos visuais semelhantes.
neural: suporte documentos com diversos modelos visuais.

DocumentClassifierPoller

Uma operação de execução prolongada (poller) que controla o estado de uma operação de criação de classificador personalizado, acabando por produzir um DocumentClassifierDetails.

DocumentClassifierSource

Uma origem de conteúdo que pode ser utilizada para criar um classificador de documentos.

Um dos seguintes:

  • BlobSource
  • BlobFileListSource
DocumentField

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

DocumentFieldType

Define valores para DocumentFieldType.
KnownDocumentFieldType pode ser utilizado alternadamente com DocumentFieldType, esta enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

cadeia: texto simples.
data: data, normalizada para o formato ISO 8601 (YYYY-MM-DD).
hora: tempo normalizado para o formato ISO 8601 (hh:mm:ss).
phoneNumber: número de telefone, normalizado para o formato E.164 (+{CountryCode}{SubscriberNumber}).
número: número de vírgula flutuante, normalizado para ponto flutuante de precisão dupla.
número inteiro: número inteiro, normalizado para número inteiro assinado de 64 bits.
selectionMark: O campo está selecionado?
countryRegion: país/região, normalizado para o formato ISO 3166-1 alfa-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: montante da moeda com o símbolo e a unidade de moeda opcionais.
endereço: endereço analisado.
booleano: valor booleano, normalizado como verdadeiro ou falso.

DocumentFormulaKind

Define valores para DocumentFormulaKind.
KnownDocumentFormulaKind pode ser utilizado alternadamente com DocumentFormulaKind, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

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

DocumentModelBuildMode

Modos de compilação de modelos suportados. O modo de compilação do modelo seleciona o motor que o serviço utiliza para preparar o modelo com base nos dados de preparação etiquetados.

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 esquemas diferentes (por exemplo, formulários fiscais W2, que podem variar de empresa para empresa, mas contêm sempre as mesmas informações).
  • "modelo", que requer que todos os documentos tenham o mesmo esquema fixo (modelo).

Veja a seguinte ligação para obter mais informações: https://aka.ms/azsdk/formrecognizer/buildmode

DocumentModelPoller

Uma operação de execução prolongada (poller) que controla o estado de uma operação de criação de modelos, acabando por produzir um DocumentModelDetails.

DocumentModelSource

Uma origem de conteúdo que pode ser utilizada para criar um modelo de documento.

Um dos seguintes:

  • BlobSource
  • BlobFileListSource
DocumentSignatureType

Define valores para DocumentSignatureType.
KnownDocumentSignatureType pode ser utilizado alternadamente com DocumentSignatureType, esta enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

assinado: é detetada uma assinatura.
não assinado: não são detetadas assinaturas.

DocumentTableCellKind

Define valores para DocumentTableCellKind.
KnownDocumentTableCellKind pode ser utilizado alternadamente com DocumentTableCellKind, esta enum contém os valores conhecidos suportados pelo serviço.

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, normalmente localizados no canto superior esquerdo de uma tabela.
descrição: descreve o conteúdo em (partes de) a tabela.

FontStyle

Define valores para FontStyle.
KnownFontStyle pode ser utilizado alternadamente com FontStyle. Este enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

normal: os carateres são representados normalmente.
itálico: os carateres são visualmente inclinados para a direita.

FontWeight

Define valores para FontWeight.
KnownFontWeight pode ser utilizado alternadamente com FontWeight, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

normal: os carateres são representados normalmente.
negrito: os carateres são representados com traços mais espessos.

FormRecognizerFeature

Capacidades de suplementos (funcionalidades) que podem ser ativadas para o pedido.

Para obter mais informações sobre as funcionalidades disponíveis no Reconhecedor de Formulários, consulte a documentação do serviço:

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

FormRecognizerRequestBody

Uma entrada de pedido que pode ser carregada como dados binários para o serviço Reconhecedor de Formulários. Reconhecedor de Formulários trata string as entradas como URLs, por isso, para enviar uma cadeia como uma entrada binária, converta primeiro a cadeia num dos seguintes tipos de entrada.

LengthUnit

Define valores para LengthUnit.
KnownLengthUnit pode ser utilizado alternadamente com LengthUnit. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

pixel: unidade de comprimento para ficheiros de imagem.
inch: unidade de comprimento para ficheiros PDF.

OperationDetailsUnion

Detalhes sobre qualquer um dos vários tipos diferentes de operações de gestão de Reconhecedor de Formulários.

OperationKind

Define valores para OperationKind.
KnownOperationKind pode ser utilizado alternadamente com OperationKind. Esta enumeração contém os valores conhecidos suportados pelo serviço.

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 potencialmente um recurso, região ou subscrição diferente.
documentClassifierBuild: crie um novo modelo de classificador personalizado.

OperationStatus

Define valores para OperationStatus.

ParagraphRole

Define valores para ParagraphRole.
KnownParagraphRole pode ser utilizado alternadamente com ParagraphRole. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

pageHeader: texto junto à margem superior da página.
pageFooter: texto junto à margem inferior da página.
pageNumber: número de página.
título: título de nível superior que descreve todo o documento.
sectionHeading: Sub cabeçalho que descreve uma secção do documento.
nota de rodapé: uma nota normalmente colocada a seguir ao conteúdo principal numa página.
formulaBlock: um bloco de fórmulas, muitas vezes com alinhamento partilhado.

SelectionMarkState

Define valores para SelectionMarkState.
KnownSelectionMarkState pode ser utilizado alternadamente com SelectionMarkState. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

selecionado: a marca de seleção está selecionada, muitas vezes indicada por uma verificação ✓ ou cruze X dentro da marca de seleção.
não selecionada: a marca de seleção não está selecionada.

StringIndexType

Tipos de índice de cadeia válidos suportados pelo serviço Reconhecedor de Formulários e clientes SDK.

Enumerações

KnownDocumentBarcodeKind

Valores conhecidos de DocumentBarcodeKind que o serviço aceita.

KnownDocumentBuildMode

Valores conhecidos de DocumentBuildMode que o serviço aceita.

KnownDocumentFieldType

Valores conhecidos de DocumentFieldType que o serviço aceita.

KnownDocumentFormulaKind

Valores conhecidos de DocumentFormulaKind que o serviço aceita.

KnownDocumentSignatureType

Valores conhecidos de DocumentSignatureType que o serviço aceita.

KnownDocumentTableCellKind

Valores conhecidos de DocumentTableCellKind que o serviço aceita.

KnownFontStyle

Valores conhecidos do FontStyle que o serviço aceita.

KnownFontWeight

Valores conhecidos de FontWeight que o serviço aceita.

KnownLengthUnit

Valores conhecidos de LengthUnit que o serviço aceita.

KnownOperationKind

Valores conhecidos de OperationKind que o serviço aceita.

KnownParagraphRole

Valores conhecidos de ParagraphRole que o serviço aceita.

KnownSelectionMarkState

Valores conhecidos de SelectionMarkState que o serviço aceita.