formrecognizer Pacote
Pacotes
aio |
Classes
AccountProperties |
Resumo de todos os modelos personalizados na conta. Novo na versão v2.1: suporte para métodos to_dict e from_dict |
AddressValue |
Um valor de campo de endereço. Novidades na versão 2023-07-31: as propriedades unit, city_district, state_district, suburb, house e level . |
AnalyzeResult |
Resultado da análise do documento. |
AnalyzedDocument |
Um objeto que descreve o local e o conteúdo semântico de um documento. |
BlobFileListSource |
Fonte de conteúdo para uma lista de arquivos no Armazenamento de Blobs do Azure. |
BlobSource |
Fonte de conteúdo para Armazenamento de Blobs do Azure. |
BoundingRegion |
A região delimitadora correspondente a uma página. |
ClassifierDocumentTypeDetails |
Fonte de dados de treinamento. |
CurrencyValue |
Um elemento de valor de moeda. Novo na versão 2023-07-31: a propriedade de código . |
CustomDocumentModelsDetails |
Detalhes sobre os modelos personalizados no recurso Reconhecimento de Formulários. |
CustomFormModel |
Representa um modelo treinado. Novo na versão v2.1: as propriedades model_name e propriedades, suporte para métodos to_dict e from_dict |
CustomFormModelField |
Um campo que o modelo extrairá dos formulários analisados por ele. Novo na versão v2.1: suporte para métodos to_dict e from_dict |
CustomFormModelInfo |
Informações de modelo personalizadas. Novo na versão v2.1: as propriedades model_name e propriedades, suporte para métodos to_dict e from_dict |
CustomFormModelProperties |
Propriedades de modelo opcionais. Novo na versão v2.1: suporte para métodos to_dict e from_dict |
CustomFormSubmodel |
Representa um submodelo que extrai campos de um tipo específico de formulário. Novo na versão v2.1: a propriedade model_id, suporte para métodos to_dict e from_dict |
DocumentAnalysisClient |
DocumentAnalysisClient analisa informações de documentos e imagens e classifica documentos. É a interface a ser usada para analisar com modelos predefinidos (recibos, cartões de visita, faturas, documentos de identidade, entre outros), analisar layout de documentos, analisar tipos de documentos gerais e analisar documentos personalizados com modelos criados (para ver uma lista completa de modelos compatíveis com o serviço, consulte: https://aka.ms/azsdk/formrecognizer/models). Ele fornece métodos diferentes com base em entradas de uma URL e entradas de um fluxo. Observação DocumentAnalysisClient deve ser usado com versões de API 2022-08-31 e para cima. Para usar versões <de API =v2.1, instancie um FormRecognizerClient. Novidades na versão 2022-08-31: o DocumentAnalysisClient e seus métodos de cliente. |
DocumentAnalysisError |
DocumentAnalysisError contém os detalhes do erro retornado pelo serviço. |
DocumentAnalysisInnerError |
Detalhes do erro interno do DocumentAnalysisError. |
DocumentBarcode |
Um objeto de código de barras. |
DocumentClassifierDetails |
Informações do classificador de documentos. Inclui os tipos de documento que o modelo pode classificar. |
DocumentField |
Um objeto que representa o conteúdo e o local de um valor de campo de documento. Novo na versão 2023-07-31: o valor booliano value_type e booliano |
DocumentFormula |
Um objeto de fórmula. |
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 documento 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 representa o conteúdo encontrado em uma única linha do documento. |
DocumentModelAdministrationClient |
DocumentModelAdministrationClient é a interface Reconhecimento de Formulários a ser usada para criar e gerenciar modelos. Ele fornece métodos para criar modelos e classificadores, bem como métodos para exibir e excluir modelos e classificadores, exibir operações de modelo e classificador, acessar informações de conta, copiar modelos para outro recurso Reconhecimento de Formulários e redigir um novo modelo de uma coleção de modelos existentes. Observação DocumentModelAdministrationClient deve ser usado com versões de API 2022-08-31 e para cima. Para usar versões <de API =v2.1, crie uma instância de formTrainingClient. Novidades na versão 2022-08-31: o DocumentModelAdministrationClient e seus métodos de cliente. |
DocumentModelAdministrationLROPoller |
Implementa um protocolo seguido por objetos de sondagem retornados. |
DocumentModelDetails |
Informações do modelo de documento. Inclui os tipos de documento que o modelo pode analisar. Novo na versão 2023-07-31: a propriedade expires_on . |
DocumentModelSummary |
Um resumo das informações do modelo de documento, incluindo a ID do modelo, sua descrição e quando o modelo foi criado. Novo na versão 2023-07-31: a propriedade expires_on . |
DocumentPage |
Elementos de conteúdo e layout extraídos de uma página da entrada. Novo na versão 2023-07-31: as propriedades de códigos de barras e fórmulas . |
DocumentParagraph |
Um objeto de parágrafo geralmente composto por linhas contíguas com alinhamento e espaçamento comuns. Novidades na versão 2023-07-31: a função formulaBlock . |
DocumentSelectionMark |
Um objeto de marca de seleção que representa marcar caixas, botões de opção e outros elementos que indicam uma seleção. |
DocumentSpan |
Região contígua do conteúdo da propriedade, especificada como um deslocamento e comprimento. |
DocumentStyle |
Um objeto que representa os estilos de texto observados. Novidades na versão 2023-07-31: as propriedades similar_font_family, font_style, font_weight, cor e background_color . |
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. |
DocumentTypeDetails |
DocumentTypeDetails representa um tipo de documento que um modelo pode reconhecer, incluindo seus campos e tipos, e a confiança para esses campos. |
DocumentWord |
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. |
FieldData |
Contém os dados do campo de formulário. Isso inclui o texto, o local do texto no formulário e uma coleção dos elementos que compõem o texto. Novo na versão v2.1: FormSelectionMark é adicionado aos tipos retornados na lista de field_elements, suporte para métodos to_dict e from_dict |
FormElement |
Tipo base que inclui propriedades para um elemento de formulário. Novo na versão v2.1: suporte para métodos to_dict e from_dict |
FormField |
Representa um campo reconhecido em um formulário de entrada. Novo na versão v2.1: suporte para métodos to_dict e from_dict |
FormLine |
Um objeto que representa uma linha de texto extraída. Novo na versão v2.1: propriedade appearance, suporte para métodos to_dict e from_dict |
FormPage |
Representa uma página reconhecida do documento de entrada. Contém linhas, palavras, marcas de seleção, tabelas e metadados de página. Novo na versão v2.1: propriedade selection_marks, suporte para métodos to_dict e from_dict |
FormPageRange |
O intervalo de páginas baseado em 1 do formulário. Novo na versão v2.1: suporte para métodos to_dict e from_dict |
FormRecognizerClient |
FormRecognizerClient extrai informações de formulários e imagens em dados estruturados. É a interface a ser usada para analisar com modelos predefinidos (recibos, cartões de visita, faturas, documentos de identidade), reconhecer conteúdo/layout de formulários e analisar formulários personalizados de modelos treinados. Ele fornece métodos diferentes com base em entradas de uma URL e entradas de um fluxo. Observação FormRecognizerClient deve ser usado com versões <de API =v2.1. Para usar as versões de API 2022-08-31 e posteriores, instancie um DocumentAnalysisClient. |
FormRecognizerError |
Representa um erro que ocorreu durante o treinamento. Novo na versão v2.1: suporte para métodos to_dict e from_dict |
FormSelectionMark |
Informações sobre a marca de seleção extraída. Novo na versão v2.1: suporte para métodos de to_dict e from_dict |
FormTable |
Informações sobre a tabela extraída contida em uma página. Novo na versão v2.1: a propriedade bounding_box, suporte para métodos de to_dict e from_dict |
FormTableCell |
Representa uma célula contida em uma tabela reconhecida do documento de entrada. Novo na versão v2.1: FormSelectionMark é adicionado aos tipos retornados na lista de field_elements, suporte para métodos de to_dict e from_dict |
FormTrainingClient |
FormTrainingClient é a interface Reconhecimento de Formulários a ser usada para criar e gerenciar modelos personalizados. Ele fornece métodos para modelos de treinamento nos formulários que você fornece, bem como métodos para exibir e excluir modelos, acessar propriedades de conta, copiar modelos para outro recurso Reconhecimento de Formulários e redigir modelos de uma coleção de modelos existentes treinados com rótulos. Observação FormTrainingClient deve ser usado com versões <de API =v2.1. Para usar as versões da API 2022-08-31 e posteriores, instancie um DocumentModelAdministrationClient. |
FormWord |
Representa uma palavra reconhecida do documento de entrada. Novo na versão v2.1: suporte para métodos de to_dict e from_dict |
OperationDetails |
OperationDetails consiste em informações sobre a operação de modelo, incluindo o resultado ou o erro da operação se ela tiver sido concluída. Observe que as informações da operação só persistem por 24 horas. Se a operação tiver sido bem-sucedida, o modelo também poderá ser acessado usando as <xref:azure.ai.formrecognizer.get_document_model>APIs , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers> . Novidades na versão 2023-07-31: o tipo documentClassifierBuild e o resultado documentClassifierDetails . |
OperationSummary |
Informações de operação de modelo, incluindo o tipo e status da operação, quando ela foi criada e muito mais. Observe que as informações da operação só persistem por 24 horas. Se a operação tiver sido bem-sucedida, o modelo poderá ser acessado usando as <xref:azure.ai.formrecognizer.get_document_model>APIs , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers> . Para descobrir por que uma operação falhou, use <xref:azure.ai.formrecognizer.get_operation> e forneça o operation_id. Novo na versão 2023-07-31: o tipo documentClassifierBuild . |
Point |
A coordenada x, y de um ponto em uma caixa delimitadora ou polígono. Novo na versão v2.1: suporte para métodos de to_dict e from_dict |
QuotaDetails |
Cota usada, limite e próxima data/hora de redefinição. |
RecognizedForm |
Representa um formulário que foi reconhecido por um modelo treinado ou predefinido. A propriedade fields contém os campos de formulário que foram extraídos do formulário. Tabelas, linhas de texto/palavras e marcas de seleção são extraídas por página e encontradas na propriedade pages. Novo na versão v2.1: as propriedades form_type_confidence e model_id, suporte para métodos de to_dict e from_dict |
ResourceDetails |
Detalhes sobre o recurso de Reconhecimento de Formulários. Novo na versão 2023-07-31: a propriedade neural_document_model_quota . |
TextAppearance |
Um objeto que representa a aparência da linha de texto. Novo na versão v2.1: suporte para métodos de to_dict e from_dict |
TrainingDocumentInfo |
Relatório de um documento individual usado para treinar um modelo personalizado. Novo na versão v2.1: a propriedade model_id, suporte para métodos de to_dict e from_dict |
Enumerações
AnalysisFeature |
Recursos de análise de documento a serem habilitados. |
CustomFormModelStatus |
Status que indica a preparação do modelo para uso. |
DocumentAnalysisApiVersion |
Reconhecimento de Formulários versões da API compatíveis com DocumentAnalysisClient e DocumentModelAdministrationClient. |
FieldValueType |
Tipo de dados semânticos do valor do campo. Novo na versão v2.1: os valores selectionMark e countryRegion |
FormContentType |
Tipo de conteúdo para upload. Novidades na versão v2.1: suporte para image/bmp |
FormRecognizerApiVersion |
Reconhecimento de Formulários versões da API compatíveis com FormRecognizerClient e FormTrainingClient. |
LengthUnit |
A unidade usada pelas propriedades de largura, altura e caixa delimitadora. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada". |
ModelBuildMode |
O modo usado ao criar modelos personalizados. Para obter mais informações, consulte https://aka.ms/azsdk/formrecognizer/buildmode. |
TrainingStatus |
Status da operação de treinamento. |
Azure SDK for Python