DocumentModelAdministrationClient Klasse
- java.
lang. Object - com.
azure. ai. formrecognizer. documentanalysis. administration. DocumentModelAdministrationClient
- com.
public final class DocumentModelAdministrationClient
Diese Klasse stellt einen asynchronen Client zum Herstellen einer Verbindung mit dem Formularerkennung Azure Cognitive Service bereit.
Dieser Client bietet asynchrone Methoden für die Ausführung:
- Erstellen eines benutzerdefinierten Modells: Extrahieren Sie Daten aus Ihren spezifischen Dokumenten, indem Sie benutzerdefinierte Modelle mithilfe der beginBuidlDocumentModel -Methode erstellen, um eine SAS-Container-URL für Ihren Azure Storage-Blobcontainer bereitzustellen.
- Zusammengesetzte benutzerdefinierte Modelle: Erstellt mithilfe der beginComposeDocumentModel -Methode ein neues Modell aus Dokumenttypen der Auflistung vorhandener Modelle.
- Kopieren eines benutzerdefinierten Modells: Kopieren Sie ein benutzerdefiniertes Formularerkennung-Modell mithilfe der beginCopyDocumentModelTo -Methode in eine Zielressource Formularerkennung.
- Benutzerdefinierte Modellverwaltung: Rufen Sie ausführliche Informationen ab, löschen und listen Sie benutzerdefinierte Modelle mithilfe von Methoden getDocumentModel(String modelId)bzw listDocumentModels()deleteDocumentModel(String modelId) . auf.
- Betriebsverwaltung: Rufen Sie detaillierte Informationen ab und listen Sie Vorgänge für das Formularerkennung-Konto mithilfe von Methoden getOperation(String operationId) bzwlistOperations(). auf.
- Abrufe und Rückrufe: Es umfasst Mechanismen zum Abrufen des Diensts, um die status eines Analysevorgangs zu überprüfen oder Rückrufe zu registrieren, um Benachrichtigungen zu empfangen, wenn die Analyse abgeschlossen ist.
Hinweis: Dieser Client unterstützt V2022_08_31 nur und neuer. So verwenden Sie eine ältere Dienstversion und FormRecognizerClient.formrecognizer.training.FormTrainingClient.
Dienstclients sind der Interaktionspunkt für Entwickler, um Azure Formularerkennung zu verwenden. DocumentModelAdministrationClient ist der synchrone Dienstclient und DocumentModelAdministrationAsyncClient der asynchrone Dienstclient. Die in diesem Dokument gezeigten Beispiele verwenden ein Anmeldeinformationsobjekt namens DefaultAzureCredential für die Authentifizierung, das für die meisten Szenarien geeignet ist, einschließlich lokaler Entwicklungs- und Produktionsumgebungen. Darüber hinaus wird empfohlen, die verwaltete Identität für die Authentifizierung in Produktionsumgebungen zu verwenden. Weitere Informationen zu verschiedenen Authentifizierungsmethoden und den entsprechenden Anmeldeinformationstypen finden Sie in der Azure Identity-Dokumentation.
Beispiel: Erstellen eines DocumentModelAdministrationAsyncClient mit DefaultAzureCredential
Im folgenden Codebeispiel wird die Erstellung einer DocumentModelAdministrationAsyncClientveranschaulicht, die zum Konfigurieren von "DefaultAzureCredentialBuilder" verwendet wird.
DocumentModelAdministrationClient client = new DocumentModelAdministrationClientBuilder()
.endpoint("{endpoint}")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
Weitere Informationen finden Sie im folgenden Codebeispiel zur Verwendung AzureKeyCredential für die Clienterstellung.
DocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =
new DocumentModelAdministrationClientBuilder()
.credential(new AzureKeyCredential("{key}"))
.endpoint("{endpoint}")
.buildAsyncClient();
Methodenzusammenfassung
Modifizierer und Typ | Methode und Beschreibung |
---|---|
Sync |
beginBuildDocumentClassifier(Map<String,ClassifierDocumentTypeDetails> documentTypes)
Erstellt ein benutzerdefiniertes Klassifiziererdokumentmodell. |
Sync |
beginBuildDocumentClassifier(Map<String,ClassifierDocumentTypeDetails> documentTypes, BuildDocumentClassifierOptions buildDocumentClassifierOptions, Context context)
Erstellt ein benutzerdefiniertes Klassifiziererdokumentmodell. |
Sync |
beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode)
Erstellt ein benutzerdefiniertes Dokumentenanalysemodell. |
Sync |
beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode, BuildDocumentModelOptions buildDocumentModelOptions, Context context)
Erstellt ein benutzerdefiniertes Dokumentenanalysemodell. |
Sync |
beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode)
Erstellt ein benutzerdefiniertes Dokumentenanalysemodell. |
Sync |
beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode, String prefix, BuildDocumentModelOptions buildDocumentModelOptions, Context context)
Erstellt ein benutzerdefiniertes Dokumentenanalysemodell. |
Sync |
beginComposeDocumentModel(List<String> componentModelIds)
Erstellen Sie ein zusammengesetztes Modell aus der bereitgestellten Liste der vorhandenen Modelle im Konto. |
Sync |
beginComposeDocumentModel(List<String> componentModelIds, ComposeDocumentModelOptions composeDocumentModelOptions, Context context)
Erstellen Sie ein zusammengesetztes Modell aus der bereitgestellten Liste der vorhandenen Modelle im Konto. |
Sync |
beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)
Kopieren Sie ein benutzerdefiniertes Modell, das in dieser Ressource (der Quelle) gespeichert ist, in das vom Benutzer angegebene Ziel Formularerkennung Ressource. |
Sync |
beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target, Context context)
Kopieren Sie ein benutzerdefiniertes Modell, das in dieser Ressource (der Quelle) gespeichert ist, in das vom Benutzer angegebene Ziel Formularerkennung Ressource. |
void |
deleteDocumentClassifier(String classifierId)
Löscht den angegebenen Dokumentklassifizierer. |
Response<Void> |
deleteDocumentClassifierWithResponse(String classifierId, Context context)
Löscht den angegebenen Dokumentklassifizierer. |
void |
deleteDocumentModel(String modelId)
Löscht das angegebene benutzerdefinierte Dokumentanalysemodell. |
Response<Void> |
deleteDocumentModelWithResponse(String modelId, Context context)
Löscht das angegebene benutzerdefinierte Dokumentanalysemodell. |
Document |
getCopyAuthorization()
Generieren Sie die Autorisierung zum Kopieren eines benutzerdefinierten Modells in die Zielressource Formularerkennung. |
Response<Document |
getCopyAuthorizationWithResponse(CopyAuthorizationOptions copyAuthorizationOptions, Context context)
Generieren Sie die Autorisierung zum Kopieren eines benutzerdefinierten Modells in die Zielressource Formularerkennung. |
Document |
getDocumentAnalysisClient()
Erstellt ein neues DocumentAnalysisClient-Objekt. |
Document |
getDocumentClassifier(String classifierId)
Rufen Sie detaillierte Informationen für einen Dokumentklassifizierer anhand seiner ID ab. |
Response<Document |
getDocumentClassifierWithResponse(String classifierId, Context context)
Rufen Sie detaillierte Informationen für einen Dokumentklassifizierer anhand seiner ID ab. |
Document |
getDocumentModel(String modelId)
Rufen Sie ausführliche Informationen für eine angegebene Modell-ID ab. |
Response<Document |
getDocumentModelWithResponse(String modelId, Context context)
Rufen Sie ausführliche Informationen für eine angegebene Modell-ID ab. |
Operation |
getOperation(String operationId)
Rufen Sie detaillierte Vorgangsinformationen für die angegebene ID mit http-Antwort ab. |
Response<Operation |
getOperationWithResponse(String operationId, Context context)
Rufen Sie detaillierte Vorgangsinformationen für die angegebene ID mit http-Antwort ab. |
Resource |
getResourceDetails()
Rufen Sie Informationen zur aktuellen Formularerkennung-Ressource ab. |
Response<Resource |
getResourceDetailsWithResponse(Context context)
Rufen Sie Informationen zur aktuellen Formularerkennungsressource mit einer HTTP-Antwort und einer angegebenen Contextab. |
Paged |
listDocumentClassifiers()
Listen Sie Informationen für die einzelnen Dokumentklassifizierungen für das Formularerkennung Konto auf, die erfolgreich erstellt wurden. |
Paged |
listDocumentClassifiers(Context context)
Auflisten von Informationen für die einzelnen Dokumentklassifizierungen im Formularerkennung Konto, die erfolgreich mit einer HTTP-Antwort und einem angegebenen Contexterstellt wurden. |
Paged |
listDocumentModels()
Listen Sie Informationen für jedes Modell im Formularerkennung Konto auf, das erfolgreich erstellt wurde. |
Paged |
listDocumentModels(Context context)
Auflisten von Informationen für jedes Modell im Formularerkennung Konto, das erfolgreich mit einer HTTP-Antwort und einem angegebenen Contexterstellt wurde. |
Paged |
listOperations()
Listen Sie Informationen zu jedem Modellvorgang im Formularerkennung Konto in den letzten 24 Stunden auf. |
Paged |
listOperations(Context context)
Auflisten von Informationen zu jedem Vorgang im Formularerkennung Konto in den letzten 24 Stunden mit einer HTTP-Antwort und einem angegebenen Context. |
Geerbte Methoden von java.lang.Object
Details zur Methode
beginBuildDocumentClassifier
public SyncPoller
Erstellt ein benutzerdefiniertes Klassifiziererdokumentmodell.
Klassifizierermodelle können mehrere Dokumente oder mehrere Instanzen eines einzelnen Dokuments identifizieren. Dazu benötigen Sie mindestens fünf Dokumente für jede Klasse und zwei Klassen von Dokumenten.
Der Dienst unterstützt das Abbruchen des vorgangs mit langer Ausführung nicht und gibt eine Fehlermeldung zurück, die angibt, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String blobContainerUrl1040D = "{SAS_URL_of_your_container_in_blob_storage}";
String blobContainerUrl1040A = "{SAS_URL_of_your_container_in_blob_storage}";
HashMap<String, ClassifierDocumentTypeDetails> documentTypes = new HashMap<>();
documentTypes.put("1040-D", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040D)
));
documentTypes.put("1040-A", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040A)
));
DocumentClassifierDetails classifierDetails
= documentModelAdministrationClient.beginBuildDocumentClassifier(documentTypes)
.getFinalResult();
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:
Returns:
beginBuildDocumentClassifier
public SyncPoller
Erstellt ein benutzerdefiniertes Klassifiziererdokumentmodell.
Klassifizierermodelle können mehrere Dokumente oder mehrere Instanzen eines einzelnen Dokuments identifizieren. Dazu benötigen Sie mindestens fünf Dokumente für jede Klasse und zwei Klassen von Dokumenten.
Der Dienst unterstützt das Abbruchen des vorgangs mit langer Ausführung nicht und gibt eine Fehlermeldung zurück, die angibt, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
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)
));
DocumentClassifierDetails classifierDetails
= documentModelAdministrationClient.beginBuildDocumentClassifier(documentTypesDetailsMap,
new BuildDocumentClassifierOptions()
.setClassifierId("classifierId")
.setDescription("classifier desc"),
Context.NONE)
.getFinalResult();
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:
Returns:
beginBuildDocumentModel
public SyncPoller
Erstellt ein benutzerdefiniertes Dokumentenanalysemodell.
Modelle werden mithilfe von Dokumenten erstellt, die den folgenden Inhaltstyp aufweisen: "application/pdf", "image/jpeg", "image/png", "image/tiff", image/bmp. Andere Inhaltstypen werden ignoriert.
Der Dienst unterstützt den Abbruch des zeitintensiven Vorgangs nicht und gibt eine Fehlermeldung zurück, die darauf hinweist, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
String fileList = "";
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginBuildDocumentModel(
new BlobFileListContentSource(blobContainerUrl, fileList),
DocumentModelBuildMode.TEMPLATE)
.getFinalResult();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
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:
Returns:
beginBuildDocumentModel
public SyncPoller
Erstellt ein benutzerdefiniertes Dokumentenanalysemodell.
Modelle werden mithilfe von Dokumenten erstellt, die den folgenden Inhaltstyp aufweisen: "application/pdf", "image/jpeg", "image/png", "image/tiff", image/bmp. Andere Inhaltstypen werden ignoriert.
Der Dienst unterstützt den Abbruch des zeitintensiven Vorgangs nicht und gibt eine Fehlermeldung zurück, die darauf hinweist, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
String fileList = "";
String modelId = "custom-model-id";
Map<String, String> attrs = new HashMap<String, String>();
attrs.put("createdBy", "sample");
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginBuildDocumentModel(
new BlobFileListContentSource(blobContainerUrl, fileList),
DocumentModelBuildMode.TEMPLATE,
new BuildDocumentModelOptions()
.setModelId(modelId)
.setDescription("model desc")
.setTags(attrs),
Context.NONE)
.getFinalResult();
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());
System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
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:
Returns:
beginBuildDocumentModel
public SyncPoller
Erstellt ein benutzerdefiniertes Dokumentenanalysemodell.
Modelle werden mithilfe von Dokumenten erstellt, die den folgenden Inhaltstyp aufweisen: "application/pdf", "image/jpeg", "image/png", "image/tiff", image/bmp. Andere Inhaltstypen werden ignoriert.
Der Dienst unterstützt den Abbruch des zeitintensiven Vorgangs nicht und gibt eine Fehlermeldung zurück, die darauf hinweist, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginBuildDocumentModel(blobContainerUrl,
DocumentModelBuildMode.TEMPLATE)
.getFinalResult();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
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:
Returns:
beginBuildDocumentModel
public SyncPoller
Erstellt ein benutzerdefiniertes Dokumentenanalysemodell.
Modelle werden mithilfe von Dokumenten erstellt, die den folgenden Inhaltstyp aufweisen: "application/pdf", "image/jpeg", "image/png", "image/tiff", image/bmp. Andere Inhaltstypen werden ignoriert.
Der Dienst unterstützt den Abbruch des zeitintensiven Vorgangs nicht und gibt eine Fehlermeldung zurück, die darauf hinweist, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
String modelId = "custom-model-id";
String prefix = "Invoice";
Map<String, String> attrs = new HashMap<String, String>();
attrs.put("createdBy", "sample");
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginBuildDocumentModel(blobContainerUrl,
DocumentModelBuildMode.TEMPLATE,
prefix,
new BuildDocumentModelOptions()
.setModelId(modelId)
.setDescription("model desc")
.setTags(attrs),
Context.NONE)
.getFinalResult();
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());
System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
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:
Returns:
beginComposeDocumentModel
public SyncPoller
Erstellen Sie ein zusammengesetztes Modell aus der bereitgestellten Liste der vorhandenen Modelle im Konto.
Bei diesen Vorgängen tritt ein Fehler auf, wenn die Liste aus einer ungültigen, nicht vorhandenen Modell-ID oder doppelten IDs besteht.
Der Dienst unterstützt den Abbruch des zeitintensiven Vorgangs nicht und gibt eine Fehlermeldung zurück, die darauf hinweist, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String modelId1 = "{custom-model-id_1}";
String modelId2 = "{custom-model-id_2}";
final DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2))
.getFinalResult();
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:
Returns:
beginComposeDocumentModel
public SyncPoller
Erstellen Sie ein zusammengesetztes Modell aus der bereitgestellten Liste der vorhandenen Modelle im Konto.
Bei diesen Vorgängen tritt ein Fehler auf, wenn die Liste aus einer ungültigen, nicht vorhandenen Modell-ID oder doppelten IDs besteht.
Der Dienst unterstützt den Abbruch des zeitintensiven Vorgangs nicht und gibt eine Fehlermeldung zurück, die darauf hinweist, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String modelId1 = "{custom-model-id_1}";
String modelId2 = "{custom-model-id_2}";
String modelId = "my-composed-model";
Map<String, String> attrs = new HashMap<String, String>();
attrs.put("createdBy", "sample");
final DocumentModelDetails documentModelDetails =
documentModelAdministrationClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2),
new ComposeDocumentModelOptions()
.setModelId(modelId)
.setDescription("my composed model desc")
.setTags(attrs),
Context.NONE)
.setPollInterval(Duration.ofSeconds(5))
.getFinalResult();
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());
System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
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:
Returns:
beginCopyDocumentModelTo
public SyncPoller
Kopieren Sie ein benutzerdefiniertes Modell, das in dieser Ressource (der Quelle) gespeichert ist, in das vom Benutzer angegebene Ziel Formularerkennung Ressource.
Dies sollte mit der Quellressource Formularerkennung aufgerufen werden (mit dem Modell, das kopiert werden soll). Der Zielparameter sollte aus der Ausgabe der Zielressource von getCopyAuthorization() der -Methode bereitgestellt werden.
Der Dienst unterstützt den Abbruch des zeitintensiven Vorgangs nicht und gibt eine Fehlermeldung zurück, die darauf hinweist, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String copyModelId = "copy-model";
// Get authorization to copy the model to target resource
DocumentModelCopyAuthorization documentModelCopyAuthorization
= documentModelAdministrationClient.getCopyAuthorization();
// Start copy operation from the source client
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginCopyDocumentModelTo(copyModelId, documentModelCopyAuthorization)
.getFinalResult();
System.out.printf("Copied model has model ID: %s, was created on: %s.%n,",
documentModelDetails.getModelId(),
documentModelDetails.getCreatedOn());
Parameters:
Returns:
beginCopyDocumentModelTo
public SyncPoller
Kopieren Sie ein benutzerdefiniertes Modell, das in dieser Ressource (der Quelle) gespeichert ist, in das vom Benutzer angegebene Ziel Formularerkennung Ressource.
Dies sollte mit der Quellressource Formularerkennung aufgerufen werden (mit dem Modell, das kopiert werden soll). Der Zielparameter sollte aus der Ausgabe der Zielressource von getCopyAuthorization() der -Methode bereitgestellt werden.
Der Dienst unterstützt den Abbruch des zeitintensiven Vorgangs nicht und gibt eine Fehlermeldung zurück, die darauf hinweist, dass keine Abbruchunterstützung vorhanden ist.
Codebeispiel
String copyModelId = "copy-model";
// Get authorization to copy the model to target resource
DocumentModelCopyAuthorization documentModelCopyAuthorization
= documentModelAdministrationClient.getCopyAuthorization();
// Start copy operation from the source client
DocumentModelDetails documentModelDetails =
documentModelAdministrationClient.beginCopyDocumentModelTo(copyModelId,
documentModelCopyAuthorization,
Context.NONE)
.getFinalResult();
System.out.printf("Copied model has model ID: %s, was created on: %s.%n,",
documentModelDetails.getModelId(),
documentModelDetails.getCreatedOn());
Parameters:
Returns:
deleteDocumentClassifier
public void deleteDocumentClassifier(String classifierId)
Löscht den angegebenen Dokumentklassifizierer.
Codebeispiel
String classifierId = "{classifierId}";
documentModelAdministrationClient.deleteDocumentClassifier(classifierId);
System.out.printf("Classifier ID: %s is deleted.%n", classifierId);
Parameters:
deleteDocumentClassifierWithResponse
public Response
Löscht den angegebenen Dokumentklassifizierer.
Codebeispiel
String classifierId = "{classifierId}";
Response<Void> response
= documentModelAdministrationClient.deleteDocumentClassifierWithResponse(classifierId, Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
System.out.printf("Classifier ID: %s is deleted.%n", classifierId);
Parameters:
Returns:
deleteDocumentModel
public void deleteDocumentModel(String modelId)
Löscht das angegebene benutzerdefinierte Dokumentanalysemodell.
Codebeispiel
String modelId = "{custom-model-id}";
documentModelAdministrationClient.deleteDocumentModel(modelId);
System.out.printf("Model ID: %s is deleted.%n", modelId);
Parameters:
deleteDocumentModelWithResponse
public Response
Löscht das angegebene benutzerdefinierte Dokumentanalysemodell.
Codebeispiel
String modelId = "{custom-model-id}";
Response<Void> response
= documentModelAdministrationClient.deleteDocumentModelWithResponse(modelId, Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
System.out.printf("Model ID: %s is deleted.%n", modelId);
Parameters:
Returns:
getCopyAuthorization
public DocumentModelCopyAuthorization getCopyAuthorization()
Generieren Sie die Autorisierung zum Kopieren eines benutzerdefinierten Modells in die Zielressource Formularerkennung.
Dies sollte von der Zielressource aufgerufen werden (in die das Modell kopiert wird), und die Ausgabe kann als Zielparameter an beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)übergeben werden.
Codebeispiel
DocumentModelCopyAuthorization documentModelCopyAuthorization
= documentModelAdministrationClient.getCopyAuthorization();
System.out.printf("Copy Authorization for model id: %s, access token: %s, expiration time: %s, "
+ "target resource ID; %s, target resource region: %s%n",
documentModelCopyAuthorization.getTargetModelId(),
documentModelCopyAuthorization.getAccessToken(),
documentModelCopyAuthorization.getExpiresOn(),
documentModelCopyAuthorization.getTargetResourceId(),
documentModelCopyAuthorization.getTargetResourceRegion()
);
Returns:
getCopyAuthorizationWithResponse
public Response
Generieren Sie die Autorisierung zum Kopieren eines benutzerdefinierten Modells in die Zielressource Formularerkennung.
Dies sollte von der Zielressource aufgerufen werden (in die das Modell kopiert wird), und die Ausgabe kann als Zielparameter an beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)übergeben werden.
Parameters:
Response<DocumentModelCopyAuthorization> copyAuthorization CopyAuthorizationResponse = documentModelAdministrationClient.getCopyAuthorizationWithResponse( new CopyAuthorizationOptions() .setModelId(modelId) .setDescription("model-desc") .setTags(attrs), Context.NONE); System.out.printf("Copy Authorization operation returned with status: %s", copyAuthorizationResponse.getStatusCode()); DocumentModelCopyAuthorization documentModelCopyAuthorization = copyAuthorizationResponse.getValue(); System.out.printf("Copy Authorization for model id: %s, access token: %s, " + "expiration time: %s, target resource ID; %s, target resource region: %s%n", documentModelCopyAuthorization.getTargetModelId(), documentModelCopyAuthorization.getAccessToken(), documentModelCopyAuthorization.getExpiresOn(), documentModelCopyAuthorization.getTargetResourceId(), documentModelCopyAuthorization.getTargetResourceRegion() );
Returns:
getDocumentAnalysisClient
public DocumentAnalysisClient getDocumentAnalysisClient()
Erstellt ein neues DocumentAnalysisClient-Objekt. Die neue DocumentAnalysisClient verwendet dieselbe Anforderungsrichtlinienpipeline wie die DocumentAnalysisClient.
Returns:
getDocumentClassifier
public DocumentClassifierDetails getDocumentClassifier(String classifierId)
Rufen Sie detaillierte Informationen für einen Dokumentklassifizierer anhand seiner ID ab.
Codebeispiel
String classifierId = "{classifierId}";
DocumentClassifierDetails documentClassifierDetails
= documentModelAdministrationClient.getDocumentClassifier(classifierId);
System.out.printf("Classifier ID: %s%n", documentClassifierDetails.getClassifierId());
System.out.printf("Classifier Description: %s%n", documentClassifierDetails.getDescription());
System.out.printf("Classifier Created on: %s%n", documentClassifierDetails.getCreatedOn());
documentClassifierDetails.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:
Returns:
getDocumentClassifierWithResponse
public Response
Rufen Sie detaillierte Informationen für einen Dokumentklassifizierer anhand seiner ID ab.
Codebeispiel
String modelId = "{custom-model-id}";
Response<DocumentClassifierDetails> response
= documentModelAdministrationClient.getDocumentClassifierWithResponse(modelId, Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
DocumentClassifierDetails documentClassifierDetails = response.getValue();
System.out.printf("Classifier ID: %s%n", documentClassifierDetails.getClassifierId());
System.out.printf("Classifier Description: %s%n", documentClassifierDetails.getDescription());
System.out.printf("Classifier Created on: %s%n", documentClassifierDetails.getCreatedOn());
documentClassifierDetails.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:
Returns:
getDocumentModel
public DocumentModelDetails getDocumentModel(String modelId)
Rufen Sie ausführliche Informationen für eine angegebene Modell-ID ab.
Codebeispiel
String modelId = "{custom-model-id}";
DocumentModelDetails documentModelDetails = documentModelAdministrationClient.getDocumentModel(modelId);
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:
Returns:
getDocumentModelWithResponse
public Response
Rufen Sie ausführliche Informationen für eine angegebene Modell-ID ab.
Codebeispiel
String modelId = "{custom-model-id}";
Response<DocumentModelDetails> response
= documentModelAdministrationClient.getDocumentModelWithResponse(modelId, Context.NONE);
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:
Returns:
getOperation
public OperationDetails getOperation(String operationId)
Rufen Sie detaillierte Vorgangsinformationen für die angegebene ID mit http-Antwort ab.
Dieser Vorgang schlägt fehl, wenn die verwendete Vorgangs-ID nach 24 Stunden liegt.
Codebeispiel
String operationId = "{operation-id}";
OperationDetails operationDetails
= documentModelAdministrationClient.getOperation(operationId);
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:
Returns:
getOperationWithResponse
public Response
Rufen Sie detaillierte Vorgangsinformationen für die angegebene ID mit http-Antwort ab.
Dieser Vorgang schlägt fehl, wenn die verwendete Vorgangs-ID nach 24 Stunden liegt.
Codebeispiel
String operationId = "{operation-id}";
Response<OperationDetails> response =
documentModelAdministrationClient.getOperationWithResponse(operationId, Context.NONE);
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:
Returns:
getResourceDetails
public ResourceDetails getResourceDetails()
Rufen Sie Informationen zur aktuellen Formularerkennung-Ressource ab.
Codebeispiel
ResourceDetails resourceDetails = documentModelAdministrationClient.getResourceDetails();
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:
getResourceDetailsWithResponse
public Response
Rufen Sie Informationen zur aktuellen Formularerkennungsressource mit einer HTTP-Antwort und einer angegebenen Contextab.
Codebeispiel
Response<ResourceDetails> response =
documentModelAdministrationClient.getResourceDetailsWithResponse(Context.NONE);
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());
Parameters:
Returns:
listDocumentClassifiers
public PagedIterable
Listen Sie Informationen für die einzelnen Dokumentklassifizierungen für das Formularerkennung Konto auf, die erfolgreich erstellt wurden.
Codebeispiel
documentModelAdministrationClient.listDocumentClassifiers()
.forEach(documentModel ->
System.out.printf("Classifier ID: %s, Classifier description: %s, Created on: %s.%n",
documentModel.getClassifierId(),
documentModel.getDescription(),
documentModel.getCreatedOn())
);
Returns:
listDocumentClassifiers
public PagedIterable
Auflisten von Informationen für die einzelnen Dokumentklassifizierungen im Formularerkennung Konto, die erfolgreich mit einer HTTP-Antwort und einem angegebenen Contexterstellt wurden.
Codebeispiel
documentModelAdministrationClient.listDocumentClassifiers(Context.NONE)
.forEach(documentModel ->
System.out.printf("Classifier ID: %s, Classifier description: %s, Created on: %s.%n",
documentModel.getClassifierId(),
documentModel.getDescription(),
documentModel.getCreatedOn())
);
Parameters:
Returns:
listDocumentModels
public PagedIterable
Listen Sie Informationen für jedes Modell im Formularerkennung Konto auf, das erfolgreich erstellt wurde.
Codebeispiel
documentModelAdministrationClient.listDocumentModels()
.forEach(documentModel ->
System.out.printf("Model ID: %s, Model description: %s, Created on: %s.%n",
documentModel.getModelId(),
documentModel.getDescription(),
documentModel.getCreatedOn())
);
Returns:
listDocumentModels
public PagedIterable
Auflisten von Informationen für jedes Modell im Formularerkennung Konto, das erfolgreich mit einer HTTP-Antwort und einem angegebenen Contexterstellt wurde.
Codebeispiel
documentModelAdministrationClient.listDocumentModels(Context.NONE)
.forEach(documentModel ->
System.out.printf("Model ID: %s, Model description: %s, Created on: %s.%n",
documentModel.getModelId(),
documentModel.getDescription(),
documentModel.getCreatedOn())
);
Parameters:
Returns:
listOperations
public PagedIterable
Listen Sie Informationen zu jedem Modellvorgang im Formularerkennung Konto in den letzten 24 Stunden auf.
Codebeispiel
PagedIterable<OperationSummary>
modelOperationInfo = documentModelAdministrationClient.listOperations();
modelOperationInfo.forEach(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:
listOperations
public PagedIterable
Auflisten von Informationen zu jedem Vorgang im Formularerkennung Konto in den letzten 24 Stunden mit einer HTTP-Antwort und einem angegebenen Context.
Codebeispiel
PagedIterable<OperationSummary>
modelOperationInfo = documentModelAdministrationClient.listOperations(Context.NONE);
modelOperationInfo.forEach(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());
});
Parameters:
Returns:
Gilt für:
Azure SDK for Java