DocumentModelAdministrationClient Clase

DocumentModelAdministrationClient es la interfaz Form Recognizer que se va a usar para compilar y administrar modelos.

Proporciona métodos para crear modelos y clasificadores, así como métodos para ver y eliminar modelos y clasificadores, ver las operaciones de modelo y clasificador, acceder a la información de la cuenta, copiar modelos en otro recurso Form Recognizer y crear un nuevo modelo a partir de una colección de modelos existentes.

Nota:

DocumentModelAdministrationClient debe usarse con versiones de API

2022-08-31 y versiones posteriores. Para usar versiones <de API =v2.1, cree una instancia de FormTrainingClient.

Novedad de la versión 2022-08-31: DocumentModelAdministrationClient y sus métodos de cliente.

Herencia

azure.ai.formrecognizer.aio._form_base_client_async.FormRecognizerClientBaseAsync

DocumentModelAdministrationClient

Constructor

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

Parámetros

endpoint

str

Requerido

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus2.api.cognitive.microsoft.com).

credential

AzureKeyCredential o TokenCredential

Requerido

Credenciales necesarias para que el cliente se conecte a Azure. Se trata de una instancia de AzureKeyCredential si usa una clave de API o una credencial de token de identity.

api_version

str o DocumentAnalysisApiVersion

La versión de API del servicio que se va a usar para las solicitudes. El valor predeterminado es la versión del servicio más reciente. Establecer en una versión anterior puede dar lugar a una compatibilidad de características reducida. Para usar versiones <de API =v2.1, cree una instancia de FormTrainingClient.

Ejemplos

Creación de DocumentModelAdministrationClient con un punto de conexión y una clave 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)
   )

Creación de DocumentModelAdministrationClient con una 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	Compile un clasificador de documentos. Para obtener más información sobre cómo compilar y entrenar un modelo clasificador personalizado, vea https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Novedad de la versión 2023-07-31: el método de cliente begin_build_document_classifier .
begin_build_document_model	Cree un modelo de documento personalizado. La solicitud debe incluir un parámetro de palabra clave blob_container_url que sea un URI de contenedor de blobs de Azure Storage accesible externamente (preferiblemente un URI de firma de acceso compartido). Tenga en cuenta que solo se acepta un URI de contenedor (sin SAS) cuando el contenedor es público o tiene configurada una identidad administrada, consulte más información sobre cómo configurar identidades administradas para que funcionen con Form Recognizer aquí: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Los modelos se compilan con documentos que son del siguiente tipo de contenido: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" o "image/heif". Se omiten otros tipos de contenido del contenedor. Novedad de la versión 2023-07-31: el argumento de palabra clave file_list .
begin_compose_document_model	Crea un modelo de documento compuesto a partir de una colección de modelos existentes. Un modelo compuesto permite llamar a varios modelos con un identificador de modelo único. Cuando se envía un documento para que se analice con un identificador de modelo compuesto, primero se realiza un paso de clasificación para enrutarlo al modelo personalizado correcto.
begin_copy_document_model_to	Copie un modelo de documento almacenado en este recurso (el origen) en el destino especificado por el usuario Form Recognizer recurso. Se debe llamar a con el recurso de Form Recognizer de origen (con el modelo que está pensado para copiarse). El parámetro de destino debe proporcionarse desde la salida del recurso de destino desde la llamada al get_copy_authorization método .
close	Cierre la DocumentModelAdministrationClient sesión.
delete_document_classifier	Elimine un clasificador de documentos. Novedad de la versión 2023-07-31: el método de cliente delete_document_classifier .
delete_document_model	Elimine un modelo de documento personalizado.
get_copy_authorization	Genere autorización para copiar un modelo personalizado en el recurso de Form Recognizer de destino. El recurso de destino debe llamar a esto (donde se copiará el modelo) y la salida se puede pasar como parámetro de destino a begin_copy_document_model_to.
get_document_analysis_client	Obtenga una instancia de DocumentAnalysisClient de DocumentModelAdministrationClient.
get_document_classifier	Obtenga un clasificador de documentos por su identificador. Novedad de la versión 2023-07-31: el método de cliente get_document_classifier .
get_document_model	Obtenga un modelo de documento por su identificador.
get_operation	Obtenga una operación por su identificador. Obtenga una operación asociada al recurso Form Recognizer. Tenga en cuenta que la información de operación solo se conserva durante 24 horas. Si la operación del modelo de documento se realizó correctamente, se puede acceder al modelo mediante las get_document_model API o list_document_models .
get_resource_details	Obtenga información sobre los modelos en el recurso Form Recognizer.
list_document_classifiers	Muestra información para cada clasificador de documentos, incluido su identificador de clasificador, descripción y cuándo se creó. Novedad de la versión 2023-07-31: el método de cliente list_document_classifiers .
list_document_models	Enumere la información de cada modelo, incluido su identificador de modelo, su descripción y cuándo se creó.
list_operations	Enumera la información de cada operación. Enumera todas las operaciones asociadas al recurso Form Recognizer. Tenga en cuenta que la información de operación solo se conserva durante 24 horas. Si la operación del modelo de documento se realizó correctamente, se puede acceder al modelo de documento mediante las get_document_model API o list_document_models .
send_request	Ejecuta una solicitud de red mediante la canalización existente del cliente. La dirección URL de la solicitud puede ser relativa a la dirección URL base. La versión de la API de servicio usada para la solicitud es la misma que la del cliente, a menos que se especifique lo contrario. La invalidación de la versión de API configurada del cliente en la dirección URL relativa se admite en el cliente con la versión de API 2022-08-31 y versiones posteriores. Invalidación en dirección URL absoluta admitida en el cliente con cualquier versión de API. Este método no genera si la respuesta es un error; para generar una excepción, llame a raise_for_status() en el objeto de respuesta devuelto. Para obtener más información sobre cómo enviar solicitudes personalizadas con este método, vea https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Compile un clasificador de documentos. Para obtener más información sobre cómo compilar y entrenar un modelo clasificador personalizado, vea https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Novedad de la versión 2023-07-31: el método de 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]

Requerido

Asignación de tipos de documentos con los que clasificar.

classifier_id

str

Nombre único del clasificador de documentos. Si no se especifica, se creará un identificador de clasificador automáticamente.

description

str

Descripción del clasificador de documentos.

Devoluciones

Instancia de AsyncDocumentModelAdministrationLROPoller. Llame a result() en el objeto poller para devolver un DocumentClassifierDetails.

Tipo de valor devuelto

AsyncDocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Excepciones

HttpResponseError

Ejemplos

Compile un clasificador de documentos.

   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

Cree un modelo de documento personalizado.

La solicitud debe incluir un parámetro de palabra clave blob_container_url que sea un URI de contenedor de blobs de Azure Storage accesible externamente (preferiblemente un URI de firma de acceso compartido). Tenga en cuenta que solo se acepta un URI de contenedor (sin SAS) cuando el contenedor es público o tiene configurada una identidad administrada, consulte más información sobre cómo configurar identidades administradas para que funcionen con Form Recognizer aquí: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Los modelos se compilan con documentos que son del siguiente tipo de contenido: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" o "image/heif". Se omiten otros tipos de contenido del contenedor.

Novedad de la versión 2023-07-31: el argumento de palabra clave 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]

Parámetros

build_mode

ModelBuildMode

Requerido

Modo de compilación del modelo personalizado. Entre los valores posibles se incluyen: "template", "neural". Para obtener más información sobre los modos de compilación, vea: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url

str

Identificador URI de SAS de un contenedor de blobs de Azure Storage. Se puede usar un URI de contenedor (sin SAS) si el contenedor es público o tiene configurada una identidad administrada. Para obtener más información sobre cómo configurar un conjunto de datos de entrenamiento, vea: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id

str

Un identificador único para el modelo. Si no se especifica, se creará un identificador de modelo automáticamente.

description

str

Descripción opcional que se va a agregar al modelo.

prefix

str

Cadena de prefijo que distingue mayúsculas de minúsculas para filtrar documentos en la ruta de acceso url del contenedor de blobs. Por ejemplo, al usar un URI de blob de Azure Storage, use el prefijo para restringir las subcarpetas. el prefijo debe terminar en "/" para evitar casos en los que los nombres de archivo compartan el mismo prefijo.

file_list

str

Ruta de acceso a un archivo JSONL dentro del contenedor que especifica un subconjunto de documentos para el entrenamiento.

tags

dict[str, str]

Lista de atributos de etiqueta clave-valor definidos por el usuario asociados al modelo.

Devoluciones

Instancia de AsyncDocumentModelAdministrationLROPoller. Llame a result() en el objeto poller para devolver un DocumentModelDetails.

Tipo de valor devuelto

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Excepciones

HttpResponseError

Ejemplos

Creación de un modelo a partir de archivos de entrenamiento.

   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 modelo de documento compuesto a partir de una colección de modelos existentes.

Un modelo compuesto permite llamar a varios modelos con un identificador de modelo único. Cuando se envía un documento para que se analice con un identificador de modelo compuesto, primero se realiza un paso de clasificación para enrutarlo al modelo personalizado correcto.

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

Parámetros

component_model_ids

list[str]

Requerido

Lista de identificadores de modelo que se usarán en el modelo compuesto.

model_id

str

Un identificador único para el modelo compuesto. Si no se especifica, se creará un identificador de modelo automáticamente.

description

str

Descripción opcional que se va a agregar al modelo.

tags

dict[str, str]

Lista de atributos de etiqueta clave-valor definidos por el usuario asociados al modelo.

Devoluciones

Instancia de AsyncDocumentModelAdministrationLROPoller. Llame a result() en el objeto poller para devolver un DocumentModelDetails.

Tipo de valor devuelto

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Excepciones

HttpResponseError

Ejemplos

Creación de un modelo compuesto con 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 un modelo de documento almacenado en este recurso (el origen) en el destino especificado por el usuario Form Recognizer recurso.

Se debe llamar a con el recurso de Form Recognizer de origen (con el modelo que está pensado para copiarse). El parámetro de destino debe proporcionarse desde la salida del recurso de destino desde la llamada al 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

Requerido

Identificador de modelo del modelo que se va a copiar en el recurso de destino.

target

<xref:azure.ai.formrecognizer.TargetAuthorization>

Requerido

Autorización de copia generada desde la llamada del recurso de destino a get_copy_authorization.

Devoluciones

Instancia de AsyncDocumentModelAdministrationLROPoller. Llame a result() en el objeto poller para devolver un DocumentModelDetails.

Tipo de valor devuelto

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Excepciones

HttpResponseError

Ejemplos

Copia de un modelo del recurso de origen en el 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

Cierre la DocumentModelAdministrationClient sesión.

async close() -> None

Excepciones

HttpResponseError

delete_document_classifier

Elimine un clasificador de documentos.

Novedad de la versión 2023-07-31: el método de cliente delete_document_classifier .

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

Parámetros

classifier_id

str

Requerido

Identificador clasificador.

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Ejemplos

Elimine un clasificador.

   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

Elimine un modelo de documento personalizado.

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

Parámetros

model_id

str

Requerido

Identificador del modelo.

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Ejemplos

Elimine un 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

Genere autorización para copiar un modelo personalizado en el recurso de Form Recognizer de destino.

El recurso de destino debe llamar a esto (donde se copiará el modelo) y la salida se puede pasar como parámetro de destino a begin_copy_document_model_to.

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

Parámetros

model_id

str

Un identificador único para el modelo copiado. Si no se especifica, se creará un identificador de modelo automáticamente.

description

str

Descripción opcional que se va a agregar al modelo.

tags

dict[str, str]

Lista de atributos de etiqueta clave-valor definidos por el usuario asociados al modelo.

Devoluciones

Diccionario con valores necesarios para la autorización de copia.

Tipo de valor devuelto

<xref:azure.ai.formrecognizer.TargetAuthorization>

Excepciones

HttpResponseError

get_document_analysis_client

Obtenga una instancia de DocumentAnalysisClient de DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Devoluciones

A DocumentAnalysisClient

Tipo de valor devuelto

DocumentAnalysisClient

Excepciones

HttpResponseError

get_document_classifier

Obtenga un clasificador de documentos por su identificador.

Novedad de la versión 2023-07-31: el método de cliente get_document_classifier .

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

Parámetros

classifier_id

str

Requerido

Identificador clasificador.

Devoluciones

DocumentClassifierDetails

Tipo de valor devuelto

DocumentClassifierDetails

Excepciones

HttpResponseError

ResourceNotFoundError

Ejemplos

Obtenga un clasificador por su identificador.

   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

Obtenga un modelo de documento por su identificador.

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

Parámetros

model_id

str

Requerido

Identificador del modelo.

Devoluciones

DocumentModelDetails

Tipo de valor devuelto

DocumentModelDetails

Excepciones

HttpResponseError

ResourceNotFoundError

Ejemplos

Obtenga un modelo por su identificador.

   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

Obtenga una operación por su identificador.

Obtenga una operación asociada al recurso Form Recognizer. Tenga en cuenta que la información de operación solo se conserva durante 24 horas. Si la operación del modelo de documento se realizó correctamente, se puede acceder al modelo mediante las get_document_model API o list_document_models .

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

Parámetros

operation_id

str

Requerido

El identificador de la operación.

Devoluciones

OperationDetails

Tipo de valor devuelto

OperationDetails

Excepciones

HttpResponseError

Ejemplos

Obtenga una operación de modelo de documento por su identificador.

   # 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

Obtenga información sobre los modelos en el recurso Form Recognizer.

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

Devoluciones

Resumen de modelos personalizados en el recurso: recuento y límite de modelos.

Tipo de valor devuelto

ResourceDetails

Excepciones

HttpResponseError

Ejemplos

Obtenga los recuentos y límites del modelo en el recurso Form Recognizer.

   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

Muestra información para cada clasificador de documentos, incluido su identificador de clasificador, descripción y cuándo se creó.

Novedad de la versión 2023-07-31: el método de cliente list_document_classifiers .

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

Devoluciones

Paginable de DocumentClassifierDetails.

Tipo de valor devuelto

AsyncItemPaged[DocumentClassifierDetails]

Excepciones

HttpResponseError

Ejemplos

Enumere todos los clasificadores que se compilaron correctamente en el recurso Form Recognizer.

   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

Enumere la información de cada modelo, incluido su identificador de modelo, su descripción y cuándo se creó.

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

Devoluciones

Paginable de DocumentModelSummary.

Tipo de valor devuelto

AsyncItemPaged[DocumentModelSummary]

Excepciones

HttpResponseError

Ejemplos

Enumere todos los modelos que se compilaron correctamente en el recurso Form Recognizer.

   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

Enumera la información de cada operación.

Enumera todas las operaciones asociadas al recurso Form Recognizer. Tenga en cuenta que la información de operación solo se conserva durante 24 horas. Si la operación del modelo de documento se realizó correctamente, se puede acceder al modelo de documento mediante las get_document_model API o list_document_models .

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

Devoluciones

Objeto paginable de OperationSummary.

Tipo de valor devuelto

AsyncItemPaged[OperationSummary]

Excepciones

HttpResponseError

Ejemplos

Enumere todas las operaciones del modelo de documentos en las ú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

Ejecuta una solicitud de red mediante la canalización existente del cliente.

La dirección URL de la solicitud puede ser relativa a la dirección URL base. La versión de la API de servicio usada para la solicitud es la misma que la del cliente, a menos que se especifique lo contrario. La invalidación de la versión de API configurada del cliente en la dirección URL relativa se admite en el cliente con la versión de API 2022-08-31 y versiones posteriores. Invalidación en dirección URL absoluta admitida en el cliente con cualquier versión de API. Este método no genera si la respuesta es un error; para generar una excepción, llame a raise_for_status() en el objeto de respuesta devuelto. Para obtener más información sobre cómo enviar solicitudes personalizadas con este método, vea https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parámetros

request

HttpRequest

Requerido

Solicitud de red que desea realizar.

Devoluciones

Respuesta de la llamada de red. No realiza el control de errores en la respuesta.

Tipo de valor devuelto

AsyncHttpResponse

Excepciones

HttpResponseError