DocumentModelAdministrationClient Classe

Referência

DocumentModelAdministrationClient é a interface Reconhecimento de Formulários a ser usada para criar e gerenciar modelos.

Ele fornece métodos para criar modelos e classificadores, bem como métodos para exibir e excluir modelos e classificadores, exibir operações de modelo e classificador, acessar informações de conta, copiar modelos para outro recurso Reconhecimento de Formulários e redigir um novo modelo de uma coleção de modelos existentes.

Observação

DocumentModelAdministrationClient deve ser usado com versões de API

2022-08-31 e para cima. Para usar versões <de API =v2.1, crie uma instância de formTrainingClient.

Novidades na versão 2022-08-31: o DocumentModelAdministrationClient e seus métodos de cliente.

Herança: azure.ai.formrecognizer.aio._form_base_client_async.FormRecognizerClientBaseAsync

DocumentModelAdministrationClient

Construtor

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

Parâmetros

endpoint: str

Obrigatório

Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential ou TokenCredential

Obrigatório

Credenciais necessárias para que o cliente se conecte ao Azure. Essa é uma instância do AzureKeyCredential se estiver usando uma chave de API ou uma credencial de token de identity.

api_version: str ou DocumentAnalysisApiVersion

A versão da API do serviço a ser usada para solicitações. Ele usa como padrão a versão mais recente do serviço. A configuração para uma versão mais antiga pode resultar em compatibilidade de recursos reduzida. Para usar as versões <da API =v2.1, instancie um FormTrainingClient.

Exemplos

Criando o DocumentModelAdministrationClient com um ponto de extremidade e uma chave de 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)
   )

Criando o DocumentModelAdministrationClient com uma credencial de 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
   )

Métodos

begin_build_document_classifier	Crie um classificador de documento. Para obter mais informações sobre como criar e treinar um modelo de classificador personalizado, consulte https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Novo na versão 2023-07-31: o método cliente begin_build_document_classifier .
begin_build_document_model	Crie um modelo de documento personalizado. A solicitação deve incluir um parâmetro blob_container_url palavra-chave que seja um URI de contêiner de blob de armazenamento do Azure acessível externamente (preferencialmente um URI de Assinatura de Acesso Compartilhado). Observe que um URI de contêiner (sem SAS) é aceito somente quando o contêiner é público ou tem uma identidade gerenciada configurada, confira mais sobre como configurar identidades gerenciadas para trabalhar com Reconhecimento de Formulários aqui: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Os modelos são criados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp' ou 'image/heif'. Outros tipos de conteúdo no contêiner são ignorados. Novo na versão 2023-07-31: o argumento file_list palavra-chave.
begin_compose_document_model	Cria um modelo de documento composto de uma coleção de modelos existentes. Um modelo composto permite que vários modelos sejam chamados com uma única ID de modelo. Quando um documento é enviado para ser analisado com uma ID de modelo composto, uma etapa de classificação é executada primeiro para encaminhá-lo para o modelo personalizado correto.
begin_copy_document_model_to	Copie um modelo de documento armazenado nesse recurso (a origem) para o recurso de Reconhecimento de Formulários de destino especificado pelo usuário. Isso deve ser chamado com o recurso de Reconhecimento de Formulários de origem (com o modelo que se destina a ser copiado). O parâmetro de destino deve ser fornecido a partir da saída do recurso de destino de chamar o get_copy_authorization método .
close	Feche a DocumentModelAdministrationClient sessão.
delete_document_classifier	Exclua um classificador de documento. Novo na versão 2023-07-31: o método cliente delete_document_classifier .
delete_document_model	Exclua um modelo de documento personalizado.
get_copy_authorization	Gere autorização para copiar um modelo personalizado para o recurso de Reconhecimento de Formulários de destino. Isso deve ser chamado pelo recurso de destino (para o qual o modelo será copiado) e a saída pode ser passada como o parâmetro de destino para begin_copy_document_model_to.
get_document_analysis_client	Obtenha uma instância de um DocumentAnalysisClient do DocumentModelAdministrationClient.
get_document_classifier	Obtenha um classificador de documento por sua ID. Novo na versão 2023-07-31: o método de cliente get_document_classifier .
get_document_model	Obtenha um modelo de documento por sua ID.
get_operation	Obtenha uma operação por sua ID. Obtenha uma operação associada ao recurso Reconhecimento de Formulários. Observe que as informações da operação só persistem por 24 horas. Se a operação do modelo de documento tiver sido bem-sucedida, o modelo poderá ser acessado usando as get_document_model APIs ou list_document_models .
get_resource_details	Obtenha informações sobre os modelos no recurso Reconhecimento de Formulários.
list_document_classifiers	Listar informações para cada classificador de documento, incluindo sua ID do classificador, descrição e quando ele foi criado. Novo na versão 2023-07-31: o método de cliente list_document_classifiers .
list_document_models	Listar informações para cada modelo, incluindo sua ID de modelo, descrição e quando ele foi criado.
list_operations	Listar informações para cada operação. Lista todas as operações associadas ao recurso Reconhecimento de Formulários. Observe que as informações da operação só persistem por 24 horas. Se a operação do modelo de documento tiver sido bem-sucedida, o modelo de documento poderá ser acessado usando as get_document_model APIs ou list_document_models .
send_request	Executa uma solicitação de rede usando o pipeline existente do cliente. A URL de solicitação pode ser relativa à URL base. A versão da API de serviço usada para a solicitação é a mesma do cliente, a menos que especificado de outra forma. A substituição da versão da API configurada do cliente na URL relativa tem suporte no cliente com a versão da API 2022-08-31 e posterior. Substituição em URL absoluta com suporte no cliente com qualquer versão de API. Esse método não será gerado se a resposta for um erro; para gerar uma exceção, chame raise_for_status() no objeto de resposta retornado. Para obter mais informações sobre como enviar solicitações personalizadas com esse método, consulte https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Crie um classificador de documento. Para obter mais informações sobre como criar e treinar um modelo de classificador personalizado, consulte https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Novo na versão 2023-07-31: o método cliente 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]

Parâmetros

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

Obrigatório

Mapeamento de tipos de documento com os quais classificar.

classifier_id: str

Nome do classificador de documento exclusivo. Se não for especificado, uma ID do classificador será criada para você.

description: str

Descrição do classificador de documentos.

Retornos

Uma instância de um AsyncDocumentModelAdministrationLROPoller. Chame result() no objeto poller para retornar um DocumentClassifierDetails.

Tipo de retorno

AsyncDocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Exceções

HttpResponseError

Exemplos

Crie um classificador de documento.


   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

Crie um modelo de documento personalizado.

A solicitação deve incluir um parâmetro blob_container_url palavra-chave que seja um URI de contêiner de blob de armazenamento do Azure acessível externamente (preferencialmente um URI de Assinatura de Acesso Compartilhado). Observe que um URI de contêiner (sem SAS) é aceito somente quando o contêiner é público ou tem uma identidade gerenciada configurada, confira mais sobre como configurar identidades gerenciadas para trabalhar com Reconhecimento de Formulários aqui: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Os modelos são criados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp' ou 'image/heif'. Outros tipos de conteúdo no contêiner são ignorados.

Novo na versão 2023-07-31: o argumento file_list palavra-chave.

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]

Parâmetros

build_mode: ModelBuildMode

Obrigatório

O modo de build de modelo personalizado. Os valores possíveis incluem: "template", "neural". Para obter mais informações sobre modos de build, consulte: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url: str

Um URI SAS de contêiner de blob do Armazenamento do Azure. Um URI de contêiner (sem SAS) poderá ser usado se o contêiner for público ou tiver uma identidade gerenciada configurada. Para obter mais informações sobre como configurar um conjunto de dados de treinamento, consulte: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id: str

Uma ID exclusiva para seu modelo. Se não for especificado, uma ID de modelo será criada para você.

description: str

Uma descrição opcional a ser adicionada ao modelo.

prefix: str

Uma cadeia de caracteres de prefixo que diferencia maiúsculas de minúsculas para filtrar documentos no caminho da URL do contêiner de blob. Por exemplo, ao usar um URI de blob de armazenamento do Azure, use o prefixo para restringir subpastas. O prefixo deve terminar em '/' para evitar casos em que os nomes de arquivo compartilhem o mesmo prefixo.

file_list: str

Caminho para um arquivo JSONL dentro do contêiner especificando um subconjunto de documentos para treinamento.

tags: dict[str, str]

Lista de atributos de marca chave-valor definidos pelo usuário associados ao modelo.

Retornos

Uma instância de um AsyncDocumentModelAdministrationLROPoller. Chame result() no objeto poller para retornar um DocumentModelDetails.

Tipo de retorno

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Exceções

HttpResponseError

Exemplos

Criando um modelo a partir de arquivos de treinamento.


   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

Cria um modelo de documento composto de uma coleção de modelos existentes.

Um modelo composto permite que vários modelos sejam chamados com uma única ID de modelo. Quando um documento é enviado para ser analisado com uma ID de modelo composto, uma etapa de classificação é executada primeiro para encaminhá-lo para o modelo personalizado correto.

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

Parâmetros

component_model_ids: list[str]

Obrigatório

Lista de IDs de modelo a serem usadas no modelo composto.

model_id: str

Uma ID exclusiva para seu modelo composto. Se não for especificado, uma ID de modelo será criada para você.

description: str

Uma descrição opcional a ser adicionada ao modelo.

tags: dict[str, str]

Lista de atributos de marca chave-valor definidos pelo usuário associados ao modelo.

Retornos

Uma instância de um AsyncDocumentModelAdministrationLROPoller. Chame result() no objeto poller para retornar um DocumentModelDetails.

Tipo de retorno

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Exceções

HttpResponseError

Exemplos

Criando um modelo composto com modelos existentes.


   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

Copie um modelo de documento armazenado nesse recurso (a origem) para o recurso de Reconhecimento de Formulários de destino especificado pelo usuário.

Isso deve ser chamado com o recurso de Reconhecimento de Formulários de origem (com o modelo que se destina a ser copiado). O parâmetro de destino deve ser fornecido a partir da saída do recurso de destino de chamar o get_copy_authorization método .

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

Parâmetros

model_id: str

Obrigatório

Identificador de modelo do modelo a ser copiado para o recurso de destino.

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

Obrigatório

A autorização de cópia gerada da chamada do recurso de destino para get_copy_authorization.

Retornos

Uma instância de um AsyncDocumentModelAdministrationLROPoller. Chame result() no objeto poller para retornar um DocumentModelDetails.

Tipo de retorno

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Exceções

HttpResponseError

Exemplos

Copiar um modelo do recurso de origem para o recurso de destino


   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

Feche a DocumentModelAdministrationClient sessão.

async close() -> None

Exceções

HttpResponseError

delete_document_classifier

Exclua um classificador de documento.

Novo na versão 2023-07-31: o método cliente delete_document_classifier .

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

Parâmetros

classifier_id: str

Obrigatório

Identificador do classificador.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Exemplos

Exclua um classificador.


   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

Exclua um modelo de documento personalizado.

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

Parâmetros

model_id: str

Obrigatório

Identificador de modelo.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Exemplos

Excluir um modelo.


   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

Gere autorização para copiar um modelo personalizado para o recurso de Reconhecimento de Formulários de destino.

Isso deve ser chamado pelo recurso de destino (para o qual o modelo será copiado) e a saída pode ser passada como o parâmetro de destino para begin_copy_document_model_to.

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

Parâmetros

model_id: str

Uma ID exclusiva para seu modelo copiado. Se não for especificado, uma ID de modelo será criada para você.

description: str

Uma descrição opcional a ser adicionada ao modelo.

tags: dict[str, str]

Lista de atributos de marca chave-valor definidos pelo usuário associados ao modelo.

Retornos

Um dicionário com valores necessários para a autorização de cópia.

Tipo de retorno

<xref:azure.ai.formrecognizer.TargetAuthorization>

Exceções

HttpResponseError

get_document_analysis_client

Obtenha uma instância de um DocumentAnalysisClient do DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Retornos

Um DocumentAnalysisClient

Tipo de retorno

DocumentAnalysisClient

Exceções

HttpResponseError

get_document_classifier

Obtenha um classificador de documento por sua ID.

Novo na versão 2023-07-31: o método de cliente get_document_classifier .

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

Parâmetros

classifier_id: str

Obrigatório

Identificador do classificador.

Retornos

DocumentClassifierDetails

Tipo de retorno

DocumentClassifierDetails

Exceções

HttpResponseError

ResourceNotFoundError

Exemplos

Obtenha um classificador por sua 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

Obtenha um modelo de documento por sua ID.

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

Parâmetros

model_id: str

Obrigatório

Identificador de modelo.

Retornos

DocumentModelDetails

Tipo de retorno

DocumentModelDetails

Exceções

HttpResponseError

ResourceNotFoundError

Exemplos

Obtenha um modelo por sua 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

Obtenha uma operação por sua ID.

Obtenha uma operação associada ao recurso Reconhecimento de Formulários. Observe que as informações da operação só persistem por 24 horas. Se a operação do modelo de documento tiver sido bem-sucedida, o modelo poderá ser acessado usando as get_document_model APIs ou list_document_models .

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

Parâmetros

operation_id: str

Obrigatório

A ID da operação.

Retornos

OperationDetails

Tipo de retorno

OperationDetails

Exceções

HttpResponseError

Exemplos

Obtenha uma operação de modelo de documento por sua 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

Obtenha informações sobre os modelos no recurso Reconhecimento de Formulários.

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

Retornos

Resumo de modelos personalizados no recurso – contagem e limite de modelos.

Tipo de retorno

ResourceDetails

Exceções

HttpResponseError

Exemplos

Obtenha contagens e limites de modelo no recurso Reconhecimento de Formulários.


   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

Listar informações para cada classificador de documento, incluindo sua ID do classificador, descrição e quando ele foi criado.

Novo na versão 2023-07-31: o método de cliente list_document_classifiers .

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

Retornos

Paginável de DocumentClassifierDetails.

Tipo de retorno

AsyncItemPaged[DocumentClassifierDetails]

Exceções

HttpResponseError

Exemplos

Liste todos os classificadores que foram criados com êxito no recurso Reconhecimento de Formulários.


   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

Listar informações para cada modelo, incluindo sua ID de modelo, descrição e quando ele foi criado.

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

Retornos

Paginável de DocumentModelSummary.

Tipo de retorno

AsyncItemPaged[DocumentModelSummary]

Exceções

HttpResponseError

Exemplos

Liste todos os modelos criados com êxito no recurso Reconhecimento de Formulários.


   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

Listar informações para cada operação.

Lista todas as operações associadas ao recurso Reconhecimento de Formulários. Observe que as informações da operação só persistem por 24 horas. Se a operação do modelo de documento tiver sido bem-sucedida, o modelo de documento poderá ser acessado usando as get_document_model APIs ou list_document_models .

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

Retornos

Um pageable de OperationSummary.

Tipo de retorno

AsyncItemPaged[OperationSummary]

Exceções

HttpResponseError

Exemplos

Liste todas as operações de modelo de documento nas últimas 24 horas.


   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

Executa uma solicitação de rede usando o pipeline existente do cliente.

A URL de solicitação pode ser relativa à URL base. A versão da API de serviço usada para a solicitação é a mesma do cliente, a menos que especificado de outra forma. A substituição da versão da API configurada do cliente na URL relativa tem suporte no cliente com a versão da API 2022-08-31 e posterior. Substituição em URL absoluta com suporte no cliente com qualquer versão de API. Esse método não será gerado se a resposta for um erro; para gerar uma exceção, chame raise_for_status() no objeto de resposta retornado. Para obter mais informações sobre como enviar solicitações personalizadas com esse método, consulte https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parâmetros

request: HttpRequest

Obrigatório

A solicitação de rede que você deseja fazer.

Retornos

A resposta da chamada de rede. Não faz tratamento de erros em sua resposta.

Tipo de retorno

AsyncHttpResponse

Exceções

HttpResponseError

Compartilhar via

DocumentModelAdministrationClient Classe

Construtor

Parâmetros

Exemplos

Métodos

begin_build_document_classifier

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

begin_build_document_model

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

begin_compose_document_model

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

begin_copy_document_model_to

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

close

Exceções

delete_document_classifier

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

delete_document_model

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

get_copy_authorization

Parâmetros

Retornos

Tipo de retorno

Exceções

get_document_analysis_client

Retornos

Tipo de retorno

Exceções

get_document_classifier

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

get_document_model

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

get_operation

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

get_resource_details

Retornos

Tipo de retorno

Exceções

Exemplos

list_document_classifiers

Retornos

Tipo de retorno

Exceções