@azure/ai-form-recognizer package

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

Um cliente para interagir com os recursos de análise do serviço Reconhecimento de Formulários.

Exemplos:

O serviço Reconhecimento de Formulários e os clientes dão suporte a 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 Assinatura)

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);

Um cliente para interagir com os recursos de gerenciamento de modelos do serviço Reconhecimento de Formulários, como criar, ler, listar, excluir 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 Assinatura)

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);

Valor do campo de endereço.

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

O resultado de uma operação de análise. O tipo do Documento pode ser determinado pelo modelo usado para executar a análise.

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

Um objeto de documento extraído.

AnalyzeDocument é uma instância de um dos tipos de documento em um modelo. Seus campos correspondem ao esquema de campo do tipo de documento.

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

Lista de arquivos em Armazenamento de Blobs do Azure.

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

Armazenamento de Blobs do Azure conteúdo.

Opções para a operação de build do classificador de documento.

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

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

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

Polígono delimitação em uma página específica da entrada.

Informações de tipo de documento do classificador.

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

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

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

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

Valor do campo moeda.

Detalhes sobre modelos de documentos personalizados.

Opções para exclusão de modelo.

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

Opções configuráveis para DocumentAnalysisClient.

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

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

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

Um código de barras extraído.

Um DocumentField que tem um valor booliano.

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

Obter objeto de resposta operação.

Informações do classificador de documentos.

Um conjunto de fontes usado para criar um classificador de documento. Este é um mapa de nomes de tipo de documento para fontes que serão usadas para treinar o modelo para classificar documentos do tipo de origem correspondente.

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

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

Um DocumentField que descreve uma quantidade de uma determinada moeda.

Um DocumentField que tem um valor Date.

Campos comuns a todas as variantes do DocumentField.

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

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

Uma fórmula extraída.

Um DocumentField que tem um valor inteiro.

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

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

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

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.

Uma especificação de modelo conhecida que dá suporte à extração de documentos estruturados.

Consulte o beginAnalyzeDocument método de DocumentAnalysisClient, que dá suporte ao consumo desses DocumentModel objetos em vez de cadeias de caracteres de ID de modelo para fornecer tipos de resultado mais fortes.

Opções configuráveis para DocumentModelAdministrationClient.

Obter objeto de resposta operação.

Obter objeto de resposta operação.

Obter objeto de resposta operação.

Informações do modelo de documento.

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

Resumo do modelo de documento.

Um DocumentField que tem um valor numérico.

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

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

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

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

Um objeto de marca de seleção que representa marcar caixas, botões de opção e outros elementos que indicam uma seleção.

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

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

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

Um DocumentField que tem um valor de cadeia de caracteres.

Um objeto que representa os estilos de texto observados.

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

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

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

Informações de tipo de documento.

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

Um objeto de palavra que consiste em uma sequência contígua de caracteres. Para idiomas delimitados por espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra.

Informações de erro.

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

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

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

Opções para recuperar Reconhecimento de Formulários informações de recursos.

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

Erro detalhado.

Opções para listar modelos.

Opções para listar operações.

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

Obter objeto de resposta operação.

Informações da operação.

Representa um ponto usado para definir polígonos delimitados. A unidade é 'pixel' ou 'inch' (consulte LengthUnit).

Opções para operações de longa execução (sondadores) nos clientes Reconhecimento de Formulários.

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

Informações gerais sobre o recurso atual.

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

Define valores para AnalyzeResultOperationStatus.

Define valores para DocumentBarcodeKind.
KnownDocumentBarcodeKind pode ser usado intercambiável com DocumentBarcodeKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

QRCode: código QR, conforme definido em ISO/IEC 18004:2015.
PDF417: PDF417, conforme definido no ISO 15438.
UPCA: Código do Produto Universal de 12 dígitos GS1.
UPCE: código de produto universal de 6 dígitos GS1.
Code39: código de barras 39, conforme definido em ISO/IEC 16388:2007.
Código128: código de barras 128, conforme definido em ISO/IEC 15417:2007.
EAN8: GS1 Número do Artigo Internacional de 8 dígitos (Número do Artigo Europeu).
EAN13: GS1 Número do Artigo Internacional de 13 dígitos (Número do Artigo Europeu).
DataBar: código de barras GS1 DataBar.
Code93: código de barras 93, conforme definido em ANSI/AIM BC5-1995.
Codabar: código de barras codabar, conforme definido em ANSI/AIM BC3-1995.
DataBarExpanded: código de barras expandido GS1 DataBar.
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 asteca, 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.

Define valores para DocumentBuildMode.
KnownDocumentBuildMode pode ser usado intercambiável com DocumentBuildMode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

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

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

Um destes:

• BlobSource
• BlobFileListSource

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

Define valores para DocumentFieldType.
KnownDocumentFieldType pode ser usado de forma intercambiável com DocumentFieldType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

cadeia de caracteres: texto sem formatação.
data: data, normalizada para o formato ISO 8601 (YYY-MM-DD).
time: Time, 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 ponto flutuante, normalizado para ponto flutuante de precisão dupla.
inteiro: número inteiro, normalizado para inteiro com sinal de 64 bits.
selectionMark: o campo está selecionado?
countryRegion: país/região, normalizado para o formato ISO 3166-1 alfa-3 (por exemplo, EUA).
assinatura: a assinatura está presente?
matriz: lista de subcampos do mesmo tipo.
object: lista nomeada de subcampos de tipos potencialmente diferentes.
moeda: valor da moeda com o símbolo e a unidade de moeda opcionais.
endereço: endereço analisado.
booleano: valor booliano, normalizado como true ou false.

Define valores para DocumentFormulaKind.
KnownDocumentFormulaKind pode ser usado de forma intercambiável com DocumentFormulaKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

Modos de build de modelo com suporte. O modo de build 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 do 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).
• "template", que exige que todos os documentos tenham o mesmo layout fixo (modelo).

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

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

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

Um destes:

• BlobSource
• BlobFileListSource

Define valores para DocumentSignatureType.
KnownDocumentSignatureType pode ser usado de forma intercambiável com DocumentSignatureType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

assinado: uma assinatura é detectada.
sem sinal: nenhuma assinatura é detectada.

Define valores para DocumentTableCellKind.
KnownDocumentTableCellKind pode ser usado de forma intercambiável com DocumentTableCellKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

content: contém o main conteúdo/dados.
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.
description: descreve o conteúdo em (partes de) da tabela.

Define valores para FontStyle.
KnownFontStyle pode ser usado de forma intercambiável com FontStyle, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

Define valores para FontWeight.
KnownFontWeight pode ser usado de forma intercambiável com FontWeight, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

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

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

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

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

Define valores para LengthUnit.
KnownLengthUnit pode ser usado de forma intercambiável com LengthUnit, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

pixel: unidade de comprimento para arquivos de imagem.
polegada: unidade de comprimento para arquivos PDF.

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

Define valores para OperationKind.
KnownOperationKind pode ser usado de forma intercambiável com OperationKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

documentModelBuild: crie um novo modelo de documento personalizado.
documentModelCompose: redigir um novo modelo de documento personalizado de modelos existentes.
documentModelCopyTo: copie um modelo de documento existente para potencialmente um recurso, região ou assinatura diferente.
documentClassifierBuild: crie um novo modelo de classificador personalizado.

Define valores para OperationStatus.

Define valores para ParagraphRole.
KnownParagraphRole pode ser usado de forma intercambiável com ParagraphRole, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

pageHeader: texto próximo à borda superior da página.
pageFooter: texto próximo à borda inferior da página.
pageNumber: número da página.
título: título de nível superior que descreve todo o documento.
sectionHeading: subtítulo que descreve uma seção do documento.
nota de rodapé: uma anotação geralmente colocada após o main conteúdo em uma página.
formulaBlock: um bloco de fórmulas, geralmente com alinhamento compartilhado.

Define valores para SelectionMarkState.
KnownSelectionMarkState pode ser usado de forma intercambiável com SelectionMarkState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

selecionado: a marca de seleção é selecionada, geralmente indicada por um marcar ✓ ou X cruzado dentro da marca de seleção.
não selecionado: a marca de seleção não está selecionada.

Tipos de índice de cadeia de caracteres válidos compatíveis com o serviço Reconhecimento de Formulários e clientes do SDK.

Valores conhecidos de DocumentBarcodeKind que o serviço aceita.

Valores conhecidos de DocumentBuildMode que o serviço aceita.

Valores conhecidos de DocumentFieldType que o serviço aceita.

Valores conhecidos de DocumentFormulaKind que o serviço aceita.

Valores conhecidos de DocumentSignatureType que o serviço aceita.

Valores conhecidos de DocumentTableCellKind que o serviço aceita.

Valores conhecidos de FontStyle que o serviço aceita.

Valores conhecidos de FontWeight que o serviço aceita.

Valores conhecidos de LengthUnit que o serviço aceita.

Valores conhecidos de OperationKind que o serviço aceita.

Valores conhecidos de ParagraphRole que o serviço aceita.

Valores conhecidos de SelectionMarkState que o serviço aceita.