مشاركة عبر

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

  • مقالة

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

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

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

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

  • الوصول الممنوح إلى Azure OpenAI في اشتراك Azure المطلوب. يمكنك التقدم بطلب للوصول إلى Azure OpenAI عن طريق إكمال النموذج في https://aka.ms/oai/access. افتح مشكلة على هذا المستودع للاتصال بنا إذا كانت لديك مشكلة.

  • مورد Azure OpenAI مع نشر نموذج. لمزيد من المعلومات حول نشر النموذج، راجع دليل توزيع الموارد.

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

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

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

يمكنك استيراد واجهة برمجة تطبيقات Azure OpenAI مباشرة إلى APIM من خدمة Azure OpenAI. عند استيراد واجهة برمجة التطبيقات، تقوم APIM تلقائيا بتكوين:

  • عمليات لكل نقطة من نقاط نهاية Azure OpenAI REST API.
  • هوية معينة من قبل النظام مع الأذونات اللازمة للوصول إلى مورد Azure OpenAI.
  • مورد الواجهة الخلفية ونهج خدمة الواجهة الخلفية التي توجه طلبات واجهة برمجة التطبيقات إلى نقطة نهاية خدمة Azure OpenAI.
  • نهج هوية مدارة بواسطة المصادقة يمكنه المصادقة على مورد Azure OpenAI باستخدام الهوية المعينة من قبل النظام للمثيل.
  • (اختياريا) نهج لمساعدتك في مراقبة وإدارة استهلاك الرمز المميز بواسطة واجهة برمجة تطبيقات Azure OpenAI.

لاستيراد واجهة برمجة تطبيقات Azure OpenAI إلى APIM:

  1. في مدخل Azure، انتقل إلى مثيل API Management الخاص بك.

  2. في القائمة اليسرى، ضمن واجهات برمجة التطبيقات، حدد واجهات برمجة التطبيقات> + إضافة واجهة برمجة التطبيقات.

  3. ضمن Create from Azure resource، حدد Azure OpenAI Service.

    لقطة شاشة لإنشاء واجهة برمجة تطبيقات من خدمة Azure OpenAI في المدخل.

  4. في علامة التبويب Basics:

    1. حدد مورد Azure OpenAI الذي تريد استيراده.

    2. اختياريا حدد إصدار Azure OpenAI API. إذا لم تحدد واحدا، فسيتم استخدام أحدث إصدار جاهز للإنتاج لواجهة برمجة تطبيقات REST بشكل افتراضي.

    3. أدخل اسم العرض والوصف الاختياري لواجهة برمجة التطبيقات.

    4. في Base URL، ألحق مسارا يستخدمه مثيل APIM للوصول إلى نقاط نهاية Azure OpenAI API. إذا قمت بتمكين التأكد من توافق OpenAI SDK (مستحسن)، /openai يتم إلحاقه تلقائيا بعنوان URL الأساسي.

      على سبيل المثال، إذا كانت نقطة نهاية بوابة API Management هي https://contoso.azure-api.net، فقم بتعيين عنوان URL أساسي مشابه ل https://contoso.azure-api.net/my-openai-api/openai.

    5. اختياريا حدد منتجا واحدا أو أكثر لإقرانه بواجهة برمجة التطبيقات. حدد التالي.

  5. في علامة التبويب Policies ، قم بتمكين النهج اختياريا لمراقبة وإدارة استهلاك الرمز المميز لواجهة برمجة تطبيقات Azure OpenAI. إذا تم تحديدها، أدخل الإعدادات أو اقبل الإعدادات الافتراضية azure-openai-token-limit التي تحدد نهج و azure-openai-emit-token-metric لواجهة برمجة التطبيقات الخاصة بك. يمكنك أيضا تعيين تكوين النهج أو تحديثه لاحقا. حدد "استعراض + إنشاء".

  6. بعد التحقق من صحة الإعدادات، حدد إنشاء.

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

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

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

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

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

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

    • Url: 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 في المواصفات. ستحتاج إليه لاختبار واجهة برمجة التطبيقات. مثال:2024-02-01.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    إشعار

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

  6. حدد إرسال.

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

نهج التخزين المؤقت لواجهات برمجة تطبيقات Azure OpenAI

بالإضافة إلى azure-openai-token-limit النهج و azure-openai-emit-token-metric التي يمكنك تكوينها عند استيراد واجهة برمجة تطبيقات خدمة Azure OpenAI، توفر APIM نهج التخزين المؤقت التالية لمساعدتك على تحسين الأداء وتقليل زمن الانتقال لواجهات برمجة تطبيقات Azure OpenAI:

  • azure-openai-semantic-cache-store
  • azure-openai-semantic-cache-lookup

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