SDK ターゲット: REST API v2.1 (GA)
REST API バージョン v2.1 (GA) 21-06-08
Azure AI Document Intelligence は、機械学習を使用してドキュメントからのテキストと構造化データを分析するクラウド サービスです。 Document Intelligence ソフトウェア開発キット (SDK) は、Document Intelligence のモデルと機能をアプリケーションに簡単に統合できる一連のライブラリとツールです。 Document Intelligence SDK は、C#/.NET、Java、JavaScript、Python プログラミング言語で、さまざまなプラットフォームで使用できます。
サポートされるプログラミング言語
Document Intelligence SDK では、次の言語とプラットフォームがサポートされています。
言語 → Document Intelligence SDK のバージョン | Package | サポートされている API バージョン | プラットフォームのサポート |
---|---|---|---|
.NET/C# → 3.1.x (GA) | NuGet | v2.1 | Windows、macOS、Linux、Docker |
Java → 3.1.x (GA) | Maven リポジトリ | v2.1 | Windows、macOS、Linux |
JavaScript → 3.1.0 (GA) | npm | v2.1 | ブラウザー、Windows、macOS、Linux |
Python → 3.1.0 (GA) | PyPI | v2.1 | |
Windows、macOS、Linux |
その他の SDK バージョンの詳細については、以下を参照してください。
サポートされているクライアント
言語 | SDK バージョン | API バージョン | サポートされるクライアント |
---|---|---|---|
.NET/C# Java JavaScript |
3.1.x | v2.1 (既定) v2.0 |
FormRecognizerClient FormTrainingClient |
.NET/C# Java JavaScript |
3.0.x | v2.0 | FormRecognizerClient FormTrainingClient |
Python | 3.1.x | v2.1 (既定) v2.0 |
FormRecognizerClient FormTrainingClient |
Python | 3.0.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 3.1.0
Install-Package Azure.AI.FormRecognizer -Version 3.1.0
2. SDK クライアント ライブラリをアプリケーションにインポートする
using Azure;
using Azure.AI.FormRecognizer.Models;
3. 認証を設定する
認証には、次の 2 つの方法がサポートされています。
azure.core.credentials からの AzureKeyCredential で Document Intelligence API キーを使用します。
Azure ID のトークン資格情報を使用して Microsoft Entra ID で認証します。
API キーを使用する
Azure portal で Document Intelligence API キーを見つける場所を次に示します。
重要
Microsoft Entra 認証と Azure リソースのマネージド ID を併用して、クラウドで実行されるアプリケーションに資格情報を格納しないようにすることをお勧めします。
API キーを使用する場合は、それを Azure Key Vault などの別の場所に安全に保存します。 API キーは、コード内に直接含めないようにし、絶対に公開しないでください。
AI サービスのセキュリティの詳細については、「Azure AI サービスに対する要求の認証」を参照してください。
//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `FormRecognizerClient` instance
string key = "<your-key>";
string endpoint = "<your-endpoint>";
FormRecognizerClient client = new FormRecognizerClient(new Uri(endpoint), new AzureKeyCredential(key));
Microsoft Entra トークン資格情報を使用する
Note
リージョン エンドポイントでは、Microsoft Entra 認証がサポートされていません。 この種類の認証を使用するために、リソースのカスタム サブドメインを作成します。
承認は、DefaultAzureCredential
を使用するのが最も簡単です。 実行中の環境に基づいて、ほとんどの Azure 認証シナリオを処理できる既定のトークン資格情報が提供されます。
.NET アプリケーションの DefaultAzureCredential を取得して使用する方法を次に示します。
.NET 用の Azure ID ライブラリをインストールします。
dotnet add package Azure.Identity
Install-Package Azure.Identity
サービス プリンシパルに
Cognitive Services User
ロールを割り当てて Document Intelligence へのアクセス権を付与します。Microsoft Entra アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値をそれぞれ環境変数
AZURE_CLIENT_ID
、AZURE_TENANT_ID
、AZURE_CLIENT_SECRET
として設定します。DefaultAzureCredential
を含むFormRecognizerClient
インスタンスを作成します。string endpoint = "<your-endpoint>"; var client = new FormRecognizerClient(new Uri(endpoint), new DefaultAzureCredential());
詳細については、「クライアントを認証する」を参照してください。
4. アプリをビルドする
Document Intelligence SDK と対話するクライアント オブジェクトを作成し、続いてそのクライアント オブジェクトのメソッドを呼び出してサービスと対話します。 SDK には同期メソッドと非同期メソッドの両方が用意されています。 詳細については、選択した言語のクイック スタートを試してください。
ヘルプ オプション
Microsoft Q & A フォーラムと Stack Overflow フォーラムは、開発者コミュニティでの Azure AI Document Intelligence やその他のサービスに関する質疑応答に利用できます。 Microsoft ではフォーラムを監視しており、コミュニティでまだ回答されていない質問に回答します。 Microsoft が質問を確実に認識できるようにするために、azure-form-recognizer
のタグを付けてください。