SDK-Ziel: REST-API 2024-07-31-preview
Wichtig
- Public Preview-Releases von Dokument Intelligenz bieten frühzeitigen Zugriff auf Features, die sich in der aktiven Entwicklung befinden. Features, Ansätze und Prozesse können sich aufgrund von Benutzerfeedback vor der allgemeinen Verfügbarkeit (General Availability, GA) ändern.
- Die Public Preview von Dokument Intelligenz-Clientbibliotheken verwendet standardmäßig Version 2024-07-31-preview der REST-API.
- Die Public Preview 2024-07-31-preview ist derzeit lediglich in den folgenden Azure-Regionen verfügbar. Beachten Sie, dass das benutzerdefinierte generative Modell (Dokumentfeldextraktion) in KI Studio nur in der Region „USA, Norden-Mitte“ verfügbar ist:
- USA, Osten
- USA, Westen 2
- Europa, Westen
- USA, Norden-Mitte
REST-API-Version 2024-07-31-preview
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# → 1.0.0-beta.3 (Vorschau) | NuGet | 2024-07-31 (Vorschau) | Windows, macOS, Linux, Docker |
Java → 1.0.0-beta.4 (Vorschau) | Maven-Repository | 2024-07-31 (Vorschau) | Windows, macOS, Linux |
JavaScript → 1.0.0-beta.3 (Vorschau) | npm | 2024-07-31 (Vorschau) | Browser, Windows, macOS, Linux |
Python → 1.0.0b4 (Preview) | PyPI | 2024-07-31 (Vorschau) | Windows, macOS, Linux |
Weitere Informationen zu anderen SDK-Versionen finden Sie unter:
Unterstützte Clients
Die folgenden Tabellen zeigen die Korrelation zwischen den einzelnen SDK-Versionen und den unterstützten API-Versionen des Dokument Intelligenz-Diensts.
Sprache | SDK-Alias | API-Version (Standard) | Unterstützte Clients |
---|---|---|---|
.NET/C# 1.0.0-beta.2 (Preview) | v4.0 (Preview) | 2024-07-31-preview | DocumentIntelligenceClient DocumentIntelligenceAdministrationClient |
.NET/C# 4.1.0 | v3.1, neueste Version (allgemeine Verfügbarkeit) | 2023-07-31 | DocumentAnalysisClient DocumentModelAdministrationClient |
.NET/C# 4.0.0 | v3.0 (allgemeine Verfügbarkeit) | 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 |
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.DocumentIntelligence --prerelease
Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3
2. Importieren der SDK-Clientbibliothek in Ihre Anwendung
using Azure;
using Azure.AI.DocumentIntelligence;
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 `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));
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.Identity
Install-Package Azure.Identity
Registrieren 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 User
zuweisen.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_ID
undAZURE_CLIENT_SECRET
fest.Erstellen Sie Ihre
DocumentIntelligenceClient
-Instanz einschließlichDefaultAzureCredential
:string endpoint = "<your-endpoint>"; var client = new DocumentIntelligenceClient(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. Verwenden Sie unbedingt die folgenden Tags, damit Ihre Frage angezeigt wird.
Microsoft Q&A
:Azure AI Document Intelligence
.Stapelüberlauf:
azure-ai-document-intelligence
.
Nächste Schritte
Erkunden Sie Vorgänge der Dokument Intelligenz-REST-API 2023-10-31-rest.