Target SDK: REST API 2024-07-31-preview
Penting
- Rilis pratinjau publik Kecerdasan Dokumen menyediakan akses awal ke fitur yang sedang dalam pengembangan aktif. Fitur, pendekatan, dan proses dapat berubah, sebelum Ketersediaan Umum (GA), berdasarkan umpan balik pengguna.
- Versi pratinjau publik pustaka klien Kecerdasan Dokumen default ke REST API versi 2024-07-31-preview.
- Pratinjau publik versi 2024-07-31-preview saat ini hanya tersedia di wilayah Azure berikut. Perhatikan bahwa model generatif kustom (ekstraksi bidang dokumen) di AI Studio hanya tersedia di wilayah US Tengah Utara:
- US Timur
- US Barat2
- Eropa Barat
- US Tengah Utara
REST API versi 2024-07-31-preview
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# → 1.0.0-beta.3 (pratinjau) | NuGet | 2024-07-31 (pratinjau) | Windows, macOS, Linux, Docker |
| Java → 1.0.0-beta.4 (pratinjau) | Repositori Maven | 2024-07-31 (pratinjau) | Windows, macOS, Linux |
| JavaScript → 1.0.0-beta.3 (pratinjau) | npm | 2024-07-31 (pratinjau) | Browser, Windows, macOS, Linux |
| Python → 1.0.0b4 (pratinjau) | PyPI | 2024-07-31 (pratinjau) | 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 | Alias SDK | Versi API (default) | Klien yang Didukung |
|---|---|---|---|
| .NET/C# 1.0.0-beta.2 (pratinjau) | v4.0 (pratinjau) | Pratinjau 07-31 2024 | DocumentIntelligenceClient DocumentIntelligenceAdministrationClient |
| .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 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
dotnet add package Azure.AI.DocumentIntelligence --prerelease
Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3
2. Impor pustaka klien SDK ke dalam aplikasi Anda
using Azure;
using Azure.AI.DocumentIntelligence;
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:
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 `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));
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.
Berikut cara memperoleh dan menggunakan DefaultAzureCredential untuk aplikasi .NET:
Instal pustaka Azure Identity untuk .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityDaftarkan aplikasi Microsoft Entra dan buat perwakilan layanan baru.
Berikan akses ke Kecerdasan Dokumen dengan menetapkan peran ke
Cognitive Services Userperwakilan layanan Anda.Tetapkan nilai ID klien, ID penyewa, dan rahasia klien di aplikasi Microsoft Entra sebagai variabel lingkungan:
AZURE_CLIENT_ID, ,AZURE_TENANT_IDdanAZURE_CLIENT_SECRET, masing-masing.Buat instans
DocumentIntelligenceClientAnda, termasukDefaultAzureCredential:string endpoint = "<your-endpoint>"; var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());
Untuk informasi selengkapnya, lihat Mengautentikasi 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, gunakan tag berikut sehingga kami melihat pertanyaan Anda.
Microsoft Q&A: .Azure AI Document IntelligenceStack Overflow:
azure-ai-document-intelligence.
Langkah berikutnya
Jelajahi Rest API Kecerdasan Dokumen 2023-10-31-rest operasi.