SDK-Ziel: REST-API v2.1 (GA)

REST-API-Version „v2.1 (GA) 21-06-08“

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# → 3.1.x (GA)	NuGet	v2.1	Windows, macOS, Linux, Docker
Java → 3.1.x (GA)	Maven-Repository	v2.1	Windows, macOS, Linux
JavaScript → 3.1.0 (GA)	npm	v2.1	Browser, Windows, macOS, Linux
Python → 3.1.0 (GA)	PyPI	v2.1
Windows, macOS, Linux

Weitere Informationen zu anderen SDK-Versionen finden Sie unter:

• 2024-02-29 (preview)
• 2023-07-31 v3.1 (GA)
• 2022-08-31 v3.0 (GA)

Unterstützte Clients

Sprache	SDK-Version	API-Version	Unterstützte Clients
.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.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

C#/.NET

dotnet add package Azure.AI.FormRecognizer --version 3.1.0

Install-Package Azure.AI.FormRecognizer -Version 3.1.0

Java

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-formrecognizer</artifactId>
<version>3.1.0</version>
</dependency>

implementation("com.azure:azure-ai-formrecognizer:3.1.0")

JavaScript

npm i @azure/ai-form-recognizer@3.1.0

Python

pip install azure-ai-formrecognizer==3.1.0

2. Importieren der SDK-Clientbibliothek in Ihre Anwendung

C#/.NET

using Azure;
using Azure.AI.FormRecognizer.Models;

Java

import com.azure.ai.formrecognizer.*;
import com.azure.ai.formrecognizer.models.*;

import com.azure.core.credential.AzureKeyCredential;

JavaScript

const { FormRecognizerClient, AzureKeyCredential } = require("@azure/ai-form-recognizer");

Python

    from azure.ai.formrecognizer import FormRecognizerClient
    from azure.core.credentials import AzureKeyCredential

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.

C#/.NET

//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `FormRecognizerClient` instance
  string key = "<your-key>";
  string endpoint = "<your-endpoint>";
  FormRecognizerClient client = new FormRecognizerClient(new Uri(endpoint), new AzureKeyCredential(key));

Java

// create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
     .credential(new AzureKeyCredential("<your-key>"))
     .endpoint("<your-endpoint>")
     .buildClient();

JavaScript

// create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
async function main() {
    const client = new FormRecognizerClient("<your-endpoint>", new AzureKeyCredential("<your-key>"));

Python

# create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
    form_recognizer_client = FormRecognizerClient(endpoint="<your-endpoint>", credential=AzureKeyCredential("<your-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.

C#/.NET

Hier sehen Sie, wie Sie DefaultAzureCredential für .NET-Anwendungen abrufen und verwenden:

1. Installieren Sie die Azure Identity-Bibliothek für .NET:

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. Registrieren Sie eine Microsoft Entra-Anwendung, und erstellen Sie einen neuen Dienstprinzipal.

3. Gewähren Sie Zugriff auf Dokument Intelligenz, indem Sie Ihrem Dienstprinzipal die Rolle Cognitive Services User zuweisen.

4. 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 und AZURE_CLIENT_SECRET fest.

5. Erstellen Sie Ihre FormRecognizerClient-Instanz einschließlich DefaultAzureCredential:

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

Weitere Informationen finden Sie unter Authentifizieren des Clients.

Java

Hier sehen Sie, wie Sie DefaultAzureCredential für Java-Anwendungen abrufen und verwenden:

1. Installieren Sie die Azure Identity-Bibliothek für Java:

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.5.3</version>
   </dependency>
   

2. Registrieren Sie eine Microsoft Entra-Anwendung, und erstellen Sie einen neuen Dienstprinzipal.

3. Gewähren Sie Zugriff auf Dokument Intelligenz, indem Sie Ihrem Dienstprinzipal die Rolle Cognitive Services User zuweisen.

4. Legen Sie die Werte der Client-ID, der Mandanten-ID und des geheimen Clientschlüssels der Microsoft Entra-Anwendung als die Umgebungsvariablen AZURE_CLIENT_ID, AZURE_TENANT_ID und AZURE_CLIENT_SECRET fest.

5. Erstellen Sie Ihre FormRecognizerClient-Instanz und die Variable TokenCredential:

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

Weitere Informationen finden Sie unter Authentifizieren des Clients.

JavaScript

Hier sehen Sie, wie Sie DefaultAzureCredential für JavaScript-Anwendungen abrufen und verwenden:

1. Installieren Sie die Azure Identity-Bibliothek für JavaScript:

   npm install @azure/identity
   

2. Registrieren Sie eine Microsoft Entra-Anwendung, und erstellen Sie einen neuen Dienstprinzipal.

3. Gewähren Sie Zugriff auf Dokument Intelligenz, indem Sie Ihrem Dienstprinzipal die Rolle Cognitive Services User zuweisen.

4. Legen Sie die Werte der Client-ID, der Mandanten-ID und des geheimen Clientschlüssels der Microsoft Entra-Anwendung als die Umgebungsvariablen AZURE_CLIENT_ID, AZURE_TENANT_ID und AZURE_CLIENT_SECRET fest.

5. Erstellen Sie Ihre FormRecognizerClient-Instanz einschließlich DefaultAzureCredential:

   const { FormRecognizerClient } = require("@azure/ai-form-recognizer");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new FormRecognizerClient("<your-endpoint>", new DefaultAzureCredential());
   

Weitere Informationen finden Sie unter Erstellen und Authentifizieren eines Clients.

Python

Hier sehen Sie, wie Sie DefaultAzureCredential für Python-Anwendungen abrufen und verwenden:

1. Installieren Sie die Azure Identity-Bibliothek für Python:

   pip install azure-identity
   

2. Registrieren Sie eine Microsoft Entra-Anwendung, und erstellen Sie einen neuen Dienstprinzipal.

3. Gewähren Sie Zugriff auf Dokument Intelligenz, indem Sie Ihrem Dienstprinzipal die Rolle Cognitive Services User zuweisen.

4. Legen Sie die Werte der Client-ID, der Mandanten-ID und des geheimen Clientschlüssels der Microsoft Entra-Anwendung als die Umgebungsvariablen AZURE_CLIENT_ID, AZURE_TENANT_ID und AZURE_CLIENT_SECRET fest.

5. Erstellen Sie Ihre FormRecognizerClient-Instanz einschließlich DefaultAzureCredential:

   from azure.identity import DefaultAzureCredential
   from azure.ai.formrecognizer import FormRecognizerClient
   
   credential = DefaultAzureCredential()
   form_recognizer_client = FormRecognizerClient(
       endpoint="https://<my-custom-subdomain>.cognitiveservices.azure.com/",
       credential=credential
   )
   

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.

Nächste Schritte

Erkunden der Dokument Intelligenz-REST-API v2.1

Testen eines Dokument Intelligenz-Schnellstarts