DocumentModelAdministrationClient Klas

Referentie

DocumentModelAdministrationClient is de Form Recognizer interface die kan worden gebruikt voor het bouwen en beheren van modellen.

Het biedt methoden voor het bouwen van modellen en classificaties, evenals methoden voor het weergeven en verwijderen van modellen en classificaties, het bekijken van model- en classificatiebewerkingen, het openen van accountgegevens, het kopiëren van modellen naar een andere Form Recognizer resource en het opstellen van een nieuw model uit een verzameling bestaande modellen.

Notitie

DocumentModelAdministrationClient moet worden gebruikt met API-versies

2022-08-31 en hoger. Als u API-versies <=v2.1 wilt gebruiken, maakt u een FormTrainingClient.

Nieuw in versie 2022-08-31: De DocumentModelAdministrationClient en de bijbehorende clientmethoden.

Overname: azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

Constructor

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

Parameters

endpoint: str

Vereist

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential of TokenCredential

Vereist

Referenties die nodig zijn voor de client om verbinding te maken met Azure. Dit is een exemplaar van AzureKeyCredential als u een API-sleutel of een tokenreferentie van identitygebruikt.

api_version: str of DocumentAnalysisApiVersion

De API-versie van de service die moet worden gebruikt voor aanvragen. De standaardinstelling is de nieuwste serviceversie. Instellen op een oudere versie kan leiden tot verminderde compatibiliteit van functies. Als u API-versies <=v2.1 wilt gebruiken, moet u een FormTrainingClient instantiëren.

Voorbeelden

DocumentModelAdministrationClient maken met een eindpunt en API-sleutel.


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

DocumentModelAdministrationClient maken met een tokenreferentie.


   """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	Bouw een documentclassificatie. Zie voor meer informatie over het bouwen en trainen van een aangepast classificatiemodel https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Nieuw in versie 31-07-2023: De begin_build_document_classifier-clientmethode .
begin_build_document_model	Een aangepast documentmodel bouwen. De aanvraag moet een blob_container_url trefwoordparameter bevatten die een extern toegankelijke Azure Storage Blob-container-URI is (bij voorkeur een Shared Access Signature-URI). Houd er rekening mee dat een container-URI (zonder SAS) alleen wordt geaccepteerd wanneer de container openbaar is of een beheerde identiteit heeft geconfigureerd. Zie hier meer informatie over het configureren van beheerde identiteiten voor gebruik met Form Recognizer: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modellen worden gemaakt met documenten van het volgende inhoudstype: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp' of 'image/heif'. Andere typen inhoud in de container worden genegeerd. Nieuw in versie 31-07-2023: het argument file_list trefwoord.
begin_compose_document_model	Hiermee maakt u een samengesteld documentmodel op basis van een verzameling bestaande modellen. Met een samengesteld model kunnen meerdere modellen worden aangeroepen met één model-id. Wanneer een document wordt verzonden om te worden geanalyseerd met een samengestelde model-id, wordt eerst een classificatiestap uitgevoerd om het naar het juiste aangepaste model te routeren.
begin_copy_document_model_to	Kopieer een documentmodel dat is opgeslagen in deze resource (de bron) naar de door de gebruiker opgegeven doel Form Recognizer resource. Dit moet worden aangeroepen met de bron Form Recognizer resource (met het model dat is bedoeld om te worden gekopieerd). De doelparameter moet worden opgegeven vanuit de uitvoer van de doelresource van het aanroepen van de get_copy_authorization methode.
close	Sluit de DocumentModelAdministrationClient sessie.
delete_document_classifier	Een documentclassificatie verwijderen. Nieuw in versie 2023-07-31: De delete_document_classifier-clientmethode .
delete_document_model	Een aangepast documentmodel verwijderen.
get_copy_authorization	Autorisatie genereren voor het kopiëren van een aangepast model naar de doelresource Form Recognizer. Dit moet worden aangeroepen door de doelresource (waarnaar het model wordt gekopieerd) en de uitvoer kan worden doorgegeven als de doelparameter in begin_copy_document_model_to.
get_document_analysis_client	Haal een exemplaar van een DocumentAnalysisClient op uit DocumentModelAdministrationClient.
get_document_classifier	Een documentclassificatie ophalen op basis van de bijbehorende id. Nieuw in versie 2023-07-31: De clientmethode get_document_classifier .
get_document_model	Een documentmodel ophalen op basis van de id.
get_operation	Een bewerking ophalen op basis van de id. Haal een bewerking op die is gekoppeld aan de Form Recognizer-resource. Houd er rekening mee dat bewerkingsgegevens slechts 24 uur behouden blijven. Als de documentmodelbewerking is geslaagd, kan het model worden geopend met behulp van de get_document_model API's of list_document_models .
get_resource_details	Krijg informatie over de modellen onder de Form Recognizer resource.
list_document_classifiers	Geef informatie weer voor elke documentclassificatie, inclusief de classificatie-id, beschrijving en wanneer deze is gemaakt. Nieuw in versie 2023-07-31: De list_document_classifiers-clientmethode .
list_document_models	Geef informatie weer voor elk model, inclusief de model-id, beschrijving en wanneer het is gemaakt.
list_operations	Geef informatie weer voor elke bewerking. Een lijst met alle bewerkingen die zijn gekoppeld aan de Form Recognizer-resource. Houd er rekening mee dat bewerkingsgegevens slechts 24 uur behouden blijven. Als een documentmodelbewerking is geslaagd, kan het documentmodel worden geopend met behulp van de get_document_model API's of list_document_models .
send_request	Hiermee wordt een netwerkaanvraag uitgevoerd met behulp van de bestaande pijplijn van de client. De aanvraag-URL kan relatief zijn ten opzichte van de basis-URL. De service-API-versie die voor de aanvraag wordt gebruikt, is dezelfde als die van de client, tenzij anders opgegeven. Het overschrijven van de geconfigureerde API-versie van de client in relatieve URL wordt ondersteund op de client met API-versie 2022-08-31 en hoger. Overschrijven in absolute URL die wordt ondersteund op client met elke API-versie. Deze methode wordt niet gegenereerd als het antwoord een fout is; als u een uitzondering wilt maken, roept u raise_for_status() aan op het geretourneerde antwoordobject. Zie voor meer informatie over het verzenden van aangepaste aanvragen met deze methode https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Bouw een documentclassificatie. Zie voor meer informatie over het bouwen en trainen van een aangepast classificatiemodel https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Nieuw in versie 31-07-2023: De 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]

Parameters

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

Vereist

Toewijzing van documenttypen voor classificatie.

classifier_id: str

Unieke naam voor documentclassificatie. Als u dit niet opgeeft, wordt er een classificatie-id voor u gemaakt.

description: str

Beschrijving van documentclassificatie.

Retouren

Een exemplaar van een DocumentModelAdministrationLROPoller. Roep result() aan op het poller-object om een DocumentClassifierDetailste retourneren.

Retourtype

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Uitzonderingen

HttpResponseError

Voorbeelden

Bouw een documentclassificatie.


   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

Een aangepast documentmodel bouwen.

De aanvraag moet een blob_container_url trefwoordparameter bevatten die een extern toegankelijke Azure Storage Blob-container-URI is (bij voorkeur een Shared Access Signature-URI). Houd er rekening mee dat een container-URI (zonder SAS) alleen wordt geaccepteerd wanneer de container openbaar is of een beheerde identiteit heeft geconfigureerd. Zie hier meer informatie over het configureren van beheerde identiteiten voor gebruik met Form Recognizer: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modellen worden gemaakt met documenten van het volgende inhoudstype: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp' of 'image/heif'. Andere typen inhoud in de container worden genegeerd.

Nieuw in versie 31-07-2023: het argument file_list trefwoord.

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]

Parameters

build_mode: ModelBuildMode

Vereist

De modus voor het bouwen van aangepaste modellen. Mogelijke waarden zijn: 'template', 'neural'. Zie voor meer informatie over buildmodi: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url: str

De SAS-URI van een Azure Storage-blobcontainer. Een container-URI (zonder SAS) kan worden gebruikt als de container openbaar is of als er een beheerde identiteit is geconfigureerd. Zie voor meer informatie over het instellen van een set trainingsgegevens: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id: str

Een unieke id voor uw model. Als u dit niet opgeeft, wordt er een model-id voor u gemaakt.

description: str

Een optionele beschrijving om aan het model toe te voegen.

prefix: str

Een hoofdlettergevoelige tekenreeks voorvoegsel voor het filteren van documenten in het URL-pad van de blobcontainer. Als u bijvoorbeeld een Azure Storage Blob-URI gebruikt, gebruikt u het voorvoegsel om submappen te beperken. het voorvoegsel moet eindigen op '/' om te voorkomen dat bestandsnamen hetzelfde voorvoegsel delen.

file_list: str

Pad naar een JSONL-bestand in de container waarin een subset van documenten voor training wordt opgegeven.

tags: dict[str, str]

Lijst met door de gebruiker gedefinieerde sleutel-waardetagkenmerken die zijn gekoppeld aan het model.

Retouren

Een exemplaar van een DocumentModelAdministrationLROPoller. Roep result() aan op het poller-object om een DocumentModelDetailste retourneren.

Retourtype

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Uitzonderingen

HttpResponseError

Voorbeelden

Een model bouwen op basis van trainingsbestanden.


   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

Hiermee maakt u een samengesteld documentmodel op basis van een verzameling bestaande modellen.

Met een samengesteld model kunnen meerdere modellen worden aangeroepen met één model-id. Wanneer een document wordt verzonden om te worden geanalyseerd met een samengestelde model-id, wordt eerst een classificatiestap uitgevoerd om het naar het juiste aangepaste model te routeren.

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

Parameters

component_model_ids: list[str]

Vereist

Lijst met model-id's die moeten worden gebruikt in het samengestelde model.

model_id: str

Een unieke id voor uw samengestelde model. Als u dit niet opgeeft, wordt er een model-id voor u gemaakt.

description: str

Een optionele beschrijving om aan het model toe te voegen.

tags: dict[str, str]

Lijst met door de gebruiker gedefinieerde sleutel-waardetagkenmerken die zijn gekoppeld aan het model.

Retouren

Een exemplaar van een DocumentModelAdministrationLROPoller. Roep result() aan op het poller-object om een DocumentModelDetailste retourneren.

Retourtype

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Uitzonderingen

HttpResponseError

Voorbeelden

Een samengesteld model maken met bestaande 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

Kopieer een documentmodel dat is opgeslagen in deze resource (de bron) naar de door de gebruiker opgegeven doel Form Recognizer resource.

Dit moet worden aangeroepen met de bron Form Recognizer resource (met het model dat is bedoeld om te worden gekopieerd). De doelparameter moet worden opgegeven vanuit de uitvoer van de doelresource van het aanroepen van de get_copy_authorization methode.

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

Parameters

model_id: str

Vereist

Model-id van het model dat moet worden gekopieerd naar de doelresource.

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

Vereist

De kopieerautorisatie die is gegenereerd op basis van de aanroep van de doelresource naar get_copy_authorization.

Retouren

Een exemplaar van een DocumentModelAdministrationLROPoller. Roep result() aan op het poller-object om een DocumentModelDetailste retourneren.

Retourtype

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Uitzonderingen

HttpResponseError

Voorbeelden

Een model kopiëren van de bronresource naar de doelresource


   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

Sluit de DocumentModelAdministrationClient sessie.

close() -> None

Uitzonderingen

HttpResponseError

delete_document_classifier

Een documentclassificatie verwijderen.

Nieuw in versie 2023-07-31: De delete_document_classifier-clientmethode .

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

Parameters

classifier_id: str

Vereist

Classificatie-id.

Retouren

Geen

Retourtype

None

Uitzonderingen

HttpResponseError

ResourceNotFoundError

Voorbeelden

Een classificatie verwijderen.


   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

Een aangepast documentmodel verwijderen.

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

Parameters

model_id: str

Vereist

Model-id.

Retouren

Geen

Retourtype

None

Uitzonderingen

HttpResponseError

ResourceNotFoundError

Voorbeelden

Een model verwijderen.


   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

Autorisatie genereren voor het kopiëren van een aangepast model naar de doelresource Form Recognizer.

Dit moet worden aangeroepen door de doelresource (waarnaar het model wordt gekopieerd) en de uitvoer kan worden doorgegeven als de doelparameter in begin_copy_document_model_to.

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parameters

model_id: str

Een unieke id voor uw gekopieerde model. Als u dit niet opgeeft, wordt er een model-id voor u gemaakt.

description: str

Een optionele beschrijving om aan het model toe te voegen.

tags: dict[str, str]

Lijst met door de gebruiker gedefinieerde sleutel-waardetagkenmerken die zijn gekoppeld aan het model.

Retouren

Een woordenlijst met waarden die nodig zijn voor de kopieerautorisatie.

Retourtype

<xref:azure.ai.formrecognizer.TargetAuthorization>

Uitzonderingen

HttpResponseError

get_document_analysis_client

Haal een exemplaar van een DocumentAnalysisClient op uit DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Retouren

Een DocumentAnalysisClient

Retourtype

DocumentAnalysisClient

Uitzonderingen

HttpResponseError

get_document_classifier

Een documentclassificatie ophalen op basis van de bijbehorende id.

Nieuw in versie 2023-07-31: De clientmethode get_document_classifier .

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

Parameters

classifier_id: str

Vereist

Classificatie-id.

Retouren

DocumentClassifierDetails

Retourtype

DocumentClassifierDetails

Uitzonderingen

HttpResponseError

ResourceNotFoundError

Voorbeelden

Haal een classificatie op op basis van de id.


   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

Een documentmodel ophalen op basis van de id.

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

Parameters

model_id: str

Vereist

Model-id.

Retouren

DocumentModelDetails

Retourtype

DocumentModelDetails

Uitzonderingen

HttpResponseError

ResourceNotFoundError

Voorbeelden

Een model ophalen op basis van de id.


   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

Een bewerking ophalen op basis van de id.

Haal een bewerking op die is gekoppeld aan de Form Recognizer-resource. Houd er rekening mee dat bewerkingsgegevens slechts 24 uur behouden blijven. Als de documentmodelbewerking is geslaagd, kan het model worden geopend met behulp van de get_document_model API's of list_document_models .

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

Parameters

operation_id: str

Vereist

De bewerkings-id.

Retouren

OperationDetails

Retourtype

OperationDetails

Uitzonderingen

HttpResponseError

Voorbeelden

Een documentmodelbewerking ophalen op basis van de 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

Krijg informatie over de modellen onder de Form Recognizer resource.

get_resource_details(**kwargs: Any) -> ResourceDetails

Retouren

Samenvatting van aangepaste modellen onder de resource : aantal en limieten voor modellen.

Retourtype

ResourceDetails

Uitzonderingen

HttpResponseError

Voorbeelden

Haal het aantal en de limieten van het model op onder de Form Recognizer resource.


   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

Geef informatie weer voor elke documentclassificatie, inclusief de classificatie-id, beschrijving en wanneer deze is gemaakt.

Nieuw in versie 2023-07-31: De list_document_classifiers-clientmethode .

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

Retouren

Wisselbaar van DocumentClassifierDetails.

Retourtype

ItemPaged[DocumentClassifierDetails]

Uitzonderingen

HttpResponseError

Voorbeelden

Maak een lijst met alle classificaties die zijn gemaakt onder de Form Recognizer resource.


   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

Geef informatie weer voor elk model, inclusief de model-id, beschrijving en wanneer het is gemaakt.

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

Retouren

Pageable van DocumentModelSummary.

Retourtype

ItemPaged[DocumentModelSummary]

Uitzonderingen

HttpResponseError

Voorbeelden

Maak een lijst met alle modellen die zijn gemaakt onder de Form Recognizer resource.


   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

Geef informatie weer voor elke bewerking.

Een lijst met alle bewerkingen die zijn gekoppeld aan de Form Recognizer-resource. Houd er rekening mee dat bewerkingsgegevens slechts 24 uur behouden blijven. Als een documentmodelbewerking is geslaagd, kan het documentmodel worden geopend met behulp van de get_document_model API's of list_document_models .

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

Retouren

Een wisselbaar van OperationSummary.

Retourtype

ItemPaged[OperationSummary]

Uitzonderingen

HttpResponseError

Voorbeelden

Alle documentmodelbewerkingen in de afgelopen 24 uur weergeven.


   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

Hiermee wordt een netwerkaanvraag uitgevoerd met behulp van de bestaande pijplijn van de client.

De aanvraag-URL kan relatief zijn ten opzichte van de basis-URL. De service-API-versie die voor de aanvraag wordt gebruikt, is dezelfde als die van de client, tenzij anders opgegeven. Het overschrijven van de geconfigureerde API-versie van de client in relatieve URL wordt ondersteund op de client met API-versie 2022-08-31 en hoger. Overschrijven in absolute URL die wordt ondersteund op client met elke API-versie. Deze methode wordt niet gegenereerd als het antwoord een fout is; als u een uitzondering wilt maken, roept u raise_for_status() aan op het geretourneerde antwoordobject. Zie voor meer informatie over het verzenden van aangepaste aanvragen met deze methode https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parameters

request: HttpRequest

Vereist

De netwerkaanvraag die u wilt maken.

stream: bool

Of de nettolading van het antwoord wordt gestreamd. Standaard ingesteld op False.

Retouren

Het antwoord van uw netwerkoproep. Er wordt geen foutafhandeling uitgevoerd voor uw antwoord.

Retourtype

HttpResponse

Uitzonderingen

HttpResponseError

Delen via

DocumentModelAdministrationClient Klas

Constructor

Parameters

Voorbeelden

Methoden

begin_build_document_classifier

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

begin_build_document_model

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

begin_compose_document_model

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

begin_copy_document_model_to

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

close

Uitzonderingen

delete_document_classifier

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

delete_document_model

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

get_copy_authorization

Parameters

Retouren

Retourtype

Uitzonderingen

get_document_analysis_client

Retouren

Retourtype

Uitzonderingen

get_document_classifier

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

get_document_model

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

get_operation

Parameters

Retouren

Retourtype

Uitzonderingen

Voorbeelden

get_resource_details

Retouren

Retourtype

Uitzonderingen

Voorbeelden

list_document_classifiers

Retouren

Retourtype

Uitzonderingen