SDK-Ziel: REST-API 2022–08–31 (GA)
![Dokument Intelligenz Häkchen]../media/yes-icon.png) REST-API-Version 2022–08–31 (GA)
Azure KI Dokument Intelligenz ist ein Clouddienst, der maschinelles Lernen verwendet, um Text und strukturierte Daten aus Dokumenten zu analysieren. Das Dokument Intelligenz SDK (Software Development Kit) besteht aus einer Reihe von Bibliotheken und Tools, mit denen Sie die Modelle und Funktionen von Dokument Intelligenz einfach in Ihre Anwendungen integrieren können. Das Dokument Intelligenz SDK ist auf allen Plattformen in den Programmiersprachen C#/.NET, Java, JavaScript und Python verfügbar.
Unterstützte Programmiersprachen
Das Dokument Intelligenz SDK unterstützt folgende Sprachen und Plattformen:
| Sprache → Dokument Intelligenz SDK-Version | Paket | Unterstützte API-Version | Plattformunterstützung |
|---|---|---|---|
| .NET/C# → 4.0.0 (GA) | NuGet | v3.0 | Windows, macOS, Linux, Docker |
| Java → 4.0.6 (GA) | Maven-Repository | v3.0 | Windows, macOS, Linux |
| JavaScript → 4.0.0 (GA) | npm | v3.0 | Browser, Windows, macOS, Linux |
| Python → 3.2.0 (GA) | PyPI | v3.0 | Windows, macOS, Linux |
Weitere Informationen zu anderen SDK-Versionen finden Sie unter:
Unterstützte Clients
| Sprache | SDK-Version | API-Version | Unterstützte Clients |
|---|---|---|---|
| .NET/C# Java JavaScript |
4.0.0 (GA) | v3.0:2022-08-31 (Standard) | DocumentAnalysisClient DocumentModelAdministrationClient |
| .NET/C# Java JavaScript |
3.1.x | v2.1 (Standard) v2.0 |
FormRecognizerClient FormTrainingClient |
| .NET/C# Java JavaScript |
3.0.x | v2.0 | FormRecognizerClient FormTrainingClient |
| Python | 3.2.x (GA) | v3.0:2022-08-31 (Standard) | DocumentAnalysisClient DocumentModelAdministrationClient |
| Python | 3.1.x | v2.1 (Standard) v2.0 |
FormRecognizerClient FormTrainingClient |
| Python | 3.0.0 | v2.0 | FormRecognizerClient FormTrainingClient |
Verwenden des Dokument Intelligenz SDK in Ihren Anwendungen
Das Dokument Intelligenz SDK ermöglicht die Verwendung und Verwaltung des Dokument Intelligenz-Diensts in Ihrer Anwendung. Das SDK basiert auf der Dokument Intelligenz-REST-API, mit der Sie diese APIs einfach in Ihrem Programmiersprachenparadigma verwenden können. So verwenden Sie das Dokument Intelligenz SDK für Ihre bevorzugte Sprache
1. Installieren der SDK-Clientbibliothek
dotnet add package Azure.AI.FormRecognizer --version 4.0.0
Install-Package Azure.AI.FormRecognizer -Version 4.0.0
2. Importieren der SDK-Clientbibliothek in Ihre Anwendung
using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;
3. Einrichten der Authentifizierung
Es gibt zwei unterstützte Methoden für die Authentifizierung:
Verwenden Sie einen Dokument Intelligenz-API-Schlüssel mit AzureKeyCredential von azure.core.credentials.
Verwenden Sie Tokenanmeldeinformationen von azure-identity, um sich bei Microsoft Entra ID zu authentifizieren.
Verwenden Ihres API-Schlüssels
Hier finden Sie den Dokument Intelligenz-API-Schlüssel im Azure-Portal:
Wichtig
Es wird empfohlen, die Microsoft Entra ID-Authentifizierung mit verwalteten Identitäten für Azure-Ressourcen zu kombinieren, um das Speichern von Anmeldeinformationen mit den in der Cloud ausgeführten Anwendungen zu vermeiden.
Wenn Sie einen API-Schlüssel verwenden, speichern Sie ihn an einer anderen Stelle sicher, z. B. in Azure Key Vault. Fügen Sie den API-Schlüssel nicht direkt in Ihren Code ein, und machen Sie ihn nicht öffentlich zugänglich.
Weitere Informationen zur Sicherheit von KI Services finden Sie unter Authentifizieren von Anforderungen an Azure KI Services.
//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `DocumentAnalysisClient` instance
string key = "<your-key>";
string endpoint = "<your-endpoint>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);
Verwenden von Microsoft Entra-Tokenanmeldeinformationen
Hinweis
Die Microsoft Entra-Authentifizierung wird von regionalen Endpunkten nicht unterstützt. Erstellen Sie eine benutzerdefinierte Unterdomäne für Ihre Ressource, um diesen Authentifizierungstyp zu verwenden.
Die Autorisierung ist am einfachsten mit dem DefaultAzureCredential-Element. Es bietet Standardtokenanmeldeinformationen basierend auf der ausgeführten Umgebung und kann die meisten Azure-Authentifizierungsszenarien behandeln.
Hier sehen Sie, wie Sie DefaultAzureCredential für .NET-Anwendungen abrufen und verwenden:
Installieren Sie die Azure Identity-Bibliothek für .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityRegistrieren Sie eine Microsoft Entra-Anwendung, und erstellen Sie einen neuen Dienstprinzipal.
Gewähren Sie Zugriff auf Dokument Intelligenz, indem Sie Ihrem Dienstprinzipal die Rolle
Cognitive Services Userzuweisen.Legen Sie die Werte der Client-ID, der Mandanten-ID und des geheimen Clientschlüssels in der Microsoft Entra-Anwendung als die Umgebungsvariablen
AZURE_CLIENT_ID,AZURE_TENANT_IDundAZURE_CLIENT_SECRETfest.Erstellen Sie Ihre
DocumentAnalysisClient-Instanz einschließlichDefaultAzureCredential:string endpoint = "<your-endpoint>"; var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
Weitere Informationen finden Sie unter Authentifizieren des Clients.
4. Erstellen Ihrer Anwendung
Erstellen Sie ein Clientobjekt für die Interaktion mit dem Dokument Intelligenz SDK. Rufen Sie dann Methoden für dieses Clientobjekt auf, um mit dem Dienst zu interagieren. Die SDKs bieten sowohl synchrone als auch asynchrone Methoden. Um mehr Einblick zu erhalten, probieren Sie einen Schnellstart in einer Sprache Ihrer Wahl aus.
Hilfeoptionen
In den Foren Microsoft Q&A und Stack Overflow kann die Entwicklercommunity Fragen zu Azure KI Dokument Intelligenz und anderen Diensten stellen und beantworten. Microsoft verfolgt die Foren und antwortet auf Fragen, die von der Community noch beantwortet werden müssen. Markieren Sie Ihre Frage mit azure-form-recognizer, um sicherzustellen, dass wir Ihre Frage sehen.