استخدم واجهة برمجة تطبيقات فهم المحتوى

مكتمل

تلميح

راجع علامة التبويب النص والصور لمزيد من التفاصيل!

توفر واجهة برمجة تطبيقات فهم المحتوى واجهة برمجية يمكنك استخدامها لإنشاء وإدارة واستهلاك المحللات.

لاستخدام واجهة برمجة التطبيقات (API)، يقوم تطبيق العميل الخاص بك بإرسال استدعاءات HTTP إلى نقطة نهاية فهم المحتوى لمورد Microsoft Foundry الخاص بك، مع تمرير أحد مفاتيح التفويض في الرأس. يمكنك الحصول على نقطة النهاية والمفاتيح من بوابة Azure أو من بوابة Microsoft Foundry. يمكنك أيضا استخدام واجهة برمجة تطبيقات Microsoft Foundry للاتصال برمجيا بالمشروع باستخدام معرف إنترا الخاص بك.

استخدام واجهة برمجة التطبيقات لتحليل المحتوى

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

على سبيل المثال، لتحليل مستند، قد يرسل تطبيق العميل طلب POST إلى الوظيفة التي analyze تحتوي على نص JSON التالي:

POST {endpoint}/contentunderstanding/analyzers/{analyzer}:analyze?api-version=2025-11-01
{
  "inputs": [
    {
      "url": "https://host.com/doc.pdf"
    }
  ]
}

إشعار

يمكنك تحديد عنوان URL لموقع ملف المحتوى كما هو موضح هنا. لتقديم بيانات الملفات الثنائية مباشرة، استخدم العملية analyzeBinary بدلا من ذلك.

بافتراض مصادقة الطلب وبدء تشغيله بنجاح، ستكون الاستجابة مشابهة لهذا المثال:

Operation-Id: 1234abcd-1234-abcd-1234-abcd1234abcd
Operation-Location: {endpoint}/contentunderstanding/analyzerResults/1234abcd-1234-abcd-1234-abcd1234abcd?api-version=2025-11-01
{
  "id": "1234abcd-1234-abcd-1234-abcd1234abcd",
  "status": "NotStarted"
}

يجب على تطبيق العميل بعد ذلك استخدام معرف العمليات الذي تم إرجاعه للتحقق من حالة العملية حتى تنجح (أو تفشل) عن طريق تقديم طلب GET إلى نقطة analyzerResults النهاية.

GET {endpoint}/contentunderstanding/analyzerResults/1234abcd-1234-abcd-1234-abcd1234abcd?api-version=2025-11-01

عند اكتمال العملية بنجاح، تحتوي الاستجابة على حمولة JSON تمثل نتائج التحليل. تعتمد النتائج المحددة على المحتوى والمخطط.

إشعار

لمزيد من المعلومات حول واجهة برمجة تطبيقات فهم المحتوى، راجع الوثائق المرجعية.