DocumentModelAdministrationClient Classe

Riferimento

DocumentModelAdministrationClient è l'interfaccia Riconoscimento modulo da usare per la creazione e la gestione di modelli.

Fornisce metodi per la creazione di modelli e classificatori, nonché metodi per la visualizzazione e l'eliminazione di modelli e classificatori, la visualizzazione di operazioni di modello e classificatore, l'accesso alle informazioni sull'account, la copia di modelli in un'altra risorsa Riconoscimento modulo e la composizione di un nuovo modello da una raccolta di modelli esistenti.

Nota

DocumentModelAdministrationClient deve essere usato con le versioni dell'API

2022-08-31 e versioni in su. Per usare le versioni <dell'API =v2.1, creare un'istanza di FormTrainingClient.

Novità della versione 2022-08-31: DocumentModelAdministrationClient e i relativi metodi client.

Ereditarietà: azure.ai.formrecognizer.aio._form_base_client_async.FormRecognizerClientBaseAsync

DocumentModelAdministrationClient

Costruttore

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

Parametri

endpoint: str

Necessario

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential oppure TokenCredential

Necessario

Credenziali necessarie per la connessione del client ad Azure. Si tratta di un'istanza di AzureKeyCredential se si usa una chiave API o una credenziale token da identity.

api_version: str oppure DocumentAnalysisApiVersion

Versione API del servizio da usare per le richieste. Il valore predefinito viene impostato sulla versione più recente del servizio. L'impostazione su una versione precedente può comportare una riduzione della compatibilità delle funzionalità. Per usare le versioni <API =v2.1, creare un'istanza di FormTrainingClient.

Esempio

Creazione di DocumentModelAdministrationClient con un endpoint e una chiave API.


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

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

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, AzureKeyCredential(key)
   )

Creazione di DocumentModelAdministrationClient con credenziali token.


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

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

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, credential
   )

Metodi

begin_build_document_classifier	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à nella versione 2023-07-31: metodo client begin_build_document_classifier .
begin_build_document_model	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 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 da usare con Riconoscimento modulo qui: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. I modelli vengono compilati usando documenti del 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à nella versione 2023-07-31: argomento della parola chiave file_list .
begin_compose_document_model	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 un documento viene inviato per essere analizzato con un ID modello composto, viene prima eseguito un passaggio di classificazione per instradarlo al modello personalizzato corretto.
begin_copy_document_model_to	Copiare un modello di documento archiviato in questa risorsa (origine) nell'utente specificato Riconoscimento modulo risorsa. Questa operazione deve essere chiamata con la risorsa di Riconoscimento modulo di origine (con il modello che deve essere copiato). Il parametro di destinazione deve essere fornito dall'output della risorsa di destinazione chiamando il get_copy_authorization metodo .
close	Chiudere la DocumentModelAdministrationClient sessione.
delete_document_classifier	Eliminare un classificatore di documenti. Novità nella versione 2023-07-31: metodo client delete_document_classifier .
delete_document_model	Eliminare un modello di documento personalizzato.
get_copy_authorization	Generare l'autorizzazione per la copia di 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_document_analysis_client	Ottenere un'istanza di DocumentAnalysisClient da DocumentModelAdministrationClient.
get_document_classifier	Ottenere un classificatore di documenti in base al relativo ID. Novità della versione 2023-07-31: metodo client get_document_classifier .
get_document_model	Ottenere un modello di documento in base al relativo ID.
get_operation	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_resource_details	Ottenere informazioni sui modelli nella risorsa Riconoscimento modulo.
list_document_classifiers	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_models	Elencare le informazioni per ogni modello, inclusi l'ID modello, la descrizione e la data di creazione.
list_operations	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 l'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 .
send_request	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.

begin_build_document_classifier

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à nella versione 2023-07-31: metodo client begin_build_document_classifier .

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

Parametri

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

Necessario

Mapping dei tipi di documento da classificare in base.

classifier_id: str

Nome univoco del classificatore di documenti. Se non specificato, verrà creato un ID classificatore.

description: str

Descrizione del classificatore del documento.

Restituisce

Istanza di AsyncDocumentModelAdministrationLROPoller. Chiamare result() nell'oggetto poller per restituire un DocumentClassifierDetailsoggetto .

Tipo restituito

AsyncDocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Eccezioni

HttpResponseError

Esempio

Compilare un classificatore di documenti.


   import os
   from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient
   from azure.ai.formrecognizer import (
       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)
   )

   async with document_model_admin_client:
       poller = await 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 = await 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

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 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 da usare con Riconoscimento modulo qui: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. I modelli vengono compilati usando documenti del 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à nella versione 2023-07-31: argomento della parola chiave file_list .

async 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) -> AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Parametri

build_mode: ModelBuildMode

Necessario

Modalità di compilazione del modello personalizzata. I valori possibili includono: "modello", "neurale". Per altre informazioni sulle modalità di compilazione, vedere: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url: str

URI di firma di accesso condiviso del contenitore BLOB di Archiviazione di Azure. Un URI del contenitore (senza firma di accesso condiviso) può essere usato se il contenitore è pubblico o ha un'identità gestita configurata. Per altre informazioni sulla configurazione di un set di dati di training, vedere: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id: str

ID univoco per il modello. Se non specificato, verrà creato un ID modello.

description: str

Descrizione facoltativa da aggiungere al modello.

prefix: str

Stringa di prefisso con distinzione tra maiuscole e minuscole per filtrare i documenti nel percorso dell'URL del contenitore BLOB. Ad esempio, quando si usa un URI BLOB di archiviazione di Azure, usare il prefisso per limitare le sottocartella. il prefisso deve terminare in '/' per evitare casi in cui i file condividono lo stesso prefisso.

file_list: str

Percorso di un file JSONL all'interno del contenitore che specifica un subset di documenti per il training.

tags: dict[str, str]

Elenco degli attributi di tag chiave definiti dall'utente associati al modello.

Restituisce

Istanza di AsyncDocumentModelAdministrationLROPoller. Chiamare result() nell'oggetto poller per restituire un DocumentModelDetailsoggetto .

Tipo restituito

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Eccezioni

HttpResponseError

Esempio

Creazione di un modello da file di training.


   from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient
   from azure.ai.formrecognizer import 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)
   )
   async with document_model_admin_client:
       poller = await document_model_admin_client.begin_build_document_model(
           ModelBuildMode.TEMPLATE,
           blob_container_url=container_sas_url,
           description="my model description",
       )
       model = await 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

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 un documento viene inviato per essere analizzato con un ID modello composto, viene prima eseguito un passaggio di classificazione per instradarlo al modello personalizzato corretto.

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

Parametri

component_model_ids: list[str]

Necessario

Elenco degli ID modello da usare nel modello composto.

model_id: str

ID univoco per il modello composto. Se non specificato, verrà creato un ID modello.

description: str

Descrizione facoltativa da aggiungere al modello.

tags: dict[str, str]

Elenco degli attributi di tag chiave definiti dall'utente associati al modello.

Restituisce

Istanza di AsyncDocumentModelAdministrationLROPoller. Chiamare result() nell'oggetto poller per restituire un DocumentModelDetailsoggetto .

Tipo restituito

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Eccezioni

HttpResponseError

Esempio

Creazione di un modello composto con modelli esistenti.


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient
   from azure.ai.formrecognizer import 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)
   )
   async with document_model_admin_client:
       supplies_poller = await document_model_admin_client.begin_build_document_model(
           ModelBuildMode.TEMPLATE,
           blob_container_url=po_supplies,
           description="Purchase order-Office supplies",
       )
       equipment_poller = await document_model_admin_client.begin_build_document_model(
           ModelBuildMode.TEMPLATE,
           blob_container_url=po_equipment,
           description="Purchase order-Office Equipment",
       )
       furniture_poller = await document_model_admin_client.begin_build_document_model(
           ModelBuildMode.TEMPLATE,
           blob_container_url=po_furniture,
           description="Purchase order-Furniture",
       )
       cleaning_supplies_poller = (
           await document_model_admin_client.begin_build_document_model(
               ModelBuildMode.TEMPLATE,
               blob_container_url=po_cleaning_supplies,
               description="Purchase order-Cleaning Supplies",
           )
       )
       supplies_model = await supplies_poller.result()
       equipment_model = await equipment_poller.result()
       furniture_model = await furniture_poller.result()
       cleaning_supplies_model = await 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 = await document_model_admin_client.begin_compose_document_model(
           purchase_order_models, description="Office Supplies Composed Model"
       )
       model = await 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

Copiare un modello di documento archiviato in questa risorsa (origine) nell'utente specificato Riconoscimento modulo risorsa.

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

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

Parametri

model_id: str

Necessario

Identificatore del modello da copiare nella risorsa di destinazione.

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

Necessario

Autorizzazione di copia generata dalla chiamata della risorsa di destinazione a get_copy_authorization.

Restituisce

Istanza di AsyncDocumentModelAdministrationLROPoller. Chiamare result() nell'oggetto poller per restituire un DocumentModelDetailsoggetto .

Tipo restituito

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Eccezioni

HttpResponseError

Esempio

Copiare un modello dalla risorsa di origine alla risorsa di destinazione


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio 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)
   )
   async with target_client:
       target = await target_client.get_copy_authorization(
           description="model copied from other resource"
       )

   source_client = DocumentModelAdministrationClient(
       endpoint=source_endpoint, credential=AzureKeyCredential(source_key)
   )
   async with source_client:
       poller = await 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 = await 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

Chiudere la DocumentModelAdministrationClient sessione.

async close() -> None

Eccezioni

HttpResponseError

delete_document_classifier

Eliminare un classificatore di documenti.

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

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

Parametri

classifier_id: str

Necessario

Identificatore classificatore.

Restituisce

Nessuno

Tipo restituito

None

Eccezioni

HttpResponseError

ResourceNotFoundError

Esempio

Eliminare un classificatore.


   await document_model_admin_client.delete_document_classifier(
       classifier_id=my_classifier.classifier_id
   )

   try:
       await 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

Eliminare un modello di documento personalizzato.

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

Parametri

model_id: str

Necessario

Identificatore del modello.

Restituisce

Nessuno

Tipo restituito

None

Eccezioni

HttpResponseError

ResourceNotFoundError

Esempio

Eliminare un modello.


   await document_model_admin_client.delete_document_model(
       model_id=my_model.model_id
   )

   try:
       await 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

Generare l'autorizzazione per la copia di 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.

async get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parametri

model_id: str

ID univoco per il modello copiato. Se non specificato, verrà creato un ID modello.

description: str

Descrizione facoltativa da aggiungere al modello.

tags: dict[str, str]

Elenco degli attributi di tag chiave definiti dall'utente associati al modello.

Restituisce

Dizionario con valori necessari per l'autorizzazione di copia.

Tipo restituito

<xref:azure.ai.formrecognizer.TargetAuthorization>

Eccezioni

HttpResponseError

get_document_analysis_client

Ottenere un'istanza di DocumentAnalysisClient da DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Restituisce

A DocumentAnalysisClient

Tipo restituito

DocumentAnalysisClient

Eccezioni

HttpResponseError

get_document_classifier

Ottenere un classificatore di documenti in base al relativo ID.

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

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

Parametri

classifier_id: str

Necessario

Identificatore classificatore.

Restituisce

DocumentClassifierDetails

Tipo restituito

DocumentClassifierDetails

Eccezioni

HttpResponseError

ResourceNotFoundError

Esempio

Ottenere un classificatore in base al relativo ID.


   my_classifier = await 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

Ottenere un modello di documento in base al relativo ID.

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

Parametri

model_id: str

Necessario

Identificatore del modello.

Restituisce

DocumentModelDetails

Tipo restituito

DocumentModelDetails

Eccezioni

HttpResponseError

ResourceNotFoundError

Esempio

Ottenere un modello in base al relativo ID.


   my_model = await 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

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 .

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

Parametri

operation_id: str

Necessario

ID operazione.

Restituisce

OperationDetails

Tipo restituito

OperationDetails

Eccezioni

HttpResponseError

Esempio

Ottenere un'operazione del modello di documento in base al relativo ID.


   # Get an operation by ID
   try:
       first_operation = await operations.__anext__()

       print(f"\nGetting operation info by ID: {first_operation.operation_id}")
       operation_info = await document_model_admin_client.get_operation(
           first_operation.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}")
   except StopAsyncIteration:
       print("No operations found.")

get_resource_details

Ottenere informazioni sui modelli nella risorsa Riconoscimento modulo.

async get_resource_details(**kwargs: Any) -> ResourceDetails

Restituisce

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

Tipo restituito

ResourceDetails

Eccezioni

HttpResponseError

Esempio

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


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

   async with document_model_admin_client:
       account_details = await 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

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) -> AsyncItemPaged[DocumentClassifierDetails]

Restituisce

Paginabile di DocumentClassifierDetails.

Tipo restituito

AsyncItemPaged[DocumentClassifierDetails]

Eccezioni

HttpResponseError

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:")
   async for classifier in classifiers:
       print(f"{classifier.classifier_id} | {classifier.description}")

list_document_models

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

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

Restituisce

Paginabile di DocumentModelSummary.

Tipo restituito

AsyncItemPaged[DocumentModelSummary]

Eccezioni

HttpResponseError

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:")
   async for model in models:
       print(f"{model.model_id} | {model.description}")

list_operations

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 l'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) -> AsyncItemPaged[OperationSummary]

Restituisce

Oggetto pageable di OperationSummary.

Tipo restituito

AsyncItemPaged[OperationSummary]

Eccezioni

HttpResponseError

Esempio

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


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio 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)
   )

   async with document_model_admin_client:
       operations = document_model_admin_client.list_operations()

       print("The following document model operations exist under my resource:")
       async 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

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.

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

Parametri

request: HttpRequest

Necessario

Richiesta di rete da effettuare.

Restituisce

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

Tipo restituito

AsyncHttpResponse

Eccezioni

HttpResponseError

Condividi tramite

DocumentModelAdministrationClient Classe

Costruttore

Parametri

Esempio

Metodi

begin_build_document_classifier

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_build_document_model

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_compose_document_model

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_copy_document_model_to

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

close

Eccezioni

delete_document_classifier

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

delete_document_model

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

get_copy_authorization

Parametri

Restituisce

Tipo restituito

Eccezioni

get_document_analysis_client

Restituisce

Tipo restituito

Eccezioni

get_document_classifier

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

get_document_model

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

get_operation

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

get_resource_details

Restituisce

Tipo restituito

Eccezioni

Esempio

list_document_classifiers

Restituisce

Tipo restituito

Eccezioni