你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DocumentModelAdministrationClient 类

DocumentModelAdministrationClient 是用于生成和管理模型的表单识别器接口。

它提供用于生成模型和分类器的方法，以及用于查看和删除模型和分类器、查看模型和分类器操作、访问帐户信息、将模型复制到另一个表单识别器资源以及从现有模型集合撰写新模型的方法。

注意

DocumentModelAdministrationClient 应与 API 版本一起使用

2022-08-31 及最新版。 若要使用 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

必需

支持的认知服务终结点 (协议和主机名，例如： https://westus2.api.cognitive.microsoft.com) 。

credential

AzureKeyCredential 或 TokenCredential

必需

客户端连接到 Azure 所需的凭据。 如果使用 API 密钥或中的 identity令牌凭据，则这是 AzureKeyCredential 的实例。

api_version

str 或 DocumentAnalysisApiVersion

要用于请求的服务的 API 版本。 它默认为最新的服务版本。 设置为较旧版本可能会导致功能兼容性降低。 若要使用 API 版本 <=v2.1，请实例化 FormTrainingClient。

示例

使用终结点和 API 密钥创建 DocumentModelAdministrationClient。

   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 关键字 (keyword) 参数，该参数是可在外部访问的 Azure 存储 Blob 容器 URI， (最好是共享访问签名 URI) 。 请注意，仅当容器为公共或配置了托管标识时，才接受没有 SAS) 的容器 (URI，请参阅此处有关配置托管标识以使用表单识别器的详细信息：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 关键字 (keyword) 参数。
begin_compose_document_model	从现有模型集合创建组合文档模型。 组合模型允许使用单个模型 ID 调用多个模型。 提交要使用组合模型 ID 分析的文档时，首先会执行分类步骤以将其路由到正确的自定义模型。
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	从 DocumentModelAdministrationClient 获取 DocumentAnalysisClient 的实例。
get_document_classifier	按 ID 获取文档分类器。 版本 2023-07-31 中的新增功能： get_document_classifier 客户端方法。
get_document_model	按 ID 获取文档模型。
get_operation	按 ID 获取操作。 获取与表单识别器资源关联的操作。 请注意，操作信息仅保留 24 小时。 如果文档模型操作成功，则可以使用 get_document_model 或 list_document_models API 访问模型。
get_resource_details	获取有关表单识别器资源下的模型的信息。
list_document_classifiers	列出每个文档分类器的信息，包括其分类器 ID、说明和创建时间。 版本 2023-07-31 中的新增功能： list_document_classifiers 客户端方法。
list_document_models	列出每个模型的信息，包括其模型 ID、说明和创建时间。
list_operations	列出每个操作的信息。 列出与表单识别器资源关联的所有操作。 请注意，操作信息仅保留 24 小时。 如果文档模型操作成功，则可以使用 get_document_model 或 list_document_models API 访问文档模型。
send_request	使用客户端的现有管道运行网络请求。 请求 URL 可以相对于基 URL。 除非另有指定，否则用于请求的服务 API 版本与客户端的版本相同。 使用 API 版本 2022-08-31 及更高版本的客户端支持在相对 URL 中替代客户端配置的 API 版本。 使用任何 API 版本在客户端上支持的绝对 URL 中重写。 如果响应是错误，则此方法不会引发;若要引发异常，请对返回的响应对象调用 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

唯一的文档分类器名称。 如果未指定，将为你创建分类器 ID。

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 关键字 (keyword) 参数，该参数是可在外部访问的 Azure 存储 Blob 容器 URI， (最好是共享访问签名 URI) 。 请注意，仅当容器为公共或配置了托管标识时，才接受没有 SAS) 的容器 (URI，请参阅此处有关配置托管标识以使用表单识别器的详细信息：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 关键字 (keyword) 参数。

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

Azure 存储 Blob 容器的 SAS URI。 如果容器 (是公共的，或者配置了托管标识，则可以使用没有 SAS) 的容器 URI。 有关设置训练数据集的详细信息，请参阅： https://aka.ms/azsdk/formrecognizer/buildtrainingset。

model_id

str

模型的唯一 ID。 如果未指定，则会为你创建一个模型 ID。

description

str

要添加到模型的可选说明。

prefix

str

一个区分大小写的前缀字符串，用于筛选 Blob 容器 URL 路径中的文档。 例如，使用 Azure 存储 Blob URI 时，请使用 前缀来限制子文件夹。 prefix 应以“/”结尾，以避免文件名共享同一前缀的情况。

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

从现有模型集合创建组合文档模型。

组合模型允许使用单个模型 ID 调用多个模型。 提交要使用组合模型 ID 分析的文档时，首先会执行分类步骤以将其路由到正确的自定义模型。

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

参数

component_model_ids

list[str]

必需

在组合模型中使用的模型 ID 列表。

model_id

str

组合模型的唯一 ID。 如果未指定，则会为你创建一个模型 ID。

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

复制模型的唯一 ID。 如果未指定，则会为你创建一个模型 ID。

description

str

要添加到模型的可选说明。

tags

dict[str, str]

与模型关联的用户定义的键值标记属性的列表。

返回

具有复制授权所需的值的字典。

返回类型

<xref:azure.ai.formrecognizer.TargetAuthorization>

例外

HttpResponseError

get_document_analysis_client

从 DocumentModelAdministrationClient 获取 DocumentAnalysisClient 的实例。

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

返回

A DocumentAnalysisClient

返回类型

DocumentAnalysisClient

例外

HttpResponseError

get_document_classifier

按 ID 获取文档分类器。

版本 2023-07-31 中的新增功能： get_document_classifier 客户端方法。

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

参数

classifier_id

str

必需

分类器标识符。

返回

DocumentClassifierDetails

返回类型

DocumentClassifierDetails

例外

HttpResponseError

ResourceNotFoundError

示例

按 ID 获取分类器。

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

get_document_model

按 ID 获取文档模型。

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

参数

model_id

str

必需

模型标识符。

返回

DocumentModelDetails

返回类型

DocumentModelDetails

例外

HttpResponseError

ResourceNotFoundError

示例

按 ID 获取模型。

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

get_operation

按 ID 获取操作。

获取与表单识别器资源关联的操作。 请注意，操作信息仅保留 24 小时。 如果文档模型操作成功，则可以使用 get_document_model 或 list_document_models API 访问模型。

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

参数

operation_id

str

必需

操作 ID。

返回

OperationDetails

返回类型

OperationDetails

例外

HttpResponseError

示例

按 ID 获取文档模型操作。

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

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

列出每个文档分类器的信息，包括其分类器 ID、说明和创建时间。

版本 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

列出每个模型的信息，包括其模型 ID、说明和创建时间。

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 或 list_document_models API 访问文档模型。

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 版本 2022-08-31 及更高版本的客户端支持在相对 URL 中替代客户端配置的 API 版本。 使用任何 API 版本在客户端上支持的绝对 URL 中重写。 如果响应是错误，则此方法不会引发;若要引发异常，请对返回的响应对象调用 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