@azure/ai-form-recognizer package

Classes

AzureKeyCredential	Uma credencial baseada em chave estática que dá suporte à atualização do valor da chave subjacente.
DocumentAnalysisClient	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 clientes dão suporte a dois meios de autenticação: Active Directory do Azure import { DefaultAzureCredential } from "@azure/identity"; import { DocumentAnalysisClient } from "@azure/ai-form-recognizer"; const credential = new DefaultAzureCredential(); const client = new DocumentAnalysisClient( "https://<resource name>.cognitiveservices.azure.com", credential, ); Chave de API (Chave de Assinatura) import { AzureKeyCredential, DocumentAnalysisClient } from "@azure/ai-form-recognizer"; const credential = new AzureKeyCredential("<API key>"); const client = new DocumentAnalysisClient( "https://<resource name>.cognitiveservices.azure.com", credential, );
DocumentModelAdministrationClient	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: Active Directory do Azure import { DefaultAzureCredential } from "@azure/identity"; import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; const credential = new DefaultAzureCredential(); const client = new DocumentModelAdministrationClient( "https://<resource name>.cognitiveservices.azure.com", credential, ); Chave de API (Chave de Assinatura) import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; const credential = new AzureKeyCredential("<API key>"); const client = new DocumentModelAdministrationClient( "https://<resource name>.cognitiveservices.azure.com", 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 do Documento pode ser determinado pelo modelo usado para executar 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 AnalyzeDocument é uma instância de um dos tipos de documento em 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 Blobs do Azure e uma lista de arquivos JSONL dentro do contêiner.
AzureBlobFileListSourceDetails	Lista de arquivos no Armazenamento de Blobs do Azure.
AzureBlobSource	Uma fonte de dados de treinamento definida por um Contêiner de Blobs do Azure.
AzureBlobSourceDetails	Conteúdo do Armazenamento de Blobs do Azure.
BeginBuildDocumentClassifierOptions	Opções para a operação de build do classificador de documento.
BeginBuildDocumentModelOptions	Opções para a operação de build de modelo.
BeginComposeDocumentModelOptions	Opções para a operação de composição de modelo.
BeginCopyModelOptions	Opções para a operação de modelo de cópia.
BoundingRegion	Delimitando o polígono em uma página específica da entrada.
ClassifierDocumentTypeDetails	Informações de tipo de documento do classificador.
ClassifyDocumentOptions	Opções para a operação de classificação de documento.
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 e modelId especificados.
CreateDocumentModelOptions	Opções para a operação de criação de modelo.
CurrencyValue	Valor do campo moeda.
CustomDocumentModelsDetails	Detalhes sobre modelos de documentos personalizados.
DeleteDocumentModelOptions	Opções de 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 eventualmente 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 uma 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 booliano.
DocumentCaption	Um objeto que representa o local e o conteúdo de uma legenda de tabela.
DocumentClassifierBuildOperationDetails	Obter objeto de resposta da Operação.
DocumentClassifierDetails	Informações do classificador de documento.
DocumentClassifierDocumentTypeSources	Um conjunto de fontes usadas 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.
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 Date.
DocumentFieldCommon	Campos comuns a todas as variantes do 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 distinto (chave) e valor de campo (pode estar vazio).
DocumentLanguage	Um objeto que representa o idioma detectado para um determinado intervalo 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 conhecida que dá suporte à extração de documentos estruturados. Consulte o método beginAnalyzeDocument de DocumentAnalysisClient, que dá suporte ao consumo desses objetos DocumentModel em vez de cadeias de caracteres de ID do modelo para fornecer tipos de resultados mais fortes.
DocumentModelAdministrationClientOptions	Opções configuráveis para DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Obter objeto de resposta da Operação.
DocumentModelComposeOperationDetails	Obter objeto de resposta da Operação.
DocumentModelCopyToOperationDetails	Obter objeto de resposta da Operação.
DocumentModelDetails	Informações do modelo de 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 layout e conteúdo 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 um 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 um deslocamento e comprimento.
DocumentStringField	Um DocumentField que tem um valor de cadeia de caracteres.
DocumentStyle	Um objeto que representa os 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 de tabela.
DocumentTimeField	Um DocumentField que tem um valor de tempo, representado como uma cadeia de caracteres.
DocumentTypeDetails	Informações de tipo de documento.
DocumentValueField	Um campo simples que tem um valor primitivo, como uma cadeia de caracteres, um número etc.
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.
ErrorModel	Informações de erro.
GetCopyAuthorizationOptions	Opções para o método obter autorização de cópia.
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 recurso do Reconhecimento de Formulários.
HasBoundingPolygon	Elementos de documento simples, como palavras, marcas de seleção e linhas, são limitados pelo polígono.
InnerError	Erro detalhado.
ListModelsOptions	Opções para listagem de 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 da Operação.
OperationSummary	Informações da operação.
Point2D	Representa um ponto usado para definir polígonos delimitados. A unidade é 'pixel' ou 'inch' (Consulte LengthUnit).
PollerOptions	Opções para operações de execução longa (pollers) nos clientes do Reconhecimento de Formulários.
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 execução (poller) que acompanha 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 podem ser usados de forma 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 GS1 de 12 dígitos. UPCE: Código do Produto Universal GS1 de 6 dígitos. código39: 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: 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). databar: código de barras GS1 DataBar. código93: 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: micro código QR, conforme definido em ISO/IEC 23941:2022. astecas: 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.
DocumentBuildMode	Define valores para DocumentBuildMode. KnownDocumentBuildMode pode ser usado de forma 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 modelo: direcionar documentos com modelos visuais semelhantes. neural: suporte a documentos com modelos visuais diversos.
DocumentClassifierPoller	Uma operação de longa execução (poller) que controla 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 documento. Um de: Origem do Blob BlobFileListSource
DocumentField	Um campo extraído. A propriedade kind identifica (discrimina) o tipo do DocumentField.
DocumentFieldType	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 (YYYY-MM-DD). tempo: 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 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 alfa-3 iso 3166-1 (por exemplo, EUA). assinatura: a assinatura está presente? matriz: lista de subcampos do mesmo tipo. objeto: lista nomeada de subcampos de tipos potencialmente diferentes. moeda: valor de moeda com símbolo e unidade de moeda opcionais. endereço: endereço analisado. booliano: valor booliano, normalizado como verdadeiro ou falso.
DocumentFormulaKind	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. exibir: uma fórmula no modo de exibição que ocupa uma linha inteira.
DocumentModelBuildMode	Modos de build de modelo com suporte. O modo de build de 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 que é 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 seguinte link para obter mais informações: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	Uma operação de longa execução (poller) que acompanha 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 de: Origem do Blob BlobFileListSource
DocumentSignatureType	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.
DocumentTableCellKind	Define valores para DocumentTableCellKind. KnownDocumentTableCellKind podem ser usados 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 conteúdo: contém o conteúdo/os 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, 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.
FontWeight	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. em negrito: os caracteres são representados com traços mais espessos.
FormRecognizerFeature	Recursos (recursos) de complemento 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
FormRecognizerRequestBody	Uma entrada de solicitação que pode ser carregada como dados binários para o serviço Reconhecimento de Formulários. O Reconhecimento de Formulários trata string entradas como URLs, portanto, para enviar uma cadeia de caracteres como uma entrada 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, 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.
OperationDetailsUnion	Detalhes sobre qualquer um dos vários tipos diferentes de operações de gerenciamento do Reconhecimento de Formulários.
OperationKind	Define valores para OperationKind. KnownOperationKind pode ser usado de forma intercambiável com o 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 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, 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 nota geralmente colocada após o conteúdo principal em 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, 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 uma verificação ✓ ou x cruzado dentro da marca de seleção. não selecionada: a marca de seleção não está selecionada.
StringIndexType	Tipos de índice de cadeia de caracteres válidos compatíveis com o serviço reconhecimento 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 de FontStyle que o serviço aceita.
KnownFontWeight	Valores conhecidos de FontWeight que o serviço aceita.
KnownFormRecognizerAudience	Define os públicos-alvo de nuvem conhecidos para o Reconhecimento de Formulários. Para autenticar com a ID do Entra (usando um TokenCredential) em um ambiente de nuvem soberana , forneça o valor apropriado abaixo como a audience opção ao criar um DocumentAnalysisClient ou DocumentModelAdministrationClient. O valor padrão é adequado para recursos do Reconhecimento de Formulários criados na Nuvem Pública do Azure, portanto, esse valor só é necessário para usar o Reconhecimento de Formulários em um ambiente de nuvem diferente.
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.