DocumentModelAdministrationClient Klasse

Referenz

DocumentModelAdministrationClient ist die Formularerkennung Schnittstelle, die zum Erstellen und Verwalten von Modellen verwendet werden soll.

Es bietet Methoden zum Erstellen von Modellen und Klassifizierern sowie Methoden zum Anzeigen und Löschen von Modellen und Klassifizierern, anzeigen von Modell- und Klassifizierervorgängen, zugreifen auf Kontoinformationen, Kopieren von Modellen in eine andere Formularerkennung Ressource und Erstellen eines neuen Modells aus einer Sammlung vorhandener Modelle.

Hinweis

DocumentModelAdministrationClient sollte mit API-Versionen verwendet werden

31.08.2022 und höher. Um API-Versionen <=v2.1 zu verwenden, instanziieren Sie einen FormTrainingClient.

Neu in Version 2022-08-31: Der DocumentModelAdministrationClient und seine Clientmethoden.

Vererbung: azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

Konstruktor

DocumentModelAdministrationClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

Parameter

endpoint: str

Erforderlich

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com

credential: AzureKeyCredential oder TokenCredential

Erforderlich

Anmeldeinformationen, die der Client für die Herstellung einer Verbindung mit Azure benötigt Dies ist eine instance von AzureKeyCredential, wenn Sie einen API-Schlüssel oder tokenanmeldeinformationen aus identityverwenden.

api_version: str oder DocumentAnalysisApiVersion

Die API-Version des Diensts, der für Anforderungen verwendet werden soll. Standardmäßig wird die neueste Dienstversion verwendet. Die Einstellung auf eine ältere Version kann zu einer verringerten Featurekompatibilität führen. Um DIE API-Versionen <=v2.1 zu verwenden, instanziieren Sie einen FormTrainingClient.

Beispiele

Erstellen des DocumentModelAdministrationClient mit einem Endpunkt und einem API-Schlüssel.


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer import DocumentModelAdministrationClient

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, AzureKeyCredential(key)
   )

Erstellen von DocumentModelAdministrationClient mit Tokenanmeldeinformationen.


   """DefaultAzureCredential will use the values from these environment
   variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
   """
   from azure.ai.formrecognizer import DocumentModelAdministrationClient
   from azure.identity import DefaultAzureCredential

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   credential = DefaultAzureCredential()

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, credential
   )

Methoden

begin_build_document_classifier	Erstellen Sie eine Dokumentklassifizierung. Weitere Informationen zum Erstellen und Trainieren eines benutzerdefinierten Klassifizierermodells finden Sie unter https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Neu in Version 2023-07-31: Die begin_build_document_classifier Clientmethode.
begin_build_document_model	Erstellen sie ein benutzerdefiniertes Dokumentmodell. Die Anforderung muss einen blob_container_url Schlüsselwort (keyword) Parameter enthalten, bei dem es sich um einen extern zugänglichen Azure Storage-Blobcontainer-URI handelt (vorzugsweise einen Shared Access Signature-URI). Beachten Sie, dass ein Container-URI (ohne SAS) nur akzeptiert wird, wenn der Container öffentlich ist oder eine verwaltete Identität konfiguriert ist. Weitere Informationen zum Konfigurieren verwalteter Identitäten für die Verwendung mit Formularerkennung finden Sie hier: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modelle werden mit Dokumenten erstellt, die den folgenden Inhaltstyp aufweisen: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" oder "image/heif". Andere Inhaltstypen im Container werden ignoriert. Neu in Version 2023-07-31: Das argument file_list Schlüsselwort (keyword).
begin_compose_document_model	Erstellt ein zusammengesetztes Dokumentmodell aus einer Auflistung vorhandener Modelle. Ein zusammengesetztes Modell ermöglicht den Aufruf mehrerer Modelle mit einer einzelnen Modell-ID. Wenn ein Dokument zur Analyse mit einer zusammengesetzten Modell-ID übermittelt wird, wird zunächst ein Klassifizierungsschritt durchgeführt, um es an das richtige benutzerdefinierte Modell weiterzuleiten.
begin_copy_document_model_to	Kopieren Sie ein in dieser Ressource (die Quelle) gespeichertes Dokumentmodell 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 beim Aufrufen der get_copy_authorization -Methode bereitgestellt werden.
close	Schließen Sie die DocumentModelAdministrationClient Sitzung.
delete_document_classifier	Löschen Sie einen Dokumentklassifizierer. Neu in Version 2023-07-31: Die delete_document_classifier Clientmethode.
delete_document_model	Löschen eines benutzerdefinierten Dokumentmodells.
get_copy_authorization	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 begin_copy_document_model_toübergeben werden.
get_document_analysis_client	Rufen Sie eine instance eines DocumentAnalysisClient aus DocumentModelAdministrationClient ab.
get_document_classifier	Ruft einen Dokumentklassifizierer anhand seiner ID ab. Neu in Version 2023-07-31: Die get_document_classifier Clientmethode.
get_document_model	Abrufen eines Dokumentmodells anhand seiner ID.
get_operation	Rufen Sie einen Vorgang anhand seiner ID ab. Rufen Sie einen Vorgang ab, der der Formularerkennung-Ressource zugeordnet ist. Beachten Sie, dass Vorgangsinformationen nur 24 Stunden lang beibehalten werden. Wenn der Dokumentmodellvorgang erfolgreich war, kann mithilfe der -APIs oder list_document_models auf das get_document_model Modell zugegriffen werden.
get_resource_details	Rufen Sie Informationen zu den Modellen unter der Formularerkennung-Ressource ab.
list_document_classifiers	Listen Sie Informationen für jeden Dokumentklassifizierer auf, einschließlich seiner Klassifizierungs-ID, Beschreibung und des Zeitpunkts seiner Erstellung. Neu in Version 2023-07-31: Die list_document_classifiers Clientmethode.
list_document_models	Listen Sie Informationen für jedes Modell auf, einschließlich der Modell-ID, der Beschreibung und des Zeitpunkts der Erstellung.
list_operations	Listen Sie Informationen für jeden Vorgang auf. Listet alle Vorgänge auf, die der Formularerkennung Ressource zugeordnet sind. Beachten Sie, dass Vorgangsinformationen nur 24 Stunden lang beibehalten werden. Wenn ein Dokumentmodellvorgang erfolgreich war, kann mithilfe der APIs oder list_document_models auf das get_document_model Dokumentmodell zugegriffen werden.
send_request	Führt eine Netzwerkanforderung mithilfe der vorhandenen Pipeline des Clients aus. Die Anforderungs-URL kann relativ zur Basis-URL sein. Sofern nicht anders angegeben, ist die für die Anforderung verwendete Dienst-API-Version mit der des Clients identisch. Das Überschreiben der konfigurierten API-Version des Clients in relativer URL wird auf dem Client mit API-Version 2022-08-31 und höher unterstützt. Überschreiben in absoluter URL, die auf dem Client mit einer beliebigen API-Version unterstützt wird. Diese Methode löst nicht aus, wenn die Antwort ein Fehler ist. Um eine Ausnahme auszulösen, rufen Sie raise_for_status() für das zurückgegebene Antwortobjekt auf. Weitere Informationen zum Senden benutzerdefinierter Anforderungen mit dieser Methode finden Sie unter https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Erstellen Sie eine Dokumentklassifizierung. Weitere Informationen zum Erstellen und Trainieren eines benutzerdefinierten Klassifizierermodells finden Sie unter https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Neu in Version 2023-07-31: Die begin_build_document_classifier Clientmethode.

begin_build_document_classifier(doc_types: Mapping[str, ClassifierDocumentTypeDetails], *, classifier_id: str | None = None, description: str | None = None, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Parameter

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

Erforderlich

Zuordnung der zu klassifizierenden Dokumenttypen.

classifier_id: str

Eindeutiger Dokumentklassifizierername. Wenn nicht angegeben, wird eine Klassifizierer-ID für Sie erstellt.

description: str

Beschreibung des Dokumentklassifizierers.

Gibt zurück

Eine instance eines DocumentModelAdministrationLROPoller. Rufen Sie result() für das Poller-Objekt auf, um eine DocumentClassifierDetailszurückzugeben.

Rückgabetyp

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Ausnahmen

HttpResponseError

Beispiele

Erstellen Sie eine Dokumentklassifizierung.


   import os
   from azure.ai.formrecognizer import (
       DocumentModelAdministrationClient,
       ClassifierDocumentTypeDetails,
       BlobSource,
       BlobFileListSource,
   )
   from azure.core.credentials import AzureKeyCredential

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
   container_sas_url = os.environ["CLASSIFIER_CONTAINER_SAS_URL"]

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )

   poller = document_model_admin_client.begin_build_document_classifier(
       doc_types={
           "IRS-1040-A": ClassifierDocumentTypeDetails(
               source=BlobSource(
                   container_url=container_sas_url, prefix="IRS-1040-A/train"
               )
           ),
           "IRS-1040-D": ClassifierDocumentTypeDetails(
               source=BlobFileListSource(
                   container_url=container_sas_url, file_list="IRS-1040-D.jsonl"
               )
           ),
       },
       description="IRS document classifier",
   )
   result = poller.result()
   print(f"Classifier ID: {result.classifier_id}")
   print(f"API version used to build the classifier model: {result.api_version}")
   print(f"Classifier description: {result.description}")
   print(f"Document classes used for training the model:")
   for doc_type, details in result.doc_types.items():
       print(f"Document type: {doc_type}")
       print(f"Container source: {details.source.container_url}\n")

begin_build_document_model

Erstellen sie ein benutzerdefiniertes Dokumentmodell.

Die Anforderung muss einen blob_container_url Schlüsselwort (keyword) Parameter enthalten, bei dem es sich um einen extern zugänglichen Azure Storage-Blobcontainer-URI handelt (vorzugsweise einen Shared Access Signature-URI). Beachten Sie, dass ein Container-URI (ohne SAS) nur akzeptiert wird, wenn der Container öffentlich ist oder eine verwaltete Identität konfiguriert ist. Weitere Informationen zum Konfigurieren verwalteter Identitäten für die Verwendung mit Formularerkennung finden Sie hier: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modelle werden mit Dokumenten erstellt, die den folgenden Inhaltstyp aufweisen: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" oder "image/heif". Andere Inhaltstypen im Container werden ignoriert.

Neu in Version 2023-07-31: Das argument file_list Schlüsselwort (keyword).

begin_build_document_model(build_mode: str | ModelBuildMode, *, blob_container_url: str, prefix: str | None = None, model_id: str | None = None, description: str | None = None, tags: Mapping[str, str] | None = None, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]

Parameter

build_mode: ModelBuildMode

Erforderlich

Der benutzerdefinierte Modellerstellungsmodus. Mögliche Werte sind: "template", "neural". Weitere Informationen zu Buildmodi finden Sie unter . https://aka.ms/azsdk/formrecognizer/buildmode

blob_container_url: str

Der SAS-URI eines Azure Storage-Blobcontainers. Ein Container-URI (ohne SAS) kann verwendet werden, wenn der Container öffentlich ist oder eine verwaltete Identität konfiguriert ist. Weitere Informationen zum Einrichten eines Trainingsdatasets finden Sie unter . https://aka.ms/azsdk/formrecognizer/buildtrainingset

model_id: str

Eine eindeutige ID für Ihr Modell. Wenn sie nicht angegeben ist, wird eine Modell-ID für Sie erstellt.

description: str

Eine optionale Beschreibung, die dem Modell hinzugefügt werden soll.

prefix: str

Eine Präfixzeichenfolge, bei der die Groß-/Kleinschreibung beachtet wird, um Dokumente im Url-Pfad des Blobcontainers zu filtern. Wenn Sie beispielsweise einen Azure Storage-Blob-URI verwenden, verwenden Sie das Präfix, um Unterordner einzuschränken. das Präfix sollte auf "/" enden, um Fälle zu vermeiden, in denen Dateinamen das gleiche Präfix verwenden.

file_list: str

Pfad zu einer JSONL-Datei im Container, die eine Teilmenge der Dokumente für das Training angibt.

tags: dict[str, str]

Liste der benutzerdefinierten Schlüssel-Wert-Tag-Attribute, die dem Modell zugeordnet sind.

Gibt zurück

Eine instance eines DocumentModelAdministrationLROPoller. Rufen Sie result() für das Poller-Objekt auf, um eine DocumentModelDetailszurückzugeben.

Rückgabetyp

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Ausnahmen

HttpResponseError

Beispiele

Erstellen eines Modells aus Trainingsdateien.


   from azure.ai.formrecognizer import (
       DocumentModelAdministrationClient,
       ModelBuildMode,
   )
   from azure.core.credentials import AzureKeyCredential

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
   container_sas_url = os.environ["CONTAINER_SAS_URL"]

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, AzureKeyCredential(key)
   )
   poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=container_sas_url,
       description="my model description",
   )
   model = poller.result()

   print(f"Model ID: {model.model_id}")
   print(f"Description: {model.description}")
   print(f"Model created on: {model.created_on}")
   print(f"Model expires on: {model.expires_on}")
   print("Doc types the model can recognize:")
   for name, doc_type in model.doc_types.items():
       print(
           f"Doc Type: '{name}' built with '{doc_type.build_mode}' mode which has the following fields:"
       )
       for field_name, field in doc_type.field_schema.items():
           print(
               f"Field: '{field_name}' has type '{field['type']}' and confidence score "
               f"{doc_type.field_confidence[field_name]}"
           )

begin_compose_document_model

Erstellt ein zusammengesetztes Dokumentmodell aus einer Auflistung vorhandener Modelle.

Ein zusammengesetztes Modell ermöglicht den Aufruf mehrerer Modelle mit einer einzelnen Modell-ID. Wenn ein Dokument zur Analyse mit einer zusammengesetzten Modell-ID übermittelt wird, wird zunächst ein Klassifizierungsschritt durchgeführt, um es an das richtige benutzerdefinierte Modell weiterzuleiten.

begin_compose_document_model(component_model_ids: List[str], **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]

Parameter

component_model_ids: list[str]

Erforderlich

Liste der Modell-IDs, die im zusammengesetzten Modell verwendet werden sollen.

model_id: str

Eine eindeutige ID für Ihr zusammengesetztes Modell. Wenn sie nicht angegeben ist, wird eine Modell-ID für Sie erstellt.

description: str

Eine optionale Beschreibung, die dem Modell hinzugefügt werden soll.

tags: dict[str, str]

Liste der benutzerdefinierten Schlüssel-Wert-Tag-Attribute, die dem Modell zugeordnet sind.

Gibt zurück

Eine instance eines DocumentModelAdministrationLROPoller. Rufen Sie result() für das Poller-Objekt auf, um eine DocumentModelDetailszurückzugeben.

Rückgabetyp

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Ausnahmen

HttpResponseError

Beispiele

Erstellen eines zusammengesetzten Modells mit vorhandenen Modellen.


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer import (
       DocumentModelAdministrationClient,
       ModelBuildMode,
   )

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
   po_supplies = os.environ["PURCHASE_ORDER_OFFICE_SUPPLIES_SAS_URL"]
   po_equipment = os.environ["PURCHASE_ORDER_OFFICE_EQUIPMENT_SAS_URL"]
   po_furniture = os.environ["PURCHASE_ORDER_OFFICE_FURNITURE_SAS_URL"]
   po_cleaning_supplies = os.environ["PURCHASE_ORDER_OFFICE_CLEANING_SUPPLIES_SAS_URL"]

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   supplies_poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=po_supplies,
       description="Purchase order-Office supplies",
   )
   equipment_poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=po_equipment,
       description="Purchase order-Office Equipment",
   )
   furniture_poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=po_furniture,
       description="Purchase order-Furniture",
   )
   cleaning_supplies_poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=po_cleaning_supplies,
       description="Purchase order-Cleaning Supplies",
   )
   supplies_model = supplies_poller.result()
   equipment_model = equipment_poller.result()
   furniture_model = furniture_poller.result()
   cleaning_supplies_model = cleaning_supplies_poller.result()

   purchase_order_models = [
       supplies_model.model_id,
       equipment_model.model_id,
       furniture_model.model_id,
       cleaning_supplies_model.model_id,
   ]

   poller = document_model_admin_client.begin_compose_document_model(
       purchase_order_models, description="Office Supplies Composed Model"
   )
   model = poller.result()

   print("Office Supplies Composed Model Info:")
   print(f"Model ID: {model.model_id}")
   print(f"Description: {model.description}")
   print(f"Model created on: {model.created_on}")
   print(f"Model expires on: {model.expires_on}")
   print("Doc types the model can recognize:")
   for name, doc_type in model.doc_types.items():
       print(f"Doc Type: '{name}' which has the following fields:")
       for field_name, field in doc_type.field_schema.items():
           print(
               f"Field: '{field_name}' has type '{field['type']}' and confidence score "
               f"{doc_type.field_confidence[field_name]}"
           )

begin_copy_document_model_to

Kopieren Sie ein in dieser Ressource (die Quelle) gespeichertes Dokumentmodell 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 beim Aufrufen der get_copy_authorization -Methode bereitgestellt werden.

begin_copy_document_model_to(model_id: str, target: TargetAuthorization, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]

Parameter

model_id: str

Erforderlich

Modellbezeichner des Modells, das in die Zielressource kopiert werden soll.

target: <xref:azure.ai.formrecognizer.TargetAuthorization>

Erforderlich

Die Kopierautorisierung, die aus dem Aufruf get_copy_authorizationvon der Zielressource generiert wurde.

Gibt zurück

Eine instance eines DocumentModelAdministrationLROPoller. Rufen Sie result() für das Poller-Objekt auf, um eine DocumentModelDetailszurückzugeben.

Rückgabetyp

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Ausnahmen

HttpResponseError

Beispiele

Kopieren eines Modells aus der Quellressource in die Zielressource


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer import DocumentModelAdministrationClient

   source_endpoint = os.environ["AZURE_FORM_RECOGNIZER_SOURCE_ENDPOINT"]
   source_key = os.environ["AZURE_FORM_RECOGNIZER_SOURCE_KEY"]
   target_endpoint = os.environ["AZURE_FORM_RECOGNIZER_TARGET_ENDPOINT"]
   target_key = os.environ["AZURE_FORM_RECOGNIZER_TARGET_KEY"]
   source_model_id = os.getenv("AZURE_SOURCE_MODEL_ID", custom_model_id)

   target_client = DocumentModelAdministrationClient(
       endpoint=target_endpoint, credential=AzureKeyCredential(target_key)
   )

   target = target_client.get_copy_authorization(
       description="model copied from other resource"
   )

   source_client = DocumentModelAdministrationClient(
       endpoint=source_endpoint, credential=AzureKeyCredential(source_key)
   )
   poller = source_client.begin_copy_document_model_to(
       model_id=source_model_id,
       target=target,  # output from target client's call to get_copy_authorization()
   )
   copied_over_model = poller.result()

   print(f"Model ID: {copied_over_model.model_id}")
   print(f"Description: {copied_over_model.description}")
   print(f"Model created on: {copied_over_model.created_on}")
   print(f"Model expires on: {copied_over_model.expires_on}")
   print("Doc types the model can recognize:")
   for name, doc_type in copied_over_model.doc_types.items():
       print(f"Doc Type: '{name}' which has the following fields:")
       for field_name, field in doc_type.field_schema.items():
           print(
               f"Field: '{field_name}' has type '{field['type']}' and confidence score "
               f"{doc_type.field_confidence[field_name]}"
           )

close

Schließen Sie die DocumentModelAdministrationClient Sitzung.

close() -> None

Ausnahmen

HttpResponseError

delete_document_classifier

Löschen Sie einen Dokumentklassifizierer.

Neu in Version 2023-07-31: Die delete_document_classifier Clientmethode.

delete_document_classifier(classifier_id: str, **kwargs: Any) -> None

Parameter

classifier_id: str

Erforderlich

Klassifiziererbezeichner.

Gibt zurück

Keine

Rückgabetyp

None

Ausnahmen

HttpResponseError

ResourceNotFoundError

Beispiele

Löschen Sie einen Klassifizierer.


   document_model_admin_client.delete_document_classifier(
       classifier_id=my_classifier.classifier_id
   )

   try:
       document_model_admin_client.get_document_classifier(
           classifier_id=my_classifier.classifier_id
       )
   except ResourceNotFoundError:
       print(f"Successfully deleted classifier with ID {my_classifier.classifier_id}")

delete_document_model

Löschen eines benutzerdefinierten Dokumentmodells.

delete_document_model(model_id: str, **kwargs: Any) -> None

Parameter

model_id: str

Erforderlich

Modellbezeichner.

Gibt zurück

Keine

Rückgabetyp

None

Ausnahmen

HttpResponseError

ResourceNotFoundError

Beispiele

Löschen sie ein Modell.


   document_model_admin_client.delete_document_model(model_id=my_model.model_id)

   try:
       document_model_admin_client.get_document_model(model_id=my_model.model_id)
   except ResourceNotFoundError:
       print(f"Successfully deleted model with ID {my_model.model_id}")

get_copy_authorization

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 begin_copy_document_model_toübergeben werden.

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parameter

model_id: str

Eine eindeutige ID für Ihr kopiertes Modell. Wenn sie nicht angegeben ist, wird eine Modell-ID für Sie erstellt.

description: str

Eine optionale Beschreibung, die dem Modell hinzugefügt werden soll.

tags: dict[str, str]

Liste der benutzerdefinierten Schlüssel-Wert-Tag-Attribute, die dem Modell zugeordnet sind.

Gibt zurück

Ein Wörterbuch mit Werten, die für die Kopierautorisierung erforderlich sind.

Rückgabetyp

<xref:azure.ai.formrecognizer.TargetAuthorization>

Ausnahmen

HttpResponseError

get_document_analysis_client

Rufen Sie eine instance eines DocumentAnalysisClient aus DocumentModelAdministrationClient ab.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Gibt zurück

Ein DocumentAnalysisClient

Rückgabetyp

DocumentAnalysisClient

Ausnahmen

HttpResponseError

get_document_classifier

Ruft einen Dokumentklassifizierer anhand seiner ID ab.

Neu in Version 2023-07-31: Die get_document_classifier Clientmethode.

get_document_classifier(classifier_id: str, **kwargs: Any) -> DocumentClassifierDetails

Parameter

classifier_id: str

Erforderlich

Klassifiziererbezeichner.

Gibt zurück

DocumentClassifierDetails

Rückgabetyp

DocumentClassifierDetails

Ausnahmen

HttpResponseError

ResourceNotFoundError

Beispiele

Ruft einen Klassifizierer anhand seiner ID ab.


   my_classifier = document_model_admin_client.get_document_classifier(
       classifier_id=classifier_model.classifier_id
   )
   print(f"\nClassifier ID: {my_classifier.classifier_id}")
   print(f"Description: {my_classifier.description}")
   print(f"Classifier created on: {my_classifier.created_on}")

get_document_model

Abrufen eines Dokumentmodells anhand seiner ID.

get_document_model(model_id: str, **kwargs: Any) -> DocumentModelDetails

Parameter

model_id: str

Erforderlich

Modellbezeichner.

Gibt zurück

DocumentModelDetails

Rückgabetyp

DocumentModelDetails

Ausnahmen

HttpResponseError

ResourceNotFoundError

Beispiele

Rufen Sie ein Modell anhand seiner ID ab.


   my_model = document_model_admin_client.get_document_model(model_id=model.model_id)
   print(f"\nModel ID: {my_model.model_id}")
   print(f"Description: {my_model.description}")
   print(f"Model created on: {my_model.created_on}")
   print(f"Model expires on: {my_model.expires_on}")

get_operation

Rufen Sie einen Vorgang anhand seiner ID ab.

Rufen Sie einen Vorgang ab, der der Formularerkennung-Ressource zugeordnet ist. Beachten Sie, dass Vorgangsinformationen nur 24 Stunden lang beibehalten werden. Wenn der Dokumentmodellvorgang erfolgreich war, kann mithilfe der -APIs oder list_document_models auf das get_document_model Modell zugegriffen werden.

get_operation(operation_id: str, **kwargs: Any) -> OperationDetails

Parameter

operation_id: str

Erforderlich

Vorgangs-ID.

Gibt zurück

OperationDetails

Rückgabetyp

OperationDetails

Ausnahmen

HttpResponseError

Beispiele

Abrufen eines Dokumentmodellvorgangs anhand seiner ID.


   # Get an operation by ID
   if operations:
       print(f"\nGetting operation info by ID: {operations[0].operation_id}")
       operation_info = document_model_admin_client.get_operation(
           operations[0].operation_id
       )
       if operation_info.status == "succeeded":
           print(f"My {operation_info.kind} operation is completed.")
           result = operation_info.result
           if result is not None:
               if operation_info.kind == "documentClassifierBuild":
                   print(f"Classifier ID: {result.classifier_id}")
               else:
                   print(f"Model ID: {result.model_id}")
       elif operation_info.status == "failed":
           print(f"My {operation_info.kind} operation failed.")
           error = operation_info.error
           if error is not None:
               print(f"{error.code}: {error.message}")
       else:
           print(f"My operation status is {operation_info.status}")
   else:
       print("No operations found.")

get_resource_details

Rufen Sie Informationen zu den Modellen unter der Formularerkennung-Ressource ab.

get_resource_details(**kwargs: Any) -> ResourceDetails

Gibt zurück

Zusammenfassung der benutzerdefinierten Modelle unter der Ressource – Modellanzahl und -limit.

Rückgabetyp

ResourceDetails

Ausnahmen

HttpResponseError

Beispiele

Rufen Sie Modellanzahlen und -grenzwerte unter der Formularerkennung-Ressource ab.


   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )

   account_details = document_model_admin_client.get_resource_details()
   print(
       f"Our resource has {account_details.custom_document_models.count} custom models, "
       f"and we can have at most {account_details.custom_document_models.limit} custom models"
   )
   neural_models = account_details.neural_document_model_quota
   print(
       f"The quota limit for custom neural document models is {neural_models.quota} and the resource has"
       f"used {neural_models.used}. The resource quota will reset on {neural_models.quota_resets_on}"
   )

list_document_classifiers

Listen Sie Informationen für jeden Dokumentklassifizierer auf, einschließlich seiner Klassifizierungs-ID, Beschreibung und des Zeitpunkts seiner Erstellung.

Neu in Version 2023-07-31: Die list_document_classifiers Clientmethode.

list_document_classifiers(**kwargs: Any) -> ItemPaged[DocumentClassifierDetails]

Gibt zurück

Pageable von DocumentClassifierDetails.

Rückgabetyp

ItemPaged[DocumentClassifierDetails]

Ausnahmen

HttpResponseError

Beispiele

Listet alle Klassifizierer auf, die erfolgreich unter der Formularerkennung-Ressource erstellt wurden.


   classifiers = document_model_admin_client.list_document_classifiers()

   print("We have the following 'ready' models with IDs and descriptions:")
   for classifier in classifiers:
       print(f"{classifier.classifier_id} | {classifier.description}")

list_document_models

Listen Sie Informationen für jedes Modell auf, einschließlich der Modell-ID, der Beschreibung und des Zeitpunkts der Erstellung.

list_document_models(**kwargs: Any) -> ItemPaged[DocumentModelSummary]

Gibt zurück

Pageable von DocumentModelSummary.

Rückgabetyp

ItemPaged[DocumentModelSummary]

Ausnahmen

HttpResponseError

Beispiele

Listet alle Modelle auf, die erfolgreich unter der Formularerkennung-Ressource erstellt wurden.


   models = document_model_admin_client.list_document_models()

   print("We have the following 'ready' models with IDs and descriptions:")
   for model in models:
       print(f"{model.model_id} | {model.description}")

list_operations

Listen Sie Informationen für jeden Vorgang auf.

Listet alle Vorgänge auf, die der Formularerkennung Ressource zugeordnet sind. Beachten Sie, dass Vorgangsinformationen nur 24 Stunden lang beibehalten werden. Wenn ein Dokumentmodellvorgang erfolgreich war, kann mithilfe der APIs oder list_document_models auf das get_document_model Dokumentmodell zugegriffen werden.

list_operations(**kwargs: Any) -> ItemPaged[OperationSummary]

Gibt zurück

Eine Seite von OperationSummary.

Rückgabetyp

ItemPaged[OperationSummary]

Ausnahmen

HttpResponseError

Beispiele

Listet alle Dokumentmodellvorgänge in den letzten 24 Stunden auf.


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer import DocumentModelAdministrationClient

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )

   operations = list(document_model_admin_client.list_operations())

   print("The following document model operations exist under my resource:")
   for operation in operations:
       print(f"\nOperation ID: {operation.operation_id}")
       print(f"Operation kind: {operation.kind}")
       print(f"Operation status: {operation.status}")
       print(f"Operation percent completed: {operation.percent_completed}")
       print(f"Operation created on: {operation.created_on}")
       print(f"Operation last updated on: {operation.last_updated_on}")
       print(
           f"Resource location of successful operation: {operation.resource_location}"
       )

send_request

Führt eine Netzwerkanforderung mithilfe der vorhandenen Pipeline des Clients aus.

Die Anforderungs-URL kann relativ zur Basis-URL sein. Sofern nicht anders angegeben, ist die für die Anforderung verwendete Dienst-API-Version mit der des Clients identisch. Das Überschreiben der konfigurierten API-Version des Clients in relativer URL wird auf dem Client mit API-Version 2022-08-31 und höher unterstützt. Überschreiben in absoluter URL, die auf dem Client mit einer beliebigen API-Version unterstützt wird. Diese Methode löst nicht aus, wenn die Antwort ein Fehler ist. Um eine Ausnahme auszulösen, rufen Sie raise_for_status() für das zurückgegebene Antwortobjekt auf. Weitere Informationen zum Senden benutzerdefinierter Anforderungen mit dieser Methode finden Sie unter https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Parameter

request: HttpRequest

Erforderlich

Die Netzwerkanforderung, die Sie stellen möchten.

stream: bool

Gibt an, ob die Antwortnutzlast gestreamt wird. Der Standardwert lautet „False“.

Gibt zurück

Die Antwort Ihres Netzwerkaufrufs. Führt keine Fehlerbehandlung für Ihre Antwort durch.

Rückgabetyp

HttpResponse

Ausnahmen

HttpResponseError