REST API バージョン 2022-08-31 v3.0
重要
- ドキュメント インテリジェンス REST API 2022-08-31 v3.0 は、2029 年 3 月 30 日にサポートが終了します。
- 運用環境の中断を回避するには、Azure Document Intelligence 2024-11-30 v4.0 に移行します。 詳細については、「 ドキュメント インテリジェンス移行ガイド」を参照してください。
Foundry Tools の Azure ドキュメント インテリジェンスは、機械学習を使用してドキュメントのテキストと構造化データを分析するクラウド サービスです。 ドキュメント インテリジェンス ソフトウェア開発キット (SDK) は、ドキュメント インテリジェンス モデルと機能をアプリケーションに簡単に統合できる一連のライブラリとツールです。 Document Intelligence SDK は、C#/.NET、Java、JavaScript、Python プログラミング言語のプラットフォーム間で利用できます。
サポートされているプログラミング言語
ドキュメント インテリジェンス SDK では、次の言語とプラットフォームがサポートされています。
| 言語→ドキュメント インテリジェンス SDK のバージョン | パッケージ | サポートされている API バージョン | プラットフォームのサポート |
|---|---|---|---|
.NET/C# → 4.0.0 (GA) |
NuGet | v3.0 | Windows、macOS、Linux、Docker |
Java → 4.0.6 (GA) |
Maven リポジトリ | v3.0 | Windows、macOS、Linux |
JavaScript → 4.0.0 (GA) |
npm | v3.0 | Browser、Windows、macOS、Linux |
Python → 3.2.0 (GA) |
PyPI | v3.0 | Windows、macOS、Linux |
その他の SDK バージョンの詳細については、以下を参照してください。
サポートされているクライアント
| Language | SDK のバージョン | API バージョン | サポートされているクライアント |
|---|---|---|---|
| .NET/C# Java JavaScript |
4.0.0 (GA) | v3.0:2022-08-31 (既定) |
DocumentAnalysisClient DocumentModelAdministrationClient |
| .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.2.x (GA) | v3.0:2022-08-31 (既定) | DocumentAnalysisClient DocumentModelAdministrationClient |
| Python | 3.1.x | v2.1 (既定値) v2.0 |
FormRecognizerClient FormTrainingClient |
| Python | 3.0.0 | v2.0 |
FormRecognizerClient FormTrainingClient |
アプリケーションでドキュメント インテリジェンス SDK を使用する
ドキュメント インテリジェンス SDK を使用すると、アプリケーションでドキュメント インテリジェンス サービスを使用および管理できます。 SDK は、基になるドキュメント インテリジェンス REST API に基づいて構築されており、プログラミング言語パラダイム内でこれらの API を簡単に使用できます。 優先する言語に Document Intelligence SDK を使用する方法を次に示します。
1. SDK クライアント ライブラリをインストールする
dotnet add package Azure.AI.FormRecognizer --version 4.0.0
Install-Package Azure.AI.FormRecognizer -Version 4.0.0
2. SDK クライアント ライブラリをアプリケーションにインポートする
using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;
3. 認証を設定する
認証には、次の 2 つの方法がサポートされています。
Azure.core.credentials から AzureKeyCredential で ドキュメント インテリジェンス API キー を使用します。
azure-identity からの
トークン資格情報を使用して、 Microsoft Entra ID で認証します。
API キーを使用する
Azure ポータルでドキュメント インテリジェンス API キーを検索する場所を次に示します。
重要
クラウドで実行されるアプリケーションに資格情報を格納しないように、 Azure リソースの管理された ID を使用して認証をMicrosoft Entra IDすることをお勧めします。
API キーを使用する場合は、
AI サービスのセキュリティの詳細については、「Authenticate requests to Azure AI サービス」を参照してください。
//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);
Microsoft Entra トークン資格情報を使用する
メモ
リージョン エンドポイントでは、Microsoft Entra認証はサポートされていません。 この種類の認証を使用するために、リソースの カスタム サブドメイン を作成します。
承認は、 DefaultAzureCredentialを使用するのが最も簡単です。 これは、ほとんどのAzure認証シナリオを処理できる、実行中の環境に基づいて、既定のトークン資格情報を提供します。
.NET アプリケーションの DefaultAzureCredential を取得して使用する方法を次に示します。
.NETAzure Identity ライブラリをインストール>:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityCognitive Services Userロールをサービス プリンシパルに割り当てることで、ドキュメント インテリジェンスへのアクセス権を付与します。Microsoft Entra アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値をそれぞれ環境変数として設定します(
AZURE_CLIENT_ID、AZURE_TENANT_ID、AZURE_CLIENT_SECRET)。DocumentAnalysisClientを含むDefaultAzureCredentialインスタンスを作成します。string endpoint = "<your-endpoint>"; var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
詳細については、seeクライアントの認証を参照してください。
4. アプリケーションをビルドする
Document Intelligence SDK と対話するクライアント オブジェクトを作成し、そのクライアント オブジェクトのメソッドを呼び出してサービスと対話します。 SDK には、同期メソッドと非同期メソッドの両方が用意されています。 詳細については、選択した言語で クイック スタート をお試しください。
ヘルプ オプション
azure-form-recognizerでタグ付けします。