DocumentModelAdministrationAsyncClient Classe

  • java.lang.Object
    • com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient

public final class DocumentModelAdministrationAsyncClient

Essa classe fornece um cliente assíncrono para se conectar ao Reconhecimento de Formulários Serviço Cognitivo do Azure.

Esse cliente fornece métodos assíncronos para executar:

  1. Criar um modelo personalizado: extraia dados de seus documentos específicos criando modelos personalizados usando o beginBuidlDocumentModel método para fornecer uma URL SAS de contêiner para seu contêiner de Blob de Armazenamento do Azure.
  2. Modelos personalizados compostos: cria um novo modelo de tipos de documento de coleção de modelos existentes usando o beginComposeDocumentModel método .
  3. Copiar modelo personalizado: copie um modelo de Reconhecimento de Formulários personalizado para um recurso de Reconhecimento de Formulários de destino usando o beginCopyDocumentModelTo método .
  4. Gerenciamento de modelo personalizado: obtenha informações detalhadas, exclua e liste modelos personalizados usando métodos getDocumentModel(String modelId)edeleteDocumentModel(String modelId), listDocumentModels() respectivamente.
  5. Gerenciamento de operações: obtenha informações detalhadas e operações de lista na conta Reconhecimento de Formulários usando métodos getOperation(String operationId) elistOperations(), respectivamente.
  6. Sondagem e retornos de chamada: inclui mecanismos para sondar o serviço para marcar o status de uma operação de análise ou registrar retornos de chamada para receber notificações quando a análise for concluída.

Nota: Esse cliente só dá V2022_08_31 suporte e é mais recente. Para usar uma versão FormRecognizerClient de serviço mais antiga e FormTrainingClient.

Os clientes de serviço são o ponto de interação para os desenvolvedores usarem o Reconhecimento de Formulários do Azure. DocumentModelAdministrationClient é o cliente de serviço síncrono e DocumentModelAdministrationAsyncClient é o cliente de serviço assíncrono. Os exemplos mostrados neste documento usam um objeto de credencial chamado DefaultAzureCredential para autenticação, que é apropriado para a maioria dos cenários, incluindo ambientes locais de desenvolvimento e produção. Além disso, recomendamos usar a identidade gerenciada para autenticação em ambientes de produção. Você pode encontrar mais informações sobre diferentes maneiras de autenticação e seus tipos de credencial correspondentes na documentação da Identidade do Azure".

Exemplo: construir um DocumentModelAdministrationAsyncClient com DefaultAzureCredential

O exemplo de código a seguir demonstra a criação de um DocumentModelAdministrationAsyncClient, usando o 'DefaultAzureCredentialBuilder' para configurá-lo.

DocumentModelAdministrationAsyncClient client = new DocumentModelAdministrationClientBuilder()
     .endpoint("{endpoint}")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();

Além disso, consulte o exemplo de código abaixo a ser usado AzureKeyCredential para a criação do cliente.

DocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =
     new DocumentModelAdministrationClientBuilder()
         .credential(new AzureKeyCredential("{key}"))
         .endpoint("{endpoint}")
         .buildAsyncClient();

Resumo do método

Modificador e tipo Método e descrição
PollerFlux<OperationResult,DocumentClassifierDetails> beginBuildDocumentClassifier(Map<String,ClassifierDocumentTypeDetails> documentTypes)

Cria um modelo de documento de classificador personalizado.

PollerFlux<OperationResult,DocumentClassifierDetails> beginBuildDocumentClassifier(Map<String,ClassifierDocumentTypeDetails> documentTypes, BuildDocumentClassifierOptions buildDocumentClassifierOptions)

Cria um modelo de análise de documento personalizado.

PollerFlux<OperationResult,DocumentModelDetails> beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode)

Cria um modelo de análise de documento personalizado.

PollerFlux<OperationResult,DocumentModelDetails> beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode, BuildDocumentModelOptions buildDocumentModelOptions)

Cria um modelo de análise de documento personalizado.

PollerFlux<OperationResult,DocumentModelDetails> beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode)

Cria um modelo de análise de documento personalizado.

PollerFlux<OperationResult,DocumentModelDetails> beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode, String prefix, BuildDocumentModelOptions buildDocumentModelOptions)

Cria um modelo de análise de documento personalizado.

PollerFlux<OperationResult,DocumentModelDetails> beginComposeDocumentModel(List<String> componentModelIds)

Crie um modelo composto a partir da lista fornecida de modelos existentes na conta.

PollerFlux<OperationResult,DocumentModelDetails> beginComposeDocumentModel(List<String> componentModelIds, ComposeDocumentModelOptions composeDocumentModelOptions)

Crie um modelo composto a partir da lista fornecida de modelos existentes na conta.

PollerFlux<OperationResult,DocumentModelDetails> beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)

Copie um modelo personalizado armazenado nesse recurso (a origem) para o recurso de Reconhecimento de Formulários de destino especificado pelo usuário.

Mono<Void> deleteDocumentClassifier(String classifierId)

Exclui o classificador de documento especificado.

Mono<Response<Void>> deleteDocumentClassifierWithResponse(String classifierId)

Exclui o classificador de documento especificado.

Mono<Void> deleteDocumentModel(String modelId)

Exclui o modelo de análise de documento personalizado especificado.

Mono<Response<Void>> deleteDocumentModelWithResponse(String modelId)

Exclui o modelo de análise de documento personalizado especificado.

Mono<DocumentModelCopyAuthorization> getCopyAuthorization()

Gere autorização para copiar um modelo de análise de documento personalizado para o recurso de Reconhecimento de Formulários de destino.

Mono<Response<DocumentModelCopyAuthorization>> getCopyAuthorizationWithResponse(CopyAuthorizationOptions copyAuthorizationOptions)

Gere autorização para copiar um modelo de análise de documento personalizado para o recurso de Reconhecimento de Formulários de destino.

DocumentAnalysisAsyncClient getDocumentAnalysisAsyncClient()

Cria um novo objeto DocumentAnalysisAsyncClient.

Mono<DocumentClassifierDetails> getDocumentClassifier(String classifierId)

Obtenha informações detalhadas para um classificador de documento por sua ID.

Mono<Response<DocumentClassifierDetails>> getDocumentClassifierWithResponse(String classifierId)

Obtenha informações detalhadas para uma ID de modelo especificada com resposta Http.

Mono<DocumentModelDetails> getDocumentModel(String modelId)

Obtenha informações detalhadas para uma ID de modelo especificada.

Mono<Response<DocumentModelDetails>> getDocumentModelWithResponse(String modelId)

Obtenha informações detalhadas para uma ID de modelo especificada com resposta Http.

Mono<OperationDetails> getOperation(String operationId)

Obtenha informações detalhadas da operação para a ID especificada.

Mono<Response<OperationDetails>> getOperationWithResponse(String operationId)

Obtenha informações detalhadas da operação para a ID especificada com a resposta Http.

Mono<ResourceDetails> getResourceDetails()

Obtenha informações sobre o recurso de Reconhecimento de Formulários atual.

Mono<Response<ResourceDetails>> getResourceDetailsWithResponse()

Obtenha as informações sobre o recurso de Reconhecimento de Formulários atual com uma resposta Http.

PagedFlux<DocumentClassifierDetails> listDocumentClassifiers()

Listar informações para cada classificador de documento na conta Reconhecimento de Formulários que foram criadas com êxito.

PagedFlux<DocumentModelSummary> listDocumentModels()

Listar informações para cada modelo na conta Reconhecimento de Formulários que foram criadas com êxito.

PagedFlux<OperationSummary> listOperations()

Listar informações para cada operação de modelo na conta Reconhecimento de Formulários nas últimas 24 horas.

Métodos herdados de java.lang.Object

Detalhes do método

beginBuildDocumentClassifier

public PollerFlux beginBuildDocumentClassifier(Map documentTypes)

Cria um modelo de documento de classificador personalizado.

Os modelos de classificador podem identificar vários documentos ou várias instâncias de um único documento. Para isso, você precisa de pelo menos cinco documentos para cada classe e duas classes de documentos.

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Exemplo de código

String blobContainerUrl1040D = "{SAS_URL_of_your_container_in_blob_storage}";
 String blobContainerUrl1040A = "{SAS_URL_of_your_container_in_blob_storage}";
 HashMap<String, ClassifierDocumentTypeDetails> documentTypesDetailsMap = new HashMap<>();
 documentTypesDetailsMap.put("1040-D", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040D)
 ));
 documentTypesDetailsMap.put("1040-A", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040A)
 ));

 documentModelAdministrationAsyncClient.beginBuildDocumentClassifier(documentTypesDetailsMap)
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(classifierDetails -> {
         System.out.printf("Classifier ID: %s%n", classifierDetails.getClassifierId());
         System.out.printf("Classifier description: %s%n", classifierDetails.getDescription());
         System.out.printf("Classifier created on: %s%n", classifierDetails.getCreatedOn());
         System.out.printf("Classifier expires on: %s%n", classifierDetails.getExpiresOn());
         classifierDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
                 System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
                     .getContentSource()).getContainerUrl());
             }
         });
     });

Parameters:

documentTypes - Lista de tipos de documento com os quais classificar.

Returns:

Um PollerFlux<T,U> que sonda a operação do modelo de construção até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o treinado DocumentClassifierDetails.

beginBuildDocumentClassifier

public PollerFlux beginBuildDocumentClassifier(Map documentTypes, BuildDocumentClassifierOptions buildDocumentClassifierOptions)

Cria um modelo de análise de documento personalizado. Os modelos são criados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Outro tipo de conteúdo é ignorado.

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Confira aqui para obter informações sobre como criar seu próprio conjunto de dados de administração.

Exemplo de código

String blobContainerUrl1040D = "{SAS_URL_of_your_container_in_blob_storage}";
 String blobContainerUrl1040A = "{SAS_URL_of_your_container_in_blob_storage}";
 HashMap<String, ClassifierDocumentTypeDetails> documentTypesDetailsMap = new HashMap<>();
 documentTypesDetailsMap.put("1040-D", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040D)
 ));
 documentTypesDetailsMap.put("1040-A", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040A)
 ));

 documentModelAdministrationAsyncClient.beginBuildDocumentClassifier(documentTypesDetailsMap,
         new BuildDocumentClassifierOptions()
             .setClassifierId("classifierId")
             .setDescription("classifier desc"))
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(classifierDetails -> {
         System.out.printf("Classifier ID: %s%n", classifierDetails.getClassifierId());
         System.out.printf("Classifier description: %s%n", classifierDetails.getDescription());
         System.out.printf("Classifier created on: %s%n", classifierDetails.getCreatedOn());
         System.out.printf("Classifier expires on: %s%n", classifierDetails.getExpiresOn());
         classifierDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
                 System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
                     .getContentSource()).getContainerUrl());
             }
         });
     });

Parameters:

documentTypes - Lista de tipos de documento com os quais classificar.
buildDocumentClassifierOptions - O configurável BuildDocumentClassifierOptions a ser passado ao criar um modelo de documento de classificador personalizado.

Returns:

Um SyncPoller<T,U> que sonda a operação do modelo de construção até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o compilado DocumentClassifierDetails.

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode)

Cria um modelo de análise de documento personalizado. Os modelos são criados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Outro tipo de conteúdo é ignorado.

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Confira aqui para obter informações sobre como criar seu próprio conjunto de dados de administração.

Exemplo de código

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 String fileList = "";
 documentModelAdministrationAsyncClient.beginBuildDocumentModel(
     new BlobFileListContentSource(blobContainerUrl, fileList),
         DocumentModelBuildMode.TEMPLATE)
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

contentSource - fonte de dados de treinamento a ser usada para criar o modelo. Ele pode ser um contêiner de blob do Armazenamento do Azure fornecido junto com seu respectivo prefixo ou Caminho para um arquivo JSONL dentro do contêiner especificando o conjunto de documentos para treinamento. Para obter mais informações sobre como configurar um conjunto de dados de treinamento, consulte: aqui.
buildMode - a técnica preferencial para criar modelos. Para treinamento mais rápido de modelos, use TEMPLATE. Consulte aqui para obter mais informações sobre o modo de construção para documentos personalizados.

Returns:

Um PollerFlux<T,U> que sonda a operação do modelo de construção até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o treinado DocumentModelDetails.

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode, BuildDocumentModelOptions buildDocumentModelOptions)

Cria um modelo de análise de documento personalizado. Os modelos são criados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Outro tipo de conteúdo é ignorado.

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Confira aqui para obter informações sobre como criar seu próprio conjunto de dados de administração.

Exemplo de código

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 String fileList = "";
 String modelId = "model-id";
 Map<String, String> attrs = new HashMap<String, String>();
 attrs.put("createdBy", "sample");
 String prefix = "Invoice";

 documentModelAdministrationAsyncClient.beginBuildDocumentModel(
         new BlobFileListContentSource(blobContainerUrl, fileList),
         DocumentModelBuildMode.TEMPLATE,
     new BuildDocumentModelOptions()
         .setModelId(modelId)
         .setDescription("model desc")
         .setTags(attrs))
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Description: %s%n", documentModel.getDescription());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         System.out.printf("Model assigned tags: %s%n", documentModel.getTags());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

contentSource - fonte de dados de treinamento a ser usada para criar o modelo. Ele pode ser um contêiner de blob do Armazenamento do Azure fornecido junto com seu respectivo prefixo ou Caminho para um arquivo JSONL dentro do contêiner especificando o conjunto de documentos para treinamento. Para obter mais informações sobre como configurar um conjunto de dados de treinamento, consulte: aqui.
buildMode - a técnica preferencial para criar modelos. Para treinamento mais rápido de modelos, use TEMPLATE. Consulte aqui para obter mais informações sobre o modo de construção para documentos personalizados.
buildDocumentModelOptions - O configurável BuildDocumentModelOptions a ser passado ao criar um modelo de análise de documento personalizado.

Returns:

Um PollerFlux<T,U> que sonda a operação do modelo de construção até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o treinado DocumentModelDetails.

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode)

Cria um modelo de análise de documento personalizado. Os modelos são criados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Outro tipo de conteúdo é ignorado.

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Confira aqui para obter informações sobre como criar seu próprio conjunto de dados de administração.

Exemplo de código

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 documentModelAdministrationAsyncClient.beginBuildDocumentModel(blobContainerUrl,
         DocumentModelBuildMode.TEMPLATE
     )
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

blobContainerUrl - um URI SAS do contêiner de blob do Armazenamento do Azure. Um URI de contêiner (sem SAS) poderá ser usado se o contêiner for público ou tiver uma identidade gerenciada configurada. Para obter mais informações sobre como configurar um conjunto de dados de treinamento, consulte: aqui.
buildMode - a técnica preferencial para criar modelos. Para treinamento mais rápido de modelos, use TEMPLATE. Consulte aqui para obter mais informações sobre o modo de construção para documentos personalizados.

Returns:

Um PollerFlux<T,U> que sonda a operação do modelo de construção até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o treinado DocumentModelDetails.

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode, String prefix, BuildDocumentModelOptions buildDocumentModelOptions)

Cria um modelo de análise de documento personalizado. Os modelos são criados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Outro tipo de conteúdo é ignorado.

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Confira aqui para obter informações sobre como criar seu próprio conjunto de dados de administração.

Exemplo de código

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 String modelId = "model-id";
 Map<String, String> attrs = new HashMap<String, String>();
 attrs.put("createdBy", "sample");
 String prefix = "Invoice";

 documentModelAdministrationAsyncClient.beginBuildDocumentModel(blobContainerUrl,
         DocumentModelBuildMode.TEMPLATE,
         prefix,
         new BuildDocumentModelOptions()
             .setModelId(modelId)
             .setDescription("model desc")
             .setTags(attrs))
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Description: %s%n", documentModel.getDescription());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         System.out.printf("Model assigned tags: %s%n", documentModel.getTags());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

blobContainerUrl - um URI SAS do contêiner de blob do Armazenamento do Azure. Um URI de contêiner (sem SAS) poderá ser usado se o contêiner for público ou tiver uma identidade gerenciada configurada. Para obter mais informações sobre como configurar um conjunto de dados de treinamento, consulte: aqui.
buildMode - a técnica preferencial para criar modelos. Para treinamento mais rápido de modelos, use TEMPLATE. Consulte aqui para obter mais informações sobre o modo de construção para documentos personalizados.
prefix - prefixo de nome de blob de prefixo que diferencia maiúsculas de minúsculas para filtrar documentos para treinamento.
buildDocumentModelOptions - O configurável BuildDocumentModelOptions a ser passado ao criar um modelo de análise de documento personalizado.

Returns:

Um PollerFlux<T,U> que sonda a operação do modelo de construção até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o treinado DocumentModelDetails.

beginComposeDocumentModel

public PollerFlux beginComposeDocumentModel(List componentModelIds)

Crie um modelo composto a partir da lista fornecida de modelos existentes na conta.

Essas operações falharão se a lista consistir em uma ID de modelo inválida e não existente ou IDs duplicadas.

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Exemplo de código

String modelId1 = "{model_Id_1}";
 String modelId2 = "{model_Id_2}";
 documentModelAdministrationAsyncClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2)
     )
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

componentModelIds - A lista de modelos de componentes a serem redigidos.

Returns:

Um PollerFlux<T,U> que sonda a operação criar modelo composto até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o criado DocumentModelDetails.

beginComposeDocumentModel

public PollerFlux beginComposeDocumentModel(List componentModelIds, ComposeDocumentModelOptions composeDocumentModelOptions)

Crie um modelo composto a partir da lista fornecida de modelos existentes na conta.

Essas operações falharão se a lista consistir em uma ID de modelo inválida e não existente ou IDs duplicadas.

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Exemplo de código

String modelId1 = "{model_Id_1}";
 String modelId2 = "{model_Id_2}";
 String modelId = "my-composed-model";
 Map<String, String> attrs = new HashMap<String, String>();
 attrs.put("createdBy", "sample");

 documentModelAdministrationAsyncClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2),
         new ComposeDocumentModelOptions()
             .setModelId(modelId)
             .setDescription("model-desc")
             .setTags(attrs))
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Description: %s%n", documentModel.getDescription());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         System.out.printf("Model assigned tags: %s%n", documentModel.getTags());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

componentModelIds - A lista de modelos de componentes a serem redigidos.
composeDocumentModelOptions - O configurável ComposeDocumentModelOptions a ser passado ao criar um modelo composto.

Returns:

Um PollerFlux<T,U> que sonda a operação criar modelo composto até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o modelo DocumentModelDetailscopiado .

beginCopyDocumentModelTo

public PollerFlux beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)

Copie um modelo personalizado armazenado nesse recurso (a origem) para o recurso de Reconhecimento de Formulários de destino especificado pelo usuário.

Isso deve ser chamado com o recurso de Reconhecimento de Formulários de origem (com o modelo que se destina a ser copiado). O parâmetro de destino deve ser fornecido a partir da saída do recurso de destino do getCopyAuthorization() método .

O serviço não dá suporte ao cancelamento da operação de execução prolongada e retorna com uma mensagem de erro indicando ausência de suporte de cancelamento.

Exemplo de código

String copyModelId = "copy-model";
 // Get authorization to copy the model to target resource
 documentModelAdministrationAsyncClient.getCopyAuthorization()
     // Start copy operation from the source client
     // The ID of the model that needs to be copied to the target resource
     .subscribe(copyAuthorization -> documentModelAdministrationAsyncClient.beginCopyDocumentModelTo(copyModelId,
             copyAuthorization)
         .filter(pollResponse -> pollResponse.getStatus().isComplete())
         .flatMap(AsyncPollResponse::getFinalResult)
         .subscribe(documentModel ->
             System.out.printf("Copied model has model ID: %s, was created on: %s.%n,",
                 documentModel.getModelId(),
                 documentModel.getCreatedOn())));

Parameters:

sourceModelId - Identificador de modelo do modelo de origem a ser copiado para o recurso de destino.
target - a autorização de cópia para o recurso de Reconhecimento de Formulários de destino. A autorização de cópia pode ser gerada a partir da chamada do recurso de destino para getCopyAuthorization()

Returns:

Um PollerFlux<T,U> que sonda a operação de modelo de cópia até que ela seja concluída, tenha falhado ou tenha sido cancelada. A operação concluída retorna o modelo DocumentModelDetailscopiado .

deleteDocumentClassifier

public Mono deleteDocumentClassifier(String classifierId)

Exclui o classificador de documento especificado.

Exemplo de código

String classifierId = "{classifierId}";
 documentModelAdministrationAsyncClient.deleteDocumentClassifier(classifierId)
     .subscribe(ignored -> System.out.printf("Classifier ID: %s is deleted%n", classifierId));

Parameters:

classifierId - O identificador de classificador de documento exclusivo.

Returns:

Um Mono vazio.

deleteDocumentClassifierWithResponse

public Mono<>> deleteDocumentClassifierWithResponse(String classifierId)

Exclui o classificador de documento especificado.

Exemplo de código

String classifierId = "{classifierId}";
 documentModelAdministrationAsyncClient.deleteDocumentClassifierWithResponse(classifierId)
     .subscribe(response -> {
         System.out.printf("Response Status Code: %d.", response.getStatusCode());
         System.out.printf("Classifier ID: %s is deleted.%n", classifierId);
     });

Parameters:

classifierId - O identificador de classificador de documento exclusivo.

Returns:

Um Response<T> que contém o código status e cabeçalhos HTTP.

deleteDocumentModel

public Mono deleteDocumentModel(String modelId)

Exclui o modelo de análise de documento personalizado especificado.

Exemplo de código

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.deleteDocumentModel(modelId)
     .subscribe(ignored -> System.out.printf("Model ID: %s is deleted%n", modelId));

Parameters:

modelId - O identificador de modelo exclusivo.

Returns:

Um Mono vazio.

deleteDocumentModelWithResponse

public Mono<>> deleteDocumentModelWithResponse(String modelId)

Exclui o modelo de análise de documento personalizado especificado.

Exemplo de código

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.deleteDocumentModelWithResponse(modelId)
     .subscribe(response -> {
         System.out.printf("Response Status Code: %d.", response.getStatusCode());
         System.out.printf("Model ID: %s is deleted.%n", modelId);
     });

Parameters:

modelId - O identificador de modelo exclusivo.

Returns:

Um Response<T> que contém o código status e cabeçalhos HTTP.

getCopyAuthorization

public Mono getCopyAuthorization()

Gere autorização para copiar um modelo de análise de documento personalizado para o recurso de Reconhecimento de Formulários de destino.

Isso deve ser chamado pelo recurso de destino (para o qual o modelo será copiado) e a saída pode ser passada como o parâmetro de destino para beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target).

Returns:

O DocumentModelCopyAuthorization que pode ser usado para autorizar a cópia do modelo entre recursos.

getCopyAuthorizationWithResponse

public Mono<>> getCopyAuthorizationWithResponse(CopyAuthorizationOptions copyAuthorizationOptions)

Gere autorização para copiar um modelo de análise de documento personalizado para o recurso de Reconhecimento de Formulários de destino.

Isso deve ser chamado pelo recurso de destino (para o qual o modelo será copiado) e a saída pode ser passada como o parâmetro de destino para beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target).

Parameters:

copyAuthorizationOptions - O configurável CopyAuthorizationOptions a ser passado ao copiar um modelo. Exemplo de código String modelId = "my-copied-model"; Map<String, String> attrs = new HashMap<String, String>(); attrs.put("createdBy", "sample");

documentModelAdministrationAsyncClient.getCopyAuthorizationWithResponse( new CopyAuthorizationOptions() .setModelId(modelId) .setDescription("model desc") .setTags(attrs)) .subscribe(copyAuthorization -> System.out.printf("Copy Authorization response status: %s, for model id: %s, access token: %s, " + "expiration time: %s, target resource ID; %s, target resource region: %s%n", copyAuthorization.getStatusCode(), copyAuthorization.getValue().getTargetModelId(), copyAuthorization.getValue().getAccessToken(), copyAuthorization.getValue().getExpiresOn(), copyAuthorization.getValue().getTargetResourceId(), copyAuthorization.getValue().getTargetResourceRegion() ));

Returns:

O DocumentModelCopyAuthorization que pode ser usado para autorizar a cópia do modelo entre recursos.

getDocumentAnalysisAsyncClient

public DocumentAnalysisAsyncClient getDocumentAnalysisAsyncClient()

Cria um novo objeto DocumentAnalysisAsyncClient. O novo DocumentTrainingAsyncClient usa o mesmo pipeline de política de solicitação que o DocumentTrainingAsyncClient.

Returns:

getDocumentClassifier

public Mono getDocumentClassifier(String classifierId)

Obtenha informações detalhadas para um classificador de documento por sua ID.

Exemplo de código

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.getDocumentClassifier(modelId).subscribe(documentClassifier -> {
     System.out.printf("Classifier ID: %s%n", documentClassifier.getClassifierId());
     System.out.printf("Classifier Description: %s%n", documentClassifier.getDescription());
     System.out.printf("Classifier Created on: %s%n", documentClassifier.getCreatedOn());
     documentClassifier.getDocumentTypes().forEach((key, documentTypeDetails) -> {
         if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
             System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
                 .getContentSource()).getContainerUrl());
         }
         if (documentTypeDetails.getContentSource() instanceof BlobFileListContentSource) {
             System.out.printf("Blob File List Source container Url: %s",
                 ((BlobFileListContentSource) documentTypeDetails
                 .getContentSource()).getContainerUrl());
         }
     });
 });

Parameters:

classifierId - O identificador de classificador de documento exclusivo.

Returns:

As informações detalhadas para a ID do classificador de documento especificada.

getDocumentClassifierWithResponse

public Mono<>> getDocumentClassifierWithResponse(String classifierId)

Obtenha informações detalhadas para uma ID de modelo especificada com resposta Http.

Exemplo de código

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.getDocumentModelWithResponse(modelId).subscribe(response -> {
     System.out.printf("Response Status Code: %d.", response.getStatusCode());
     DocumentModelDetails documentModelDetails = response.getValue();
     System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
     System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
     System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
     documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
         documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
             System.out.printf("Field: %s", field);
             System.out.printf("Field type: %s", documentFieldSchema.getType());
             System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
         });
     });
 });

Parameters:

classifierId - O identificador de classificador de documento exclusivo.

Returns:

Um Response<T> que contém o solicitado DocumentClassifierDetails.

getDocumentModel

public Mono getDocumentModel(String modelId)

Obtenha informações detalhadas para uma ID de modelo especificada.

Exemplo de código

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.getDocumentModel(modelId).subscribe(documentModel -> {
     System.out.printf("Model ID: %s%n", documentModel.getModelId());
     System.out.printf("Model Description: %s%n", documentModel.getDescription());
     System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
     documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
         documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
             System.out.printf("Field: %s", field);
             System.out.printf("Field type: %s", documentFieldSchema.getType());
             System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
         });
     });
 });

Parameters:

modelId - O identificador de modelo exclusivo.

Returns:

As informações detalhadas do modelo especificado.

getDocumentModelWithResponse

public Mono<>> getDocumentModelWithResponse(String modelId)

Obtenha informações detalhadas para uma ID de modelo especificada com resposta Http.

Exemplo de código

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.getDocumentModelWithResponse(modelId).subscribe(response -> {
     System.out.printf("Response Status Code: %d.", response.getStatusCode());
     DocumentModelDetails documentModelDetails = response.getValue();
     System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
     System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
     System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
     documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
         documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
             System.out.printf("Field: %s", field);
             System.out.printf("Field type: %s", documentFieldSchema.getType());
             System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
         });
     });
 });

Parameters:

modelId - O identificador de modelo exclusivo.

Returns:

Um Response<T> que contém o solicitado DocumentModelDetails.

getOperation

public Mono getOperation(String operationId)

Obtenha informações detalhadas da operação para a ID especificada.

Essas operações falharão se a ID da operação usada for anterior a 24 horas.

Exemplo de código

String operationId = "{operation_Id}";
 documentModelAdministrationAsyncClient.getOperation(operationId).subscribe(operationDetails -> {
     System.out.printf("Operation ID: %s%n", operationDetails.getOperationId());
     System.out.printf("Operation Kind: %s%n", operationDetails.getKind());
     System.out.printf("Operation Status: %s%n", operationDetails.getStatus());
     System.out.printf("Model ID created with this operation: %s%n",
         ((DocumentModelBuildOperationDetails) operationDetails).getResult().getModelId());
     if (OperationStatus.FAILED.equals(operationDetails.getStatus())) {
         System.out.printf("Operation fail error: %s%n", operationDetails.getError().getMessage());
     }
 });

Parameters:

operationId - ID de operação exclusiva.

Returns:

informações detalhadas da operação para a ID especificada.

getOperationWithResponse

public Mono<>> getOperationWithResponse(String operationId)

Obtenha informações detalhadas da operação para a ID especificada com a resposta Http.

Essas operações falharão se a ID da operação usada for anterior a 24 horas.

Exemplo de código

String operationId = "{operation_Id}";
 documentModelAdministrationAsyncClient.getOperationWithResponse(operationId).subscribe(response -> {
     System.out.printf("Response Status Code: %d.", response.getStatusCode());
     OperationDetails operationDetails = response.getValue();
     System.out.printf("Operation ID: %s%n", operationDetails.getOperationId());
     System.out.printf("Operation Kind: %s%n", operationDetails.getKind());
     System.out.printf("Operation Status: %s%n", operationDetails.getStatus());
     System.out.printf("Model ID created with this operation: %s%n",
         ((DocumentModelBuildOperationDetails) operationDetails).getResult().getModelId());
     if (OperationStatus.FAILED.equals(operationDetails.getStatus())) {
         System.out.printf("Operation fail error: %s%n", operationDetails.getError().getMessage());
     }
 });

Parameters:

operationId - ID de operação exclusiva.

Returns:

Um Response<T> que contém o solicitado OperationDetails.

getResourceDetails

public Mono getResourceDetails()

Obtenha informações sobre o recurso de Reconhecimento de Formulários atual.

Exemplo de código

documentModelAdministrationAsyncClient.getResourceDetails()
     .subscribe(resourceInfo -> {
         System.out.printf("Max number of models that can be build for this account: %d%n",
             resourceInfo.getCustomDocumentModelLimit());
         System.out.printf("Current count of built document analysis models: %d%n",
             resourceInfo.getCustomDocumentModelCount());
     });

Returns:

Os detalhes das informações de recurso solicitadas.

getResourceDetailsWithResponse

public Mono<>> getResourceDetailsWithResponse()

Obtenha as informações sobre o recurso de Reconhecimento de Formulários atual com uma resposta Http.

Exemplo de código

documentModelAdministrationAsyncClient.getResourceDetailsWithResponse()
     .subscribe(response -> {
         System.out.printf("Response Status Code: %d.", response.getStatusCode());
         ResourceDetails resourceDetails = response.getValue();
         System.out.printf("Max number of models that can be build for this account: %d%n",
             resourceDetails.getCustomDocumentModelLimit());
         System.out.printf("Current count of built document analysis models: %d%n",
             resourceDetails.getCustomDocumentModelCount());
     });

Returns:

Um Response<T> que contém os detalhes das informações de recurso solicitadas.

listDocumentClassifiers

public PagedFlux listDocumentClassifiers()

Listar informações para cada classificador de documento na conta Reconhecimento de Formulários que foram criadas com êxito.

Exemplo de código

documentModelAdministrationAsyncClient.listDocumentClassifiers()
     .subscribe(documentModelInfo ->
         System.out.printf("Classifier ID: %s, Classifier description: %s, Created on: %s.%n",
             documentModelInfo.getClassifierId(),
             documentModelInfo.getDescription(),
             documentModelInfo.getCreatedOn()));

Returns:

PagedFlux<T>de DocumentClassifierDetails na conta Reconhecimento de Formulários.

listDocumentModels

public PagedFlux listDocumentModels()

Listar informações para cada modelo na conta Reconhecimento de Formulários que foram criadas com êxito.

Exemplo de código

documentModelAdministrationAsyncClient.listDocumentModels()
     .subscribe(documentModelInfo ->
         System.out.printf("Model ID: %s, Model description: %s, Created on: %s.%n",
             documentModelInfo.getModelId(),
             documentModelInfo.getDescription(),
             documentModelInfo.getCreatedOn()));

Returns:

listOperations

public PagedFlux listOperations()

Listar informações para cada operação de modelo na conta Reconhecimento de Formulários nas últimas 24 horas.

Exemplo de código

documentModelAdministrationAsyncClient.listOperations()
     .subscribe(modelOperationSummary -> {
         System.out.printf("Operation ID: %s%n", modelOperationSummary.getOperationId());
         System.out.printf("Operation Status: %s%n", modelOperationSummary.getStatus());
         System.out.printf("Operation Created on: %s%n", modelOperationSummary.getCreatedOn());
         System.out.printf("Operation Percent completed: %d%n", modelOperationSummary.getPercentCompleted());
         System.out.printf("Operation Kind: %s%n", modelOperationSummary.getKind());
         System.out.printf("Operation Last updated on: %s%n", modelOperationSummary.getLastUpdatedOn());
         System.out.printf("Operation resource location: %s%n", modelOperationSummary.getResourceLocation());
     });

Returns:

Aplica-se a