SDK target: REST API v3.1 (GA)

🟩 REST API versi 2023-07-31 (GA)

Kecerdasan Dokumen Azure 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# → latest (GA) NuGet 2023-07-31 (GA)
Java → latest (GA) Repositori Maven 2023-07-31 (GA) Windows, macOS, Linux
JavaScript → latest (GA) npm 2023-07-31 (GA) Browser, Windows, macOS, Linux
Python → latest (GA) PyPI 2023-07-31 (GA) Windows, macOS, Linux

Untuk informasi selengkapnya tentang versi SDK lainnya, lihat:

Klien yang didukung

Tabel berikut menyajikan korelasi antara setiap versi SDK versi API yang didukung dari layanan Kecerdasan Dokumen.

Bahasa Versi SDK Versi API (default) Klien yang Didukung
.NET/C# 4.1.0 v3.1 terbaru (GA) 2023-07-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 4.0.0 v3.0 (GA) 2022-08-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 3.1.x v2.1 v2.1 FormRecognizerClient
FormTrainingClient
.NET/C# 3.0.x v2.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 di atas REST API Document Intelligence yang mendasari, sehingga Anda dapat dengan mudah menggunakan API tersebut sesuai paradigma bahasa pemrograman Anda. Berikut cara Anda menggunakan SDK Kecerdasan Dokumen untuk bahasa pilihan Anda:

1. Instal pustaka klien SDK

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

Install-Package Azure.AI.FormRecognizer -Version 4.1.0

2. Impor pustaka klien SDK ke dalam aplikasi Anda

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

3. Siapkan autentikasi

Ada dua metode yang didukung untuk autentikasi:

Gunakan kunci API Anda

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

Cuplikan layar lokasi titik akhir dan kunci di portal Azure.

Penting

Kami merekomendasikan autentikasi ID Microsoft Entra dengan identitas terkelola untuk sumber daya Azure untuk menghindari penyimpanan kredensial dengan 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 Mengautentikasi permintaan ke layanan Azure AI.


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

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. Ini menyediakan kredensial token default berdasarkan lingkungan tempatnya berjalan dan dapat menangani sebagian besar skenario autentikasi Azure.

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 Document Intelligence dengan menetapkan peran Cognitive Services User kepada prinsipal 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 Anda DocumentAnalysisClient dengan menyertakan DefaultAzureCredential:

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

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 informasi lebih lanjut, coba panduan memulai cepat dalam bahasa yang Anda pilih.

Opsi bantuan

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

Jelajahi operasi REST API Kecerdasan Dokumen 2023-07-31.

  • Last updated on