Target SDK: REST API 2022–08–31 v3.0

REST API versi 2022–08–31 v3.0

Penting

• REST API Kecerdasan Dokumen 2022-08-31 v3.0 mencapai akhir dukungan pada 30 Maret 2029.
• Untuk menghindari gangguan produksi, gunakan Azure Document Intelligence 2024-11-30 v4.0 untuk semua pengembangan baru, dan migrasikan beban kerja yang ada ke Azure Kecerdasan Dokumen 2024-11-30 v4.0 sebelum tanggal ini. Untuk informasi selengkapnya, lihat Panduan migrasi Kecerdasan Dokumen.

Azure Kecerdasan Dokumen di Foundry Tools 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:

Bahasa → Versi SDK Kecerdasan Dokumen	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:

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

• v2.1 (GA)

Klien yang Didukung

Bahasa	Versi SDK	Versi API	Klien yang didukung
.NET/C# Java JavaScript	4.0.0 (GA)	v3.0:2022-08-31 (default)	DocumentAnalysisClient DocumentModelAdministrationClient
.NET/C# Java JavaScript	3.1.x	v2.1 (bawaan) v2.0	FormRecognizerClient FormTrainingClient
.NET/C# Java 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 (bawaan) 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. Menyiapkan 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 Microsoft Entra ID.

Menggunakan kunci API Anda

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

Penting

Sebaiknya autentikasi Microsoft Entra ID dengan identitas terkelola untuk sumber daya Azure untuk menghindari penyimpanan kredensial pada aplikasi Anda yang berjalan di cloud.

Jika Anda menggunakan kunci API, simpan dengan aman di tempat lain, seperti di Azure Key Vault. Jangan sertakan kunci API langsung dalam kode Anda, dan jangan pernah mempostingnya secara publik.

Untuk informasi selengkapnya tentang keamanan layanan AI, lihat cara mengotentikasi permintaan ke layanan Azure AI.

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 untuk menggunakan jenis autentikasi ini.

Otorisasi paling mudah menggunakan DefaultAzureCredential. 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. Register aplikasi Microsoft Entra dan buat perwakilan layanan baru.

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

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

5. Buat instans Anda DocumentAnalysisClient termasuk DefaultAzureCredential:

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

Untuk informasi selengkapnya, lihatAutentikasi klien.

Java

Berikut cara memperoleh dan menggunakan DefaultAzureCredential untuk aplikasi Java:

1. Instal pustaka Identitas Azure untuk Java:

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

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

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

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

5. Buat DocumentAnalysisClient instans dan variabel TokenCredential Anda:

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

Untuk informasi selengkapnya, lihatAutentikasi klien.

Javascript

Berikut cara memperoleh dan menggunakan DefaultAzureCredential untuk aplikasi JavaScript:

1. Instal pustaka Azure Identity untuk JavaScript:

   npm install @azure/identity
   

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

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

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

5. Buat instans Anda DocumentAnalysisClient 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, lihatBuat dan autentikasi klien.

Python

Berikut cara memperoleh dan menggunakan DefaultAzureCredential untuk aplikasi Python.

1. Instal pustaka identitas Azure untuk Python:

   pip install azure-identity
   

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

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

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

5. Buat instans Anda DocumentAnalysisClient 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, lihatAutentikasi klien.

4. Bangun 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 lebih lanjut, coba panduan cepat dalam bahasa pilihan Anda.

Opsi bantuan

Forum Microsoft Q & A dan Stack Overflow tersedia bagi komunitas pengembang untuk mengajukan dan menjawab pertanyaan tentang Azure Document Intelligence 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