SDK hedefi: REST API 2022–08–31 (GA)
! [Belge Yönetim Bilgileri onay işareti].. /media/yes-icon.png) REST API sürüm 2022–08–31 (GA)
Azure AI Document Intelligence, belgelerden metin ve yapılandırılmış verileri analiz etmek için makine öğrenmesini kullanan bir bulut hizmetidir. Belge Zekası yazılım geliştirme seti (SDK), Belge Zekası modellerini ve özelliklerini uygulamalarınızla kolayca tümleştirmenizi sağlayan bir kitaplık ve araç kümesidir. Belge Zekası SDK'sı C#/.NET, Java, JavaScript ve Python programlama dillerindeki platformlarda kullanılabilir.
Desteklenen programlama dilleri
Belge Zekası SDK'sı aşağıdaki dilleri ve platformları destekler:
| Dil → Belge Yönetim Bilgileri SDK sürümü | Paket | Desteklenen API sürümü | Platform desteği |
|---|---|---|---|
| .NET/C# → 4.0.0 (GA) | NuGet | v3.0 | Windows, macOS, Linux, Docker |
| Java → 4.0.6 (GA) | Maven deposu | v3.0 | Windows, macOS, Linux |
| JavaScript → 4.0.0 (GA) | npm | v3.0 | Tarayıcı, Windows, macOS, Linux |
| Python → 3.2.0 (GA) | PyPI | v3.0 | Windows, macOS, Linux |
Diğer SDK sürümleri hakkında daha fazla bilgi için bkz:
Desteklenen İstemciler
| Dil | SDK sürümü | API sürümü | Desteklenen istemciler |
|---|---|---|---|
| .NET/C# JavaScript |
4.0.0 (GA) | v3.0:2022-08-31 (varsayılan) | DocumentAnalysisClient DocumentModelAdministrationClient |
| .NET/C# JavaScript |
3.1.x | v2.1 (varsayılan) v2.0 |
FormRecognizerClient FormTrainingClient |
| .NET/C# JavaScript |
3.0.x | v2.0 | FormRecognizerClient FormTrainingClient |
| Python | 3.2.x (GA) | v3.0:2022-08-31 (varsayılan) | DocumentAnalysisClient DocumentModelAdministrationClient |
| Python | 3.1.x | v2.1 (varsayılan) v2.0 |
FormRecognizerClient FormTrainingClient |
| Python | 3.0.0 | v2.0 | FormRecognizerClient FormTrainingClient |
Uygulamalarınızda Belge Zekası SDK'sı kullanma
Belge Yönetim Bilgileri SDK'sı, uygulamanızda Belge Yönetim Bilgileri hizmetinin kullanılmasını ve yönetilmesini sağlar. SDK, temel alınan Belge Zekası REST API'sini temel alır ve bu API'leri programlama dili paradigması içinde kolayca kullanmanıza olanak sağlar. Tercih ettiğiniz dil için Belge Zekası SDK'sını şu şekilde kullanabilirsiniz:
1. SDK istemci kitaplığını yükleme
dotnet add package Azure.AI.FormRecognizer --version 4.0.0
Install-Package Azure.AI.FormRecognizer -Version 4.0.0
2. SDK istemci kitaplığını uygulamanıza aktarma
using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;
3. Kimlik doğrulamayı ayarlama
Kimlik doğrulaması için desteklenen iki yöntem vardır:
Azure.core.credentials'tan AzureKeyCredential ile Bir Belge Zekası API anahtarı kullanın.
Microsoft Entra Id ile kimlik doğrulaması yapmak için azure-identity'den belirteç kimlik bilgilerini kullanın.
API anahtarınızı kullanma
Azure portalında Belge Zekası API anahtarınızı burada bulabilirsiniz:
Önemli
Kimlik bilgilerini bulutta çalışan uygulamalarınızla depolamaktan kaçınmak için Azure kaynakları için yönetilen kimliklerle Microsoft Entra Id kimlik doğrulaması yapmanızı öneririz.
API anahtarı kullanıyorsanız, bunu Azure Key Vault gibi başka bir yerde güvenli bir şekilde depolayın. API anahtarını doğrudan kodunuzla eklemeyin ve hiçbir zaman herkese açık olarak göndermeyin.
Yapay zeka hizmetleri güvenliği hakkında daha fazla bilgi için bkz . Azure AI hizmetlerine yönelik isteklerin kimliğini doğrulama.
//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);
Microsoft Entra belirteci kimlik bilgilerini kullanma
Not
Bölgesel uç noktalar Microsoft Entra kimlik doğrulamayı desteklemez. Bu kimlik doğrulama türünü kullanmak için kaynağınız için özel bir alt etki alanı oluşturun.
Yetkilendirme, kullanarak en kolayıdır DefaultAzureCredential. Azure kimlik doğrulama senaryolarının çoğunu işleyebilen, çalışan ortamı temel alan varsayılan bir belirteç kimlik bilgisi sağlar.
.NET uygulamaları için DefaultAzureCredential'ı şu şekilde edinip kullanabilirsiniz:
.NET için Azure Kimlik kitaplığını yükleyin:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityBir Microsoft Entra uygulaması kaydedin ve yeni bir hizmet sorumlusu oluşturun.
Rolü hizmet sorumlunuza atayarak
Cognitive Services UserBelge Yönetim Bilgilerine erişim verin.Microsoft Entra uygulamasında istemci kimliği, kiracı kimliği ve istemci gizli dizisi değerlerini sırasıyla ,
AZURE_TENANT_IDveAZURE_CLIENT_SECRETortam değişkenleriAZURE_CLIENT_IDolarak ayarlayın.örneğinizi oluşturun ve örneğinizi
DocumentAnalysisClientDefaultAzureCredentialoluşturun:string endpoint = "<your-endpoint>"; var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
Daha fazla bilgi için bkz. İstemcinin kimliğini doğrulama.
4. Uygulamanızı derleme
Belge Yönetim Bilgileri SDK'sı ile etkileşim kurmak için bir istemci nesnesi oluşturun ve ardından hizmetle etkileşim kurmak için bu istemci nesnesinde yöntemleri çağırın. SDK'lar hem zaman uyumlu hem de zaman uyumsuz yöntemler sağlar. Daha fazla içgörü için, seçtiğiniz dilde bir hızlı başlangıç deneyin.
Yardım seçenekleri
Microsoft Soru-Cevap ve Stack Overflow forumları, geliştirici topluluğunun Azure AI Belge Zekası ve diğer hizmetler hakkında sorular sorması ve yanıtlaması için kullanılabilir. Microsoft forumları izler ve topluluğun henüz yanıtlamadığı soruları yanıtlar. Sorunuzu gördüğümüzden emin olmak için ile azure-form-recognizeretiketleyin.