DocumentModelAdministrationClient Класс

Ссылка

DocumentModelAdministrationClient — это интерфейс Распознаватель документов, используемый для создания моделей и управления ими.

Он предоставляет методы для создания моделей и классификаторов, а также методы для просмотра и удаления моделей и классификаторов, просмотра операций модели и классификаторов, доступа к сведениям об учетной записи, копирования моделей в другой ресурс Распознаватель документов и создания новой модели из коллекции существующих моделей.

Примечание

DocumentModelAdministrationClient следует использовать с версиями API

31.08.2022 и более Чтобы использовать API версии <=v2.1, создайте экземпляр FormTrainingClient.

Новые возможности в версии 2022-08-31: DocumentModelAdministrationClient и его клиентские методы.

Наследование: azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

Конструктор

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

Параметры

endpoint: str

Обязательно

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential или TokenCredential

Обязательно

Учетные данные, необходимые клиенту для подключения к Azure. Это экземпляр AzureKeyCredential, если используется ключ API или учетные данные маркера из identity.

api_version: str или DocumentAnalysisApiVersion

Версия API службы, используемая для запросов. По умолчанию используется последняя версия службы. Установка более старой версии может привести к снижению совместимости функций. Чтобы использовать версии <API =v2.1, создайте экземпляр FormTrainingClient.

Примеры

Создание DocumentModelAdministrationClient с конечной точкой и ключом API.


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

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

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, AzureKeyCredential(key)
   )

Создание DocumentModelAdministrationClient с учетными данными маркера.


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

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

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, credential
   )

Методы

begin_build_document_classifier	Создание классификатора документов. Дополнительные сведения о создании и обучении модели пользовательского классификатора см. в разделе https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Новые возможности в версии 2023-07-31: метод клиента begin_build_document_classifier .
begin_build_document_model	Создание пользовательской модели документов. Запрос должен содержать параметр blob_container_url ключевое слово, который является URI контейнера BLOB-объектов хранилища Azure с внешним доступом (предпочтительно URI подписанного URL-адреса). Обратите внимание, что URI контейнера (без SAS) принимается только в том случае, если контейнер является общедоступным или в нем настроено управляемое удостоверение. Дополнительные сведения о настройке управляемых удостоверений для работы с Распознаватель документов см. здесь: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Модели создаются с использованием документов следующего типа контента: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" или "image/heif". Другие типы содержимого в контейнере игнорируются. Новые возможности в версии 2023-07-31: аргумент ключевое слово file_list.
begin_compose_document_model	Создает составную модель документа из коллекции существующих моделей. Составная модель позволяет вызывать несколько моделей с одним идентификатором модели. При отправке документа для анализа с помощью идентификатора созданной модели сначала выполняется классификация, которая направляется в нужную пользовательскую модель.
begin_copy_document_model_to	Скопируйте модель документа, хранящуюся в этом ресурсе (источнике), в указанный пользователем целевой Распознаватель документов ресурс. Он должен вызываться с исходным ресурсом Распознаватель документов (с моделью, которая предназначена для копирования). Целевой параметр должен быть предоставлен из выходных данных целевого ресурса при вызове get_copy_authorization метода .
close	DocumentModelAdministrationClient Закройте сеанс.
delete_document_classifier	Удаление классификатора документов. Новые возможности в версии 2023-07-31: метод клиента delete_document_classifier .
delete_document_model	Удаление пользовательской модели документов.
get_copy_authorization	Создайте авторизацию для копирования пользовательской модели в целевой ресурс Распознаватель документов. Он должен вызываться целевым ресурсом (в который будет скопирована модель), а выходные данные могут быть переданы в качестве целевого параметра в begin_copy_document_model_to.
get_document_analysis_client	Получите экземпляр DocumentAnalysisClient из DocumentModelAdministrationClient.
get_document_classifier	Получение классификатора документа по его идентификатору. Новое в версии 2023-07-31: метод get_document_classifier клиента.
get_document_model	Получение модели документа по ее идентификатору.
get_operation	Получение операции по ее идентификатору. Получение операции, связанной с ресурсом Распознаватель документов. Обратите внимание, что сведения об операциях сохраняются только в течение 24 часов. Если операция с моделью документа прошла успешно, доступ к модели можно получить с помощью get_document_model API или list_document_models .
get_resource_details	Получите сведения о моделях в ресурсе Распознаватель документов.
list_document_classifiers	Список сведений для каждого классификатора документа, включая его идентификатор, описание и время создания. Новые возможности в версии 2023-07-31: метод клиента list_document_classifiers .
list_document_models	Список сведений для каждой модели, включая ее идентификатор, описание и время ее создания.
list_operations	Вывод сведений для каждой операции. Выводит список всех операций, связанных с ресурсом Распознаватель документов. Обратите внимание, что сведения об операциях сохраняются только в течение 24 часов. Если операция с моделью документа прошла успешно, доступ к модели документа можно получить с помощью get_document_model API или list_document_models .
send_request	Выполняет сетевой запрос, используя существующий конвейер клиента. URL-адрес запроса может быть относительно базового URL-адреса. Версия API службы, используемая для запроса, совпадает с версией клиента, если не указано иное. Переопределение настроенной версии API клиента в относительном URL-адресе поддерживается на клиенте с API версии 2022-08-31 и более поздних версий. Переопределение в абсолютном URL-адресе, поддерживаемом на клиенте с любой версией API. Этот метод не вызывает, если ответ является ошибкой; чтобы вызвать исключение, вызовите raise_for_status() для возвращенного объекта ответа. Дополнительные сведения об отправке пользовательских запросов с помощью этого метода см. в разделе https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Создание классификатора документов. Дополнительные сведения о создании и обучении модели пользовательского классификатора см. в разделе https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Новые возможности в версии 2023-07-31: метод клиента begin_build_document_classifier .

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

Параметры

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

Обязательно

Сопоставление типов документов для классификации.

classifier_id: str

Уникальное имя классификатора документов. Если этот параметр не указан, будет создан идентификатор классификатора.

description: str

Описание классификатора документов.

Возвращаемое значение

Экземпляр DocumentModelAdministrationLROPoller. Вызовите result() в объекте опроса, чтобы вернуть DocumentClassifierDetails.

Возвращаемый тип

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Исключения

HttpResponseError

Примеры

Создание классификатора документов.


   import os
   from azure.ai.formrecognizer import (
       DocumentModelAdministrationClient,
       ClassifierDocumentTypeDetails,
       BlobSource,
       BlobFileListSource,
   )
   from azure.core.credentials import AzureKeyCredential

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

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

   poller = document_model_admin_client.begin_build_document_classifier(
       doc_types={
           "IRS-1040-A": ClassifierDocumentTypeDetails(
               source=BlobSource(
                   container_url=container_sas_url, prefix="IRS-1040-A/train"
               )
           ),
           "IRS-1040-D": ClassifierDocumentTypeDetails(
               source=BlobFileListSource(
                   container_url=container_sas_url, file_list="IRS-1040-D.jsonl"
               )
           ),
       },
       description="IRS document classifier",
   )
   result = poller.result()
   print(f"Classifier ID: {result.classifier_id}")
   print(f"API version used to build the classifier model: {result.api_version}")
   print(f"Classifier description: {result.description}")
   print(f"Document classes used for training the model:")
   for doc_type, details in result.doc_types.items():
       print(f"Document type: {doc_type}")
       print(f"Container source: {details.source.container_url}\n")

begin_build_document_model

Создание пользовательской модели документов.

Запрос должен содержать параметр blob_container_url ключевое слово, который является URI контейнера BLOB-объектов хранилища Azure с внешним доступом (предпочтительно URI подписанного URL-адреса). Обратите внимание, что URI контейнера (без SAS) принимается только в том случае, если контейнер является общедоступным или в нем настроено управляемое удостоверение. Дополнительные сведения о настройке управляемых удостоверений для работы с Распознаватель документов см. здесь: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Модели создаются с использованием документов следующего типа контента: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" или "image/heif". Другие типы содержимого в контейнере игнорируются.

Новые возможности в версии 2023-07-31: аргумент ключевое слово file_list.

begin_build_document_model(build_mode: str | ModelBuildMode, *, blob_container_url: str, prefix: str | None = None, model_id: str | None = None, description: str | None = None, tags: Mapping[str, str] | None = None, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]

Параметры

build_mode: ModelBuildMode

Обязательно

Режим сборки пользовательской модели. Возможные значения: "template", "neural". Дополнительные сведения о режимах сборки см. в разделе https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url: str

URI SAS контейнера BLOB-объектов службы хранилища Azure. URI контейнера (без SAS) можно использовать, если контейнер является общедоступным или имеет настроенное управляемое удостоверение. Дополнительные сведения о настройке набора данных для обучения см. в разделе https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id: str

Уникальный идентификатор модели. Если этот параметр не указан, будет создан идентификатор модели.

description: str

Необязательное описание для добавления в модель.

prefix: str

Строка префикса с учетом регистра для фильтрации документов по URL-адресу контейнера BLOB-объектов. Например, при использовании URI blob-объекта службы хранилища Azure используйте префикс для ограничения вложенных папок. Префикс должен заканчиваться на "/", чтобы избежать случаев, когда имена файлов используют один и тот же префикс.

file_list: str

Путь к JSONL-файлу в контейнере с указанием подмножества документов для обучения.

tags: dict[str, str]

Список определяемых пользователем атрибутов тега "ключ-значение", связанных с моделью.

Возвращаемое значение

Экземпляр DocumentModelAdministrationLROPoller. Вызовите result() в объекте опроса, чтобы вернуть DocumentModelDetails.

Возвращаемый тип

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Исключения

HttpResponseError

Примеры

Создание модели на основе файлов обучения.


   from azure.ai.formrecognizer import (
       DocumentModelAdministrationClient,
       ModelBuildMode,
   )
   from azure.core.credentials import AzureKeyCredential

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

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, AzureKeyCredential(key)
   )
   poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=container_sas_url,
       description="my model description",
   )
   model = poller.result()

   print(f"Model ID: {model.model_id}")
   print(f"Description: {model.description}")
   print(f"Model created on: {model.created_on}")
   print(f"Model expires on: {model.expires_on}")
   print("Doc types the model can recognize:")
   for name, doc_type in model.doc_types.items():
       print(
           f"Doc Type: '{name}' built with '{doc_type.build_mode}' mode which has the following fields:"
       )
       for field_name, field in doc_type.field_schema.items():
           print(
               f"Field: '{field_name}' has type '{field['type']}' and confidence score "
               f"{doc_type.field_confidence[field_name]}"
           )

begin_compose_document_model

Создает составную модель документа из коллекции существующих моделей.

Составная модель позволяет вызывать несколько моделей с одним идентификатором модели. При отправке документа для анализа с помощью идентификатора созданной модели сначала выполняется классификация, которая направляется в нужную пользовательскую модель.

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

Параметры

component_model_ids: list[str]

Обязательно

Список идентификаторов моделей, используемых в составной модели.

model_id: str

Уникальный идентификатор для составной модели. Если этот параметр не указан, будет создан идентификатор модели.

description: str

Необязательное описание для добавления в модель.

tags: dict[str, str]

Список определяемых пользователем атрибутов тега "ключ-значение", связанных с моделью.

Возвращаемое значение

Экземпляр DocumentModelAdministrationLROPoller. Вызовите result() в объекте опроса, чтобы вернуть DocumentModelDetails.

Возвращаемый тип

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Исключения

HttpResponseError

Примеры

Создание составной модели с существующими моделями.


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer import (
       DocumentModelAdministrationClient,
       ModelBuildMode,
   )

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
   po_supplies = os.environ["PURCHASE_ORDER_OFFICE_SUPPLIES_SAS_URL"]
   po_equipment = os.environ["PURCHASE_ORDER_OFFICE_EQUIPMENT_SAS_URL"]
   po_furniture = os.environ["PURCHASE_ORDER_OFFICE_FURNITURE_SAS_URL"]
   po_cleaning_supplies = os.environ["PURCHASE_ORDER_OFFICE_CLEANING_SUPPLIES_SAS_URL"]

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   supplies_poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=po_supplies,
       description="Purchase order-Office supplies",
   )
   equipment_poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=po_equipment,
       description="Purchase order-Office Equipment",
   )
   furniture_poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=po_furniture,
       description="Purchase order-Furniture",
   )
   cleaning_supplies_poller = document_model_admin_client.begin_build_document_model(
       ModelBuildMode.TEMPLATE,
       blob_container_url=po_cleaning_supplies,
       description="Purchase order-Cleaning Supplies",
   )
   supplies_model = supplies_poller.result()
   equipment_model = equipment_poller.result()
   furniture_model = furniture_poller.result()
   cleaning_supplies_model = cleaning_supplies_poller.result()

   purchase_order_models = [
       supplies_model.model_id,
       equipment_model.model_id,
       furniture_model.model_id,
       cleaning_supplies_model.model_id,
   ]

   poller = document_model_admin_client.begin_compose_document_model(
       purchase_order_models, description="Office Supplies Composed Model"
   )
   model = poller.result()

   print("Office Supplies Composed Model Info:")
   print(f"Model ID: {model.model_id}")
   print(f"Description: {model.description}")
   print(f"Model created on: {model.created_on}")
   print(f"Model expires on: {model.expires_on}")
   print("Doc types the model can recognize:")
   for name, doc_type in model.doc_types.items():
       print(f"Doc Type: '{name}' which has the following fields:")
       for field_name, field in doc_type.field_schema.items():
           print(
               f"Field: '{field_name}' has type '{field['type']}' and confidence score "
               f"{doc_type.field_confidence[field_name]}"
           )

begin_copy_document_model_to

Скопируйте модель документа, хранящуюся в этом ресурсе (источнике), в указанный пользователем целевой Распознаватель документов ресурс.

Он должен вызываться с исходным ресурсом Распознаватель документов (с моделью, которая предназначена для копирования). Целевой параметр должен быть предоставлен из выходных данных целевого ресурса при вызове get_copy_authorization метода .

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

Параметры

model_id: str

Обязательно

Идентификатор модели, копируемой в целевой ресурс.

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

Обязательно

Авторизация копирования, созданная при вызове целевого ресурса к get_copy_authorization.

Возвращаемое значение

Экземпляр DocumentModelAdministrationLROPoller. Вызовите result() в объекте опроса, чтобы вернуть DocumentModelDetails.

Возвращаемый тип

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Исключения

HttpResponseError

Примеры

Копирование модели из исходного ресурса в целевой ресурс


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

   source_endpoint = os.environ["AZURE_FORM_RECOGNIZER_SOURCE_ENDPOINT"]
   source_key = os.environ["AZURE_FORM_RECOGNIZER_SOURCE_KEY"]
   target_endpoint = os.environ["AZURE_FORM_RECOGNIZER_TARGET_ENDPOINT"]
   target_key = os.environ["AZURE_FORM_RECOGNIZER_TARGET_KEY"]
   source_model_id = os.getenv("AZURE_SOURCE_MODEL_ID", custom_model_id)

   target_client = DocumentModelAdministrationClient(
       endpoint=target_endpoint, credential=AzureKeyCredential(target_key)
   )

   target = target_client.get_copy_authorization(
       description="model copied from other resource"
   )

   source_client = DocumentModelAdministrationClient(
       endpoint=source_endpoint, credential=AzureKeyCredential(source_key)
   )
   poller = source_client.begin_copy_document_model_to(
       model_id=source_model_id,
       target=target,  # output from target client's call to get_copy_authorization()
   )
   copied_over_model = poller.result()

   print(f"Model ID: {copied_over_model.model_id}")
   print(f"Description: {copied_over_model.description}")
   print(f"Model created on: {copied_over_model.created_on}")
   print(f"Model expires on: {copied_over_model.expires_on}")
   print("Doc types the model can recognize:")
   for name, doc_type in copied_over_model.doc_types.items():
       print(f"Doc Type: '{name}' which has the following fields:")
       for field_name, field in doc_type.field_schema.items():
           print(
               f"Field: '{field_name}' has type '{field['type']}' and confidence score "
               f"{doc_type.field_confidence[field_name]}"
           )

close

DocumentModelAdministrationClient Закройте сеанс.

close() -> None

Исключения

HttpResponseError

delete_document_classifier

Удаление классификатора документов.

Новые возможности в версии 2023-07-31: метод клиента delete_document_classifier .

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

Параметры

classifier_id: str

Обязательно

Идентификатор классификатора.

Возвращаемое значение

Нет

Возвращаемый тип

None

Исключения

HttpResponseError

ResourceNotFoundError

Примеры

Удаление классификатора.


   document_model_admin_client.delete_document_classifier(
       classifier_id=my_classifier.classifier_id
   )

   try:
       document_model_admin_client.get_document_classifier(
           classifier_id=my_classifier.classifier_id
       )
   except ResourceNotFoundError:
       print(f"Successfully deleted classifier with ID {my_classifier.classifier_id}")

delete_document_model

Удаление пользовательской модели документов.

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

Параметры

model_id: str

Обязательно

Идентификатор модели.

Возвращаемое значение

Нет

Возвращаемый тип

None

Исключения

HttpResponseError

ResourceNotFoundError

Примеры

Удаление модели.


   document_model_admin_client.delete_document_model(model_id=my_model.model_id)

   try:
       document_model_admin_client.get_document_model(model_id=my_model.model_id)
   except ResourceNotFoundError:
       print(f"Successfully deleted model with ID {my_model.model_id}")

get_copy_authorization

Создайте авторизацию для копирования пользовательской модели в целевой ресурс Распознаватель документов.

Он должен вызываться целевым ресурсом (в который будет скопирована модель), а выходные данные могут быть переданы в качестве целевого параметра в begin_copy_document_model_to.

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Параметры

model_id: str

Уникальный идентификатор скопированной модели. Если этот параметр не указан, будет создан идентификатор модели.

description: str

Необязательное описание для добавления в модель.

tags: dict[str, str]

Список определяемых пользователем атрибутов тега "ключ-значение", связанных с моделью.

Возвращаемое значение

Словарь со значениями, необходимыми для авторизации копирования.

Возвращаемый тип

<xref:azure.ai.formrecognizer.TargetAuthorization>

Исключения

HttpResponseError

get_document_analysis_client

Получите экземпляр DocumentAnalysisClient из DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Возвращаемое значение

A DocumentAnalysisClient

Возвращаемый тип

DocumentAnalysisClient

Исключения

HttpResponseError

get_document_classifier

Получение классификатора документа по его идентификатору.

Новое в версии 2023-07-31: метод get_document_classifier клиента.

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

Параметры

classifier_id: str

Обязательно

Идентификатор классификатора.

Возвращаемое значение

DocumentClassifierDetails

Возвращаемый тип

DocumentClassifierDetails

Исключения

HttpResponseError

ResourceNotFoundError

Примеры

Получение классификатора по его идентификатору.


   my_classifier = document_model_admin_client.get_document_classifier(
       classifier_id=classifier_model.classifier_id
   )
   print(f"\nClassifier ID: {my_classifier.classifier_id}")
   print(f"Description: {my_classifier.description}")
   print(f"Classifier created on: {my_classifier.created_on}")

get_document_model

Получение модели документа по ее идентификатору.

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

Параметры

model_id: str

Обязательно

Идентификатор модели.

Возвращаемое значение

DocumentModelDetails

Возвращаемый тип

DocumentModelDetails

Исключения

HttpResponseError

ResourceNotFoundError

Примеры

Получение модели по ее идентификатору.


   my_model = document_model_admin_client.get_document_model(model_id=model.model_id)
   print(f"\nModel ID: {my_model.model_id}")
   print(f"Description: {my_model.description}")
   print(f"Model created on: {my_model.created_on}")
   print(f"Model expires on: {my_model.expires_on}")

get_operation

Получение операции по ее идентификатору.

Получение операции, связанной с ресурсом Распознаватель документов. Обратите внимание, что сведения об операциях сохраняются только в течение 24 часов. Если операция с моделью документа прошла успешно, доступ к модели можно получить с помощью get_document_model API или list_document_models .

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

Параметры

operation_id: str

Обязательно

Идентификатор операции.

Возвращаемое значение

OperationDetails

Возвращаемый тип

OperationDetails

Исключения

HttpResponseError

Примеры

Получение операции модели документа по ее идентификатору.


   # Get an operation by ID
   if operations:
       print(f"\nGetting operation info by ID: {operations[0].operation_id}")
       operation_info = document_model_admin_client.get_operation(
           operations[0].operation_id
       )
       if operation_info.status == "succeeded":
           print(f"My {operation_info.kind} operation is completed.")
           result = operation_info.result
           if result is not None:
               if operation_info.kind == "documentClassifierBuild":
                   print(f"Classifier ID: {result.classifier_id}")
               else:
                   print(f"Model ID: {result.model_id}")
       elif operation_info.status == "failed":
           print(f"My {operation_info.kind} operation failed.")
           error = operation_info.error
           if error is not None:
               print(f"{error.code}: {error.message}")
       else:
           print(f"My operation status is {operation_info.status}")
   else:
       print("No operations found.")

get_resource_details

Получите сведения о моделях в ресурсе Распознаватель документов.

get_resource_details(**kwargs: Any) -> ResourceDetails

Возвращаемое значение

Сводка пользовательских моделей в ресурсе — количество и ограничение моделей.

Возвращаемый тип

ResourceDetails

Исключения

HttpResponseError

Примеры

Получение количества моделей и ограничений в ресурсе Распознаватель документов.


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

   account_details = document_model_admin_client.get_resource_details()
   print(
       f"Our resource has {account_details.custom_document_models.count} custom models, "
       f"and we can have at most {account_details.custom_document_models.limit} custom models"
   )
   neural_models = account_details.neural_document_model_quota
   print(
       f"The quota limit for custom neural document models is {neural_models.quota} and the resource has"
       f"used {neural_models.used}. The resource quota will reset on {neural_models.quota_resets_on}"
   )

list_document_classifiers

Список сведений для каждого классификатора документа, включая его идентификатор, описание и время создания.

Новые возможности в версии 2023-07-31: метод клиента list_document_classifiers .

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

Возвращаемое значение

Страничный объект DocumentClassifierDetails.

Возвращаемый тип

ItemPaged[DocumentClassifierDetails]

Исключения

HttpResponseError

Примеры

Перечисление всех классификаторов, успешно созданных в ресурсе Распознаватель документов.


   classifiers = document_model_admin_client.list_document_classifiers()

   print("We have the following 'ready' models with IDs and descriptions:")
   for classifier in classifiers:
       print(f"{classifier.classifier_id} | {classifier.description}")

list_document_models

Список сведений для каждой модели, включая ее идентификатор, описание и время ее создания.

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

Возвращаемое значение

Страничный файл DocumentModelSummary.

Возвращаемый тип

ItemPaged[DocumentModelSummary]

Исключения

HttpResponseError

Примеры

Вывод списка всех моделей, успешно созданных в ресурсе Распознаватель документов.


   models = document_model_admin_client.list_document_models()

   print("We have the following 'ready' models with IDs and descriptions:")
   for model in models:
       print(f"{model.model_id} | {model.description}")

list_operations

Вывод сведений для каждой операции.

Выводит список всех операций, связанных с ресурсом Распознаватель документов. Обратите внимание, что сведения об операциях сохраняются только в течение 24 часов. Если операция с моделью документа прошла успешно, доступ к модели документа можно получить с помощью get_document_model API или list_document_models .

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

Возвращаемое значение

Страничный файл OperationSummary.

Возвращаемый тип

ItemPaged[OperationSummary]

Исключения

HttpResponseError

Примеры

Перечисление всех операций модели документов за последние 24 часа.


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

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

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

   operations = list(document_model_admin_client.list_operations())

   print("The following document model operations exist under my resource:")
   for operation in operations:
       print(f"\nOperation ID: {operation.operation_id}")
       print(f"Operation kind: {operation.kind}")
       print(f"Operation status: {operation.status}")
       print(f"Operation percent completed: {operation.percent_completed}")
       print(f"Operation created on: {operation.created_on}")
       print(f"Operation last updated on: {operation.last_updated_on}")
       print(
           f"Resource location of successful operation: {operation.resource_location}"
       )

send_request

Выполняет сетевой запрос, используя существующий конвейер клиента.

URL-адрес запроса может быть относительно базового URL-адреса. Версия API службы, используемая для запроса, совпадает с версией клиента, если не указано иное. Переопределение настроенной версии API клиента в относительном URL-адресе поддерживается на клиенте с API версии 2022-08-31 и более поздних версий. Переопределение в абсолютном URL-адресе, поддерживаемом на клиенте с любой версией API. Этот метод не вызывает, если ответ является ошибкой; чтобы вызвать исключение, вызовите raise_for_status() для возвращенного объекта ответа. Дополнительные сведения об отправке пользовательских запросов с помощью этого метода см. в разделе https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Параметры

request: HttpRequest

Обязательно

Сетевой запрос, который вы хотите выполнить.

stream: bool

Будет ли потоковая передача полезных данных ответа. Значение по умолчанию — False.

Возвращаемое значение

Ответ сетевого вызова. Не обрабатывает ошибки в ответе.

Возвращаемый тип

HttpResponse

Исключения

HttpResponseError

Поделиться через

DocumentModelAdministrationClient Класс

Конструктор

Параметры

Примеры

Методы

begin_build_document_classifier

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

begin_build_document_model

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

begin_compose_document_model

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

begin_copy_document_model_to

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

close

Исключения

delete_document_classifier

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

delete_document_model

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

get_copy_authorization

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

get_document_analysis_client

Возвращаемое значение

Возвращаемый тип

Исключения

get_document_classifier

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

get_document_model

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

get_operation

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

get_resource_details

Возвращаемое значение

Возвращаемый тип

Исключения

Примеры

list_document_classifiers

Возвращаемое значение

Возвращаемый тип

Исключения