Target SDK: REST API 2022–08–31 (GA)

REST API versi 2022–08–31 (GA)

Azure AI Document Intelligence adalah layanan cloud yang menggunakan pembelajaran mesin untuk menganalisis teks dan data terstruktur dari dokumen. Kit pengembangan perangkat lunak (SDK) Kecerdasan Dokumen adalah sekumpulan pustaka dan alat yang memungkinkan Anda untuk dengan mudah mengintegrasikan model dan kemampuan Kecerdasan Dokumen ke dalam aplikasi Anda. SDK Kecerdasan Dokumen tersedia di seluruh platform dalam bahasa pemrograman C#/.NET, Java, JavaScript, dan Python.

Bahasa pemrograman yang didukung

SDK Kecerdasan Dokumen mendukung bahasa dan platform berikut:

Versi SDK Kecerdasan Dokumen → Bahasa	Paket	Versi API yang didukung	Dukungan platform
.NET/C# → 4.0.0 (GA)	NuGet	v3.0	Windows, macOS, Linux, Docker
Java → 4.0.6 (GA)	Repositori Maven	v3.0	Windows, macOS, Linux
JavaScript → 4.0.0 (GA)	npm	v3.0	Browser, Windows, macOS, Linux
Python → 3.2.0 (GA)	PyPI	v3.0	Windows, macOS, Linux

Untuk informasi selengkapnya tentang versi SDK lainnya, lihat:

• 2024-02-29 v4.0 (pratinjau)

• 2023-07-31 v3.1 (GA)

• v2.1 (GA)

Klien yang didukung

Bahasa	Versi SDK	versi API	Klien yang Didukung
.NET/C# JavaScript	4.0.0 (GA)	v3.0:2022-08-31 (default)	DocumentAnalysisClient DocumentModelAdministrationClient
.NET/C# JavaScript	3.1.x	v2.1 (default) v2.0	FormRecognizerClient FormTrainingClient
.NET/C# JavaScript	3.0.x	v2.0	FormRecognizerClient FormTrainingClient
Python	3.2.x (GA)	v3.0:2022-08-31 (default)	DocumentAnalysisClient DocumentModelAdministrationClient
Python	3.1.x	v2.1 (default) v2.0	FormRecognizerClient FormTrainingClient
Python	3.0.0	v2.0	FormRecognizerClient FormTrainingClient

Menggunakan SDK Kecerdasan Dokumen di aplikasi Anda

SDK Kecerdasan Dokumen memungkinkan penggunaan dan pengelolaan layanan Kecerdasan Dokumen di aplikasi Anda. SDK dibangun pada REST API Kecerdasan Dokumen yang mendasar yang memungkinkan Anda menggunakan API tersebut dengan mudah dalam paradigma bahasa pemrograman Anda. Berikut cara Anda menggunakan SDK Kecerdasan Dokumen untuk bahasa pilihan Anda:

1. Instal pustaka klien SDK

C#/.NET

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

Install-Package Azure.AI.FormRecognizer -Version 4.0.0

Java

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

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

JavaScript

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

Python

pip install azure-ai-formrecognizer==3.2.0

2. Impor pustaka klien SDK ke dalam aplikasi Anda

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. Siapkan autentikasi

Ada dua metode yang didukung untuk autentikasi:

• Gunakan kunci API Kecerdasan Dokumen dengan AzureKeyCredential dari azure.core.credentials.

• Gunakan kredensial token dari azure-identity untuk mengautentikasi dengan ID Microsoft Entra.

Mendapatkan kunci API Anda

Berikut adalah tempat untuk menemukan kunci API Kecerdasan Dokumen Anda di portal Azure:

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>"))

Menggunakan kredensial token Microsoft Entra

Catatan

Titik akhir regional tidak mendukung autentikasi Microsoft Entra. Buat subdomain kustom untuk sumber daya Anda supaya dapat menggunakan jenis autentikasi ini.

Otorisasi paling mudah menggunakan DefaultAzureCredential. Otorisasi ini menyediakan kredensial token default, berdasarkan lingkungan yang berjalan, yang mampu menangani sebagian besar skenario autentikasi Azure.

C#/.NET

Berikut cara memperoleh dan menggunakan DefaultAzureCredential untuk aplikasi .NET:

1. Instal pustaka Azure Identity untuk .NET:

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. Daftarkan aplikasi Microsoft Entra dan buat perwakilan layanan baru.

3. Berikan akses ke Kecerdasan Dokumen dengan menetapkan peran ke Cognitive Services User perwakilan layanan Anda.

4. Tetapkan nilai ID klien, ID penyewa, dan rahasia klien di aplikasi Microsoft Entra sebagai variabel lingkungan: AZURE_CLIENT_ID, , AZURE_TENANT_IDdan AZURE_CLIENT_SECRET, masing-masing.

5. Buat instans DocumentAnalysisClientAnda, termasuk DefaultAzureCredential:

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

Untuk informasi selengkapnya, lihatMengautentikasi klien.

Java

Berikut cara memperoleh dan menggunakan DefaultAzureCredential untuk aplikasi Java:

1. Instal pustaka Azure Identity untuk Java:

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

2. Daftarkan aplikasi Microsoft Entra dan buat perwakilan layanan baru.

3. Berikan akses ke Kecerdasan Dokumen dengan menetapkan peran ke Cognitive Services User perwakilan layanan Anda.

4. Atur nilai ID klien, ID penyewa, dan rahasia klien aplikasi Microsoft Entra sebagai variabel lingkungan: AZURE_CLIENT_ID, , AZURE_TENANT_IDdan AZURE_CLIENT_SECRET, masing-masing.

5. Buat instans DocumentAnalysisClient dan variabel TokenCredential Anda:

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

Untuk informasi selengkapnya, lihatMengautentikasi klien.

JavaScript

Berikut cara memperoleh dan menggunakan DefaultAzureCredential untuk aplikasi JavaScript:

1. Instal pustaka Azure Identity untuk JavaScript:

   npm install @azure/identity
   

2. Daftarkan aplikasi Microsoft Entra dan buat perwakilan layanan baru.

3. Berikan akses ke Kecerdasan Dokumen dengan menetapkan peran ke Cognitive Services User perwakilan layanan Anda.

4. Atur nilai ID klien, ID penyewa, dan rahasia klien aplikasi Microsoft Entra sebagai variabel lingkungan: AZURE_CLIENT_ID, , AZURE_TENANT_IDdan AZURE_CLIENT_SECRET, masing-masing.

5. Buat instans DocumentAnalysisClientAnda, termasuk DefaultAzureCredential:

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

Untuk informasi selengkapnya, lihatMembuat dan mengautentikasi klien.

Python

Berikut cara memperoleh dan menggunakan DefaultAzureCredential untuk aplikasi Python.

1. Instal pustaka Azure Identity untuk Python:

   pip install azure-identity
   

2. Daftarkan aplikasi Microsoft Entra dan buat perwakilan layanan baru.

3. Berikan akses ke Kecerdasan Dokumen dengan menetapkan peran ke Cognitive Services User perwakilan layanan Anda.

4. Atur nilai ID klien, ID penyewa, dan rahasia klien aplikasi Microsoft Entra sebagai variabel lingkungan: AZURE_CLIENT_ID, , AZURE_TENANT_IDdan AZURE_CLIENT_SECRET, masing-masing.

5. Buat instans DocumentAnalysisClientAnda, termasuk 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
   )
   

Untuk informasi selengkapnya, lihatMengautentikasi klien.

4. Buat aplikasi Anda

Buat objek klien untuk berinteraksi dengan SDK Kecerdasan Dokumen, lalu panggil metode pada objek klien tersebut untuk berinteraksi dengan layanan. SDK menyediakan metode sinkron dan asinkron. Untuk wawasan selengkapnya, coba mulai cepat dalam bahasa pilihan Anda.

Opsi bantuan

Forum Microsoft Q & A dan Stack Overflow tersedia bagi komunitas pengembang untuk mengajukan dan menjawab pertanyaan tentang Kecerdasan Dokumen Azure AI dan layanan lainnya. Microsoft memantau forum dan membalas pertanyaan yang belum dijawab oleh komunitas. Untuk memastikan bahwa kami melihat pertanyaan Anda, tandai dengan azure-form-recognizer.

Langkah berikutnya

Menjelajahi REST API Kecerdasan Dokumen v3.0

Coba mulai cepat Kecerdasan Dokumen