共用方式為


SDK 目標:REST API 2024-07-31-preview

重要

  • 文件智慧服務公開預覽版本可讓您搶先存取正在積極開發的功能。 根據使用者意見反應,功能、方法和流程在正式發行 (GA) 前可能有所變更。
  • 文件智慧服務用戶端程式庫的公開預覽版預設為 REST API 版本 2024-07-31-preview
  • 公開預覽版 2024-07-31-preview 目前僅適用於下列 Azure 地區。 請注意,AI Studio 中的自訂生成 (文件欄位擷取) 模型僅適用美國中北部地區:
    • 美國東部
    • 美國西部 2
    • 西歐
    • 美國中北部

文件智慧核取記號 REST API 版本 2024-07-31-preview

Azure AI 文件智慧服務是一項雲端服務,會使用機器學習來分析文件中的文字和結構化資料。 文件智慧軟體開發套件 (SDK) 是一組程式庫和工具,可讓您輕鬆地將文件智慧模型和功能整合到應用程式中。 可跨平台使用 C#/.NET、Java、JavaScript 和 Python 程式設計語言,來使用文件智慧 SDK。

支援的程式設計語言

文件智慧 SDK 支援下列語言和平台:

語言 → 文件智慧服務 SDK 版本 套件 支援的 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 版本的詳細資訊,請參閱:

支援的用戶端

下表顯示每個 SDK 版本與文件智慧服務支援的 API 版本之間的相互關聯。

語言 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

在應用程式中使用文件智慧 SDK

文件智慧 SDK 讓您能夠在應用程式中使用和管理文件智慧服務。 SDK 建置於基礎文件智慧 REST API 上,可讓您輕鬆地在程式設計語言範例內使用這些 API。 以下說明如何使用您慣用語言的文件智慧 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.設定驗證

有兩種支援的驗證方法:

使用您的 API 金鑰

您可以在 Azure 入口網站中的下列位置找到文件智慧 API 金鑰:

Azure 入口網站中金鑰和端點位置的螢幕擷取畫面。

重要

我們建議使用適用於 Azure 資源的受控識別搭配 Microsoft Entra 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 權杖認證

注意

區域端點不支援 Microsoft Entra 驗證。 為您的資源建立自訂子網域,以使用此類型的驗證。

使用 DefaultAzureCredential 是最簡單的授權方式。 它會根據執行中的環境提供預設權杖認證,足以因應多數 Azure 驗證案例的需求。

以下說明如何取得和使用 .NET 應用程式的 DefaultAzureCredential

  1. 安裝適用於 .NET 的 Azure 身分識別程式庫

        dotnet add package Azure.Identity
    
        Install-Package Azure.Identity
    
  2. 註冊 Microsoft Entra 應用程式並建立新的服務主體

  3. Cognitive Services User 角色指派給服務主體,以授與對文件智慧的存取權。

  4. 將 Microsoft Entra 應用程式中用戶端識別碼、租用戶識別碼和用戶端密碼的值分別設定為環境變數 AZURE_CLIENT_IDAZURE_TENANT_IDAZURE_CLIENT_SECRET

  5. 建立您的 DocumentIntelligenceClient 執行個體,包括 DefaultAzureCredential

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

如需詳細資訊,請參閱驗證用戶端

4.建置應用程式

建立用戶端物件以與文件智慧 SDK 互動,然後在該用戶端物件上呼叫與服務互動的方法。 SDK 同時提供同步和非同步方法。 如需詳細資訊,請根據您選擇的語言嘗試進行快速入門

說明選項

Microsoft Q&AStack Overflow 論壇可供開發人員社群詢問和回答有關 Azure AI 文件智慧服務及其他服務的問題。 Microsoft 會監視論壇,並回覆社群尚未回答的問題。 若要確定,請使用下列標籤,以便我們看到您的問題。

  • Stack Overflow:azure-ai-document-intelligence

下一步