إشعار
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تسجيل الدخول أو تغيير الدلائل.
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تغيير الدلائل.
المشاهدة الحالية:نسخة - التحويل إلى النسخة الخاصة ببوابة Foundry الجديدة
ملحوظة
بعض الروابط في هذا المقال قد تفتح محتوى في وثائق Microsoft Foundry الجديدة بدلا من وثائق Foundry (الكلاسيكية) التي تشاهدها الآن.
توفر هذه المقالة تفاصيل حول نقاط نهاية واجهة برمجة تطبيقات REST للاستدلال Azure OpenAI.
مواصفات واجهة برمجة التطبيقات
يتم تقسيم إدارة Azure والموارد الخاصة ب OpenAI والتفاعل معها عبر ثلاثة أسطح واجهة برمجة التطبيقات الأساسية:
- مستوى التحكم
- مستوى البيانات - التأليف
- مستوى البيانات - الاستدلال
يغلف كل سطح/مواصفات واجهة برمجة تطبيقات مجموعة مختلفة من قدرات OpenAI Azure. تحتوي كل واجهة برمجة تطبيقات على مجموعة فريدة خاصة بها من المعاينة وإصدارات واجهة برمجة التطبيقات (GA) الثابتة/المتوفرة بشكل عام. تميل إصدارات المعاينة حاليا إلى اتباع إيقاع شهري.
مهم
هناك الآن واجهة برمجة تطبيقات استدلال معاينة جديدة. تعرف على المزيد في دليل دورة حياة واجهة برمجة التطبيقات.
| API | أحدث إصدار معاينة | أحدث إصدار من GA | المواصفات | وصف |
|---|---|---|---|---|
| مستوى التحكم | 2025-07-01-preview |
2025-06-01 |
ملفات Spec | يتم استخدام واجهة برمجة تطبيقات مستوى التحكم لعمليات مثل إنشاء المواردونشر النموذج ومهام إدارة الموارد الأخرى ذات المستوى الأعلى. تحكم وحدة التحكم أيضا ما يمكن القيام به مع قدرات مثل Azure Resource Manager Bicep وTerraform Azure CLI. |
| مستوى البيانات | v1 preview |
v1 |
ملفات Spec | تتحكم واجهة برمجة تطبيقات مستوى البيانات في عمليات الاستدلال والتأليف. |
المصادقة
يوفر Azure OpenAI طريقتين للمصادقة. يمكنك استخدام مفاتيح واجهة برمجة التطبيقات أو Microsoft Entra ID.
مصادقة مفتاح API: لهذا النوع من المصادقة، يجب أن تتضمن جميع طلبات واجهة برمجة التطبيقات مفتاح API في
api-keyرأس HTTP. يوفر التشغيل السريع إرشادات حول كيفية إجراء مكالمات باستخدام هذا النوع من المصادقة.مصادقة Microsoft Entra ID: يمكنك مصادقة استدعاء واجهة برمجة التطبيقات باستخدام رمز مميز Microsoft Entra. يتم تضمين رموز المصادقة المميزة في الطلب كعنوان
Authorization. يجب أن يكون الرمز المميز المقدم مسبوقًا بـBearer، على سبيل المثالBearer YOUR_AUTH_TOKEN. يمكنك قراءة دليل الكيفية حول مصادقة باستخدام Microsoft Entra ID.
تعيين إصدار واجهة برمجة تطبيقات REST
يتم إصدار واجهات برمجة التطبيقات للخدمة باستخدام معلمة الاستعلام 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
استدلال مستوى البيانات
تغطي بقية المقالة إصدار التوفر العام لمواصفات استدلال مستوى بيانات Azure OpenAI، 2024-10-21.
إذا كنت تبحث عن وثائق حول أحدث إصدار لواجهة برمجة تطبيقات المعاينة، فراجع أحدث واجهة برمجة تطبيقات لاستدلال مستوى بيانات المعاينة
عمليات الإكمال
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21
إنشاء إكمال للمطالبة المقدمة والمعلمات والنموذج المختار.
معلمات URI
| الاسم | في | مطلوب | النوع | وصف |
|---|---|---|---|---|
| نقطه النهايه | path | نعم | string عنوان URL |
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | نعم | string | معرف النشر للنموذج الذي تم نشره. |
| نسخة واجهة برمجة التطبيقات | استعلام | نعم | string | إصدار API |
رأس الطلب
| الاسم | مطلوب | النوع | وصف |
|---|---|---|---|
| api-key | صحيح | string | توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا |
نص الطلب
نوع المحتوى: application/json
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| فوري | سلسلة أو مجموعة | المطالبة (المطالبات) لإنشاء عمليات إكمال، مرمزة كسلسلة، أو صفيف من السلاسل، أو صفيف من الرموز المميزة، أو صفيف من صفائف الرمز المميز. لاحظ أن <|endoftext|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، لذلك إذا لم يتم تحديد مطالبة، فسينشئ النموذج كما لو كان من بداية مستند جديد. |
نعم | |
| best_of | integer | إنشاء إكمال من best_of جانب الخادم وإرجاع "الأفضل" (واحد مع أعلى احتمال سجل لكل رمز مميز). لا يمكن دفق النتائج.عند استخدامه مع n، best_of يتحكم في عدد إكمالات n المرشحين ويحدد عدد مرات إرجاع â € best_of يجب أن يكون أكبر من n.ملاحظه: نظرا لأن هذه المعلمة تنشئ العديد من عمليات الإكمال، يمكنها استهلاك حصة الرمز المميز الخاصة بك بسرعة. استخدم بعناية وتأكد من أن لديك إعدادات معقولة ل max_tokens و stop. |
لا | 1 |
| echo | boolean | إعادة توجيه المطالبة بالإضافة إلى الاكتمال |
لا | خطأ |
| frequency_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي. |
لا | 0 |
| logit_bias | object | تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في GPT tokenizer) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. سيختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو تحديد حصري للرمز المميز ذي الصلة. على سبيل المثال، يمكنك التمرير {"50256": -100} لمنع <إنشاء الرمز المميز |endoftext|> . |
لا | لا شيء |
| سجلات الحماية | integer | قم بتضمين احتمالات السجل على logprobs الرموز المميزة للإخراج الأكثر احتمالا، بالإضافة إلى الرموز المميزة المختارة. على سبيل المثال، إذا كان logprobs هو 5، فسترجع واجهة برمجة التطبيقات قائمة بالرموز المميزة الخمسة الأكثر احتمالا. ستقوم واجهة برمجة التطبيقات دائما بإعادة logprob الرمز المميز الذي تم أخذ عينات له، لذلك قد يكون هناك ما يصل إلى logprobs+1 عناصر في الاستجابة.الحد الأقصى لقيمة logprobs هو 5. |
لا | لا شيء |
| max_tokens | integer | الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها عند الاكتمال. لا يمكن أن يتجاوز عدد الرموز المميزة لمطالبتك بالإضافة إلى max_tokens طول سياق النموذج. |
لا | 16 |
| n | integer | مقدار عدد عمليات الإكمال التي يجب إنشاؤها لكل مطالبة. ملاحظه: نظرا لأن هذه المعلمة تنشئ العديد من عمليات الإكمال، يمكنها استهلاك حصة الرمز المميز الخاصة بك بسرعة. استخدم بعناية وتأكد من أن لديك إعدادات معقولة ل max_tokens و stop. |
لا | 1 |
| presence_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج. |
لا | 0 |
| seed | integer | إذا تم تحديده ، سيبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات seed المتكررة بنفس المعلمات والمعلمات نفس النتيجة.الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة system_fingerprint لمراقبة التغييرات في الخلفية. |
لا | |
| stop | سلسلة أو مجموعة | ما يصل إلى أربعة تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف. |
لا | |
| استدر | boolean | سواء كنت تريد إرجاع التقدم الجزئي أم لا. إذا تم تعيينها، إرسال الرموز المميزة كأحداث مرسلة إلى الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالة data: [DONE] . |
لا | خطأ |
| لاحقه | string | اللاحقة التي تأتي بعد إكمال النص المدرج. هذه المعلمة مدعومة فقط ل gpt-3.5-turbo-instruct. |
لا | لا شيء |
| درجة الحرارة | رقم | ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما. |
لا | 1 |
| top_p | رقم | بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما. |
لا | 1 |
| user | string | معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها. |
لا |
الاستجابات
رمز الحالة: 200
وصف: حسنا
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | createCompletionResponse | يمثل استجابة إكمال من واجهة برمجة التطبيقات. ملاحظة: تشترك كائنات الاستجابة المتدفقة وغير المتدفقة في نفس الشكل (على عكس نقطة نهاية الدردشة). |
رمز الحالة: افتراضي
الوصف: الخدمة غير متوفرة
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | errorResponse |
الأمثلة
مثال
إنشاء إكمال للمطالبة المقدمة والمعلمات والنموذج المختار.
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
}
}
}
Embeddings
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21
احصل على تمثيل متجه لمدخلات معينة يمكن استهلاكها بسهولة بواسطة نماذج التعلم الآلي والخوارزميات.
معلمات URI
| الاسم | في | مطلوب | النوع | وصف |
|---|---|---|---|---|
| نقطه النهايه | path | نعم | string عنوان URL |
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | نعم | string | |
| نسخة واجهة برمجة التطبيقات | استعلام | نعم | string | إصدار API |
رأس الطلب
| الاسم | مطلوب | النوع | وصف |
|---|---|---|---|
| api-key | صحيح | string | توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا |
نص الطلب
نوع المحتوى: application/json
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| الادخال | سلسلة أو مجموعة | إدخال نص لتضمينه أو ترميزه كسلسلة أو صفيف من الرموز المميزة. لتضمين مدخلات متعددة في طلب واحد، مرر صفيف سلاسل أو صفيف من صفائف الرمز المميز. يجب ألا يتجاوز الإدخال الحد الأقصى الرموز المميزة للإدخال للنموذج (8192 رمزا مميزا ل text-embedding-ada-002)، ولا يمكن أن يكون سلسلة فارغة، ويجب أن يكون أي صفيف 2048 بعدا أو أقل. |
نعم | |
| user | string | معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها. | لا | |
| input_type | string | نوع إدخال البحث المراد استخدامه للتضمين | لا | |
| encoding_format | string | التنسيق الذي يجب إرجاع التضمينات فيه. يمكن أن يكون إما float أو base64. الإعدادات الافتراضية لـ float. |
لا | |
| ابعاد | integer | عدد الأبعاد التي يجب أن تحتوي عليها تضمينات الإخراج الناتجة. مدعوم فقط في text-embedding-3 والنماذج الأحدث. |
لا |
الاستجابات
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| object | string | نعم | ||
| نموذج | string | نعم | ||
| البيانات | صفيف | نعم | ||
| استخدام | object | نعم |
خصائص الاستخدام
prompt_tokens
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| prompt_tokens | integer |
total_tokens
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| total_tokens | integer |
رمز الحالة: 200
وصف: حسنا
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | object |
الأمثلة
مثال
إرجاع التضمينات لمطالبة معينة.
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
| الاسم | في | مطلوب | النوع | وصف |
|---|---|---|---|---|
| نقطه النهايه | path | نعم | string عنوان URL |
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | نعم | string | معرف النشر للنموذج الذي تم نشره. |
| نسخة واجهة برمجة التطبيقات | استعلام | نعم | string | إصدار API |
رأس الطلب
| الاسم | مطلوب | النوع | وصف |
|---|---|---|---|
| api-key | صحيح | string | توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا |
نص الطلب
نوع المحتوى: application/json
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| درجة الحرارة | رقم | ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما. |
لا | 1 |
| top_p | رقم | بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما. |
لا | 1 |
| استدر | boolean | في حالة التعيين، سيتم إرسال دلتا الرسائل الجزئية، كما هو الحال في ChatGPT. سيتم إرسال الرموز المميزة كأحداث مرسلة بواسطة الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالة data: [DONE] . |
لا | خطأ |
| stop | سلسلة أو مجموعة | ما يصل إلى أربعة تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. |
لا | |
| max_tokens | integer | الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها في إكمال الدردشة. يحد طول إجمالي رموز الإدخال المميزة والرموز المميزة التي تم إنشاؤها من خلال طول سياق النموذج. |
لا | |
| max_completion_tokens | integer | حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها لإكمالها، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية. | لا | |
| presence_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج. |
لا | 0 |
| frequency_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي. |
لا | 0 |
| logit_bias | object | تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في الرمز المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. سيختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو تحديد حصري للرمز المميز ذي الصلة. |
لا | لا شيء |
| user | string | معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها. |
لا | |
| messages | صفيف | قائمة بالرسائل التي تتضمن المحادثة حتى الآن. | نعم | |
| data_sources | صفيف | إدخالات التكوين Azure ملحقات دردشة OpenAI التي تستخدمها. هذه المواصفات الإضافية متوافقة فقط مع Azure OpenAI. |
لا | |
| سجلات الحماية | 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": {...} } الإخراجات المنظمة التي تضمن أن النموذج سيطابق مخطط JSON المتوفر.إعداد لتمكين { "type": "json_object" } وضع JSON، والذي يضمن الرسالة التي ينشئها النموذج هي JSON صالحة.هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، finish_reason="length"مما يشير إلى تجاوز max_tokens الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق. |
لا | |
| seed | integer | هذه الميزة في Beta. إذا تم تحديده ، سيبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات seed المتكررة بنفس المعلمات والمعلمات نفس النتيجة.الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة system_fingerprint لمراقبة التغييرات في الخلفية. |
لا | |
| الأدوات | صفيف | قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. يتم دعم 128 وظيفة كحد أقصى. |
لا | |
| tool_choice | chatCompletionToolChoiceOption | يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج.
none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة.
auto يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر.
required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر. تحديد أداة معينة عبر {"type": "function", "function": {"name": "my_function"}} يفرض على النموذج استدعاء تلك الأداة.
none هو الافتراضي عندما لا تكون هناك أدوات موجودة.
auto هو الافتراضي إذا كانت الأدوات موجودة. |
لا | |
| function_call | سلسلة أو chatCompletionFunctionCallOption | مهمل لصالح tool_choice.عناصر التحكم التي يتم استدعاء الدالة (إن وجدت) بواسطة النموذج. none يعني أن النموذج لن يستدعي دالة وبدلا من ذلك ينشئ رسالة.auto يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء دالة.تحديد دالة معينة عبر {"name": "my_function"} يفرض على النموذج استدعاء تلك الدالة.none هو الافتراضي عندما لا تكون هناك دالات.
auto هو الافتراضي إذا كانت الدالات موجودة. |
لا | |
| functions | صفيف | مهمل لصالح tools.قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. |
لا |
الاستجابات
رمز الحالة: 200
وصف: حسنا
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | إنشاءChatCompletionResponse أو إنشاءChatCompletionStreamResponse |
رمز الحالة: افتراضي
الوصف: الخدمة غير متوفرة
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | errorResponse |
الأمثلة
مثال
إنشاء إكمال للمطالبة المقدمة والمعلمات والنموذج المختار.
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 والهوية المدارة المعينة من قبل النظام.
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 ورسالة المساعد السابقة والهوية المدارة المعينة من قبل المستخدم.
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
| الاسم | في | مطلوب | النوع | وصف |
|---|---|---|---|---|
| نقطه النهايه | path | نعم | string عنوان URL |
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | نعم | string | معرف النشر لنموذج الكلام إلى النص. للحصول على معلومات حول النماذج المدعومة، راجع [/azure/ai-foundry/openai/concepts/models#audio-models]. |
| نسخة واجهة برمجة التطبيقات | استعلام | نعم | string | إصدار API |
رأس الطلب
| الاسم | مطلوب | النوع | وصف |
|---|---|---|---|
| api-key | صحيح | string | توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا |
نص الطلب
نوع المحتوى: متعدد الأحزاب/بيانات النموذج
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| ملف | string | كائن الملف الصوتي المراد نسخه. | نعم | |
| فوري | string | نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت. | لا | |
| response_format | audioResponseFormat | تعريف تنسيق الإخراج. | لا | |
| درجة الحرارة | رقم | درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه إلى 0، فسيستخدم النموذج احتمال السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى حدود معينة. | لا | 0 |
| اللغة | string | لغة صوت الإدخال. سيؤدي توفير لغة الإدخال بتنسيق ISO-639-1 إلى تحسين الدقة وزمن الانتقال. | لا |
الاستجابات
رمز الحالة: 200
وصف: حسنا
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | audioResponse أو audioVerboseResponse | |
| text/plain | 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
| الاسم | في | مطلوب | النوع | وصف |
|---|---|---|---|---|
| نقطه النهايه | path | نعم | string عنوان URL |
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | نعم | string | معرف النشر لنموذج الهمس الذي تم نشره. للحصول على معلومات حول النماذج المدعومة، راجع [/azure/ai-foundry/openai/concepts/models#audio-models]. |
| نسخة واجهة برمجة التطبيقات | استعلام | نعم | string | إصدار API |
رأس الطلب
| الاسم | مطلوب | النوع | وصف |
|---|---|---|---|
| api-key | صحيح | string | توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا |
نص الطلب
نوع المحتوى: متعدد الأحزاب/بيانات النموذج
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| ملف | string | الملف الصوتي المراد ترجمته. | نعم | |
| فوري | string | نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تكون المطالبة باللغة الإنجليزية. | لا | |
| response_format | audioResponseFormat | تعريف تنسيق الإخراج. | لا | |
| درجة الحرارة | رقم | درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه إلى 0، فسيستخدم النموذج احتمال السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى حدود معينة. | لا | 0 |
الاستجابات
رمز الحالة: 200
وصف: حسنا
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | audioResponse أو audioVerboseResponse | |
| text/plain | 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
| الاسم | في | مطلوب | النوع | وصف |
|---|---|---|---|---|
| نقطه النهايه | path | نعم | string عنوان URL |
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | نعم | string | معرف النشر للنموذج dall-e الذي تم نشره. |
| نسخة واجهة برمجة التطبيقات | استعلام | نعم | string | إصدار API |
رأس الطلب
| الاسم | مطلوب | النوع | وصف |
|---|---|---|---|
| api-key | صحيح | string | توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا |
نص الطلب
نوع المحتوى: application/json
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| فوري | string | وصف نصي للصورة (الصور) المطلوبة. الحد الأقصى للطول هو 4000 حرف. | نعم | |
| n | integer | عدد الصور المراد إنشاؤها. | لا | 1 |
| size | imageSize | حجم الصور التي تم إنشاؤها. | لا | 1024x1024 |
| response_format | imagesResponseFormat | التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها. | لا | عنوان URL |
| user | string | معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها. | لا | |
| جودة | imageQuality | جودة الصورة التي سيتم إنشاؤها. | لا | قياسي |
| style | imageStyle | نمط الصور التي تم إنشاؤها. | لا | vivid |
الاستجابات
رمز الحالة: 200
وصف: حسنا
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | generateImagesResponse |
رمز الحالة: افتراضي
الوصف: حدث خطأ.
| Content-Type | نوع | الوصف |
|---|---|---|
| application/json | dalleErrorResponse |
الأمثلة
مثال
إنشاء صور معينة إلى مطالبة.
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
}
}
}
]
}
}
مكونات
errorResponse
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| خطأ | error | لا |
errorBase
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| رمز | string | لا | ||
| رسالة | string | لا |
خطأ
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| بارام | string | لا | ||
| النوع | string | لا | ||
| inner_error | innerError | خطأ داخلي مع تفاصيل إضافية. | لا |
innerError
خطأ داخلي مع تفاصيل إضافية.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| رمز | innerErrorCode | رموز الخطأ لكائن الخطأ الداخلي. | لا | |
| content_filter_results | contentFilterPromptResults | معلومات حول فئة تصفية المحتوى (الكراهية، الجنسي، العنف، self_harm)، إذا تم الكشف عنها، وكذلك مستوى الخطورة (very_low، منخفض، متوسط، عالي النطاق يحدد شدة المحتوى الضار ومستوى مخاطره) وما إذا كان قد تمت تصفيته أم لا. معلومات حول محتوى اختراق الحماية والألفاظ النابية، وما إذا تم الكشف عنها، وما إذا تمت تصفيتها أم لا. ومعلومات حول قائمة حظر العملاء، إذا تمت تصفيتها ومعرفها. | لا |
innerErrorCode
رموز الخطأ لكائن الخطأ الداخلي.
الوصف: رموز الخطأ لكائن الخطأ الداخلي.
النوع: سلسلة
افتراضي :
اسم قائمة التعداد: InnerErrorCode
قيم التعداد:
| قيمة | وصف |
|---|---|
| نهجAI المسؤول | انتهكت المطالبة إحدى قواعد تصفية المحتوى. |
dalleErrorResponse
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| خطأ | dalleError | لا |
dalleError
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| بارام | string | لا | ||
| النوع | string | لا | ||
| inner_error | dalleInnerError | خطأ داخلي مع تفاصيل إضافية. | لا |
dalleInnerError
خطأ داخلي مع تفاصيل إضافية.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| رمز | innerErrorCode | رموز الخطأ لكائن الخطأ الداخلي. | لا | |
| content_filter_results | dalleFilterResults | معلومات حول فئة تصفية المحتوى (الكراهية، الجنسي، العنف، self_harm)، إذا تم الكشف عنها، وكذلك مستوى الخطورة (very_low، منخفض، متوسط، عالي النطاق يحدد شدة المحتوى الضار ومستوى مخاطره) وما إذا كان قد تمت تصفيته أم لا. معلومات حول محتوى اختراق الحماية والألفاظ النابية، وما إذا تم الكشف عنها، وما إذا تمت تصفيتها أم لا. ومعلومات حول قائمة حظر العملاء، إذا تمت تصفيتها ومعرفها. | لا | |
| revised_prompt | string | المطالبة التي تم استخدامها لإنشاء الصورة، إذا كان هناك أي مراجعة للمطالبة. | لا |
contentFilterResultBase
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| filtered | boolean | نعم |
contentFilterSeverityResult
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| filtered | boolean | نعم | ||
| severity | string | لا |
contentFilterDetectedResult
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| filtered | boolean | نعم | ||
| detected | boolean | لا |
contentFilterDetectedWithCitationResult
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| citation | object | لا |
خصائص الاقتباس
Url
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| Url | string |
الترخيص
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الترخيص | string |
contentFilterResultsBase
معلومات حول نتائج تصفية المحتوى.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| sexual | contentFilterSeverityResult | لا | ||
| violence | contentFilterSeverityResult | لا | ||
| hate | contentFilterSeverityResult | لا | ||
| self_harm | contentFilterSeverityResult | لا | ||
| profanity | contentFilterDetectedResult | لا | ||
| خطأ | errorBase | لا |
contentFilterPromptResults
معلومات حول فئة تصفية المحتوى (الكراهية، الجنسي، العنف، self_harm)، إذا تم الكشف عنها، وكذلك مستوى الخطورة (very_low، منخفض، متوسط، عالي النطاق يحدد شدة المحتوى الضار ومستوى مخاطره) وما إذا كان قد تمت تصفيته أم لا. معلومات حول محتوى اختراق الحماية والألفاظ النابية، وما إذا تم الكشف عنها، وما إذا تمت تصفيتها أم لا. ومعلومات حول قائمة حظر العملاء، إذا تمت تصفيتها ومعرفها.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| sexual | contentFilterSeverityResult | لا | ||
| violence | contentFilterSeverityResult | لا | ||
| hate | contentFilterSeverityResult | لا | ||
| self_harm | contentFilterSeverityResult | لا | ||
| profanity | contentFilterDetectedResult | لا | ||
| خطأ | errorBase | لا | ||
| jailbreak | contentFilterDetectedResult | لا |
contentFilterChoiceResults
معلومات حول فئة تصفية المحتوى (الكراهية، الجنسي، العنف، self_harm)، إذا تم الكشف عنها، وكذلك مستوى الخطورة (very_low، منخفض، متوسط، عالي النطاق يحدد شدة المحتوى الضار ومستوى مخاطره) وما إذا كان قد تمت تصفيته أم لا. معلومات حول نص الجهات الخارجية والألفاظ النابية، وما إذا تم الكشف عنها، وما إذا تمت تصفيتها أم لا. ومعلومات حول قائمة حظر العملاء، إذا تمت تصفيتها ومعرفها.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| sexual | contentFilterSeverityResult | لا | ||
| violence | contentFilterSeverityResult | لا | ||
| hate | contentFilterSeverityResult | لا | ||
| self_harm | contentFilterSeverityResult | لا | ||
| profanity | contentFilterDetectedResult | لا | ||
| خطأ | errorBase | لا | ||
| protected_material_text | contentFilterDetectedResult | لا | ||
| protected_material_code | contentFilterDetectedWithCitationResult | لا |
promptFilterResult
نتائج تصفية المحتوى لمطالبة واحدة في الطلب.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| prompt_index | integer | لا | ||
| content_filter_results | contentFilterPromptResults | معلومات حول فئة تصفية المحتوى (الكراهية، الجنسي، العنف، self_harm)، إذا تم الكشف عنها، وكذلك مستوى الخطورة (very_low، منخفض، متوسط، عالي النطاق يحدد شدة المحتوى الضار ومستوى مخاطره) وما إذا كان قد تمت تصفيته أم لا. معلومات حول محتوى اختراق الحماية والألفاظ النابية، وما إذا تم الكشف عنها، وما إذا تمت تصفيتها أم لا. ومعلومات حول قائمة حظر العملاء، إذا تمت تصفيتها ومعرفها. | لا |
promptFilterResults
نتائج تصفية المحتوى لمطالبات صفرية أو أكثر في الطلب. في طلب الدفق، قد تصل نتائج مطالبات مختلفة في أوقات مختلفة أو في أوامر مختلفة.
لا توجد خصائص معرفة لهذا المكون.
dalleContentFilterResults
معلومات حول نتائج تصفية المحتوى.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| sexual | contentFilterSeverityResult | لا | ||
| violence | contentFilterSeverityResult | لا | ||
| hate | contentFilterSeverityResult | لا | ||
| self_harm | contentFilterSeverityResult | لا |
dalleFilterResults
معلومات حول فئة تصفية المحتوى (الكراهية، الجنسي، العنف، self_harm)، إذا تم الكشف عنها، وكذلك مستوى الخطورة (very_low، منخفض، متوسط، عالي النطاق يحدد شدة المحتوى الضار ومستوى مخاطره) وما إذا كان قد تمت تصفيته أم لا. معلومات حول محتوى اختراق الحماية والألفاظ النابية، وما إذا تم الكشف عنها، وما إذا تمت تصفيتها أم لا. ومعلومات حول قائمة حظر العملاء، إذا تمت تصفيتها ومعرفها.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| sexual | contentFilterSeverityResult | لا | ||
| violence | contentFilterSeverityResult | لا | ||
| hate | contentFilterSeverityResult | لا | ||
| self_harm | contentFilterSeverityResult | لا | ||
| profanity | contentFilterDetectedResult | لا | ||
| jailbreak | contentFilterDetectedResult | لا |
chatCompletionsRequestCommon
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| درجة الحرارة | رقم | ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما. |
لا | 1 |
| top_p | رقم | بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما. |
لا | 1 |
| استدر | boolean | في حالة التعيين، سيتم إرسال دلتا الرسائل الجزئية، كما هو الحال في ChatGPT. سيتم إرسال الرموز المميزة كأحداث مرسلة بواسطة الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالة data: [DONE] . |
لا | خطأ |
| stop | سلسلة أو مجموعة | ما يصل إلى أربعة تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. | لا | |
| max_tokens | integer | الحد الأقصى لعدد الرموز المميزة المسموح بها للإجابة التي تم إنشاؤها. بشكل افتراضي، سيكون عدد الرموز المميزة التي يمكن للنموذج إرجاعها (4096 - الرموز المميزة للمطالبة). تم إهمال هذه القيمة الآن لصالح max_completion_tokens، وهي غير متوافقة مع نماذج السلسلة o1. |
لا | 4096 |
| max_completion_tokens | integer | حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها لإكمالها، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية. | لا | |
| presence_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج. | لا | 0 |
| frequency_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي. | لا | 0 |
| logit_bias | object | تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن json الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في الرمز المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. سيختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو تحديد حصري للرمز المميز ذي الصلة. | لا | |
| user | string | معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد Azure OpenAI لمراقبة إساءة الاستخدام واكتشافها. | لا |
createCompletionRequest
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| فوري | سلسلة أو مجموعة | المطالبة (المطالبات) لإنشاء عمليات إكمال، مرمزة كسلسلة، أو صفيف من السلاسل، أو صفيف من الرموز المميزة، أو صفيف من صفائف الرمز المميز. لاحظ أن <|endoftext|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، لذلك إذا لم يتم تحديد مطالبة، فسينشئ النموذج كما لو كان من بداية مستند جديد. |
نعم | |
| best_of | integer | إنشاء إكمال من best_of جانب الخادم وإرجاع "الأفضل" (واحد مع أعلى احتمال سجل لكل رمز مميز). لا يمكن دفق النتائج.عند استخدامه مع n، best_of يتحكم في عدد إكمالات n المرشحين ويحدد عدد مرات إرجاع â € best_of يجب أن يكون أكبر من n.ملاحظه: نظرا لأن هذه المعلمة تنشئ العديد من عمليات الإكمال، يمكنها استهلاك حصة الرمز المميز الخاصة بك بسرعة. استخدم بعناية وتأكد من أن لديك إعدادات معقولة ل max_tokens و stop. |
لا | 1 |
| echo | boolean | إعادة توجيه المطالبة بالإضافة إلى الاكتمال |
لا | خطأ |
| frequency_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي. |
لا | 0 |
| logit_bias | object | تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في GPT tokenizer) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. سيختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو تحديد حصري للرمز المميز ذي الصلة. على سبيل المثال، يمكنك التمرير {"50256": -100} لمنع <إنشاء الرمز المميز |endoftext|> . |
لا | لا شيء |
| سجلات الحماية | integer | قم بتضمين احتمالات السجل على logprobs الرموز المميزة للإخراج الأكثر احتمالا، بالإضافة إلى الرموز المميزة المختارة. على سبيل المثال، إذا كان logprobs هو 5، فسترجع واجهة برمجة التطبيقات قائمة بالرموز المميزة الخمسة الأكثر احتمالا. ستقوم واجهة برمجة التطبيقات دائما بإعادة logprob الرمز المميز الذي تم أخذ عينات له، لذلك قد يكون هناك ما يصل إلى logprobs+1 عناصر في الاستجابة.الحد الأقصى لقيمة logprobs هو 5. |
لا | لا شيء |
| max_tokens | integer | الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها عند الاكتمال. لا يمكن أن يتجاوز عدد الرموز المميزة لمطالبتك بالإضافة إلى max_tokens طول سياق النموذج. |
لا | 16 |
| n | integer | مقدار عدد عمليات الإكمال التي يجب إنشاؤها لكل مطالبة. ملاحظه: نظرا لأن هذه المعلمة تنشئ العديد من عمليات الإكمال، يمكنها استهلاك حصة الرمز المميز الخاصة بك بسرعة. استخدم بعناية وتأكد من أن لديك إعدادات معقولة ل max_tokens و stop. |
لا | 1 |
| presence_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج. |
لا | 0 |
| seed | integer | إذا تم تحديده ، سيبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات seed المتكررة بنفس المعلمات والمعلمات نفس النتيجة.الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة system_fingerprint لمراقبة التغييرات في الخلفية. |
لا | |
| stop | سلسلة أو مجموعة | ما يصل إلى أربعة تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف. |
لا | |
| استدر | boolean | سواء كنت تريد إرجاع التقدم الجزئي أم لا. إذا تم تعيينها، إرسال الرموز المميزة كأحداث مرسلة إلى الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالة data: [DONE] . |
لا | خطأ |
| لاحقه | string | اللاحقة التي تأتي بعد إكمال النص المدرج. هذه المعلمة مدعومة فقط ل gpt-3.5-turbo-instruct. |
لا | لا شيء |
| درجة الحرارة | رقم | ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما. |
لا | 1 |
| top_p | رقم | بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما. |
لا | 1 |
| user | string | معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها. |
لا |
createCompletionResponse
يمثل استجابة إكمال من واجهة برمجة التطبيقات. ملاحظة: تشترك كائنات الاستجابة المتدفقة وغير المتدفقة في نفس الشكل (على عكس نقطة نهاية الدردشة).
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| المعرف | string | معرف فريد للاكتمال. | نعم | |
| choices | صفيف | قائمة خيارات الإكمال النموذج الذي تم إنشاؤه لمطالبة الإدخال. | نعم | |
| created | integer | الطابع الزمني Unix (بالثوان) لوقت إنشاء الإكمال. | نعم | |
| نموذج | string | النموذج المستخدم للإكمال. | نعم | |
| prompt_filter_results | promptFilterResults | نتائج تصفية المحتوى لمطالبات صفرية أو أكثر في الطلب. في طلب الدفق، قد تصل نتائج مطالبات مختلفة في أوقات مختلفة أو في أوامر مختلفة. | لا | |
| system_fingerprint | string | تمثل بصمة الإصبع هذه تكوين الخلفية التي يعمل بها النموذج. يمكن استخدامها بالاقتران مع معلمة طلب seed لفهم متى تم إجراء تغييرات الخلفية التي قد تؤثر على الحتمية. |
لا | |
| object | enum | نوع الكائن، والذي يكون دائما "text_completion" القيم المحتملة: text_completion |
نعم | |
| استخدام | completionUsage | إحصائيات الاستخدام لطلب الإكمال. | لا |
createChatCompletionRequest
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| درجة الحرارة | رقم | ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما. |
لا | 1 |
| top_p | رقم | بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما. |
لا | 1 |
| استدر | boolean | في حالة التعيين، سيتم إرسال دلتا الرسائل الجزئية، كما هو الحال في ChatGPT. سيتم إرسال الرموز المميزة كأحداث مرسلة بواسطة الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالة data: [DONE] . |
لا | خطأ |
| stop | سلسلة أو مجموعة | ما يصل إلى أربعة تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. |
لا | |
| max_tokens | integer | الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها في إكمال الدردشة. يحد طول إجمالي رموز الإدخال المميزة والرموز المميزة التي تم إنشاؤها من خلال طول سياق النموذج. |
لا | |
| max_completion_tokens | integer | حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها لإكمالها، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية. | لا | |
| presence_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج. |
لا | 0 |
| frequency_penalty | رقم | رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي. |
لا | 0 |
| logit_bias | object | تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في الرمز المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. سيختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو تحديد حصري للرمز المميز ذي الصلة. |
لا | لا شيء |
| user | string | معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها. |
لا | |
| messages | صفيف | قائمة بالرسائل التي تتضمن المحادثة حتى الآن. | نعم | |
| data_sources | صفيف | إدخالات التكوين Azure ملحقات دردشة OpenAI التي تستخدمها. هذه المواصفات الإضافية متوافقة فقط مع Azure OpenAI. |
لا | |
| سجلات الحماية | 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": {...} } الإخراجات المنظمة التي تضمن أن النموذج سيطابق مخطط JSON المتوفر.إعداد لتمكين { "type": "json_object" } وضع JSON، والذي يضمن الرسالة التي ينشئها النموذج هي JSON صالحة.هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، finish_reason="length"مما يشير إلى تجاوز max_tokens الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق. |
لا | |
| seed | integer | هذه الميزة في Beta. إذا تم تحديده ، سيبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات seed المتكررة بنفس المعلمات والمعلمات نفس النتيجة.الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة system_fingerprint لمراقبة التغييرات في الخلفية. |
لا | |
| الأدوات | صفيف | قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. يتم دعم 128 وظيفة كحد أقصى. |
لا | |
| tool_choice | chatCompletionToolChoiceOption | يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج.
none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة.
auto يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر.
required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر. تحديد أداة معينة عبر {"type": "function", "function": {"name": "my_function"}} يفرض على النموذج استدعاء تلك الأداة.
none هو الافتراضي عندما لا تكون هناك أدوات موجودة.
auto هو الافتراضي إذا كانت الأدوات موجودة. |
لا | |
| function_call | سلسلة أو chatCompletionFunctionCallOption | مهمل لصالح tool_choice.عناصر التحكم التي يتم استدعاء الدالة (إن وجدت) بواسطة النموذج. none يعني أن النموذج لن يستدعي دالة وبدلا من ذلك ينشئ رسالة.auto يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء دالة.تحديد دالة معينة عبر {"name": "my_function"} يفرض على النموذج استدعاء تلك الدالة.none هو الافتراضي عندما لا تكون هناك دالات.
auto هو الافتراضي إذا كانت الدالات موجودة. |
لا | |
| functions | صفيف | مهمل لصالح tools.قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. |
لا |
chatCompletionFunctions
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| الوصف | string | وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة. | لا | |
| الاسم | string | اسم الدالة التي سيتم استدعاؤها. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64. | نعم | |
| المعلمات | FunctionParameters | المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON.
راجع الدليل للحصول على أمثلة، ومرجع مخطط JSON للحصول على وثائق حول التنسيق. يحدد الحذف parameters دالة بقائمة معلمات فارغة. |
لا |
chatCompletionFunctionCallOption
تحديد دالة معينة عبر {"name": "my_function"} يفرض على النموذج استدعاء تلك الدالة.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| الاسم | string | اسم الدالة التي يجب استدعاها. | نعم |
chatCompletionRequestMessage
يمكن أن يكون هذا المكون واحدا مما يلي:
chatCompletionRequestSystemMessage
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| محتوى | سلسلة أو مجموعة | محتويات رسالة النظام. | نعم | |
| role | enum | دور كاتب الرسائل، في هذه الحالة system.القيم المحتملة: النظام |
نعم | |
| الاسم | string | اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور. | لا |
chatCompletionRequestUserMessage
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| محتوى | سلسلة أو مجموعة | محتويات رسالة المستخدم. |
نعم | |
| role | enum | دور كاتب الرسائل، في هذه الحالة user.القيم المحتملة: المستخدم |
نعم | |
| الاسم | string | اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور. | لا |
chatCompletionRequestAssistantMessage
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| محتوى | سلسلة أو مجموعة | محتويات رسالة المساعد. مطلوب ما لم tool_calls يتم تحديد أو function_call . |
لا | |
| رفض | string | رسالة الرفض من قبل المساعد. | لا | |
| role | enum | دور كاتب الرسائل، في هذه الحالة assistant.القيم المحتملة: مساعد |
نعم | |
| الاسم | string | اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور. | لا | |
| tool_calls | chatCompletionMessageToolCalls | تستدعي الأداة التي تم إنشاؤها بواسطة النموذج، مثل استدعاءات الدالة. | لا | |
| function_call | object | مهمل واستبدل ب tool_calls. اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج. |
لا |
خصائص function_call
الحجج
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الحجج | string | الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد ينشئ معلمات غير محددة بواسطة مخطط الدالة. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة. |
الاسم
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الاسم | string | اسم الدالة التي يجب استدعاها. |
chatCompletionRequestToolMessage
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| role | enum | دور كاتب الرسائل، في هذه الحالة tool.القيم المحتملة: الأداة |
نعم | |
| محتوى | سلسلة أو مجموعة | محتويات رسالة الأداة. | نعم | |
| tool_call_id | string | استدعاء الأداة الذي تستجيب له هذه الرسالة. | نعم |
chatCompletionRequestFunctionMessage
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| role | enum | دور كاتب الرسائل، في هذه الحالة function.القيم المحتملة: الدالة |
نعم | |
| محتوى | string | محتويات رسالة الدالة. | نعم | |
| الاسم | string | اسم الدالة التي يجب استدعاها. | نعم |
chatCompletionRequestSystemMessageContentPart
يمكن أن يكون هذا المكون واحدا مما يلي:
chatCompletionRequestUserMessageContentPart
يمكن أن يكون هذا المكون واحدا مما يلي:
chatCompletionRequestAssistantMessageContentPart
يمكن أن يكون هذا المكون واحدا مما يلي:
chatCompletionRequestToolMessageContentPart
يمكن أن يكون هذا المكون واحدا مما يلي:
chatCompletionRequestMessageContentPartText
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | enum | نوع جزء المحتوى. القيم المحتملة: نص |
نعم | |
| نص | string | محتوى النص. | نعم |
chatCompletionRequestMessageContentPartImage
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | enum | نوع جزء المحتوى. القيم المحتملة: image_url |
نعم | |
| image_url | object | نعم |
خصائص image_url
عنوان URL
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| عنوان URL | string | إما عنوان URL للصورة أو بيانات الصورة المشفرة base64. |
تفصيل
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| تفصيل | string | تحديد مستوى تفاصيل الصورة. تعرف على المزيد في دليل الرؤية. | تلقائي |
chatCompletionRequestMessageContentPartRefusal
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | enum | نوع جزء المحتوى. القيم المحتملة: الرفض |
نعم | |
| رفض | string | رسالة الرفض التي أنشأها النموذج. | نعم |
azureChatExtensionConfiguration
تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | azureChatExtensionType | تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا بواسطة دردشة طلب الإكمال الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI. |
نعم |
azureChatExtensionType
تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.
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.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | azureChatExtensionType | تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا بواسطة دردشة طلب الإكمال الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI. |
نعم | |
| المعلمات | azureSearchChatExtensionParameters | معلمات Azure Search عند استخدامها كملحق دردشة Azure OpenAI. | لا |
azureSearchChatExtensionParameters
معلمات Azure Search عند استخدامها كملحق دردشة Azure OpenAI.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| المصادقه | onYourDataApiKeyAuthenticationOptions أو onYourDataSystemAssignedManagedIdentityAuthenticationOptions أو onYourDataUserAssignedManagedIdentityAuthenticationOptions | نعم | ||
| top_n_documents | integer | العدد الأعلى للمستندات المكونة للميزة للاستعلام الذي تم تكوينه. | لا | |
| in_scope | boolean | ما إذا كان يجب تقييد الاستعلامات لاستخدام البيانات المفهرسة. | لا | |
| strictness | integer | الصرامة المكونة لتصفية صلة البحث. أعلى من الصرامة، وأعلى من الدقة ولكن أقل استدعاء للإجابة. | لا | |
| role_information | string | امنح النموذج إرشادات حول كيفية تصرفه وأي سياق يجب أن يشير إليه عند إنشاء استجابة. يمكنك وصف شخصية المساعد وإخباره بكيفية تنسيق الاستجابات. هناك حد 100 رمز مميز له، وهو يحتسب مقابل الحد الإجمالي للرمز المميز. | لا | |
| نقطه النهايه | string | مسار نقطة النهاية المطلق لمورد Azure Search المراد استخدامه. | نعم | |
| index_name | string | اسم الفهرس المراد استخدامه كما هو متوفر في مورد Azure Search المشار إليه. | نعم | |
| fields_mapping | azureSearchIndexFieldMappingOptions | إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Search تم تكوينه. | لا | |
| query_type | azureSearchQueryType | نوع استعلام استرداد Azure Search الذي يجب تنفيذه عند استخدامه كملحق دردشة Azure OpenAI. | لا | |
| semantic_configuration | string | التكوين الدلالي الإضافي للاستعلام. | لا | |
| filter | string | عامل تصفية البحث. | لا | |
| embedding_dependency | onYourDataEndpointVectorizationSource أو onYourDataDeploymentNameVectorizationSource | لا |
azureSearchIndexFieldMappingOptions
إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Search تم تكوينه.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| title_field | string | اسم حقل الفهرس المراد استخدامه كعنوان. | لا | |
| url_field | string | اسم حقل الفهرس لاستخدامه كعنون URL. | لا | |
| filepath_field | string | اسم حقل الفهرس لاستخدامه كمسار ملف. | لا | |
| content_fields | صفيف | أسماء حقول الفهرس التي يجب التعامل معها كمحتوى. | لا | |
| content_fields_separator | string | نمط الفاصل الذي يجب أن تستخدمه حقول المحتوى. | لا | |
| vector_fields | صفيف | أسماء الحقول التي تمثل بيانات المتجهات. | لا |
azureSearchQueryType
نوع استعلام استرداد Azure Search الذي يجب تنفيذه عند استخدامه كملحق دردشة Azure OpenAI.
Description: نوع استعلام استرداد Azure Search الذي يجب تنفيذه عند استخدامه كملحق دردشة Azure OpenAI.
النوع: سلسلة
افتراضي :
اسم قائمة التعداد: AzureSearchQueryType
قيم التعداد:
| قيمة | وصف |
|---|---|
| بسيطة | يمثل محلل الاستعلام الافتراضي البسيط. |
| دلالي | يمثل محلل الاستعلام الدلالي للنمذجة الدلالية المتقدمة. |
| المتجه | يمثل البحث المتجه عبر البيانات المحسوبة. |
| vector_simple_hybrid | يمثل مزيجا من استراتيجية الاستعلام البسيطة مع بيانات المتجهات. |
| vector_semantic_hybrid | يمثل مزيجا من البحث الدلالي والاستعلام عن بيانات المتجهات. |
azureCosmosDBChatExtensionConfiguration
تمثيل محدد للخيارات القابلة للتكوين Azure Cosmos DB عند استخدامه كملحق دردشة Azure OpenAI.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | azureChatExtensionType | تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا بواسطة دردشة طلب الإكمال الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI. |
نعم | |
| المعلمات | azureCosmosDBChatExtensionParameters | المعلمات التي يجب استخدامها عند تكوين Azure OpenAI على ملحقات دردشة بياناتك عند استخدام Azure Cosmos DB ل MongoDB vCore. |
لا |
azureCosmosDBChatExtensionParameters
المعلمات التي يجب استخدامها عند تكوين Azure OpenAI على ملحقات دردشة بياناتك عند استخدام Azure Cosmos DB ل MongoDB vCore.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| المصادقه | onYourDataConnectionStringAuthenticationOptions | خيارات المصادقة Azure OpenAI على بياناتك عند استخدام connection string. | نعم | |
| top_n_documents | integer | العدد الأعلى للمستندات المكونة للميزة للاستعلام الذي تم تكوينه. | لا | |
| in_scope | boolean | ما إذا كان يجب تقييد الاستعلامات لاستخدام البيانات المفهرسة. | لا | |
| strictness | integer | الصرامة المكونة لتصفية صلة البحث. أعلى من الصرامة، وأعلى من الدقة ولكن أقل استدعاء للإجابة. | لا | |
| role_information | string | امنح النموذج إرشادات حول كيفية تصرفه وأي سياق يجب أن يشير إليه عند إنشاء استجابة. يمكنك وصف شخصية المساعد وإخباره بكيفية تنسيق الاستجابات. هناك حد 100 رمز مميز له، وهو يحتسب مقابل الحد الإجمالي للرمز المميز. | لا | |
| database_name | string | اسم قاعدة بيانات MongoDB vCore لاستخدامه مع Azure Cosmos DB. | نعم | |
| container_name | string | اسم حاوية موارد Azure Cosmos DB. | نعم | |
| index_name | string | اسم فهرس MongoDB vCore لاستخدامه مع Azure Cosmos DB. | نعم | |
| fields_mapping | azureCosmosDBFieldMappingOptions | إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Cosmos DB تم تكوينه. | نعم | |
| embedding_dependency | onYourDataEndpointVectorizationSource أو onYourDataDeploymentNameVectorizationSource | نعم |
azureCosmosDBFieldMappingOptions
إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Cosmos DB تم تكوينه.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| title_field | string | اسم حقل الفهرس المراد استخدامه كعنوان. | لا | |
| url_field | string | اسم حقل الفهرس لاستخدامه كعنون URL. | لا | |
| filepath_field | string | اسم حقل الفهرس لاستخدامه كمسار ملف. | لا | |
| content_fields | صفيف | أسماء حقول الفهرس التي يجب التعامل معها كمحتوى. | نعم | |
| content_fields_separator | string | نمط الفاصل الذي يجب أن تستخدمه حقول المحتوى. | لا | |
| vector_fields | صفيف | أسماء الحقول التي تمثل بيانات المتجهات. | نعم |
onYourDataAuthenticationOptions
خيارات المصادقة Azure OpenAI على بياناتك.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | onYourDataAuthenticationType | أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك. | نعم |
onYourDataAuthenticationType
أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.
Description: أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.
النوع: سلسلة
افتراضي :
اسم قائمة التعداد: OnYourDataAuthenticationType
قيم التعداد:
| قيمة | وصف |
|---|---|
| api_key | المصادقة عبر مفتاح API. |
| connection_string | المصادقة عبر connection string. |
| system_assigned_managed_identity | المصادقة عبر الهوية المدارة المعينة من قبل النظام. |
| user_assigned_managed_identity | المصادقة عبر الهوية المدارة المعينة من قبل المستخدم. |
onYourDataApiKeyAuthenticationOptions
خيارات المصادقة Azure OpenAI على بياناتك عند استخدام مفتاح API.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | onYourDataAuthenticationType | أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك. | نعم | |
| مفتاح | string | مفتاح API لاستخدامه للمصادقة. | لا |
onYourDataConnectionStringAuthenticationOptions
خيارات المصادقة Azure OpenAI على بياناتك عند استخدام connection string.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | onYourDataAuthenticationType | أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك. | نعم | |
| connection_string | string | connection string لاستخدامه للمصادقة. | لا |
onYourDataSystemAssignedManagedIdentityAuthenticationOptions
خيارات المصادقة Azure OpenAI على بياناتك عند استخدام هوية مدارة معينة من قبل النظام.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | onYourDataAuthenticationType | أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك. | نعم |
onYourDataUserAssignedManagedIdentityAuthenticationOptions
خيارات المصادقة Azure OpenAI على بياناتك عند استخدام هوية مدارة يعينها المستخدم.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | onYourDataAuthenticationType | أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك. | نعم | |
| managed_identity_resource_id | string | معرف المورد للهوية المدارة المعينة من قبل المستخدم لاستخدامها للمصادقة. | لا |
onYourDataVectorizationSource
تمثيل مجرد لمصدر متجه Azure OpenAI على بياناتك مع البحث عن المتجهات.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | onYourDataVectorizationSourceType | يمثل المصادر المتاحة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات. |
نعم |
onYourDataVectorizationSourceType
يمثل المصادر المتوفرة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات.
Description: يمثل المصادر المتاحة Azure OpenAI On Your Data التي يمكن استخدامها لتكوين توجيه البيانات للاستخدام مع
البحث عن المتجهات.
النوع: سلسلة
افتراضي :
اسم التعداد: OnYourDataVectorizationSourceType
قيم التعداد:
| قيمة | وصف |
|---|---|
| نقطه النهايه | يمثل المتجهات التي يتم إجراؤها بواسطة استدعاءات الخدمة العامة إلى نموذج تضمين Azure OpenAI. |
| deployment_name | يمثل اسم توزيع نموذج Ada لاستخدامه. يجب أن يكون نشر النموذج هذا في نفس Azure مورد OpenAI، ولكن على البيانات الخاصة بك سوف تستخدم نشر النموذج هذا عبر مكالمة داخلية بدلا من استدعاء عام، والذي يمكن المتجه البحث حتى في الشبكات الخاصة. |
onYourDataDeploymentNameVectorizationSource
تفاصيل مصدر المتجهات، المستخدمة من قبل Azure OpenAI على بياناتك عند تطبيق البحث عن المتجهات، والتي تستند إلى اسم توزيع نموذج تضمينات داخلية في نفس مورد OpenAI Azure.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | onYourDataVectorizationSourceType | يمثل المصادر المتاحة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات. |
نعم | |
| deployment_name | string | يحدد اسم نشر النموذج لاستخدامه في المتجهات. يجب أن يكون نشر النموذج هذا في نفس Azure مورد OpenAI، ولكن على بياناتك ستستخدم نشر النموذج هذا عبر مكالمة داخلية بدلا من استدعاء عام، مما يتيح البحث المتجه حتى في الشبكات الخاصة. | لا |
onYourDataEndpointVectorizationSource
تفاصيل مصدر المتجهات، المستخدمة من قبل Azure OpenAI على بياناتك عند تطبيق البحث عن المتجهات، والتي تستند إلى استدعاء نقطة نهاية openAI Azure العامة للتضمين.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | onYourDataVectorizationSourceType | يمثل المصادر المتاحة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات. |
نعم | |
| المصادقه | onYourDataApiKeyAuthenticationOptions | خيارات المصادقة Azure OpenAI على بياناتك عند استخدام مفتاح API. | لا | |
| نقطه النهايه | string | تحديد نقطة النهاية لاستخدامها في المتجهات. يجب أن تكون نقطة النهاية هذه في نفس Azure مورد OpenAI، ولكن على بياناتك ستستخدم نقطة النهاية هذه عبر مكالمة داخلية بدلا من مكالمة عامة، مما يتيح البحث عن المتجهات حتى في الشبكات الخاصة. | لا |
azureChatExtensionsMessageContext
تمثيل لمعلومات السياق الإضافية المتوفرة عند مشاركة Azure ملحقات دردشة OpenAI في إنشاء استجابة إكمال الدردشة المقابلة. يتم ملء معلومات السياق هذه فقط عند استخدام طلب openAI Azure تم تكوينه لاستخدام ملحق مطابق.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| citations | صفيف | نتيجة استرداد مصدر البيانات، المستخدمة لإنشاء رسالة المساعد في الاستجابة. | لا | |
| intent | string | الهدف المكتشف من محفوظات الدردشة، المستخدم للتمرير إلى الدور التالي لنقل السياق. | لا |
citation
معلومات الاقتباس لرسالة استجابة إكمال الدردشة.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| محتوى | string | محتوى الاقتباس. | نعم | |
| العنوان | string | عنوان الاقتباس. | لا | |
| عنوان URL | string | عنوان URL للاقتباس. | لا | |
| filepath | string | مسار ملف الاقتباس. | لا | |
| chunk_id | string | معرف المجموعة للاقتباس. | لا |
chatCompletionMessageToolCall
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| المعرف | string | معرف استدعاء الأداة. | نعم | |
| النوع | toolCallType | نوع استدعاء الأداة، في هذه الحالة function. |
نعم | |
| دالة | object | الدالة التي استدعاها النموذج. | نعم |
خصائص الدالة
الاسم
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الاسم | string | اسم الدالة التي يجب استدعاها. |
الحجج
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الحجج | string | الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد ينشئ معلمات غير محددة بواسطة مخطط الدالة. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة. |
toolCallType
نوع استدعاء الأداة، في هذه الحالة function.
الوصف: نوع استدعاء الأداة، في هذه الحالة function.
النوع: سلسلة
افتراضي :
اسم قائمة التعداد: ToolCallType
قيم التعداد:
| قيمة | وصف |
|---|---|
| دالة | نوع استدعاء الأداة هو دالة. |
chatCompletionRequestMessageTool
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| tool_call_id | string | استدعاء الأداة الذي تستجيب له هذه الرسالة. | لا | |
| محتوى | string | محتويات الرسالة. | لا |
chatCompletionRequestMessageFunction
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| role | enum | دور كاتب الرسائل، في هذه الحالة function.القيم المحتملة: الدالة |
لا | |
| الاسم | string | محتويات الرسالة. | لا | |
| محتوى | string | محتويات الرسالة. | لا |
createChatCompletionResponse
يمثل استجابة إكمال الدردشة التي تم إرجاعها بواسطة النموذج، استنادا إلى الإدخال المقدم.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| المعرف | string | معرف فريد لإكمال الدردشة. | نعم | |
| prompt_filter_results | promptFilterResults | نتائج تصفية المحتوى لمطالبات صفرية أو أكثر في الطلب. في طلب الدفق، قد تصل نتائج مطالبات مختلفة في أوقات مختلفة أو في أوامر مختلفة. | لا | |
| choices | صفيف | قائمة بخيارات إكمال الدردشة. يمكن أن يكون أكثر من واحد إذا كان n أكبر من 1. |
نعم | |
| created | integer | الطابع الزمني Unix (بالثوان) عند إنشاء إكمال الدردشة. | نعم | |
| نموذج | string | النموذج المستخدم لإكمال الدردشة. | نعم | |
| system_fingerprint | string | تمثل بصمة الإصبع هذه تكوين الخلفية التي يعمل بها النموذج. يمكن استخدامها بالاقتران مع معلمة طلب seed لفهم متى تم إجراء تغييرات الخلفية التي قد تؤثر على الحتمية. |
لا | |
| object | enum | نوع الكائن، الذي يتم chat.completionدائما .القيم المحتملة: chat.completion |
نعم | |
| استخدام | completionUsage | إحصائيات الاستخدام لطلب الإكمال. | لا |
createChatCompletionStreamResponse
يمثل مجموعة متدفقة من استجابة إكمال الدردشة التي تم إرجاعها بواسطة النموذج، استنادا إلى الإدخال المقدم.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| المعرف | string | معرف فريد لإكمال الدردشة. كل مجموعة لها نفس المعرف. | نعم | |
| choices | صفيف | قائمة بخيارات إكمال الدردشة. يمكن أن يحتوي على أكثر من عنصر إذا كان n أكبر من 1. |
نعم | |
| created | integer | الطابع الزمني Unix (بالثوان) عند إنشاء إكمال الدردشة. كل مجموعة لها نفس الطابع الزمني. | نعم | |
| نموذج | string | النموذج لإنشاء الإكمال. | نعم | |
| system_fingerprint | string | تمثل بصمة الإصبع هذه تكوين الخلفية التي يعمل بها النموذج. يمكن استخدامها بالاقتران مع معلمة طلب seed لفهم متى تم إجراء تغييرات الخلفية التي قد تؤثر على الحتمية. |
لا | |
| object | enum | نوع الكائن، الذي يتم chat.completion.chunkدائما .القيم المحتملة: chat.completion.chunk |
نعم |
chatCompletionStreamResponseDelta
دلتا إكمال الدردشة التي تم إنشاؤها بواسطة استجابات النموذج المتدفقة.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| محتوى | string | محتويات رسالة المجموعة. | لا | |
| function_call | object | مهمل واستبدل ب tool_calls. اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج. |
لا | |
| tool_calls | صفيف | لا | ||
| role | enum | دور كاتب هذه الرسالة. القيم المحتملة: النظام، المستخدم، المساعد، الأداة |
لا | |
| رفض | string | رسالة الرفض التي أنشأها النموذج. | لا |
خصائص function_call
الحجج
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الحجج | string | الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد ينشئ معلمات غير محددة بواسطة مخطط الدالة. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة. |
الاسم
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الاسم | string | اسم الدالة التي يجب استدعاها. |
chatCompletionMessageToolCallChunk
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| الفهرس | integer | نعم | ||
| المعرف | string | معرف استدعاء الأداة. | لا | |
| النوع | enum | نوع الأداة. حاليا، يتم دعم فقط function .القيم المحتملة: الدالة |
لا | |
| دالة | object | لا |
خصائص الدالة
الاسم
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الاسم | string | اسم الدالة التي يجب استدعاها. |
الحجج
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الحجج | string | الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد ينشئ معلمات غير محددة بواسطة مخطط الدالة. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة. |
chatCompletionStreamOptions
خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين stream: true.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| include_usage | boolean | إذا تم تعيينها، دفق مجموعة إضافية قبل data: [DONE] الرسالة.
usage يعرض الحقل الموجود في هذه المجموعة إحصائيات استخدام الرمز المميز للطلب بأكمله، choices وسيكون الحقل دائما صفيفا فارغا. ستتضمن جميع المجموعات الأخرى أيضا حقلا usage ، ولكن بقيمة خالية. |
لا |
chatCompletionChoiceLogProbs
سجل معلومات الاحتمال للاختيار.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| محتوى | صفيف | قائمة بالرموز المميزة لمحتوى الرسائل مع معلومات احتمال السجل. | نعم | |
| رفض | صفيف | قائمة بالرموز المميزة لرفض الرسائل مع معلومات احتمال السجل. | لا |
chatCompletionTokenLogprob
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| الرمز المميز | string | الرمز المميز. | نعم | |
| لوغاربوب | رقم | احتمال السجل لهذا الرمز المميز. | نعم | |
| بايت | صفيف | قائمة بالأعداد الصحيحة التي تمثل تمثيل UTF-8 بايت للرمز المميز. مفيد في الحالات التي يتم فيها تمثيل الأحرف بواسطة رموز مميزة متعددة وتمثيلات البايت الخاصة بها يجب دمجها لإنشاء تمثيل النص الصحيح. يمكن أن يكون null إذا لم يكن هناك تمثيل بايت للرمز المميز. |
نعم | |
| top_logprobs | صفيف | قائمة بالرموز المميزة الأكثر احتمالا واحتمال سجلها، في موضع الرمز المميز هذا. في حالات نادرة، قد يكون هناك أقل من عدد الطلبات التي تم top_logprobs إرجاعها. |
نعم |
chatCompletionResponseMessage
رسالة إكمال دردشة تم إنشاؤها بواسطة النموذج.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| role | chatCompletionResponseMessageRole | دور كاتب رسالة الاستجابة. | نعم | |
| رفض | string | رسالة الرفض التي أنشأها النموذج. | نعم | |
| محتوى | string | محتويات الرسالة. | نعم | |
| tool_calls | صفيف | تستدعي الأداة التي تم إنشاؤها بواسطة النموذج، مثل استدعاءات الدالة. | لا | |
| function_call | chatCompletionFunctionCall | مهمل واستبدل ب tool_calls. اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج. |
لا | |
| context | azureChatExtensionsMessageContext | تمثيل معلومات السياق الإضافية المتوفرة عند Azure ملحقات دردشة OpenAI في إنشاء استجابة إكمال الدردشة المقابلة. يتم ملء معلومات السياق هذه فقط عندما استخدام طلب Azure OpenAI تم تكوينه لاستخدام ملحق مطابق. |
لا |
chatCompletionResponseMessageRole
دور كاتب رسالة الاستجابة.
الوصف: دور كاتب رسالة الاستجابة.
النوع: سلسلة
افتراضي :
قيم التعداد:
- assistant
chatCompletionToolChoiceOption
يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج.
none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة.
auto يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر.
required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر. تحديد أداة معينة عبر {"type": "function", "function": {"name": "my_function"}} يفرض على النموذج استدعاء تلك الأداة.
none هو الافتراضي عندما لا تكون هناك أدوات موجودة.
auto هو الافتراضي إذا كانت الأدوات موجودة.
يمكن أن يكون هذا المكون واحدا مما يلي:
chatCompletionNamedToolChoice
تحديد أداة يجب أن يستخدمها النموذج. استخدم لفرض النموذج لاستدعاء دالة معينة.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | enum | نوع الأداة. حاليا، يتم دعم فقط function .القيم المحتملة: الدالة |
نعم | |
| دالة | object | نعم |
خصائص الدالة
الاسم
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الاسم | string | اسم الدالة التي يجب استدعاها. |
ParallelToolCalls
ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.
لا توجد خصائص معرفة لهذا المكون.
chatCompletionMessageToolCalls
تستدعي الأداة التي تم إنشاؤها بواسطة النموذج، مثل استدعاءات الدالة.
لا توجد خصائص معرفة لهذا المكون.
chatCompletionFunctionCall
مهمل واستبدل ب tool_calls. اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| الاسم | string | اسم الدالة التي يجب استدعاها. | نعم | |
| الحجج | string | الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد ينشئ معلمات غير محددة بواسطة مخطط الدالة. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة. | نعم |
completionUsage
إحصائيات الاستخدام لطلب الإكمال.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| prompt_tokens | integer | عدد الرموز المميزة في المطالبة. | نعم | |
| completion_tokens | integer | عدد الرموز المميزة في الإكمال الذي تم إنشاؤه. | نعم | |
| total_tokens | integer | إجمالي عدد الرموز المميزة المستخدمة في الطلب (المطالبة + الإكمال). | نعم | |
| completion_tokens_details | object | تصنيف الرموز المميزة المستخدمة في الإكمال. | لا |
خصائص completion_tokens_details
reasoning_tokens
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| reasoning_tokens | integer | الرموز المميزة التي تم إنشاؤها بواسطة النموذج من أجل المنطق. |
chatCompletionTool
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | enum | نوع الأداة. حاليا، يتم دعم فقط function .القيم المحتملة: الدالة |
نعم | |
| دالة | FunctionObject | نعم |
FunctionParameters
المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON. راجع الدليل للحصول على أمثلة، ومرجع مخطط JSON للحصول على وثائق حول التنسيق.
يحدد الحذف parameters دالة بقائمة معلمات فارغة.
لا توجد خصائص معرفة لهذا المكون.
FunctionObject
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| الوصف | string | وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة. | لا | |
| الاسم | string | اسم الدالة التي سيتم استدعاؤها. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64. | نعم | |
| المعلمات | FunctionParameters | المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON.
راجع الدليل للحصول على أمثلة، ومرجع مخطط JSON للحصول على وثائق حول التنسيق. يحدد الحذف parameters دالة بقائمة معلمات فارغة. |
لا | |
| صارم | boolean | ما إذا كان سيتم تمكين الالتزام الصارم بالمخطط عند إنشاء استدعاء الدالة. إذا تم تعيينه إلى صحيح، فسيتبع النموذج المخطط الدقيق المحدد في parameters الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما strict تكون true. |
لا | خطأ |
ResponseFormatText
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | enum | نوع تنسيق الاستجابة الذي يتم تعريفه: textالقيم المحتملة: نص |
نعم |
ResponseFormatJsonObject
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | enum | نوع تنسيق الاستجابة الذي يتم تعريفه: json_objectالقيم المحتملة: json_object |
نعم |
ResponseFormatJsonSchemaSchema
مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON.
لا توجد خصائص معرفة لهذا المكون.
ResponseFormatJsonSchema
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| النوع | enum | نوع تنسيق الاستجابة الذي يتم تعريفه: json_schemaالقيم المحتملة: json_schema |
نعم | |
| json_schema | object | نعم |
خصائص json_schema
الوصف
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الوصف | string | وصف لما هو تنسيق الاستجابة، يستخدمه النموذج لتحديد كيفية الاستجابة بالتنسيق. |
الاسم
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| الاسم | string | اسم تنسيق الاستجابة. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64. |
Schema
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| Schema | ResponseFormatJsonSchemaSchema | مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON. |
صارم
| الاسم | النوع | وصف | الإفتراضي |
|---|---|---|---|
| صارم | boolean | ما إذا كان سيتم تمكين الالتزام الصارم بالمخطط عند إنشاء الإخراج. إذا تم تعيينه إلى true، فسيتبع النموذج دائما المخطط الدقيق المحدد في schema الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما strict تكون true. |
خطأ |
chatCompletionChoiceCommon
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| الفهرس | integer | لا | ||
| finish_reason | string | لا |
createTranslationRequest
طلب ترجمة.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| ملف | string | الملف الصوتي المراد ترجمته. | نعم | |
| فوري | string | نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تكون المطالبة باللغة الإنجليزية. | لا | |
| response_format | audioResponseFormat | تعريف تنسيق الإخراج. | لا | |
| درجة الحرارة | رقم | درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه إلى 0، فسيستخدم النموذج احتمال السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى حدود معينة. | لا | 0 |
audioResponse
استجابة الترجمة أو النسخ عندما كان response_format json
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| نص | string | نص مترجم أو منسوخ. | نعم |
audioVerboseResponse
استجابة الترجمة أو النسخ عند verbose_json response_format
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| نص | string | نص مترجم أو منسوخ. | نعم | |
| مهمة | string | نوع مهمة الصوت. | لا | |
| اللغة | string | Language. | لا | |
| المدة | رقم | Duration. | لا | |
| segments | صفيف | لا |
audioResponseFormat
تعريف تنسيق الإخراج.
الوصف: يحدد تنسيق الإخراج.
النوع: سلسلة
افتراضي :
قيم التعداد:
- json
- نص
- srt
- verbose_json
- vtt
createTranscriptionRequest
طلب النسخ.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| ملف | string | كائن الملف الصوتي المراد نسخه. | نعم | |
| فوري | string | نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت. | لا | |
| response_format | audioResponseFormat | تعريف تنسيق الإخراج. | لا | |
| درجة الحرارة | رقم | درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه إلى 0، فسيستخدم النموذج احتمال السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى حدود معينة. | لا | 0 |
| اللغة | string | لغة صوت الإدخال. سيؤدي توفير لغة الإدخال بتنسيق ISO-639-1 إلى تحسين الدقة وزمن الانتقال. | لا |
audioSegment
جزء النسخ أو الترجمة.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| المعرف | integer | معرف الشريحة. | لا | |
| seek | رقم | إزاحة المقطع. | لا | |
| start | رقم | إزاحة بدء المقطع. | لا | |
| end | رقم | إزاحة نهاية المقطع. | لا | |
| نص | string | نص المقطع. | لا | |
| tokens | صفيف | الرموز المميزة للنص. | لا | |
| درجة الحرارة | رقم | Temperature. | لا | |
| avg_logprob | رقم | متوسط احتمال السجل. | لا | |
| compression_ratio | رقم | نسبة الضغط. | لا | |
| no_speech_prob | رقم | احتمال .no speech |
لا |
imageQuality
جودة الصورة التي سيتم إنشاؤها.
الوصف: جودة الصورة التي سيتم إنشاؤها.
النوع: سلسلة
الافتراضي: قياسي
اسم قائمة التعداد: الجودة
قيم التعداد:
| قيمة | وصف |
|---|---|
| قياسي | تعمل الجودة القياسية على إنشاء صور بجودة قياسية. |
| هد | تعمل جودة HD على إنشاء صور بتفاصيل أدق وتناسق أكبر عبر الصورة. |
imagesResponseFormat
التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها.
الوصف: التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها.
النوع: سلسلة
الافتراضي: url
اسم قائمة التعداد: ImagesResponseFormat
قيم التعداد:
| قيمة | وصف |
|---|---|
| عنوان URL | عنوان URL الذي يوفر وصولا مؤقتا لتنزيل الصور التي تم إنشاؤها. |
| b64_json | يتم إرجاع الصور التي تم إنشاؤها كسلسلة مشفرة base64. |
imageSize
حجم الصور التي تم إنشاؤها.
الوصف: حجم الصور التي تم إنشاؤها.
النوع: سلسلة
الافتراضي: 1024x1024
اسم قائمة التعداد: الحجم
قيم التعداد:
| قيمة | وصف |
|---|---|
| 1792x1024 | الحجم المطلوب للصورة التي تم إنشاؤها هو 1792x1024 بكسل. |
| 1024x1792 | الحجم المطلوب للصورة التي تم إنشاؤها هو 1024x1792 بكسل. |
| 1024x1024 | الحجم المطلوب للصورة التي تم إنشاؤها هو 1024x1024 بكسل. |
imageStyle
نمط الصور التي تم إنشاؤها.
الوصف: نمط الصور التي تم إنشاؤها.
النوع: سلسلة
الافتراضي: حي
اسم قائمة التعداد: نمط
قيم التعداد:
| قيمة | وصف |
|---|---|
| vivid | حية يخلق الصور التي هي فرط واقعية ومثيرة. |
| طبيعي | الطبيعية يخلق الصور التي هي أكثر طبيعية وأقل واقعية. |
imageGenerationsRequest
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| فوري | string | وصف نصي للصورة (الصور) المطلوبة. الحد الأقصى للطول هو 4000 حرف. | نعم | |
| n | integer | عدد الصور المراد إنشاؤها. | لا | 1 |
| size | imageSize | حجم الصور التي تم إنشاؤها. | لا | 1024x1024 |
| response_format | imagesResponseFormat | التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها. | لا | عنوان URL |
| user | string | معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها. | لا | |
| جودة | imageQuality | جودة الصورة التي سيتم إنشاؤها. | لا | قياسي |
| style | imageStyle | نمط الصور التي تم إنشاؤها. | لا | vivid |
generateImagesResponse
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| created | integer | الطابع الزمني unix عند إنشاء العملية. | نعم | |
| البيانات | صفيف | بيانات نتيجة العملية، إذا نجحت | نعم |
imageResult
عنوان URL للصورة أو الصورة المشفرة إذا نجحت، وخطأ بخلاف ذلك.
| الاسم | النوع | وصف | مطلوب | الإفتراضي |
|---|---|---|---|---|
| عنوان URL | string | عنوان URL للصورة. | لا | |
| b64_json | string | الصورة المشفرة base64 | لا | |
| content_filter_results | dalleContentFilterResults | معلومات حول نتائج تصفية المحتوى. | لا | |
| revised_prompt | string | المطالبة التي تم استخدامها لإنشاء الصورة، إذا كان هناك أي مراجعة للمطالبة. | لا | |
| prompt_filter_results | dalleFilterResults | معلومات حول فئة تصفية المحتوى (الكراهية، الجنسي، العنف، self_harm)، إذا تم الكشف عنها، وكذلك مستوى الخطورة (very_low، منخفض، متوسط، عالي النطاق يحدد شدة المحتوى الضار ومستوى مخاطره) وما إذا كان قد تمت تصفيته أم لا. معلومات حول محتوى اختراق الحماية والألفاظ النابية، وما إذا تم الكشف عنها، وما إذا تمت تصفيتها أم لا. ومعلومات حول قائمة حظر العملاء، إذا تمت تصفيتها ومعرفها. | لا |
ملحقات الإكمال
ملحقات الإكمال ليست جزءا من أحدث إصدار GA من Azure مواصفات استدلال مستوى بيانات OpenAI.
رسالة الدردشة
كائن رسالة الدردشة ليس جزءا من أحدث إصدار GA من Azure مواصفات استدلال مستوى بيانات OpenAI.
تحويل النص إلى كلام (معاينة)
لا يعد حاليا جزءا من أحدث إصدار Azure OpenAI GA من مواصفات استدلال مستوى بيانات OpenAI Azure. راجع أحدث إصدار preview لهذه الإمكانية.
الخطوات التالية
تعرف على النماذج، والضبط الدقيق مع واجهة برمجة تطبيقات REST. تعرف على المزيد حول النماذج underlying التي تعمل Azure OpenAI.