DocumentModelAdministrationClient クラス

リファレンス

DocumentModelAdministrationClient は、モデルの構築と管理に使用するForm Recognizer インターフェイスです。

モデルと分類子を構築するためのメソッドと、モデルと分類子の表示と削除、モデルと分類子の操作の表示、アカウント情報へのアクセス、別のForm Recognizer リソースへのモデルのコピー、既存のモデルのコレクションからの新しいモデルの作成を行うメソッドを提供します。

注意

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

必須

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 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	カスタムドキュメントモデルを構築します。要求には、外部からアクセス可能な Azure ストレージ BLOB コンテナー URI (できれば Shared Access Signature URI) である blob_container_url キーワード (keyword) パラメーターを含める必要があります。コンテナー URI (SAS なし) は、コンテナーがパブリックであるか、マネージド ID が構成されている場合にのみ受け入れられることに注意してください。マネージド ID の構成に関する詳細については、Form Recognizerhttps://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	既存のモデルのコレクションから構成されたドキュメントモデルを作成します。構成済みモデルを使用すると、1 つのモデル ID で複数のモデルを呼び出すことができます。作成済みのモデル ID を使用して分析するドキュメントが送信されると、分類ステップが最初に実行され、適切なカスタムモデルにルーティングされます。
begin_copy_document_model_to	このリソース (ソース) に格納されているドキュメントモデルを、ユーザー指定のターゲット Form Recognizer リソースにコピーします。これは、ソース Form Recognizer リソース (コピー対象のモデル) で呼び出す必要があります。ターゲットパラメーターは、メソッドの呼び出しからのターゲットリソースの出力から指定するget_copy_authorization必要があります。
close	セッションを DocumentModelAdministrationClient 閉じます。
delete_document_classifier	ドキュメント分類子を削除します。バージョン 2023-07-31 の新機能: delete_document_classifier クライアントメソッド。
delete_document_model	カスタムドキュメントモデルを削除します。
get_copy_authorization	カスタムモデルをターゲット Form Recognizer リソースにコピーするための承認を生成します。これはターゲットリソース (モデルのコピー先) によって呼び出され、出力はターゲットパラメーターとしてに 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 で操作を取得します。 Form Recognizer リソースに関連付けられている操作を取得します。操作情報は 24 時間のみ保持されることに注意してください。ドキュメントモデル操作が成功した場合は、または list_document_models API を使用してモデルにget_document_modelアクセスできます。
get_resource_details	Form Recognizer リソースのモデルに関する情報を取得します。
list_document_classifiers	分類子 ID、説明、作成日時など、各ドキュメント分類子の情報を一覧表示します。バージョン 2023-07-31 の新機能: list_document_classifiers クライアントメソッド。
list_document_models	モデル ID、説明、作成日時など、各モデルの情報を一覧表示します。
list_operations	各操作の情報を一覧表示します。 Form Recognizer リソースに関連付けられているすべての操作を一覧表示します。操作情報は 24 時間のみ保持されることに注意してください。ドキュメントモデル操作が成功した場合は、または list_document_models API を使用してドキュメントモデルにget_document_modelアクセスできます。
send_request	クライアントの既存のパイプラインを使用してネットワーク要求を実行します。要求 URL は、ベース URL に対する相対 URL にすることができます。要求に使用されるサービス API のバージョンは、特に指定がない限り、クライアントのと同じです。クライアントの構成済み API バージョンを相対 URL でオーバーライドすることは、API バージョン 2022-08-31 以降のクライアントでサポートされています。任意の 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 のインスタンス。 poller オブジェクトで 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

カスタムドキュメントモデルを構築します。

要求には、外部からアクセス可能な Azure ストレージ BLOB コンテナー URI (できれば Shared Access Signature URI) である blob_container_url キーワード (keyword) パラメーターを含める必要があります。コンテナー URI (SAS なし) は、コンテナーがパブリックであるか、マネージド ID が構成されている場合にのみ受け入れられることに注意してください。マネージド ID の構成に関する詳細については、Form Recognizerhttps://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 Storage BLOB コンテナーの SAS URI。コンテナーがパブリックであるか、マネージド ID が構成されている場合は、コンテナー URI (SAS なし) を使用できます。トレーニングデータセットの設定の詳細については、次を参照してください。 https://aka.ms/azsdk/formrecognizer/buildtrainingset

model_id: str

モデルの一意の ID。指定しない場合は、モデル ID が自動的に作成されます。

description: str

モデルに追加する説明 (省略可能)。

prefix: str

BLOB コンテナーの URL パス内のドキュメントをフィルター処理するための大文字と小文字を区別するプレフィックス文字列。たとえば、Azure ストレージ BLOB URI を使用する場合は、プレフィックスを使用してサブフォルダーを制限します。 ファイル 名が同じプレフィックスを共有する場合を避けるために、プレフィックスは '/' で終わる必要があります。

file_list: str

トレーニング用のドキュメントのサブセットを指定するコンテナー内の JSONL ファイルへのパス。

tags: dict[str, str]

モデルに関連付けられているユーザー定義のキーと値のタグ属性の一覧。

戻り値

DocumentModelAdministrationLROPoller のインスタンス。 poller オブジェクトで 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

既存のモデルのコレクションから構成されたドキュメントモデルを作成します。

構成済みモデルを使用すると、1 つのモデル 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 のインスタンス。 poller オブジェクトで 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

このリソース (ソース) に格納されているドキュメントモデルを、ユーザー指定のターゲット Form Recognizer リソースにコピーします。

これは、ソース Form Recognizer リソース (コピー対象のモデル) で呼び出す必要があります。 ターゲット パラメーターは、メソッドの呼び出しからのターゲットリソースの出力から指定する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 のインスタンス。 poller オブジェクトで 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

カスタムモデルをターゲット Form Recognizer リソースにコピーするための承認を生成します。

これはターゲットリソース (モデルのコピー先) によって呼び出され、出力は ターゲット パラメーターとしてに 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 で操作を取得します。

Form Recognizer リソースに関連付けられている操作を取得します。操作情報は 24 時間のみ保持されることに注意してください。ドキュメントモデル操作が成功した場合は、または list_document_models API を使用してモデルにget_document_modelアクセスできます。

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

Form Recognizer リソースのモデルに関する情報を取得します。

get_resource_details(**kwargs: Any) -> ResourceDetails

戻り値

リソースの下のカスタムモデルの概要 - モデルの数と制限。

の戻り値の型 :

ResourceDetails

例外

HttpResponseError

例

Form Recognizer リソースのモデルの数と制限を取得します。


   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

例

Form Recognizer リソースの下に正常に構築されたすべての分類子を一覧表示します。


   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

例

Form Recognizer リソースの下で正常に構築されたすべてのモデルを一覧表示します。


   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

各操作の情報を一覧表示します。

Form Recognizer リソースに関連付けられているすべての操作を一覧表示します。操作情報は 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 に対する相対 URL にすることができます。要求に使用されるサービス API のバージョンは、特に指定がない限り、クライアントのと同じです。クライアントの構成済み API バージョンを相対 URL でオーバーライドすることは、API バージョン 2022-08-31 以降のクライアントでサポートされています。任意の 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

戻り値

の戻り値の型 :

例外