SDK-doel: REST API 2023-07-31 (GA)
REST API-versie 2023-07-31 (GA)
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# → meest recente (GA) | NuGet | 2023-07-31 (GA) | |
| Java → meest recente versie (GA) | Maven-opslagplaats | 2023-07-31 (GA) | Windows, macOS, Linux |
| JavaScript → meest recente versie (GA) | npm | 2023-07-31 (GA) | Browser, Windows, macOS, Linux |
| Python → meest recente (GA) | PyPI | 2023-07-31 (GA) | Windows, macOS, Linux |
Zie voor meer informatie over andere SDK-versies:
Ondersteunde clients
De volgende tabellen bevatten de correlatie tussen elke SDK-versie de ondersteunde API-versies van de Document Intelligence-service.
| Taal | SDK-versie | API-versie (standaard) | Ondersteunde clients |
|---|---|---|---|
| .NET/C# 4.1.0 | v3.1 nieuwste versie (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 |
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
dotnet add package Azure.AI.FormRecognizer --version 4.1.0
Install-Package Azure.AI.FormRecognizer -Version 4.1.0
2. Importeer de SDK-clientbibliotheek in uw toepassing
using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;
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.
//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);
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.
U kunt als volgt de DefaultAzureCredential voor .NET-toepassingen verkrijgen en gebruiken:
Installeer de Azure Identity-bibliotheek voor .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityRegistreer een Microsoft Entra-toepassing en maak een nieuwe service-principal.
Verwijs toegang tot Document Intelligence door de
Cognitive Services Userrol toe te wijzen aan uw service-principal.Stel de waarden van de client-id, tenant-id en clientgeheim in de Microsoft Entra-toepassing in als omgevingsvariabelen:
AZURE_CLIENT_ID,AZURE_TENANT_IDenAZURE_CLIENT_SECRETrespectievelijk.Maak uw
DocumentAnalysisClientexemplaar, inclusief hetDefaultAzureCredentialvolgende:string endpoint = "<your-endpoint>"; var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
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.