SDK の対象: 最新の REST API 2023-07-31 (GA)
[アーティクル] 11/21/2023
2 人の共同作成者
フィードバック
この記事の内容
REST API バージョン 2023-07-31 (GA)
Azure AI Document Intelligence は、機械学習を使用してドキュメントからのテキストと構造化データを分析するクラウド サービスです。 Document Intelligence ソフトウェア開発キット (SDK) は、Document Intelligence のモデルと機能をアプリケーションに簡単に統合できる一連のライブラリとツールです。 Document Intelligence SDK は、C#/.NET、Java、JavaScript、Python プログラミング言語で、さまざまなプラットフォームで使用できます。
サポートされるプログラミング言語
Document Intelligence SDK では、次の言語とプラットフォームがサポートされています。
サポートされているクライアント
次の表は、ドキュメント インテリジェンス サービスでサポートされている API バージョンの各 SDK バージョン間の相関関係を示しています。
Language
SDK バージョン
API バージョン (既定)
サポートされるクライアント
.NET (C#) 4.1.0
v3.1 最新 (GA)
2023-07-31
DocumentAnalysisClient DocumentModelAdministrationClient
.NET/C# 4.0.0
v3.0 (GA)
2022-08-31
DocumentAnalysisClient DocumentModelAdministrationClient
.NET/C# 3.1.x
v2.1
v2.1
FormRecognizerClient FormTrainingClient
.NET/C# 3.0.x
v2.0
v2.0
FormRecognizerClient FormTrainingClient
Language
SDK バージョン
API バージョン
サポートされるクライアント
Java 4.1.0
v3.1 最新 (GA)
2023-07-31 (既定)
DocumentAnalysisClient DocumentModelAdministrationClient
Java 4.0.0
v3.0 (GA)
2022-08-31
DocumentAnalysisClient DocumentModelAdministrationClient
Java 3.1.x
v2.1
v2.1
FormRecognizerClient FormTrainingClient
Java 3.0.x
v2.0
v2.0
FormRecognizerClient FormTrainingClient
Language
SDK バージョン
API バージョン (既定)
サポートされるクライアント
JavaScript 5.0.0
v3.1 最新 (GA)
2023-07-31 (既定)
DocumentAnalysisClient DocumentModelAdministrationClient
JavaScript 4.0.0
v3.0 (GA)
2022-08-31
DocumentAnalysisClient DocumentModelAdministrationClient
JavaScript 3.1.x
v2.1
v2.1
FormRecognizerClient FormTrainingClient
JavaScript 3.0.x
v2.0
v2.0
FormRecognizerClient FormTrainingClient
Language
SDK バージョン
API バージョン (既定)
サポートされるクライアント
Python 3.3.0
v3.1 (最新 (GA)
2023-07-31 (既定)
DocumentAnalysisClient DocumentModelAdministrationClient
Python 3.2.x
v3.0 (GA)
2022-08-31
DocumentAnalysisClient DocumentModelAdministrationClient
Python 3.1.x
v2.1
v2.1
FormRecognizerClient FormTrainingClient
Python 3.0.0
v2.0
v2.0
FormRecognizerClient FormTrainingClient
アプリケーションで Document Intelligence SDK を使用する
Document Intelligence SDK を使用すると、アプリケーションで Document Intelligence サービスを使用および管理できます。 SDK は、基になる Document Intelligence REST API に基づいて構築されていて、プログラミング言語パラダイム内でこれらの API を簡単に使用できます。 Document Intelligence SDK を任意の言語で使用する方法を次に示します。
1. SDK クライアント ライブラリをインストールする
dotnet add package Azure.AI.FormRecognizer --version 4.1.0
Install-Package Azure.AI.FormRecognizer -Version 4.1.0
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-formrecognizer</artifactId>
<version>4.1.0</version>
</dependency>
implementation("com.azure:azure-ai-formrecognizer:4.1.0")
npm i @azure/ai-form-recognizer@5.0.0
pip install azure-ai-formrecognizer==3.3.0
2. SDK クライアント ライブラリをアプリケーションにインポートする
using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;
import com.azure.ai.formrecognizer.*;
import com.azure.ai.formrecognizer.models.*;
import com.azure.ai.formrecognizer.DocumentAnalysisClient.*;
import com.azure.core.credential.AzureKeyCredential;
const { AzureKeyCredential, DocumentAnalysisClient } = require("@azure/ai-form-recognizer");
from azure.ai.formrecognizer import DocumentAnalysisClient
from azure.core.credentials import AzureKeyCredential
3. 認証を設定する
認証には 2 つの方法がサポートされています
API キーを使用する
Azure portal で Document Intelligence API キーを見つける場所を次に示します。
//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `DocumentAnalysisClient` instance
string key = "<your-key>";
string endpoint = "<your-endpoint>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);
// create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
DocumentAnalysisClient client = new DocumentAnalysisClientBuilder()
.credential(new AzureKeyCredential("<your-key>"))
.endpoint("<your-endpoint>")
.buildClient();
// create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
async function main() {
const client = new DocumentAnalysisClient("<your-endpoint>", new AzureKeyCredential("<your-key>"));
# create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
document_analysis_client = DocumentAnalysisClient(endpoint="<your-endpoint>", credential=AzureKeyCredential("<your-key>"))
Microsoft Entra トークン資格情報を使用する
Note
リージョン エンドポイントでは、Microsoft Entra 認証がサポートされていません。 この種類の認証を使用するために、リソースのカスタム サブドメイン を作成します。
承認は、DefaultAzureCredential
を使用するのが最も簡単です。 実行中の環境に基づいて、ほとんどの Azure 認証シナリオを処理できる既定のトークン資格情報が提供されます。
.NET アプリケーションの DefaultAzureCredential を取得して使用する方法を次に示します。
.NET 用の Azure ID ライブラリ をインストールします。
dotnet add package Azure.Identity
Install-Package Azure.Identity
Microsoft Entra アプリケーションを登録し、新しいサービス プリンシパルを作成します 。
サービス プリンシパルに Cognitive Services User
ロールを割り当てて Document Intelligence へのアクセス権を付与します。
Microsoft Entra アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値をそれぞれ環境変数 AZURE_CLIENT_ID
、AZURE_TENANT_ID
、AZURE_CLIENT_SECRET
として設定します。
DefaultAzureCredential
を含む DocumentAnalysisClient
インスタンスを作成します。
string endpoint = "<your-endpoint>";
var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
詳細については、「クライアントの認証 」を参照 してください。
Java アプリケーションの DefaultAzureCredential を取得して使用する方法を次に示します。
Java 用の Azure ID ライブラリ をインストールします。
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.5.3</version>
</dependency>
Microsoft Entra アプリケーションを登録し、新しいサービス プリンシパルを作成します 。
サービス プリンシパルに Cognitive Services User
ロールを割り当てて Document Intelligence へのアクセス権を付与します。
Microsoft Entra アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値をそれぞれ環境変数 AZURE_CLIENT_ID
、AZURE_TENANT_ID
、AZURE_CLIENT_SECRET
として設定します。
DocumentAnalysisClient
インスタンスと TokenCredential
変数を作成します。
TokenCredential credential = new DefaultAzureCredentialBuilder().build();
DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
.endpoint("{your-endpoint}")
.credential(credential)
.buildClient();
詳細については、「クライアントの認証 」を参照 してください。
JavaScript アプリケーションの DefaultAzureCredential を取得して使用する方法を次に示します。
JavaScript 用の Azure ID ライブラリ をインストールします。
npm install @azure/identity
Microsoft Entra アプリケーションを登録し、新しいサービス プリンシパルを作成します 。
サービス プリンシパルに Cognitive Services User
ロールを割り当てて Document Intelligence へのアクセス権を付与します。
Microsoft Entra アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値をそれぞれ環境変数 AZURE_CLIENT_ID
、AZURE_TENANT_ID
、AZURE_CLIENT_SECRET
として設定します。
DefaultAzureCredential
を含む DocumentAnalysisClient
インスタンスを作成します。
const { DocumentAnalysisClient } = require("@azure/ai-form-recognizer");
const { DefaultAzureCredential } = require("@azure/identity");
const client = new DocumentAnalysisClient("<your-endpoint>", new DefaultAzureCredential());
詳細については、「クライアントの作成と認証 」を参照 してください。
Python アプリケーションの DefaultAzureCredential を取得して使用する方法を次に示します。
Python 用の Azure ID ライブラリ をインストールします。
pip install azure-identity
Microsoft Entra アプリケーションを登録し、新しいサービス プリンシパルを作成します 。
サービス プリンシパルに Cognitive Services User
ロールを割り当てて Document Intelligence へのアクセス権を付与します。
Microsoft Entra アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値をそれぞれ環境変数 AZURE_CLIENT_ID
、AZURE_TENANT_ID
、AZURE_CLIENT_SECRET
として設定します。
DefaultAzureCredential
を含む DocumentAnalysisClient
インスタンスを作成します。
from azure.identity import DefaultAzureCredential
from azure.ai.formrecognizer import DocumentAnalysisClient
credential = DefaultAzureCredential()
document_analysis_client = DocumentAnalysisClient(
endpoint="https://<my-custom-subdomain>.cognitiveservices.azure.com/",
credential=credential
)
詳細については、「クライアントの認証 」を参照 してください。
4. アプリをビルドする
Document Intelligence SDK と対話するクライアント オブジェクトを作成し、続いてそのクライアント オブジェクトのメソッドを呼び出してサービスと対話します。 SDK には同期メソッドと非同期メソッドの両方が用意されています。 詳細については、選択した言語のクイック スタート を試してください。
ヘルプ オプション
Microsoft Q&A フォーラムと Stack Overflow フォーラムは、開発者コミュニティでの Azure AI Document Intelligence やその他のサービスに関する質疑応答に利用できます。 Microsoft ではフォーラムを監視しており、コミュニティでまだ回答されていない質問に回答します。 Microsoft が質問を確実に認識できるようにするために、azure-form-recognizer
のタグを付けてください。
次のステップ