هدف SDK: REST API 2023-07-31 (GA)

إصدار واجهة برمجة تطبيقات REST 2023-07-31 (GA)

Azure الذكاء الاصطناعي Document Intelligence هي خدمة سحابية تستخدم التعلم الآلي لتحليل النص والبيانات المنظمة من المستندات. تعد مجموعة أدوات تطوير برامج المعلومات المستندية (SDK) مجموعة من المكتبات والأدوات التي تمكنك من دمج نماذج وإمكانيات معلومات المستند بسهولة في تطبيقاتك. تتوفر Document Intelligence SDK عبر الأنظمة الأساسية بلغات البرمجة C#/.NET وJava وJavaScript وPython.

لغات البرمجة المدعومة

يدعم Document Intelligence SDK اللغات والأنظمة الأساسية التالية:

إصدار Language → Document Intelligence SDK	الحزمة	إصدار واجهة برمجة التطبيقات المدعوم	دعم النظام الأساسي
.NET/C# → الأحدث (GA)	NuGet	2023-07-31 (GA)
Java → الأحدث (GA)	مستودع Maven	2023-07-31 (GA)	Windows وmacOS وLinux
JavaScript → الأحدث (GA)	npm	2023-07-31 (GA)	Browser, Windows, macOS, Linux
أحدث → Python (GA)	PyPI	2023-07-31 (GA)	Windows وmacOS وLinux

لمزيد من المعلومات حول إصدارات SDK الأخرى، راجع:

• 2024-02-29 الإصدار 4.0 (معاينة)

• 2022-08-31 الإصدار 3.0 (GA)

• v2.1 (GA)

تطبيقات العميل المعتمدة

تقدم الجداول التالية الارتباط بين كل إصدار من إصدارات SDK لإصدارات واجهة برمجة التطبيقات المدعومة لخدمة Document Intelligence.

C#/.NET

اللغة	إصدار SDK	إصدار واجهة برمجة التطبيقات (افتراضي)	‏‫العملاء المعتمدون
.NET/C# 4.1.0	الإصدار 3.1 الأحدث (GA)	2023-07-31	DocumentAnalysisClient DocumentModel مسؤول istrationClient
.NET/C# 4.0.0	الإصدار 3.0 (GA)	2022-08-31	DocumentAnalysisClient DocumentModel مسؤول istrationClient
.NET/C# 3.1.x	v2.1	v2.1	FormRecognizerClient FormTrainingClient
.NET/C# 3.0.x	v2.0	v2.0	FormRecognizerClient FormTrainingClient

Java

اللغة	إصدار SDK	إصدار واجهة برمجة التطبيقات	‏‫العملاء المعتمدون
Java 4.1.0	الإصدار 3.1 الأحدث (GA)	2023-07-31 (افتراضي)	DocumentAnalysisClient DocumentModel مسؤول istrationClient
Java 4.0.0	الإصدار 3.0 (GA)	2022-08-31	DocumentAnalysisClient DocumentModel مسؤول istrationClient
Java 3.1.x	v2.1	v2.1	FormRecognizerClient FormTrainingClient
Java 3.0.x	v2.0	v2.0	FormRecognizerClient FormTrainingClient

جافا سكريبت

اللغة	إصدار SDK	إصدار واجهة برمجة التطبيقات (افتراضي)	‏‫العملاء المعتمدون
JavaScript 5.0.0	الإصدار 3.1 الأحدث (GA)	2023-07-31 (افتراضي)	DocumentAnalysisClient DocumentModel مسؤول istrationClient
JavaScript 4.0.0	الإصدار 3.0 (GA)	2022-08-31	DocumentAnalysisClient DocumentModel مسؤول istrationClient
JavaScript 3.1.x	v2.1	v2.1	FormRecognizerClient FormTrainingClient
JavaScript 3.0.x	v2.0	v2.0	FormRecognizerClient FormTrainingClient

Python

اللغة	إصدار SDK	إصدار واجهة برمجة التطبيقات (افتراضي)	‏‫العملاء المعتمدون
Python 3.3.0	الإصدار 3.1 (الأحدث (GA)	2023-07-31 (افتراضي)	DocumentAnalysisClient DocumentModel مسؤول istrationClient
Python 3.2.x	الإصدار 3.0 (GA)	2022-08-31	DocumentAnalysisClient DocumentModel مسؤول istrationClient
Python 3.1.x	v2.1	v2.1	FormRecognizerClient FormTrainingClient
Python 3.0.0	v2.0	v2.0	FormRecognizerClient FormTrainingClient

استخدام Document Intelligence SDK في تطبيقاتك

تمكن Document Intelligence SDK من استخدام وإدارة خدمة Document Intelligence في التطبيق الخاص بك. تعتمد SDK على واجهة برمجة تطبيقات REST الأساسية لذكاء المستند مما يسمح لك باستخدام واجهات برمجة التطبيقات هذه بسهولة ضمن نموذج لغة البرمجة. إليك كيفية استخدام Document Intelligence SDK للغة المفضلة لديك:

1. تثبيت مكتبة عميل عدة تطوير البرامج

C#/.NET

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

Install-Package Azure.AI.FormRecognizer -Version 4.1.0

Java

  <dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-ai-formrecognizer</artifactId>
  <version>4.1.0</version>
  </dependency>

implementation("com.azure:azure-ai-formrecognizer:4.1.0")

جافا سكريبت

npm i @azure/ai-form-recognizer@5.0.0

Python

pip install azure-ai-formrecognizer==3.3.0

2. استيراد مكتبة عميل عدة تطوير البرامج إلى التطبيق

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;

جافا سكريبت

const { AzureKeyCredential, DocumentAnalysisClient } = require("@azure/ai-form-recognizer");

Python

from azure.ai.formrecognizer import DocumentAnalysisClient
from azure.core.credentials import AzureKeyCredential

3. إعداد المصادقة

هناك طريقتان مدعومتان للمصادقة:

• استخدم مفتاح Document Intelligence API مع AzureKeyCredential من azure.core.credentials.

• استخدم بيانات اعتماد رمز مميز من azure-identity للمصادقة باستخدام معرف Microsoft Entra.

استخدام مفتاح API

فيما يلي مكان العثور على مفتاح واجهة برمجة تطبيقات تحليل معلومات المستند في مدخل Microsoft Azure:

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

جافا سكريبت

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

استخدام بيانات اعتماد الرمز المميز ل Microsoft Entra

إشعار

لا تدعم نقاط النهاية الإقليمية مصادقة Microsoft Entra. أنشئ مجالًا فرعيًا مخصصًا لموردك لاستخدام هذا النوع من المصادقة.

التخويل أسهل باستخدام DefaultAzureCredential. يوفر بيانات اعتماد رمز مميز افتراضية استنادًا إلى بيئة التشغيل، يمكنها التعامل مع معظم سيناريوهات مصادقة Azure.

C#/.NET

فيما يلي كيفية الحصول على DefaultAzureCredential واستخدامه لتطبيقات Microsoft.NET:

1. ثبّت مكتبة Azure Identity لـ Microsoft.NET:

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. تسجيل تطبيق Microsoft Entra وإنشاء كيان خدمة جديد.

3. امنح حق الوصول إلى Document Intelligence عن طريق تعيين Cognitive Services User الدور إلى كيان الخدمة.

4. تعيين قيم معرف العميل ومعرف المستأجر وسر العميل في تطبيق Microsoft Entra كمتغيرات بيئة: AZURE_CLIENT_IDو AZURE_TENANT_IDAZURE_CLIENT_SECRETعلى التوالي.

5. أنشئ المثيل DocumentAnalysisClient بما في ذلك DefaultAzureCredential:

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

لمزيد من المعلومات، راجعمصادقة العميل.

Java

فيما يلي كيفية الحصول على DefaultAzureCredential واستخدامه لتطبيقات Java:

1. ثبّت مكتبة Azure Identity لـ Java:

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

2. تسجيل تطبيق Microsoft Entra وإنشاء كيان خدمة جديد.

3. امنح حق الوصول إلى Document Intelligence عن طريق تعيين Cognitive Services User الدور إلى كيان الخدمة.

4. تعيين قيم معرف العميل ومعرف المستأجر وسر العميل لتطبيق Microsoft Entra كمتغيرات بيئة: AZURE_CLIENT_IDو AZURE_TENANT_IDAZURE_CLIENT_SECRETعلى التوالي.

5. إنشاء المثيل DocumentAnalysisClient والمتغيرTokenCredential:

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

لمزيد من المعلومات، راجعمصادقة العميل.

جافا سكريبت

فيما يلي كيفية الحصول على DefaultAzureCredential واستخدامه لتطبيقات JavaScript:

1. ثبّت مكتبة Azure Identity لـ JavaScript:

   npm install @azure/identity
   

2. تسجيل تطبيق Microsoft Entra وإنشاء كيان خدمة جديد.

3. امنح حق الوصول إلى Document Intelligence عن طريق تعيين Cognitive Services User الدور إلى كيان الخدمة.

4. تعيين قيم معرف العميل ومعرف المستأجر وسر العميل لتطبيق Microsoft Entra كمتغيرات بيئة: AZURE_CLIENT_IDو AZURE_TENANT_IDAZURE_CLIENT_SECRETعلى التوالي.

5. أنشئ المثيل DocumentAnalysisClient بما في ذلك DefaultAzureCredential:

   const { DocumentAnalysisClient } = require("@azure/ai-form-recognizer");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new DocumentAnalysisClient("<your-endpoint>", new DefaultAzureCredential());
   

لمزيد من المعلومات، راجعإنشاء عميل ومصادقته.

Python

فيما يلي كيفية الحصول على DefaultAzureCredential واستخدامه لتطبيقات Python.

1. ثبّت مكتبة Azure Identity لـ Python:

   pip install azure-identity
   

2. تسجيل تطبيق Microsoft Entra وإنشاء كيان خدمة جديد.

3. امنح حق الوصول إلى Document Intelligence عن طريق تعيين Cognitive Services User الدور إلى كيان الخدمة.

4. تعيين قيم معرف العميل ومعرف المستأجر وسر العميل لتطبيق Microsoft Entra كمتغيرات بيئة: AZURE_CLIENT_IDو AZURE_TENANT_IDAZURE_CLIENT_SECRETعلى التوالي.

5. أنشئ المثيل DocumentAnalysisClient بما في ذلك 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
   )
   

لمزيد من المعلومات، راجعمصادقة العميل.

4. إنشاء التطبيق

أنشئ كائن عميل للتفاعل مع Document Intelligence SDK، ثم قم باستدعاء أساليب على كائن العميل هذا للتفاعل مع الخدمة. توفر عدد تطوير البرامج الأسلوب المتزامن وغير المتزامن. لمزيد من التفاصيل، جرب التشغيل السريع بلغة برمجة من اختيارك.

خيارات المساعدة

تتوفر منتديات Microsoft Q و Stack Overflow لمجتمع المطورين لطرح الأسئلة حول Azure الذكاء الاصطناعي Document Intelligence والخدمات الأخرى والإجابة عليها. تراقب Microsoft المنتديات وتجيب على الأسئلة التي لم يُجِب المجتمع عليها. ضمان استقبالنا للسؤال، ضع علامة azure-form-recognizer عليه.

الخطوات التالية

استكشاف عمليات واجهة برمجة تطبيقات REST لذكاء المستندات 2023-07-31 .