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

REST API versie v2.1 (GA) 21-06-08

Azure AI Document Intelligence is een cloudservice die machine learning gebruikt om tekst en gestructureerde gegevens uit documenten te analyseren. De Document Intelligence Software Development Kit (SDK) is een set bibliotheken en hulpprogramma's waarmee u eenvoudig Document Intelligence-modellen en -mogelijkheden in uw toepassingen kunt integreren. De Document Intelligence SDK is beschikbaar op verschillende platforms in programmeertalen C#/.NET, Java, JavaScript en Python.

Ondersteunde programmeertalen

Document Intelligence SDK ondersteunt de volgende talen en platforms:

Language → Document Intelligence SDK-versie	Pakket	Ondersteunde API-versie	Platformondersteuning
.NET/C# → 3.1.x (GA)	NuGet	v2.1	Windows, macOS, Linux, Docker
Java → 3.1.x (GA)	Maven-opslagplaats	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

Zie voor meer informatie over andere SDK-versies:

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

Ondersteunde clients

Taal	SDK-versie	API-versie	Ondersteunde clients
.NET/C# JavaScript	3.1.x	v2.1 (standaard) v2.0	FormRecognizerClient FormTrainingClient
.NET/C# JavaScript	3.0.x	v2.0	FormRecognizerClient FormTrainingClient
Python	3.1.x	v2.1 (standaard) v2.0	FormRecognizerClient FormTrainingClient
Python	3.0.0	v2.0	FormRecognizerClient FormTrainingClient

Document Intelligence SDK gebruiken in uw toepassingen

De Document Intelligence SDK maakt het gebruik en beheer van de Document Intelligence-service in uw toepassing mogelijk. De SDK bouwt voort op de onderliggende Document Intelligence REST API, zodat u deze API's eenvoudig kunt gebruiken binnen uw programmeertaalparadigma. U gebruikt de Document Intelligence SDK als volgt voor uw voorkeurstaal:

1. Installeer de SDK-clientbibliotheek

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. Importeer de SDK-clientbibliotheek in uw toepassing

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. Verificatie instellen

Er zijn twee ondersteunde methoden voor verificatie.

• Gebruik een Document Intelligence API-sleutel met AzureKeyCredential van azure.core.credentials.

• Gebruik een tokenreferentie van azure-identity om te verifiëren met Microsoft Entra-id.

Uw API-sleutel gebruiken

Hier vindt u uw Document Intelligence-API-sleutel in Azure Portal:

Belangrijk

We raden Microsoft Entra ID-verificatie aan met beheerde identiteiten voor Azure-resources om te voorkomen dat referenties worden opgeslagen met uw toepassingen die in de cloud worden uitgevoerd.

Als u een API-sleutel gebruikt, slaat u deze veilig op ergens anders op, zoals in Azure Key Vault. Neem de API-sleutel niet rechtstreeks in uw code op en plaats deze nooit openbaar.

Zie Aanvragen verifiëren bij Azure AI-services voor meer informatie over beveiliging van AI-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>"))

Een Microsoft Entra-tokenreferentie gebruiken

Notitie

Regionale eindpunten bieden geen ondersteuning voor Microsoft Entra-verificatie. Maak een aangepast subdomein voor uw resource om dit type verificatie te gebruiken.

Autorisatie is het eenvoudigst met behulp van de DefaultAzureCredential. Het biedt een standaardtokenreferentie, op basis van de actieve omgeving, die de meeste Azure-verificatiescenario's kan verwerken.

C#/.NET

U kunt als volgt de DefaultAzureCredential voor .NET-toepassingen verkrijgen en gebruiken:

1. Installeer de Azure Identity-bibliotheek voor .NET:

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. Registreer een Microsoft Entra-toepassing en maak een nieuwe service-principal.

3. Verwijs toegang tot Document Intelligence door de Cognitive Services User rol toe te wijzen aan uw service-principal.

4. Stel de waarden van de client-id, tenant-id en clientgeheim in de Microsoft Entra-toepassing in als omgevingsvariabelen: AZURE_CLIENT_ID, AZURE_TENANT_IDen AZURE_CLIENT_SECRETrespectievelijk.

5. Maak uw FormRecognizerClient exemplaar, inclusief het DefaultAzureCredentialvolgende:

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

Zie De client verifiëren voor meer informatie.

Java

U kunt als volgt de DefaultAzureCredential voor Java-toepassingen verkrijgen en gebruiken:

1. Installeer de Azure Identity-bibliotheek voor Java:

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

2. Registreer een Microsoft Entra-toepassing en maak een nieuwe service-principal.

3. Verwijs toegang tot Document Intelligence door de Cognitive Services User rol toe te wijzen aan uw service-principal.

4. Stel de waarden van de client-id, tenant-id en clientgeheim van de Microsoft Entra-toepassing in als omgevingsvariabelen: AZURE_CLIENT_ID, AZURE_TENANT_IDen AZURE_CLIENT_SECRETrespectievelijk.

5. Maak uw FormRecognizerClient exemplaar en TokenCredential variabele:

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

Zie De client verifiëren voor meer informatie.

JavaScript

U kunt als volgt de DefaultAzureCredential verkrijgen en gebruiken voor JavaScript-toepassingen:

1. Installeer de Azure Identity-bibliotheek voor JavaScript:

   npm install @azure/identity
   

2. Registreer een Microsoft Entra-toepassing en maak een nieuwe service-principal.

3. Verwijs toegang tot Document Intelligence door de Cognitive Services User rol toe te wijzen aan uw service-principal.

4. Stel de waarden van de client-id, tenant-id en clientgeheim van de Microsoft Entra-toepassing in als omgevingsvariabelen: AZURE_CLIENT_ID, AZURE_TENANT_IDen AZURE_CLIENT_SECRETrespectievelijk.

5. Maak uw FormRecognizerClient exemplaar, inclusief het DefaultAzureCredentialvolgende:

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

Zie Een client maken en verifiëren voor meer informatie.

Python

U kunt als volgt de DefaultAzureCredential voor Python-toepassingen verkrijgen en gebruiken.

1. Installeer de Azure Identity-bibliotheek voor Python:

   pip install azure-identity
   

2. Registreer een Microsoft Entra-toepassing en maak een nieuwe service-principal.

3. Verwijs toegang tot Document Intelligence door de Cognitive Services User rol toe te wijzen aan uw service-principal.

4. Stel de waarden van de client-id, tenant-id en clientgeheim van de Microsoft Entra-toepassing in als omgevingsvariabelen: AZURE_CLIENT_ID, AZURE_TENANT_IDen AZURE_CLIENT_SECRETrespectievelijk.

5. Maak uw FormRecognizerClient exemplaar, inclusief het DefaultAzureCredentialvolgende:

   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
   )
   

Zie De client verifiëren voor meer informatie.

4. Uw toepassing bouwen

Maak een clientobject om te communiceren met de Document Intelligence SDK en roep vervolgens methoden aan voor dat clientobject om te communiceren met de service. De SDK's bieden zowel synchrone als asynchrone methoden. Probeer een quickstart in een taal van uw keuze voor meer inzicht.

Help-opties

De Microsoft Q & A - en Stack Overflow-forums zijn beschikbaar voor de ontwikkelaarscommunity om vragen te stellen en te beantwoorden over Azure AI Document Intelligence en andere services. Microsoft bewaakt de forums en beantwoordt vragen die de community nog moet beantwoorden. Om er zeker van te zijn dat we uw vraag zien, tagt u deze met azure-form-recognizer.

Volgende stappen

Document Intelligence REST API v2.1 verkennen

Een quickstart voor Document Intelligence uitproberen