Partager via


DocumentModelAdministrationAsyncClient Classe

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

public final class DocumentModelAdministrationAsyncClient

Cette classe fournit un client asynchrone pour se connecter au Form Recognizer Azure Cognitive Service.

Ce client fournit des méthodes asynchrones à effectuer :

  1. Créer un modèle personnalisé : extrayez des données de vos documents spécifiques en créant des modèles personnalisés à l’aide de la beginBuidlDocumentModel méthode pour fournir une URL SAP de conteneur à votre conteneur d’objets blob stockage Azure.
  2. Modèles personnalisés composés : crée un modèle à partir de types de documents de collection de modèles existants à l’aide de la beginComposeDocumentModel méthode .
  3. Copier un modèle personnalisé : copiez un modèle de Form Recognizer personnalisé vers une ressource Form Recognizer cible à l’aide de la beginCopyDocumentModelTo méthode .
  4. Gestion des modèles personnalisés : obtenez des informations détaillées, supprimez et répertoriez les modèles personnalisés à l’aide des méthodes getDocumentModel(String modelId), listDocumentModels() et deleteDocumentModel(String modelId) respectivement.
  5. Gestion des opérations : obtenez des informations détaillées et répertoriez les opérations sur le compte Form Recognizer à l’aide des méthodes getOperation(String operationId) et listOperations() respectivement.
  6. Interrogation et rappels : il inclut des mécanismes d’interrogation du service pour case activée la status d’une opération d’analyse ou l’inscription de rappels pour recevoir des notifications lorsque l’analyse est terminée.

Note: Ce client prend uniquement en charge V2022_08_31 et plus récent. Pour utiliser une version de service antérieure, FormRecognizerClient et FormTrainingClient.

Les clients de service sont le point d’interaction permettant aux développeurs d’utiliser Azure Form Recognizer. DocumentModelAdministrationClient est le client de service synchrone et DocumentModelAdministrationAsyncClient est le client de service asynchrone. Les exemples présentés dans ce document utilisent un objet d’informations d’identification nommé DefaultAzureCredential pour l’authentification, qui convient à la plupart des scénarios, notamment aux environnements de développement et de production locaux. En outre, nous vous recommandons d’utiliser une identité managée pour l’authentification dans les environnements de production. Vous trouverez plus d’informations sur les différentes méthodes d’authentification et leurs types d’informations d’identification correspondants dans la documentation Azure Identity.

Exemple : Construire un DocumentModelAdministrationAsyncClient avec DefaultAzureCredential

L’exemple de code suivant illustre la création d’un DocumentModelAdministrationAsyncClient, à l’aide de « DefaultAzureCredentialBuilder » pour le configurer.

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

Pour plus d’informations, consultez l’exemple de code ci-dessous à utiliser pour la AzureKeyCredential création du client.

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

Résumé de la méthode

Modificateur et type Méthode et description
PollerFlux<OperationResult,DocumentClassifierDetails> beginBuildDocumentClassifier(Map<String,ClassifierDocumentTypeDetails> documentTypes)

Génère un modèle de document classifieur personnalisé.

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

Crée un modèle personnalisé d’analyse de document.

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

Crée un modèle personnalisé d’analyse de document.

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

Crée un modèle personnalisé d’analyse de document.

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

Crée un modèle personnalisé d’analyse de document.

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

Crée un modèle personnalisé d’analyse de document.

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

Créez un modèle composé à partir de la liste fournie des modèles existants dans le compte.

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

Créez un modèle composé à partir de la liste fournie des modèles existants dans le compte.

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

Copiez un modèle personnalisé stocké dans cette ressource (la source) vers la ressource cible spécifiée par l’utilisateur Form Recognizer ressource.

Mono<Void> deleteDocumentClassifier(String classifierId)

Supprime le classifieur de documents spécifié.

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

Supprime le classifieur de documents spécifié.

Mono<Void> deleteDocumentModel(String modelId)

Supprime le modèle d’analyse de document personnalisé spécifié.

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

Supprime le modèle d’analyse de document personnalisé spécifié.

Mono<DocumentModelCopyAuthorization> getCopyAuthorization()

Générez l’autorisation de copie d’un modèle d’analyse de document personnalisé dans la ressource Form Recognizer cible.

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

Générez l’autorisation de copie d’un modèle d’analyse de document personnalisé dans la ressource Form Recognizer cible.

DocumentAnalysisAsyncClient getDocumentAnalysisAsyncClient()

Crée un objet DocumentAnalysisAsyncClient.

Mono<DocumentClassifierDetails> getDocumentClassifier(String classifierId)

Obtenez des informations détaillées pour un classifieur de documents par son ID.

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

Obtenez des informations détaillées sur un ID de modèle spécifié avec la réponse Http.

Mono<DocumentModelDetails> getDocumentModel(String modelId)

Obtenez des informations détaillées pour un ID de modèle spécifié.

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

Obtenez des informations détaillées sur un ID de modèle spécifié avec la réponse Http.

Mono<OperationDetails> getOperation(String operationId)

Obtenez des informations détaillées sur l’opération pour l’ID spécifié.

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

Obtenez des informations détaillées sur l’opération pour l’ID spécifié avec la réponse Http.

Mono<ResourceDetails> getResourceDetails()

Obtenez des informations sur la ressource Form Recognizer actuelle.

Mono<Response<ResourceDetails>> getResourceDetailsWithResponse()

Obtenez les informations sur la ressource Form Recognizer actuelle avec une réponse Http.

PagedFlux<DocumentClassifierDetails> listDocumentClassifiers()

Répertoriez les informations de chaque classifieur de document sur le compte Form Recognizer qui ont été créés avec succès.

PagedFlux<DocumentModelSummary> listDocumentModels()

Répertoriez les informations de chaque modèle sur le compte Form Recognizer qui ont été créés avec succès.

PagedFlux<OperationSummary> listOperations()

Répertoriez les informations pour chaque opération de modèle sur le compte Form Recognizer au cours des dernières 24 heures.

Méthodes héritées de java.lang.Object

Détails de la méthode

beginBuildDocumentClassifier

public PollerFlux beginBuildDocumentClassifier(Map documentTypes)

Génère un modèle de document classifieur personnalisé.

Les modèles classifieur peuvent identifier plusieurs documents ou plusieurs instances d’un même document. Pour cela, vous avez besoin d’au moins cinq documents pour chaque classe et de deux classes de documents.

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Code sample

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 - Liste des types de documents à classer.

Returns:

PollerFlux<T,U> qui interroge l’opération de modèle de génération jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le entraîné DocumentClassifierDetails.

beginBuildDocumentClassifier

public PollerFlux beginBuildDocumentClassifier(Map documentTypes, BuildDocumentClassifierOptions buildDocumentClassifierOptions)

Crée un modèle personnalisé d’analyse de document. Les modèles sont créés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg », « image/png », « image/tiff », image/bmp. Tout autre type de contenu est ignoré.

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Consultez ici pour plus d’informations sur la création de votre propre jeu de données d’administration.

Code sample

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 - Liste des types de documents à classer.
buildDocumentClassifierOptions - configurable BuildDocumentClassifierOptions à passer lors de la génération d’un modèle de document classifieur personnalisé.

Returns:

SyncPoller<T,U> qui interroge l’opération de modèle de génération jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le généré DocumentClassifierDetails.

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode)

Crée un modèle personnalisé d’analyse de document. Les modèles sont créés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg », « image/png », « image/tiff », image/bmp. Tout autre type de contenu est ignoré.

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Consultez ici pour plus d’informations sur la création de votre propre jeu de données d’administration.

Code sample

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 - source de données d’entraînement à utiliser pour générer le modèle. Il peut s’agir d’un conteneur d’objets blob de stockage Azure fourni avec son préfixe respectif ou son chemin d’accès à un fichier JSONL dans le conteneur spécifiant l’ensemble de documents pour l’entraînement. Pour plus d’informations sur la configuration d’un jeu de données d’entraînement, consultez : ici.
buildMode - technique préférée pour créer des modèles. Pour accélérer l’apprentissage des modèles, utilisez TEMPLATE. Consultez ici pour plus d’informations sur le mode de création de documents personnalisés.

Returns:

PollerFlux<T,U> qui interroge l’opération de modèle de génération jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le entraîné DocumentModelDetails.

beginBuildDocumentModel

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

Crée un modèle personnalisé d’analyse de document. Les modèles sont créés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg », « image/png », « image/tiff », image/bmp. Tout autre type de contenu est ignoré.

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Consultez ici pour plus d’informations sur la création de votre propre jeu de données d’administration.

Code sample

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 - source de données d’entraînement à utiliser pour générer le modèle. Il peut s’agir d’un conteneur d’objets blob de stockage Azure fourni avec son préfixe respectif ou son chemin d’accès à un fichier JSONL dans le conteneur spécifiant l’ensemble de documents pour l’entraînement. Pour plus d’informations sur la configuration d’un jeu de données d’entraînement, consultez : ici.
buildMode - technique préférée pour créer des modèles. Pour accélérer l’apprentissage des modèles, utilisez TEMPLATE. Consultez ici pour plus d’informations sur le mode de création de documents personnalisés.
buildDocumentModelOptions - configurable BuildDocumentModelOptions à passer lors de la création d’un modèle d’analyse de document personnalisé.

Returns:

PollerFlux<T,U> qui interroge l’opération de modèle de génération jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le entraîné DocumentModelDetails.

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode)

Crée un modèle personnalisé d’analyse de document. Les modèles sont créés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg », « image/png », « image/tiff », image/bmp. Tout autre type de contenu est ignoré.

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Consultez ici pour plus d’informations sur la création de votre propre jeu de données d’administration.

Code sample

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 - URI SAS d’un conteneur d’objets blob De stockage Azure. Un URI de conteneur (sans SAP) peut être utilisé si le conteneur est public ou si une identité managée est configurée. Pour plus d’informations sur la configuration d’un jeu de données d’entraînement, consultez : ici.
buildMode - technique préférée pour créer des modèles. Pour accélérer l’apprentissage des modèles, utilisez TEMPLATE. Consultez ici pour plus d’informations sur le mode de création de documents personnalisés.

Returns:

PollerFlux<T,U> qui interroge l’opération de modèle de génération jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le entraîné DocumentModelDetails.

beginBuildDocumentModel

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

Crée un modèle personnalisé d’analyse de document. Les modèles sont créés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg », « image/png », « image/tiff », image/bmp. Tout autre type de contenu est ignoré.

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Consultez ici pour plus d’informations sur la création de votre propre jeu de données d’administration.

Code sample

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 - URI SAS d’un conteneur d’objets blob De stockage Azure. Un URI de conteneur (sans SAP) peut être utilisé si le conteneur est public ou si une identité managée est configurée. Pour plus d’informations sur la configuration d’un jeu de données d’entraînement, consultez : ici.
buildMode - technique préférée pour créer des modèles. Pour accélérer l’apprentissage des modèles, utilisez TEMPLATE. Consultez ici pour plus d’informations sur le mode de création de documents personnalisés.
prefix - Préfixe de préfixe respectant la casse préfixe nom de l’objet blob préfixe pour filtrer les documents à des fins d’entraînement.
buildDocumentModelOptions - configurable BuildDocumentModelOptions à passer lors de la création d’un modèle d’analyse de document personnalisé.

Returns:

PollerFlux<T,U> qui interroge l’opération de modèle de génération jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le entraîné DocumentModelDetails.

beginComposeDocumentModel

public PollerFlux beginComposeDocumentModel(List componentModelIds)

Créez un modèle composé à partir de la liste fournie des modèles existants dans le compte.

Cette opération échoue si la liste se compose d’un ID de modèle non existant non valide ou d’ID en double.

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Code sample

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 - Liste des modèles de composants à composer.

Returns:

PollerFlux<T,U> qui interroge l’opération de création de modèle composé jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le créé DocumentModelDetails.

beginComposeDocumentModel

public PollerFlux beginComposeDocumentModel(List componentModelIds, ComposeDocumentModelOptions composeDocumentModelOptions)

Créez un modèle composé à partir de la liste fournie des modèles existants dans le compte.

Cette opération échoue si la liste se compose d’un ID de modèle non existant non valide ou d’ID en double.

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Code sample

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 - Liste des modèles de composants à composer.
composeDocumentModelOptions - configurable ComposeDocumentModelOptions à passer lors de la création d’un modèle composé.

Returns:

PollerFlux<T,U> qui interroge l’opération de création de modèle composé jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le modèle DocumentModelDetailscopié.

beginCopyDocumentModelTo

public PollerFlux beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)

Copiez un modèle personnalisé stocké dans cette ressource (la source) vers la ressource cible spécifiée par l’utilisateur Form Recognizer ressource.

Cela doit être appelé avec la ressource Form Recognizer source (avec le modèle destiné à être copié). Le paramètre cible doit être fourni à partir de la sortie de la ressource cible à partir de la getCopyAuthorization() méthode .

Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne avec un message d’erreur indiquant l’absence de prise en charge de l’annulation.

Code sample

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 - Identificateur de modèle du modèle source à copier dans la ressource cible.
target - l’autorisation de copie vers la ressource Form Recognizer cible. L’autorisation de copie peut être générée à partir de l’appel de la ressource cible à getCopyAuthorization()

Returns:

PollerFlux<T,U> qui interroge l’opération de copie du modèle jusqu’à ce qu’elle soit terminée, qu’elle ait échoué ou qu’elle ait été annulée. L’opération terminée retourne le modèle DocumentModelDetailscopié.

deleteDocumentClassifier

public Mono deleteDocumentClassifier(String classifierId)

Supprime le classifieur de documents spécifié.

Code sample

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

Parameters:

classifierId - Identificateur de classifieur de document unique.

Returns:

Mono vide.

deleteDocumentClassifierWithResponse

public Mono<>> deleteDocumentClassifierWithResponse(String classifierId)

Supprime le classifieur de documents spécifié.

Code sample

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 - Identificateur de classifieur de document unique.

Returns:

Response<T> contenant le code status et les en-têtes HTTP.

deleteDocumentModel

public Mono deleteDocumentModel(String modelId)

Supprime le modèle d’analyse de document personnalisé spécifié.

Code sample

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

Parameters:

modelId - Identificateur de modèle unique.

Returns:

Mono vide.

deleteDocumentModelWithResponse

public Mono<>> deleteDocumentModelWithResponse(String modelId)

Supprime le modèle d’analyse de document personnalisé spécifié.

Code sample

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 - Identificateur de modèle unique.

Returns:

Response<T> contenant le code status et les en-têtes HTTP.

getCopyAuthorization

public Mono getCopyAuthorization()

Générez l’autorisation de copie d’un modèle d’analyse de document personnalisé dans la ressource Form Recognizer cible.

Cela doit être appelé par la ressource cible (où le modèle sera copié) et la sortie peut être passée en tant que paramètre cible dans beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target).

Returns:

DocumentModelCopyAuthorization qui peut être utilisé pour autoriser la copie du modèle entre les ressources.

getCopyAuthorizationWithResponse

public Mono<>> getCopyAuthorizationWithResponse(CopyAuthorizationOptions copyAuthorizationOptions)

Générez l’autorisation de copie d’un modèle d’analyse de document personnalisé dans la ressource Form Recognizer cible.

Cela doit être appelé par la ressource cible (où le modèle sera copié) et la sortie peut être passée en tant que paramètre cible dans beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target).

Parameters:

copyAuthorizationOptions - Configurable CopyAuthorizationOptions à passer lors de la copie d’un modèle. Code sample 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:

DocumentModelCopyAuthorization qui peut être utilisé pour autoriser la copie du modèle entre les ressources.

getDocumentAnalysisAsyncClient

public DocumentAnalysisAsyncClient getDocumentAnalysisAsyncClient()

Crée un objet DocumentAnalysisAsyncClient. Le nouveau DocumentTrainingAsyncClient utilise le même pipeline de stratégie de requête que le DocumentTrainingAsyncClient.

Returns:

getDocumentClassifier

public Mono getDocumentClassifier(String classifierId)

Obtenez des informations détaillées pour un classifieur de documents par son ID.

Code sample

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 - Identificateur unique du classifieur de document.

Returns:

Informations détaillées pour l’ID de classifieur de document spécifié.

getDocumentClassifierWithResponse

public Mono<>> getDocumentClassifierWithResponse(String classifierId)

Obtenez des informations détaillées sur un ID de modèle spécifié avec la réponse Http.

Code sample

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 - Identificateur unique du classifieur de document.

Returns:

getDocumentModel

public Mono getDocumentModel(String modelId)

Obtenez des informations détaillées pour un ID de modèle spécifié.

Code sample

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 - Identificateur de modèle unique.

Returns:

Informations détaillées sur le modèle spécifié.

getDocumentModelWithResponse

public Mono<>> getDocumentModelWithResponse(String modelId)

Obtenez des informations détaillées sur un ID de modèle spécifié avec la réponse Http.

Code sample

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 - Identificateur de modèle unique.

Returns:

Response<T> contenant le demandéDocumentModelDetails.

getOperation

public Mono getOperation(String operationId)

Obtenez des informations détaillées sur l’opération pour l’ID spécifié.

Cette opération échoue si l’ID d’opération utilisé est passé 24 heures.

Code sample

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 d’opération unique.

Returns:

informations détaillées sur l’opération pour l’ID spécifié.

getOperationWithResponse

public Mono<>> getOperationWithResponse(String operationId)

Obtenez des informations détaillées sur l’opération pour l’ID spécifié avec la réponse Http.

Cette opération échoue si l’ID d’opération utilisé est passé 24 heures.

Code sample

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 d’opération unique.

Returns:

Response<T> contenant le demandéOperationDetails.

getResourceDetails

public Mono getResourceDetails()

Obtenez des informations sur la ressource Form Recognizer actuelle.

Code sample

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:

Détails des informations de ressource demandées.

getResourceDetailsWithResponse

public Mono<>> getResourceDetailsWithResponse()

Obtenez les informations sur la ressource Form Recognizer actuelle avec une réponse Http.

Code sample

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:

Response<T> contenant les détails des informations de ressource demandées.

listDocumentClassifiers

public PagedFlux listDocumentClassifiers()

Répertoriez les informations de chaque classifieur de document sur le compte Form Recognizer qui ont été créés avec succès.

Code sample

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>sur DocumentClassifierDetails le compte Form Recognizer.

listDocumentModels

public PagedFlux listDocumentModels()

Répertoriez les informations de chaque modèle sur le compte Form Recognizer qui ont été créés avec succès.

Code sample

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

Répertoriez les informations pour chaque opération de modèle sur le compte Form Recognizer au cours des dernières 24 heures.

Code sample

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:

S’applique à