SDK-mål: REST API 2024-07-31-preview
Viktigt!
- Versioner av den offentliga förhandsversionen av Document Intelligence ger tidig åtkomst till funktioner som är i aktiv utveckling. Funktioner, metoder och processer kan ändras, före allmän tillgänglighet (GA), baserat på användarfeedback.
- Den offentliga förhandsversionen av Dokumentinformationsklientbiblioteken är som standard REST API version 2024-07-31-preview.
- Den offentliga förhandsversionen 2024-07-31-preview är för närvarande endast tillgänglig i följande Azure-regioner. Observera att modellen för anpassad generativ (extrahering av dokumentfält) i AI Studio endast är tillgänglig i regionen USA, norra centrala:
- USA, östra
- USA, västra 2
- Europa, västra
- USA, norra centrala
REST API version 2024-07-31-preview
Azure AI Document Intelligence är en molntjänst som använder maskininlärning för att analysera text och strukturerade data från dokument. SDK (Document Intelligence Software Development Kit) är en uppsättning bibliotek och verktyg som gör att du enkelt kan integrera modeller och funktioner för dokumentinformation i dina program. Document Intelligence SDK är tillgängligt på olika plattformar i programmeringsspråken C#/.NET, Java, JavaScript och Python.
Programmeringsspråk som stöds
Document Intelligence SDK stöder följande språk och plattformar:
| Language → Document Intelligence SDK-version | Paket | API-version som stöds | Plattformssupport |
|---|---|---|---|
| .NET/C# → 1.0.0-beta.3 (förhandsversion) | NuGet | 2024-07-31 (förhandsversion) | Windows, macOS, Linux, Docker |
| Java → 1.0.0-beta.4 (förhandsversion) | Maven-lagringsplats | 2024-07-31 (förhandsversion) | Windows, macOS, Linux |
| JavaScript → 1.0.0-beta.3 (förhandsversion) | npm | 2024-07-31 (förhandsversion) | Webbläsare, Windows, macOS, Linux |
| Python → 1.0.0b4 (förhandsversion) | PyPI | 2024-07-31 (förhandsversion) | Windows, macOS, Linux |
Mer information om andra SDK-versioner finns i:
Klienter som stöds
Följande tabeller visar korrelationen mellan varje SDK-version de API-versioner som stöds av document intelligence-tjänsten.
| Språk | SDK-alias | API-version (standard) | Klienter som stöds |
|---|---|---|---|
| .NET/C# 1.0.0-beta.2 (förhandsversion) | v4.0 (förhandsversion) | 2024-07-31-preview | DocumentIntelligenceClient DocumentIntelligenceAdministrationClient |
| .NET/C# 4.1.0 | v3.1 senaste (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 |
Använda Document Intelligence SDK i dina program
Med Document Intelligence SDK kan du använda och hantera dokumentinformationstjänsten i ditt program. SDK bygger på det underliggande REST API:et för dokumentinformation så att du enkelt kan använda dessa API:er i ditt programmeringsspråkparadigm. Så här använder du Document Intelligence SDK för önskat språk:
1. Installera SDK-klientbiblioteket
dotnet add package Azure.AI.DocumentIntelligence --prerelease
Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3
2. Importera SDK-klientbiblioteket till ditt program
using Azure;
using Azure.AI.DocumentIntelligence;
3. Konfigurera autentisering
Det finns två metoder som stöds för autentisering:
Använd en API-nyckel för dokumentinformation med AzureKeyCredential från azure.core.credentials.
Använd en tokenautentiseringsuppgift från azure-identity för att autentisera med Microsoft Entra-ID.
Använda din API-nyckel
Här hittar du din API-nyckel för dokumentinformation i Azure Portal:
Viktigt!
Vi rekommenderar Microsoft Entra-ID-autentisering med hanterade identiteter för Azure-resurser för att undvika att lagra autentiseringsuppgifter med dina program som körs i molnet.
Om du använder en API-nyckel lagrar du den på ett säkert sätt någon annanstans, till exempel i Azure Key Vault. Inkludera inte API-nyckeln direkt i koden och publicera den aldrig offentligt.
Mer information om säkerhet för AI-tjänster finns i Autentisera begäranden till Azure AI-tjänster.
//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));
Använda en autentiseringsuppgift för Microsoft Entra-token
Kommentar
Regionala slutpunkter stöder inte Microsoft Entra-autentisering. Skapa en anpassad underdomän för resursen för att använda den här typen av autentisering.
Auktorisering är enklast med hjälp av DefaultAzureCredential. Den tillhandahåller en standardautentiseringsuppgift för token, baserat på den miljö som körs, som kan hantera de flesta Azure-autentiseringsscenarier.
Så här hämtar och använder du DefaultAzureCredential för .NET-program:
Installera Azure Identity-biblioteket för .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityRegistrera ett Microsoft Entra-program och skapa ett nytt huvudnamn för tjänsten.
Bevilja åtkomst till dokumentinformation genom att
Cognitive Services Usertilldela rollen till tjänstens huvudnamn.Ange värdena för klient-ID, klient-ID och klienthemlighet i Microsoft Entra-programmet som miljövariabler:
AZURE_CLIENT_ID,AZURE_TENANT_IDrespektiveAZURE_CLIENT_SECRET.Skapa din
DocumentIntelligenceClientinstans, inklusiveDefaultAzureCredential:string endpoint = "<your-endpoint>"; var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());
Mer information finns i Autentisera klienten.
4. Skapa ditt program
Skapa ett klientobjekt för att interagera med Document Intelligence SDK och anropa sedan metoder på klientobjektet för att interagera med tjänsten. SDK:erna innehåller både synkrona och asynkrona metoder. Om du vill ha mer information kan du prova en snabbstart på ett valfritt språk.
Hjälpalternativ
Forumen Microsoft Q&A och Stack Overflow är tillgängliga för utvecklarcommunityn för att ställa och svara på frågor om Azure AI Document Intelligence och andra tjänster. Microsoft övervakar forumen och svarar på frågor som communityn ännu inte har besvarat. För att vara säker använder du följande taggar så att vi ser din fråga.
Microsoft Q&A:Azure AI Document Intelligence.Stack Overflow:
azure-ai-document-intelligence.
Nästa steg
Utforska REST API 2023-10-31-rest-åtgärder för Dokumentinformation.