Docelowy pakiet SDK: REST API w wersji 4.0 (GA)

Ta zawartość dotyczy: 🟩 wersja 4.0 (ogólna dostępność)

Azure Document Intelligence in Foundry Tools to usługa w chmurze, która używa uczenia maszynowego do analizowania tekstu i danych strukturalnych z dokumentów. Zestaw SDK (Document Intelligence Software Development Kit) to zestaw bibliotek i narzędzi, które umożliwiają łatwe integrowanie modeli i możliwości analizy dokumentów z aplikacjami. Zestaw SDK analizy dokumentów jest dostępny na różnych platformach w językach programowania C#/.NET, Java, JavaScript i Python.

Obsługiwane języki programowania

Zestaw SDK analizy dokumentów obsługuje następujące języki i platformy:

Język → wersja zestawu SDK usługi Document Intelligence Pakiet Obsługiwana wersja interfejsu API Obsługiwane platformy
.NET/C# → 1.0.0 (wersja ogólnodostępna) NuGet 2024-11-30 (dostępność ogólna) Windows, macOS, Linux, Docker
Java → 1.0.0 (GA Repozytorium Maven 2024-11-30 (dostępność ogólna) Windows, macOS, Linux
JavaScript → 1.0.0 (GA) npm 2024-11-30 (dostępność ogólna) Przeglądarka, Windows, macOS, Linux
Python → 1.0.0 (GA) PyPI 2024-11-30 (dostępność ogólna) Windows, macOS, Linux

Aby uzyskać więcej informacji na temat innych wersji zestawu SDK, zobacz:

Obsługiwani klienci

W poniższych tabelach przedstawiono korelację między poszczególnymi wersjami zestawu SDK obsługiwanymi wersjami interfejsu API usługi Analizy dokumentów.

Język Alias zestawu SDK Wersja interfejsu API (domyślna) Obsługiwani klienci
.NET/C# 1.0.0 (GA) Wersja 4.0 (ogólnie dostępna) 2024-11-30 GA DocumentIntelligenceClient
DocumentIntelligenceAdministrationClient
.NET/C# 4.1.0 v3.1 najnowsza wersja (GA) 2023-07-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 4.0.0 Wersja 3.0 (wersja ogólnie dostępna) 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

Korzystanie z zestawu Document Intelligence SDK w aplikacjach

Zestaw SDK analizy dokumentów umożliwia korzystanie z usługi Document Intelligence i zarządzanie nią w aplikacji. Zestaw SDK bazuje na bazowym interfejsie Document Intelligence REST API, umożliwiając łatwe korzystanie z tego interfejsu API w modelu właściwym dla danego języka programowania. Oto jak używasz zestawu SDK analizy dokumentów dla preferowanego języka:

1. Instalowanie biblioteki klienta zestawu SDK

dotnet add package Azure.AI.DocumentIntelligence -Version 1.0.0
Install-Package Azure.AI.DocumentIntelligence -Version 1.0.0

2. Importowanie biblioteki klienta zestawu SDK do aplikacji

using Azure;
using Azure.AI.DocumentIntelligence;

3. Konfigurowanie uwierzytelniania

Istnieją dwie obsługiwane metody uwierzytelniania:

Użyj swojego klucza API

Oto gdzie znaleźć klucz interfejsu API analizy dokumentów w witrynie Azure Portal:

Zrzut ekranu przedstawiający klucze i lokalizację punktu końcowego w witrynie Azure Portal.

Ważne

Zalecamy uwierzytelnianie za pomocą identyfikatora Entra firmy Microsoft z tożsamościami zarządzanymi dla zasobów platformy Azure, aby uniknąć przechowywania poświadczeń przy użyciu aplikacji uruchamianych w chmurze.

Jeśli używasz klucza interfejsu API, zapisz go bezpiecznie w innym miejscu, na przykład w usłudze Azure Key Vault. Nie dołączaj klucza interfejsu API bezpośrednio do kodu i nigdy nie publikuj go publicznie.

Aby uzyskać więcej informacji na temat zabezpieczeń usług sztucznej inteligencji, zobacz Uwierzytelnianie żądań w usługach 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));

Użyj poświadczenia tokenu Microsoft Entra

Uwaga

Regionalne punkty końcowe nie obsługują uwierzytelniania firmy Microsoft Entra. Utwórz niestandardową poddomenę dla zasobu, aby użyć tego typu uwierzytelniania.

Autoryzacja jest najłatwiejsza przy użyciu .DefaultAzureCredential Zapewnia on domyślne poświadczenia tokenu oparte na uruchomionym środowisku, które może obsługiwać większość scenariuszy uwierzytelniania platformy Azure.

Oto jak uzyskać i używać poświadczenia DefaultAzureCredential w aplikacjach platformy .NET:

  1. Zainstaluj bibliotekę tożsamości platformy Azure dla platformy .NET:

        dotnet add package Azure.Identity
    
        Install-Package Azure.Identity
    
  2. Zarejestruj aplikację Microsoft Entra i utwórz nową jednostkę usługi

  3. Przyznaj dostęp do Document Intelligence, przypisując rolę Cognitive Services User do nazwy głównej usługi.

  4. Ustaw wartości identyfikatora klienta, identyfikatora dzierżawy i klucza tajnego klienta w aplikacji Microsoft Entra jako zmienne środowiskowe: AZURE_CLIENT_ID, AZURE_TENANT_IDi AZURE_CLIENT_SECRET, odpowiednio.

  5. Utwórz swoją instancję DocumentIntelligenceClient, w tym DefaultAzureCredential:

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

Aby uzyskać więcej informacji, zobaczUwierzytelnianie klienta.

4. Kompilowanie aplikacji

Utwórz obiekt klienta do interakcji z zestawem SDK analizy dokumentów, a następnie wywołaj metody dla tego obiektu klienta w celu interakcji z usługą. Zestawy SDK zapewniają metody synchroniczne i asynchroniczne. Aby uzyskać więcej informacji, wypróbuj przewodnik Szybki start w wybranym języku.

Opcje pomocy

Fora Microsoft Q&A i Stack Overflow są dostępne dla społeczności deweloperów, aby zadawać i odpowiadać na pytania dotyczące usługi Azure Document Intelligence w narzędziach Foundry Tools i innych usługach. Firma Microsoft monitoruje fora i odpowiada na pytania, na które społeczność nie odpowiedziała. Aby mieć pewność, że zobaczymy Twoje pytanie, użyj następujących tagów.

  • Microsoft Q&A: Azure Document Intelligence.

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

Następne kroki