次の方法で共有

SDK ターゲット: REST API 2024-07-31-preview

  • [アーティクル]

重要

  • Document Intelligence パブリック プレビュー リリースは、開発中の機能への早期アクセスを提供します。 機能、アプローチ、およびプロセスは、一般提供 (GA) の前に、ユーザーからのフィードバックに基づいて変更される可能性があります。
  • Document Intelligence クライアント ライブラリのパブリック プレビュー バージョンは、REST API バージョン 2024-07-31-preview にデフォルトで設定されています。
  • パブリック プレビュー バージョン 2024-07-31-preview は、現在、次の Azure リージョンでのみ使用できます。 AI Studio のカスタム生成 (ドキュメント フィールド抽出) モデルは、米国中北部リージョンでのみ使用できます。
    • 米国東部
    • 米国西部 2
    • "西ヨーロッパ"
    • 米国中北部

Document Intelligence チェックマーク REST API version 2024-07-31-preview

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# → 1.0.0-beta.3 (プレビュー) NuGet 2024-07-31 (プレビュー) Windows、macOS、Linux、Docker
Java → 1.0.0-beta.4 (プレビュー) Maven リポジトリ 2024-07-31 (プレビュー) Windows、macOS、Linux
JavaScript → 1.0.0-beta.3 (プレビュー) npm 2024-07-31 (プレビュー) ブラウザー、Windows、macOS、Linux
Python → 1.0.0b4 (プレビュー) PyPI 2024-07-31 (プレビュー) Windows、macOS、Linux

その他の SDK バージョンの詳細については、以下を参照してください。

サポートされているクライアント

次の表は、ドキュメント インテリジェンス サービスでサポートされている API バージョンの各 SDK バージョン間の相関関係を示しています。

Language SDK エイリアス API バージョン (既定) サポートされるクライアント
.NET/C# 1.0.0-beta.2 (プレビュー) v4.0 (プレビュー) 2024-07-31-preview DocumentIntelligenceClient
DocumentIntelligenceAdministrationClient
.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

アプリケーションで Document Intelligence SDK を使用する

Document Intelligence SDK を使用すると、アプリケーションで Document Intelligence サービスを使用および管理できます。 SDK は、基になる Document Intelligence REST API に基づいて構築されていて、プログラミング言語パラダイム内でこれらの API を簡単に使用できます。 Document Intelligence SDK を任意の言語で使用する方法を次に示します。

1. SDK クライアント ライブラリをインストールする

dotnet add package Azure.AI.DocumentIntelligence --prerelease

Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3

2. SDK クライアント ライブラリをアプリケーションにインポートする

using Azure;
using Azure.AI.DocumentIntelligence;

3. 認証を設定する

認証には、次の 2 つの方法がサポートされています。

API キーを使用する

Azure portal で Document Intelligence API キーを見つける場所を次に示します。

Azure portal のキーとエンドポイントの場所のスクリーンショット。

重要

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 `DocumentIntelligenceClient` instance
string key = "<your-key>";
string endpoint = "<your-endpoint>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentIntelligenceClient client = new DocumentIntelligenceClient(new Uri(endpoint), new AzureKeyCredential(key));

Microsoft Entra トークン資格情報を使用する

Note

リージョン エンドポイントでは、Microsoft Entra 認証がサポートされていません。 この種類の認証を使用するために、リソースのカスタム サブドメインを作成します。

承認は、DefaultAzureCredential を使用するのが最も簡単です。 実行中の環境に基づいて、ほとんどの Azure 認証シナリオを処理できる既定のトークン資格情報が提供されます。

.NET アプリケーションの DefaultAzureCredential を取得して使用する方法を次に示します。

  1. .NET 用の Azure ID ライブラリをインストールします。

        dotnet add package Azure.Identity

        Install-Package Azure.Identity

  2. Microsoft Entra アプリケーションを登録し、新しいサービス プリンシパルを作成します。

  3. サービス プリンシパルに Cognitive Services User ロールを割り当てて Document Intelligence へのアクセス権を付与します。

  4. Microsoft Entra アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値をそれぞれ環境変数 AZURE_CLIENT_ID、AZURE_TENANT_ID、AZURE_CLIENT_SECRET として設定します。

  5. DefaultAzureCredential を含む DocumentIntelligenceClient インスタンスを作成します。

    string endpoint = "<your-endpoint>";
var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());

詳細については、「クライアントを認証する」を参照してください。

4. アプリをビルドする

Document Intelligence SDK と対話するクライアント オブジェクトを作成し、続いてそのクライアント オブジェクトのメソッドを呼び出してサービスと対話します。 SDK には同期メソッドと非同期メソッドの両方が用意されています。 詳細については、選択した言語のクイック スタートを試してください。

ヘルプ オプション

Microsoft Q&A と Stack Overflow のフォーラムは、開発者コミュニティでの Azure AI Document Intelligence やその他のサービスに関する質問と回答を行うために利用できます。 Microsoft ではフォーラムを監視しており、コミュニティでまだ回答されていない質問に回答します。 確実にするために、次のタグを使って質問が見つかるようにしてください。

  • Microsoft Q&A: Azure AI Document Intelligence。

  • Stack Overflow: azure-ai-document-intelligence。

次のステップ

Document Intelligence REST API 2023-10-31-rest の操作を確認する。