SDK-cél: REST API 2023-07-31 (GA)

REST API 2023-07-31-es verzió (GA)

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# → legújabb (GA)	NuGet	2023-07-31 (GA)
Java → legújabb (GA)	Maven-adattár	2023-07-31 (GA)	Windows, macOS, Linux
JavaScript → legújabb (GA)	npm	2023-07-31 (GA)	Böngésző, Windows, macOS, Linux
Python → legújabb (GA)	PyPI	2023-07-31 (GA)	Windows, macOS, Linux

További információ az SDK más verzióiról:

• 2024-02-29 4.0-s verzió (előzetes verzió)

• 2022-08-31 3.0-s verzió (GA)

• v2.1 (GA)

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.

C#/.NET

Nyelv	SDK verziója	API-verzió (alapértelmezett)	Támogatott ügyfelek
.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

Java

Nyelv	SDK verziója	API-verzió	Támogatott ügyfelek
Java 4.1.0	v3.1 legújabb (GA)	2023-07-31 (alapértelmezett)	DocumentAnalysisClient DocumentModelAdministrationClient
Java 4.0.0	3.0-s verzió (GA)	2022-08-31	DocumentAnalysisClient DocumentModelAdministrationClient
Java 3.1.x	2.1-s verzió	2.1-s verzió	FormRecognizerClient FormTrainingClient
Java 3.0.x	2.0-s verzió	2.0-s verzió	FormRecognizerClient FormTrainingClient

JavaScript

Nyelv	SDK verziója	API-verzió (alapértelmezett)	Támogatott ügyfelek
JavaScript 5.0.0	v3.1 legújabb (GA)	2023-07-31 (alapértelmezett)	DocumentAnalysisClient DocumentModelAdministrationClient
JavaScript 4.0.0	3.0-s verzió (GA)	2022-08-31	DocumentAnalysisClient DocumentModelAdministrationClient
JavaScript 3.1.x	2.1-s verzió	2.1-s verzió	FormRecognizerClient FormTrainingClient
JavaScript 3.0.x	2.0-s verzió	2.0-s verzió	FormRecognizerClient FormTrainingClient

Python

Nyelv	SDK verziója	API-verzió (alapértelmezett)	Támogatott ügyfelek
Python 3.3.0	v3.1 (legújabb (GA)	2023-07-31 (alapértelmezett)	DocumentAnalysisClient DocumentModelAdministrationClient
Python 3.2.x	3.0-s verzió (GA)	2022-08-31	DocumentAnalysisClient DocumentModelAdministrationClient
Python 3.1.x	2.1-s verzió	2.1-s verzió	FormRecognizerClient FormTrainingClient
Python 3.0.0	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

C#/.NET

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

Install-Package Azure.AI.FormRecognizer -Version 4.1.0

Java

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

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

JavaScript

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

Python

pip install azure-ai-formrecognizer==3.3.0

2. Az SDK-ügyfélkódtár importálása az alkalmazásba

C#/.NET

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

Java

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

import com.azure.core.credential.AzureKeyCredential;

JavaScript

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

Python

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

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.

C#/.NET

//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);

Java

// create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
DocumentAnalysisClient client = new DocumentAnalysisClientBuilder()
            .credential(new AzureKeyCredential("<your-key>"))
            .endpoint("<your-endpoint>")
            .buildClient();

JavaScript

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

Python

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

C#/.NET

A DefaultAzureCredential beszerzése és használata .NET-alkalmazásokhoz:

1. Telepítse a .NET-hez készült Azure Identity-kódtárat:

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. Regisztráljon egy Microsoft Entra-alkalmazást, és hozzon létre egy új szolgáltatásnevet.

3. Adjon hozzáférést a Dokumentumintelligencia szolgáltatásnévhez rendelhető Cognitive Services User szerepkörhöz.

4. Á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és AZURE_CLIENT_SECRET, illetve.

5. Hozza létre a példányt DocumentAnalysisClient , beleértve a következőt DefaultAzureCredential:

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

További információ: Az ügyfél hitelesítése.

Java

Az alábbiak szerint szerezheti be és használhatja a DefaultAzureCredentialt Java-alkalmazásokhoz:

1. Telepítse a Java-hoz készült Azure Identity-kódtárat:

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

2. Regisztráljon egy Microsoft Entra-alkalmazást, és hozzon létre egy új szolgáltatásnevet.

3. Adjon hozzáférést a Dokumentumintelligencia szolgáltatásnévhez rendelhető Cognitive Services User szerepkörhöz.

4. Állítsa be a Microsoft Entra-alkalmazás ügyfélazonosítójának, bérlőazonosítójának és titkos ügyfélkulcsának értékeit környezeti változókként: AZURE_CLIENT_ID, AZURE_TENANT_IDés AZURE_CLIENT_SECRET, illetve.

5. Hozza létre a példányt és a TokenCredential változótDocumentAnalysisClient:

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

További információ: Az ügyfél hitelesítése.

JavaScript

Az alábbiak szerint szerezheti be és használhatja a DefaultAzureCredentialt JavaScript-alkalmazásokhoz:

1. Telepítse a JavaScripthez készült Azure Identity-kódtárat:

   npm install @azure/identity
   

2. Regisztráljon egy Microsoft Entra-alkalmazást, és hozzon létre egy új szolgáltatásnevet.

3. Adjon hozzáférést a Dokumentumintelligencia szolgáltatásnévhez rendelhető Cognitive Services User szerepkörhöz.

4. Állítsa be a Microsoft Entra-alkalmazás ügyfélazonosítójának, bérlőazonosítójának és titkos ügyfélkulcsának értékeit környezeti változókként: AZURE_CLIENT_ID, AZURE_TENANT_IDés AZURE_CLIENT_SECRET, illetve.

5. Hozza létre a példányt DocumentAnalysisClient , beleértve a következőt DefaultAzureCredential:

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

További információ: Ügyfél létrehozása és hitelesítése.

Python

Az alábbiakban bemutatjuk, hogyan szerezheti be és használhatja a DefaultAzureCredential for Python-alkalmazásokat.

1. Telepítse a Pythonhoz készült Azure Identity-kódtárat:

   pip install azure-identity
   

2. Regisztráljon egy Microsoft Entra-alkalmazást, és hozzon létre egy új szolgáltatásnevet.

3. Adjon hozzáférést a Dokumentumintelligencia szolgáltatásnévhez rendelhető Cognitive Services User szerepkörhöz.

4. Állítsa be a Microsoft Entra-alkalmazás ügyfélazonosítójának, bérlőazonosítójának és titkos ügyfélkulcsának értékeit környezeti változókként: AZURE_CLIENT_ID, AZURE_TENANT_IDés AZURE_CLIENT_SECRET, illetve.

5. Hozza létre a példányt DocumentAnalysisClient , beleértve a következőt DefaultAzureCredential:

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

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 és a Stack Overflow fórumai a fejlesztői közösség számára is elérhetők, 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. Annak érdekében, hogy biztosan láthassuk a kérdését, címkézze meg a következővel azure-form-recognizer: .

Következő lépések

Ismerkedjen meg a Document Intelligence REST API 2023-07-31 műveletekkel.