formrecognizer Pacote

Pacote

aio

Classes

AccountProperties	Resumo de todos os modelos personalizados na conta. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
AddressValue	Um valor de campo de endereço. Novidades na versão 2023-07-31: A unidade, city_district, state_district, subúrbio, casa e propriedades de nível .
AnalyzeResult	Resultado da análise de documentos.
AnalyzedDocument	Um objeto que descreve a localização e o conteúdo semântico de um documento.
BlobFileListSource	Origem de conteúdo de uma lista de ficheiros no Armazenamento de Blobs do Azure.
BlobSource	Origem de conteúdo para Armazenamento de Blobs do Azure.
BoundingRegion	A região delimitadora correspondente a uma página.
ClassifierDocumentTypeDetails	Origem de dados de preparação.
CurrencyValue	Um elemento de valor de moeda. Novidade na versão 2023-07-31: a propriedade do código .
CustomDocumentModelsDetails	Detalhes sobre os modelos personalizados no recurso Reconhecedor de Formulários.
CustomFormModel	Representa um modelo preparado. Novo na versão v2.1: as propriedadesmodel_name e propriedades, suporte para métodos to_dict e from_dict
CustomFormModelField	Um campo que o modelo irá extrair dos formulários que analisa. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
CustomFormModelInfo	Informações personalizadas do modelo. Novo na versão v2.1: as propriedadesmodel_name e propriedades, suporte para métodos to_dict e from_dict
CustomFormModelProperties	Propriedades de modelo opcionais. Novidade na versão v2.1: Suporte para métodos de 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 de to_dict e from_dict
DocumentAnalysisClient	DocumentAnalysisClient analisa informações de documentos e imagens e classifica documentos. É a interface a utilizar para analisar com modelos pré-criados (recibos, cartões de visita, faturas, documentos de identidade, entre outros), analisar esquemas de documentos, analisar tipos de documentos gerais e analisar documentos personalizados com modelos criados (para ver uma lista completa de modelos suportados pelo serviço, consulte: https://aka.ms/azsdk/formrecognizer/models). Fornece diferentes métodos baseados em entradas de um URL e entradas de um fluxo. Nota DocumentAnalysisClient deve ser utilizado com versões da API 2022-08-31 e mais. Para utilizar versões <da API =v2.1, instanciar um FormulárioRecognizerClient. Novidades na versão 2022-08-31: o DocumentAnalysisClient e os respetivos métodos de cliente.
DocumentAnalysisError	DocumentAnalysisError contém os detalhes do erro devolvido 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 a localização de um valor de campo de documento. Novidade na versão 2023-07-31: O valor booleano value_type e bool
DocumentFormula	Um objeto de fórmula.
DocumentKeyValueElement	Um objeto que representa a chave de campo ou o valor num par chave-valor.
DocumentKeyValuePair	Um objeto que representa um campo de documento 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 representa o conteúdo encontrado numa única linha do documento.
DocumentModelAdministrationClient	DocumentModelAdministrationClient é a interface de Reconhecedor de Formulários a utilizar para criar e gerir modelos. Fornece métodos para criar modelos e classificadores, bem como métodos para visualizar e eliminar modelos e classificadores, ver operações de modelos e classificadores, aceder às informações da conta, copiar modelos para outro recurso Reconhecedor de Formulários e compor um novo modelo a partir de uma coleção de modelos existentes. Nota DocumentModelAdministrationClient deve ser utilizado com versões da API 2022-08-31 e mais. Para utilizar versões <da API =v2.1, instanciar um FormTrainingClient. Novidade na versão 2022-08-31: o DocumentModelAdministrationClient e os respetivos métodos de cliente.
DocumentModelAdministrationLROPoller	Implementa um protocolo seguido de objetos de poller devolvidos.
DocumentModelDetails	Informações do modelo de documentos. Inclui os tipos de documento que o modelo pode analisar. Novidade na versão 2023-07-31: a propriedade expires_on .
DocumentModelSummary	Um resumo das informações do modelo de documento, incluindo o ID do modelo, a respetiva descrição e quando o modelo foi criado. Novidade na versão 2023-07-31: a propriedade expires_on .
DocumentPage	Elementos de conteúdo e esquema extraídos de uma página da entrada. Novidades na versão 2023-07-31: os códigos de barras e as propriedades das fórmulas .
DocumentParagraph	Geralmente, um objeto de parágrafo consiste em linhas contíguas com alinhamento e espaçamento comuns. Novidade na versão 2023-07-31: a função formulaBlock .
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.
DocumentSpan	Região contígua do conteúdo da propriedade, especificada como desvio e comprimento.
DocumentStyle	Um objeto que representa 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 composto por 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.
DocumentTypeDetails	DocumentTypeDetails representa um tipo de documento que um modelo pode reconhecer, incluindo os respetivos campos e tipos, e a confiança para esses campos.
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.
FieldData	Contém os dados do campo de formulário. Isto inclui o texto, a localização 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 devolvidos na lista de field_elements, suporte para métodos to_dict e from_dict
FormElement	Tipo de base que inclui propriedades para um elemento de formulário. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
FormField	Representa um campo reconhecido num formulário de entrada. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
FormLine	Um objeto que representa uma linha de texto extraída. Novidade na versão v2.1: propriedade de aspeto, suporte para to_dict e métodos de from_dict
FormPage	Representa uma página reconhecida a partir 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 de to_dict e from_dict
FormPageRange	O intervalo de páginas baseado em 1 do formulário. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
FormRecognizerClient	FormRecognizerClient extrai informações de formulários e imagens em dados estruturados. É a interface a utilizar para analisar com modelos pré-criados (recibos, cartões de visita, faturas, documentos de identidade), reconhecer conteúdos/esquemas de formulários e analisar formulários personalizados de modelos preparados. Fornece diferentes métodos baseados em entradas de um URL e entradas de um fluxo. Nota FormRecognizerClient deve ser utilizado com versões <da API =v2.1. Para utilizar as versões da API 2022-08-31 e para cima, instanciar um DocumentAnalysisClient.
FormRecognizerError	Representa um erro que ocorreu durante a preparação. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
FormSelectionMark	Informações sobre a marca de seleção extraída. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
FormTable	Informações sobre a tabela extraída contida numa página. Novidade 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 numa tabela reconhecida no documento de entrada. Novo na versão v2.1: FormSelectionMark é adicionado aos tipos devolvidos na lista de field_elements, suporte para métodos to_dict e from_dict
FormTrainingClient	FormTrainingClient é a interface Reconhecedor de Formulários a utilizar para criar e gerir modelos personalizados. Fornece métodos para modelos de preparação nos formulários fornecidos, bem como métodos para visualizar e eliminar modelos, aceder às propriedades da conta, copiar modelos para outro recurso Reconhecedor de Formulários e compor modelos de uma coleção de modelos existentes preparados com etiquetas. Nota FormTrainingClient deve ser utilizado com as versões <da API =v2.1. Para utilizar as versões de API 2022-08-31 e mais, instanciar um DocumentModelAdministrationClient.
FormWord	Representa uma palavra reconhecida a partir do documento de entrada. Novidade 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 do modelo, incluindo o resultado ou o erro da operação, se tiver sido concluída. Tenha em atenção que as informações da operação só persistem durante 24 horas. Se a operação tiver sido bem-sucedida, o modelo também pode ser acedido com 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> Novidade na versão 2023-07-31: o tipo documentClassifierBuild e o resultado DocumentClassifierDetails .
OperationSummary	Informações da operação de modelo, incluindo o tipo e o estado da operação, quando foi criada, etc. Tenha em atenção que as informações da operação só persistem durante 24 horas. Se a operação tiver sido bem-sucedida, o modelo pode ser acedido com 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 saber por que motivo uma operação falhou, utilize <xref:azure.ai.formrecognizer.get_operation> e forneça o operation_id. Novidade na versão 2023-07-31: o tipo documentClassifierBuild .
Point	A coordenada x, y de um ponto numa caixa delimitadora ou polígono. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
QuotaDetails	Quota utilizada, limite e próxima data/hora de reposição.
RecognizedForm	Representa um formulário que foi reconhecido por um modelo preparado ou pré-criado. A propriedade campos contém os campos de formulário que foram extraídos do formulário. As tabelas, linhas/palavras de texto e marcas de seleção são extraídas por página e encontradas na propriedade pages. Novidade 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 Reconhecedor de Formulários. Novidade na versão 2023-07-31: a propriedade neural_document_model_quota .
TextAppearance	Um objeto que representa o aspeto da linha de texto. Novidade na versão v2.1: Suporte para métodos de to_dict e from_dict
TrainingDocumentInfo	Relatório de um documento individual utilizado para preparar um modelo personalizado. Novidade na versão v2.1: a propriedade model_id, suporte para to_dict e métodos de from_dict

Enumerações

AnalysisFeature	Funcionalidades de análise de documentos a ativar.
CustomFormModelStatus	Estado a indicar a preparação do modelo para utilização.
DocumentAnalysisApiVersion	Reconhecedor de Formulários versões da API suportadas por DocumentAnalysisClient e DocumentModelAdministrationClient.
FieldValueType	Tipo de dados semântico do valor do campo. Novo na versão v2.1: Os valores selectionMark e countryRegion
FormContentType	Tipo de conteúdo para carregamento. Novo na versão v2.1: Suporte para imagem/bmp
FormRecognizerApiVersion	Reconhecedor de Formulários versões da API suportadas por FormRecognizerClient e FormTrainingClient.
LengthUnit	A unidade utilizada pelas propriedades da largura, altura e caixa delimitadora. Para imagens, a unidade é "pixel". Para PDF, a unidade é "polegada".
ModelBuildMode	O modo utilizado ao criar modelos personalizados. Para obter mais informações, consulte https://aka.ms/azsdk/formrecognizer/buildmode.
TrainingStatus	Estado da operação de preparação.