İngilizce dilinde oku

Aracılığıyla paylaş

SDK hedefi: REST API v4.0 (GA)

  • Makale

Belge Yönetim Bilgileri onay işareti REST API sürüm 2024-11-30 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# → 1.0.0 (GA) NuGet 2024-11-30 (GA) Windows, macOS, Linux, Docker
Java → 1.0.0 (GA) Maven deposu 2024-11-30 (GA) Windows, macOS, Linux
JavaScript → 1.0.0 (GA) npm 2024-11-30 (GA) Tarayıcı, Windows, macOS, Linux
Python → 1.0.0 (GA) PyPI 2024-11-30 (GA) Windows, macOS, Linux

Diğer SDK sürümleri hakkında daha fazla bilgi için bkz:

Desteklenen İstemciler

Aşağıdaki tablolarda her SDK sürümü arasındaki bağıntı, Belge Zekası hizmetinin desteklenen API sürümleriyle gösterilir.

Dil SDK diğer adı API sürümü (varsayılan) Desteklenen istemciler
.NET/C# 1.0.0 (GA) v4.0 (GA) 2024-11-30 GA DocumentIntelligenceClient
DocumentIntelligenceAdministrationClient
.NET/C# 4.1.0 v3.1 en son (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

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

.NET CLI 
dotnet add package Azure.AI.DocumentIntelligence -Version 1.0.0
PowerShell 
Install-Package Azure.AI.DocumentIntelligence -Version 1.0.0

2. SDK istemci kitaplığını uygulamanıza aktarma

C# 
using Azure;
using Azure.AI.DocumentIntelligence;

3. Kimlik doğrulamayı ayarlama

Kimlik doğrulaması için desteklenen iki yöntem vardır:

API anahtarınızı kullanma

Azure portalında Belge Zekası API anahtarınızı burada bulabilirsiniz:

Azure portalında anahtarların ve uç nokta konumunun ekran görüntüsü.

Ö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.

C# 

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

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:

  1. .NET için Azure Kimlik kitaplığını yükleyin:

    Console 
        dotnet add package Azure.Identity
    PowerShell 
        Install-Package Azure.Identity

  2. Bir Microsoft Entra uygulaması kaydedin ve yeni bir hizmet sorumlusu oluşturun.

  3. Rolü hizmet sorumlunuza atayarak Cognitive Services User Belge Yönetim Bilgilerine erişim verin.

  4. Microsoft Entra uygulamasında istemci kimliği, kiracı kimliği ve istemci gizli dizisi değerlerini sırasıyla , AZURE_TENANT_IDve AZURE_CLIENT_SECRETortam değişkenleri AZURE_CLIENT_IDolarak ayarlayın.

  5. örneğinizi oluşturun ve örneğinizi DocumentIntelligenceClientDefaultAzureCredentialoluşturun:

    C# 
    string endpoint = "<your-endpoint>";
var client = new DocumentIntelligenceClient(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 Q&A 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örebilmek için aşağıdaki etiketleri kullanın.

  • Microsoft Q&A: . Azure AI Document Intelligence

  • Yığın Taşması: azure-ai-document-intelligence.

Sonraki adımlar

Belge Zekası REST API 2023-10-31 rest işlemlerini keşfedin.