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 關鍵字參數，這是可外部存取的 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 關鍵字引數。
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	從 DocumentModelAdministrationClient 取得 DocumentAnalysisClient 的實例。
get_document_classifier	依其識別碼取得檔分類器。 2023-07-31 版的新功能： get_document_classifier 用戶端方法。
get_document_model	依識別碼取得檔模型。
get_operation	依識別碼取得作業。取得與表格辨識器資源相關聯的作業。請注意，作業資訊只會持續 24 小時。如果檔模型作業成功，可以使用或 list_document_models API 來存取 get_document_model 模型。
get_resource_details	取得表格辨識器資源下模型的相關資訊。
list_document_classifiers	列出每個檔分類器的資訊，包括其分類器識別碼、描述，以及建立時間。 2023-07-31 版的新功能： list_document_classifiers 用戶端方法。
list_document_models	列出每個模型的資訊，包括其模型識別碼、描述，以及建立時。
list_operations	列出每個作業的資訊。列出與表格辨識器資源相關聯的所有作業。請注意，作業資訊只會持續 24 小時。如果檔模型作業成功，可以使用或 list_document_models API 來存取 get_document_model 檔模型。
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

唯一的檔分類器名稱。如果未指定，將會為您建立分類器識別碼。

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 關鍵字參數，這是可外部存取的 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 關鍵字引數。

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

模型的唯一識別碼。如果未指定，將會為您建立模型識別碼。

description: str

要新增至模型的選擇性描述。

prefix: str

區分大小寫的前置詞字串，可篩選 Blob 容器 URL 路徑中的檔。例如，使用 Azure 儲存體 Blob URI 時，請使用前置詞來限制子資料夾。 前置詞 應該以 '/' 結尾，以避免檔案名共用相同前置詞的情況。

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

從 DocumentModelAdministrationClient 取得 DocumentAnalysisClient 的實例。

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 小時。如果檔模型作業成功，可以使用或 list_document_models API 來存取 get_document_model 模型。

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 小時。如果檔模型作業成功，可以使用或 list_document_models API 來存取 get_document_model 檔模型。

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

共用方式為

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

傳回

傳回類型

例外狀況