FormTrainingClient Klasse

Paket:

com.azure.ai.formrecognizer.training

Maven-Artefakt:

com.azure:azure-ai-formrecognizer:4.1.7

• java.lang.Object
• • com.azure.ai.formrecognizer.training.FormTrainingClient

public final class FormTrainingClient

Diese Klasse stellt einen synchronen Client zum Herstellen einer Verbindung mit dem Formularerkennung Azure Cognitive Service bereit.

Dieser Client bietet synchrone Methoden für Folgendes:

1. Trainieren eines benutzerdefinierten Modells: Trainieren Sie ein benutzerdefiniertes Modell zum Analysieren und Extrahieren von Daten aus Formularen und Dokumenten, die für Ihr Unternehmen spezifisch sind, mithilfe der beginTraining(String trainingFilesUrl, boolean useTrainingLabels) -Methode.
2. Kopieren eines benutzerdefinierten Modells: Kopieren Sie ein benutzerdefiniertes Formularerkennung-Modell mithilfe der beginCopyModel -Methode in eine Zielressource Formularerkennung.
3. Benutzerdefinierte Modelle auflisten: Rufen Sie Informationen zu allen benutzerdefinierten Modellen mit den getCustomModel(String modelId) Methoden und listCustomModels() ab.
4. 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 V2_1 nur und niedriger. Es wird empfohlen, DocumentModelAdministrationAsyncClient eine neuere Dienstversion und DocumentModelAdministrationClientzu verwenden.

Informationen zur Verwendung der API-Versionen 2022-08-31 und höher finden Sie im Migrationsleitfaden .

Dienstclients sind der Interaktionspunkt für Entwickler, um Azure Formularerkennung zu verwenden. FormTrainingClient ist der synchrone Dienstclient und FormTrainingAsyncClient 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 FormTrainingClient mit DefaultAzureCredential

Im folgenden Codebeispiel wird die Erstellung einer FormTrainingClientveranschaulicht, die zum Konfigurieren von "DefaultAzureCredentialBuilder" verwendet wird.

FormTrainingClient client = new FormTrainingClientBuilder()
     .endpoint("{endpoint}")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();

Weitere Informationen finden Sie im folgenden Codebeispiel zur Verwendung AzureKeyCredential für die Clienterstellung.

FormTrainingClient formTrainingClient = new FormTrainingClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .buildClient();

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
SyncPoller<FormRecognizerOperationResult,CustomFormModelInfo>	beginCopyModel(String modelId, CopyAuthorization target) Kopieren Sie ein benutzerdefiniertes Modell, das in dieser Ressource (der Quelle) gespeichert ist, in das vom Benutzer angegebene Ziel Formularerkennung Ressource.
SyncPoller<FormRecognizerOperationResult,CustomFormModelInfo>	beginCopyModel(String modelId, CopyAuthorization target, Duration pollInterval, Context context) Kopieren Sie ein benutzerdefiniertes Modell, das in dieser Ressource (der Quelle) gespeichert ist, in das vom Benutzer angegebene Ziel Formularerkennung Ressource.
SyncPoller<FormRecognizerOperationResult,CustomFormModel>	beginCreateComposedModel(List<String> modelIds) Erstellen Sie ein zusammengesetztes Modell aus der bereitgestellten Liste der vorhandenen Modelle im Konto.
SyncPoller<FormRecognizerOperationResult,CustomFormModel>	beginCreateComposedModel(List<String> modelIds, CreateComposedModelOptions createComposedModelOptions, Context context) Erstellen Sie ein zusammengesetztes Modell aus der bereitgestellten Liste der vorhandenen Modelle im Konto.
SyncPoller<FormRecognizerOperationResult,CustomFormModel>	beginTraining(String trainingFilesUrl, boolean useTrainingLabels) Erstellt und trainiert ein benutzerdefiniertes Modell.
SyncPoller<FormRecognizerOperationResult,CustomFormModel>	beginTraining(String trainingFilesUrl, boolean useTrainingLabels, TrainingOptions trainingOptions, Context context) Erstellt und trainiert ein benutzerdefiniertes Modell.
void	deleteModel(String modelId) Löscht das angegebene benutzerdefinierte Modell.
Response<Void>	deleteModelWithResponse(String modelId, Context context) Löscht das angegebene benutzerdefinierte Modell.
AccountProperties	getAccountProperties() Rufen Sie Kontoinformationen des Formularerkennungskontos ab.
Response<AccountProperties>	getAccountPropertiesWithResponse(Context context) Abrufen von Kontoinformationen des Formularerkennungskontos mit einer HTTP-Antwort und einem angegebenen Context.
CopyAuthorization	getCopyAuthorization(String resourceId, String resourceRegion) Generieren Sie die Autorisierung zum Kopieren eines benutzerdefinierten Modells in die Zielressource Formularerkennung.
Response<CopyAuthorization>	getCopyAuthorizationWithResponse(String resourceId, String resourceRegion, Context context) Generieren Sie die Autorisierung zum Kopieren eines benutzerdefinierten Modells in die Zielressource Formularerkennung.
CustomFormModel	getCustomModel(String modelId) Rufen Sie detaillierte Informationen zu einer angegebenen benutzerdefinierten Modell-ID ab.
Response<CustomFormModel>	getCustomModelWithResponse(String modelId, Context context) Rufen Sie detaillierte Informationen zu einer angegebenen benutzerdefinierten Modell-ID ab.
FormRecognizerClient	getFormRecognizerClient() Erstellt ein neues FormRecognizerClient-Objekt.
PagedIterable<CustomFormModelInfo>	listCustomModels() Listen Sie Informationen für jedes Modell im Konto der Formularerkennung auf.
PagedIterable<CustomFormModelInfo>	listCustomModels(Context context) Auflisten von Informationen für jedes Modell im Formularerkennungskonto mit einer HTTP-Antwort und einem angegebenen Context.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zur Methode

beginCopyModel

public SyncPoller beginCopyModel(String modelId, CopyAuthorization target)

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(String resourceId, String resourceRegion) -Methode angegeben werden.

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 resourceId = "target-resource-Id";
 String resourceRegion = "target-resource-region";
 String copyModelId = "copy-model-Id";
 formTrainingAsyncClient.getCopyAuthorization(resourceId, resourceRegion)
     .flatMapMany(copyAuthorization -> formTrainingAsyncClient.beginCopyModel(copyModelId, copyAuthorization))
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(customFormModelInfo ->
         System.out.printf("Copied model has model Id: %s, model status: %s, training started on: %s,"
             + " training completed on: %s.%n",
         customFormModelInfo.getModelId(),
         customFormModelInfo.getStatus(),
         customFormModelInfo.getTrainingStartedOn(),
         customFormModelInfo.getTrainingCompletedOn()));

Parameters:

modelId - Modellbezeichner des Modells, das in die Zielressource Formularerkennung kopiert werden soll

target - die Kopierautorisierung für die Zielressource Formularerkennung. Die Kopierautorisierung kann aus dem Aufruf der Zielressource generiert werden. getCopyAuthorization(String resourceId, String resourceRegion)

Returns:

Eine SyncPoller<T,U> , die den Kopiermodellvorgang abfragt, bis er abgeschlossen ist, ein Fehler aufgetreten ist oder abgebrochen wurde.

beginCopyModel

public SyncPoller beginCopyModel(String modelId, CopyAuthorization target, Duration pollInterval, Context context)

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(String resourceId, String resourceRegion) -Methode angegeben werden.

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

// The resource to copy model to
 String resourceId = "target-resource-Id";
 String resourceRegion = "target-resource-region";
 // The Id of the model to be copied
 String copyModelId = "copy-model-Id";

 CopyAuthorization copyAuthorization = targetFormTrainingClient.getCopyAuthorization(resourceId,
     resourceRegion);
 formTrainingClient.beginCopyModel(copyModelId, copyAuthorization, Duration.ofSeconds(5), Context.NONE)
     .waitForCompletion();
 CustomFormModel modelCopy = targetFormTrainingClient.getCustomModel(copyAuthorization.getModelId());
 System.out.printf("Copied model has model Id: %s, model status: %s, was requested on: %s,"
         + " transfer completed on: %s.%n",
     modelCopy.getModelId(),
     modelCopy.getModelStatus(),
     modelCopy.getTrainingStartedOn(),
     modelCopy.getTrainingCompletedOn());

Parameters:

modelId - Modellbezeichner des Modells, das in die Zielressource Formularerkennung kopiert werden soll

target - die Kopierautorisierung für die Zielressource Formularerkennung. Die Kopierautorisierung kann aus dem Aufruf der Zielressource generiert werden. getCopyAuthorization(String resourceId, String resourceRegion)

pollInterval - Dauer zwischen den einzelnen Abfragen für den Vorgang status. Wenn keine angegeben ist, wird der Standardwert von 5 Sekunden verwendet.

context - Zusätzlicher Kontext, der während des Dienstaufrufs durch die HTTP-Pipeline übergeben wird.

Returns:

Eine SyncPoller<T,U> , die den Kopiermodellvorgang abfragt, bis er abgeschlossen ist, ein Fehler aufgetreten ist oder abgebrochen wurde.

beginCreateComposedModel

public SyncPoller beginCreateComposedModel(List modelIds)

Erstellen Sie ein zusammengesetztes Modell aus der bereitgestellten Liste der vorhandenen Modelle im Konto.

Dieser Vorgang schlägt fehl, wenn die Liste aus einer ungültigen, nicht vorhandenen Modell-ID oder doppelten ID besteht. Dieser Vorgang wird derzeit nur für benutzerdefinierte Modelle unterstützt, die mit Bezeichnungen trainiert werden.

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 labeledModelId1 = "5f21ab8d-71a6-42d8-9856-ef5985c486a8";
 String labeledModelId2 = "d7b0904c-841f-46f9-a9f4-3f2273eef7c9";
 final CustomFormModel customFormModel
     = formTrainingClient.beginCreateComposedModel(Arrays.asList(labeledModelId1, labeledModelId2))
     .getFinalResult();
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 System.out.printf("Is this a composed model: %s%n",
     customFormModel.getCustomModelProperties().isComposed());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

modelIds - Die Liste der Modell-IDs zum Bilden des zusammengesetzten Modells.

Returns:

Eine SyncPoller<T,U> , die den Vorgang zum Erstellen eines zusammengesetzten Modells abfragt, bis er abgeschlossen ist, ein Fehler aufgetreten ist oder abgebrochen wurde. Der abgeschlossene Vorgang gibt den CustomFormModelzurück.

beginCreateComposedModel

public SyncPoller beginCreateComposedModel(List modelIds, CreateComposedModelOptions createComposedModelOptions, Context context)

Erstellen Sie ein zusammengesetztes Modell aus der bereitgestellten Liste der vorhandenen Modelle im Konto.

Dieser Vorgang schlägt fehl, wenn die Liste aus einer ungültigen, nicht vorhandenen Modell-ID oder doppelten ID besteht. Dieser Vorgang wird derzeit nur für benutzerdefinierte Modelle unterstützt, die mit Bezeichnungen trainiert werden.

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 labeledModelId1 = "5f21ab8d-71a6-42d8-9856-ef5985c486a8";
 String labeledModelId2 = "d7b0904c-841f-46f9-a9f4-3f2273eef7c9";
 final CustomFormModel customFormModel =
     formTrainingClient.beginCreateComposedModel(Arrays.asList(labeledModelId1, labeledModelId2),
         new CreateComposedModelOptions()
             .setModelName("my composed model name"),
         Context.NONE)
         .setPollInterval(Duration.ofSeconds(5))
         .getFinalResult();
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 System.out.printf("Model display name: %s%n", customFormModel.getModelName());
 System.out.printf("Is this a composed model: %s%n",
     customFormModel.getCustomModelProperties().isComposed());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

modelIds - Die Liste der Modell-IDs zum Bilden des zusammengesetzten Modells.

createComposedModelOptions - Die konfigurierbare CreateComposedModelOptions , die beim Erstellen eines zusammengesetzten Modells übergeben werden soll.

context - Zusätzlicher Kontext, der während des Dienstaufrufs durch die HTTP-Pipeline übergeben wird.

Returns:

Eine SyncPoller<T,U> , die den Vorgang zum Erstellen eines zusammengesetzten Modells abfragt, bis er abgeschlossen ist, ein Fehler aufgetreten ist oder abgebrochen wurde. Der abgeschlossene Vorgang gibt den CustomFormModelzurück.

beginTraining

public SyncPoller beginTraining(String trainingFilesUrl, boolean useTrainingLabels)

Erstellt und trainiert ein benutzerdefiniertes Modell.

Modelle werden mit Dokumenten trainiert, die die folgenden Inhaltstypen aufweisen: „application/pdf“, „image/jpeg“, „image/png“ und „image/tiff“. Andere Inhaltstypen werden ignoriert.

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 trainingFilesUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 boolean useTrainingLabels = true;
 CustomFormModel customFormModel =
     formTrainingClient.beginTraining(trainingFilesUrl, useTrainingLabels).getFinalResult();
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form Type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

trainingFilesUrl - ein extern zugänglicher Azure Storage-Blobcontainer-URI (vorzugsweise ein Shared Access Signature-URI). Anweisungen zum Einrichten von Formularen für das Training in einem Azure Storage Blob Container finden Sie hier.

useTrainingLabels - Boolesch, um die Verwendung von beschrifteten Dateien zum Trainieren des Modells anzugeben.

Returns:

Eine SyncPoller<T,U> , die den Trainingsmodellvorgang abfragt, bis er abgeschlossen ist, fehlgeschlagen ist oder abgebrochen wurde. Der abgeschlossene Vorgang gibt das trainierte CustomFormModelzurück.

beginTraining

public SyncPoller beginTraining(String trainingFilesUrl, boolean useTrainingLabels, TrainingOptions trainingOptions, Context context)

Erstellt und trainiert ein benutzerdefiniertes Modell. Modelle werden mit Dokumenten trainiert, die die folgenden Inhaltstypen aufweisen: „application/pdf“, „image/jpeg“, „image/png“ und „image/tiff“. Andere Inhaltstypen werden ignoriert.

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 trainingFilesUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 TrainingFileFilter trainingFileFilter = new TrainingFileFilter().setSubfoldersIncluded(false).setPrefix("Invoice");
 boolean useTrainingLabels = true;

 CustomFormModel customFormModel = formTrainingClient.beginTraining(trainingFilesUrl, useTrainingLabels,
     new TrainingOptions()
         .setTrainingFileFilter(trainingFileFilter)
         .setPollInterval(Duration.ofSeconds(5)), Context.NONE)
     .getFinalResult();

 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form Type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

trainingFilesUrl - ein extern zugänglicher Azure Storage-Blobcontainer-URI (vorzugsweise ein Shared Access Signature-URI). Anweisungen zum Einrichten von Formularen für das Training in einem Azure Storage Blob Container finden Sie hier.

useTrainingLabels - Boolesch, um die Verwendung von beschrifteten Dateien zum Trainieren des Modells anzugeben.

trainingOptions - Das zusätzliche konfigurierbare TrainingOptions , das beim Trainieren eines Modells übergeben werden kann.

context - Zusätzlicher Kontext, der während des Dienstaufrufs durch die HTTP-Pipeline übergeben wird.

Returns:

Eine SyncPoller<T,U> , die den Trainingsmodellvorgang abfragt, bis er abgeschlossen ist, fehlgeschlagen ist oder abgebrochen wurde. Der abgeschlossene Vorgang gibt das trainierte CustomFormModelzurück.

deleteModel

public void deleteModel(String modelId)

Löscht das angegebene benutzerdefinierte Modell.

Codebeispiel

String modelId = "{model_id}";
 formTrainingClient.deleteModel(modelId);
 System.out.printf("Model Id: %s is deleted.%n", modelId);

Parameters:

modelId - Der UUID-Zeichenfolgenformatmodellbezeichner.

deleteModelWithResponse

public Response deleteModelWithResponse(String modelId, Context context)

Löscht das angegebene benutzerdefinierte Modell.

Codebeispiel

String modelId = "{model_id}";
 Response<Void> response = formTrainingClient.deleteModelWithResponse(modelId, Context.NONE);
 System.out.printf("Response Status Code: %d.", response.getStatusCode());
 System.out.printf("Model Id: %s is deleted.%n", modelId);

Parameters:

modelId - Der UUID-Zeichenfolgenformatmodellbezeichner.

context - Zusätzlicher Kontext, der während des Dienstaufrufs über die HTTP-Pipeline übergeben wird.

Returns:

EinResponse<T>, der status Code und HTTP-Headern enthält.

getAccountProperties

public AccountProperties getAccountProperties()

Rufen Sie Kontoinformationen des Formularerkennungskontos ab.

Codebeispiel

AccountProperties accountProperties = formTrainingClient.getAccountProperties();
 System.out.printf("Max number of models that can be trained for this account: %d%n",
     accountProperties.getCustomModelLimit());
 System.out.printf("Current count of trained custom models: %d%n", accountProperties.getCustomModelCount());

Returns:

Die angeforderten Kontoinformationen des Formularerkennungskontos.

getAccountPropertiesWithResponse

public Response getAccountPropertiesWithResponse(Context context)

Abrufen von Kontoinformationen des Formularerkennungskontos mit einer HTTP-Antwort und einem angegebenen Context.

Codebeispiel

Response<AccountProperties> response = formTrainingClient.getAccountPropertiesWithResponse(Context.NONE);
 System.out.printf("Response Status Code: %d.", response.getStatusCode());
 AccountProperties accountProperties = response.getValue();
 System.out.printf("Max number of models that can be trained for this account: %s%n",
     accountProperties.getCustomModelLimit());
 System.out.printf("Current count of trained custom models: %d%n", accountProperties.getCustomModelCount());

Parameters:

context - Zusätzlicher Kontext, der während des Dienstaufrufs über die HTTP-Pipeline übergeben wird.

Returns:

Die angeforderten Kontoinformationen des Formularerkennungskontos.

getCopyAuthorization

public CopyAuthorization getCopyAuthorization(String resourceId, String resourceRegion)

Generieren Sie die Autorisierung zum Kopieren eines benutzerdefinierten Modells in die Zielressource Formularerkennung.

Parameters:

resourceId - Azure-Ressourcen-ID der Zielressource Formularerkennung, in die das Modell kopiert wird. Diese Informationen finden Sie im Abschnitt "Eigenschaften" der Formularerkennung-Ressource im Azure-Portal.

resourceRegion - Speicherort der Zielressource Formularerkennung. Ein gültiger Azure-Regionsname, der von Cognitive Services unterstützt wird. Diese Informationen finden Sie im Abschnitt "Schlüssel und Endpunkt" der Formularerkennung-Ressource im Azure-Portal. Codebeispiel

 String resourceId = "target-resource-Id";
 String resourceRegion = "target-resource-region";
 CopyAuthorization copyAuthorization = formTrainingClient.getCopyAuthorization(resourceId, resourceRegion);
 System.out.printf("Copy Authorization for model id: %s, access token: %s, expiration time: %s, "
         + "target resource Id; %s, target resource region: %s%n",
     copyAuthorization.getModelId(),
     copyAuthorization.getAccessToken(),
     copyAuthorization.getExpiresOn(),
     copyAuthorization.getResourceId(),
     copyAuthorization.getResourceRegion()
 );
 

Returns:

Der CopyAuthorization

getCopyAuthorizationWithResponse

public Response getCopyAuthorizationWithResponse(String resourceId, String resourceRegion, Context context)

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 beginCopyModel(String modelId, CopyAuthorization target)übergeben werden.

Parameters:

resourceId - Azure-Ressourcen-ID der Zielressource Formularerkennung, in die das Modell kopiert wird. Diese Informationen finden Sie im Abschnitt "Eigenschaften" der Formularerkennung-Ressource im Azure-Portal.

resourceRegion - Speicherort der Zielressource Formularerkennung. Ein gültiger Azure-Regionsname, der von Cognitive Services unterstützt wird. Diese Informationen finden Sie im Abschnitt "Schlüssel und Endpunkt" der Formularerkennung-Ressource im Azure-Portal.

context - Zusätzlicher Kontext, der während des Dienstaufrufs über die HTTP-Pipeline übergeben wird. Codebeispiel

 String resourceId = "target-resource-Id";
 String resourceRegion = "target-resource-region";
 Response<CopyAuthorization> copyAuthorizationResponse =
     formTrainingClient.getCopyAuthorizationWithResponse(resourceId, resourceRegion, Context.NONE);
 System.out.printf("Copy Authorization operation returned with status: %s",
     copyAuthorizationResponse.getStatusCode());
 CopyAuthorization copyAuthorization = copyAuthorizationResponse.getValue();
 System.out.printf("Copy model id: %s, access token: %s, expiration time: %s, "
         + "target resource Id; %s, target resource region: %s%n",
     copyAuthorization.getModelId(),
     copyAuthorization.getAccessToken(),
     copyAuthorization.getExpiresOn(),
     copyAuthorization.getResourceId(),
     copyAuthorization.getResourceRegion()
 );
 

Returns:

Ein Response<T> mit dem CopyAuthorization

getCustomModel

public CustomFormModel getCustomModel(String modelId)

Rufen Sie detaillierte Informationen zu einer angegebenen benutzerdefinierten Modell-ID ab.

Codebeispiel

String modelId = "{model_id}";
 CustomFormModel customFormModel = formTrainingClient.getCustomModel(modelId);
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form Type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

modelId - Der UUID-Zeichenfolgenformatmodellbezeichner.

Returns:

Die detaillierten Informationen für das angegebene Modell.

getCustomModelWithResponse

public Response getCustomModelWithResponse(String modelId, Context context)

Rufen Sie detaillierte Informationen zu einer angegebenen benutzerdefinierten Modell-ID ab.

Codebeispiel

String modelId = "{model_id}";
 Response<CustomFormModel> response = formTrainingClient.getCustomModelWithResponse(modelId, Context.NONE);
 System.out.printf("Response Status Code: %d.", response.getStatusCode());
 CustomFormModel customFormModel = response.getValue();
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Field: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

modelId - Der UUID-Zeichenfolgenformatmodellbezeichner.

context - Zusätzlicher Kontext, der während des Dienstaufrufs über die HTTP-Pipeline übergeben wird.

Returns:

Die detaillierten Informationen für das angegebene Modell.

getFormRecognizerClient

public FormRecognizerClient getFormRecognizerClient()

Erstellt ein neues FormRecognizerClient-Objekt. Das neue FormTrainingClient verwendet dieselbe Anforderungsrichtlinienpipeline wie die FormTrainingClient.

Returns:

Ein neues FormRecognizerClient-Objekt.

listCustomModels

public PagedIterable listCustomModels()

Listen Sie Informationen für jedes Modell im Konto der Formularerkennung auf.

Codebeispiel

formTrainingClient.listCustomModels()
     .forEach(customModel ->
         System.out.printf("Model Id: %s, Model status: %s, Training started on: %s, Training completed on: %s.%n",
             customModel.getModelId(),
             customModel.getStatus(),
             customModel.getTrainingStartedOn(),
             customModel.getTrainingCompletedOn())
     );

Returns:

PagedIterable<T> der Informationen zum benutzerdefinierten CustomFormModelInfo Formularmodell.

listCustomModels

public PagedIterable listCustomModels(Context context)

Auflisten von Informationen für jedes Modell im Formularerkennungskonto mit einer HTTP-Antwort und einem angegebenen Context.

Codebeispiel

formTrainingClient.listCustomModels(Context.NONE)
     .forEach(customModel ->
         System.out.printf("Model Id: %s, Model status: %s, Training started on: %s, Training completed on: %s.%n",
             customModel.getModelId(),
             customModel.getStatus(),
             customModel.getTrainingStartedOn(),
             customModel.getTrainingCompletedOn())
     );

Parameters:

context - Zusätzlicher Kontext, der während des Dienstaufrufs über die HTTP-Pipeline übergeben wird.

Returns:

PagedIterable<T> der Informationen zum benutzerdefinierten CustomFormModelInfo Formularmodell.