DocumentModelAdministrationClient Classe

Compilare un classificatore di documenti. Per altre informazioni su come compilare ed eseguire il training di un modello di classificatore personalizzato, vedere https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Novità della versione 2023-07-31: metodo client begin_build_document_classifier .

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

Parametri

Restituisce

Istanza di documentModelAdministrationLROPoller. Chiamare result() sull'oggetto poller per restituire un oggetto DocumentClassifierDetails.

Tipo restituito

Eccezioni

Esempio

Compilare un classificatore di documenti.

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

Creare un modello di documento personalizzato.

La richiesta deve includere un parametro di parola chiave blob_container_url che è un URI del contenitore BLOB di archiviazione di Azure accessibile esternamente (preferibilmente un URI della firma di accesso condiviso). Si noti che un URI del contenitore (senza firma di accesso condiviso) viene accettato solo quando il contenitore è pubblico o ha un'identità gestita configurata, vedere altre informazioni sulla configurazione delle identità gestite per l'uso con Riconoscimento modulo qui: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. I modelli vengono compilati usando documenti con il tipo di contenuto seguente: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp' o 'image/heif'. Altri tipi di contenuto nel contenitore vengono ignorati.

Novità della versione 2023-07-31: argomento della parola chiave file_list .

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]

Parametri

Restituisce

Istanza di documentModelAdministrationLROPoller. Chiamare result() sull'oggetto poller per restituire un oggetto DocumentModelDetails.

Tipo restituito

Eccezioni

Esempio

Creazione di un modello da file di training.

   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]}"
           )

Crea un modello di documento composto da una raccolta di modelli esistenti.

Un modello composto consente di chiamare più modelli con un singolo ID modello. Quando viene inviato un documento da analizzare con un ID modello composto, viene prima eseguito un passaggio di classificazione per instradarlo al modello personalizzato corretto.

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

Parametri

Restituisce

Istanza di documentModelAdministrationLROPoller. Chiamare result() sull'oggetto poller per restituire un oggetto DocumentModelDetails.

Tipo restituito

Eccezioni

Esempio

Creazione di un modello composto con modelli esistenti.

   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]}"
           )

Copiare un modello di documento archiviato in questa risorsa (l'origine) nella destinazione specificata dall'utente Riconoscimento modulo risorsa.

Questa operazione deve essere chiamata con la risorsa di origine Riconoscimento modulo (con il modello che deve essere copiato). Il parametro di destinazione deve essere fornito dall'output della risorsa di destinazione dalla chiamata al get_copy_authorization metodo .

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

Parametri

Restituisce

Istanza di documentModelAdministrationLROPoller. Chiamare result() sull'oggetto poller per restituire un oggetto DocumentModelDetails.

Tipo restituito

Eccezioni

Esempio

Copiare un modello dalla risorsa di origine alla risorsa di destinazione

   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]}"
           )

Chiudere la DocumentModelAdministrationClient sessione.

close() -> None

Eccezioni

Eliminare un classificatore di documenti.

Novità della versione 2023-07-31: metodo client delete_document_classifier .

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

Parametri

Restituisce

Nessuno

Tipo restituito

Eccezioni

Esempio

Eliminare un classificatore.

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

Eliminare un modello di documento personalizzato.

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

Parametri

Restituisce

Nessuno

Tipo restituito

Eccezioni

Esempio

Eliminare un modello.

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

Generare l'autorizzazione per copiare un modello personalizzato nella risorsa di Riconoscimento modulo di destinazione.

Questa operazione deve essere chiamata dalla risorsa di destinazione (in cui il modello verrà copiato) e l'output può essere passato come parametro di destinazione in begin_copy_document_model_to.

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parametri

Restituisce

Dizionario con valori necessari per l'autorizzazione di copia.

Tipo restituito

Eccezioni

Ottenere un'istanza di documentAnalysisClient da DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Restituisce

A DocumentAnalysisClient

Tipo restituito

Eccezioni

Ottenere un classificatore di documenti in base al relativo ID.

Novità della versione 2023-07-31: metodo client get_document_classifier .

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

Parametri

Restituisce

DocumentClassifierDetails

Tipo restituito

Eccezioni

Esempio

Ottenere un classificatore in base al relativo 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}")

Ottenere un modello di documento in base al relativo ID.

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

Parametri

Restituisce

DocumentModelDetails

Tipo restituito

Eccezioni

Esempio

Ottenere un modello in base al relativo 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}")

Ottenere un'operazione in base al relativo ID.

Ottiene un'operazione associata alla risorsa Riconoscimento modulo. Si noti che le informazioni sull'operazione vengono mantenute solo per 24 ore. Se l'operazione del modello di documento ha avuto esito positivo, è possibile accedere al modello usando le get_document_model API o list_document_models .

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

Parametri

Restituisce

OperationDetails

Tipo restituito

Eccezioni

Esempio

Ottenere un'operazione del modello di documento in base al relativo 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.")

Ottenere informazioni sui modelli nella risorsa Riconoscimento modulo.

get_resource_details(**kwargs: Any) -> ResourceDetails

Restituisce

Riepilogo dei modelli personalizzati nella risorsa - Numero e limite dei modelli.

Tipo restituito

Eccezioni

Esempio

Ottenere i conteggi e i limiti del modello nella risorsa Riconoscimento modulo.

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

Elencare le informazioni per ogni classificatore di documenti, inclusi l'ID classificatore, la descrizione e la data di creazione.

Novità della versione 2023-07-31: metodo client list_document_classifiers .

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

Restituisce

Paginabile di DocumentClassifierDetails.

Tipo restituito

Eccezioni

Esempio

Elencare tutti i classificatori compilati correttamente nella risorsa Riconoscimento modulo.

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

Elencare le informazioni per ogni modello, inclusi l'ID modello, la descrizione e la data di creazione.

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

Restituisce

Paginabile di DocumentModelSummary.

Tipo restituito

Eccezioni

Esempio

Elencare tutti i modelli compilati correttamente nella risorsa Riconoscimento modulo.

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

Elencare le informazioni per ogni operazione.

Elenca tutte le operazioni associate alla risorsa Riconoscimento modulo. Si noti che le informazioni sull'operazione vengono mantenute solo per 24 ore. Se un'operazione del modello di documento ha avuto esito positivo, è possibile accedere al modello di documento usando le get_document_model API o list_document_models .

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

Restituisce

Oggetto pageable di OperationSummary.

Tipo restituito

Eccezioni

Esempio

Elencare tutte le operazioni del modello di documento nelle ultime 24 ore.

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

Esegue una richiesta di rete usando la pipeline esistente del client.

L'URL della richiesta può essere relativo all'URL di base. La versione dell'API del servizio usata per la richiesta è uguale a quella del client, se non diversamente specificato. L'override della versione dell'API configurata del client nell'URL relativo è supportata nel client con l'API versione 2022-08-31 e successive. Override dell'URL assoluto supportato nel client con qualsiasi versione dell'API. Questo metodo non genera se la risposta è un errore; per generare un'eccezione, chiamare raise_for_status() sull'oggetto risposta restituito. Per altre informazioni su come inviare richieste personalizzate con questo metodo, vedere https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametri

Restituisce

Risposta della chiamata di rete. Non esegue la gestione degli errori nella risposta.

Tipo restituito

Eccezioni