DocumentAnalysisClient Classe
- java.
lang. Object - com.
azure. ai. formrecognizer. documentanalysis. DocumentAnalysisClient
- com.
public final class DocumentAnalysisClient
Cette classe fournit un client synchrone pour se connecter au Form Recognizer Azure Cognitive Service.
Ce client fournit des méthodes synchrones à effectuer :
- Analyse de documents personnalisée : classification, extraction et analyse des données à partir de formulaires et de documents spécifiques à des données métier et des cas d’usage distincts. Utilisez le modèle entraîné personnalisé en passant son modelId dans la com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient#beginAnalyzeDocument(String, BinaryData) méthode .
- Analyse générale du document : extrayez du texte, des tableaux, de la structure et des paires clé-valeur. Utilisez le modèle de document général fourni par le service Form Recognizer en passant modelId="reconstruit-document » dans la com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient#beginAnalyzeDocument(String, BinaryData) méthode .
- Analyse de modèle prédéfinie : analyser les reçus, les cartes de visite, les factures, les id, les W2 et d’autres documents avec supported prebuilt models. Use the prebuilt receipt model provided by passing modelId="prebuilt-receipt" into the com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient#beginAnalyzeDocument(String, BinaryData) method.
- Analyse de la disposition : extrayez du texte, des marques de sélection et des structures de tableaux, ainsi que leurs coordonnées de cadre englobant, à partir de formulaires et de documents. Utilisez le modèle d’analyse de disposition fourni par le service en passant modelId="prebuilt-layout » dans la com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient#beginAnalyzeDocument(String, BinaryData) méthode.
- 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.
Ce client fournit également différentes méthodes basées sur les entrées d’une URL et les entrées d’un flux.
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. DocumentAnalysisClient est le client de service synchrone et DocumentAnalysisAsyncClient 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 DocumentAnalysisAsyncClient avec DefaultAzureCredential
L’exemple de code suivant illustre la création d’un DocumentAnalysisClient, à l’aide de « DefaultAzureCredentialBuilder » pour le configurer.
DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
.endpoint("{endpoint}")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
Pour plus d’informations, consultez l’exemple de code ci-dessous à utiliser pour la AzureKeyCredential création du client.
DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
.credential(new AzureKeyCredential("{key}"))
.endpoint("{endpoint}")
.buildClient();
Résumé de la méthode
| Modificateur et type | Méthode et description |
|---|---|
|
Sync |
beginAnalyzeDocument(String modelId, BinaryData document)
Analyse les données de documents à l’aide de la reconnaissance optique de caractères (OCR) à l’aide de l’un des modèles prédéfinis ou d’un modèle d’analyse personnalisé. |
|
Sync |
beginAnalyzeDocument(String modelId, BinaryData document, AnalyzeDocumentOptions analyzeDocumentOptions, Context context)
Analyse les données de documents avec reconnaissance optique de caractères (OCR) et les valeurs sémantiques d’un document donné à l’aide de l’un des modèles prédéfinis ou d’un modèle d’analyse personnalisé. |
|
Sync |
beginAnalyzeDocumentFromUrl(String modelId, String documentUrl)
Analyse les données de documents avec reconnaissance optique de caractères (OCR) et les valeurs sémantiques d’un document donné à l’aide de l’un des modèles prédéfinis ou d’un modèle d’analyse personnalisé. |
|
Sync |
beginAnalyzeDocumentFromUrl(String modelId, String documentUrl, AnalyzeDocumentOptions analyzeDocumentOptions, Context context)
Analyse les données de documents avec reconnaissance optique de caractères (OCR) et les valeurs sémantiques d’un document donné à l’aide de l’un des modèles prédéfinis ou d’un modèle d’analyse personnalisé. |
|
Sync |
beginClassifyDocument(String classifierId, BinaryData document)
Classifier un document donné à l’aide d’un classifieur de documents. |
|
Sync |
beginClassifyDocument(String classifierId, BinaryData document, Context context)
Classifier un document donné à l’aide d’un classifieur de document. |
|
Sync |
beginClassifyDocumentFromUrl(String classifierId, String documentUrl)
Classifier un document donné à l’aide d’un classifieur de document. |
|
Sync |
beginClassifyDocumentFromUrl(String classifierId, String documentUrl, Context context)
Classifier un document donné à l’aide d’un classifieur de document. |
Méthodes héritées de java.lang.Object
Détails de la méthode
beginAnalyzeDocument
public SyncPoller
Analyse les données de documents à l’aide de la reconnaissance optique de caractères (OCR) à l’aide de l’un des modèles prédéfinis ou d’un modèle d’analyse personnalisé.
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
File document = new File("{local/file_path/fileName.jpg}");
String modelId = "{custom_trained_model_id}";
byte[] fileContent = Files.readAllBytes(document.toPath());
documentAnalysisClient.beginAnalyzeDocument(modelId, BinaryData.fromBytes(fileContent))
.getFinalResult()
.getDocuments().stream()
.map(AnalyzedDocument::getFields)
.forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {
System.out.printf("Field text: %s%n", key);
System.out.printf("Field value data content: %s%n", documentField.getContent());
System.out.printf("Confidence score: %.2f%n", documentField.getConfidence());
}));
}
Parameters:
Returns:
beginAnalyzeDocument
public SyncPoller
Analyse les données de documents avec reconnaissance optique de caractères (OCR) et les valeurs sémantiques d’un document donné à l’aide de l’un des modèles prédéfinis ou d’un modèle d’analyse personnalisé.
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
Analyser un document avec des options configurables.
File document = new File("{local/file_path/fileName.jpg}");
String modelId = "{custom_trained_model_id}";
byte[] fileContent = Files.readAllBytes(document.toPath());
documentAnalysisClient.beginAnalyzeDocument(modelId, BinaryData.fromBytes(fileContent),
new AnalyzeDocumentOptions().setPages(Arrays.asList("1", "3")), Context.NONE)
.getFinalResult()
.getDocuments().stream()
.map(AnalyzedDocument::getFields)
.forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {
System.out.printf("Field text: %s%n", key);
System.out.printf("Field value data content: %s%n", documentField.getContent());
System.out.printf("Confidence score: %.2f%n", documentField.getConfidence());
}));
Parameters:
Returns:
beginAnalyzeDocumentFromUrl
public SyncPoller
Analyse les données de documents avec reconnaissance optique de caractères (OCR) et les valeurs sémantiques d’un document donné à l’aide de l’un des modèles prédéfinis ou d’un modèle d’analyse personnalisé.
Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne un message d’erreur indiquant l’absence de prise en charge de l’annulation
Code sample
Analyser un document à l’aide de l’URL du document.
String documentUrl = "{document_url}";
String modelId = "{custom_trained_model_id}";
documentAnalysisClient.beginAnalyzeDocumentFromUrl(modelId, documentUrl).getFinalResult()
.getDocuments().stream()
.map(AnalyzedDocument::getFields)
.forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {
System.out.printf("Field text: %s%n", key);
System.out.printf("Field value data content: %s%n", documentField.getContent());
System.out.printf("Confidence score: %.2f%n", documentField.getConfidence());
}));
Parameters:
Returns:
beginAnalyzeDocumentFromUrl
public SyncPoller
Analyse les données de documents avec reconnaissance optique de caractères (OCR) et les valeurs sémantiques d’un document donné à l’aide de l’un des modèles prédéfinis ou d’un modèle d’analyse personnalisé.
Le service ne prend pas en charge l’annulation de l’opération de longue durée et retourne un message d’erreur indiquant l’absence de prise en charge de l’annulation
Code sample
Analysez un document à l’aide de l’URL du document avec des options configurables.
String documentUrl = "{document_url}";
String modelId = "{custom_trained_model_id}";
documentAnalysisClient.beginAnalyzeDocumentFromUrl(modelId, documentUrl).getFinalResult()
.getDocuments().stream()
.map(AnalyzedDocument::getFields)
.forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {
System.out.printf("Field text: %s%n", key);
System.out.printf("Field value data content: %s%n", documentField.getContent());
System.out.printf("Confidence score: %.2f%n", documentField.getConfidence());
}));
Parameters:
Returns:
beginClassifyDocument
public SyncPoller
Classifier un document donné à l’aide d’un classifieur de documents. Pour plus d’informations sur la création d’un modèle classifieur personnalisé, consultez
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
File document = new File("{local/file_path/fileName.jpg}");
String classifierId = "{custom_trained_classifier_id}";
byte[] fileContent = Files.readAllBytes(document.toPath());
documentAnalysisClient.beginClassifyDocument(classifierId, BinaryData.fromBytes(fileContent))
.getFinalResult()
.getDocuments()
.forEach(analyzedDocument -> System.out.printf("Doc Type: %s%n", analyzedDocument.getDocType()));
Parameters:
Returns:
beginClassifyDocument
public SyncPoller
Classifier un document donné à l’aide d’un classifieur de documents. Pour plus d’informations sur la création d’un modèle classifieur personnalisé, consultez
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
File document = new File("{local/file_path/fileName.jpg}");
String classifierId = "{custom_trained_classifier_id}";
byte[] fileContent = Files.readAllBytes(document.toPath());
documentAnalysisClient.beginClassifyDocument(classifierId, BinaryData.fromBytes(fileContent), Context.NONE)
.getFinalResult()
.getDocuments()
.forEach(analyzedDocument -> System.out.printf("Doc Type: %s%n", analyzedDocument.getDocType()));
Parameters:
Returns:
beginClassifyDocumentFromUrl
public SyncPoller
Classifier un document donné à l’aide d’un classifieur de document. Pour plus d’informations sur la création d’un modèle de classifieur personnalisé, consultez
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
Analysez un document à l’aide de l’URL du document avec des options configurables.
String documentUrl = "{file_source_url}";
String classifierId = "{custom_trained_classifier_id}";
documentAnalysisClient.beginClassifyDocumentFromUrl(classifierId, documentUrl)
.getFinalResult()
.getDocuments()
.forEach(analyzedDocument -> System.out.printf("Doc Type: %s%n", analyzedDocument.getDocType()));
Parameters:
Returns:
beginClassifyDocumentFromUrl
public SyncPoller
Classifier un document donné à l’aide d’un classifieur de document. Pour plus d’informations sur la création d’un modèle de classifieur personnalisé, consultez
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
Analysez un document à l’aide de l’URL du document avec des options configurables.
String documentUrl = "{file_source_url}";
String classifierId = "{custom_trained_classifier_id}";
documentAnalysisClient.beginClassifyDocumentFromUrl(classifierId, documentUrl, Context.NONE)
.getFinalResult()
.getDocuments()
.forEach(analyzedDocument -> System.out.printf("Doc Type: %s%n", analyzedDocument.getDocType()));
Parameters:
Returns:
S’applique à
Azure SDK for Java
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour