Cel zestawu SDK: interfejs API REST 2024-07-31-preview
Ważne
- Publiczne wersje zapoznawcze analizy dokumentów zapewniają wczesny dostęp do funkcji, które są aktywnie opracowywane. Funkcje, podejścia i procesy mogą ulec zmianie przed ogólną dostępnością na podstawie opinii użytkowników.
- Publiczna wersja zapoznawcza bibliotek klienckich analizy dokumentów jest domyślna dla interfejsu API REST w wersji 2024-07-31-preview.
- Publiczna wersja zapoznawcza 2024-07-31-preview jest obecnie dostępna tylko w następujących regionach świadczenia usługi Azure. Należy pamiętać, że niestandardowy model generowania (wyodrębniania pól dokumentów) w programie AI Studio jest dostępny tylko w regionie Północno-środkowe stany USA:
- Wschodnie stany USA
- Zachodnie stany USA 2
- Europa Zachodnia
- Północno-środkowe stany USA
Interfejs API REST w wersji 2024-07-31-preview
Azure AI Document Intelligence 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:
| Wersja zestawu SDK analizy dokumentów języka → | Pakiet | Obsługiwana wersja interfejsu API | Obsługa platform |
|---|---|---|---|
| .NET/C# → 1.0.0-beta.3 (wersja zapoznawcza) | NuGet | 2024-07-31 (wersja zapoznawcza) | Windows, macOS, Linux, Docker |
| Java → 1.0.0-beta.4 (wersja zapoznawcza) | Repozytorium Maven | 2024-07-31 (wersja zapoznawcza) | Windows, macOS, Linux |
| JavaScript → 1.0.0-beta.3 (wersja zapoznawcza) | npm | 2024-07-31 (wersja zapoznawcza) | Przeglądarka, Windows, macOS, Linux |
| Python → 1.0.0b4 (wersja zapoznawcza) | PyPI | 2024-07-31 (wersja zapoznawcza) | Windows, macOS, Linux |
Aby uzyskać więcej informacji na temat innych wersji zestawu SDK, zobacz:
2023-07-31Wersja 3.1 (ogólna dostępność)2022-08-31Wersja 3.0 (ogólna dostępność)v2.1(ogólna dostępność)
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-beta.2 (wersja zapoznawcza) | Wersja 4.0 (wersja zapoznawcza) | 2024-07-31-preview | DocumentIntelligenceClient DocumentIntelligenceAdministrationClient |
| .NET/C# 4.1.0 | Najnowsza wersja 3.1 (ogólna dostępność) | 2023-07-31 | DocumentAnalysisClient DocumentModelAdministrationClient |
| .NET/C# 4.0.0 | Wersja 3.0 (ogólna dostępność) | 2022-08-31 | DocumentAnalysisClient DocumentModelAdministrationClient |
| .NET/C# 3.1.x | Wersja 2.1 | Wersja 2.1 | FormRecognizerClient FormTrainingClient |
| .NET/C# 3.0.x | Wersja 2.0 | Wersja 2.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 opiera się na podstawowym interfejsie API REST analizy dokumentów, który umożliwia łatwe korzystanie z tych interfejsów API w ramach paradygmatu 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 --prerelease
Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3
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 klucza interfejsu API analizy dokumentów z elementem AzureKeyCredential z pliku azure.core.credentials.
Użyj poświadczeń tokenu z tożsamości platformy Azure, aby uwierzytelnić się przy użyciu identyfikatora Entra firmy Microsoft.
Używanie klucza interfejsu API
Oto gdzie znaleźć klucz interfejsu API analizy dokumentów 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żywanie poświadczeń tokenu entra firmy Microsoft
Uwaga
Regionalne punkty końcowe nie obsługują uwierzytelniania entra firmy Microsoft. 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.
Poniżej przedstawiono sposób uzyskiwania i używania wartości DefaultAzureCredential dla aplikacji platformy .NET:
Zainstaluj bibliotekę tożsamości platformy Azure dla platformy .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityZarejestruj aplikację Microsoft Entra i utwórz nową jednostkę usługi.
Udziel dostępu do analizy dokumentów, przypisując
Cognitive Services Userrolę do jednostki usługi.Ustaw wartości identyfikatora klienta, identyfikatora dzierżawy i klucza tajnego klienta w aplikacji Microsoft Entra jako zmienne środowiskowe:
AZURE_CLIENT_ID,AZURE_TENANT_IDiAZURE_CLIENT_SECRET, odpowiednio.DocumentIntelligenceClientUtwórz wystąpienie, w tym elementDefaultAzureCredential:string endpoint = "<your-endpoint>"; var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());
Aby uzyskać więcej informacji, zobacz Uwierzytelnianie 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 analizy dokumentów usługi Azure AI i innych usług. Firma Microsoft monitoruje fora i odpowiada na pytania, na które społeczność nie odpowiedziała. Aby upewnić się, użyj następujących tagów, aby zobaczyć twoje pytanie.
Microsoft Q&A:Azure AI Document Intelligence.Stack Overflow:
azure-ai-document-intelligence.