Python 用 Azure Form Recognizer クライアントライブラリ - バージョン 3.3.2

[アーティクル]
11/07/2023

Azure Document Intelligence (以前は Form Recognizer と呼ばられていました) は、機械学習を使用してドキュメントのテキストと構造化データを分析するクラウドサービスです。これには、次のメイン機能が含まれています。

レイアウト - ドキュメントからコンテンツと構造 (単語、選択マーク、テーブルなど) を抽出します。
ドキュメント - ドキュメントからの一般的なレイアウトに加えて、キーと値のペアを分析します。
読み取り - ドキュメントからページ情報を読み取ります。
事前構築済み - 事前構築済みモデルを使用して、選択したドキュメントの種類 (領収書、請求書、名刺、ID ドキュメント、米国 W-2 税ドキュメントなど) から共通フィールド値を抽出します。
カスタム - 独自のデータからカスタムモデルを構築し、ドキュメントから一般的なレイアウトに加えて、調整されたフィールド値を抽出します。
分類子 - レイアウト機能と言語機能を組み合わせて、アプリケーション内で処理するドキュメントを正確に検出して識別するカスタム分類モデルを構築します。
アドオン機能 - バーコード/QR コード、数式、フォント/スタイルなどを抽出するか、省略可能なパラメーターを持つ大きなドキュメントに対して高解像度モードを有効にします。

作業の開始

前提条件

このパッケージを使用するには、Python 3.7 以降が必要です。
このパッケージを使用するには、Azure サブスクリプションと Cognitive Services または Form Recognizer リソースが必要です。

パッケージをインストールする

pip を使用して Python 用 Azure Form Recognizer クライアントライブラリをインストールします。

pip install azure-ai-formrecognizer

注: このバージョンのクライアントライブラリは、既定でサービスの 2023-07-31 バージョンになります。

SDK のバージョンとサービスのサポートされる API バージョンの関係を次の表に示します。

SDK バージョン	サポートされている API バージョンのサービス
3.3.X - 最新の GA リリース	2.0、2.1、2022-08-31、2023-07-31 (既定値)
3.2.X	2.0、2.1、2022-08-31 (既定値)
3.1.X	2.0、2.1 (既定値)
3.0.0	2.0

注: バージョン 3.2.X以降では、ドキュメントインテリジェンスサービスの最新機能を活用するために、新しいクライアントセットが導入されました。クライアントライブラリのバージョン以下から最新バージョン3.1.Xにアプリケーションコードを更新する方法の詳細については、移行ガイドを参照してください。さらに、詳細については、Changelog を参照してください。次の表は、各クライアントとそのサポートされている API バージョンの関係を示しています。

API バージョン	サポートされるクライアント
2023-07-31	DocumentAnalysisClient と DocumentModelAdministrationClient
2022-08-31	DocumentAnalysisClient と DocumentModelAdministrationClient
2.1	FormRecognizerClient と FormTrainingClient
2.0	FormRecognizerClient と FormTrainingClient

Cognitive Services または Form Recognizer リソースを作成する

ドキュメントインテリジェンスでは、マルチサービスアクセスと単一サービスアクセスの両方がサポートされます。 1 つのエンドポイント/キーで複数の Cognitive Services にアクセスする予定の場合は、Cognitive Services リソースを作成します。ドキュメントインテリジェンスアクセスのみの場合は、Form Recognizer リソースを作成します。 Azure Active Directory 認証を使用する場合は、単一サービスリソースが必要であることに注意してください。

次を使用して、いずれかのリソースを作成できます。

オプション 1: Azure Portal。
オプション 2: Azure CLI。

CLI を使用してForm Recognizer リソースを作成する方法の例を次に示します。

# Create a new resource group to hold the Form Recognizer resource
# if using an existing resource group, skip this step
az group create --name <your-resource-name> --location <location>

# Create form recognizer
az cognitiveservices account create \
    --name <your-resource-name> \
    --resource-group <your-resource-group-name> \
    --kind FormRecognizer \
    --sku <sku> \
    --location <location> \
    --yes

リソースの作成の詳細、または場所と SKU の情報を取得する方法については、こちらを参照してください。

クライアントを認証する

ドキュメントインテリジェンスサービスを操作するには、クライアントのインスタンスを作成する必要があります。クライアントオブジェクトをインスタンス化するには、 エンドポイント と 資格情報 が必要です。

エンドポイントを取得する

Form Recognizer リソースのエンドポイントは、Azure Portal または Azure CLI を使用して確認できます。

# Get the endpoint for the Form Recognizer resource
az cognitiveservices account show --name "resource-name" --resource-group "resource-group-name" --query "properties.endpoint"

リージョンエンドポイントまたはカスタムサブドメインを認証に使用できます。これらは次のように書式設定されます。

Regional endpoint: https://<region>.api.cognitive.microsoft.com/
Custom subdomain: https://<resource-name>.cognitiveservices.azure.com/

リージョンエンドポイントは、リージョン内のすべてのリソースで同じです。サポートされているリージョンエンドポイントの完全な一覧については、こちらを参照してください。リージョンエンドポイントでは AAD 認証がサポートされないことに注意してください。

一方、カスタムサブドメインは、Form Recognizer リソースに固有の名前です。これらは、単一サービスリソースでのみ使用できます。

API キーを取得する

API キーは、Azure Portal で、または次の Azure CLI コマンドを実行して見つけることができます。

az cognitiveservices account keys list --name "<resource-name>" --resource-group "<resource-group-name>"

AzureKeyCredential を使用してクライアントを作成する

API キーをパラメーターとしてcredential使用するには、キーを文字列として AzureKeyCredential のインスタンスに渡します。

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

endpoint = "https://<my-custom-subdomain>.cognitiveservices.azure.com/"
credential = AzureKeyCredential("<api_key>")
document_analysis_client = DocumentAnalysisClient(endpoint, credential)

Azure Active Directory 資格情報を使用してクライアントを作成する

AzureKeyCredential 認証は、このファーストステップガイドの例で使用しますが、 azure-identity ライブラリを使用して Azure Active Directory で認証することもできます。リージョンエンドポイントでは AAD 認証がサポートされないことに注意してください。この種類の認証を使用するために、リソースのカスタムサブドメイン名を作成します。

次に示す DefaultAzureCredential 型、または Azure SDK で提供されているその他の資格情報の種類を使用するには、パッケージを azure-identity インストールしてください。

pip install azure-identity

また、サービスプリンシパルにロールを割り当てることで、新しい AAD アプリケーションを "Cognitive Services User" 登録し、ドキュメントインテリジェンスへのアクセス権を付与する必要もあります。

完了したら、AAD アプリケーションのクライアント ID、テナント ID、およびクライアントシークレットの値を環境変数として設定します。 AZURE_CLIENT_IDAZURE_TENANT_IDAZURE_CLIENT_SECRET

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

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

document_analysis_client = DocumentAnalysisClient(endpoint, credential)

主要な概念

DocumentAnalysisClient

DocumentAnalysisClientでは、 API と API を介して事前構築済みモデルとカスタムモデルを使用して入力ドキュメントを分析する操作がbegin_analyze_documentbegin_analyze_document_from_url提供されます。パラメーターを model_id 使用して、分析するモデルの種類を選択します。サポートされているモデルの完全な一覧については、こちらを参照してください。 DocumentAnalysisClientには、 API と begin_classify_document_from_url API を使用してbegin_classify_documentドキュメントを分類するための操作も用意されています。カスタム分類モデルは、入力ファイル内の各ページを分類してその中のドキュメントを識別できます。また、入力ファイル内の複数のドキュメントまたは 1 つのドキュメントの複数のインスタンスを識別することもできます。

サンプルコードスニペットは、DocumentAnalysisClient をここに示すために用意されています。サポートされている機能、ロケール、ドキュメントの種類など、ドキュメントの分析の詳細については、サービスドキュメントを参照してください。

DocumentModelAdministrationClient

DocumentModelAdministrationClient には、以下を目的とした操作が用意されています。

カスタムドキュメントにラベルを付けることで、指定した特定のフィールドを分析するカスタムモデルを構築します。 DocumentModelDetailsモデルが分析できるドキュメントの種類と、各フィールドの推定信頼度を示すが返されます。詳細な説明については、サービスのドキュメントを参照してください。
既存のモデルのコレクションから構成済みモデルを作成する。
アカウントに作成されたモデルを管理する。
操作を一覧表示するか、過去 24 時間以内に作成された特定のモデル操作を取得します。
Form Recognizer リソース間でカスタムモデルをコピーする。
カスタム分類モデルを構築して管理し、アプリケーション内で処理するドキュメントを分類します。

Document Intelligence Studio などのグラフィカルユーザーインターフェイスを使用してモデルを構築することもできます。

サンプルコードスニペットは、DocumentModelAdministrationClient 示すために提供されています。

長時間にわたって実行される操作

実行時間の長い操作は、操作を開始するためにサービスに送信された最初の要求で構成される操作です。その後、間隔を指定してサービスをポーリングして、操作が完了したか失敗したか、成功したかどうかを判断して結果を取得します。

ドキュメントの分析、モデルの構築、またはモデルのコピー/作成を行うメソッドは、実行時間の長い操作としてモデル化されます。クライアントは、または AsyncLROPollerをbegin_<method-name>返すメソッドをLROPoller公開します。呼び出し元は、メソッドから返された poller オブジェクトを呼び出 result() して、操作が完了するまで待機する begin_<method-name> 必要があります。実行時間の長い操作の使用例を示すサンプルコードスニペット用意されています。

例

次のセクションでは、次のような最も一般的なドキュメントインテリジェンスタスクの一部をカバーするいくつかのコードスニペットを示します。

レイアウトの抽出
一般的なドキュメントモデルの使用
事前構築済みモデルの使用
カスタムモデルを構築する
カスタムモデルを使用してドキュメントを分析する
モデルの管理
ドキュメントの分類
アドオン機能

レイアウトの抽出

文書から、テキスト、選択マーク、テキストスタイル、およびテーブル構造とその境界領域座標を抽出します。

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

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

document_analysis_client = DocumentAnalysisClient(
    endpoint=endpoint, credential=AzureKeyCredential(key)
)
with open(path_to_sample_documents, "rb") as f:
    poller = document_analysis_client.begin_analyze_document(
        "prebuilt-layout", document=f
    )
result = poller.result()

for idx, style in enumerate(result.styles):
    print(
        "Document contains {} content".format(
            "handwritten" if style.is_handwritten else "no handwritten"
        )
    )

for page in result.pages:
    print("----Analyzing layout from page #{}----".format(page.page_number))
    print(
        "Page has width: {} and height: {}, measured with unit: {}".format(
            page.width, page.height, page.unit
        )
    )

    for line_idx, line in enumerate(page.lines):
        words = line.get_words()
        print(
            "...Line # {} has word count {} and text '{}' within bounding polygon '{}'".format(
                line_idx,
                len(words),
                line.content,
                line.polygon,
            )
        )

        for word in words:
            print(
                "......Word '{}' has a confidence of {}".format(
                    word.content, word.confidence
                )
            )

    for selection_mark in page.selection_marks:
        print(
            "...Selection mark is '{}' within bounding polygon '{}' and has a confidence of {}".format(
                selection_mark.state,
                selection_mark.polygon,
                selection_mark.confidence,
            )
        )

for table_idx, table in enumerate(result.tables):
    print(
        "Table # {} has {} rows and {} columns".format(
            table_idx, table.row_count, table.column_count
        )
    )
    for region in table.bounding_regions:
        print(
            "Table # {} location on page: {} is {}".format(
                table_idx,
                region.page_number,
                region.polygon,
            )
        )
    for cell in table.cells:
        print(
            "...Cell[{}][{}] has content '{}'".format(
                cell.row_index,
                cell.column_index,
                cell.content,
            )
        )
        for region in cell.bounding_regions:
            print(
                "...content on page {} is within bounding polygon '{}'".format(
                    region.page_number,
                    region.polygon,
                )
            )

print("----------------------------------------")

一般的なドキュメントモデルの使用

ドキュメントインテリジェンスサービスによって提供される一般的なドキュメントモデルを使用して、ドキュメントのキーと値のペア、テーブル、スタイル、および選択マークを分析します。メソッドにを渡 model_id="prebuilt-document" して、一般ドキュメントモデルを begin_analyze_document 選択します。

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

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

document_analysis_client = DocumentAnalysisClient(
    endpoint=endpoint, credential=AzureKeyCredential(key)
)
with open(path_to_sample_documents, "rb") as f:
    poller = document_analysis_client.begin_analyze_document(
        "prebuilt-document", document=f
    )
result = poller.result()

for style in result.styles:
    if style.is_handwritten:
        print("Document contains handwritten content: ")
        print(",".join([result.content[span.offset:span.offset + span.length] for span in style.spans]))

print("----Key-value pairs found in document----")
for kv_pair in result.key_value_pairs:
    if kv_pair.key:
        print(
                "Key '{}' found within '{}' bounding regions".format(
                    kv_pair.key.content,
                    kv_pair.key.bounding_regions,
                )
            )
    if kv_pair.value:
        print(
                "Value '{}' found within '{}' bounding regions\n".format(
                    kv_pair.value.content,
                    kv_pair.value.bounding_regions,
                )
            )

for page in result.pages:
    print("----Analyzing document from page #{}----".format(page.page_number))
    print(
        "Page has width: {} and height: {}, measured with unit: {}".format(
            page.width, page.height, page.unit
        )
    )

    for line_idx, line in enumerate(page.lines):
        words = line.get_words()
        print(
            "...Line # {} has {} words and text '{}' within bounding polygon '{}'".format(
                line_idx,
                len(words),
                line.content,
                line.polygon,
            )
        )

        for word in words:
            print(
                "......Word '{}' has a confidence of {}".format(
                    word.content, word.confidence
                )
            )

    for selection_mark in page.selection_marks:
        print(
            "...Selection mark is '{}' within bounding polygon '{}' and has a confidence of {}".format(
                selection_mark.state,
                selection_mark.polygon,
                selection_mark.confidence,
            )
        )

for table_idx, table in enumerate(result.tables):
    print(
        "Table # {} has {} rows and {} columns".format(
            table_idx, table.row_count, table.column_count
        )
    )
    for region in table.bounding_regions:
        print(
            "Table # {} location on page: {} is {}".format(
                table_idx,
                region.page_number,
                region.polygon,
            )
        )
    for cell in table.cells:
        print(
            "...Cell[{}][{}] has content '{}'".format(
                cell.row_index,
                cell.column_index,
                cell.content,
            )
        )
        for region in cell.bounding_regions:
            print(
                "...content on page {} is within bounding polygon '{}'\n".format(
                    region.page_number,
                    region.polygon,
                )
            )
print("----------------------------------------")

モデルによって提供される機能の詳細については、prebuilt-documentこちらを参照してください。

事前構築済みモデルの使用

ドキュメントインテリジェンスサービスによって提供される事前構築済みモデルを使用して、領収書、請求書、名刺、ID ドキュメント、米国 W-2 税ドキュメントなどの一部のドキュメントの種類からフィールドを抽出します。

たとえば、売上受領書のフィールドを分析するには、メソッドにを渡 model_id="prebuilt-receipt" すことによって提供される事前構築済みのレシートモデルを begin_analyze_document 使用します。

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

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

document_analysis_client = DocumentAnalysisClient(
    endpoint=endpoint, credential=AzureKeyCredential(key)
)
with open(path_to_sample_documents, "rb") as f:
    poller = document_analysis_client.begin_analyze_document(
        "prebuilt-receipt", document=f, locale="en-US"
    )
receipts = poller.result()

for idx, receipt in enumerate(receipts.documents):
    print(f"--------Analysis of receipt #{idx + 1}--------")
    print(f"Receipt type: {receipt.doc_type if receipt.doc_type else 'N/A'}")
    merchant_name = receipt.fields.get("MerchantName")
    if merchant_name:
        print(
            f"Merchant Name: {merchant_name.value} has confidence: "
            f"{merchant_name.confidence}"
        )
    transaction_date = receipt.fields.get("TransactionDate")
    if transaction_date:
        print(
            f"Transaction Date: {transaction_date.value} has confidence: "
            f"{transaction_date.confidence}"
        )
    if receipt.fields.get("Items"):
        print("Receipt items:")
        for idx, item in enumerate(receipt.fields.get("Items").value):
            print(f"...Item #{idx + 1}")
            item_description = item.value.get("Description")
            if item_description:
                print(
                    f"......Item Description: {item_description.value} has confidence: "
                    f"{item_description.confidence}"
                )
            item_quantity = item.value.get("Quantity")
            if item_quantity:
                print(
                    f"......Item Quantity: {item_quantity.value} has confidence: "
                    f"{item_quantity.confidence}"
                )
            item_price = item.value.get("Price")
            if item_price:
                print(
                    f"......Individual Item Price: {item_price.value} has confidence: "
                    f"{item_price.confidence}"
                )
            item_total_price = item.value.get("TotalPrice")
            if item_total_price:
                print(
                    f"......Total Item Price: {item_total_price.value} has confidence: "
                    f"{item_total_price.confidence}"
                )
    subtotal = receipt.fields.get("Subtotal")
    if subtotal:
        print(f"Subtotal: {subtotal.value} has confidence: {subtotal.confidence}")
    tax = receipt.fields.get("TotalTax")
    if tax:
        print(f"Total tax: {tax.value} has confidence: {tax.confidence}")
    tip = receipt.fields.get("Tip")
    if tip:
        print(f"Tip: {tip.value} has confidence: {tip.confidence}")
    total = receipt.fields.get("Total")
    if total:
        print(f"Total: {total.value} has confidence: {total.confidence}")
    print("--------------------------------------")

レシートに限りません! いくつかの事前構築済みモデルから選択できます。それぞれのモデルには、サポートされているフィールドの独自のセットがあります。サポートされている他の事前構築済みモデルについては、こちらを参照してください。

カスタムモデルを構築する

独自のドキュメントの種類に基づいてカスタムモデルを構築します。結果のモデルを使用して、トレーニング対象のドキュメントの種類の値を分析できます。トレーニングドキュメントを格納する Azure Storage BLOB コンテナーにコンテナー SAS URL を指定します。

コンテナーの設定と必要なファイル構造の詳細については、サービスドキュメントを参照してください。

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]}"
        )

カスタムモデルを使用してドキュメントを分析する

ドキュメントフィールド、テーブル、選択マークなどを分析します。これらのモデルは独自のデータでトレーニングされるため、ドキュメントに合わせて調整されます。最良の結果を得るには、カスタムモデルが作成されたのと同じ種類のドキュメントのみを分析する必要があります。

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

endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
model_id = os.getenv("CUSTOM_BUILT_MODEL_ID", custom_model_id)

document_analysis_client = DocumentAnalysisClient(
    endpoint=endpoint, credential=AzureKeyCredential(key)
)

# Make sure your document's type is included in the list of document types the custom model can analyze
with open(path_to_sample_documents, "rb") as f:
    poller = document_analysis_client.begin_analyze_document(
        model_id=model_id, document=f
    )
result = poller.result()

for idx, document in enumerate(result.documents):
    print(f"--------Analyzing document #{idx + 1}--------")
    print(f"Document has type {document.doc_type}")
    print(f"Document has document type confidence {document.confidence}")
    print(f"Document was analyzed with model with ID {result.model_id}")
    for name, field in document.fields.items():
        field_value = field.value if field.value else field.content
        print(
            f"......found field of type '{field.value_type}' with value '{field_value}' and with confidence {field.confidence}"
        )

# iterate over tables, lines, and selection marks on each page
for page in result.pages:
    print(f"\nLines found on page {page.page_number}")
    for line in page.lines:
        print(f"...Line '{line.content}'")
    for word in page.words:
        print(f"...Word '{word.content}' has a confidence of {word.confidence}")
    if page.selection_marks:
        print(f"\nSelection marks found on page {page.page_number}")
        for selection_mark in page.selection_marks:
            print(
                f"...Selection mark is '{selection_mark.state}' and has a confidence of {selection_mark.confidence}"
            )

for i, table in enumerate(result.tables):
    print(f"\nTable {i + 1} can be found on page:")
    for region in table.bounding_regions:
        print(f"...{region.page_number}")
    for cell in table.cells:
        print(
            f"...Cell[{cell.row_index}][{cell.column_index}] has text '{cell.content}'"
        )
print("-----------------------------------")

または、ドキュメント URL を使用して、メソッドを使用してドキュメントを begin_analyze_document_from_url 分析することもできます。

document_url = "<url_of_the_document>"
poller = document_analysis_client.begin_analyze_document_from_url(model_id=model_id, document_url=document_url)
result = poller.result()

モデルの管理

アカウントにアタッチされているカスタムモデルを管理します。

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

endpoint = "https://<my-custom-subdomain>.cognitiveservices.azure.com/"
credential = AzureKeyCredential("<api_key>")

document_model_admin_client = DocumentModelAdministrationClient(endpoint, credential)

account_details = document_model_admin_client.get_resource_details()
print("Our account has {} custom models, and we can have at most {} custom models".format(
    account_details.custom_document_models.count, account_details.custom_document_models.limit
))

# Here we get a paged list of all of our models
models = document_model_admin_client.list_document_models()
print("We have models with the following ids: {}".format(
    ", ".join([m.model_id for m in models])
))

# Replace with the custom model ID from the "Build a model" sample
model_id = "<model_id from the Build a Model sample>"

custom_model = document_model_admin_client.get_document_model(model_id=model_id)
print("Model ID: {}".format(custom_model.model_id))
print("Description: {}".format(custom_model.description))
print("Model created on: {}\n".format(custom_model.created_on))

# Finally, we will delete this model by ID
document_model_admin_client.delete_document_model(model_id=custom_model.model_id)

try:
    document_model_admin_client.get_document_model(model_id=custom_model.model_id)
except ResourceNotFoundError:
    print("Successfully deleted model with id {}".format(custom_model.model_id))

アドオン機能

ドキュメントインテリジェンスでは、より高度な分析機能がサポートされています。これらのオプション機能は、ドキュメント抽出のシナリオに応じて有効または無効にすることができます。

2023-07-31 (GA) 以降のリリースでは、次のアドオン機能を使用できます。

一部のアドオン機能では追加料金が発生します。「価格: https://azure.microsoft.com/pricing/details/ai-document-intelligence/」を参照してください。

トラブルシューティング

全般

クライアントライブラリForm Recognizer、Azure Core で定義されている例外が発生します。ドキュメントインテリジェンスサービスによって発生するエラーコードとメッセージは、サービスドキュメントにあります。

ログの記録

このライブラリでは、ログ記録に標準のログライブラリが使用されます。

HTTP セッション (URL、ヘッダーなど) に関する基本情報は、レベルで INFO ログに記録されます。

要求/応答本文や未処理ヘッダーなど、詳細なDEBUGレベルのログ記録は、クライアントで有効にすることも、キーワード (keyword)引数を使用してlogging_enable操作ごとに有効にすることもできます。

SDK ログに関する完全なドキュメントと例については、こちらを参照してください。

オプションの構成

省略可能なキーワード (keyword)引数は、クライアントと操作ごとのレベルで渡すことができます。 azure-core リファレンスドキュメントでは、再試行、ログ記録、トランスポートプロトコルなどの使用可能な構成について説明しています。

次のステップ

その他のサンプルコード

Form Recognizer Python API で使用される一般的なパターンを示すいくつかのコードスニペットについては、サンプル README を参照してください。

その他のドキュメント

Azure AI ドキュメントインテリジェンスに関するより広範なドキュメントについては、docs.microsoft.com に関するドキュメントインテリジェンスに関するドキュメントを参照してください。

共同作成

このプロジェクトでは、共同作成と提案を歓迎しています。ほとんどの共同作成では、共同作成者使用許諾契約書 (CLA) にご同意いただき、ご自身の共同作成内容を使用する権利を Microsoft に供与する権利をお持ちであり、かつ実際に供与することを宣言していただく必要があります。詳細については、「 cla.microsoft.com」を参照してください。

pull request を送信すると、CLA を提供して PR (ラベル、コメントなど) を適宜装飾する必要があるかどうかを CLA ボットが自動的に決定します。ボットによって提供される手順にそのまま従ってください。この操作は、Microsoft の CLA を使用するすべてのリポジトリについて、1 回だけ行う必要があります。

このプロジェクトでは、Microsoft オープンソースの倫理規定を採用しています。詳しくは、「Code of Conduct FAQ (倫理規定についてよくある質問)」を参照するか、opencode@microsoft.com 宛てに質問またはコメントをお送りください。

次の方法で共有

Python 用 Azure Form Recognizer クライアントライブラリ - バージョン 3.3.2

作業の開始

前提条件

パッケージをインストールする

Cognitive Services または Form Recognizer リソースを作成する

クライアントを認証する

エンドポイントを取得する

API キーを取得する

AzureKeyCredential を使用してクライアントを作成する

Azure Active Directory 資格情報を使用してクライアントを作成する

主要な概念

DocumentAnalysisClient

DocumentModelAdministrationClient

長時間にわたって実行される操作

例

レイアウトの抽出

一般的なドキュメントモデルの使用

事前構築済みモデルの使用

カスタムモデルを構築する

カスタムモデルを使用してドキュメントを分析する

モデルの管理

アドオン機能

トラブルシューティング

全般

ログの記録

オプションの構成

次のステップ

その他のサンプルコード

その他のドキュメント

共同作成

その他のリソース

次の方法で共有

Python 用 Azure Form Recognizer クライアント ライブラリ - バージョン 3.3.2

作業の開始

前提条件

パッケージをインストールする

Cognitive Services または Form Recognizer リソースを作成する

クライアントを認証する

エンドポイントを取得する

API キーを取得する

AzureKeyCredential を使用してクライアントを作成する

Azure Active Directory 資格情報を使用してクライアントを作成する

主要な概念

DocumentAnalysisClient

DocumentModelAdministrationClient

長時間にわたって実行される操作

例

レイアウトの抽出

一般的なドキュメント モデルの使用

事前構築済みモデルの使用

カスタム モデルを構築する

カスタム モデルを使用してドキュメントを分析する

モデルの管理

アドオン機能

トラブルシューティング

全般

ログの記録

オプションの構成

次のステップ

その他のサンプル コード

その他のドキュメント

共同作成

その他のリソース

Python 用 Azure Form Recognizer クライアントライブラリ - バージョン 3.3.2

一般的なドキュメントモデルの使用

カスタムモデルを構築する

カスタムモデルを使用してドキュメントを分析する

その他のサンプルコード