مرجع واجهة برمجة التطبيقات Azure OpenAI in Microsoft Foundry Models

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

مواصفات واجهة برمجة التطبيقات

إدارة وتفاعل نماذج وموارد Azure OpenAI مقسمة عبر ثلاثة أسطح رئيسية لواجهات برمجة التطبيقات:

وحدة التحكم
مستوى البيانات - التأليف
مستوى البيانات - الاستدلال

كل سطح/مواصفة API تحتوي على مجموعة مختلفة من قدرات Azure OpenAI. لكل واجهة برمجة تطبيقات مجموعة فريدة من إصدارات المعاينة والمستقرة/المتاحة عموما (GA). إصدارات المعاينات حاليا تميل إلى اتباع وتيرة شهرية.

مهم

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

API	أحدث إصدار معاينة	أحدث إصدار من GA	المواصفات	الوصف
وحدة التحكم	`2025-07-01-preview`	`2025-06-01`	ملفات المواصفات	تستخدم واجهة برمجة تطبيقات مستوى التحكم في العمليات مثل إنشاء الموارد، ونشر النماذج، وغيرها من مهام إدارة الموارد على مستوى أعلى. كما يتحكم مستوى التحكم في ما يمكن فعله بقدرات مثل Azure Resource Manager وBicep وTerraform وAzure CLI.
مستوى البيانات	`v1 preview`	`v1`	ملفات المواصفات	تتحكم واجهة برمجة التطبيقات في مستوى البيانات في عمليات الاستدلال والتأليف.

المصادقة

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

مصادقة مفتاح API: لهذا النوع من المصادقة، يجب أن تتضمن جميع طلبات API مفتاح API في api-key رأس HTTP. يوفر البدء السريع إرشادات حول كيفية إجراء المكالمات باستخدام هذا النوع من المصادقة.
Microsoft Entra ID المصادقة: يمكنك التحقق من استدعاء واجهة برمجة التطبيقات باستخدام رمز Microsoft Entra. يتم تضمين رموز المصادقة في الطلب كرأس Authorization رئيسي. يجب أن يسبق الرمز المقدم ب Bearer، على سبيل المثال Bearer YOUR_AUTH_TOKEN. يمكنك قراءة دليلنا التعليمي حول التحقق باستخدام Microsoft Entra ID.

إصدار REST API

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

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

استنتاج مستوى البيانات

يغطي بقية المقال إصدار GA لمواصفة الاستدلال لمستوى البيانات Azure OpenAI، 2024-10-21.

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

الإنجازات

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

ينشئ إكمال للطلب المقدم والمعلمات والنموذج المختار.

معلمات URI

Name	In	مطلوبة	النوع	الوصف
نقطه النهايه	مسار	‏‏نعم‬	string عنوان URL	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
معرف التوزيع	مسار	‏‏نعم‬	string	معرف النشر للنموذج الذي تم نشره.
إصدار API	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

Name	مطلوبة	النوع	الوصف
مفتاح واجهة برمجة التطبيقات	صحيح	string	قدم مفتاح API Azure OpenAI هنا

هيئة الطلب

نوع المحتوى: application/json

Name	النوع	الوصف	مطلوبة	افتراضي
الموضوع	السلسلة أو المصفوفة	الأوامر (أو المعرضات) لتوليد الإكمالات ل، مشفرة كسلسلة، مصفوفة من السلاسل النصية، مصفوفة الرموز، أو مصفوفة من مصفوفات الرموز. لاحظ أن <\|endoftext\|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، فإذا لم يتم تحديد الطلب، فإن النموذج سينشأ كما لو كان من بداية مستند جديد.	‏‏نعم‬
best_of	integer	يولد `best_of` الإنجازات على جانب الخادم ويعيد "الأفضل" (الذي لديه أعلى احتمال لوغاريتمية لكل رمز). لا يمكن بث النتائج. عند استخدامه مع `n`، `best_of` يتحكم في عدد المرشحين المكتملين ويحدد `n` عدد المرات التي يجب إرجاعها â€" `best_of` يجب أن يكون أكبر من `n`. ملاحظة: نظرا لأن هذا المعامل يولد العديد من الإكمالات، يمكنه بسرعة استهلاك حصة الرمز الخاصة بك. استخدم بحذر وتأكد من وجود إعدادات مناسبة ل `max_tokens` و `stop`.	لا	1
صدى	boolean	أعد الموضوع بالإضافة إلى الإكمال	لا	خطأ
frequency_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا.	لا	1
logit_bias	الهدف	قم بتعديل احتمالية ظهور رموز محددة في الإكمال. يقبل كائن JSON يقوم بتعيين الرموز (المحددة بواسطة معرف الرمز الخاص بها في ترميز GPT) إلى قيمة تحيز مرتبطة من -100 إلى 100. رياضيا، يضاف التحيز إلى اللوجيتس التي يولدها النموذج قبل أخذ العينة. التأثير الدقيق يختلف حسب النموذج، لكن القيم بين -1 و1 يجب أن تقلل أو تزيد من احتمال الاختيار؛ قيم مثل -100 أو 100 يجب أن تؤدي إلى حظر أو اختيار حصري للرمز المعني. كمثال، يمكنك تمرير `{"50256": -100}` الرمز <لمنع إنشاء رمز \|endoftext\|> من الآن.	لا	‏‫لا شيء‬
logprobs	integer	أدرج احتمالات السجل على `logprobs` الرموز الأكثر احتمالا للخروج، بالإضافة إلى الرموز المختارة. على سبيل المثال، إذا `logprobs` كان 5، ستعيد واجهة برمجة التطبيقات قائمة بخمسة رموز محتملة جدا. ستعيد واجهة برمجة التطبيقات دائما الرمز `logprob` المأخوذ من العينة، لذا قد تكون `logprobs+1` هناك حتى عناصر في الرد. القيمة القصوى ل `logprobs` هي 5.	لا	‏‫لا شيء‬
max_tokens	integer	الحد الأقصى لعدد الرموز التي يمكن توليدها في الإكمال. لا يمكن أن يتجاوز عدد الرموز في الطلبة بالإضافة `max_tokens` إلى طول سياق النموذج.	لا	16
n	integer	كم عدد الإكمال الذي يجب توليده لكل محفز. ملاحظة: نظرا لأن هذا المعامل يولد العديد من الإكمالات، يمكنه بسرعة استهلاك حصة الرمز الخاصة بك. استخدم بحذر وتأكد من وجود إعدادات مناسبة ل `max_tokens` و `stop`.	لا	1
presence_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة.	لا	1
البذور	integer	إذا تم تحديده، سيبذل نظامنا أقصى جهد لأخذ عينات حتمية، بحيث يجب أن تعطي الطلبات المتكررة بنفس `seed` المعلمات نفس النتيجة. الحتمية ليست مضمونة، ويجب عليك الرجوع إلى `system_fingerprint` معامل الاستجابة لمراقبة التغيرات في الخلفية.	لا
توقف	السلسلة أو المصفوفة	حتى أربع تسلسلات تتوقف فيها واجهة برمجة التطبيقات عن توليد المزيد من الرموز. النص المرتجع لن يحتوي على تسلسل التوقف.	لا
تدفق	boolean	ما إذا كان يجب بث التقدم الجزئي مرة أخرى. إذا تم تعيينها، سيتم إرسال الرموز كأحداث مرسلة من الخادم فقط للبيانات بمجرد توفرها، مع إنهاء التدفق برسالة `data: [DONE]` .	لا	خطأ
اللاحقة	string	اللاحقة التي تأتي بعد إكمال النص المدرج. هذا المعامل مدعوم فقط ل `gpt-3.5-turbo-instruct`.	لا	‏‫لا شيء‬
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو `top_p` ليس كلاهما.	لا	1
top_p	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	إنشاءCompletionResponse	يمثل استجابة إكمال من واجهة برمجة التطبيقات (API). ملاحظة: كل من كائنات الاستجابة المتدفقة وغير المبثة تشتركان في نفس الشكل (على عكس نقطة نهاية الدردشة).

رمز الحالة: افتراضي

الوصف: الخدمة غير متوفرة

نوع المحتوى	نوع	الوصف
application/json	خطأ الاستجابة

الأمثلة

مثال

ينشئ إكمال للطلب المقدم والمعلمات والنموذج المختار.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

الردود: رمز الحالة: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

التضمينات

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

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

معلمات URI

Name	In	مطلوبة	النوع	الوصف
نقطه النهايه	مسار	‏‏نعم‬	string عنوان URL	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
معرف التوزيع	مسار	‏‏نعم‬	string
إصدار API	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

Name	مطلوبة	النوع	الوصف
مفتاح واجهة برمجة التطبيقات	صحيح	string	قدم مفتاح API Azure OpenAI هنا

هيئة الطلب

نوع المحتوى: application/json

Name	النوع	الوصف	مطلوبة
المدخلات	السلسلة أو المصفوفة	إدخال النص للتضمين، مشفر كسلسلة أو مصفوفة من الرموز. لتضمين عدة مدخلات في طلب واحد، مرر مصفوفة من السلاسل أو مصفوفات الرموز. يجب ألا يتجاوز المدخل الحد الأقصى لرموز الإدخال للنموذج (8,192 رمزا ل `text-embedding-ada-002`)، ولا يمكن أن يكون سلسلة فارغة، ويجب أن تكون أي مصفوفة بأبعاد 2,048 أو أقل. بالإضافة إلى حد الرمز لكل إدخال، تفرض جميع نماذج التضمين مجموع حد أقصى يصل إلى 300,000 رمز عبر جميع المدخلات في طلب واحد.	‏‏نعم‬
المستخدم	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة واكتشاف الإساءة.	لا
input_type	string	نوع الإدخال من البحث في التضمين للاستخدام	لا
encoding_format	string	التنسيق لإعادة التضمينات. يمكن أن يكون إما `float` أو `base64`. تتغير افتراضيا إلى `float`.	لا
الأبعاد	integer	عدد الأبعاد التي يجب أن تكون على التضمينات الناتجة. مدعوم فقط في `text-embedding-3` النماذج الأحدث واللاحقة.	لا

Responses

Name	النوع	مطلوبة
الهدف	string	‏‏نعم‬
النموذج	string	‏‏نعم‬
البيانات	مصفوفة	‏‏نعم‬
الاستخدام	الهدف	‏‏نعم‬

خصائص للاستخدام

prompt_tokens

Name	النوع	الوصف	افتراضي
prompt_tokens	integer

total_tokens

Name	النوع	الوصف	افتراضي
total_tokens	integer

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	الهدف

الأمثلة

مثال

أعد التضمينات الخاصة بطلب معين.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

{
 "input": [
  "this is a test"
 ]
}

الردود: رمز الحالة: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

ينشئ إكمال لرسالة الدردشة

معلمات URI

Name	In	مطلوبة	النوع	الوصف
نقطه النهايه	مسار	‏‏نعم‬	string عنوان URL	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
معرف التوزيع	مسار	‏‏نعم‬	string	معرف النشر للنموذج الذي تم نشره.
إصدار API	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

Name	مطلوبة	النوع	الوصف
مفتاح واجهة برمجة التطبيقات	صحيح	string	قدم مفتاح API Azure OpenAI هنا

هيئة الطلب

نوع المحتوى: application/json

Name	النوع	الوصف	مطلوبة	افتراضي
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو `top_p` ليس كلاهما.	لا	1
top_p	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
تدفق	boolean	إذا تم تعيينها، سيتم إرسال دلتا جزئية للرسائل، كما في ChatGPT. سيتم إرسال الرموز كأحداث مرسلة من الخادم فقط عبر البيانات بمجرد توفرها، مع إنهاء التدفق برسالة `data: [DONE]` .	لا	خطأ
توقف	السلسلة أو المصفوفة	حتى أربع تسلسلات تتوقف فيها واجهة برمجة التطبيقات عن توليد المزيد من الرموز.	لا
max_tokens	integer	الحد الأقصى لعدد الرموز التي يمكن إنشاؤها في إكمال الدردشة. الطول الكلي لرموز الإدخال والرموز المولدة محدود بطول سياق النموذج.	لا
max_completion_tokens	integer	حد أعلى لعدد الرموز التي يمكن توليدها لإكمال، بما في ذلك رموز الإخراج المرئية ورموز الاستدلال.	لا
presence_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة.	لا	1
frequency_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا.	لا	1
logit_bias	الهدف	قم بتعديل احتمالية ظهور رموز محددة في الإكمال. يقبل كائن JSON يربط الرموز (المحددة بمعرف الرمز الخاص بها في الرمز) إلى قيمة تحيز مرتبطة من -100 إلى 100. رياضيا، يضاف التحيز إلى اللوجيتس التي يولدها النموذج قبل أخذ العينة. التأثير الدقيق يختلف حسب النموذج، لكن القيم بين -1 و1 يجب أن تقلل أو تزيد من احتمال الاختيار؛ قيم مثل -100 أو 100 يجب أن تؤدي إلى حظر أو اختيار حصري للرمز المعني.	لا	‏‫لا شيء‬
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا
الرسائل	مصفوفة	قائمة بالرسائل التي شكلت المحادثة حتى الآن.	‏‏نعم‬
data_sources	مصفوفة	إدخالات التكوين لإضافات الدردشة Azure OpenAI التي تستخدمها. هذه المواصفة الإضافية متوافقة فقط مع Azure OpenAI.	لا
logprobs	boolean	هل يجب إعادة احتمالات السجل لرموز الإخراج أم لا. إذا كان صحيحا، يعيد احتمالات لوغاريتيم كل رمز مخرج تم إرجاعه في `content` .`message`	لا	خطأ
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز الأكثر احتمالا للعودة في كل موقع رمز، لكل منها احتمال لوغاريتمية مرتبط. `logprobs` يجب أن يتم ضبطه إلى `true` إذا تم استخدام هذا المعامل.	لا
n	integer	كم عدد خيارات إكمال المحادثة التي يجب إنشاؤها لكل رسالة إدخال. لاحظ أنه سيتم تحصيل الرسوم بناء على عدد الرموز المولدة عبر جميع الخيارات. حافظ `n` على ذلك `1` لتقليل التكاليف.	لا	1
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تفعيل استدعاء الدوال المتوازية أثناء استخدام الأداة.	لا	صحيح
response_format	ResponseFormatText أو ResponseFormatJsonObject أو ResponseFormatJsonSchema	كائن يحدد الصيغة التي يجب أن ينتجها النموذج. متوافق مع GPT-4o وGPT-4o mini وGPT-4 Turbo وجميع طرازات GPT-3.5 Turbo الأحدث من `gpt-3.5-turbo-1106`. إعداد تفعيل `{ "type": "json_schema", "json_schema": {...} }` Structured Outputs مما يضمن أن النموذج سيتطابق مخطط JSON المرفق لديك. إعداد تفعيل `{ "type": "json_object" }` وضع JSON، الذي يضمن أن الرسالة التي يولدها النموذج هي JSON صالحة. مهم: عند استخدام وضع JSON، يجب عليك أيضا توجيه النموذج لإنتاج JSON بنفسه عبر رسالة نظام أو مستخدم. بدون ذلك، قد يولد النموذج تدفقا لا ينتهي من المساحات البيضاء حتى يصل التوليد إلى حد الرموز، مما يؤدي إلى طلب طويل الأمد ويبدو "عالق". لاحظ أيضا أن محتوى الرسالة قد يقطع جزئيا إذا `finish_reason="length"`، مما يشير إلى أن `max_tokens` التوليد تجاوز أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
البذور	integer	هذه الميزة موجودة في مرحلة البيتا. إذا تم تحديده، سيبذل نظامنا أقصى جهد لأخذ عينات حتمية، بحيث يجب أن تعطي الطلبات المتكررة بنفس `seed` المعلمات نفس النتيجة. الحتمية ليست مضمونة، ويجب عليك الرجوع إلى `system_fingerprint` معامل الاستجابة لمراقبة التغيرات في الخلفية.	لا
الأدوات	مصفوفة	قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالدوال التي قد يولد النموذج مدخلات JSON لها. يتم دعم حد أقصى 128 وظيفة.	لا
tool_choice	chatCompletionToolChoiceOption	يتحكم في أي أداة (إن وجدت) يتم استدعاؤها بواسطة النموذج. `none` يعني أن النموذج لن يستدعي أي أداة بل يولد رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة أو أكثر. تحديد أداة معينة عبر `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة. `none` هو الوضع الافتراضي عندما لا تتوفر أدوات. `auto` هي الافتراضية إذا كانت الأدوات موجودة.	لا
function_call	string أو chatCompletionFunctionCallOption	تم استبعاده لصالح `tool_choice`. يتحكم في أي وظيفة (إن وجدت) يتم استدعاؤها بواسطة النموذج. `none` يعني أن النموذج لن يستدعي دالة بل يولد رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء دالة. تحديد دالة معينة عبر `{"name": "my_function"}` يجبر النموذج على استدعاء تلك الدالة. `none` هي الوضع الافتراضي عندما لا توجد دوال. `auto` هي الافتراضية إذا كانت الدوال موجودة.	لا
الوظائف	مصفوفة	تم استبعاده لصالح `tools`. قائمة بالدوال التي قد يولد النموذج مدخلات JSON لها.	لا

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	createChatCompletionResponse أو createChatCompletionStreamResponse

رمز الحالة: افتراضي

الوصف: الخدمة غير متوفرة

نوع المحتوى	نوع	الوصف
application/json	خطأ الاستجابة

الأمثلة

مثال

ينشئ إكمال للطلب المقدم والمعلمات والنموذج المختار.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

الردود: رمز الحالة: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

مثال

ينشئ إكمال بناء على بيانات Azure Search والهوية المدارة المعينة من النظام.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

الردود: رمز الحالة: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

مثال

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

الردود: رمز الحالة: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

مثال

ينشئ إكمال لقاعدة بيانات Azure Cosmos DB المقدمة.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

الردود: رمز الحالة: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

النسخ - إنشاء

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

يقوم بنسخ الصوت إلى لغة الإدخال.

معلمات URI

Name	In	مطلوبة	النوع	الوصف
نقطه النهايه	مسار	‏‏نعم‬	string عنوان URL	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
معرف التوزيع	مسار	‏‏نعم‬	string	معرف النشر لنموذج تحويل الكلام إلى نص. للحصول على معلومات حول النماذج المدعومة، راجع [/azure/ai-foundry/openai/concepts/models#audio-models].
إصدار API	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

Name	مطلوبة	النوع	الوصف
مفتاح واجهة برمجة التطبيقات	صحيح	string	قدم مفتاح API Azure OpenAI هنا

هيئة الطلب

نوع المحتوى: متعدد الأجزاء/بيانات الشكل

Name	النوع	الوصف	مطلوبة	افتراضي
ملف	string	ملف الصوت يجب نسخه.	‏‏نعم‬
الموضوع	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار مقطع صوتي سابق. يجب أن يتطابق الموضوع مع لغة الصوت.	لا
response_format	تنسيق الاستجابة الصوتية	يحدد تنسيق المخرج.	لا
درجة الحرارة	number	درجة حرارة العينة، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. إذا تم ضبطه على 0، سيستخدم النموذج احتمال لوغاريتيم لزيادة درجة الحرارة تلقائيا حتى تصل عتبات معينة.	لا	1
اللغة	string	لغة الصوت المدخل. توفير لغة الإدخال بصيغة ISO-639-1 سيحسن الدقة والتأخير.	لا

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	audioResponse أو audioVerboseResponse
النص/البسيط	string	كان ينسخ النص بصيغة الإخراج (عندما response_format نصا أو VTT أو SRT).

الأمثلة

مثال

يحصل على النص المنقول والبيانات الوصفية المرتبطة به من بيانات الصوت المنطوقة المقدمة.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

الردود: رمز الحالة: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

مثال

يحصل على النص المنقول والبيانات الوصفية المرتبطة به من بيانات الصوت المنطوقة المقدمة.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

الردود: رمز الحالة: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

الترجمات - إنشاء

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

يقوم بنسخ وترجمة الصوت المدخل إلى النص الإنجليزي.

معلمات URI

Name	In	مطلوبة	النوع	الوصف
نقطه النهايه	مسار	‏‏نعم‬	string عنوان URL	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
معرف التوزيع	مسار	‏‏نعم‬	string	معرف النشر لنموذج الهمس الذي تم نشره. للحصول على معلومات حول النماذج المدعومة، راجع [/azure/ai-foundry/openai/concepts/models#audio-models].
إصدار API	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

Name	مطلوبة	النوع	الوصف
مفتاح واجهة برمجة التطبيقات	صحيح	string	قدم مفتاح API Azure OpenAI هنا

هيئة الطلب

نوع المحتوى: متعدد الأجزاء/بيانات الشكل

Name	النوع	الوصف	مطلوبة	افتراضي
ملف	string	ملف الصوت للترجمة.	‏‏نعم‬
الموضوع	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار مقطع صوتي سابق. يجب أن يكون الموضوع باللغة الإنجليزية.	لا
response_format	تنسيق الاستجابة الصوتية	يحدد تنسيق المخرج.	لا
درجة الحرارة	number	درجة حرارة العينة، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. إذا تم ضبطه على 0، سيستخدم النموذج احتمال لوغاريتيم لزيادة درجة الحرارة تلقائيا حتى تصل عتبات معينة.	لا	1

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	audioResponse أو audioVerboseResponse
النص/البسيط	string	كان ينسخ النص بصيغة الإخراج (عندما response_format نصا أو VTT أو SRT).

الأمثلة

مثال

يحصل على النص المنسوخ باللغة الإنجليزية والبيانات الوصفية المرتبطة به من بيانات الصوت المنطوقة المقدمة.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

الردود: رمز الحالة: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

مثال

يحصل على النص المنسوخ باللغة الإنجليزية والبيانات الوصفية المرتبطة به من بيانات الصوت المنطوقة المقدمة.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

الردود: رمز الحالة: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

إنشاء الصور

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

ينشئ دفعة من الصور من تعليق نصي على نشر نموذج dall-e معين

معلمات URI

Name	In	مطلوبة	النوع	الوصف
نقطه النهايه	مسار	‏‏نعم‬	string عنوان URL	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
معرف التوزيع	مسار	‏‏نعم‬	string	معرف النشر لنموذج dall-e الذي تم نشره.
إصدار API	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

Name	مطلوبة	النوع	الوصف
مفتاح واجهة برمجة التطبيقات	صحيح	string	قدم مفتاح API Azure OpenAI هنا

هيئة الطلب

نوع المحتوى: application/json

Name	النوع	الوصف	مطلوبة	افتراضي
الموضوع	string	وصف نصي للصورة أو الصور المطلوبة. الحد الأقصى للطول هو 4,000 حرف.	‏‏نعم‬
n	integer	عدد الصور التي يجب إنشاؤها.	لا	1
الحجم	حجم الصورة	حجم الصور المولدة.	لا	1024x1024
response_format	imagesResponseFormat	الصيغة التي تعاد بها الصور المولدة.	لا	عنوان URL
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا
الجودة	imageQuality	جودة الصورة التي سيتم إنشاؤها.	لا	قياسي
الأسلوب	imageStyle	أسلوب الصور المولدة.	لا	حيه

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	إنشاءImagesResponse

رمز الحالة: افتراضي

الوصف: حدث خطأ.

نوع المحتوى	نوع	الوصف
application/json	داليErrorResponse

الأمثلة

مثال

ينشئ صورا مع توجيه.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

الردود: رمز الحالة: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

المكونات

خطأ الاستجابة

Name	النوع	الوصف	مطلوبة	افتراضي
خطأ	error		لا

errorBase

Name	النوع	الوصف	مطلوبة	افتراضي
الرمز	string		لا
رسالة	string		لا

خطأ

Name	النوع	الوصف	مطلوبة
برام	string		لا
النوع	string		لا
inner_error	خطأ داخلي	خطأ داخلي مع تفاصيل إضافية.	لا

خطأ داخلي

خطأ داخلي مع تفاصيل إضافية.

Name	النوع	الوصف	مطلوبة	افتراضي
الرمز	innerErrorCode	رموز الخطأ لكائن الخطأ الداخلي.	لا
content_filter_results	contentFilterPromptResults	معلومات عن فئة تصفية المحتوى (الكراهية، الجنس، العنف، self_harm)، وإذا تم اكتشافها، بالإضافة إلى مستوى الشدة (very_low، منخفض، متوسط، عالي النطاق الذي يحدد شدة ومستوى خطر المحتوى الضار) وما إذا تم تصفيته أم لا. معلومات عن محتوى الجيلبريك والألفاظ النابية، وإذا تم اكتشافه، وإذا تم تصفيتها أم لا. ومعلومات عن قائمة حظر العملاء، إذا تم تصفيتها ومعرفها.	لا

innerErrorCode

رموز الخطأ لكائن الخطأ الداخلي.

الوصف: رموز خطأ لكائن الخطأ الداخلي.

النوع: السلسلة

الافتراضي:

اسم Enum: InnerErrorCode

قيم التعداد:

قيمة	الوصف
نهجAI المسؤول	الموضوع انتهك إحدى قواعد تصفية المحتوى.

داليErrorResponse

Name	النوع	الوصف	مطلوبة	افتراضي
خطأ	داليError		لا

داليError

Name	النوع	الوصف	مطلوبة
برام	string		لا
النوع	string		لا
inner_error	dalleInnerError	خطأ داخلي مع تفاصيل إضافية.	لا

dalleInnerError

خطأ داخلي مع تفاصيل إضافية.

Name	النوع	الوصف	مطلوبة
الرمز	innerErrorCode	رموز الخطأ لكائن الخطأ الداخلي.	لا
content_filter_results	dalleFilterResults	معلومات عن فئة تصفية المحتوى (الكراهية، الجنس، العنف، self_harm)، وإذا تم اكتشافها، بالإضافة إلى مستوى الشدة (very_low، منخفض، متوسط، عالي النطاق الذي يحدد شدة ومستوى خطر المحتوى الضار) وما إذا تم تصفيته أم لا. معلومات عن محتوى الجيلبريك والألفاظ النابية، وإذا تم اكتشافه، وإذا تم تصفيتها أم لا. ومعلومات عن قائمة حظر العملاء، إذا تم تصفيتها ومعرفها.	لا
revised_prompt	string	المحفز الذي استخدم لإنشاء الصورة، إذا كان هناك أي تعديل على الطلب.	لا

contentFilterResultBase

Name	النوع	الوصف	مطلوبة	افتراضي
مفلتر	boolean		‏‏نعم‬

contentFilterSeverityResult

Name	النوع	الوصف	مطلوبة	افتراضي
مفلتر	boolean		‏‏نعم‬
الشدة	string		لا

contentFilterDetectedResult

Name	النوع	الوصف	مطلوبة	افتراضي
مفلتر	boolean		‏‏نعم‬
تم اكتشافه	boolean		لا

contentFilterDetectedWithCitationResult

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

خصائص الاستشهاد

عنوان URL

Name	النوع	الوصف	افتراضي
عنوان URL	string

الترخيص

Name	النوع	الوصف	افتراضي
الترخيص	string

contentFilterResultsBase

معلومات حول نتائج تصفية المحتوى.

Name	النوع	مطلوبة
الجنس	contentFilterSeverityResult	لا
العنف	contentFilterSeverityResult	لا
الكراهية	contentFilterSeverityResult	لا
self_harm	contentFilterSeverityResult	لا
الألفاظ النابية	contentFilterDetectedResult	لا
خطأ	errorBase	لا

contentFilterPromptResults

معلومات عن فئة تصفية المحتوى (الكراهية، الجنس، العنف، self_harm)، وإذا تم اكتشافها، بالإضافة إلى مستوى الشدة (very_low، منخفض، متوسط، عالي النطاق الذي يحدد شدة ومستوى خطر المحتوى الضار) وما إذا تم تصفيته أم لا. معلومات عن محتوى الجيلبريك والألفاظ النابية، وإذا تم اكتشافه، وإذا تم تصفيتها أم لا. ومعلومات عن قائمة حظر العملاء، إذا تم تصفيتها ومعرفها.

Name	النوع	مطلوبة
الجنس	contentFilterSeverityResult	لا
العنف	contentFilterSeverityResult	لا
الكراهية	contentFilterSeverityResult	لا
self_harm	contentFilterSeverityResult	لا
الألفاظ النابية	contentFilterDetectedResult	لا
خطأ	errorBase	لا
الهروب من السجن	contentFilterDetectedResult	لا

contentFilterChoiceResults

معلومات عن فئة تصفية المحتوى (الكراهية، الجنس، العنف، self_harm)، وإذا تم اكتشافها، بالإضافة إلى مستوى الشدة (very_low، منخفض، متوسط، عالي النطاق الذي يحدد شدة ومستوى خطر المحتوى الضار) وما إذا تم تصفيته أم لا. معلومات عن نصوص طرف ثالث والألفاظ النابية، وإذا تم اكتشافها، وإذا تم تصفيتها أم لا. ومعلومات عن قائمة حظر العملاء، إذا تم تصفيتها ومعرفها.

Name	النوع	مطلوبة
الجنس	contentFilterSeverityResult	لا
العنف	contentFilterSeverityResult	لا
الكراهية	contentFilterSeverityResult	لا
self_harm	contentFilterSeverityResult	لا
الألفاظ النابية	contentFilterDetectedResult	لا
خطأ	errorBase	لا
protected_material_text	contentFilterDetectedResult	لا
protected_material_code	contentFilterDetectedWithCitationResult	لا

promptFilterResult

نتائج تصفية المحتوى لطلب واحد في الطلب.

Name	النوع	الوصف	مطلوبة	افتراضي
prompt_index	integer		لا
content_filter_results	contentFilterPromptResults	معلومات عن فئة تصفية المحتوى (الكراهية، الجنس، العنف، self_harm)، وإذا تم اكتشافها، بالإضافة إلى مستوى الشدة (very_low، منخفض، متوسط، عالي النطاق الذي يحدد شدة ومستوى خطر المحتوى الضار) وما إذا تم تصفيته أم لا. معلومات عن محتوى الجيلبريك والألفاظ النابية، وإذا تم اكتشافه، وإذا تم تصفيتها أم لا. ومعلومات عن قائمة حظر العملاء، إذا تم تصفيتها ومعرفها.	لا

promptFilterResults

نتائج تصفية المحتوى لصفر أو أكثر من الطلبات في الطلب. في طلب البث، قد تصل نتائج طلبات مختلفة في أوقات مختلفة أو بترتيبات مختلفة.

لا توجد خصائص محددة لهذا المكون.

dalleContentFilterResults

معلومات حول نتائج تصفية المحتوى.

Name	النوع	مطلوبة
الجنس	contentFilterSeverityResult	لا
العنف	contentFilterSeverityResult	لا
الكراهية	contentFilterSeverityResult	لا
self_harm	contentFilterSeverityResult	لا

dalleFilterResults

Name	النوع	مطلوبة
الجنس	contentFilterSeverityResult	لا
العنف	contentFilterSeverityResult	لا
الكراهية	contentFilterSeverityResult	لا
self_harm	contentFilterSeverityResult	لا
الألفاظ النابية	contentFilterDetectedResult	لا
الهروب من السجن	contentFilterDetectedResult	لا

chatCompletionsRequestCommon

Name	النوع	الوصف	مطلوبة	افتراضي
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو `top_p` ليس كلاهما.	لا	1
top_p	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
تدفق	boolean	إذا تم تعيينها، سيتم إرسال دلتا جزئية للرسائل، كما في ChatGPT. سيتم إرسال الرموز كأحداث مرسلة من الخادم فقط عبر البيانات بمجرد توفرها، مع إنهاء التدفق برسالة `data: [DONE]` .	لا	خطأ
توقف	السلسلة أو المصفوفة	حتى أربع تسلسلات تتوقف فيها واجهة برمجة التطبيقات عن توليد المزيد من الرموز.	لا
max_tokens	integer	الحد الأقصى لعدد الرموز المسموح به للإجابة المولدة. افتراضيا، سيكون عدد الرموز التي يمكن للنموذج إرجاعها (4096 - رموز الطلب). هذه القيمة أصبحت الآن مهجورة لصالح `max_completion_tokens`، وهي غير متوافقة مع نماذج سلسلة O1.	لا	4096
max_completion_tokens	integer	حد أعلى لعدد الرموز التي يمكن توليدها لإكمال، بما في ذلك رموز الإخراج المرئية ورموز الاستدلال.	لا
presence_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة.	لا	1
frequency_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا.	لا	1
logit_bias	الهدف	قم بتعديل احتمالية ظهور رموز محددة في الإكمال. يقبل كائن json يربط الرموز (المحددة بمعرف الرمز الخاص بها في الرمزي) إلى قيمة تحيز مرتبطة من -100 إلى 100. رياضيا، يضاف التحيز إلى اللوجيتس التي يولدها النموذج قبل أخذ العينة. التأثير الدقيق يختلف حسب النموذج، لكن القيم بين -1 و1 يجب أن تقلل أو تزيد من احتمال الاختيار؛ قيم مثل -100 أو 100 يجب أن تؤدي إلى حظر أو اختيار حصري للرمز المعني.	لا
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد Azure OpenAI على مراقبة واكتشاف سوء الاستخدام.	لا

إنشاءCompletionRequest

Name	النوع	الوصف	مطلوبة	افتراضي
الموضوع	السلسلة أو المصفوفة	الأوامر (أو المعرضات) لتوليد الإكمالات ل، مشفرة كسلسلة، مصفوفة من السلاسل النصية، مصفوفة الرموز، أو مصفوفة من مصفوفات الرموز. لاحظ أن <\|endoftext\|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، فإذا لم يتم تحديد الطلب، فإن النموذج سينشأ كما لو كان من بداية مستند جديد.	‏‏نعم‬
best_of	integer	يولد `best_of` الإنجازات على جانب الخادم ويعيد "الأفضل" (الذي لديه أعلى احتمال لوغاريتمية لكل رمز). لا يمكن بث النتائج. عند استخدامه مع `n`، `best_of` يتحكم في عدد المرشحين المكتملين ويحدد `n` عدد المرات التي يجب إرجاعها â€" `best_of` يجب أن يكون أكبر من `n`. ملاحظة: نظرا لأن هذا المعامل يولد العديد من الإكمالات، يمكنه بسرعة استهلاك حصة الرمز الخاصة بك. استخدم بحذر وتأكد من وجود إعدادات مناسبة ل `max_tokens` و `stop`.	لا	1
صدى	boolean	أعد الموضوع بالإضافة إلى الإكمال	لا	خطأ
frequency_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا.	لا	1
logit_bias	الهدف	قم بتعديل احتمالية ظهور رموز محددة في الإكمال. يقبل كائن JSON يقوم بتعيين الرموز (المحددة بواسطة معرف الرمز الخاص بها في ترميز GPT) إلى قيمة تحيز مرتبطة من -100 إلى 100. رياضيا، يضاف التحيز إلى اللوجيتس التي يولدها النموذج قبل أخذ العينة. التأثير الدقيق يختلف حسب النموذج، لكن القيم بين -1 و1 يجب أن تقلل أو تزيد من احتمال الاختيار؛ قيم مثل -100 أو 100 يجب أن تؤدي إلى حظر أو اختيار حصري للرمز المعني. كمثال، يمكنك تمرير `{"50256": -100}` الرمز <لمنع إنشاء رمز \|endoftext\|> من الآن.	لا	‏‫لا شيء‬
logprobs	integer	أدرج احتمالات السجل على `logprobs` الرموز الأكثر احتمالا للخروج، بالإضافة إلى الرموز المختارة. على سبيل المثال، إذا `logprobs` كان 5، ستعيد واجهة برمجة التطبيقات قائمة بخمسة رموز محتملة جدا. ستعيد واجهة برمجة التطبيقات دائما الرمز `logprob` المأخوذ من العينة، لذا قد تكون `logprobs+1` هناك حتى عناصر في الرد. القيمة القصوى ل `logprobs` هي 5.	لا	‏‫لا شيء‬
max_tokens	integer	الحد الأقصى لعدد الرموز التي يمكن توليدها في الإكمال. لا يمكن أن يتجاوز عدد الرموز في الطلبة بالإضافة `max_tokens` إلى طول سياق النموذج.	لا	16
n	integer	كم عدد الإكمال الذي يجب توليده لكل محفز. ملاحظة: نظرا لأن هذا المعامل يولد العديد من الإكمالات، يمكنه بسرعة استهلاك حصة الرمز الخاصة بك. استخدم بحذر وتأكد من وجود إعدادات مناسبة ل `max_tokens` و `stop`.	لا	1
presence_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة.	لا	1
البذور	integer	إذا تم تحديده، سيبذل نظامنا أقصى جهد لأخذ عينات حتمية، بحيث يجب أن تعطي الطلبات المتكررة بنفس `seed` المعلمات نفس النتيجة. الحتمية ليست مضمونة، ويجب عليك الرجوع إلى `system_fingerprint` معامل الاستجابة لمراقبة التغيرات في الخلفية.	لا
توقف	السلسلة أو المصفوفة	حتى أربع تسلسلات تتوقف فيها واجهة برمجة التطبيقات عن توليد المزيد من الرموز. النص المرتجع لن يحتوي على تسلسل التوقف.	لا
تدفق	boolean	ما إذا كان يجب بث التقدم الجزئي مرة أخرى. إذا تم تعيينها، سيتم إرسال الرموز كأحداث مرسلة من الخادم فقط للبيانات بمجرد توفرها، مع إنهاء التدفق برسالة `data: [DONE]` .	لا	خطأ
اللاحقة	string	اللاحقة التي تأتي بعد إكمال النص المدرج. هذا المعامل مدعوم فقط ل `gpt-3.5-turbo-instruct`.	لا	‏‫لا شيء‬
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو `top_p` ليس كلاهما.	لا	1
top_p	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا

إنشاءCompletionResponse

يمثل استجابة إكمال من واجهة برمجة التطبيقات (API). ملاحظة: كل من كائنات الاستجابة المتدفقة وغير المبثة تشتركان في نفس الشكل (على عكس نقطة نهاية الدردشة).

Name	النوع	الوصف	مطلوبة
معرف	string	معرف فريد للإكمال.	‏‏نعم‬
الخيارات	مصفوفة	قائمة خيارات الإكمال التي يولدها النموذج لطلب الإدخال.	‏‏نعم‬
تم إنشاؤه	integer	الطابع الزمني ليونكس (بالثواني) لوقت إنشاء الاكتمال.	‏‏نعم‬
النموذج	string	النموذج المستخدم للإكمال.	‏‏نعم‬
prompt_filter_results	promptFilterResults	نتائج تصفية المحتوى لصفر أو أكثر من الطلبات في الطلب. في طلب البث، قد تصل نتائج طلبات مختلفة في أوقات مختلفة أو بترتيبات مختلفة.	لا
system_fingerprint	string	تمثل هذه البصمة تكوين الخلفية الذي يعمل به النموذج. يمكن استخدامه مع `seed` معامل الطلب لفهم متى تم إجراء تغييرات في الخلفية قد تؤثر على الحتمية.	لا
الهدف	enum	نوع الكائن، الذي يكون دائما "text_completion" القيم الممكنة: text_completion	‏‏نعم‬
الاستخدام	إكمال الاستخدام	إحصائيات الاستخدام لطلب الإكمال.	لا

createChatCompletionRequest

Name	النوع	الوصف	مطلوبة	افتراضي
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو `top_p` ليس كلاهما.	لا	1
top_p	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
تدفق	boolean	إذا تم تعيينها، سيتم إرسال دلتا جزئية للرسائل، كما في ChatGPT. سيتم إرسال الرموز كأحداث مرسلة من الخادم فقط عبر البيانات بمجرد توفرها، مع إنهاء التدفق برسالة `data: [DONE]` .	لا	خطأ
توقف	السلسلة أو المصفوفة	حتى أربع تسلسلات تتوقف فيها واجهة برمجة التطبيقات عن توليد المزيد من الرموز.	لا
max_tokens	integer	الحد الأقصى لعدد الرموز التي يمكن إنشاؤها في إكمال الدردشة. الطول الكلي لرموز الإدخال والرموز المولدة محدود بطول سياق النموذج.	لا
max_completion_tokens	integer	حد أعلى لعدد الرموز التي يمكن توليدها لإكمال، بما في ذلك رموز الإخراج المرئية ورموز الاستدلال.	لا
presence_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة.	لا	1
frequency_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا.	لا	1
logit_bias	الهدف	قم بتعديل احتمالية ظهور رموز محددة في الإكمال. يقبل كائن JSON يربط الرموز (المحددة بمعرف الرمز الخاص بها في الرمز) إلى قيمة تحيز مرتبطة من -100 إلى 100. رياضيا، يضاف التحيز إلى اللوجيتس التي يولدها النموذج قبل أخذ العينة. التأثير الدقيق يختلف حسب النموذج، لكن القيم بين -1 و1 يجب أن تقلل أو تزيد من احتمال الاختيار؛ قيم مثل -100 أو 100 يجب أن تؤدي إلى حظر أو اختيار حصري للرمز المعني.	لا	‏‫لا شيء‬
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا
الرسائل	مصفوفة	قائمة بالرسائل التي شكلت المحادثة حتى الآن.	‏‏نعم‬
data_sources	مصفوفة	إدخالات التكوين لإضافات الدردشة Azure OpenAI التي تستخدمها. هذه المواصفة الإضافية متوافقة فقط مع Azure OpenAI.	لا
logprobs	boolean	هل يجب إعادة احتمالات السجل لرموز الإخراج أم لا. إذا كان صحيحا، يعيد احتمالات لوغاريتيم كل رمز مخرج تم إرجاعه في `content` .`message`	لا	خطأ
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز الأكثر احتمالا للعودة في كل موقع رمز، لكل منها احتمال لوغاريتمية مرتبط. `logprobs` يجب أن يتم ضبطه إلى `true` إذا تم استخدام هذا المعامل.	لا
n	integer	كم عدد خيارات إكمال المحادثة التي يجب إنشاؤها لكل رسالة إدخال. لاحظ أنه سيتم تحصيل الرسوم بناء على عدد الرموز المولدة عبر جميع الخيارات. حافظ `n` على ذلك `1` لتقليل التكاليف.	لا	1
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تفعيل استدعاء الدوال المتوازية أثناء استخدام الأداة.	لا	صحيح
response_format	ResponseFormatText أو ResponseFormatJsonObject أو ResponseFormatJsonSchema	كائن يحدد الصيغة التي يجب أن ينتجها النموذج. متوافق مع GPT-4o وGPT-4o mini وGPT-4 Turbo وجميع طرازات GPT-3.5 Turbo الأحدث من `gpt-3.5-turbo-1106`. إعداد تفعيل `{ "type": "json_schema", "json_schema": {...} }` Structured Outputs مما يضمن أن النموذج سيتطابق مخطط JSON المرفق لديك. إعداد تفعيل `{ "type": "json_object" }` وضع JSON، الذي يضمن أن الرسالة التي يولدها النموذج هي JSON صالحة. مهم: عند استخدام وضع JSON، يجب عليك أيضا توجيه النموذج لإنتاج JSON بنفسه عبر رسالة نظام أو مستخدم. بدون ذلك، قد يولد النموذج تدفقا لا ينتهي من المساحات البيضاء حتى يصل التوليد إلى حد الرموز، مما يؤدي إلى طلب طويل الأمد ويبدو "عالق". لاحظ أيضا أن محتوى الرسالة قد يقطع جزئيا إذا `finish_reason="length"`، مما يشير إلى أن `max_tokens` التوليد تجاوز أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
البذور	integer	هذه الميزة موجودة في مرحلة البيتا. إذا تم تحديده، سيبذل نظامنا أقصى جهد لأخذ عينات حتمية، بحيث يجب أن تعطي الطلبات المتكررة بنفس `seed` المعلمات نفس النتيجة. الحتمية ليست مضمونة، ويجب عليك الرجوع إلى `system_fingerprint` معامل الاستجابة لمراقبة التغيرات في الخلفية.	لا
الأدوات	مصفوفة	قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالدوال التي قد يولد النموذج مدخلات JSON لها. يتم دعم حد أقصى 128 وظيفة.	لا
tool_choice	chatCompletionToolChoiceOption	يتحكم في أي أداة (إن وجدت) يتم استدعاؤها بواسطة النموذج. `none` يعني أن النموذج لن يستدعي أي أداة بل يولد رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة أو أكثر. تحديد أداة معينة عبر `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة. `none` هو الوضع الافتراضي عندما لا تتوفر أدوات. `auto` هي الافتراضية إذا كانت الأدوات موجودة.	لا
function_call	string أو chatCompletionFunctionCallOption	تم استبعاده لصالح `tool_choice`. يتحكم في أي وظيفة (إن وجدت) يتم استدعاؤها بواسطة النموذج. `none` يعني أن النموذج لن يستدعي دالة بل يولد رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء دالة. تحديد دالة معينة عبر `{"name": "my_function"}` يجبر النموذج على استدعاء تلك الدالة. `none` هي الوضع الافتراضي عندما لا توجد دوال. `auto` هي الافتراضية إذا كانت الدوال موجودة.	لا
الوظائف	مصفوفة	تم استبعاده لصالح `tools`. قائمة بالدوال التي قد يولد النموذج مدخلات JSON لها.	لا

وظائف إكمال الدردشة

Name	النوع	الوصف	مطلوبة
الوصف	string	وصف لما تفعله الدالة، يستخدمه النموذج لاختيار متى وكيفية استدعاء الدالة.	لا
الاسم	string	اسم الدالة التي سيتم استدعاؤها. يجب أن تكون من الف إلى الياء، من ال إلى الي، من 0 إلى 9، أو تحتوي على خطوط تحت وشرطات، بطول أقصى يبلغ 64.	‏‏نعم‬
المعلمات	معلمات الدالة	المعلمات التي تقبلها الدوال، وصفت ككائن مخطط JSON. راجع الدليل للحصول على أمثلة، ومرجع JSON Schema للتوثيق حول التنسيق. حذف `parameters` الدالة يعرف دالة ذات قائمة معلمات فارغة.	لا

chatCompletionFunctionCallOption

تحديد دالة معينة عبر {"name": "my_function"} يجبر النموذج على استدعاء تلك الدالة.

Name	النوع	الوصف	مطلوبة	افتراضي
الاسم	string	اسم الدالة التي يجب استدعاؤها.	‏‏نعم‬

chatCompletionRequestMessage

يمكن أن يكون هذا المكون واحدا من التالي:

chatCompletionRequestSystemMessage

Name	النوع	الوصف	مطلوبة
محتوى	السلسلة أو المصفوفة	محتوى رسالة النظام.	‏‏نعم‬
الدور	enum	دور مؤلف الرسائل، في هذه الحالة `system`. القيم الممكنة: النظام	‏‏نعم‬
الاسم	string	اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور.	لا

chatCompletionRequestUserMessage

Name	النوع	الوصف	مطلوبة
محتوى	السلسلة أو المصفوفة	محتوى رسالة المستخدم.	‏‏نعم‬
الدور	enum	دور مؤلف الرسائل، في هذه الحالة `user`. القيم المحتملة: المستخدم	‏‏نعم‬
الاسم	string	اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور.	لا

chatCompletionRequestAssistantMessage

Name	النوع	الوصف	مطلوبة
محتوى	السلسلة أو المصفوفة	محتوى رسالة المساعد. مطلوب ما لم `tool_calls` يتم تحديده أو `function_call` تم تحديده.	لا
الرفض	string	رسالة الرفض من المساعد.	لا
الدور	enum	دور مؤلف الرسائل، في هذه الحالة `assistant`. القيم الممكنة: مساعد	‏‏نعم‬
الاسم	string	اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور.	لا
tool_calls	chatCompletionMessageToolCalls	استدعاءات الأدوات التي يولدها النموذج، مثل استدعاءات الدوال.	لا
function_call	الهدف	تم إهمال واستبداله ب `tool_calls`. اسم ووسائط دالة يجب استدعاؤها، كما يولدها النموذج.	لا

خصائص function_call

الحجج

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

الاسم

Name	النوع	الوصف	افتراضي
الاسم	string	اسم الدالة التي يجب استدعاؤها.

chatCompletionRequestToolMessage

Name	النوع	الوصف	مطلوبة
الدور	enum	دور مؤلف الرسائل، في هذه الحالة `tool`. القيم المحتملة: أداة	‏‏نعم‬
محتوى	السلسلة أو المصفوفة	محتوى رسالة الأداة.	‏‏نعم‬
tool_call_id	string	نداء أداة تستجيب لها هذه الرسالة.	‏‏نعم‬

chatCompletionRequestFunctionMessage

Name	النوع	الوصف	مطلوبة
الدور	enum	دور مؤلف الرسائل، في هذه الحالة `function`. القيم الممكنة: دالة	‏‏نعم‬
محتوى	string	محتوى رسالة الدالة.	‏‏نعم‬
الاسم	string	اسم الدالة التي يجب استدعاؤها.	‏‏نعم‬

chatCompletionRequestSystemMessageContentPart

يمكن أن يكون هذا المكون واحدا من التالي:

chatCompletionRequestUserMessageContentPart

يمكن أن يكون هذا المكون واحدا من التالي:

chatCompletionRequestAssistantMessageContentPart

يمكن أن يكون هذا المكون واحدا من التالي:

chatCompletionRequestToolMessageContentPart

يمكن أن يكون هذا المكون واحدا من التالي:

chatCompletionRequestMessageContentPartText

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع المحتوى الجزئي. القيم الممكنة: نص	‏‏نعم‬
النص	string	محتوى النص.	‏‏نعم‬

chatCompletionRequestMessageContentPartImage

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع المحتوى الجزئي. القيم المحتملة: image_url	‏‏نعم‬
image_url	الهدف		‏‏نعم‬

خصائص image_url

عنوان URL

Name	النوع	الوصف	افتراضي
عنوان URL	string	إما رابط URL للصورة أو بيانات الصورة المشفرة في base64.

التفاصيل

Name	النوع	الوصف	افتراضي
التفاصيل	string	يحدد مستوى التفاصيل في الصورة. تعرف على المزيد في دليل الرؤية.	أوتو

chatCompletionRequestMessageContentPartRefusal

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع المحتوى الجزئي. القيم المحتملة: الرفض	‏‏نعم‬
الرفض	string	رسالة الرفض التي يولدها النموذج.	‏‏نعم‬

تكوين azureChatExtension

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

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

نوع azureChatExtension

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

النوع: السلسلة

الافتراضي:

اسم التعداد: AzureChatExtensionType

قيم التعداد:

قيمة	الوصف
azure_search	يمثل استخدام Azure Search كإضافة دردشة Azure OpenAI.
azure_cosmos_db	يمثل استخدام Azure Cosmos DB كإضافة دردشة Azure OpenAI.

تكوين azureSearchChatExtensionConfiguration

تمثيل محدد للخيارات القابلة للتكوين في Azure Search عند استخدامه كإضافة دردشة Azure OpenAI.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	نوع azureChatExtension	تمثيل لبيانات التكوين لإضافة دردشة واحدة ل Azure OpenAI. سيتم استخدام هذا في الدردشة تطلب الإكمال استخدام إضافات الدردشة Azure OpenAI لتعزيز سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	‏‏نعم‬
المعلمات	azureSearchChatExtensionParameters	Parameters for Azure Search عند استخدامه كإضافة دردشة Azure OpenAI.	لا

azureSearchChatExtensionParameters

Parameters for Azure Search عند استخدامه كإضافة دردشة Azure OpenAI.

Name	النوع	الوصف	مطلوبة
authentication	OnYourDataApiKeyAuthenticationOptions أو OnYourDataSystemAssignedManagedIdentityAuthenticationOptions أو OnYourDataUserAssignedManagedIdentityAuthenticationOptions		‏‏نعم‬
top_n_documents	integer	العدد الأعلى المكون من المستندات التي يجب عرضها في الاستعلام المكون.	لا
in_scope	boolean	ما إذا كان يجب تقييد الاستعلامات على استخدام البيانات المفهرسة فقط.	لا
التشدد	integer	التكوين الصارم لتصفية ملاءمة البحث. كلما زادت الدقة، زادت الدقة ولكن تقليل التذكر للإجابة.	لا
role_information	string	أعط النموذج تعليمات حول كيفية تصرفه وأي سياق يجب أن يشير إليه عند توليد الاستجابة. يمكنك وصف شخصية المساعد وإخباره كيف يشكل الردود. هناك حد 100 رمز لها، وتحتسب ضمن الحد الإجمالي للرمز.	لا
نقطه النهايه	string	المسار النهائي المطلق لاستخدام مورد Azure Search.	‏‏نعم‬
index_name	string	اسم الفهرس المستخدم كما هو متوفر في مورد Azure Search المشار إليه.	‏‏نعم‬
fields_mapping	azureSearchIndexFieldMappingOptions	إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Search المكون.	لا
query_type	نوع azureSearchQuery	نوع استعلام استرجاع Azure Search الذي يجب تنفيذه عند استخدامه كإضافة دردشة ل Azure OpenAI.	لا
semantic_configuration	string	التكوين الدلالي الإضافي للاستعلام.	لا
الفلتر	string	عامل تصفية البحث.	لا
embedding_dependency	onYourDataEndpointVectorizationSource أو onYourDataDeploymentNameVectorizationSource		لا

azureSearchIndexFieldMappingOptions

إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Search المكون.

Name	النوع	الوصف	مطلوبة
title_field	string	اسم حقل الفهرس الذي يمكن استخدامه كعنوان.	لا
url_field	string	اسم حقل الفهرس الذي يمكن استخدامه كعنوان URL.	لا
filepath_field	string	اسم حقل الفهرس الذي تستخدمه كمسار ملف.	لا
content_fields	مصفوفة	أسماء حقول الفهرس التي يجب التعامل معها كمحتوى.	لا
content_fields_separator	string	نمط الفصل الذي يجب أن تستخدمه حقول المحتوى.	لا
vector_fields	مصفوفة	أسماء الحقول التي تمثل بيانات المتجهات.	لا

نوع azureSearchQuery

نوع استعلام استرجاع Azure Search الذي يجب تنفيذه عند استخدامه كإضافة دردشة ل Azure OpenAI.

Description: نوع استعلام استرجاع البحث Azure الذي يجب تنفيذه عند استخدامه كإضافة دردشة Azure OpenAI.

النوع: السلسلة

الافتراضي:

اسم Enum: AzureSearchQueryType

قيم التعداد:

قيمة	الوصف
بسيطه	يمثل محلل الاستعلام الافتراضي البسيط.
الدلالي	يمثل محلل الاستعلام الدلالي للنمذجة الدلالية المتقدمة.
المتجه	يمثل البحث المتجه فوق البيانات المحوسبة.
vector_simple_hybrid	يمثل مزيجا من استراتيجية الاستعلام البسيطة مع بيانات المتجه.
vector_semantic_hybrid	يمثل مزيجا من البحث الدلالي والاستعلام عن البيانات المتجهية.

تكوين azureCosmosDBChatExtensionConfiguration

تمثيل محدد للخيارات القابلة للتكوين ل Azure Cosmos DB عند استخدامه كإضافة دردشة Azure OpenAI.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	نوع azureChatExtension	تمثيل لبيانات التكوين لإضافة دردشة واحدة ل Azure OpenAI. سيتم استخدام هذا في الدردشة تطلب الإكمال استخدام إضافات الدردشة Azure OpenAI لتعزيز سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	‏‏نعم‬
المعلمات	azureCosmosDBChatExtensionParameters	Parameters to Use عند تكوين Azure OpenAI On Your Data chat extensions عند استخدام Azure Cosmos DB ل MongoDB vCore.	لا

azureCosmosDBChatExtensionParameters

Parameters to Use عند تكوين Azure OpenAI On Your Data chat extensions عند استخدام Azure Cosmos DB for MongoDB vCore.

Name	النوع	الوصف	مطلوبة
authentication	onYourDataConnectionStringAuthenticationOptions	خيارات المصادقة ل Azure OpenAI On Your Data عند استخدام سلسلة الاتصال.	‏‏نعم‬
top_n_documents	integer	العدد الأعلى المكون من المستندات التي يجب عرضها في الاستعلام المكون.	لا
in_scope	boolean	ما إذا كان يجب تقييد الاستعلامات على استخدام البيانات المفهرسة فقط.	لا
التشدد	integer	التكوين الصارم لتصفية ملاءمة البحث. كلما زادت الدقة، زادت الدقة ولكن تقليل التذكر للإجابة.	لا
role_information	string	أعط النموذج تعليمات حول كيفية تصرفه وأي سياق يجب أن يشير إليه عند توليد الاستجابة. يمكنك وصف شخصية المساعد وإخباره كيف يشكل الردود. هناك حد 100 رمز لها، وتحتسب ضمن الحد الإجمالي للرمز.	لا
database_name	string	MongoDB vCore قاعدة البيانات التي يجب استخدامها مع Azure Cosmos DB.	‏‏نعم‬
container_name	string	اسم حاوية الموارد Azure Cosmos DB.	‏‏نعم‬
index_name	string	الاسم MongoDB vCore index المستخدم مع Azure Cosmos DB.	‏‏نعم‬
fields_mapping	azureCosmosDBFieldMappingOptions	إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Cosmos DB المكون.	‏‏نعم‬
embedding_dependency	onYourDataEndpointVectorizationSource أو onYourDataDeploymentNameVectorizationSource		‏‏نعم‬

azureCosmosDBFieldMappingOptions

إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Cosmos DB المكون.

Name	النوع	الوصف	مطلوبة
title_field	string	اسم حقل الفهرس الذي يمكن استخدامه كعنوان.	لا
url_field	string	اسم حقل الفهرس الذي يمكن استخدامه كعنوان URL.	لا
filepath_field	string	اسم حقل الفهرس الذي تستخدمه كمسار ملف.	لا
content_fields	مصفوفة	أسماء حقول الفهرس التي يجب التعامل معها كمحتوى.	‏‏نعم‬
content_fields_separator	string	نمط الفصل الذي يجب أن تستخدمه حقول المحتوى.	لا
vector_fields	مصفوفة	أسماء الحقول التي تمثل بيانات المتجهات.	‏‏نعم‬

onYourDataAuthenticationOptions

خيارات المصادقة ل Azure OpenAI على بياناتك.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	‏‏نعم‬

onYourDataAuthenticationType

أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.

Description: أنواع المصادقة المدعومة Azure OpenAI On Your Data.

النوع: السلسلة

الافتراضي:

اسم Enum: OnYourDataAuthenticationType

قيم التعداد:

قيمة	الوصف
api_key	المصادقة عبر مفتاح واجهة برمجة التطبيقات (API).
connection_string	المصادقة عبر سلسلة الاتصال.
system_assigned_managed_identity	المصادقة عبر هوية مدارة معينة من النظام.
user_assigned_managed_identity	المصادقة عبر الهوية المدارة المعينة من قبل المستخدم.

onYourDataApiKeyAuthenticationOptions

خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام مفتاح API.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	‏‏نعم‬
المفتاح	string	مفتاح API المستخدم للمصادقة.	لا

onYourDataConnectionStringAuthenticationOptions

خيارات المصادقة ل Azure OpenAI On Your Data عند استخدام سلسلة الاتصال.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	‏‏نعم‬
connection_string	string	سلسلة سلسلة الاتصال المستخدمة للمصادقة.	لا

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

خيارات المصادقة ل Azure OpenAI On Your Data عند استخدام هوية مدارة معينة من النظام.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	‏‏نعم‬

onYourDataUserAssignedManagedIdentityAuthenticationOptions

خيارات المصادقة ل Azure OpenAI On Your Data عند استخدام هوية مدارة معينة من المستخدم.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	‏‏نعم‬
managed_identity_resource_id	string	معرف الموارد للهوية المدارة المعينة من قبل المستخدم لاستخدامها في المصادقة.	لا

onYourDataVectorizationSource

تمثيل مجرد لمصدر التوجيه للعبة Azure OpenAI On Your Data باستخدام البحث المتجه.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	onYourDataVectorizationSourceType	يمثل المصادر المتاحة التي يمكن ل Azure OpenAI On Your Data استخدامها لتكوين التوجيه الاتجاهي للبيانات لاستخدامها مع البحث عن المتجهات.	‏‏نعم‬

onYourDataVectorizationSourceType

يمثل المصادر المتاحة التي يمكن ل Azure OpenAI On Your Data استخدامها لتكوين التوجيه المتجه للبيانات لاستخدامها في البحث المتجه.

Description: يمثل المصادر المتاحة Azure OpenAI On Your Data لتكوين التوجيه المخصص للبيانات لاستخدامها مع
البحث عن المتجهات.

النوع: السلسلة

الافتراضي:

اسم Enum: OnYourDataVectorizationSourceType

قيم التعداد:

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

onYourDataDeploymentNameVectorizationSource

تفاصيل مصدر التوجيه، المستخدم من قبل Azure OpenAI On Your Data عند تطبيق البحث المتجه، والذي يعتمد على اسم نشر نموذج التضمين الداخلي في نفس مورد Azure OpenAI.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	onYourDataVectorizationSourceType	يمثل المصادر المتاحة التي يمكن ل Azure OpenAI On Your Data استخدامها لتكوين التوجيه الاتجاهي للبيانات لاستخدامها مع البحث عن المتجهات.	‏‏نعم‬
deployment_name	string	يحدد اسم نشر النموذج لاستخدامه في التوجيه. يجب أن يكون نشر هذا النموذج في نفس مورد Azure OpenAI، لكن On Your Data سيستخدم هذا النموذج عبر مكالمة داخلية بدلا من عام النشر، مما يتيح البحث المتجه حتى في الشبكات الخاصة.	لا

onYourDataEndpointVectorizationSource

تفاصيل مصدر التوجيه، المستخدم في Azure OpenAI On Your Data عند تطبيق البحث المتجه، والذي يعتمد على استدعاء عام لنقطة نهاية Azure OpenAI للتضمينات.

Name	النوع	الوصف	مطلوبة
النوع	onYourDataVectorizationSourceType	يمثل المصادر المتاحة التي يمكن ل Azure OpenAI On Your Data استخدامها لتكوين التوجيه الاتجاهي للبيانات لاستخدامها مع البحث عن المتجهات.	‏‏نعم‬
authentication	onYourDataApiKeyAuthenticationOptions	خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام مفتاح API.	لا
نقطه النهايه	string	يحدد نقطة النهاية المستخدمة في التوجيه. يجب أن تكون هذه النقطة النهائية في نفس مورد Azure OpenAI، لكن On Your Data ستستخدم هذه النقطة عبر مكالمة داخلية بدلا من استدعاء عام، مما يتيح البحث المتجه حتى في الشبكات الخاصة.	لا

azureChatExtensionsMessageContext

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

Name	النوع	الوصف	مطلوبة	افتراضي
الاستشهادات	مصفوفة	نتيجة استرجاع مصدر البيانات، تستخدم لتوليد رسالة المساعد في الرد.	لا
عمد	string	النية التي تم اكتشافها من سجل الدردشة، تستخدم للانتقال إلى الدور التالي لنقل السياق.	لا

الاقتباس

معلومات الاستشهاد لرسالة استجابة لإكمال الدردشة.

Name	النوع	الوصف	مطلوبة
محتوى	string	محتوى الاقتباس.	‏‏نعم‬
العنوان	string	عنوان الاقتباس.	لا
عنوان URL	string	رابط الاستشهاد.	لا
مسار الملف	string	مسار ملف الاستشهاد.	لا
chunk_id	string	معرف جزء من المخالفة.	لا

chatCompletionMessageToolCall

Name	النوع	الوصف	مطلوبة
معرف	string	معرف نداء الأداة.	‏‏نعم‬
النوع	toolCallType	نوع استدعاء الأداة، في هذه الحالة `function`.	‏‏نعم‬
دالة	الهدف	الدالة التي استدعى النموذج.	‏‏نعم‬

خصائص الدالة

الاسم

Name	النوع	الوصف	افتراضي
الاسم	string	اسم الدالة التي يجب استدعاؤها.

الحجج

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

toolCallType

نوع استدعاء الأداة، في هذه الحالة function.

الوصف: نوع استدعاء الأداة، في هذه الحالة function.

النوع: السلسلة

الافتراضي:

اسم Enum: ToolCallType

قيم التعداد:

قيمة	الوصف
دالة	نوع استدعاء الأداة هو الدالة.

chatCompletionRequestMessageTool

Name	النوع	الوصف	مطلوبة	افتراضي
tool_call_id	string	نداء أداة تستجيب لها هذه الرسالة.	لا
محتوى	string	محتوى الرسالة.	لا

chatCompletionRequestMessageFunction

Name	النوع	الوصف	مطلوبة
الدور	enum	دور مؤلف الرسائل، في هذه الحالة `function`. القيم الممكنة: دالة	لا
الاسم	string	محتوى الرسالة.	لا
محتوى	string	محتوى الرسالة.	لا

إنشاءChatCompletionResponse

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

Name	النوع	الوصف	مطلوبة
معرف	string	معرف فريد لإكمال الدردشة.	‏‏نعم‬
prompt_filter_results	promptFilterResults	نتائج تصفية المحتوى لصفر أو أكثر من الطلبات في الطلب. في طلب البث، قد تصل نتائج طلبات مختلفة في أوقات مختلفة أو بترتيبات مختلفة.	لا
الخيارات	مصفوفة	قائمة بخيارات إكمال المحادثة. يمكن أن يكون أكثر من واحد إذا `n` كان أكبر من 1.	‏‏نعم‬
تم إنشاؤه	integer	الطابع الزمني ليونكس (بالثواني) لوقت إنشاء الدردشة.	‏‏نعم‬
النموذج	string	النموذج المستخدم لإكمال الدردشة.	‏‏نعم‬
system_fingerprint	string	تمثل هذه البصمة تكوين الخلفية الذي يعمل به النموذج. يمكن استخدامه مع `seed` معامل الطلب لفهم متى تم إجراء تغييرات في الخلفية قد تؤثر على الحتمية.	لا
الهدف	enum	نوع الكائن، والذي يكون دائما `chat.completion`. القيم الممكنة: chat.completion	‏‏نعم‬
الاستخدام	إكمال الاستخدام	إحصائيات الاستخدام لطلب الإكمال.	لا

إنشاءChatCompletionStreamResponse

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

Name	النوع	الوصف	مطلوبة
معرف	string	معرف فريد لإكمال الدردشة. كل جزء له نفس معرف.	‏‏نعم‬
الخيارات	مصفوفة	قائمة بخيارات إكمال المحادثة. يمكن أن يحتوي على أكثر من عنصر واحد إذا `n` كان أكبر من 1.	‏‏نعم‬
تم إنشاؤه	integer	الطابع الزمني ليونكس (بالثواني) لوقت إنشاء الدردشة. كل جزء له نفس الطابع الزمني.	‏‏نعم‬
النموذج	string	النموذج لتوليد الإكمال.	‏‏نعم‬
system_fingerprint	string	تمثل هذه البصمة تكوين الخلفية الذي يعمل به النموذج. يمكن استخدامه مع `seed` معامل الطلب لفهم متى تم إجراء تغييرات في الخلفية قد تؤثر على الحتمية.	لا
الهدف	enum	نوع الكائن، والذي يكون دائما `chat.completion.chunk`. القيم المحتملة: chat.completion.chunk	‏‏نعم‬

chatCompletionStreamResponseDelta

دلتا إكمال المحادثة يتم توليدها بواسطة ردود النماذج المتدفقة.

Name	النوع	الوصف	مطلوبة
محتوى	string	محتوى رسالة القطعة.	لا
function_call	الهدف	تم إهمال واستبداله ب `tool_calls`. اسم ووسائط دالة يجب استدعاؤها، كما يولدها النموذج.	لا
tool_calls	مصفوفة		لا
الدور	enum	دور كاتب هذه الرسالة. القيم المحتملة: النظام، المستخدم، المساعد، الأداة.	لا
الرفض	string	رسالة الرفض التي يولدها النموذج.	لا

خصائص function_call

الحجج

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

الاسم

Name	النوع	الوصف	افتراضي
الاسم	string	اسم الدالة التي يجب استدعاؤها.

chatCompletionMessageToolCallChunk

Name	النوع	الوصف	مطلوبة
فهرس	integer		‏‏نعم‬
معرف	string	معرف نداء الأداة.	لا
النوع	enum	نوع الأداة. حاليا، فقط `function` مدعوم. القيم الممكنة: دالة	لا
دالة	الهدف		لا

خصائص الدالة

الاسم

Name	النوع	الوصف	افتراضي
الاسم	string	اسم الدالة التي يجب استدعاؤها.

الحجج

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

chatCompletionStreamOptions

خيارات للاستجابة عبر البث. قم بتعيين هذا فقط عندما تضبط stream: true.

Name	النوع	الوصف	مطلوبة	افتراضي
include_usage	boolean	إذا تم تعيينها، سيتم بث جزء إضافي قبل الرسالة `data: [DONE]` . `usage` الحقل في هذا الجزء يعرض إحصائيات استخدام الرموز للطلب بأكمله، وسيظل الحقل `choices` دائما مصفوفة فارغة. جميع القطع الأخرى ستتضمن `usage` أيضا حقلا، لكن بقيمة صفرية.	لا

chatCompletionChoiceLogProbs

سجل معلومات الاحتمالات للاختيار.

Name	النوع	الوصف	مطلوبة	افتراضي
محتوى	مصفوفة	قائمة برموز محتوى الرسائل مع معلومات احتمالية السجل.	‏‏نعم‬
الرفض	مصفوفة	قائمة برموز رفض الرسائل مع معلومات السجل الاحتمالي.	لا

chatCompletionTokenLogprob

Name	النوع	الوصف	مطلوبة
الرمز	string	الرمز.	‏‏نعم‬
logprob	number	احتمال اللوغاريتيوم لهذا الرمز.	‏‏نعم‬
بايتات	مصفوفة	قائمة بالأعداد الصحيحة التي تمثل تمثيل UTF-8 بايت للرمز. مفيد في الحالات التي يتم فيها تمثيل الأحرف بواسطة عدة رموز ويجب دمج تمثيلات بايتها لتوليد التمثيل النصي الصحيح. قد يكون ذلك `null` إذا لم يكن هناك تمثيل للبايتات للرمز.	‏‏نعم‬
top_logprobs	مصفوفة	قائمة بالرموز الأكثر احتمالا واحتمالية السجل الخاصة بها، في هذا الموقع الرمزي. في حالات نادرة، قد يكون هناك عدد أقل من عدد الطلبات `top_logprobs` المعادة.	‏‏نعم‬

chatCompletionResponseMessage

رسالة إكمال المحادثة تولدها النموذج.

Name	النوع	الوصف	مطلوبة
الدور	chatCompletionResponseMessageRole	دور كاتب رسالة الرد.	‏‏نعم‬
الرفض	string	رسالة الرفض التي يولدها النموذج.	‏‏نعم‬
محتوى	string	محتوى الرسالة.	‏‏نعم‬
tool_calls	مصفوفة	استدعاءات الأدوات التي يولدها النموذج، مثل استدعاءات الدوال.	لا
function_call	chatCompletionFunctionCall	تم إهمال واستبداله ب `tool_calls`. اسم ووسائط دالة يجب استدعاؤها، كما يولدها النموذج.	لا
context	azureChatExtensionsMessageContext	تمثيل لمعلومات السياق الإضافية المتاحة عند استخدام إضافات دردشة Azure OpenAI في توليد استجابة مطابقة لإكمال الدردشة. يتم ملء هذه المعلومات السياقية فقط عندما باستخدام طلب Azure OpenAI مهيأ لاستخدام إضافة مطابقة.	لا

chatCompletionResponseMessageRole

دور كاتب رسالة الرد.

الوصف: دور كاتب رسالة الرد.

النوع: السلسلة

الافتراضي:

قيم التعداد:

مساعد

chatCompletionToolChoiceOption

يتحكم في أي أداة (إن وجدت) يتم استدعاؤها بواسطة النموذج. none يعني أن النموذج لن يستدعي أي أداة بل يولد رسالة. auto يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. required يعني أن النموذج يجب أن يستدعي أداة أو أكثر. تحديد أداة معينة عبر {"type": "function", "function": {"name": "my_function"}} يجبر النموذج على استدعاء تلك الأداة. none هو الوضع الافتراضي عندما لا تتوفر أدوات. auto هي الافتراضية إذا كانت الأدوات موجودة.

يمكن أن يكون هذا المكون واحدا من التالي:

chatCompletionNamedToolChoice

يحدد الأداة التي يجب أن يستخدمها النموذج. يستخدم لإجبار النموذج على استدعاء دالة معينة.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع الأداة. حاليا، فقط `function` مدعوم. القيم الممكنة: دالة	‏‏نعم‬
دالة	الهدف		‏‏نعم‬

خصائص الدالة

الاسم

Name	النوع	الوصف	افتراضي
الاسم	string	اسم الدالة التي يجب استدعاؤها.

ParallelToolCalls

ما إذا كان يجب تفعيل استدعاء الدوال المتوازية أثناء استخدام الأداة.

لا توجد خصائص محددة لهذا المكون.

chatCompletionMessageToolCalls

استدعاءات الأدوات التي يولدها النموذج، مثل استدعاءات الدوال.

لا توجد خصائص محددة لهذا المكون.

chatCompletionFunctionCall

تم إهمال واستبداله ب tool_calls. اسم ووسائط دالة يجب استدعاؤها، كما يولدها النموذج.

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

إكمال الاستخدام

إحصائيات الاستخدام لطلب الإكمال.

Name	النوع	الوصف	مطلوبة
prompt_tokens	integer	عدد الرموز في الطلب.	‏‏نعم‬
completion_tokens	integer	عدد الرموز في الإكمال المولد.	‏‏نعم‬
total_tokens	integer	إجمالي عدد الرموز المستخدمة في الطلب (الطلب + الإكمال).	‏‏نعم‬
completion_tokens_details	الهدف	تفصيل الرموز المستخدمة في إكمال العملية.	لا

خصائص completion_tokens_details

reasoning_tokens

Name	النوع	الوصف	افتراضي
reasoning_tokens	integer	الرموز التي يولدها النموذج للتفكير.

chatCompletionTool

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع الأداة. حاليا، فقط `function` مدعوم. القيم الممكنة: دالة	‏‏نعم‬
دالة	FunctionObject		‏‏نعم‬

معلمات الدالة

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

حذف parameters الدالة يعرف دالة ذات قائمة معلمات فارغة.

لا توجد خصائص محددة لهذا المكون.

FunctionObject

Name	النوع	الوصف	مطلوبة	افتراضي
الوصف	string	وصف لما تفعله الدالة، يستخدمه النموذج لاختيار متى وكيفية استدعاء الدالة.	لا
الاسم	string	اسم الدالة التي سيتم استدعاؤها. يجب أن تكون من الف إلى الياء، من ال إلى الي، من 0 إلى 9، أو تحتوي على خطوط تحت وشرطات، بطول أقصى يبلغ 64.	‏‏نعم‬
المعلمات	معلمات الدالة	المعلمات التي تقبلها الدوال، وصفت ككائن مخطط JSON. راجع الدليل للحصول على أمثلة، ومرجع JSON Schema للتوثيق حول التنسيق. حذف `parameters` الدالة يعرف دالة ذات قائمة معلمات فارغة.	لا
صارم	boolean	ما إذا كان يجب تمكين الالتزام الصارم بالمخطط عند توليد استدعاء الدالة. إذا تم تعيينه على true، سيتبع النموذج المخطط الدقيق المحدد `parameters` في الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما `strict` يكون .`true`	لا	خطأ

نص تنسيق الاستجابة

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع صيغة الاستجابة التي يتم تعريفها: `text` القيم الممكنة: نص	‏‏نعم‬

ResponseFormatJsonObject

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع صيغة الاستجابة التي يتم تعريفها: `json_object` القيم الممكنة: json_object	‏‏نعم‬

ResponseFormatJsonSchemaSchema

المخطط لصيغة الاستجابة، موصوف ككائن مخطط JSON.

لا توجد خصائص محددة لهذا المكون.

ResponseFormatJsonSchema

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع صيغة الاستجابة التي يتم تعريفها: `json_schema` القيم المحتملة: json_schema	‏‏نعم‬
json_schema	الهدف		‏‏نعم‬

خصائص json_schema

الوصف

Name	النوع	الوصف	افتراضي
الوصف	string	وصف لما هو صيغة الرد الغرضية، يستخدمه النموذج لتحديد كيفية الاستجابة في التنسيق.

الاسم

Name	النوع	الوصف	افتراضي
الاسم	string	اسم صيغة الرد. يجب أن تكون من الف إلى الياء، من ال إلى الي، من 0 إلى 9، أو تحتوي على خطوط تحت وشرطات، بطول أقصى يبلغ 64.

المخطط

Name	النوع	الوصف	افتراضي
المخطط	ResponseFormatJsonSchemaSchema	المخطط لصيغة الاستجابة، موصوف ككائن مخطط JSON.

صارم

Name	النوع	الوصف	افتراضي
صارم	boolean	ما إذا كان يجب تمكين الالتزام الصارم بالمخطط عند توليد المخرج. إذا تم ضبطه `schema` على true، سيتبع النموذج دائما المخطط الدقيق المحدد في الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما `strict` يكون .`true`	خطأ

chatCompletionChoiceCommon

Name	النوع	الوصف	مطلوبة	افتراضي
فهرس	integer		لا
finish_reason	string		لا

createTranslationRequest

طلب الترجمة.

Name	النوع	الوصف	مطلوبة	افتراضي
ملف	string	ملف الصوت للترجمة.	‏‏نعم‬
الموضوع	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار مقطع صوتي سابق. يجب أن يكون الموضوع باللغة الإنجليزية.	لا
response_format	تنسيق الاستجابة الصوتية	يحدد تنسيق المخرج.	لا
درجة الحرارة	number	درجة حرارة العينة، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. إذا تم ضبطه على 0، سيستخدم النموذج احتمال لوغاريتيم لزيادة درجة الحرارة تلقائيا حتى تصل عتبات معينة.	لا	1

الاستجابة الصوتية

استجابة الترجمة أو النسخ عندما response_format json

Name	النوع	الوصف	مطلوبة	افتراضي
النص	string	نص مترجم أو منقول.	‏‏نعم‬

audioVerboseResponse

استجابة الترجمة أو النسخ عندما response_format verbose_json

Name	النوع	الوصف	مطلوبة
النص	string	نص مترجم أو منقول.	‏‏نعم‬
المهمة	string	نوع من المهام الصوتية.	لا
اللغة	string	اللغه.	لا
المدة	number	مده.	لا
المقاطع	مصفوفة		لا

تنسيق الاستجابة الصوتية

يحدد تنسيق المخرج.

الوصف: يحدد تنسيق المخرج.

النوع: السلسلة

الافتراضي:

قيم التعداد:

json
النص
الصربيه
verbose_json
vtt

createTranscriptionRequest

طلب النسخ.

Name	النوع	الوصف	مطلوبة	افتراضي
ملف	string	ملف الصوت يجب نسخه.	‏‏نعم‬
الموضوع	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار مقطع صوتي سابق. يجب أن يتطابق الموضوع مع لغة الصوت.	لا
response_format	تنسيق الاستجابة الصوتية	يحدد تنسيق المخرج.	لا
درجة الحرارة	number	درجة حرارة العينة، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. إذا تم ضبطه على 0، سيستخدم النموذج احتمال لوغاريتيم لزيادة درجة الحرارة تلقائيا حتى تصل عتبات معينة.	لا	1
اللغة	string	لغة الصوت المدخل. توفير لغة الإدخال بصيغة ISO-639-1 سيحسن الدقة والتأخير.	لا

ملف صوتي

قسم النسخ أو الترجمة.

Name	النوع	الوصف	مطلوبة
معرف	integer	معرف المقطع.	لا
ابحث	number	إزاحة الجزء.	لا
ابدأ	number	بداية المقطع بإزاحة.	لا
النهاية	number	إزاحة نهاية المقطع.	لا
النص	string	تقسيم النص.	لا
الرموز	مصفوفة	رموز من النص.	لا
درجة الحرارة	number	درجه الحراره.	لا
avg_logprob	number	متوسط احتمال اللوغاريتم.	لا
compression_ratio	number	نسبة الضغط.	لا
no_speech_prob	number	احتمال .`no speech`	لا

imageQuality

جودة الصورة التي سيتم إنشاؤها.

الوصف: جودة الصورة التي سيتم إنشاؤها.

النوع: السلسلة

الافتراضي: قياسي

اسم Enum: الجودة

قيم التعداد:

قيمة	الوصف
قياسي	الجودة القياسية تخلق صورا بجودة قياسية.
هد	جودة HD تخلق صورا بتفاصيل أدق وأكثر اتساقا عبر الصورة.

imagesResponseFormat

الصيغة التي تعاد بها الصور المولدة.

الوصف: الصيغة التي تعاد بها الصور المولدة.

النوع: السلسلة

الافتراضي: url

اسم Enum: ImagesResponseFormat

قيم التعداد:

قيمة	الوصف
عنوان URL	الرابط الذي يوفر وصولا مؤقتا لتحميل الصور المولدة.
b64_json	يتم إرجاع الصور المولدة كسلسلة مشفرة base64.

حجم الصورة

حجم الصور المولدة.

الوصف: حجم الصور المولدة.

النوع: السلسلة

الافتراضي: 1024x1024

اسم إينوم: الحجم

قيم التعداد:

قيمة	الوصف
1792x1024	الحجم المطلوب للصورة المولدة هو 1792x1024 بكسل.
1024x1792	الحجم المطلوب للصورة المولدة هو 1024x1792 بكسل.
1024x1024	الحجم المطلوب للصورة المولدة هو 1024x1024 بكسل.

imageStyle

أسلوب الصور المولدة.

الوصف: أسلوب الصور التي تم إنشاؤها.

النوع: السلسلة

الافتراضي: حي

اسم إينوم: الأسلوب

قيم التعداد:

قيمة	الوصف
حيه	يخلق Vivid صورا واقعية للغاية ودرامية.
الطبيعيه	Natural يخلق صورا أكثر طبيعية وأقل واقعية مفرطة.

إنشاء الصوراستعلام

Name	النوع	الوصف	مطلوبة	افتراضي
الموضوع	string	وصف نصي للصورة أو الصور المطلوبة. الحد الأقصى للطول هو 4,000 حرف.	‏‏نعم‬
n	integer	عدد الصور التي يجب إنشاؤها.	لا	1
الحجم	حجم الصورة	حجم الصور المولدة.	لا	1024x1024
response_format	imagesResponseFormat	الصيغة التي تعاد بها الصور المولدة.	لا	عنوان URL
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا
الجودة	imageQuality	جودة الصورة التي سيتم إنشاؤها.	لا	قياسي
الأسلوب	imageStyle	أسلوب الصور المولدة.	لا	حيه

إنشاءImagesResponse

Name	النوع	الوصف	مطلوبة	افتراضي
تم إنشاؤه	integer	طابع يونكس الزمني عند إنشاء العملية.	‏‏نعم‬
البيانات	مصفوفة	بيانات نتيجة العملية، إذا نجحت	‏‏نعم‬

imageResult

إذا نجحت، يتم إرسال رابط الصورة أو الصورة المشفرة إلى URL أو الصورة المشفرة ويوجد خطأ آخر.

Name	النوع	الوصف	مطلوبة
عنوان URL	string	رابط الصورة.	لا
b64_json	string	الصورة المشفرة على base64	لا
content_filter_results	dalleContentFilterResults	معلومات حول نتائج تصفية المحتوى.	لا
revised_prompt	string	المحفز الذي استخدم لإنشاء الصورة، إذا كان هناك أي تعديل على الطلب.	لا
prompt_filter_results	dalleFilterResults	معلومات عن فئة تصفية المحتوى (الكراهية، الجنس، العنف، self_harm)، وإذا تم اكتشافها، بالإضافة إلى مستوى الشدة (very_low، منخفض، متوسط، عالي النطاق الذي يحدد شدة ومستوى خطر المحتوى الضار) وما إذا تم تصفيته أم لا. معلومات عن محتوى الجيلبريك والألفاظ النابية، وإذا تم اكتشافه، وإذا تم تصفيتها أم لا. ومعلومات عن قائمة حظر العملاء، إذا تم تصفيتها ومعرفها.	لا

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

امتدادات Completeions ليست جزءا من أحدث إصدار GA من مواصفات استنتاج مستوى البيانات Azure OpenAI.

رسالة الدردشة

كائن رسالة الدردشة ليس جزءا من أحدث إصدار GA من مواصفة استنتاج مستوى البيانات Azure OpenAI.

التحويل من النص إلى كلام (معاينة)

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

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

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

الملاحظات

هل كانت هذه الصفحة مفيدة؟

Last updated on 2026-05-20