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-02-29-preview verziója.
• A nyilvános előzetes verzió 2024-02-29 előzetes verziója jelenleg csak a következő Azure-régiókban érhető el:
• USA keleti régiója
• USA2 nyugati régiója
• Nyugat-Európa

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:

• 2023-07-31 v3.1 (GA)
• 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 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 DocumentIntelligence Rendszergazda istrationClient
.NET/C# 4.1.0	v3.1 legújabb (GA)	2023-07-31	DocumentAnalysisClient DocumentModel Rendszergazda istrationClient
.NET/C# 4.0.0	3.0-s verzió (GA)	2022-08-31	DocumentAnalysisClient DocumentModel Rendszergazda istrationClient
.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 alias	API-verzió (alapértelmezett)	Támogatott ügyfelek
Java 1.0.0-beta.2 (előzetes verzió)	4.0-s verzió (előzetes verzió)	2024-02-29-preview	DocumentIntelligenceClient DocumentIntelligence Rendszergazda istrationClient
Java 4.1.0	v3.1 legújabb (GA)	2023-07-31	DocumentAnalysisClient DocumentModel Rendszergazda istrationClient
Java 4.0.0	3.0-s verzió (GA)	2022-08-31	DocumentAnalysisClient DocumentModel Rendszergazda istrationClient
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 alias	API-verzió (alapértelmezett)	Támogatott ügyfelek
JavaScript 1.0.0-beta.2	4.0-s verzió (előzetes verzió)	2024-02-29-preview	DocumentIntelligenceClient DocumentIntelligence Rendszergazda istrationClient
JavaScript 5.0.0	v3.1 legújabb (GA)	2023-07-31	DocumentAnalysisClient DocumentModel Rendszergazda istrationClient
JavaScript 4.0.0	3.0-s verzió (GA)	2022-08-31	DocumentAnalysisClient DocumentModel Rendszergazda istrationClient
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 alias	API-verzió (alapértelmezett)	Támogatott ügyfelek
Python 1.0.0b2	4.0-s verzió (előzetes verzió)	2024-02-29-preview	DocumentIntelligenceClient DocumentIntelligence Rendszergazda istrationClient
Python 3.3.0	v3.1 legújabb (GA)	2023-07-31	DocumentAnalysisClient DocumentModel Rendszergazda istrationClient
Python 3.2.x	3.0-s verzió (GA)	2022-08-31	DocumentAnalysisClient DocumentModel Rendszergazda istrationClient
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.DocumentIntelligence --version 1.0.0-beta.2

Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.2

Java

  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-ai-documentintelligence</artifactId>
    <version>1.0.0-beta.2</version>
  </dependency>

implementation("com.azure:azure-ai-documentintelligence:1.0.0-beta.2")

JavaScript

npm i @azure-rest/ai-document-intelligence@1.0.0-beta.2

Python

pip install azure-ai-documentintelligence==1.0.0b2

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

C#/.NET

using Azure;
using Azure.AI.DocumentIntelligence;

Java

import com.azure.ai.documentintelligence.*;
import com.azure.ai.documentintelligence.models.*;

import com.azure.core.credential.AzureKeyCredential;

JavaScript

const { AzureKeyCredential, DocumentIntelligence } = require("@azure-rest/ai-document-intelligence@1.0.0-beta.2");

Python

from azure.ai.documentintelligence import DocumentIntelligenceClient
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:

C#/.NET

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

Java

// create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
DocumentIntelligenceClient documentIntelligenceClient = new DocumentIntelligenceClientBuilder()
    .credential(new AzureKeyCredential("<your-key>"))
    .endpoint("<your-endpoint>")
    .buildClient();

JavaScript

// create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
async function main() {
    const client = DocumentIntelligence(process.env["your-endpoint>"], {
  key: process.env["<your-key>"],
});

Python

# create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
    endpoint = "<your-endpoint>"
    credential = AzureKeyCredential("<your-key>")
    document_analysis_client = DocumentIntelligenceClient(endpoint, credential)

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 DocumentIntelligenceClient , beleértve a következőt DefaultAzureCredential:

   string endpoint = "<your-endpoint>";
   var client = new DocumentIntelligenceClient(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ótDocumentIntelligenceClient:

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   DocumentIntelligenceClient documentIntelligenceClient = new DocumentIntelligenceClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

További információ: Hitelesítés.

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 DocumentIntelligenceClient , beleértve a következőt DefaultAzureCredential:

   const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence@1.0.0-beta.2");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new DocumentIntelligenceClient("<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 DocumentIntelligenceClient , beleértve a következőt DefaultAzureCredential:

   from azure.identity import DefaultAzureCredential
   from azure.ai.documentintelligence import DocumentIntelligenceClient
   
   credential = DefaultAzureCredential()
   client = DocumentIntelligenceClient(
       endpoint="<your-endpoint>",
       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 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.