استيراد واجهة برمجة تطبيقات Azure OpenAI كواجهة برمجة تطبيقات REST

ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات

يمكنك استيراد نقاط نهاية نموذج الذكاء الاصطناعي المنشورة في Azure OpenAI في Foundry Models إلى مثيل APIM كواجهة برمجة تطبيقات REST. استخدم نهج البوابة الذكاء الاصطناعي والقدرات الأخرى في APIM لتبسيط التكامل وتحسين إمكانية الملاحظة وتعزيز التحكم في نقاط نهاية النموذج.

توضح هذه المقالة خيارين لاستيراد واجهة برمجة تطبيقات Azure OpenAI إلى مثيل Azure API Management كواجهة برمجة تطبيقات REST:

تعرف أكثر على إدارة واجهات برمجة تطبيقات النماذج الكبيرة في إدارة واجهات برمجة التطبيقات:

المتطلبات الأساسية

  • مثيل APIM موجود. أنشئ واحد إذا لم تكن قد قمت بذلك بالفعل.

  • (للاستيراد من مايكروسوفت فاوندري) تم نشر مشروع Microsoft Foundry بنموذج Azure OpenAI. لمزيد من المعلومات حول نشر النموذج في Azure OpenAI، راجع دليل توزيع الموارد.

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

  • أذونات لمنح حق الوصول إلى مورد Azure OpenAI من مثيل APIM.

الخيار 1. استيراد واجهة برمجة تطبيقات OpenAI من Microsoft Foundry

يمكنك استيراد نشر نموذج Azure OpenAI مباشرة من Microsoft Foundry إلى إدارة واجهات البرمجة (API Management). للتفاصيل، راجع استيراد واجهة برمجة تطبيقات Microsoft Foundry.

عند استيراد واجهة برمجة التطبيقات:

  • حدد خدمة Microsoft Foundry التي تستضيف نشر نموذج Azure OpenAI.
  • حدد خيار توافق عميل Azure OpenAI . يقوم هذا الخيار بتكوين واجهة برمجة تطبيقات إدارة واجهة برمجة التطبيقات مع /openai نقطة نهاية.

الخيار 2. إضافة مواصفات OpenAPI إلى APIM

بدلا من ذلك، قم بتنزيل مواصفات OpenAPI يدويا لواجهة برمجة تطبيقات AZURE OpenAI REST وإضافتها إلى APIM كواجهة برمجة تطبيقات OpenAPI.

تنزيل مواصفات OpenAPI

قم بتنزيل مواصفات OpenAPI لواجهة برمجة تطبيقات AZURE OpenAI REST، مثل إصدار GA 2024-10-21.

  1. في محرر نص، افتح ملف المواصفات الذي قمت بتنزيله.

  2. في servers العنصر في المواصفة، استبدل اسم نقطة نهاية Azure OpenAI بقيم البديل ل url و default نقطة نهاية. على سبيل المثال، إذا كانت نقطة نهاية Azure OpenAI هي contoso.openai.azure.com، فقم بتحديث servers العنصر بالقيم التالية:

    • الرابط: https://contoso.openai.azure.com/openai
    • نقطة النهاية الافتراضية:contoso.openai.azure.com
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]

  3. دون قيمة واجهة برمجة التطبيقات version في المواصفات. تحتاجه لاختبار واجهة برمجة التطبيقات (API). مثال:2024-10-21.

إضافة مواصفات OpenAPI إلى APIM

  1. في مدخل Microsoft Azure، انتقل إلى مثيل APIM.
  2. في القائمة اليسرى، حدد APIs>+ Add API.
  3. ضمن تعريف واجهة برمجة تطبيقات جديدة، حدد OpenAPI. أدخل اسم العرض والاسم لواجهة برمجة التطبيقات.
  4. أدخل لاحقة عنوان URL لواجهة برمجة التطبيقات تنتهي بالوصول /openai إلى نقاط نهاية Azure OpenAI API في مثيل API Management. على سبيل المثال: my-openai-api/openai.
  5. حدد إنشاء.

تقوم إدارة API باستيراد واجهة برمجة التطبيقات وتعرض العمليات من مواصفة OpenAPI.

تكوين المصادقة إلى واجهة برمجة تطبيقات Azure OpenAI

للمصادقة على واجهة Azure OpenAI، قدم مفتاح API أو استخدم هوية مدارة. إذا قمت باستيراد واجهة برمجة تطبيقات Azure OpenAI مباشرة من Microsoft Foundry، يتم تكوين المصادقة باستخدام هوية إدارة مثيل إدارة واجهة برمجة التطبيقات تلقائيا.

إذا أضفت واجهة برمجة تطبيقات Azure OpenAI من مواصفات OpenAPI الخاصة بها، فستحتاج إلى تكوين المصادقة. لمزيد من المعلومات حول كيفية تكوين المصادقة باستخدام سياسات إدارة واجهة برمجة التطبيقات، راجع التحقق والتفويض لواجهات برمجة التطبيقات لنماذج اللغة الكبيرة (LLM).

اختبار واجهة برمجة تطبيقات Azure OpenAI

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

  1. تحديد واجهة برمجة التطبيقات التي أنشأتها في الخطوة السابقة.

  2. حدد علامة التبويب الاختبار.

  3. حدد عملية متوافقة مع النموذج الذي قمت بنشره في مورد Azure OpenAI. تعرض الصفحة حقول المعلمات والرؤوس.

  4. في معلمات القالب، أدخل القيم التالية:

    • deployment-id - معرف نشر نموذج Azure OpenAI في Microsoft Foundry
    • api-version - إصدار Azure OpenAI API صالح، مثل إصدار واجهة برمجة التطبيقات الذي حددته عند استيراد واجهة برمجة التطبيقات. لقطة شاشة لاختبار واجهة برمجة تطبيقات Azure OpenAI في المدخل.

  5. أدخل معلمات وعناوين أخرى حسب الحاجة. اعتمادا على العملية والنموذج، قد تحتاج إلى تكوين أو تحديث جسم الطلب. على سبيل المثال، إليك جسم طلب أساسي لعملية إكمال الدردشة:

    {
  "model": "any",
  "messages": [
    {
      "role": "user",
      "content": "Help me plan a vacation trip to Paris."
    }
  ],
  "max_tokens": 100
}

    إشعار

    في وحدة الاختبار، تضيف إدارة واجهة برمجة التطبيقات تلقائيا رأس Ocp-Apim-Subscription-Key وتحدد مفتاح الاشتراك للاشتراك المدمج بكل الوصول. يوفر هذا المفتاح الوصول إلى كل واجهة برمجة تطبيقات في مثيل إدارة واجهة برمجة التطبيقات. لعرض رأس Ocp-Apim-Subscription-Key اختياريا، اختر أيقونة "eye" بجانب طلب HTTP.

  6. حدد إرسال.

    عندما ينجح الاختبار، تستجيب الواجهة الخلفية برمز استجابة HTTP ناجح وبعض البيانات. يتضمن الرد بيانات استخدام الرموز لمساعدتك في مراقبة وإدارة استهلاك رموز Azure OpenAI API.

    لقطة شاشة لبيانات استخدام الرمز المميز في استجابة واجهة برمجة التطبيقات في المدخل.

المحتوى ذو الصلة

  • Last updated on