Cíl sady SDK: REST API v4.0 (GA)
Obecná dostupnost rozhraní REST API verze 2024-11-30
Azure AI Document Intelligence je cloudová služba, která používá strojové učení k analýze textu a strukturovaných dat z dokumentů. Sada SDK (Document Intelligence Software Development Kit) je sada knihoven a nástrojů, které umožňují snadno integrovat modely a funkce Document Intelligence do vašich aplikací. Sada Document Intelligence SDK je k dispozici na různých platformách v programovacích jazycích C#/.NET, Java, JavaScript a Python.
Podporované programovací jazyky
Sada Document Intelligence SDK podporuje následující jazyky a platformy:
| Verze sady Language → Document Intelligence SDK | Balíček | Podporovaná verze rozhraní API | Podpora platformy |
|---|---|---|---|
| .NET/C# → 1.0.0 (GA) | NuGet | 2024-11-30 (GA) | Windows, macOS, Linux, Docker |
| Java → 1.0.0 (GA) | Úložiště Maven | 2024-11-30 (GA) | Windows, macOS, Linux |
| JavaScript → 1.0.0 (GA) | npm | 2024-11-30 (GA) | Prohlížeč, Windows, macOS, Linux |
| Python → 1.0.0b4 (Preview) | PyPI | 2024-11-30 (GA) | Windows, macOS, Linux |
Další informace o dalších verzích sady SDK najdete tady:
Podporovaní klienti
Následující tabulky představují korelaci mezi každou verzí sady SDK podporovanými verzemi rozhraní API služby Document Intelligence.
| Jazyk | Alias sady SDK | Verze rozhraní API (výchozí) | Podporovaní klienti |
|---|---|---|---|
| .NET/C# 1.0.0-beta.2 (Preview) | v4.0 (GA) | 2024-11-30 GA | DocumentIntelligenceClient DocumentIntelligenceAdministrationClient |
| .NET/C# 4.1.0 | Nejnovější verze 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 |
Použití sady Document Intelligence SDK v aplikacích
Sada Document Intelligence SDK umožňuje ve vaší aplikaci používat a spravovat službu Document Intelligence. Sada SDK vychází ze základního rozhraní REST API pro analýzu dokumentů, které vám umožní snadno používat tato rozhraní API v rámci paradigmatu programovacího jazyka. Tady je postup, jak používat sadu Document Intelligence SDK pro preferovaný jazyk:
1. Instalace klientské knihovny SDK
dotnet add package Azure.AI.DocumentIntelligence --prerelease
Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3
2. Import klientské knihovny SDK do aplikace
using Azure;
using Azure.AI.DocumentIntelligence;
3. Nastavení ověřování
Pro ověřování existují dvě podporované metody:
Použijte klíč rozhraní Document Intelligence API s AzureKeyCredential z azure.core.credentials.
K ověření pomocí ID Microsoft Entra použijte přihlašovací údaje tokenu z azure-identity.
Použití klíče rozhraní API
Tady najdete klíč rozhraní DOCUMENT Intelligence API na webu Azure Portal:
Důležité
Doporučujeme ověřování Microsoft Entra ID se spravovanými identitami pro prostředky Azure, abyste se vyhnuli ukládání přihlašovacích údajů s aplikacemi, které běží v cloudu.
Pokud používáte klíč rozhraní API, uložte ho bezpečně někam jinam, například ve službě Azure Key Vault. Nezahrnujte klíč rozhraní API přímo do kódu a nikdy ho nevštěvujte veřejně.
Další informace o zabezpečení služeb AI najdete v tématu Ověřování požadavků na služby 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));
Použití přihlašovacích údajů tokenu Microsoft Entra
Poznámka:
Regionální koncové body nepodporují ověřování Microsoft Entra. Vytvořte pro prostředek vlastní subdoménu, abyste mohli tento typ ověřování použít.
Autorizace se nejsnadněji používá .DefaultAzureCredential Poskytuje výchozí přihlašovací údaje tokenu založené na spuštěném prostředí, které dokáže zpracovat většinu scénářů ověřování Azure.
Tady je postup, jak získat a použít DefaultAzureCredential pro aplikace .NET:
Nainstalujte knihovnu identit Azure pro .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityZaregistrujte aplikaci Microsoft Entra a vytvořte nový instanční objekt.
Udělení přístupu k funkci Document Intelligence přiřazením
Cognitive Services Userrole k instančnímu objektu.Nastavte hodnoty ID klienta, ID tenanta a tajného klíče klienta v aplikaci Microsoft Entra jako proměnné prostředí:
AZURE_CLIENT_ID,AZURE_TENANT_IDaAZURE_CLIENT_SECRETv uvedeném pořadí.Vytvořte instanci
DocumentIntelligenceClient, včetně:DefaultAzureCredentialstring endpoint = "<your-endpoint>"; var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());
Další informace najdete v tématu Ověření klienta.
4. Sestavení aplikace
Vytvořte objekt klienta pro interakci se sadou Document Intelligence SDK a potom volejte metody na daném objektu klienta pro interakci se službou. Sady SDK poskytují synchronní i asynchronní metody. Další přehled najdete v rychlém startu v jazyce podle vašeho výběru.
Možnosti nápovědy
Fóra Microsoft Q&A Stack Overflow jsou k dispozici pro komunitu vývojářů, kde se můžete ptát a odpovídat na otázky týkající se funkcí Document Intelligence a dalších služeb Azure AI. Microsoft monitoruje fóra a odpovídá na otázky, na které má komunita odpověď. Abyste měli jistotu, použijte následující značky, abychom viděli vaši otázku.
Microsoft Q&A:Azure AI Document Intelligence. .Stack Overflow:
azure-ai-document-intelligence.