SDK-cél: REST API 2024-02-29-preview
Fontos
- A Document Intelligence nyilvános előzetes verziójú kiadásai korai hozzáférést biztosítanak az aktív fejlesztés alatt lévő funkciókhoz. A funkciók, a megközelítések és a folyamatok az általános rendelkezésre állás (GA) előtt változhatnak a felhasználói visszajelzések alapján.
- A Document Intelligence ügyfélkódtárak nyilvános előzetes verziója alapértelmezés szerint a REST API 2024-07-31-preview verziója.
- A nyilvános előzetes verzió 2024-07-31 előzetes verziója jelenleg csak a következő Azure-régiókban érhető el. Vegye figyelembe, hogy az AI Studio egyéni generatív (dokumentummező-kinyerési) modellje csak az USA északi középső régiójában érhető el:
- USA keleti régiója
- USA2 nyugati régiója
- Nyugat-Európa
- USA északi középső régiója
REST API 2024-02-29-preview verzió
Az Azure AI Document Intelligence egy felhőalapú szolgáltatás, amely gépi tanulással elemzi a dokumentumokból származó szöveges és strukturált adatokat. A Dokumentumintelligencia szoftverfejlesztői készlet (SDK) kódtárak és eszközök készlete, amelyekkel egyszerűen integrálhatja a Dokumentumintelligencia-modelleket és -képességeket az alkalmazásokba. A Document Intelligence SDK a C#/.NET, a Java, a JavaScript és a Python programozási nyelvek platformjai között érhető el.
Támogatott programozási nyelvek
A Document Intelligence SDK a következő nyelveket és platformokat támogatja:
Language → Document Intelligence SDK-verzió | Csomag | Támogatott API-verzió | Platformtámogatás |
---|---|---|---|
.NET/C# → 1.0.0-beta.2 (előzetes verzió) | NuGet | 2024-02-29 (előzetes verzió) | Windows, macOS, Linux, Docker |
Java → 1.0.0-beta.2 (előzetes verzió) | Maven-adattár | 2024-02-29 (előzetes verzió) | Windows, macOS, Linux |
JavaScript → 1.0.0-beta.2 (előzetes verzió) | npm | 2024-02-29 (előzetes verzió) | Böngésző, Windows, macOS, Linux |
Python → 1.0.0b2 (előzetes verzió) | PyPI | 2024-02-29 (előzetes verzió) | Windows, macOS, Linux |
További információ az SDK más verzióiról:
Támogatott ügyfelek
Az alábbi táblázatok az egyes SDK-verziók és a Document Intelligence szolgáltatás támogatott API-verziói közötti korrelációt mutatják be.
Nyelv | SDK alias | API-verzió (alapértelmezett) | Támogatott ügyfelek |
---|---|---|---|
.NET/C# 1.0.0-beta.2 (előzetes verzió) | 4.0-s verzió (előzetes verzió) | 2024-02-29-preview | DocumentIntelligenceClient DocumentIntelligenceAdministrationClient |
.NET/C# 4.1.0 | v3.1 legújabb (GA) | 2023-07-31 | DocumentAnalysisClient DocumentModelAdministrationClient |
.NET/C# 4.0.0 | 3.0-s verzió (GA) | 2022-08-31 | DocumentAnalysisClient DocumentModelAdministrationClient |
.NET/C# 3.1.x | 2.1-s verzió | 2.1-s verzió | FormRecognizerClient FormTrainingClient |
.NET/C# 3.0.x | 2.0-s verzió | 2.0-s verzió | FormRecognizerClient FormTrainingClient |
A Document Intelligence SDK használata az alkalmazásokban
A Dokumentumintelligencia SDK lehetővé teszi a Dokumentumintelligencia szolgáltatás használatát és kezelését az alkalmazásban. Az SDK a mögöttes Document Intelligence REST API-ra épül, amely lehetővé teszi ezen API-k egyszerű használatát a programozási nyelvi paradigmán belül. A Dokumentumintelligencia SDK használata az előnyben részesített nyelvhez:
1. Az SDK-ügyfélkódtár telepítése
dotnet add package Azure.AI.DocumentIntelligence --version 1.0.0-beta.2
Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.2
2. Az SDK-ügyfélkódtár importálása az alkalmazásba
using Azure;
using Azure.AI.DocumentIntelligence;
3. Hitelesítés beállítása
A hitelesítéshez két támogatott módszer létezik:
A Document Intelligence API-kulcs és az AzureKeyCredential használata az azure.core.credentials-ből.
Az Azure-identitásból származó jogkivonat hitelesítő adataival hitelesíthet a Microsoft Entra-azonosítóval.
Az API-kulcs használata
Itt találja meg a Document Intelligence API-kulcsot az Azure Portalon:
Fontos
Az Azure-erőforrásokhoz tartozó felügyelt identitásokkal rendelkező Microsoft Entra ID-hitelesítést javasoljuk, hogy ne tárolja a hitelesítő adatokat a felhőben futó alkalmazásokkal.
HA API-kulcsot használ, biztonságosan tárolja valahol máshol, például az Azure Key Vaultban. Ne foglalja bele közvetlenül az API-kulcsot a kódba, és soha ne tegye közzé nyilvánosan.
Az AI-szolgáltatások biztonságáról további információt az Azure AI-szolgáltatásokhoz érkező kérelmek hitelesítése című témakörben talál.
//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));
Microsoft Entra-jogkivonat hitelesítő adatainak használata
Feljegyzés
A regionális végpontok nem támogatják a Microsoft Entra-hitelesítést. Hozzon létre egy egyéni altartományt az erőforráshoz az ilyen típusú hitelesítés használatához.
Az engedélyezés a legegyszerűbb a DefaultAzureCredential
. A futó környezeten alapuló alapértelmezett jogkivonat-hitelesítő adatokat biztosít, amely képes kezelni a legtöbb Azure-hitelesítési forgatókönyvet.
A DefaultAzureCredential beszerzése és használata .NET-alkalmazásokhoz:
Telepítse a .NET-hez készült Azure Identity-kódtárat:
dotnet add package Azure.Identity
Install-Package Azure.Identity
Regisztráljon egy Microsoft Entra-alkalmazást, és hozzon létre egy új szolgáltatásnevet.
Adjon hozzáférést a Dokumentumintelligencia szolgáltatásnévhez rendelhető
Cognitive Services User
szerepkörhöz.Állítsa be a Microsoft Entra alkalmazás ügyfélazonosítójának, bérlőazonosítójának és ügyféltitkának értékeit környezeti változóként:
AZURE_CLIENT_ID
,AZURE_TENANT_ID
ésAZURE_CLIENT_SECRET
, illetve.Hozza létre a példányt
DocumentIntelligenceClient
, beleértve a következőtDefaultAzureCredential
:string endpoint = "<your-endpoint>"; var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());
További információ: Az ügyfél hitelesítése.
4. Az alkalmazás létrehozása
Hozzon létre egy ügyfélobjektumot a Dokumentumintelligencia SDK használatához, majd hívja meg az adott ügyfélobjektum metódusát a szolgáltatással való interakcióhoz. Az SDK-k szinkron és aszinkron metódusokat is biztosítanak. További információkért próbálkozzon egy gyorsútmutatóval egy tetszőleges nyelven.
Súgóbeállítások
A Microsoft Q&A
Stack Overflow fórumai a fejlesztői közösség számára érhetők el, hogy kérdéseket tegyenek fel és válaszoljanak meg az Azure AI-dokumentumintelligencia-szolgáltatással és más szolgáltatásokkal kapcsolatban. A Microsoft figyeli azokat a fórumokat és válaszokat, amelyekre a közösség még nem válaszolt. A kérdés megtekintéséhez használja az alábbi címkéket.
Microsoft Q&A
:Azure AI Document Intelligence
.Stack Overflow:
azure-ai-document-intelligence
.
Következő lépések
Ismerkedjen meg a Document Intelligence REST API 2023-10-31 rest műveletekkel.