مشاركة عبر

مرجع واجهة برمجة تطبيقات REST لخدمة Azure OpenAI

  • مقالة

توفر هذه المقالة تفاصيل حول نقاط نهاية واجهة برمجة تطبيقات REST للاستدلال ل Azure OpenAI.

المصادقة

يوفر Azure OpenAI طريقتين للمصادقة. يمكنك استخدام مفاتيح واجهة برمجة التطبيقات أو معرف Microsoft Entra.

  • مصادقة مفتاح واجهة برمجة التطبيقات: لهذا النوع من المصادقة، يجب أن تتضمن جميع طلبات واجهة برمجة التطبيقات مفتاح واجهة برمجة التطبيقات في api-key عنوان HTTP. يوفر التشغيل السريع إرشادات حول كيفية إجراء مكالمات باستخدام هذا النوع من المصادقة.

  • مصادقة معرف Microsoft Entra: يمكنك مصادقة استدعاء واجهة برمجة التطبيقات باستخدام رمز Microsoft Entra المميز. يتم تضمين رموز المصادقة المميزة في الطلب كعنوان Authorization. يجب أن يكون الرمز المميز المقدم مسبوقًا بـ Bearer، على سبيل المثال Bearer YOUR_AUTH_TOKEN. يمكنك قراءة دليل الكيفية الخاص بنا حول المصادقة باستخدام معرف Microsoft Entra.

تعيين إصدار واجهة برمجة تطبيقات REST

يتم إصدار واجهات برمجة التطبيقات للخدمة باستخدام معلمة الاستعلام api-version. تتبع جميع الإصدارات بنية التاريخ YYYY-MM-DD. على سبيل المثال:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2024-02-01

عمليات الإكمال

مع عملية الإكمال، يقوم النموذج بإنشاء واحد أو أكثر من عمليات الإكمال المتوقعة بناء على مطالبة مقدمة. كما يمكن للخدمة إرجاع احتمالات الرموز المميزة البديلة في كل موضع.

إنشاء إكمال

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/completions?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI الخاص بك.
deployment-id سلسلة المطلوب اسم النشر الذي اخترته عند نشر النموذج.
api-version سلسلة المطلوب إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية. يتبع هذا التنسيق YYYY-MM-DD.

الإصدارات المدعومة

نص الطلب

المعلمة النوع مطلوب؟ Default ‏‏الوصف
prompt سلسلة أو مجموعة اختياري <\|endoftext\|> المطالبة أو المطالبة بإنشاء عمليات إكمال ل أو ترميزها كسلسلة أو صفيف من السلاسل. <\|endoftext\|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، لذلك إذا لم يتم تحديد مطالبة، فسينشئ النموذج كما لو كان من بداية مستند جديد.
max_tokens integer اختياري 16 الحد الأقصى لعدد الرموز المميزة التي يجب إنشاؤها في الاكتمال. لا يمكن أن يتجاوز عدد الرموز المميزة لمطالبتك بالإضافة إلى max_tokens طول سياق النموذج. تحتوي معظم النماذج على طول سياق الرموز المميزة 2048 (باستثناء أحدث النماذج، والتي تدعم 4096).
temperature رقم اختياري 1 ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. تعني القيم الأعلى أن النموذج يأخذ المزيد من المخاطر. جرب 0.9 للحصول على تطبيقات أكثر إبداعًا، و0 (argmax sampling) للتطبيقات ذات الإجابة المحددة جيدًا. نوصي عمومًا بتغيير هذا أو top_p، لكن ليس كليهما.
top_p رقم اختياري 1 بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة الاحتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تشكل كتلة الاحتمال الأعلى بنسبة 10٪ هي التي تعتبر فحسب. نوصي عمومًا بتغيير هذا أو درجة الحرارة، ولكن ليس كليهما.
logit_bias map اختياري قيمة فارغة تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن json الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في رمز GPT المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. يمكنك استخدام أداة الرمز المميز هذه (التي تعمل مع كل من GPT-2 وGPT-3) لتحويل النص إلى معرفات الرمز المميز. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. يختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو اختيار حصري للرمز المميز ذي الصلة. على سبيل المثال، يمكنك تمرير {"50256": -100} لمنع <إنشاء الرمز المميز |endoftext|>.
user سلسلة اختياري معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها
n integer اختياري 1 مقدار عدد عمليات الإكمال التي يجب إنشاؤها لكل مطالبة. ملاحظة: نظرًا لأن هذه المعلمة تنشئ العديد من عمليات الإكمال، يمكن أن تستهلك حصة الرمز المميز الخاصة بك بسرعة. استخدمه بعناية وتأكد من أن لديك إعدادات معقولة max_tokens والإيقاف.
stream boolean اختياري خطأ سواء كنت تريد إرجاع التقدم الجزئي أم لا. إذا تم تعيينها، يتم إرسال الرموز المميزة كأحداث مرسلة إلى الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة بيانات: رسالة [DONE].
logprobs integer اختياري قيمة فارغة قم بتضمين احتمالات السجل على الرموز المميزة الأكثر احتمالاً لـ logprobs، بالإضافة إلى الرموز المميزة المختارة. على سبيل المثال، إذا كانت logprobs هي 10، فسترجع واجهة برمجة التطبيقات قائمة بالرموز المميزة العشرة الأكثر احتمالاً. ستقوم واجهة برمجة التطبيقات دائما بإعادة logprob للرمز المميز الذي تم أخذ عينات له، لذلك قد يكون هناك ما يصل إلى عناصر logprobs+1 في الاستجابة. لا يمكن استخدام هذه المعلمة مع gpt-35-turbo.
suffix سلسلة اختياري قيمة فارغة اللاحقة التي تأتي بعد إكمال النص المدرج.
echo boolean اختياري خطأ إعادة توجيه المطالبة بالإضافة إلى الإكمال. لا يمكن استخدام هذه المعلمة مع gpt-35-turbo.
stop سلسلة أو مجموعة اختياري قيمة فارغة ما يصل إلى أربعة تسلسلات عند توقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف. بالنسبة إلى GPT-4 Turbo مع Vision، يتم دعم ما يصل إلى تسلسلين.
presence_penalty رقم اختياري 0 رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج.
frequency_penalty رقم اختياري 0 رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي.
best_of integer اختياري 1 إنشاء عمليات إكمال best_of من جانب الخادم وإرجاع "الأفضل" (الذي يحتوي على أقل احتمال سجل لكل رمز مميز). لا يمكن دفق النتائج. عند استخدامها مع n، يتحكم best_of في عدد عمليات إكمال المرشحين ويحدد n عدد المرشحين المطلوب إرجاعهم - يجب أن يكون best_of أكبر من n. ملاحظة: نظرًا لأن هذه المعلمة تنشئ العديد من عمليات الإكمال، يمكن أن تستهلك حصة الرمز المميز الخاصة بك بسرعة. استخدمه بعناية وتأكد من أن لديك إعدادات معقولة max_tokens والإيقاف. لا يمكن استخدام هذه المعلمة مع gpt-35-turbo.

عينة طلب

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2024-02-01\
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d "{
  \"prompt\": \"Once upon a time\",
  \"max_tokens\": 5
}"

مثال على الاستجابة

{
    "id": "cmpl-4kGh7iXtjW4lc9eGhff6Hp8C7btdQ",
    "object": "text_completion",
    "created": 1646932609,
    "model": "ada",
    "choices": [
        {
            "text": ", a dark line crossed",
            "index": 0,
            "logprobs": null,
            "finish_reason": "length"
        }
    ]
}

في مثال الاستجابة، finish_reason يساوي stop. إذا كان finish_reason يساوي، فاطلع content_filterعلى دليل تصفية المحتوى لفهم سبب حدوث ذلك.

عمليات التضمين

احصل على تمثيل خط متجه لمدخل معين يمكن استهلاكه بسهولة من نماذج التعلم الآلي والخوارزميات الأخرى.

إشعار

يسمح OpenAI حاليا بعدد أكبر من إدخالات الصفيف باستخدام text-embedding-ada-002. يدعم Azure OpenAI حاليا صفائف الإدخال حتى 16 ل text-embedding-ada-002 (Version 2). يتطلب كلاهما الحد الأقصى رمز الإدخال المميز لكل طلب واجهة برمجة تطبيقات للبقاء تحت 8191 لهذا النموذج.

إنشاء تضمين

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/embeddings?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI الخاص بك.
deployment-id سلسلة المطلوب اسم توزيع النموذج الخاص بك. يطلب منك أولا نشر نموذج قبل إجراء المكالمات.
api-version سلسلة المطلوب إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية. يتبع هذا التنسيق YYYY-MM-DD.

الإصدارات المدعومة

نص الطلب

المعلمة النوع مطلوب؟ Default ‏‏الوصف
input سلسلة أو مجموعة ‏‏نعم‬ غير متوفر أدخل نصا للحصول على تضمينات له، مرمز كصفيف أو سلسلة. يختلف عدد رموز الإدخال استنادا إلى النموذج الذي تستخدمه. يدعم إدخال الصفيف فقط text-embedding-ada-002 (Version 2) .
user سلسلة لا قيمة فارغة معرف فريد يمثل المستخدم النهائي. Azure OpenAI سيساعد على مراقبة إساءة الاستخدام واكتشافها. لا تمرر معرفات PII بدلاً من ذلك استخدام القيم الزائفة، مثل معرفات واجهة المستخدم الرسومية
encoding_format سلسلة لا float التنسيق الذي يجب إرجاع التضمينات فيه. يمكن أن يكون إما float أو base64. الإعدادات الافتراضية لـ float.

[تمت الإضافة في 2024-03-01-preview].
dimensions عدد صحيح لا عدد الأبعاد التي يجب أن تحتوي عليها تضمينات الإخراج الناتجة. مدعوم فقط في text-embedding-3 النماذج والإحدث.

[تمت الإضافة في 2024-03-01-preview]

عينة طلب

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings?api-version=2024-02-01 \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d "{\"input\": \"The food was delicious and the waiter...\"}"

مثال على الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.018990106880664825,
        -0.0073809814639389515,
        .... (1024 floats total for ada)
        0.021276434883475304,
      ],
      "index": 0
    }
  ],
  "model": "text-similarity-babbage:001"
}

إكمال الدردشة

إنشاء عمليات إكمال لرسائل الدردشة باستخدام طرازي GPT-35-Turbo وGPT-4.

إنشاء إكمال الدردشة

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/chat/completions?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI الخاص بك.
deployment-id سلسلة المطلوب اسم توزيع النموذج الخاص بك. يطلب منك أولا نشر نموذج قبل إجراء المكالمات.
api-version سلسلة المطلوب إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية. يتبع هذا التنسيق YYYY-MM-DD أو YYYY-MM-DD-preview.

الإصدارات المدعومة

هام

functions تم إهمال المعلمات و function_call مع إصدار 2023-12-01-preview إصدار واجهة برمجة التطبيقات. الاستبدال هو functions المعلمة tools . الاستبدال هو function_call المعلمة tool_choice . يتم دعم استدعاء الدالة المتوازية الذي تم تقديمه كجزء من 2023-12-01-preview فقط مع gpt-35-turbo (1106) و gpt-4 (1106-preview) المعروف أيضا باسم GPT-4 Turbo Preview.

المعلمة النوع مطلوب؟ Default ‏‏الوصف
messages صفيف المطلوب مجموعة رسائل السياق المقترنة بطلب إكمال الدردشة هذا. يبدأ الاستخدام النموذجي برسالة دردشة لدور النظام الذي يوفر إرشادات لسلوك المساعد، متبوعا بالرسائل المتناوبة بين أدوار المستخدم والمساعد.
temperature رقم اختياري 1 ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.
role سلسلة ‏‏نعم‬ غير متوفر يشير إلى الشخص الذي يعطي الرسالة الحالية. يمكن أن يكون systemأوassistantuser أوtool أو function.
content سلسلة أو مجموعة ‏‏نعم‬ غير متوفر محتوى الرسالة. يجب أن تكون سلسلة، ما لم يكن في سيناريو تمكين الرؤية. إذا كان جزءا من user الرسالة، باستخدام نموذج GPT-4 Turbo مع Vision، مع أحدث إصدار من واجهة برمجة التطبيقات، content فيجب أن يكون صفيفا من البنيات، حيث يمثل كل عنصر إما نصا أو صورة:
  • text: يتم تمثيل نص الإدخال كبنية بالخصائص التالية:
    • type = "نص"
    • text = نص الإدخال
  • images: يتم تمثيل صورة الإدخال كبنية بالخصائص التالية:
    • type = "image_url"
    • image_url = بنية ذات الخصائص التالية:
      • url = عنوان URL للصورة
      • (اختياري) detail = highأو أو lowauto
contentPart كائن لا ‏‫غير متاح جزء من رسالة المستخدم متعددة الوسائط. يمكن أن يكون نوع النص أو نوع الصورة. إذا كان نصا، فسيكون سلسلة نصية. إذا كانت الصورة، فسيكون كائنا contentPartImage .
contentPartImage كائن لا ‏‫غير متاح يمثل صورة تم تحميلها من قبل المستخدم. يحتوي على url خاصية ، وهي إما عنوان URL للصورة أو بيانات الصورة المشفرة الأساسية 64. كما أنه يحتوي على detail خاصية يمكن أن تكون autoأو lowأو high.
enhancements كائن لا ‏‫غير متاح يمثل ميزات تحسين الرؤية المطلوبة للدردشة. يحتوي على grounding خصائص و ocr ، لكل منها خاصية منطقية enabled . استخدم هذه لطلب خدمة التعرف البصري على الحروف و/أو خدمة الكشف عن الكائنات/الأرضية [معلمة المعاينة هذه غير متوفرة في 2024-02-01 واجهة برمجة تطبيقات GA ولم تعد متوفرة في واجهات برمجة التطبيقات للمعاينة بعد 2024-03-01-preview.]
dataSources كائن لا ‏‫غير متاح يمثل بيانات موارد إضافية. بيانات موارد Computer Vision مطلوبة لتحسين الرؤية. يحتوي على خاصية type ، والتي يجب أن تكون "AzureComputerVision" وخاصية parameters ، والتي تحتوي على endpoint خاصية و key . يجب تعيين هذه السلاسل إلى عنوان URL لنقطة النهاية ومفتاح الوصول لمورد Computer Vision.
n integer اختياري 1 كم عدد خيارات إكمال الدردشة التي يجب إنشاؤها لكل رسالة إدخال.
stream boolean اختياري true في حالة التعيين، سيتم إرسال دلتا الرسائل الجزئية، كما هو الحال في ChatGPT. سيتم إرسال الرموز المميزة كأحداث مرسلة إلى الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالة data: [DONE] ."
stop سلسلة أو مجموعة اختياري قيمة فارغة ما يصل إلى 4 تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة.
max_tokens integer اختياري Inf الحد الأقصى لعدد الرموز المميزة المسموح بها للإجابة التي تم إنشاؤها. بشكل افتراضي، سيكون عدد الرموز المميزة التي يمكن للنموذج إرجاعها (4096 - الرموز المميزة للمطالبة).
presence_penalty رقم اختياري 0 رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج.
frequency_penalty رقم اختياري 0 رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي.
logit_bias كائن اختياري قيمة فارغة تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن json الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في الرمز المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. يختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو اختيار حصري للرمز المميز ذي الصلة.
user سلسلة اختياري معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد Azure OpenAI على مراقبة إساءة الاستخدام واكتشافها.
function_call اختياري [Deprecated in 2023-12-01-preview replacement parameter is tools_choice]يتحكم في كيفية استجابة النموذج لاستدعاءات الوظائف. تعني كلمة "لا شيء" أن النموذج لا يستدعي دالة، ويستجيب للمستخدم النهائي. auto يعني أن النموذج يمكنه الاختيار بين مستخدم أو استدعاء دالة. تحديد دالة معينة عبر {"name": "my_function"} يفرض على النموذج استدعاء هذه الدالة. "none" هو الافتراضي عندما لا تكون هناك دالات. auto هو الافتراضي إذا كانت الدالات موجودة. تتطلب هذه المعلمة إصدار واجهة برمجة التطبيقات 2023-07-01-preview
functions FunctionDefinition[] اختياري [Deprecated in 2023-12-01-preview replacement paremeter is tools] قائمة بالوظائف التي يمكن للنموذج إنشاء مدخلات JSON لها. تتطلب هذه المعلمة إصدار واجهة برمجة التطبيقات 2023-07-01-preview
tools سلسلة (نوع الأداة. معتمد فقط function .) اختياري قائمة بالأدوات التي يمكن للنموذج الاتصال بها. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي يمكن للنموذج إنشاء مدخلات JSON لها. تتطلب هذه المعلمة إصدار واجهة برمجة التطبيقات 2023-12-01-preview
tool_choice سلسلة أو عنصر اختياري لا شيء هو الافتراضي عندما لا توجد دالات. auto هو الافتراضي إذا كانت الدالات موجودة. عناصر التحكم التي يتم استدعاء الدالة (إن وجدت) بواسطة النموذج. لا شيء يعني أن النموذج لن يستدعي دالة وبدلا من ذلك ينشئ رسالة. auto يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء دالة. تحديد دالة معينة عبر {"type: "function", "function": {"name": "my_function"}} يفرض على النموذج استدعاء هذه الدالة. تتطلب هذه المعلمة إصدار واجهة برمجة التطبيقات أو أحدث 2023-12-01-preview .
top_p رقم لا الافتراضي:1
الحد الأدنى:0
الحد الأقصى:1		 بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة الاحتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من كتلة الاحتمال الأعلى بنسبة 10٪ فقط هي التي يتم النظر فيها.\nاوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما."
log_probs boolean لا ما إذا كان يجب إرجاع احتمالات السجل للرمز المميزة للإخراج أم لا. إذا كان صحيحا، فترجع احتمالات السجل لكل رمز مميز للإخراج تم إرجاعه في content من message. هذا الخيار غير متوفر حاليا على gpt-4-vision-preview النموذج.
top_logprobs عدد صحيح لا الحد الأدنى: 0
الحد الأقصى: 5		 عدد صحيح بين 0 و5 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن. logprobs يجب تعيين إلى true إذا تم استخدام هذه المعلمة.
response_format كائن لا كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يستخدم لتمكين وضع JSON.
seed عدد صحيح لا 0 إذا تم تحديده، فسيبذل نظامنا أفضل جهد للعينة بشكل محدد، بحيث أن الطلبات المتكررة بنفسها seed والمعلمات يجب أن ترجع نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة system_fingerprint لمراقبة التغييرات في الخلفية.

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

عينة طلب

دردشة نصية فقط

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-02-01 \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{"messages":[{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Does Azure OpenAI support customer managed keys?"},{"role": "assistant", "content": "Yes, customer managed keys are supported by Azure OpenAI."},{"role": "user", "content": "Do other Azure AI services support this too?"}]}'

الدردشة مع الرؤية

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2023-12-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{"messages":[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":[{"type":"text","text":"Describe this picture:"},{ "type": "image_url", "image_url": { "url": "https://learn.microsoft.com/azure/ai-services/computer-vision/media/quickstarts/presentation.png", "detail": "high" } }]}]}'

دردشة محسنة مع الرؤية

  • غير مدعوم مع إصدار نموذجgpt-4GPT-4 Turbo GA:turbo-2024-04-09
  • إصدارات واجهة برمجة التطبيقات غير المدعومة2024-02-01والإصدارات2024-04-01-preview الأحدث.
curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/extensions/chat/completions?api-version=2023-12-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{"enhancements":{"ocr":{"enabled":true},"grounding":{"enabled":true}},"dataSources":[{"type":"AzureComputerVision","parameters":{"endpoint":" <Computer Vision Resource Endpoint> ","key":"<Computer Vision Resource Key>"}}],"messages":[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":[{"type":"text","text":"Describe this picture:"},{"type":"image_url","image_url":"https://learn.microsoft.com/azure/ai-services/computer-vision/media/quickstarts/presentation.png"}]}]}'

مثال على الاستجابة

{
    "id": "chatcmpl-6v7mkQj980V1yBec6ETrKPRqFjNw9",
    "object": "chat.completion",
    "created": 1679072642,
    "model": "gpt-35-turbo",
    "usage":
    {
        "prompt_tokens": 58,
        "completion_tokens": 68,
        "total_tokens": 126
    },
    "choices":
    [
        {
            "message":
            {
                "role": "assistant",
                "content": "Yes, other Azure AI services also support customer managed keys.
                    Azure AI services offer multiple options for customers to manage keys, such as
                    using Azure Key Vault, customer-managed keys in Azure Key Vault or
                    customer-managed keys through Azure Storage service. This helps customers ensure
                    that their data is secure and access to their services is controlled."
            },
            "finish_reason": "stop",
            "index": 0
        }
    ]
}

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

في مثال الاستجابة، finish_reason يساوي stop. إذا كان finish_reason يساوي، فاطلع content_filterعلى دليل تصفية المحتوى لفهم سبب حدوث ذلك.

ChatMessage

رسالة واحدة منسوبة إلى دور ضمن تفاعل إكمال الدردشة.

Name كتابة ‏‏الوصف
المحتوى سلسلة النص المقترن بحمولة الرسالة هذه.
function_call FunctionCall اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج.
الاسم سلسلة name كاتب هذه الرسالة. name مطلوب إذا كان الدور هو function، ويجب أن يكون اسم الدالة التي تكون استجابتها في content. يمكن أن يحتوي على a-z، A-Z، 0-9، وتسطير أسفل السطر، بحد أقصى 64 حرفا.
الدور ChatRole الدور المقترن بحمولة الرسالة هذه

ChatRole

وصف للغرض المقصود من رسالة ضمن تفاعل إكمال الدردشة.

Name كتابة ‏‏الوصف
مساعد سلسلة الدور الذي يوفر استجابات للإدخل الموجه من قبل النظام والمطالبة من المستخدم.
وظيفة سلسلة الدور الذي يوفر نتائج الدالة لإكمال الدردشة.
نظام سلسلة الدور الذي يوجه سلوك المساعد أو يعينه.
المستخدم سلسلة الدور الذي يوفر الإدخال لإكمال الدردشة.

الدالة

يتم استخدام هذا مع المعلمة tools التي تمت إضافتها في إصدار 2023-12-01-previewواجهة برمجة التطبيقات .

Name كتابة ‏‏الوصف
الوصف سلسلة وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة
الاسم سلسلة اسم الدالة التي سيتم استدعاؤها. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64
المعلمات كائن المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON. راجع مرجع مخطط JSON للحصول على وثائق حول التنسيق."

FunctionCall-Deprecated

اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج. يتطلب هذا إصدار واجهة برمجة التطبيقات 2023-07-01-preview

Name كتابة ‏‏الوصف
الحجج سلسلة الوسيطات لاستدعاء الدالة مع، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لا ينشئ النموذج دائما JSON صالحا، وقد يختلق معلمات غير محددة بواسطة مخطط الدالة الخاص بك. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة.
الاسم سلسلة اسم الدالة التي يجب استدعاها.

FunctionDefinition-مهمل

تعريف دالة محددة من قبل المتصل يمكن استدعاء إكمال الدردشة استجابة لإدخال المستخدم المطابق. يتطلب هذا إصدار واجهة برمجة التطبيقات 2023-07-01-preview

Name كتابة ‏‏الوصف
الوصف سلسلة وصف لما تقوم به الدالة. يستخدم النموذج هذا الوصف عند تحديد الدالة وتفسير معلماتها.
الاسم سلسلة اسم الدالة التي سيتم استدعاؤها.
المعلمات المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON.

ملحقات الإكمال

تم نقل وثائق هذا القسم. راجع وثائق مرجع Azure OpenAI على بياناتك بدلا من ذلك.

توليد صورة

طلب صورة تم إنشاؤها (DALL-E 3)

إنشاء مجموعة من الصور واستردادها من تسمية توضيحية للنص.

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/images/generations?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI الخاص بك.
deployment-id سلسلة المطلوب اسم نشر نموذج DALL-E 3 مثل MyDalle3. يطلب منك أولا نشر نموذج DALL-E 3 قبل أن تتمكن من إجراء المكالمات.
api-version سلسلة المطلوب إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية. يتبع هذا التنسيق YYYY-MM-DD.

الإصدارات المدعومة

نص الطلب

المعلمة النوع مطلوب؟ Default ‏‏الوصف
prompt سلسلة المطلوب وصف نصي للصورة (الصور) المطلوبة. الحد الأقصى للطول هو 4000 حرف.
n integer اختياري 1 عدد الصور المراد إنشاؤها. يتم دعم DALL-E 3 فقط n=1 .
size سلسلة اختياري 1024x1024 حجم الصور التي تم إنشاؤها. يجب أن يكون واحدا من 1792x1024أو 1024x1024أو 1024x1792.
quality سلسلة اختياري standard جودة الصور التي تم إنشاؤها. لابد أن يكون hd أو standard.
response_format سلسلة اختياري url يجب أن يكون url التنسيق الذي يتم إرجاع الصور التي تم إنشاؤها به (عنوان URL يشير إلى الصورة) أو b64_json (التعليمة البرمجية الأساسية 64 بايت بتنسيق JSON).
style سلسلة اختياري vivid نمط الصور التي تم إنشاؤها. يجب أن يكون natural أو vivid (للصور فائقة الواقعية / الدرامية).
user سلسلة اختياري معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.

يتم الآن دعم Dalle-2 في 2024-05-01-preview.

عينة طلب

curl -X POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/images/generations?api-version=2023-12-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{
    "prompt": "An avocado chair",
    "size": "1024x1024",
    "n": 1,
    "quality": "hd", 
    "style": "vivid"
  }'

مثال على الاستجابة

ترجع 202 العملية رمز حالة وعنصر GenerateImagesResponse JSON يحتوي على معرف وحالة العملية.

{ 
    "created": 1698116662, 
    "data": [ 
        { 
            "url": "url to the image", 
            "revised_prompt": "the actual prompt that was used" 
        }, 
        { 
            "url": "url to the image" 
        },
        ...
    ]
}

طلب صورة تم إنشاؤها (معاينة DALL-E 2)

إنشاء دفعة من الصور من تسمية توضيحية للنص.

POST https://{your-resource-name}.openai.azure.com/openai/images/generations:submit?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI الخاص بك.
api-version سلسلة المطلوب إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية. يتبع هذا التنسيق YYYY-MM-DD.

الإصدارات المدعومة

نص الطلب

المعلمة النوع مطلوب؟ Default ‏‏الوصف
prompt سلسلة المطلوب وصف نصي للصورة (الصور) المطلوبة. الحد الأقصى للطول هو 1000 حرف.
n integer اختياري 1 عدد الصور المراد إنشاؤها. يجب أن يكون بين 1 و5.
size سلسلة اختياري 1024x1024 حجم الصور التي تم إنشاؤها. يجب أن يكون واحدا من 256x256أو 512x512أو 1024x1024.

عينة طلب

curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/images/generations:submit?api-version=2023-06-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{
"prompt": "An avocado chair",
"size": "512x512",
"n": 3
}'

مثال على الاستجابة

ترجع 202 العملية رمز حالة وعنصر GenerateImagesResponse JSON يحتوي على معرف وحالة العملية.

{
  "id": "f508bcf2-e651-4b4b-85a7-58ad77981ffa",
  "status": "notRunning"
}

الحصول على نتيجة صورة تم إنشاؤها (معاينة DALL-E 2)

استخدم واجهة برمجة التطبيقات هذه لاسترداد نتائج عملية إنشاء صورة. يتوفر إنشاء الصور حاليا فقط مع api-version=2023-06-01-preview.

GET https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI الخاص بك.
operation-id سلسلة المطلوب المعرف الفريد العمومي (GUID) الذي يحدد طلب إنشاء الصورة الأصلي.

الإصدارات المدعومة

عينة طلب

curl -X GET "https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version=2023-06-01-preview"
-H "Content-Type: application/json"
-H "Api-Key: {api key}"

مثال على الاستجابة

عند النجاح، تقوم العملية بإرجاع 200 رمز الحالة وعنصر OperationResponse JSON. status يمكن أن يكون "notRunning" الحقل (المهمة في قائمة الانتظار ولكن لم تبدأ بعد) أو "running"أو "succeeded""canceled" أو (انتهاء مهلة المهمة) "failed"أو أو "deleted". succeeded تشير الحالة إلى أن الصورة التي تم إنشاؤها متاحة للتنزيل على عنوان URL المحدد. إذا تم إنشاء صور متعددة، يتم إرجاع جميع عناوين URL الخاصة بها في result.data الحقل.

{
  "created": 1685064331,
  "expires": 1685150737,
  "id": "4b755937-3173-4b49-bf3f-da6702a3971a",
  "result": {
    "data": [
      {
        "url": "<URL_TO_IMAGE>"
      },
      {
        "url": "<URL_TO_NEXT_IMAGE>"
      },
      ...
    ]
  },
  "status": "succeeded"
}

حذف صورة تم إنشاؤها من الخادم (معاينة DALL-E 2)

يمكنك استخدام معرف العملية الذي تم إرجاعه بواسطة الطلب لحذف الصورة المقابلة من خادم Azure. يتم حذف الصور التي تم إنشاؤها تلقائيا بعد 24 ساعة بشكل افتراضي، ولكن يمكنك تشغيل الحذف في وقت سابق إذا كنت تريد ذلك.

DELETE https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI الخاص بك.
operation-id سلسلة المطلوب المعرف الفريد العمومي (GUID) الذي يحدد طلب إنشاء الصورة الأصلي.

الإصدارات المدعومة

عينة طلب

curl -X DELETE "https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version=2023-06-01-preview"
-H "Content-Type: application/json"
-H "Api-Key: {api key}"

استجابة

تقوم العملية بإرجاع رمز الحالة إذا كان ناجحا 204 . تنجح واجهة برمجة التطبيقات هذه فقط إذا كانت العملية في حالة نهاية (وليس running).

الكلام إلى النص

يمكنك استخدام نموذج الهمس في خدمة Azure OpenAI لتحويل الكلام إلى نص أو ترجمة الكلام. لمزيد من المعلومات حول استخدام نموذج الهمس، راجع التشغيل السريع ونظرة عامة على نموذج الهمس.

طلب خطاب إلى نسخ النص

نسخ ملف صوتي.

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/audio/transcriptions?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI.
deployment-id سلسلة المطلوب اسم نشر نموذج الهمس مثل MyWhisperDeployment. يطلب منك أولا نشر نموذج الهمس قبل إجراء المكالمات.
api-version سلسلة المطلوب إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية. تتبع هذه القيمة تنسيق YYYY-MM-DD.

الإصدارات المدعومة

نص الطلب

المعلمة النوع مطلوب؟ Default ‏‏الوصف
file ملف ‏‏نعم‬ غير متوفر كائن الملف الصوتي (وليس اسم الملف) المراد نسخه، بأحد التنسيقات التالية: flacأو mp3wavmp4m4aoggmpegmpga.webm

حد حجم الملف لنموذج الهمس في خدمة Azure OpenAI هو 25 ميغابايت. إذا كنت بحاجة إلى نسخ ملف أكبر من 25 ميغابايت، فقسمه إلى مجموعات. بدلا من ذلك يمكنك استخدام واجهة برمجة تطبيقات النسخ الدفعي ل Azure الذكاء الاصطناعي Speech.

يمكنك الحصول على ملفات صوتية نموذجية من مستودع Azure الذكاء الاصطناعي Speech SDK في GitHub.
language سلسلة لا قيمة فارغة لغة صوت الإدخال مثل fr. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 إلى تحسين الدقة وزمن الانتقال.

للحصول على قائمة اللغات المدعومة، راجع وثائق OpenAI.
prompt سلسلة لا قيمة فارغة نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت.

لمزيد من المعلومات حول المطالبات بما في ذلك حالات الاستخدام النموذجية، راجع وثائق OpenAI.
response_format سلسلة لا json تنسيق إخراج النسخة المكتوبة، في أحد هذه الخيارات: json أو text أو srt أو verbose_json أو vtt.

القيمة الافتراضية هي json.
temperature رقم لا 0 درجة حرارة أخذ العينات، بين 0 و1.

تجعل القيم الأعلى مثل 0.8 الإخراج أكثر عشوائية، في حين أن القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحسما. إذا تم تعيينه إلى 0، يستخدم النموذج احتمال السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى حدود معينة.

القيمة الافتراضية هي 0.
timestamp_granularities صفيف اختياري المقطع نقاوة الطابع الزمني التي يجب ملؤها لهذا النسخ. response_format يجب تعيين verbose_json لاستخدام نقاوة الطابع الزمني. يتم دعم أي من هذين الخيارين أو كليهما: wordأو segment. ملاحظة: لا يوجد زمن انتقال إضافي للطوابع الزمنية للمقطع، ولكن إنشاء الطوابع الزمنية للكلمة يتطلب زمن انتقال إضافي. [تمت الإضافة في 2024-04-01-prevew]

عينة طلب

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/audio/transcriptions?api-version=2023-09-01-preview \
  -H "Content-Type: multipart/form-data" \
  -H "api-key: $YOUR_API_KEY" \
  -F file="@./YOUR_AUDIO_FILE_NAME.wav" \
  -F "language=en" \
  -F "prompt=The transcript contains zoology terms and geographical locations." \
  -F "temperature=0" \
  -F "response_format=srt"

مثال على الاستجابة

1
00:00:00,960 --> 00:00:07,680
The ocelot, Lepardus paradalis, is a small wild cat native to the southwestern United States,

2
00:00:07,680 --> 00:00:13,520
Mexico, and Central and South America. This medium-sized cat is characterized by

3
00:00:13,520 --> 00:00:18,960
solid black spots and streaks on its coat, round ears, and white neck and undersides.

4
00:00:19,760 --> 00:00:27,840
It weighs between 8 and 15.5 kilograms, 18 and 34 pounds, and reaches 40 to 50 centimeters

5
00:00:27,840 --> 00:00:34,560
16 to 20 inches at the shoulders. It was first described by Carl Linnaeus in 1758.

6
00:00:35,360 --> 00:00:42,880
Two subspecies are recognized, L. p. paradalis and L. p. mitis. Typically active during twilight

7
00:00:42,880 --> 00:00:48,480
and at night, the ocelot tends to be solitary and territorial. It is efficient at climbing,

8
00:00:48,480 --> 00:00:54,480
leaping, and swimming. It preys on small terrestrial mammals such as armadillo, opossum,

9
00:00:54,480 --> 00:00:56,480
and lagomorphs.

طلب تحويل الكلام إلى ترجمة نصية

ترجمة ملف صوتي من لغة أخرى إلى اللغة الإنجليزية. للحصول على قائمة اللغات المدعومة، راجع وثائق OpenAI.

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/audio/translations?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI.
deployment-id سلسلة المطلوب اسم نشر نموذج الهمس مثل MyWhisperDeployment. يطلب منك أولا نشر نموذج الهمس قبل إجراء المكالمات.
api-version سلسلة المطلوب إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية. تتبع هذه القيمة تنسيق YYYY-MM-DD.

الإصدارات المدعومة

نص الطلب

المعلمة النوع مطلوب؟ Default ‏‏الوصف
file ملف ‏‏نعم‬ غير متوفر كائن الملف الصوتي (وليس اسم الملف) المراد نسخه، بأحد هذه التنسيقات: flac أو mp3 أو mp4 أو mpeg أو mpga أو m4a أو ogg أو wav أو webm.

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

يمكنك تنزيل ملفات صوتية نموذجية من مستودع Azure الذكاء الاصطناعي Speech SDK في GitHub.
prompt سلسلة لا قيمة فارغة نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت.

لمزيد من المعلومات حول المطالبات بما في ذلك حالات الاستخدام النموذجية، راجع وثائق OpenAI.
response_format سلسلة لا json تنسيق إخراج النسخة المكتوبة، في أحد هذه الخيارات: json أو text أو srt أو verbose_json أو vtt.

القيمة الافتراضية هي json.
temperature رقم لا 0 درجة حرارة أخذ العينات، بين 0 و1.

تجعل القيم الأعلى مثل 0.8 الإخراج أكثر عشوائية، في حين أن القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحسما. إذا تم تعيينه إلى 0، يستخدم النموذج احتمال السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى حدود معينة.

القيمة الافتراضية هي 0.

عينة طلب

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/audio/translations?api-version=2023-09-01-preview \
  -H "Content-Type: multipart/form-data" \
  -H "api-key: $YOUR_API_KEY" \
  -F file="@./YOUR_AUDIO_FILE_NAME.wav" \
  -F "temperature=0" \
  -F "response_format=json"

مثال على الاستجابة

{
  "text": "Hello, my name is Wolfgang and I come from Germany. Where are you heading today?"
}

نص إلى كلام

تجميع النص إلى كلام.

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/audio/speech?api-version={api-version}

معلمات المسار

المعلمة النوع مطلوب؟ ‏‏الوصف
your-resource-name سلسلة المطلوب اسم مورد Azure OpenAI.
deployment-id سلسلة المطلوب اسم نشر نموذج النص إلى الكلام مثل MyTextToSpeechDeployment. يطلب منك أولا نشر نص إلى نموذج الكلام (مثل tts-1 أو tts-1-hd) قبل أن تتمكن من إجراء المكالمات.
api-version سلسلة المطلوب إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية. تتبع هذه القيمة تنسيق YYYY-MM-DD.

الإصدارات المدعومة

نص الطلب

المعلمة النوع مطلوب؟ Default ‏‏الوصف
model سلسلة ‏‏نعم‬ غير متوفر أحد نماذج TTS المتوفرة: tts-1 أو tts-1-hd
input سلسلة ‏‏نعم‬ غير متوفر النص الذي تريد إنشاء صوت له. الحد الأقصى للطول هو 4096 حرفا. حدد نص الإدخال باللغة التي تختارها.1
voice سلسلة ‏‏نعم‬ غير متوفر الصوت الذي يجب استخدامه عند إنشاء الصوت. الأصوات المدعومة هي alloyو echofableوonyxnova.shimmer تتوفر معاينات الأصوات في دليل نص OpenAI إلى الكلام.

1 يدعم النص إلى نماذج الكلام بشكل عام نفس لغات نموذج الهمس. للحصول على قائمة اللغات المدعومة، راجع وثائق OpenAI.

عينة طلب

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/audio/speech?api-version=2024-02-15-preview \
 -H "api-key: $YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
    "model": "tts-hd",
    "input": "I'm excited to try text to speech.",
    "voice": "alloy"
}' --output speech.mp3

مثال على الاستجابة

يتم إرجاع الكلام كملف صوتي من الطلب السابق.

واجهات برمجة تطبيقات الإدارة

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

الوثائق المرجعية لواجهات برمجة التطبيقات للإدارة

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

تعرف على النماذج، والضبط الدقيق مع واجهة برمجة تطبيقات REST. تعرف على المزيد حول النماذج الأساس التي تعمل على تشغيل Azure OpenAI.