Azure OpenAI في مرجع معاينة واجهة برمجة تطبيقات REST لنماذج Microsoft Foundry

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

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

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

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

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

مهم

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

API	أحدث إصدار معاينة	أحدث إصدار من GA	المواصفات	وصف
مستوى التحكم	`2025-07-01-preview`	`2025-06-01`	ملفات Spec	يتم استخدام واجهة برمجة تطبيقات مستوى التحكم لعمليات مثل إنشاء الموارد ونشر النموذج ومهام إدارة الموارد الأخرى ذات المستوى الأعلى. تحكم وحدة التحكم أيضا ما هو ممكن to do بقدرات مثل 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

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

تغطي بقية المقالة إصدار معاينة 2025-04-01-preview لمواصفات استدلال مستوى بيانات Azure OpenAI.

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

الإكمال - إنشاء

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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

معلمات URI

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

رأس الطلب

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
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، فإن واجهة برمجة التطبيقات تعرض قائمة ب 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
فوري	سلسلة أو مجموعة	المطالبة بإنشاء عمليات إكمال، مشفرة كسلسلة، مصفوفة من السلاسل، مصفوفة من الرموز المميزة أو مصفوفة من مصفوفات الرموز المميزة. لاحظ أن <\|endoftext\|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، لذلك إذا لم يتم تحديد مطالبة، فإن النموذج ينشئ كما لو كان من بداية مستند جديد.	‏‏نعم‬
seed	integer	إذا تم تحديده ، يبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات `seed` المتكررة بنفس المعلمات والمعلمات نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة `system_fingerprint` لمراقبة التغييرات في الخلفية.	لا
stop	سلسلة أو مجموعة	ما يصل إلى أربعة تسلسلات حيث تتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف.	لا
استدر	boolean	سواء كنت تريد إرجاع التقدم الجزئي أم لا. في حالة التعيين، يتم إرسال الرموز المميزة كأحداث مرسلة من الخادم للبيانات فقط عند توفرها، مع إنهاء البث بواسطة رسالة `data: [DONE]` . مثال على تعليمة Python البرمجية.	لا	خطأ
لاحقه	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	Type	الوصف
application/json	createCompletionResponse

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

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

Content-Type	Type	الوصف
application/json	errorResponse

الأمثلة

مثال

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

{
 "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=2025-04-01-preview

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

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	object

الأمثلة

مثال

إرجاع التضمينات لمطالبة معينة.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "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.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
صوتي	object	معلمات لإخراج الصوت. مطلوب عند طلب إخراج الصوت باستخدام `modalities: ["audio"]`.	لا
└─ التنسيق	enum	تحديد تنسيق صوت الإخراج. يجب أن يكون واحدا من `wav`أو `mp3flac`أو `opus`.`pcm16` القيم المحتملة: `wav`، `mp3`، `flac`، ، `opuspcm16`	لا
└─ صوت	enum	تحديد نوع الصوت. الأصوات المدعومة هي `alloy`و `echofable`و`onyxnova`.`shimmer` القيم المحتملة: `alloy`، `echo`، `fable`، `onyx`، ، `novashimmer`	لا
data_sources	صفيف	إدخالات التكوين Azure ملحقات دردشة OpenAI التي تستخدمها. هذه المواصفات الإضافية متوافقة فقط مع Azure OpenAI.	لا
frequency_penalty	رقم	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي.	لا	0
function_call	سلسلة أو chatCompletionFunctionCallOption	مهمل لصالح `tool_choice`. عناصر التحكم التي يتم استدعاء الدالة (إن وجدت) بواسطة النموذج. `none` يعني أن النموذج لن يستدعي دالة وبدلا من ذلك ينشئ رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء دالة. تحديد دالة معينة عبر `{"name": "my_function"}` يفرض على النموذج استدعاء تلك الدالة. `none` هو الافتراضي عندما لا تكون هناك دالات. `auto` هو الافتراضي إذا كانت الدالات موجودة.	لا
functions	صفيف	مهمل لصالح `tools`. قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها.	لا
logit_bias	object	تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في الرمز المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. يختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو اختيار حصري للرمز المميز ذي الصلة.	لا	لا شيء
سجلات الحماية	boolean	ما إذا كان يجب إرجاع احتمالات السجل للرمز المميزة للإخراج أم لا. إذا كان صحيحا، فترجع احتمالات السجل لكل رمز مميز للإخراج تم إرجاعه في `content` من `message`.	لا	خطأ
max_completion_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها لإكمالها، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية.	لا
max_tokens	integer	الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها في إكمال الدردشة. يحد طول إجمالي رموز الإدخال المميزة والرموز المميزة التي تم إنشاؤها من خلال طول سياق النموذج.	لا
messages	صفيف	قائمة بالرسائل التي تتضمن المحادثة حتى الآن. مثال على تعليمة Python البرمجية.	‏‏نعم‬
metadata	object	العلامات والقيم المعرفة من قبل المطور المستخدمة لتصفية الإكمال في لوحة معلومات الإكمال المخزنة.	لا
طرائق	ChatCompletionModalities	أنواع الإخراج التي ترغب في أن ينشئها النموذج لهذا الطلب. معظم النماذج قادرة على إنشاء نص، وهو الافتراضي: `["text"]` `gpt-4o-audio-preview` يمكن أيضا استخدام النموذج لإنشاء الصوت. لطلب إنشاء هذا النموذج استجابات نصية وصوتية، يمكنك استخدام: `["text", "audio"]`	لا
n	integer	كم عدد خيارات إكمال الدردشة التي يجب إنشاؤها لكل رسالة إدخال. سيتم تحصيل رسوم منك بناء على عدد الرموز المميزة التي تم إنشاؤها عبر جميع الخيارات. احتفظ `n` بأدنى `1` قدر من التكاليف.	لا	1
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا	صحيح
prediction	PredictionContent	تكوين الإخراج المتوقع، والذي يمكن أن يحسن أوقات الاستجابة بشكل كبير عندما تكون أجزاء كبيرة من استجابة النموذج معروفة مسبقا. هذا هو الأكثر شيوعا عند إعادة إنشاء ملف مع تغييرات طفيفة فقط على معظم المحتوى.	لا
presence_penalty	رقم	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج.	لا	0
reasoning_effort	enum	نماذج o1 فقط يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي `low`و `medium`و.`high` يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. القيم المحتملة: `low`، ، `mediumhigh`	لا
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` لمراقبة التغييرات في الخلفية.	لا
stop	سلسلة أو مجموعة	ما يصل إلى 4 تسلسلات حيث تتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة.	لا
store	boolean	ما إذا كان يجب تخزين إخراج طلب إكمال الدردشة هذا أم لا للاستخدام في منتجات تقطير النموذج أو التقييم.	لا
استدر	boolean	إذا تم تعيينه ، يتم إرسال دلتا الرسائل الجزئية ، كما هو الحال في ChatGPT. يتم إرسال الرموز المميزة كأحداث مرسلة من الخادم للبيانات فقط عند توفرها، مع إنهاء الدفق برسالة `data: [DONE]` . مثال على تعليمة Python البرمجية.	لا	خطأ
stream_options	chatCompletionStreamOptions	خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين `stream: true`.	لا	لا شيء
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 تجعل الإخراج أكثر عشوائية ، في حين أن القيم المنخفضة مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	لا	1
tool_choice	chatCompletionToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. `auto` يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر. تحديد أداة معينة عبر `{"type": "function", "function": {"name": "my_function"}}` يفرض على النموذج استدعاء تلك الأداة. `none` هو الافتراضي عندما لا تكون هناك أدوات موجودة. `auto` هو الافتراضي إذا كانت الأدوات موجودة.	لا
الأدوات	صفيف	قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. يتم دعم 128 وظيفة كحد أقصى.	لا
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن. `logprobs` يجب تعيين إلى `true` إذا تم استخدام هذه المعلمة.	لا
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	لا	1
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	لا
user_security_context	userSecurityContext	يحتوي سياق أمان المستخدم على العديد من المعلمات التي تصف تطبيق الذكاء الاصطناعي نفسه، والمستخدم النهائي الذي يتفاعل مع تطبيق الذكاء الاصطناعي. تساعد هذه الحقول فرق عمليات الأمان الخاصة بك على التحقيق في الحوادث الأمنية والتخفيف من حدتها من خلال توفير نهج شامل لحماية تطبيقاتك الذكاء الاصطناعي. تعرف على المزيد حول حماية تطبيقات الذكاء الاصطناعي باستخدام Microsoft Defender for Cloud.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	object

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

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

Content-Type	Type	الوصف
application/json	errorResponse

الأمثلة

مثال

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "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=2025-04-01-preview

{
 "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=2025-04-01-preview

{
 "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}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

مثال

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "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=2025-04-01-preview

{
 "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
    }
  }
}

مثال

ينشئ إكمالا لقاعدة بيانات Mongo DB المتوفرة.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "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
    }
  }
}

مثال

إنشاء إكمال ل Elasticsearch المقدم.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

الاستجابات: رمز الحالة: 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
    }
  }
}

مثال

إنشاء إكمال لمورد Pinecone المتوفر.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

الاستجابات: رمز الحالة: 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=2025-04-01-preview

نسخ الصوت إلى لغة الإدخال.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
نموذج	string	معرف النموذج المراد استخدامه. الخيارات هي `gpt-4o-transcribe`، `gpt-4o-mini-transcribe`، `gpt-4o-mini-transcribe-2025-12-15`، `whisper-1`و `gpt-4o-transcribe-diarize`.	‏‏نعم‬
ملف	string	كائن الملف الصوتي المراد نسخه.	‏‏نعم‬
اللغة	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 إلى تحسين الدقة وزمن الوصول.	لا
فوري	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت.	لا
response_format	audioResponseFormat	تعريف تنسيق الإخراج.	لا
درجة الحرارة	رقم	درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه على 0 ، يستخدم النموذج احتمالية السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى عتبات معينة.	لا	0
timestamp_granularities[]	صفيف	نقاوة الطابع الزمني التي يجب ملؤها لهذا النسخ. `response_format` يجب تعيين `verbose_json` لاستخدام نقاوة الطابع الزمني. يتم دعم أي من هذين الخيارين أو كليهما: `word`أو `segment`. ملاحظة: لا يوجد زمن انتقال إضافي للطوابع الزمنية للمقطع، ولكن إنشاء الطوابع الزمنية للكلمة يتطلب زمن انتقال إضافي.	لا	['segment']

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	object
text/plain	string	نص منسوخ بتنسيق الإخراج (عندما كان response_format واحدا من `text`، `vtt` أو `srt`).

الأمثلة

مثال

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

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

مثال

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---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=2025-04-01-preview

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

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	object
text/plain	string	نص مكتوب بتنسيق الإخراج (عندما يكون response_format نصا أو vtt أو srt).

الأمثلة

مثال

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---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=2025-04-01-preview

"---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/speech?api-version=2025-04-01-preview

إنشاء صوت من نص الإدخال.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	string	النص المراد تركيب الصوت له. الحد الأقصى للطول هو 4,096 حرفا.	‏‏نعم‬
response_format	enum	التنسيق المراد تركيب الصوت فيه. القيم المحتملة: `mp3`، `opus`، `aac`، `flac`، ، `wavpcm`	لا
speed	رقم	سرعة الصوت المركب. حدد قيمة من `0.25` إلى `4.0`. `1.0` هو الافتراضي.	لا	1.0
صوت	enum	الصوت الذي يجب استخدامه لتركيب الكلام. القيم المحتملة: `alloy`، `echo`، `fable`، `onyx`، ، `novashimmer`	‏‏نعم‬

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/octet-stream	string

الأمثلة

مثال

تجميع الصوت من النص المقدم.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

الاستجابات: رمز الحالة: 200

{
  "body": "101010101"
}

أجيال الصور - إنشاء

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

تولد دفعة من الصور من تعليق نصي على نشر نموذج DALL-E معين أو GPT-image-1

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
background	imageBackground	يسمح بتعيين الشفافية لخلفية الصور التي تم إنشاؤها. هذا المعامل مدعوم فقط لنماذج سلسلة gpt-image-1.	لا	تلقائي
n	integer	عدد الصور المراد إنشاؤها. بالنسبة إلى dall-e-3، يتم دعم n=1 فقط.	لا	1
output_compression	integer	مستوى الضغط (0-100%) للصور التي تم إنشاؤها. يدعم هذا المعامل فقط لنماذج سلسلة gpt-image-1 التي تستخدم صيغة إخراج jpeg.	لا	100
output_format	imagesOutputFormat	تنسيق الملف الذي يتم فيه إرجاع الصور التي تم إنشاؤها. مدعوم فقط لنماذج سلسلة gpt-image-1.	لا	png
فوري	string	وصف نصي للصورة (الصور) المطلوبة. الحد الأقصى للطول هو 32000 حرف لسلسلة gpt-image-1 و4000 حرف لسلسلة dall-e-3	‏‏نعم‬
partial_images	integer	عدد الصور الجزئية المراد إنشاؤها. تستخدم هذه المعلمة لتدفق الاستجابات التي تعرض صورا جزئية. يجب أن تكون القيمة بين 0 و3. عند الضبط على 0، ستكون الاستجابة صورة واحدة يتم إرسالها في حدث بث واحد. لاحظ أنه قد يتم إرسال الصورة النهائية قبل إنشاء العدد الكامل للصور الجزئية إذا تم إنشاء الصورة الكاملة بسرعة أكبر.	0
استدر	boolean	قم بتحرير الصورة في وضع البث.	no	`false`
جودة	imageQuality	جودة الصورة التي سيتم إنشاؤها.	لا	تلقائي
response_format	imagesResponseFormat	التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها. هذا المعامل غير مدعوم لنماذج `gpt-image-1`السلسلة التي ستعيد دائما الصور المشفرة بنظام base64. القيم المحتملة: `url`، `b64_json`.	لا	عنوان URL
size	imageSize	حجم الصور التي تم إنشاؤها.	لا	تلقائي
style	imageStyle	نمط الصور التي تم إنشاؤها. مدعوم فقط ل dall-e-3.	لا	vivid
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	generateImagesResponse

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

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

Content-Type	Type	الوصف
application/json	dalleErrorResponse

الأمثلة

مثال

إنشاء صور معينة إلى مطالبة.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "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
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "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
          }
        }
      }
    ]
  }
}

أجيال الصور - تحرير

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

تحرير صورة من تسمية توضيحية نصية على نشر نموذج gpt-image-1 معين

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
صورة	سلسلة أو مجموعة	الصورة (الصور) المراد تحريرها. يجب أن يكون ملف صورة معتمدا أو صفيفا من الصور. يجب أن تكون كل صورة ملف png أو jpg أقل من 50 ميجابايت.	‏‏نعم‬
input_fidelity	string	تحكم في مقدار الجهد الذي سيبذله النموذج لمطابقة نمط وميزات الصور المدخلة ، وخاصة ملامح الوجه. هذا المعامل مدعوم فقط لنماذج سلسلة gpt-image-1. يدعم `high` و `low`.	no	`low`.
قناع	string	صورة إضافية تشير مناطقها الشفافة بالكامل (على سبيل المثال، حيث ألفا صفر) إلى المكان الذي يجب تحرير الصورة فيه. إذا تم توفير صور متعددة، تطبيق القناع على الصورة الأولى. يجب أن يكون ملف PNG صالحا، أقل من 4 ميغابايت، وأن يكون له نفس أبعاد الصورة.	لا
n	integer	عدد الصور المراد إنشاؤها. يجب أن يكون بين 1 و 10.	لا	1
فوري	string	وصف نصي للصورة (الصور) المطلوبة. الحد الأقصى للطول هو 32000 حرف.	‏‏نعم‬
جودة	imageQuality	جودة الصورة التي سيتم إنشاؤها.	لا	تلقائي
partial_images	عدد الصور الجزئية المراد إنشاؤها. تستخدم هذه المعلمة لتدفق الاستجابات التي تعرض صورا جزئية. يجب أن تكون القيمة بين 0 و3. عند الضبط على 0، ستكون الاستجابة صورة واحدة يتم إرسالها في حدث بث واحد. لاحظ أنه قد يتم إرسال الصورة النهائية قبل إنشاء العدد الكامل للصور الجزئية إذا تم إنشاء الصورة الكاملة بسرعة أكبر.
استدر	boolean	قم بتحرير الصورة في وضع البث.	no	`false`
response_format	imagesResponseFormat	التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها.	لا	عنوان URL
size	imageSize	حجم الصور التي تم إنشاؤها.	لا	تلقائي
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	generateImagesResponse

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

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

Content-Type	Type	الوصف
application/json	dalleErrorResponse

قائمة - مساعدون

‏‫ملاحظة‬

واجهة برمجة تطبيقات المساعدين مهجورة وسيتم إخراجها في 26 أغسطس 2026. استخدم خدمة Microsoft Foundry Agents المتوفرة عموما. اتبع دليل الترحيل لتحديث أعباء عملك. تعرّف على المزيد.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

إرجاع قائمة المساعدين.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
order	استعلام	لا	string القيم المحتملة: `asc`، `desc`	ترتيب الفرز حسب الطابع `created_at` الزمني للكائنات. `asc` للترتيب التصاعدي وللترتيب `desc` التنازلي.
after	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `after` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
قبل	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `before` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، بدءا من obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	listAssistantsResponse

الأمثلة

مثال

إرجاع قائمة المساعدين.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

إنشاء - مساعد

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

إنشاء مساعد باستخدام نموذج وتعليمات.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	لا
تعليمات	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 256000 حرف.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
نموذج	string		‏‏نعم‬
الاسم	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	لا
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
└─ vector_stores	صفيف	مساعد لإنشاء مخزن متجهات باستخدام file_ids وإرفاقه بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
الأدوات	صفيف	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `retrieval`أو `function`.	لا	[]
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	assistantObject

الأمثلة

مثال

إنشاء مساعد باستخدام نموذج وتعليمات.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Get - مساعد

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

استرداد مساعد.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	assistantObject

الأمثلة

مثال

استرداد مساعد.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

تعديل - مساعد

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

تعديل مساعد.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	لا
تعليمات	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 32768 حرفا.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
نموذج	string		لا
الاسم	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	لا
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	يتجاوز قائمة معرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	يتجاوز مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
الأدوات	صفيف	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `retrieval`أو `function`.	لا	[]
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	assistantObject

الأمثلة

مثال

تعديل مساعد.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

حذف - مساعد

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

حذف مساعد.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	deleteAssistantResponse

الأمثلة

مثال

حذف مساعد.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

إنشاء - مؤشر ترابط

‏‫ملاحظة‬

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

إنشاء مؤشر ترابط.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
messages	صفيف	قائمة بالرسائل لبدء مؤشر الترابط بها.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
tool_resources	object	مجموعة من الموارد المتوفرة لأدوات المساعد في مؤشر الترابط هذا. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	مخزن المتجهات المرفق بسلسلة الرسائل هذه. يمكن أن يكون هناك مخزن متجه 1 كحد أقصى مرفق بسلسلة الرسائل.	لا
└─ vector_stores	صفيف	مساعد لإنشاء مخزن متجهات مع file_ids وإرفاقه بسلسلة الرسائل هذه. يمكن أن يكون هناك مخزن متجه 1 كحد أقصى مرفق بسلسلة الرسائل.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	threadObject

الأمثلة

مثال

إنشاء مؤشر ترابط.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Get - مؤشر ترابط

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

استرداد مؤشر ترابط.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	threadObject

الأمثلة

مثال

استرداد مؤشر ترابط.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

تعديل - مؤشر ترابط

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

تعديل مؤشر ترابط.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
tool_resources	object	مجموعة من الموارد المتوفرة لأدوات المساعد في مؤشر الترابط هذا. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة للأداة `code_interpreter` . يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	مخزن المتجهات المرفق بسلسلة الرسائل هذه. يمكن أن يكون هناك مخزن متجه 1 كحد أقصى مرفق بسلسلة الرسائل.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	threadObject

الأمثلة

مثال

تعديل مؤشر ترابط.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

حذف - مؤشر ترابط

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

حذف مؤشر ترابط.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	deleteThreadResponse

الأمثلة

مثال

يحذف سلسلة رسائل.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

القائمة - الرسائل

‏‫ملاحظة‬

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

إرجاع قائمة بالرسائل لمترابط معين.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
thread_id	path	‏‏نعم‬	string	معرف مؤشرات الترابط التي تنتمي إليها الرسائل.
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
order	استعلام	لا	string القيم المحتملة: `asc`، `desc`	ترتيب الفرز حسب الطابع `created_at` الزمني للكائنات. `asc` للترتيب التصاعدي وللترتيب `desc` التنازلي.
after	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `after` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
قبل	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `before` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، بدءا من obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.
run_id	استعلام	لا	string	تصفية الرسائل حسب معرف التشغيل الذي أنشأها.
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	listMessagesResponse

الأمثلة

مثال

قائمة الرسائل

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

إنشاء - رسالة

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

إنشاء رسالة.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب
attachments	صفيف	قائمة بالملفات المرفقة بالرسالة والأدوات التي يجب إضافتها إليها.	لا
محتوى	string	محتوى الرسالة.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
role	string	دور الكيان الذي يقوم بإنشاء الرسالة. تتضمن القيم المسموح بها ما يلي: - `user`: يشير إلى أن الرسالة يتم إرسالها بواسطة مستخدم فعلي ويجب استخدامها في معظم الحالات لتمثيل الرسائل التي أنشأها المستخدم. - `assistant`: يشير إلى إنشاء الرسالة بواسطة المساعد. استخدم هذه القيمة لإدراج رسائل من المساعد في المحادثة.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	messageObject

الأمثلة

مثال

إنشاء رسالة.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

الحصول على - رسالة

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

استرداد رسالة.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	messageObject

الأمثلة

مثال

استرداد رسالة.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

تعديل - رسالة

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

تعديل رسالة.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	messageObject

الأمثلة

مثال

تعديل رسالة.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

إنشاء - مؤشر ترابط وتشغيل

‏‫ملاحظة‬

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

إنشاء مؤشر ترابط وتشغيله في طلب واحد.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
assistant_id	string	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.	‏‏نعم‬
تعليمات	string	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد رموز الإكمال المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	لا
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد الرموز المميزة السريعة المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
نموذج	string	معرف النماذج التي سيتم استخدامها لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	لا
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا	صحيح
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
استدر	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	لا
stream_options	chatCompletionStreamOptions	خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين `stream: true`.	لا	لا شيء
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
thread	createThreadRequest		لا
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	لا
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	معرف مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
الأدوات	صفيف	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	runObject

الأمثلة

مثال

إنشاء مؤشر ترابط وتشغيله في طلب واحد.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

قائمة - عمليات التشغيل

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

إرجاع قائمة عمليات التشغيل التي تنتمي إلى مؤشر ترابط.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
thread_id	path	‏‏نعم‬	string	معرف مؤشر الترابط الذي ينتمي إليه التشغيل.
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
order	استعلام	لا	string القيم المحتملة: `asc`، `desc`	ترتيب الفرز حسب الطابع `created_at` الزمني للكائنات. `asc` للترتيب التصاعدي وللترتيب `desc` التنازلي.
after	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `after` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
قبل	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `before` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، بدءا من obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	listRunsResponse

الأمثلة

مثال

إرجاع قائمة عمليات التشغيل التي تنتمي إلى مؤشر ترابط.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

إنشاء - تشغيل

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

إنشاء تشغيل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
thread_id	path	‏‏نعم‬	string	معرف مؤشر الترابط الذي سيتم تشغيله.
تشمل []	استعلام	لا	صفيف	قائمة بالحقول الإضافية لتضمينها في الاستجابة. القيمة الوحيدة المدعومة حاليا هي `step_details.tool_calls[].file_search.results[].content` إحضار محتوى نتيجة البحث عن الملفات.
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
additional_instructions	string	إلحاق إرشادات إضافية في نهاية التعليمات الخاصة بالتشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل دون تجاوز إرشادات أخرى.	لا
additional_messages	صفيف	إضافة رسائل إضافية إلى مؤشر الترابط قبل إنشاء التشغيل.	لا
assistant_id	string	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.	‏‏نعم‬
تعليمات	string	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد رموز الإكمال المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	لا
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد الرموز المميزة السريعة المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
نموذج	string	معرف النموذج الذي سيتم استخدامه لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	لا
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا	صحيح
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
استدر	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	لا
الأدوات	صفيف	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	runObject

الأمثلة

مثال

إنشاء تشغيل.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

احصل على - تشغيل

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

استرداد تشغيل.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	runObject

الأمثلة

مثال

يحصل على تشغيل.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

تعديل - تشغيل

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

تعديل تشغيل.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	runObject

الأمثلة

مثال

تعديل تشغيل.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

إرسال - مخرجات الأداة للتشغيل

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

عندما يحتوي التشغيل على status: "requires_action" و required_action.type ، submit_tool_outputsيمكن استخدام نقطة النهاية هذه لإرسال المخرجات من استدعاءات الأداة بمجرد اكتمالها جميعا. يجب إرسال جميع المخرجات في طلب واحد.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
استدر	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	لا
tool_outputs	صفيف	قائمة بالأدوات التي يتم إرسال المخرجات لها.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	runObject

الأمثلة

مثال

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

إلغاء الأمر - تشغيل

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

إلغاء تشغيل يكون in_progress.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	runObject

الأمثلة

مثال

إلغاء تشغيل يكون in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

قائمة - خطوات التشغيل

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

إرجاع قائمة بخطوات التشغيل التي تنتمي إلى تشغيل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
thread_id	path	‏‏نعم‬	string	معرف مؤشر الترابط الذي تنتمي إليه خطوات التشغيل والتشغيل.
run_id	path	‏‏نعم‬	string	معرف التشغيل الذي تنتمي إليه خطوات التشغيل.
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
order	استعلام	لا	string القيم المحتملة: `asc`، `desc`	ترتيب الفرز حسب الطابع `created_at` الزمني للكائنات. `asc` للترتيب التصاعدي وللترتيب `desc` التنازلي.
after	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `after` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
قبل	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `before` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، بدءا من obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string
تشمل []	استعلام	لا	صفيف	قائمة بالحقول الإضافية لتضمينها في الاستجابة. القيمة الوحيدة المدعومة حاليا هي `step_details.tool_calls[].file_search.results[].content` إحضار محتوى نتيجة البحث عن الملفات.

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	listRunStepsResponse

الأمثلة

مثال

إرجاع قائمة بخطوات التشغيل التي تنتمي إلى تشغيل.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

احصل على - تشغيل الخطوة

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

استرداد خطوة تشغيل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
thread_id	path	‏‏نعم‬	string	معرف مؤشر الترابط الذي تنتمي إليه خطوة التشغيل والتشغيل.
run_id	path	‏‏نعم‬	string	معرف التشغيل الذي تنتمي إليه خطوة التشغيل.
step_id	path	‏‏نعم‬	string	معرف خطوة التشغيل لاسترداده.
تشمل []	استعلام	لا	صفيف	قائمة بالحقول الإضافية لتضمينها في الاستجابة. القيمة الوحيدة المدعومة حاليا هي `step_details.tool_calls[].file_search.results[].content` إحضار محتوى نتيجة البحث عن الملفات.
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	runStepObject

الأمثلة

مثال

استرداد خطوة تشغيل.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

قائمة - مخازن المتجهات

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

إرجاع قائمة مخازن المتجهات.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
order	استعلام	لا	string القيم المحتملة: `asc`، `desc`	ترتيب الفرز حسب الطابع `created_at` الزمني للكائنات. `asc` للترتيب التصاعدي وللترتيب `desc` التنازلي.
after	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `after` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
قبل	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `before` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، بدءا من obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	listVectorStoresResponse

الأمثلة

مثال

إرجاع قائمة مخازن المتجهات.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

إنشاء - مخزن المتجهات

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

إنشاء مخزن متجهات.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب
chunking_strategy	autoChunkingStrategyRequestParam أو staticChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` . ينطبق فقط إذا كان `file_ids` غير فارغ.	لا
expires_after	vectorStoreExpirationAfter	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
file_ids	صفيف	قائمة بمعرفات الملفات التي يجب أن يستخدمها مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
الاسم	string	اسم مخزن المتجهات.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreObject

الأمثلة

مثال

إنشاء مخزن متجهات.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get - مخزن المتجهات

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

استرداد مخزن متجهات.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreObject

الأمثلة

مثال

استرداد مخزن متجهات.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

تعديل - مخزن المتجهات

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

تعديل مخزن متجه.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب
expires_after	vectorStoreExpirationAfter	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
الاسم	string	اسم مخزن المتجهات.	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreObject

الأمثلة

مثال

تعديل مخزن متجه.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

حذف - مخزن المتجهات

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

حذف مخزن متجهات.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	deleteVectorStoreResponse

الأمثلة

مثال

حذف مخزن متجهات.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

قائمة - ملفات مخزن المتجهات

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

إرجاع قائمة بملفات مخزن المتجهات.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
vector_store_id	path	‏‏نعم‬	string	معرف مخزن المتجهات الذي تنتمي إليه الملفات.
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
order	استعلام	لا	string القيم المحتملة: `asc`، `desc`	ترتيب الفرز حسب الطابع `created_at` الزمني للكائنات. `asc` للترتيب التصاعدي وللترتيب `desc` التنازلي.
after	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `after` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
قبل	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `before` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، بدءا من obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.
filter	استعلام	لا	string القيم المحتملة: `in_progress`، `completed`، ، `failedcancelled`	التصفية حسب حالة الملف. واحد من `in_progress`، `completed`، `failed`، . `cancelled`
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	listVectorStoreFilesResponse

الأمثلة

مثال

إرجاع قائمة بملفات مخزن المتجهات.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

إنشاء - ملف مخزن المتجهات

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

إنشاء ملف مخزن متجه عن طريق إرفاق ملف بمخزن متجه.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
chunking_strategy	chunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` .	لا
file_id	string	معرف ملف يجب أن يستخدمه مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreFileObject

الأمثلة

مثال

إنشاء ملف مخزن متجه عن طريق إرفاق ملف بمخزن متجه.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - ملف مخزن المتجهات

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

استرداد ملف مخزن متجه.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreFileObject

الأمثلة

مثال

استرداد ملف مخزن متجه.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

حذف - ملف مخزن المتجهات

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

حذف ملف مخزن متجه. سيؤدي ذلك إلى إزالة الملف من مخزن المتجهات ولكن لن يتم حذف الملف نفسه. لحذف الملف، استخدم نقطة نهاية حذف الملف.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	deleteVectorStoreFileResponse

الأمثلة

مثال

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

تحديث السمات على ملف مخزن متجه.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	VectorStoreFileAttributes	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا أو قيمة منطقية أو أرقام.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreFileObject

استرداد محتوى ملف مخزن المتجهات

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

استرداد المحتويات التي تم تحليلها لملف مخزن متجه.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	VectorStoreFileContentResponse

مخزن متجهات البحث

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

ابحث في مخزن متجهات عن المجموعات ذات الصلة استنادا إلى عامل تصفية الاستعلام وسمات الملف.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	ComparisonFilter أو CompoundFilter	عامل تصفية لتطبيقه استنادا إلى سمات الملف.	لا
max_num_results	integer	الحد الأقصى لعدد النتائج التي سيتم إرجاعها. يجب أن يتراوح هذا الرقم بين 1 و50 ضمنا.	لا	10
استعلام	سلسلة أو مجموعة	سلسلة استعلام للبحث	‏‏نعم‬
ranking_options	object	خيارات تحديد المرتبة للبحث.	لا
└─ المرتبة	enum	القيم المحتملة: `auto`، `default-2024-11-15`	لا
└─ score_threshold	رقم		لا	0
rewrite_query	boolean	ما إذا كنت تريد إعادة كتابة استعلام اللغة الطبيعية للبحث عن المتجهات.	لا	خطأ

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	VectorStoreSearchResultsPage

إنشاء - دفعة ملف مخزن المتجهات

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

إنشاء دفعة ملف مخزن متجه.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
chunking_strategy	chunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` .	لا
file_ids	صفيف	قائمة بمعرفات الملفات التي يجب أن يستخدمها مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreFileBatchObject

الأمثلة

مثال

إنشاء دفعة ملف مخزن متجه.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

الاستجابات: رمز الحالة: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

احصل على - مجموعة ملف مخزن المتجهات

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

استرداد دفعة ملف مخزن متجه.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreFileBatchObject

الأمثلة

مثال

استرداد دفعة ملف مخزن متجه.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

إلغاء الأمر - دفعة ملف مخزن المتجهات

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

إلغاء دفعة ملف مخزن متجه. يحاول هذا إلغاء معالجة الملفات في هذه الدفعة في أقرب وقت ممكن.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	vectorStoreFileBatchObject

الأمثلة

مثال

إلغاء دفعة ملف مخزن متجه. يحاول هذا إلغاء معالجة الملفات في هذه الدفعة في أقرب وقت ممكن.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

القائمة - ملفات دفعة ملف مخزن المتجهات

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

إرجاع قائمة بملفات مخزن المتجهات في دفعة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
vector_store_id	path	‏‏نعم‬	string	معرف مخزن المتجهات الذي تنتمي إليه الملفات.
batch_id	path	‏‏نعم‬	string	معرف دفعة الملفات التي تنتمي إليها الملفات.
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
order	استعلام	لا	string القيم المحتملة: `asc`، `desc`	ترتيب الفرز حسب الطابع `created_at` الزمني للكائنات. `asc` للترتيب التصاعدي وللترتيب `desc` التنازلي.
after	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `after` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
قبل	استعلام	لا	string	مؤشر للاستخدام في ترقيم الصفحات. `before` هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، بدءا من obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.
filter	استعلام	لا	string القيم المحتملة: `in_progress`، `completed`، ، `failedcancelled`	التصفية حسب حالة الملف. واحد من `in_progress`، `completed`، `failed`، . `cancelled`
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار API

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	listVectorStoreFilesResponse

الأمثلة

مثال

إرجاع قائمة بملفات مخزن المتجهات.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

إنشاء - Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

إنشاء رمز مميز لواجهة برمجة التطبيقات سريعة الزوال للاستخدام في التطبيقات من جانب العميل باستخدام واجهة برمجة التطبيقات في الوقت الحقيقي. يمكن تكوينها بنفس معلمات جلسة العمل مثل session.update حدث العميل. يستجيب مع كائن جلسة عمل، بالإضافة إلى client_secret مفتاح يحتوي على رمز مميز سريع الزوال لواجهة برمجة التطبيقات يمكن استخدامه لمصادقة عملاء المتصفح لواجهة برمجة التطبيقات في الوقت الحقيقي.

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_audio_format	enum	تنسيق صوت الإدخال. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`. بالنسبة إلى `pcm16`، يجب أن يكون صوت الإدخال PCM 16 بت بمعدل عينة 24 كيلوهرتز وقناة واحدة (أحادية) وترتيب بايت ذي نهاية صغيرة. القيم المحتملة: `pcm16`، ، `g711_ulawg711_alaw`	لا
input_audio_noise_reduction	object	تكوين الحد من ضوضاء صوت الإدخال. يمكن تعيين هذا إلى `null` لإيقاف التشغيل. يعمل تقليل الضوضاء على تصفية الصوت المضاف إلى المخزن المؤقت لصوت الإدخال قبل إرساله إلى VAD والنموذج. يمكن أن تؤدي تصفية الصوت إلى تحسين VAD وتحويل دقة الكشف (تقليل الإيجابيات الزائفة) وأداء النموذج عن طريق تحسين تصور صوت الإدخال.	لا
└─ النوع	enum	نوع الحد من الضوضاء. `near_field` للميكروفونات القريبة مثل سماعات الرأس، `far_field` مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات. القيم المحتملة: `near_field`، `far_field`	لا
input_audio_transcription	object	تكوين النسخ الصوتي للإدخل، الإعدادات الافتراضية إلى إيقاف التشغيل ويمكن تعيينها إلى `null` إيقاف التشغيل مرة واحدة. النسخ الصوتي للإدخال ليس أصليا للنموذج، لأن النموذج يستهلك الصوت مباشرة. يتم تشغيل النسخ بشكل غير متزامن من خلال نقطة نهاية النسخ وينبغي التعامل معها على أنها إرشادات لمحتوى صوت الإدخال بدلا من ما سمعه النموذج بدقة. يمكن للعميل اختياريا تعيين اللغة والمطالبة بالنسخ، وهذه توفر إرشادات إضافية لخدمة النسخ.	لا
└─ اللغة	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 (على سبيل المثال `en`) إلى تحسين الدقة وزمن الوصول.	لا
└─ نموذج	string	النموذج المستخدم للنسخ، الخيارات الحالية هي `gpt-4o-transcribe`، ، ، `gpt-4o-transcribe-diarizegpt-4o-mini-transcribe`، و `gpt-4o-mini-transcribe-2025-12-15whisper-1`.	لا
└─ موجه	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. بالنسبة إلى `whisper-1`، تكون المطالبة عبارة عن قائمة بالكلمات الأساسية. بالنسبة للنماذج `gpt-4o-transcribe` ، تكون المطالبة عبارة عن سلسلة نصية مجانية، على سبيل المثال "توقع الكلمات المتعلقة بالتكنولوجيا".	لا
تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وتنسيقها، (على سبيل المثال، "كن مختصرا للغاية"، و"تصرف ودودا"، و"فيما يلي أمثلة للاستجابات الجيدة") وعلى السلوك الصوتي (على سبيل المثال، "التحدث بسرعة"، و"إدخال العاطفة في صوتك"، و"الضحك بشكل متكرر"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يعين الإرشادات الافتراضية التي سيتم استخدامها إذا لم يتم تعيين هذا الحقل وتكون مرئية `session.created` في الحدث في بداية جلسة العمل.	لا
max_response_output_tokens	عدد صحيح أو سلسلة	الحد الأقصى لعدد الرموز المميزة للإخراج لاستجابة مساعد واحد، بما في ذلك استدعاءات الأدوات. توفير عدد صحيح بين 1 و4096 للحد من الرموز المميزة للإخراج، أو `inf` للحد الأقصى من الرموز المميزة المتاحة لنموذج معين. الإعدادات الافتراضية لـ `inf`.	لا
طرائق		مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا إلى ["نص"].	لا
نموذج	string	اسم النشر المستخدم لجلسة العمل هذه.	لا
output_audio_format	enum	تنسيق صوت الإخراج. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`. بالنسبة إلى `pcm16`، يتم أخذ عينات من صوت الإخراج بمعدل 24 كيلوهرتز. القيم المحتملة: `pcm16`، ، `g711_ulawg711_alaw`	لا
درجة الحرارة	رقم	درجة حرارة أخذ العينات للنموذج، تقتصر على [0.6، 1.2]. بالنسبة لنماذج الصوت، يوصى بدرجة حرارة 0.8 للحصول على أفضل أداء.	لا	0.8
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي `auto`أو `nonerequired`أو أو تحديد دالة.	لا	تلقائي
الأدوات	صفيف	الأدوات (الوظائف) المتوفرة للنموذج.	لا
turn_detection	object	تكوين الكشف عن الدور أو ether Server VAD أو VAD الدلالي. يمكن تعيين هذا إلى `null` إيقاف التشغيل، وفي هذه الحالة يجب على العميل تشغيل استجابة النموذج يدويا. يعني خادم VAD أن النموذج سيكشف عن بدء الكلام ونهاته استنادا إلى مستوى الصوت والاستجابة في نهاية كلام المستخدم. يعد VAD الدلالي أكثر تقدما ويستخدم نموذج الكشف عن الأدوار (بالاقتران مع VAD) لتقدير ما إذا كان المستخدم قد انتهى من التحدث بشكل دلالي، ثم يعين مهلة ديناميكيا استنادا إلى هذا الاحتمال. على سبيل المثال، إذا تم إيقاف تشغيل صوت المستخدم باستخدام `uhhm`، فسيسجل النموذج احتمالا منخفضا بانتهاء الدوران والانتظار لفترة أطول حتى يستمر المستخدم في التحدث. يمكن أن يكون هذا مفيدا للمحادثات الأكثر طبيعية، ولكن قد يكون له زمن انتقال أعلى.	لا
└─ create_response	boolean	ما إذا كان يجب إنشاء استجابة تلقائيا عند حدوث حدث إيقاف VAD أم لا.	لا	صحيح
└─ الشغف	enum	يستخدم فقط في `semantic_vad` الوضع. رغبة النموذج في الاستجابة. `low` سينتظر المستخدم لفترة أطول حتى يستمر في التحدث، `high` وسيستجيب بسرعة أكبر. `auto` هو الافتراضي ومكافئ ل `medium`. القيم المحتملة: `low`، `medium`، ، `highauto`	لا
└─ interrupt_response	boolean	ما إذا كنت تريد مقاطعة أي استجابة مستمرة تلقائيا مع إخراج للمحادثة الافتراضية (أي `conversation` من `auto`) عند حدوث حدث بدء VAD.	لا	صحيح
└─ prefix_padding_ms	integer	يستخدم فقط في `server_vad` الوضع. مقدار الصوت المطلوب تضمينه قبل الكشف عن الكلام في VAD (بالمللي ثانية). الافتراضيات إلى 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	يستخدم فقط في `server_vad` الوضع. مدة الصمت للكشف عن توقف الكلام (بالمللي ثانية). الافتراضيات إلى 500 مللي ثانية. مع القيم الأقصر، سيستجيب النموذج بسرعة أكبر، ولكن قد يقفز في الإيقاف المؤقت القصير من المستخدم.	لا
└─ عتبة	رقم	يستخدم فقط في `server_vad` الوضع. حد التنشيط ل VAD (0.0 إلى 1.0)، هذا افتراضيا إلى 0.5. سيتطلب الحد الأعلى صوت أعلى لتنشيط النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات الصاخبة.	لا
└─ النوع	enum	نوع الكشف عن الأدوار. القيم المحتملة: `server_vad`، `semantic_vad`	لا
صوت	VoiceIdsShared		لا

الاستجابات

رمز الحالة: 200

الوصف: تم إنشاء جلسة العمل بنجاح.

Content-Type	Type	الوصف
application/json	RealtimeSessionCreateResponse

إنشاء - وقت النسخ

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

إنشاء رمز مميز لواجهة برمجة التطبيقات سريعة الزوال للاستخدام في التطبيقات من جانب العميل باستخدام واجهة برمجة التطبيقات في الوقت الحقيقي خصيصا للنسخ في الوقت الفعلي. يمكن تكوينها بنفس معلمات جلسة العمل مثل transcription_session.update حدث العميل. يستجيب مع كائن جلسة عمل، بالإضافة إلى client_secret مفتاح يحتوي على رمز مميز سريع الزوال لواجهة برمجة التطبيقات يمكن استخدامه لمصادقة عملاء المتصفح لواجهة برمجة التطبيقات في الوقت الحقيقي.

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
include	صفيف	مجموعة العناصر المراد تضمينها في النسخ. العناصر المتوفرة الحالية هي: - `item.input_audio_transcription.logprobs`	لا
input_audio_format	enum	تنسيق صوت الإدخال. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`. بالنسبة إلى `pcm16`، يجب أن يكون صوت الإدخال PCM 16 بت بمعدل عينة 24 كيلوهرتز وقناة واحدة (أحادية) وترتيب بايت ذي نهاية صغيرة. القيم المحتملة: `pcm16`، ، `g711_ulawg711_alaw`	لا
input_audio_noise_reduction	object	تكوين الحد من ضوضاء صوت الإدخال. يمكن تعيين هذا إلى `null` لإيقاف التشغيل. يعمل تقليل الضوضاء على تصفية الصوت المضاف إلى المخزن المؤقت لصوت الإدخال قبل إرساله إلى VAD والنموذج. يمكن أن تؤدي تصفية الصوت إلى تحسين VAD وتحويل دقة الكشف (تقليل الإيجابيات الزائفة) وأداء النموذج عن طريق تحسين تصور صوت الإدخال.	لا
└─ النوع	enum	نوع الحد من الضوضاء. `near_field` للميكروفونات القريبة مثل سماعات الرأس، `far_field` مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات. القيم المحتملة: `near_field`، `far_field`	لا
input_audio_transcription	object	تكوين النسخ الصوتي للإدخل. يمكن للعميل اختياريا تعيين اللغة والمطالبة بالنسخ، وهذه توفر إرشادات إضافية لخدمة النسخ.	لا
└─ اللغة	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 (على سبيل المثال `en`) إلى تحسين الدقة وزمن الوصول.	لا
└─ نموذج	enum	النموذج المراد استخدامه للنسخ ، والخيارات الحالية هي `gpt-4o-transcribe`، `gpt-4o-mini-transcribe`و `gpt-4o-mini-transcribe-2025-12-15`، و `whisper-1`. القيم المحتملة: `gpt-4o-transcribe`، `gpt-4o-mini-transcribe`، ، `gpt-4o-mini-transcribe-2025-12-15whisper-1`	لا
└─ موجه	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. بالنسبة إلى `whisper-1`، تكون المطالبة عبارة عن قائمة بالكلمات الأساسية. بالنسبة للنماذج `gpt-4o-transcribe` ، تكون المطالبة عبارة عن سلسلة نصية مجانية، على سبيل المثال "توقع الكلمات المتعلقة بالتكنولوجيا".	لا
طرائق		مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا إلى ["نص"].	لا
turn_detection	object	تكوين الكشف عن الدور أو ether Server VAD أو VAD الدلالي. يمكن تعيين هذا إلى `null` إيقاف التشغيل، وفي هذه الحالة يجب على العميل تشغيل استجابة النموذج يدويا. يعني خادم VAD أن النموذج سيكشف عن بدء الكلام ونهاته استنادا إلى مستوى الصوت والاستجابة في نهاية كلام المستخدم. يعد VAD الدلالي أكثر تقدما ويستخدم نموذج الكشف عن الأدوار (بالاقتران مع VAD) لتقدير ما إذا كان المستخدم قد انتهى من التحدث بشكل دلالي، ثم يعين مهلة ديناميكيا استنادا إلى هذا الاحتمال. على سبيل المثال، إذا تم إيقاف تشغيل صوت المستخدم باستخدام `uhhm`، فسيسجل النموذج احتمالا منخفضا بانتهاء الدوران والانتظار لفترة أطول حتى يستمر المستخدم في التحدث. يمكن أن يكون هذا مفيدا للمحادثات الأكثر طبيعية، ولكن قد يكون له زمن انتقال أعلى.	لا
└─ create_response	boolean	ما إذا كان يجب إنشاء استجابة تلقائيا عند حدوث حدث إيقاف VAD أم لا. غير متوفر لجلسات النسخ.	لا	صحيح
└─ الشغف	enum	يستخدم فقط في `semantic_vad` الوضع. رغبة النموذج في الاستجابة. `low` سينتظر المستخدم لفترة أطول حتى يستمر في التحدث، `high` وسيستجيب بسرعة أكبر. `auto` هو الافتراضي ومكافئ ل `medium`. القيم المحتملة: `low`، `medium`، ، `highauto`	لا
└─ interrupt_response	boolean	ما إذا كنت تريد مقاطعة أي استجابة مستمرة تلقائيا مع إخراج للمحادثة الافتراضية (أي `conversation` من `auto`) عند حدوث حدث بدء VAD. غير متوفر لجلسات النسخ.	لا	صحيح
└─ prefix_padding_ms	integer	يستخدم فقط في `server_vad` الوضع. مقدار الصوت المطلوب تضمينه قبل الكشف عن الكلام في VAD (بالمللي ثانية). الافتراضيات إلى 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	يستخدم فقط في `server_vad` الوضع. مدة الصمت للكشف عن توقف الكلام (بالمللي ثانية). الافتراضيات إلى 500 مللي ثانية. مع القيم الأقصر، سيستجيب النموذج بسرعة أكبر، ولكن قد يقفز في الإيقاف المؤقت القصير من المستخدم.	لا
└─ عتبة	رقم	يستخدم فقط في `server_vad` الوضع. حد التنشيط ل VAD (0.0 إلى 1.0)، هذا افتراضيا إلى 0.5. سيتطلب الحد الأعلى صوت أعلى لتنشيط النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات الصاخبة.	لا
└─ النوع	enum	نوع الكشف عن الأدوار. القيم المحتملة: `server_vad`، `semantic_vad`	لا

الاستجابات

رمز الحالة: 200

الوصف: تم إنشاء جلسة العمل بنجاح.

Content-Type	Type	الوصف
application/json	RealtimeTranscriptionSessionCreateResponse

الاستجابات

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

ينشئ استجابة نموذجية.

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
include	صفيف		لا
الادخال	سلسلة أو مجموعة	مدخلات النموذج	‏‏نعم‬
تعليمات	string	إدراج رسالة نظام (أو مطور) كعنصر أول في سياق النموذج. عند استخدام جنبا إلى جنب مع `previous_response_id`، لن يتم نقل الإرشادات من استجابة سابقة إلى الاستجابة التالية. وهذا يجعل من السهل تبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية وحالة المحادثة.	لا
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار. تعرف على المزيد حول حالة المحادثة.	لا
المنطق	Reasoning	خيارات التكوين لنماذج المنطق.	لا
store	boolean	ما إذا كنت تريد تخزين استجابة النموذج التي تم إنشاؤها للاسترداد لاحقا عبر واجهة برمجة التطبيقات.	لا	صحيح
استدر	boolean	إذا تم تعيينها إلى true، دفق بيانات استجابة النموذج إلى العميل كما يتم إنشاؤها باستخدام الأحداث المرسلة من الخادم. راجع قسم Streaming أدناه لمزيد من المعلومات.	لا	خطأ
نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ التنسيق	TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين `{ "type": "json_schema" }` المخرجات المنظمة، مما يضمن تطابق النموذج مع مخطط JSON المقدم. التنسيق الافتراضي مع `{ "type": "text" }` عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: الإعداد لتمكين `{ "type": "json_object" }` وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام `json_schema` للنماذج التي تدعمه.	لا
tool_choice	ToolChoiceOptions أو ToolChoiceTypes أو ToolChoiceFunction	كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة `tools` لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.	لا
الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. يمكنك تحديد الأداة التي يجب استخدامها عن طريق تعيين المعلمة `tool_choice` . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج	لا
اقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - `auto`: إذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج، فسيقتطاع النموذج الاستجابة لاحتواء نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (افتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، فسيفشل الطلب مع حدوث خطأ 400. القيم المحتملة: `auto`، `disabled`	لا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	response
نص/دفق الأحداث	responseStreamEvent

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

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

Content-Type	Type	الوصف
application/json	errorResponse

واجهة برمجة تطبيقات الاستجابات - عناصر الإدخال

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

استرداد استجابة نموذج باستخدام المعرف المحدد.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	response

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

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

Content-Type	Type	الوصف
application/json	errorResponse

حذف الرد

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

حذف استجابة نموذج بالمعرف المحدد.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

رمز الحالة: 404

الوصف: غير موجود

Content-Type	Type	الوصف
application/json	error

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

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

Content-Type	Type	الوصف
application/json	errorResponse

واجهة برمجة تطبيقات الاستجابات - قائمة عناصر الاستجابة

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

إرجاع قائمة بعناصر الإدخال لاستجابة معينة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	عنوان URL للسلسلة	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai. azure.com
response_id	path	‏‏نعم‬	string	معرف الاستجابة لاسترداد عناصر الإدخال ل.
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
order	استعلام	لا	string القيم المحتملة: `asc`، `desc`	ترتيب إرجاع عناصر الإدخال فيه. القيمة الافتراضية هي `asc`. - `asc`: إرجاع عناصر الإدخال بترتيب تصاعدي. - `desc`: إرجاع عناصر الإدخال بترتيب تنازلي.
after	استعلام	لا	string	معرف عنصر لسرد العناصر بعد، يستخدم في ترقيم الصفحات.
قبل	استعلام	لا	string	معرف عنصر لسرد العناصر من قبل، يستخدم في ترقيم الصفحات.

رأس الطلب

الاسم	مطلوب	النوع	وصف
Authorization	صحيح	string	مثال: `Authorization: Bearer {Azure_OpenAI_Auth_Token}` لنشاء رمز مميز للمصادقة باستخدام Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` النوع: oauth2 عنوان Url للتخويل: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` النطاق: `https://ai.azure.com/.default`
api-key	صحيح	string	توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

الاستجابات

رمز الحالة: 200

وصف: حسنا

Content-Type	Type	الوصف
application/json	responseItemList

مكونات

errorResponse

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

errorBase

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

خطأ

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

innerError

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

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

innerErrorCode

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

الخاصية	قيمة
الوصف	رموز الخطأ لكائن الخطأ الداخلي.
Type	string
Values	`ResponsibleAIPolicyViolation`

dalleErrorResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	dalleError		لا

dalleError

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

dalleInnerError

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

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

contentFilterCompletionTextSpan

توضح هذه المقالة امتدادا ضمن نص الإكمال الذي تم إنشاؤه. الإزاحة 0 هي أول نقطة تعليمة برمجية UTF32 لنص الإكمال.

الاسم	النوع	وصف	مطلوب	الإفتراضي
completion_end_offset	integer	إزاحة نقطة التعليمات البرمجية UTF32 الأولى التي يتم استبعادها من النطاق. هذا الحقل يساوي دائما completion_start_offset للامتدادات الفارغة. هذا الحقل أكبر دائما من completion_start_offset للامتدادات غير الفارغة.	‏‏نعم‬
completion_start_offset	integer	إزاحة نقطة التعليمات البرمجية UTF32 التي تبدأ النطاق.	‏‏نعم‬

contentFilterResultBase

الاسم	النوع	وصف	مطلوب	الإفتراضي
filtered	boolean		‏‏نعم‬

contentFilterSeverityResult

الاسم	النوع	وصف	مطلوب	الإفتراضي
filtered	boolean		‏‏نعم‬
severity	string		لا

contentFilterDetectedResult

الاسم	النوع	وصف	مطلوب	الإفتراضي
detected	boolean		لا
filtered	boolean		‏‏نعم‬

contentFilterDetectedWithCitationResult

الاسم	النوع	مطلوب
citation	object	لا
└─ عنوان URL	string	لا
└─ الترخيص	string	لا

contentFilterDetectedWithCompletionTextSpansResult

الاسم	النوع	وصف	مطلوب	الإفتراضي
details	صفيف		لا

contentFilterIdResult

الاسم	النوع	وصف	مطلوب	الإفتراضي
filtered	boolean		‏‏نعم‬
المعرف	string		لا

contentFilterResultsBase

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

الاسم	النوع	وصف	مطلوب
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للشرائح التي تمت تصفيتها.	لا
خطأ	errorBase		لا
hate	contentFilterSeverityResult		لا
profanity	contentFilterDetectedResult		لا
self_harm	contentFilterSeverityResult		لا
sexual	contentFilterSeverityResult		لا
violence	contentFilterSeverityResult		لا

contentFilterPromptResults

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

الاسم	النوع	وصف	مطلوب
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للشرائح التي تمت تصفيتها.	لا
خطأ	errorBase		لا
hate	contentFilterSeverityResult		لا
indirect_attack	contentFilterDetectedResult		لا
jailbreak	contentFilterDetectedResult		لا
profanity	contentFilterDetectedResult		لا
self_harm	contentFilterSeverityResult		لا
sexual	contentFilterSeverityResult		لا
violence	contentFilterSeverityResult		لا

contentFilterChoiceResults

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

الاسم	النوع	وصف	مطلوب
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للشرائح التي تمت تصفيتها.	لا
خطأ	errorBase		لا
hate	contentFilterSeverityResult		لا
profanity	contentFilterDetectedResult		لا
protected_material_code	contentFilterDetectedWithCitationResult		لا
protected_material_text	contentFilterDetectedResult		لا
self_harm	contentFilterSeverityResult		لا
sexual	contentFilterSeverityResult		لا
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		لا
violence	contentFilterSeverityResult		لا

contentFilterDetailedResults

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
details	صفيف		لا
filtered	boolean		‏‏نعم‬

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

الاسم	النوع	مطلوب
hate	contentFilterSeverityResult	لا
self_harm	contentFilterSeverityResult	لا
sexual	contentFilterSeverityResult	لا
violence	contentFilterSeverityResult	لا

dalleFilterResults

الاسم	النوع	وصف	مطلوب
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للشرائح التي تمت تصفيتها.	لا
hate	contentFilterSeverityResult		لا
jailbreak	contentFilterDetectedResult		لا
profanity	contentFilterDetectedResult		لا
self_harm	contentFilterSeverityResult		لا
sexual	contentFilterSeverityResult		لا
violence	contentFilterSeverityResult		لا

chatCompletionsRequestCommon

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

createCompletionRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
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
فوري	سلسلة أو مجموعة	المطالبة (المطالبات) لإنشاء عمليات إكمال، مرمزة كسلسلة، أو صفيف من السلاسل، أو صفيف من الرموز المميزة، أو صفيف من صفائف الرمز المميز. لاحظ أن <\|endoftext\|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، لذلك إذا لم يتم تحديد مطالبة، فسينشئ النموذج كما لو كان من بداية مستند جديد.	‏‏نعم‬
seed	integer	إذا تم تحديده ، يبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات `seed` المتكررة بنفس المعلمات والمعلمات نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة `system_fingerprint` لمراقبة التغييرات في الخلفية.	لا
stop	سلسلة أو مجموعة	ما يصل إلى 4 تسلسلات حيث تتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف.	لا
استدر	boolean	سواء كنت تريد إرجاع التقدم الجزئي أم لا. في حالة التعيين، يتم إرسال الرموز المميزة كأحداث مرسلة من الخادم للبيانات فقط عند توفرها، مع إنهاء البث بواسطة رسالة `data: [DONE]` . مثال على تعليمة Python البرمجية.	لا	خطأ
لاحقه	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

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

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

createChatCompletionRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
صوتي	object	معلمات لإخراج الصوت. مطلوب عند طلب إخراج الصوت باستخدام `modalities: ["audio"]`.	لا
└─ التنسيق	enum	تحديد تنسيق صوت الإخراج. يجب أن يكون واحدا من `wav`أو `mp3flac`أو `opus`.`pcm16` القيم المحتملة: `wav`، `mp3`، `flac`، ، `opuspcm16`	لا
└─ صوت	enum	تحديد نوع الصوت. الأصوات المدعومة هي `alloy`و `echofable`و`onyxnova`.`shimmer` القيم المحتملة: `alloy`، `echo`، `fable`، `onyx`، ، `novashimmer`	لا
data_sources	صفيف	إدخالات التكوين Azure ملحقات دردشة OpenAI التي تستخدمها. هذه المواصفات الإضافية متوافقة فقط مع Azure OpenAI.	لا
frequency_penalty	رقم	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي.	لا	0
function_call	سلسلة أو chatCompletionFunctionCallOption	مهمل لصالح `tool_choice`. عناصر التحكم التي يتم استدعاء الدالة (إن وجدت) بواسطة النموذج. `none` يعني أن النموذج لن يستدعي دالة وبدلا من ذلك ينشئ رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء دالة. تحديد دالة معينة عبر `{"name": "my_function"}` يفرض على النموذج استدعاء تلك الدالة. `none` هو الافتراضي عندما لا تكون هناك دالات. `auto` هو الافتراضي إذا كانت الدالات موجودة.	لا
functions	صفيف	مهمل لصالح `tools`. قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها.	لا
logit_bias	object	تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في الرمز المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. يختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو اختيار حصري للرمز المميز ذي الصلة.	لا	لا شيء
سجلات الحماية	boolean	ما إذا كان يجب إرجاع احتمالات السجل للرمز المميزة للإخراج أم لا. إذا كان صحيحا، فترجع احتمالات السجل لكل رمز مميز للإخراج تم إرجاعه في `content` من `message`.	لا	خطأ
max_completion_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها لإكمالها، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية.	لا
max_tokens	integer	الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها في إكمال الدردشة. يحد طول إجمالي رموز الإدخال المميزة والرموز المميزة التي تم إنشاؤها من خلال طول سياق النموذج.	لا
messages	صفيف	قائمة بالرسائل التي تتضمن المحادثة حتى الآن. مثال على تعليمة Python البرمجية.	‏‏نعم‬
metadata	object	العلامات والقيم المعرفة من قبل المطور المستخدمة لتصفية الإكمال في لوحة معلومات الإكمال المخزنة.	لا
طرائق	ChatCompletionModalities	أنواع الإخراج التي ترغب في أن ينشئها النموذج لهذا الطلب. معظم النماذج قادرة على إنشاء نص، وهو الافتراضي: `["text"]` `gpt-4o-audio-preview` يمكن أيضا استخدام النموذج لإنشاء الصوت. لطلب إنشاء هذا النموذج استجابات نصية وصوتية، يمكنك استخدام: `["text", "audio"]`	لا
n	integer	كم عدد خيارات إكمال الدردشة التي يجب إنشاؤها لكل رسالة إدخال. لاحظ أنه سيتم تحصيل رسوم منك استنادا إلى عدد الرموز المميزة التي تم إنشاؤها عبر جميع الخيارات. احتفظ `n` بأدنى `1` قدر من التكاليف.	لا	1
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا	صحيح
prediction	PredictionContent	تكوين الإخراج المتوقع، والذي يمكن أن يحسن أوقات الاستجابة بشكل كبير عندما تكون أجزاء كبيرة من استجابة النموذج معروفة مسبقا. هذا هو الأكثر شيوعا عند إعادة إنشاء ملف مع تغييرات طفيفة فقط على معظم المحتوى.	لا
presence_penalty	رقم	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج.	لا	0
reasoning_effort	enum	نماذج o1 فقط يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي `low`و `medium`و.`high` يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. القيم المحتملة: `low`، ، `mediumhigh`	لا
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` لمراقبة التغييرات في الخلفية.	لا
stop	سلسلة أو مجموعة	ما يصل إلى 4 تسلسلات حيث تتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة.	لا
store	boolean	ما إذا كان يجب تخزين إخراج طلب إكمال الدردشة هذا أم لا للاستخدام في منتجات تقطير النموذج أو التقييم.	لا
استدر	boolean	إذا تم تعيينه ، يتم إرسال دلتا الرسائل الجزئية ، كما هو الحال في ChatGPT. يتم إرسال الرموز المميزة كأحداث مرسلة من الخادم للبيانات فقط عند توفرها، مع إنهاء الدفق برسالة `data: [DONE]` . مثال على تعليمة Python البرمجية.	لا	خطأ
stream_options	chatCompletionStreamOptions	خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين `stream: true`.	لا	لا شيء
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	لا	1
tool_choice	chatCompletionToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. `auto` يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر. تحديد أداة معينة عبر `{"type": "function", "function": {"name": "my_function"}}` يفرض على النموذج استدعاء تلك الأداة. `none` هو الافتراضي عندما لا تكون هناك أدوات موجودة. `auto` هو الافتراضي إذا كانت الأدوات موجودة.	لا
الأدوات	صفيف	قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. يتم دعم 128 وظيفة كحد أقصى.	لا
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن. `logprobs` يجب تعيين إلى `true` إذا تم استخدام هذه المعلمة.	لا
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	لا	1
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	لا
user_security_context	userSecurityContext	يحتوي سياق أمان المستخدم على العديد من المعلمات التي تصف تطبيق الذكاء الاصطناعي نفسه، والمستخدم النهائي الذي يتفاعل مع تطبيق الذكاء الاصطناعي. تساعد هذه الحقول فرق عمليات الأمان الخاصة بك على التحقيق في الحوادث الأمنية والتخفيف من حدتها من خلال توفير نهج شامل لحماية تطبيقاتك الذكاء الاصطناعي. تعرف على المزيد حول حماية تطبيقات الذكاء الاصطناعي باستخدام Microsoft Defender for Cloud.	لا

userSecurityContext

يحتوي سياق أمان المستخدم على العديد من المعلمات التي تصف تطبيق الذكاء الاصطناعي نفسه، والمستخدم النهائي الذي يتفاعل مع تطبيق الذكاء الاصطناعي. تساعد هذه الحقول فرق عمليات الأمان الخاصة بك على التحقيق في الحوادث الأمنية والتخفيف من حدتها من خلال توفير نهج شامل لحماية تطبيقاتك الذكاء الاصطناعي. تعرف على المزيد حول حماية تطبيقات الذكاء الاصطناعي باستخدام Microsoft Defender for Cloud.

الاسم	النوع	وصف	مطلوب
application_name	string	اسم التطبيق. يجب عدم تضمين المعلومات الشخصية الحساسة في هذا الحقل.	لا
end_user_id	string	هذا المعرف هو معرف كائن المستخدم Microsoft Entra ID (Azure Active Directory سابقا) المستخدم لمصادقة المستخدمين النهائيين داخل تطبيق الذكاء الاصطناعي التوليدي. يجب عدم تضمين المعلومات الشخصية الحساسة في هذا الحقل.	لا
end_user_tenant_id	string	معرف المستأجر Microsoft 365 الذي ينتمي إليه المستخدم النهائي. وهو مطلوب عندما يكون تطبيق الذكاء الاصطناعي التوليدي متعدد المستأجرين.	لا
source_ip	string	يلتقط عنوان IP الخاص بالعميل الأصلي، ويقبل تنسيقي IPv4 وIPv6.	لا

chatCompletionFunctions

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

chatCompletionFunctionCallOption

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

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

chatCompletionFunctionParameters

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

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

chatCompletionRequestMessage

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

ChatCompletionRequestDeveloperMessage
chatCompletionRequestSystemMessage
chatCompletionRequestUserMessage
chatCompletionRequestAssistantMessage
chatCompletionRequestToolMessage
chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

الإرشادات التي يوفرها المطور والتي يجب أن يتبعها النموذج، بغض النظر عن الرسائل المرسلة من قبل المستخدم. مع نماذج o1 وأحدث، developer تحل الرسائل محل الرسائل السابقة system .

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

chatCompletionRequestSystemMessage

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

chatCompletionRequestUserMessage

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

chatCompletionRequestAssistantMessage

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

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatCompletionRequestDeveloperMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestMessageContentPartText
chatCompletionRequestMessageContentPartImage
chatCompletionRequestMessageContentPartAudio

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestMessageContentPartText
chatCompletionRequestMessageContentPartRefusal

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	محتوى النص.	‏‏نعم‬
النوع	enum	نوع جزء المحتوى. القيم المحتملة: `text`	‏‏نعم‬

chatCompletionRequestMessageContentPartAudio

الاسم	النوع	وصف	مطلوب
input_audio	object		‏‏نعم‬
└─ البيانات	string	بيانات صوتية مشفرة Base64.	لا
└─ التنسيق	enum	تنسيق البيانات الصوتية المشفرة. يدعم حاليا "wav" و"mp3". القيم المحتملة: `wav`، `mp3`	لا
النوع	enum	نوع جزء المحتوى. دائمًا `input_audio`. القيم المحتملة: `input_audio`	‏‏نعم‬

chatCompletionRequestMessageContentPartImage

الاسم	النوع	وصف	مطلوب
image_url	object		‏‏نعم‬
└─ التفاصيل	enum	تحديد مستوى تفاصيل الصورة. تعرف على المزيد في دليل Vision. القيم المحتملة: `auto`، ، `lowhigh`	لا
└─ عنوان URL	string	إما عنوان URL للصورة أو بيانات الصورة المشفرة base64.	لا
النوع	enum	نوع جزء المحتوى. القيم المحتملة: `image_url`	‏‏نعم‬

chatCompletionRequestMessageContentPartRefusal

الاسم	النوع	وصف	مطلوب	الإفتراضي
رفض	string	رسالة الرفض التي أنشأها النموذج.	‏‏نعم‬
النوع	enum	نوع جزء المحتوى. القيم المحتملة: `refusal`	‏‏نعم‬

azureChatExtensionConfiguration

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

###Discriminator ل azureChatExtensionConfiguration

يستخدم هذا المكون الخاصية type للتمييز بين أنواع مختلفة:

قيمة النوع	Schema
`azure_search`	azureSearchChatExtensionConfiguration
`azure_cosmos_db`	azureCosmosDBChatExtensionConfiguration
`elasticsearch`	elasticsearchChatExtensionConfiguration
`mongo_db`	mongoDBChatExtensionConfiguration
`pinecone`	pineconeChatExtensionConfiguration

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

azureChatExtensionType

الخاصية	قيمة
الوصف	تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.
Type	string
Values	`azure_search` `azure_cosmos_db` `elasticsearch` `mongo_db` `pinecone`

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

معلمات Azure Search عند استخدامها كملحق دردشة Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
allow_partial_result	boolean	إذا تم تحديده على أنه صحيح، فسيسمح النظام باستخدام نتائج البحث الجزئية ويفشل الطلب إذا فشلت جميع الاستعلامات. إذا لم يتم تحديده، أو تم تحديده على أنه خطأ، فسيفشل الطلب إذا فشل أي استعلام بحث.	لا	خطأ
المصادقه	onYourDataApiKeyAuthenticationOptions أو onYourDataSystemAssignedManagedIdentityAuthenticationOptions أو onYourDataUserAssignedManagedIdentityAuthenticationOptions أو onYourDataAccessTokenAuthenticationOptions		‏‏نعم‬
embedding_dependency	onYourDataEndpointVectorizationSource أو onYourDataDeploymentNameVectorizationSource أو onYourDataIntegratedVectorizationSource		لا
نقطه النهايه	string	مسار نقطة النهاية المطلق لمورد Azure Search المراد استخدامه.	‏‏نعم‬
fields_mapping	azureSearchIndexFieldMappingOptions	إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Search تم تكوينه.	لا
filter	string	عامل تصفية البحث.	لا
in_scope	boolean	ما إذا كان يجب تقييد الاستعلامات لاستخدام البيانات المفهرسة.	لا
include_contexts	صفيف	الخصائص المضمنة لسياق الإخراج. إذا لم يتم تحديدها، فإن القيمة الافتراضية هي `citations` و `intent`.	لا
index_name	string	اسم الفهرس المراد استخدامه كما هو متوفر في مورد Azure Search المشار إليه.	‏‏نعم‬
max_search_queries	integer	يجب إرسال الحد الأقصى لعدد الاستعلامات المعاد كتابتها إلى موفر البحث لرسالة مستخدم واحدة. إذا لم يتم تحديده، فسيقرر النظام عدد الاستعلامات التي سيتم إرسالها.	لا
query_type	azureSearchQueryType	نوع استعلام استرداد Azure Search الذي يجب تنفيذه عند استخدامه كملحق دردشة Azure OpenAI.	لا
semantic_configuration	string	التكوين الدلالي الإضافي للاستعلام.	لا
strictness	integer	الصرامة المكونة لتصفية صلة البحث. أعلى من الصرامة، وأعلى من الدقة ولكن أقل استدعاء للإجابة.	لا
top_n_documents	integer	العدد الأعلى للمستندات المكونة للميزة للاستعلام الذي تم تكوينه.	لا

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

الخاصية	قيمة
الوصف	نوع استعلام استرداد Azure Search الذي يجب تنفيذه عند استخدامه كملحق دردشة Azure OpenAI.
Type	string
Values	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

azureCosmosDBChatExtensionConfiguration

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعلمات	azureCosmosDBChatExtensionParameters	المعلمات التي يجب استخدامها عند تكوين Azure OpenAI على ملحقات دردشة بياناتك عند استخدام Azure Cosmos DB ل MongoDB vCore.	لا
النوع	azureChatExtensionType	تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	‏‏نعم‬

azureCosmosDBChatExtensionParameters

المعلمات التي يجب استخدامها عند تكوين Azure OpenAI على ملحقات دردشة بياناتك عند استخدام Azure Cosmos DB ل MongoDB vCore.

الاسم	النوع	وصف	مطلوب	الإفتراضي
allow_partial_result	boolean	إذا تم تحديده على أنه صحيح، فسيسمح النظام باستخدام نتائج البحث الجزئية ويفشل الطلب إذا فشلت جميع الاستعلامات. إذا لم يتم تحديده، أو تم تحديده على أنه خطأ، فسيفشل الطلب إذا فشل أي استعلام بحث.	لا	خطأ
المصادقه	onYourDataConnectionStringAuthenticationOptions	خيارات المصادقة Azure OpenAI على بياناتك عند استخدام connection string.	‏‏نعم‬
container_name	string	اسم حاوية موارد Azure Cosmos DB.	‏‏نعم‬
database_name	string	اسم قاعدة بيانات MongoDB vCore لاستخدامها مع Azure Cosmos DB.	‏‏نعم‬
embedding_dependency	onYourDataEndpointVectorizationSource أو onYourDataDeploymentNameVectorizationSource		‏‏نعم‬
fields_mapping	azureCosmosDBFieldMappingOptions	إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد تم تكوينه Azure Cosmos DB.	‏‏نعم‬
in_scope	boolean	ما إذا كان يجب تقييد الاستعلامات لاستخدام البيانات المفهرسة.	لا
include_contexts	صفيف	الخصائص المضمنة لسياق الإخراج. إذا لم يتم تحديدها، فإن القيمة الافتراضية هي `citations` و `intent`.	لا
index_name	string	اسم فهرس MongoDB vCore لاستخدامه مع Azure Cosmos DB.	‏‏نعم‬
max_search_queries	integer	يجب إرسال الحد الأقصى لعدد الاستعلامات المعاد كتابتها إلى موفر البحث لرسالة مستخدم واحدة. إذا لم يتم تحديده، فسيقرر النظام عدد الاستعلامات التي سيتم إرسالها.	لا
strictness	integer	الصرامة المكونة لتصفية صلة البحث. أعلى من الصرامة، وأعلى من الدقة ولكن أقل استدعاء للإجابة.	لا
top_n_documents	integer	العدد الأعلى للمستندات المكونة للميزة للاستعلام الذي تم تكوينه.	لا

azureCosmosDBFieldMappingOptions

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

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

elasticsearchChatExtensionConfiguration

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

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

elasticsearchChatExtensionParameters

المعلمات التي يجب استخدامها عند تكوين ElasticsearchÂ® كملحق دردشة Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
allow_partial_result	boolean	إذا تم تحديده على أنه صحيح، فسيسمح النظام باستخدام نتائج البحث الجزئية ويفشل الطلب إذا فشلت جميع الاستعلامات. إذا لم يتم تحديده، أو تم تحديده على أنه خطأ، فسيفشل الطلب إذا فشل أي استعلام بحث.	لا	خطأ
المصادقه	onYourDataKeyAndKeyIdAuthenticationOptions أو onYourDataEncodedApiKeyAuthenticationOptions		‏‏نعم‬
embedding_dependency	onYourDataEndpointVectorizationSource أو onYourDataDeploymentNameVectorizationSource أو onYourDataModelIdVectorizationSource		لا
نقطه النهايه	string	نقطة نهاية ElasticsearchÂ®.	‏‏نعم‬
fields_mapping	elasticsearchIndexFieldMappingOptions	إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد ElasticsearchÂ® مكون.	لا
in_scope	boolean	ما إذا كان يجب تقييد الاستعلامات لاستخدام البيانات المفهرسة.	لا
include_contexts	صفيف	الخصائص المضمنة لسياق الإخراج. إذا لم يتم تحديدها، فإن القيمة الافتراضية هي `citations` و `intent`.	لا
index_name	string	اسم فهرس ElasticsearchÂ®.	‏‏نعم‬
max_search_queries	integer	يجب إرسال الحد الأقصى لعدد الاستعلامات المعاد كتابتها إلى موفر البحث لرسالة مستخدم واحدة. إذا لم يتم تحديده، فسيقرر النظام عدد الاستعلامات التي سيتم إرسالها.	لا
query_type	elasticsearchQueryType	نوع استعلام الاسترداد ElasticsearchÂ® الذي يجب تنفيذه عند استخدامه كملحق دردشة Azure OpenAI.	لا
strictness	integer	الصرامة المكونة لتصفية صلة البحث. أعلى من الصرامة، وأعلى من الدقة ولكن أقل استدعاء للإجابة.	لا
top_n_documents	integer	العدد الأعلى للمستندات المكونة للميزة للاستعلام الذي تم تكوينه.	لا

elasticsearchIndexFieldMappingOptions

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

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

elasticsearchQueryType

نوع استعلام الاسترداد ElasticsearchÂ® الذي يجب تنفيذه عند استخدامه كملحق دردشة Azure OpenAI.

الخاصية	قيمة
الوصف	نوع استعلام الاسترداد ElasticsearchÂ® الذي يجب تنفيذه عند استخدامه كملحق دردشة Azure OpenAI.
Type	string
Values	`simple` `vector`

mongoDBChatExtensionConfiguration

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

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

mongoDBChatExtensionParameters

المعلمات التي يجب استخدامها عند تكوين Azure OpenAI على ملحقات دردشة بياناتك عند استخدام Mongo DB.

الاسم	النوع	وصف	مطلوب	الإفتراضي
allow_partial_result	boolean	إذا تم تحديده على أنه صحيح، فسيسمح النظام باستخدام نتائج البحث الجزئية ويفشل الطلب إذا فشلت جميع الاستعلامات. إذا لم يتم تحديده، أو تم تحديده على أنه خطأ، فسيفشل الطلب إذا فشل أي استعلام بحث.	لا	خطأ
app_name	string	اسم تطبيق Mongo DB.	‏‏نعم‬
المصادقه	onYourDataUsernameAndPasswordAuthenticationOptions	خيارات المصادقة Azure OpenAI على بياناتك عند استخدام اسم مستخدم وكلمة مرور.	‏‏نعم‬
collection_name	string	اسم مجموعة Mongo DB.	‏‏نعم‬
database_name	string	اسم قاعدة بيانات Mongo DB.	‏‏نعم‬
embedding_dependency	onYourDataEndpointVectorizationSource أو onYourDataDeploymentNameVectorizationSource		‏‏نعم‬
نقطه النهايه	string	اسم نقطة نهاية مجموعة Mongo DB.	‏‏نعم‬
fields_mapping	mongoDBFieldMappingOptions	إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Mongo DB تم تكوينه.	‏‏نعم‬
in_scope	boolean	ما إذا كان يجب تقييد الاستعلامات لاستخدام البيانات المفهرسة.	لا
include_contexts	صفيف	الخصائص المضمنة لسياق الإخراج. إذا لم يتم تحديدها، فإن القيمة الافتراضية هي `citations` و `intent`.	لا
index_name	string	اسم مؤشر مونغو DB.	‏‏نعم‬
max_search_queries	integer	يجب إرسال الحد الأقصى لعدد الاستعلامات المعاد كتابتها إلى موفر البحث لرسالة مستخدم واحدة. إذا لم يتم تحديده، فسيقرر النظام عدد الاستعلامات التي سيتم إرسالها.	لا
strictness	integer	الصرامة المكونة لتصفية صلة البحث. أعلى من الصرامة، وأعلى من الدقة ولكن أقل استدعاء للإجابة.	لا
top_n_documents	integer	العدد الأعلى للمستندات المكونة للميزة للاستعلام الذي تم تكوينه.	لا

mongoDBFieldMappingOptions

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

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

pineconeChatExtensionConfiguration

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

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

pineconeChatExtensionParameters

معلمات لتكوين Azure ملحقات دردشة OpenAI Pinecone.

الاسم	النوع	وصف	مطلوب	الإفتراضي
allow_partial_result	boolean	إذا تم تحديده على أنه صحيح، فسيسمح النظام باستخدام نتائج البحث الجزئية ويفشل الطلب إذا فشلت جميع الاستعلامات. إذا لم يتم تحديده، أو تم تحديده على أنه خطأ، فسيفشل الطلب إذا فشل أي استعلام بحث.	لا	خطأ
المصادقه	onYourDataApiKeyAuthenticationOptions	خيارات المصادقة Azure OpenAI على بياناتك عند استخدام مفتاح API.	‏‏نعم‬
embedding_dependency	onYourDataDeploymentNameVectorizationSource	تفاصيل مصدر المتجهات، المستخدمة من قبل Azure OpenAI على بياناتك عند تطبيق بحث المتجهات، والتي تستند إلى اسم توزيع نموذج تضمين داخلي في نفس Azure مورد OpenAI.	‏‏نعم‬
environment	string	اسم البيئة ل Pinecone.	‏‏نعم‬
fields_mapping	pineconeFieldMappingOptions	إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Pinecone مكون.	‏‏نعم‬
in_scope	boolean	ما إذا كان يجب تقييد الاستعلامات لاستخدام البيانات المفهرسة.	لا
include_contexts	صفيف	الخصائص المضمنة لسياق الإخراج. إذا لم يتم تحديدها، فإن القيمة الافتراضية هي `citations` و `intent`.	لا
index_name	string	اسم فهرس قاعدة بيانات Pinecone.	‏‏نعم‬
max_search_queries	integer	يجب إرسال الحد الأقصى لعدد الاستعلامات المعاد كتابتها إلى موفر البحث لرسالة مستخدم واحدة. إذا لم يتم تحديده، فسيقرر النظام عدد الاستعلامات التي سيتم إرسالها.	لا
strictness	integer	الصرامة المكونة لتصفية صلة البحث. أعلى من الصرامة، وأعلى من الدقة ولكن أقل استدعاء للإجابة.	لا
top_n_documents	integer	العدد الأعلى للمستندات المكونة للميزة للاستعلام الذي تم تكوينه.	لا

pineconeFieldMappingOptions

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

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

onYourDataAuthenticationOptions

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

تمييز على onYourDataAuthenticationOptions

يستخدم هذا المكون الخاصية type للتمييز بين أنواع مختلفة:

قيمة النوع	Schema
`api_key`	onYourDataApiKeyAuthenticationOptions
`connection_string`	onYourDataConnectionStringAuthenticationOptions
`key_and_key_id`	onYourDataKeyAndKeyIdAuthenticationOptions
`encoded_api_key`	onYourDataEncodedApiKeyAuthenticationOptions
`access_token`	onYourDataAccessTokenAuthenticationOptions
`system_assigned_managed_identity`	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
`user_assigned_managed_identity`	onYourDataUserAssignedManagedIdentityAuthenticationOptions
`username_and_password`	onYourDataUsernameAndPasswordAuthenticationOptions

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

onYourDataContextProperty

خاصية السياق.

الخاصية	قيمة
الوصف	خاصية السياق.
Type	string
Values	`citations` `intent` `all_retrieved_documents`

onYourDataAuthenticationType

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

الخاصية	قيمة
الوصف	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.
Type	string
Values	`api_key` `connection_string` `key_and_key_id` `encoded_api_key` `access_token` `system_assigned_managed_identity` `user_assigned_managed_identity` `username_and_password`

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

onYourDataKeyAndKeyIdAuthenticationOptions

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

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

onYourDataEncodedApiKeyAuthenticationOptions

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
encoded_api_key	string	مفتاح واجهة برمجة التطبيقات المرمزة Elasticsearch لاستخدامه للمصادقة.	لا
النوع	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	‏‏نعم‬

onYourDataAccessTokenAuthenticationOptions

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

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUsernameAndPasswordAuthenticationOptions

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

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

onYourDataVectorizationSource

تمثيل مجرد لمصدر متجه Azure OpenAI على بياناتك مع البحث عن المتجهات.

يستخدم هذا المكون الخاصية type للتمييز بين أنواع مختلفة:

قيمة النوع	Schema
`endpoint`	onYourDataEndpointVectorizationSource
`deployment_name`	onYourDataDeploymentNameVectorizationSource
`integrated`	onYourDataIntegratedVectorizationSource
`model_id`	onYourDataModelIdVectorizationSource

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

onYourDataVectorizationSourceType

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

الخاصية	قيمة
الوصف	يمثل المصادر المتوفرة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات.
Type	string
Values	`endpoint` `deployment_name` `integrated` `model_id`

onYourDataEndpointVectorizationSource

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

الاسم	النوع	وصف	مطلوب
المصادقه	onYourDataApiKeyAuthenticationOptions أو onYourDataAccessTokenAuthenticationOptions		لا
ابعاد	integer	عدد الأبعاد التي يجب أن تحتوي عليها عمليات التضمين. مدعوم فقط في `text-embedding-3` والنماذج الأحدث.	لا
نقطه النهايه	string	يحدد عنوان URL لنقطة نهاية المورد الذي يجب استرداد عمليات التضمين منه. يجب أن يكون بتنسيق `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`. معلمة استعلام إصدار واجهة برمجة التطبيقات غير مسموح بها.	لا
النوع	onYourDataVectorizationSourceType	يمثل المصادر المتوفرة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات.	‏‏نعم‬

onYourDataDeploymentNameVectorizationSource

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

الاسم	النوع	وصف	مطلوب
deployment_name	string	يحدد اسم نشر النموذج لاستخدامه في المتجهات. يجب أن يكون نشر النموذج هذا في نفس Azure مورد OpenAI، ولكن على بياناتك ستستخدم نشر النموذج هذا عبر مكالمة داخلية بدلا من استدعاء عام، مما يتيح البحث المتجه حتى في الشبكات الخاصة.	لا
ابعاد	integer	عدد الأبعاد التي يجب أن تحتوي عليها عمليات التضمين. مدعوم فقط في `text-embedding-3` والنماذج الأحدث.	لا
النوع	onYourDataVectorizationSourceType	يمثل المصادر المتوفرة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات.	‏‏نعم‬

onYourDataIntegratedVectorizationSource

يمثل المتجه المتكامل المحدد داخل مورد البحث.

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

onYourDataModelIdVectorizationSource

تفاصيل مصدر المتجهات، المستخدمة من قبل Azure OpenAI على بياناتك عند تطبيق البحث عن المتجهات، والتي تستند إلى معرف نموذج search service. حاليا يدعمه ElasticsearchÂ® فقط.

الاسم	النوع	وصف	مطلوب	الإفتراضي
model_id	string	تحديد معرف النموذج لاستخدامه في المتجهات. يجب تعريف معرف النموذج هذا في search service.	لا
النوع	onYourDataVectorizationSourceType	يمثل المصادر المتوفرة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات.	‏‏نعم‬

azureChatExtensionsMessageContext

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

الاسم	النوع	وصف	مطلوب
all_retrieved_documents	صفيف	كافة المستندات التي تم استردادها.	لا
citations	صفيف	نتيجة استرداد مصدر البيانات، المستخدمة لإنشاء رسالة المساعد في الاستجابة.	لا
intent	string	الهدف المكتشف من محفوظات الدردشة، المستخدم للتمرير إلى الدور التالي لنقل السياق.	لا

citation

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

الاسم	النوع	وصف	مطلوب
chunk_id	string	معرف المجموعة للاقتباس.	لا
محتوى	string	محتوى الاقتباس.	‏‏نعم‬
filepath	string	مسار ملف الاقتباس.	لا
rerank_score	رقم	درجة إعادة ترتيب المستند الذي تم استرداده.	لا
العنوان	string	عنوان الاقتباس.	لا
عنوان URL	string	عنوان URL للاقتباس.	لا

retrievedDocument

المستند الذي تم استرداده.

الاسم	النوع	وصف	مطلوب
chunk_id	string	معرف المجموعة للاقتباس.	لا
محتوى	string	محتوى الاقتباس.	‏‏نعم‬
data_source_index	integer	فهرس مصدر البيانات.	لا
filepath	string	مسار ملف الاقتباس.	لا
filter_reason	filterReason	سبب تصفية المستند الذي تم استرداده.	لا
original_search_score	رقم	درجة البحث الأصلية للمستند الذي تم استرداده.	لا
rerank_score	رقم	درجة إعادة ترتيب المستند الذي تم استرداده.	لا
search_queries	صفيف	استعلامات البحث المستخدمة لاسترداد المستند.	لا
العنوان	string	عنوان الاقتباس.	لا
عنوان URL	string	عنوان URL للاقتباس.	لا

filterReason

سبب تصفية المستند الذي تم استرداده.

الخاصية	قيمة
الوصف	سبب تصفية المستند الذي تم استرداده.
Type	string
Values	`score` `rerank`

chatCompletionMessageToolCall

الاسم	النوع	وصف	مطلوب
دالة	object	الدالة التي استدعاها النموذج.	‏‏نعم‬
└─ الحجج	string	الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد يهلوس المعلمات التي لم يتم تعريفها بواسطة مخطط الدالة الخاص بك. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة.	لا
└─ الاسم	string	اسم الدالة التي يجب استدعاها.	لا
المعرف	string	معرف استدعاء الأداة.	‏‏نعم‬
النوع	toolCallType	نوع استدعاء الأداة، في هذه الحالة `function`.	‏‏نعم‬

toolCallType

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

الخاصية	قيمة
الوصف	نوع استدعاء الأداة، في هذه الحالة `function`.
Type	string
Values	`function`

chatCompletionRequestMessageTool

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

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

الاسم	النوع	وصف	مطلوب
محتوى	string	محتويات رسالة المجموعة.	لا
function_call	object	مهمل واستبدل ب `tool_calls`. اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج.	لا
└─ الحجج	string	الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد يهلوس المعلمات التي لم يتم تعريفها بواسطة مخطط الدالة الخاص بك. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة.	لا
└─ الاسم	string	اسم الدالة التي يجب استدعاها.	لا
رفض	string	رسالة الرفض التي أنشأها النموذج.	لا
role	enum	دور كاتب هذه الرسالة. القيم المحتملة: `system`، `user`، ، `assistanttool`	لا
tool_calls	صفيف		لا

chatCompletionMessageToolCallChunk

الاسم	النوع	وصف	مطلوب
دالة	object		لا
└─ الحجج	string	الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد يهلوس المعلمات التي لم يتم تعريفها بواسطة مخطط الدالة الخاص بك. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة.	لا
└─ الاسم	string	اسم الدالة التي يجب استدعاها.	لا
المعرف	string	معرف استدعاء الأداة.	لا
الفهرس	integer		‏‏نعم‬
النوع	enum	نوع الأداة. حاليا، يتم دعم فقط `function` . القيم المحتملة: `function`	لا

chatCompletionStreamOptions

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

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

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

رسالة إكمال دردشة تم إنشاؤها بواسطة النموذج.

الاسم	النوع	وصف	مطلوب
صوتي	object	إذا تم طلب أسلوب إخراج الصوت، يحتوي هذا الكائن على بيانات حول الاستجابة الصوتية من النموذج.	لا
└─ البيانات	string	وحدات بايت الصوت المرمزة Base64 التي تم إنشاؤها بواسطة النموذج، بالتنسيق المحدد في الطلب.	لا
└─ expires_at	integer	لن يعود من الممكن الوصول إلى الطابع الزمني Unix (بالثوان) عندما لا يمكن الوصول إلى استجابة الصوت هذه على الخادم لاستخدامها في المحادثات متعددة الأدوار.	لا
└─ الهوية	string	معرف فريد لاستجابة الصوت هذه.	لا
└─ نسخة طبق الأصل	string	نسخة من الصوت الذي تم إنشاؤه بواسطة النموذج.	لا
محتوى	string	محتويات الرسالة.	‏‏نعم‬
context	azureChatExtensionsMessageContext	تمثيل لمعلومات السياق الإضافية المتوفرة عند مشاركة Azure ملحقات دردشة OpenAI في إنشاء استجابة إكمال الدردشة المقابلة. يتم ملء معلومات السياق هذه فقط عند استخدام طلب openAI Azure تم تكوينه لاستخدام ملحق مطابق.	لا
function_call	chatCompletionFunctionCall	مهمل واستبدل ب `tool_calls`. اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج.	لا
رفض	string	رسالة الرفض التي أنشأها النموذج.	‏‏نعم‬
role	chatCompletionResponseMessageRole	دور كاتب رسالة الاستجابة.	‏‏نعم‬
tool_calls	صفيف	تستدعي الأداة التي تم إنشاؤها بواسطة النموذج، مثل استدعاءات الدالة.	لا

chatCompletionResponseMessageRole

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

الخاصية	قيمة
الوصف	دور كاتب رسالة الاستجابة.
Type	string
Values	`assistant`

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

chatCompletionNamedToolChoice

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

الاسم	النوع	وصف	مطلوب
دالة	object		‏‏نعم‬
└─ الاسم	string	اسم الدالة التي يجب استدعاها.	لا
النوع	enum	نوع الأداة. حاليا، يتم دعم فقط `function` . القيم المحتملة: `function`	‏‏نعم‬

ParallelToolCalls

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

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

PredictionContent

محتوى إخراج متوقع ثابت، مثل محتوى ملف نصي يتم إعادة إنشائه.

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

chatCompletionMessageToolCalls

تستدعي الأداة التي تم إنشاؤها بواسطة النموذج، مثل استدعاءات الدالة.

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

ChatCompletionModalities

أنواع الإخراج التي ترغب في أن ينشئها النموذج لهذا الطلب. معظم النماذج قادرة على إنشاء نص، وهو الافتراضي:

["text"]

gpt-4o-audio-preview يمكن أيضا استخدام النموذج لإنشاء الصوت. لطلب إنشاء هذا النموذج استجابات نصية وصوتية، يمكنك استخدام:

["text", "audio"]

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

chatCompletionFunctionCall

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

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

completionUsage

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

الاسم	النوع	وصف	مطلوب
completion_tokens	integer	عدد الرموز المميزة في الإكمال الذي تم إنشاؤه.	‏‏نعم‬
completion_tokens_details	object	تصنيف الرموز المميزة المستخدمة في الإكمال.	لا
└─ accepted_prediction_tokens	integer	عند استخدام المخرجات المتوقعة، عدد الرموز المميزة في التنبؤ الذي ظهر في الاكتمال.	لا
└─ audio_tokens	integer	الرموز المميزة لإدخال الصوت التي تم إنشاؤها بواسطة النموذج.	لا
└─ reasoning_tokens	integer	الرموز المميزة التي تم إنشاؤها بواسطة النموذج من أجل المنطق.	لا
└─ rejected_prediction_tokens	integer	عند استخدام Predicted Outputs، عدد الرموز المميزة في التنبؤ الذي لم يظهر في الاكتمال. ومع ذلك، مثل الرموز المميزة المنطقية، لا يزال يتم حساب هذه الرموز المميزة في إجمالي رموز الإكمال المميزة لأغراض حدود نافذة الفوترة والإخراج والسياق.	لا
prompt_tokens	integer	عدد الرموز المميزة في المطالبة.	‏‏نعم‬
prompt_tokens_details	object	تفاصيل الرموز المميزة للمطالبة.	لا
└─ audio_tokens	integer	الرموز المميزة لإدخال الصوت موجودة في المطالبة.	لا
└─ cached_tokens	integer	عدد الرموز المميزة للمطالبة المخزنة مؤقتا.	لا
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة في الطلب (المطالبة + الإكمال).	‏‏نعم‬

chatCompletionTool

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

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` القيم المحتملة: `text`	‏‏نعم‬

ResponseFormatJsonObject

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

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

الاسم	النوع	وصف	مطلوب	الإفتراضي
json_schema	object		‏‏نعم‬
└─ الوصف	string	وصف لما هو تنسيق الاستجابة، يستخدمه النموذج لتحديد كيفية الاستجابة بالتنسيق.	لا
└─ الاسم	string	اسم تنسيق الاستجابة. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64.	لا
└─ مخطط	ResponseFormatJsonSchemaSchema	مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON.	لا
└─ صارم	boolean	ما إذا كان سيتم تمكين الالتزام الصارم بالمخطط عند إنشاء الإخراج. إذا تم تعيينه إلى true، فسيتبع النموذج دائما المخطط الدقيق المحدد في `schema` الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما `strict` تكون `true`.	لا	خطأ
النوع	enum	نوع تنسيق الاستجابة الذي يتم تعريفه: `json_schema` القيم المحتملة: `json_schema`	‏‏نعم‬

chatCompletionChoiceCommon

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

createTranslationRequest

طلب ترجمة.

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

audioResponse

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	نص مترجم أو منسوخ.	‏‏نعم‬

audioVerboseResponse

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

الاسم	النوع	وصف	مطلوب
المدة	رقم	Duration.	لا
اللغة	string	Language.	لا
segments	صفيف		لا
مهمة	string	نوع مهمة الصوت.	لا
نص	string	نص مترجم أو منسوخ.	‏‏نعم‬
words	صفيف		لا

audioResponseFormat

تعريف تنسيق الإخراج.

الخاصية	قيمة
الوصف	تعريف تنسيق الإخراج.
Type	string
Values	`json` `text` `srt` `verbose_json` `vtt`

createTranscriptionRequest

طلب النسخ.

الاسم	النوع	وصف	مطلوب	الإفتراضي
ملف	string	كائن الملف الصوتي المراد نسخه.	‏‏نعم‬
اللغة	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 إلى تحسين الدقة وزمن الوصول.	لا
فوري	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت.	لا
response_format	audioResponseFormat	تعريف تنسيق الإخراج.	لا
درجة الحرارة	رقم	درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه على 0 ، يستخدم النموذج احتمالية السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى عتبات معينة.	لا	0
timestamp_granularities[]	صفيف	نقاوة الطابع الزمني التي يجب ملؤها لهذا النسخ. `response_format` يجب تعيين `verbose_json` لاستخدام نقاوة الطابع الزمني. يتم دعم أي من هذين الخيارين أو كليهما: `word`أو `segment`. ملاحظة: لا يوجد زمن انتقال إضافي للطوابع الزمنية للمقطع، ولكن إنشاء الطوابع الزمنية للكلمة يتطلب زمن انتقال إضافي.	لا	['segment']

audioSegment

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

الاسم	النوع	وصف	مطلوب
avg_logprob	رقم	متوسط احتمال السجل.	لا
compression_ratio	رقم	نسبة الضغط.	لا
end	رقم	إزاحة نهاية المقطع.	لا
المعرف	integer	معرف الشريحة.	لا
no_speech_prob	رقم	احتمال "عدم الكلام".	لا
seek	رقم	إزاحة المقطع.	لا
start	رقم	إزاحة بدء المقطع.	لا
درجة الحرارة	رقم	Temperature.	لا
نص	string	نص المقطع.	لا
tokens	صفيف	الرموز المميزة للنص.	لا

audioWord

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

الاسم	النوع	وصف	مطلوب
end	رقم	إزاحة نهاية Word.	لا
start	رقم	إزاحة بدء Word.	لا
word	string	Word	لا

createSpeechRequest

طلب الكلام.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	string	النص المراد تركيب الصوت له. الحد الأقصى للطول هو 4,096 حرفا.	‏‏نعم‬
response_format	enum	التنسيق المراد تركيب الصوت فيه. القيم المحتملة: `mp3`، `opus`، `aac`، `flac`، ، `wavpcm`	لا
speed	رقم	سرعة الصوت المركب. حدد قيمة من `0.25` إلى `4.0`. `1.0` هو الافتراضي.	لا	1.0
صوت	enum	الصوت الذي يجب استخدامه لتركيب الكلام. القيم المحتملة: `alloy`، `echo`، `fable`، `onyx`، ، `novashimmer`	‏‏نعم‬

imageQuality

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

الخاصية	قيمة
الوصف	جودة الصورة التي سيتم إنشاؤها.
Type	string
الإعداد الافتراضي	تلقائي
Values	`auto` `high` `medium` `low` `hd` `standard`

imagesResponseFormat

التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها.

الخاصية	قيمة
الوصف	التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها.
Type	string
الإعداد الافتراضي	عنوان URL
Values	`url` `b64_json`

imagesOutputFormat

تنسيق الملف الذي يتم فيه إرجاع الصور التي تم إنشاؤها. مدعوم فقط لنماذج السلسلة.

الخاصية	قيمة
الوصف	تنسيق الملف الذي يتم فيه إرجاع الصور التي تم إنشاؤها. مدعوم فقط لنماذج سلسلة gpt-image-1.
Type	string
الإعداد الافتراضي	png
Values	`png` `jpeg`

imageSize

حجم الصور التي تم إنشاؤها.

الخاصية	قيمة
الوصف	حجم الصور التي تم إنشاؤها.
Type	string
الإعداد الافتراضي	تلقائي
Values	`auto` `1792x1024` `1024x1792` `1024x1024` `1024x1536` `1536x1024`

imageStyle

نمط الصور التي تم إنشاؤها. مدعوم فقط ل dall-e-3.

الخاصية	قيمة
الوصف	نمط الصور التي تم إنشاؤها. مدعوم فقط ل dall-e-3.
Type	string
الإعداد الافتراضي	vivid
Values	`vivid` `natural`

imageBackground

يسمح بتعيين الشفافية لخلفية الصورة (الصور) التي تم إنشاؤها. هذا المعامل مدعوم فقط لنماذج سلسلة gpt-image-1.

الخاصية	قيمة
الوصف	يسمح بتعيين الشفافية لخلفية الصورة (الصور) التي تم إنشاؤها. هذا المعامل مدعوم فقط لنماذج سلسلة gpt-image-1.
Type	string
الإعداد الافتراضي	تلقائي
Values	`transparent` `opaque` `auto`

imageGenerationsRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
background	imageBackground	يسمح بتعيين الشفافية لخلفية الصورة (الصور) التي تم إنشاؤها. هذا المعامل مدعوم فقط لنماذج سلسلة gpt-image-1.	لا	تلقائي
n	integer	عدد الصور المراد إنشاؤها. بالنسبة إلى dall-e-3، يتم دعم n=1 فقط.	لا	1
output_compression	integer	مستوى الضغط (0-100%) للصور التي تم إنشاؤها. يدعم هذا المعامل فقط لنماذج سلسلة gpt-image-1 التي تستخدم صيغة إخراج jpeg.	لا	100
output_format	imagesOutputFormat	تنسيق الملف الذي يتم فيه إرجاع الصور التي تم إنشاؤها. مدعوم فقط لنماذج سلسلة gpt-image-1.	لا	png
فوري	string	وصف نصي للصورة (الصور) المطلوبة. الطول الأقصى هو 32000 حرف لنماذج سلسلة gpt-image-1 و4000 حرف لنماذج dall-e-3	‏‏نعم‬
جودة	imageQuality	جودة الصورة التي سيتم إنشاؤها.	لا	تلقائي
response_format	imagesResponseFormat	التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها. مدعوم فقط ل dall-e-3.	لا	عنوان URL
size	imageSize	حجم الصور التي تم إنشاؤها.	لا	تلقائي
style	imageStyle	نمط الصور التي تم إنشاؤها. مدعوم فقط ل dall-e-3.	لا	vivid
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	لا

imageEditsRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
صورة	سلسلة أو مجموعة	الصورة (الصور) المراد تحريرها. يجب أن يكون ملف صورة معتمدا أو صفيفا من الصور. يجب أن تكون كل صورة ملف png أو jpg أقل من 25 ميغابايت.	‏‏نعم‬
قناع	string	صورة إضافية تشير مناطقها الشفافة بالكامل (على سبيل المثال، حيث ألفا صفر) إلى المكان الذي يجب تحرير الصورة فيه. إذا تم توفير صور متعددة، تطبيق القناع على الصورة الأولى. يجب أن يكون ملف PNG صالحا، أقل من 4 ميغابايت، وأن يكون له نفس أبعاد الصورة.	لا
n	integer	عدد الصور المراد إنشاؤها.	لا	1
فوري	string	وصف نصي للصورة (الصور) المطلوبة. الحد الأقصى للطول هو 32000 حرف.	‏‏نعم‬
جودة	imageQuality	جودة الصورة التي سيتم إنشاؤها.	لا	تلقائي
response_format	imagesResponseFormat	التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها.	لا	عنوان URL
size	imageSize	حجم الصور التي تم إنشاؤها.	لا	تلقائي
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	لا

generateImagesResponse

الاسم	النوع	وصف	مطلوب
created	integer	الطابع الزمني unix عند إنشاء العملية.	‏‏نعم‬
البيانات	صفيف	بيانات نتيجة العملية، إذا نجحت	‏‏نعم‬
استخدام	imageGenerationsUsage	يمثل تفاصيل استخدام الرمز المميز لطلبات إنشاء الصور. فقط لنماذج سلسلة gpt-image-1.	لا

imageResult

عنوان URL للصورة أو الصورة المشفرة إذا نجحت، وخطأ بخلاف ذلك.

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

imageGenerationsUsage

يمثل تفاصيل استخدام الرمز المميز لطلبات إنشاء الصور. فقط لنماذج سلسلة gpt-image-1.

الاسم	النوع	وصف	مطلوب
input_tokens	integer	عدد رموز الإدخال.	لا
input_tokens_details	object	تحليل مفصل للرموز المميزة للإدخال.	لا
└─ image_tokens	integer	عدد الرموز المميزة للصورة.	لا
└─ text_tokens	integer	عدد الرموز المميزة للنص.	لا
output_tokens	integer	عدد الرموز المميزة للإخراج.	لا
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة.	لا

line

كائن سطر محتوى يتكون من تسلسل متجاورة من عناصر المحتوى، مثل الكلمات وعلامات التحديد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
spans	صفيف	صفيف من الامتدادات التي تمثل العناصر المكتشفة ومعلومات المربع المحيط بها.	‏‏نعم‬
نص	string		‏‏نعم‬

span

كائن امتداد يمثل كائنا تم اكتشافه ومعلومات المربع المحيط به.

الاسم	النوع	وصف	مطلوب
length	integer	طول الامتداد بالأحرف، مقاسا بنقاط التعليمات البرمجية ل Unicode.	‏‏نعم‬
offset	integer	إزاحة الحرف داخل النص حيث يبدأ النطاق. يتم تعريف هذه الإزاحة كموضع الحرف الأول من النطاق، مع عد من بداية النص كنقاط تعليمات برمجية Unicode.	‏‏نعم‬
polygon	صفيف	صفيف من الكائنات التي تمثل النقاط في المضلع الذي يحيط الكائن المكتشف.	‏‏نعم‬
نص	string	محتوى النص للامتداد الذي يمثل الكائن المكتشف.	‏‏نعم‬

runCompletionUsage

إحصائيات الاستخدام المتعلقة بالتشغيل. ستكون null هذه القيمة إذا لم يكن التشغيل في حالة طرفية (مثل in_progress، ، queuedوما إلى ذلك).

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

runStepCompletionUsage

إحصائيات الاستخدام المتعلقة بخطوة التشغيل. سيتم null هذه القيمة بينما تكون حالة خطوة التشغيل in_progress.

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

assistantsApiResponseFormatOption

تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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 الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.

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

ResponseFormatText
ResponseFormatJsonObject
ResponseFormatJsonSchema

assistantsApiResponseFormat

كائن يصف الإخراج المتوقع للنموذج. إذا json_object فقط function يتم السماح بتمرير tools النوع إلى تشغيل. إذا text يمكن للنموذج إرجاع نص أو أي قيمة مطلوبة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	string	يجب أن يكون أحد `text` أو `json_object`.	لا	نص

نوع التعداد: AssistantsApiResponseFormat

قيمة	وصف
نص
json_object

assistantObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء المساعد.	‏‏نعم‬
الوصف	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
تعليمات	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 256000 حرف.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	‏‏نعم‬
نموذج	string	معرف النموذج المراد استخدامه.	‏‏نعم‬
الاسم	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم `assistant`دائما .	‏‏نعم‬
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	معرف مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
الأدوات	صفيف	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `file_search`أو `function`.	‏‏نعم‬	[]
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1

تعداد الكائن: AssistantObjectType

قيمة	وصف
assistant	نوع الكائن، وهو مساعد دائما

createAssistantRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	لا
تعليمات	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 256000 حرف.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
نموذج	string		‏‏نعم‬
الاسم	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	لا
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
└─ vector_stores	صفيف	مساعد لإنشاء مخزن متجهات باستخدام file_ids وإرفاقه بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
الأدوات	صفيف	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `retrieval`أو `function`.	لا	[]
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1

modifyAssistantRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	لا
تعليمات	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 32768 حرفا.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
نموذج	string		لا
الاسم	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	لا
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	يتجاوز قائمة معرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	يتجاوز مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
الأدوات	صفيف	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `retrieval`أو `function`.	لا	[]
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1

deleteAssistantResponse

الاسم	النوع	مطلوب
deleted	boolean	‏‏نعم‬
المعرف	string	‏‏نعم‬
object	string	‏‏نعم‬

تعداد الكائن: DeleteAssistantResponseState

قيمة	وصف
assistant.deleted

listAssistantsResponse

الاسم	النوع	مطلوب
البيانات	صفيف	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
object	string	‏‏نعم‬

assistantToolsCode

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	string	نوع الأداة التي يتم تعريفها: `code_interpreter`	‏‏نعم‬

نوع التعداد: assistantToolsCodeType

قيمة	وصف
code_interpreter

assistantToolsFileSearch

الاسم	النوع	وصف	مطلوب
file_search	object	تجاوز أداة البحث عن الملفات.	لا
└─ max_num_results	integer	الحد الأقصى لعدد النتائج التي يجب أن تنتجها أداة البحث عن الملفات. الإعداد الافتراضي هو 20 لنماذج gpt-4* و5 ل gpt-3.5-turbo. يجب أن يتراوح هذا الرقم بين 1 و50 ضمنا. لاحظ أن أداة البحث عن الملفات قد تنتج أقل من `max_num_results` النتائج.	لا
النوع	string	نوع الأداة التي يتم تعريفها: `file_search`	‏‏نعم‬

نوع التعداد: assistantToolsFileSearchType

قيمة	وصف
file_search

assistantToolsFileSearchTypeOnly

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	string	نوع الأداة التي يتم تعريفها: `file_search`	‏‏نعم‬

نوع التعداد: assistantToolsFileSearchType

قيمة	وصف
file_search

assistantToolsFunction

الاسم	النوع	وصف	مطلوب
دالة	object	تعريف الدالة.	‏‏نعم‬
└─ الوصف	string	وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة.	لا
└─ الاسم	string	اسم الدالة التي سيتم استدعاؤها. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64.	لا
└─ المعلمات	chatCompletionFunctionParameters	المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON. راجع guide/ للحصول على أمثلة، ومرجع مخطط JSON للحصول على وثائق حول التنسيق.	لا
النوع	string	نوع الأداة التي يتم تعريفها: `function`	‏‏نعم‬

نوع التعداد: assistantToolsFunction

قيمة	وصف
دالة

truncationObject

عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
last_messages	integer	عدد أحدث الرسائل من مؤشر الترابط عند إنشاء سياق التشغيل.	لا
النوع	string	استراتيجية الاقتطاع لاستخدامها في مؤشر الترابط. الافتراضي هو `auto`. إذا تم تعيينه إلى `last_messages`، اقتطاع مؤشر الترابط إلى الرسائل الأخيرة n في مؤشر الترابط. عند التعيين إلى `auto`، سيتم إسقاط الرسائل الموجودة في منتصف مؤشر الترابط لاحتواء طول سياق النموذج، `max_prompt_tokens`.	‏‏نعم‬

نوع قائمة التعداد: TruncationType

قيمة	وصف
تلقائي
last_messages

assistantsApiToolChoiceOption

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

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

assistantsNamedToolChoice

assistantsNamedToolChoice

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

الاسم	النوع	وصف	مطلوب
دالة	object		لا
└─ الاسم	string	اسم الدالة التي يجب استدعاها.	لا
النوع	string	نوع الأداة. إذا كان النوع هو `function`، يجب تعيين اسم الدالة	‏‏نعم‬

نوع التعداد: AssistantsNamedToolChoiceType

قيمة	وصف
دالة
code_interpreter
file_search

runObject

يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.

الاسم	النوع	وصف	مطلوب	الإفتراضي
assistant_id	string	معرف المساعد المستخدم لتنفيذ هذا التشغيل.	‏‏نعم‬
cancelled_at	integer	الطابع الزمني Unix (بالثوان) لوقت إلغاء التشغيل.	‏‏نعم‬
completed_at	integer	الطابع الزمني Unix (بالثوان) لوقت اكتمال التشغيل.	‏‏نعم‬
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء التشغيل.	‏‏نعم‬
expires_at	integer	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية التشغيل.	‏‏نعم‬
failed_at	integer	الطابع الزمني Unix (بالثوان) لوقت فشل التشغيل.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
incomplete_details	object	تفاصيل حول سبب عدم اكتمال التشغيل. سيكون `null` إذا لم يكن التشغيل غير مكتمل.	‏‏نعم‬
└─ السبب	string	سبب عدم اكتمال التشغيل. سيشير هذا إلى حد الرمز المميز المحدد الذي تم الوصول إليه على مدار التشغيل.	لا
تعليمات	string	الإرشادات التي استخدمها المساعد لهذا التشغيل.	‏‏نعم‬
last_error	object	الخطأ الأخير المقترن بهذا التشغيل. سيتم `null` إذا لم تكن هناك أخطاء.	‏‏نعم‬
└─ كود	string	أحد `server_error` أو `rate_limit_exceeded`.	لا
└─ رسالة	string	وصف يمكن للإنسان قراءته للخطأ.	لا
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة المحددة لاستخدامها على مدار التشغيل.	‏‏نعم‬
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة المحددة لاستخدامها على مدار التشغيل.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	‏‏نعم‬
نموذج	string	النموذج الذي استخدمه المساعد لهذا التشغيل.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم `thread.run`دائما .	‏‏نعم‬
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا	صحيح
required_action	object	تفاصيل حول الإجراء المطلوب لمتابعة التشغيل. سيكون `null` إذا لم يكن هناك أي إجراء مطلوب.	‏‏نعم‬
└─ submit_tool_outputs	object	تفاصيل حول مخرجات الأداة اللازمة لمتابعة هذا التشغيل.	لا
└─ tool_calls	صفيف	قائمة باستدعاءات الأدوات ذات الصلة.	لا
└─ النوع	enum	في الوقت الحالي، هذا هو دائما `submit_tool_outputs`. القيم المحتملة: `submit_tool_outputs`	لا
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	‏‏نعم‬
started_at	integer	الطابع الزمني Unix (بالثوان) لوقت بدء التشغيل.	‏‏نعم‬
الحالة	string	حالة التشغيل، والتي يمكن أن تكون إما `queued`أو `in_progress`أو `requires_action`أو `cancellingcancelledfailedcompleted`.`expired`	‏‏نعم‬
درجة الحرارة	رقم	درجة حرارة أخذ العينات المستخدمة لهذا التشغيل. إذا لم يتم تعيينه، تعيينه افتراضيا إلى 1.	لا
thread_id	string	معرف مؤشرات الترابط التي تم تنفيذها كجزء من هذا التشغيل.	‏‏نعم‬
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	‏‏نعم‬
الأدوات	صفيف	قائمة الأدوات التي استخدمها المساعد لهذا التشغيل.	‏‏نعم‬	[]
top_p	رقم	قيمة أخذ عينات النواة المستخدمة لهذا التشغيل. إذا لم يتم تعيينه، تعيينه افتراضيا إلى 1.	لا
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	‏‏نعم‬
استخدام	runCompletionUsage	إحصائيات الاستخدام المتعلقة بالتشغيل. ستكون `null` هذه القيمة إذا لم يكن التشغيل في حالة طرفية (مثل `in_progress`، ، `queued`وما إلى ذلك).	‏‏نعم‬

قائمة تعداد العناصر: runObjectType

قيمة	وصف
thread.run	نوع كائن التشغيل الذي يكون دائما thread.run

قائمة تعداد الحالة: RunObjectStatus

قيمة	وصف
queued	الحالة في قائمة الانتظار
in_progress	الحالة in_progress
requires_action	الحالة required_action
cancelling	حالة الإلغاء
cancelled	الحالة الملغاة
failed	الحالة الفاشلة
completed	الحالة المكتملة
expired	الحالة منتهية الصلاحية

createRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
additional_instructions	string	إلحاق إرشادات إضافية في نهاية التعليمات الخاصة بالتشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل دون تجاوز إرشادات أخرى.	لا
additional_messages	صفيف	إضافة رسائل إضافية إلى مؤشر الترابط قبل إنشاء التشغيل.	لا
assistant_id	string	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.	‏‏نعم‬
تعليمات	string	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد رموز الإكمال المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	لا
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد الرموز المميزة السريعة المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
نموذج	string	معرف النموذج الذي سيتم استخدامه لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	لا
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا	صحيح
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
استدر	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	لا
الأدوات	صفيف	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	لا

listRunsResponse

الاسم	النوع	مطلوب
البيانات	صفيف	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
object	string	‏‏نعم‬

modifyRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا

submitToolOutputsRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
استدر	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	لا
tool_outputs	صفيف	قائمة بالأدوات التي يتم إرسال المخرجات لها.	‏‏نعم‬

runToolCallObject

كائنات استدعاء الأداة

الاسم	النوع	وصف	مطلوب
دالة	object	تعريف الدالة.	‏‏نعم‬
└─ الحجج	string	الوسيطات التي يتوقع منك النموذج تمريرها إلى الدالة .	لا
└─ الاسم	string	اسم الدالة	لا
المعرف	string	معرف استدعاء الأداة. يجب الرجوع إلى هذا المعرف عند إرسال مخرجات الأداة باستخدام مخرجات أداة الإرسال لتشغيل نقطة نهاية نقطة النهاية.	‏‏نعم‬
النوع	string	نوع استدعاء الأداة مطلوب للإخراج. في الوقت الحالي، هذا هو دائما `function`.	‏‏نعم‬

نوع التعداد: RunToolCallObjectType

قيمة	وصف
دالة

createThreadAndRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
assistant_id	string	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.	‏‏نعم‬
تعليمات	string	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد رموز الإكمال المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	لا
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد الرموز المميزة السريعة المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
نموذج	string	معرف النماذج التي سيتم استخدامها لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	لا
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا	صحيح
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o و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` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
استدر	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	لا
stream_options	chatCompletionStreamOptions	خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين `stream: true`.	لا	لا شيء
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا	1
thread	createThreadRequest		لا
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	لا
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	معرف مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	لا
الأدوات	صفيف	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا	1
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	لا

threadObject

يمثل مؤشر ترابط يحتوي على رسائل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء مؤشر الترابط.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم `thread`دائما .	‏‏نعم‬
tool_resources	object	مجموعة من الموارد المتوفرة لأدوات المساعد في مؤشر الترابط هذا. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	‏‏نعم‬
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	مخزن المتجهات المرفق بسلسلة الرسائل هذه. يمكن أن يكون هناك مخزن متجه 1 كحد أقصى مرفق بسلسلة الرسائل.	لا

تعداد الكائن: ThreadObjectType

قيمة	وصف
thread	نوع كائن مؤشر الترابط الذي يكون دائما `thread`

createThreadRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
messages	صفيف	قائمة بالرسائل لبدء مؤشر الترابط بها.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
tool_resources	object	مجموعة من الموارد المتوفرة لأدوات المساعد في مؤشر الترابط هذا. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	مخزن المتجهات المرفق بسلسلة الرسائل هذه. يمكن أن يكون هناك مخزن متجه 1 كحد أقصى مرفق بسلسلة الرسائل.	لا
└─ vector_stores	صفيف	مساعد لإنشاء مخزن متجهات مع file_ids وإرفاقه بسلسلة الرسائل هذه. يمكن أن يكون هناك مخزن متجه 1 كحد أقصى مرفق بسلسلة الرسائل.	لا

modifyThreadRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
tool_resources	object	مجموعة من الموارد المتوفرة لأدوات المساعد في مؤشر الترابط هذا. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	لا
└─ code_interpreter	object		لا
└─ file_ids	صفيف	قائمة بمعرفات الملفات المتوفرة للأداة `code_interpreter` . يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	لا	[]
└─ file_search	object		لا
└─ vector_store_ids	صفيف	مخزن المتجهات المرفق بسلسلة الرسائل هذه. يمكن أن يكون هناك مخزن متجه 1 كحد أقصى مرفق بسلسلة الرسائل.	لا

deleteThreadResponse

الاسم	النوع	مطلوب
deleted	boolean	‏‏نعم‬
المعرف	string	‏‏نعم‬
object	string	‏‏نعم‬

تعداد الكائن: DeleteThreadResponseObjectState

قيمة	وصف
thread.deleted	حالة كائن استجابة مؤشر الترابط الحذف وهي `thread.deleted`

listThreadsResponse

الاسم	النوع	مطلوب
البيانات	صفيف	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
object	string	‏‏نعم‬

messageObject

يمثل رسالة داخل مؤشرات ترابط.

الاسم	النوع	وصف	مطلوب
assistant_id	string	إذا كان ذلك ممكنا، معرف المساعد الذي قام بتأليف هذه الرسالة.	‏‏نعم‬
attachments	صفيف	قائمة بالملفات المرفقة بالرسالة والأدوات التي تمت إضافتها إليها.	‏‏نعم‬
completed_at	integer	الطابع الزمني Unix (بالثوان) لوقت اكتمال الرسالة.	‏‏نعم‬
محتوى	صفيف	محتوى الرسالة في صفيف من النص و/أو الصور.	‏‏نعم‬
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء الرسالة.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
incomplete_at	integer	الطابع الزمني Unix (بالثوان) لوقت وضع علامة على الرسالة على أنها غير مكتملة.	‏‏نعم‬
incomplete_details	object	في رسالة غير مكتملة، تفاصيل حول سبب عدم اكتمال الرسالة.	‏‏نعم‬
└─ السبب	string	سبب عدم اكتمال الرسالة.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم `thread.message`دائما .	‏‏نعم‬
role	string	الكيان الذي أنتج الرسالة. أحد `user` أو `assistant`.	‏‏نعم‬
run_id	string	إذا كان ذلك ممكنا، معرف التشغيل المقترن بتأليف هذه الرسالة.	‏‏نعم‬
الحالة	string	حالة الرسالة، والتي يمكن أن تكون إما `in_progress`أو `incomplete`أو `completed`.	‏‏نعم‬
thread_id	string	معرف مؤشرات الترابط التي تنتمي إليها هذه الرسالة.	‏‏نعم‬

تعداد الكائن: MessageObjectType

قيمة	وصف
thread.message	نوع كائن الرسالة الذي هو `thread.message`

قائمة تعداد الحالة: MessageObjectStatus

قيمة	وصف
in_progress
incomplete
completed

قائمة تعداد الدور: MessageObjectRole

قيمة	وصف
user
assistant

messageDeltaObject

يمثل دلتا رسالة، أي أي حقول تم تغييرها في رسالة أثناء البث.

الاسم	النوع	وصف	مطلوب
الدلتا	object	دلتا تحتوي على الحقول التي تم تغييرها في الرسالة.	‏‏نعم‬
└─ المحتوى	صفيف	محتوى الرسالة في صفيف من النص و/أو الصور.	لا
└─ الدور	string	الكيان الذي أنتج الرسالة. أحد `user` أو `assistant`.	لا
المعرف	string	معرف الرسالة، والذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم `thread.message.delta`دائما .	‏‏نعم‬

تعداد الكائن: MessageDeltaObjectType

قيمة	وصف
thread.message.delta

createMessageRequest

الاسم	النوع	وصف	مطلوب
attachments	صفيف	قائمة بالملفات المرفقة بالرسالة والأدوات التي يجب إضافتها إليها.	لا
محتوى	string	محتوى الرسالة.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
role	string	دور الكيان الذي يقوم بإنشاء الرسالة. تتضمن القيم المسموح بها ما يلي: - `user`: يشير إلى أن الرسالة يتم إرسالها بواسطة مستخدم فعلي ويجب استخدامها في معظم الحالات لتمثيل الرسائل التي أنشأها المستخدم. - `assistant`: يشير إلى إنشاء الرسالة بواسطة المساعد. استخدم هذه القيمة لإدراج رسائل من المساعد في المحادثة.	‏‏نعم‬

قائمة تعداد الدور: CreateMessageRequestRole

قيمة	وصف
user
assistant

modifyMessageRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا

deleteMessageResponse

الاسم	النوع	مطلوب
deleted	boolean	‏‏نعم‬
المعرف	string	‏‏نعم‬
object	string	‏‏نعم‬

تعداد الكائن: DeleteMessageResponseObject

قيمة	وصف
thread.message.deleted	حالة كائن استجابة رسالة الحذف

listMessagesResponse

الاسم	النوع	مطلوب
البيانات	صفيف	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
object	string	‏‏نعم‬

messageContentImageFileObject

يشير إلى ملف صورة في محتوى رسالة.

الاسم	النوع	وصف	مطلوب
image_file	object		‏‏نعم‬
└─ file_id	string	معرف الملف للصورة في محتوى الرسالة.	لا
النوع	string	دائمًا `image_file`.	‏‏نعم‬

نوع التعداد: MessageContentImageFileObjectType

قيمة	وصف
image_file	نوع ملف صورة محتوى الرسالة

messageContentTextObject

محتوى النص الذي يشكل جزءا من رسالة.

الاسم	النوع	وصف	مطلوب
نص	object		‏‏نعم‬
└─ التعليقات التوضيحية	صفيف		لا
└─ القيمة	string	البيانات التي تشكل النص.	لا
النوع	string	دائمًا `text`.	‏‏نعم‬

نوع قائمة تعداد: messageContentTextObjectType

قيمة	وصف
نص	نوع كائن نص محتوى الرسالة

messageContentTextAnnotationsFileCitationObject

اقتباس داخل الرسالة يشير إلى اقتباس معين من ملف معين مقترن بالمساعد أو الرسالة. يتم إنشاؤه عندما يستخدم المساعد أداة "الاسترداد" للبحث في الملفات.

الاسم	النوع	وصف	مطلوب
end_index	integer		‏‏نعم‬
file_citation	object		‏‏نعم‬
└─ file_id	string	معرف الملف المحدد الذي يتم الاقتباس منه.	لا
start_index	integer		‏‏نعم‬
نص	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	‏‏نعم‬
النوع	string	دائمًا `file_citation`.	‏‏نعم‬

نوع التعداد: FileCitationObjectType

قيمة	وصف
file_citation	نوع كائن اقتباس الملف

messageContentTextAnnotationsFilePathObject

عنوان URL للملف الذي تم إنشاؤه عندما استخدم code_interpreter المساعد الأداة لإنشاء ملف.

الاسم	النوع	وصف	مطلوب
end_index	integer		‏‏نعم‬
file_path	object		‏‏نعم‬
└─ file_id	string	معرف الملف الذي تم إنشاؤه.	لا
start_index	integer		‏‏نعم‬
نص	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	‏‏نعم‬
النوع	string	دائمًا `file_path`.	‏‏نعم‬

نوع قائمة التعداد: FilePathObjectType

قيمة	وصف
file_path	نوع كائن مسار الملف

messageDeltaContentImageFileObject

يشير إلى ملف صورة في محتوى رسالة.

الاسم	النوع	وصف	مطلوب
image_file	object		لا
└─ file_id	string	معرف الملف للصورة في محتوى الرسالة.	لا
الفهرس	integer	فهرس جزء المحتوى في الرسالة.	‏‏نعم‬
النوع	string	دائمًا `image_file`.	‏‏نعم‬

نوع التعداد: MessageDeltaContentImageFileObjectType

قيمة	وصف
image_file

messageDeltaContentTextObject

محتوى النص الذي يشكل جزءا من رسالة.

الاسم	النوع	وصف	مطلوب
الفهرس	integer	فهرس جزء المحتوى في الرسالة.	‏‏نعم‬
نص	object		لا
└─ التعليقات التوضيحية	صفيف		لا
└─ القيمة	string	البيانات التي تشكل النص.	لا
النوع	string	دائمًا `text`.	‏‏نعم‬

نوع التعداد: MessageDeltaContentTextObjectType

قيمة	وصف
نص

messageDeltaContentTextAnnotationsFileCitationObject

اقتباس داخل الرسالة يشير إلى اقتباس معين من ملف معين مقترن بالمساعد أو الرسالة. يتم إنشاؤه عندما يستخدم المساعد أداة "file_search" للبحث في الملفات.

الاسم	النوع	وصف	مطلوب
end_index	integer		لا
file_citation	object		لا
└─ file_id	string	معرف الملف المحدد الذي يتم الاقتباس منه.	لا
└─ اقتباس	string	عرض الأسعار المحدد في الملف.	لا
الفهرس	integer	فهرس التعليق التوضيحي في جزء محتوى النص.	‏‏نعم‬
start_index	integer		لا
نص	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	لا
النوع	string	دائمًا `file_citation`.	‏‏نعم‬

نوع التعداد: MessageDeltaContentTextAnnotationsFileCitationObjectType

قيمة	وصف
file_citation

messageDeltaContentTextAnnotationsFilePathObject

عنوان URL للملف الذي تم إنشاؤه عندما استخدم code_interpreter المساعد الأداة لإنشاء ملف.

الاسم	النوع	وصف	مطلوب
end_index	integer		لا
file_path	object		لا
└─ file_id	string	معرف الملف الذي تم إنشاؤه.	لا
الفهرس	integer	فهرس التعليق التوضيحي في جزء محتوى النص.	‏‏نعم‬
start_index	integer		لا
نص	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	لا
النوع	string	دائمًا `file_path`.	‏‏نعم‬

نوع التعداد: MessageDeltaContentTextAnnotationsFilePathObjectType

قيمة	وصف
file_path

runStepObject

يمثل خطوة في تنفيذ تشغيل.

الاسم	النوع	وصف	مطلوب
assistant_id	string	معرف المساعد المقترن بخطوة التشغيل.	‏‏نعم‬
cancelled_at	integer	الطابع الزمني Unix (بالثوان) لوقت إلغاء خطوة التشغيل.	‏‏نعم‬
completed_at	integer	الطابع الزمني Unix (بالثوان) عند اكتمال خطوة التشغيل.	‏‏نعم‬
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء خطوة التشغيل.	‏‏نعم‬
expired_at	integer	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية خطوة التشغيل. تعتبر الخطوة منتهية الصلاحية إذا انتهت صلاحية التشغيل الأصل.	‏‏نعم‬
failed_at	integer	الطابع الزمني Unix (بالثوان) لوقت فشل خطوة التشغيل.	‏‏نعم‬
المعرف	string	معرف خطوة التشغيل، والتي يمكن الرجوع إليها في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
last_error	object	الخطأ الأخير المقترن بخطوة التشغيل هذه. سيتم `null` إذا لم تكن هناك أخطاء.	‏‏نعم‬
└─ كود	string	أحد `server_error` أو `rate_limit_exceeded`.	لا
└─ رسالة	string	وصف يمكن للإنسان قراءته للخطأ.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم `assistant.run.step`دائما .	‏‏نعم‬
run_id	string	معرف التشغيل الذي تعد خطوة التشغيل هذه جزءا منه.	‏‏نعم‬
الحالة	string	حالة التشغيل، والتي يمكن أن تكون إما `in_progress`أو `cancelledfailedcompleted`.`expired`	‏‏نعم‬
step_details	runStepDetailsMessageCreationObject أو runStepDetailsToolCallsObject	تفاصيل خطوة التشغيل.	‏‏نعم‬
thread_id	string	معرف مؤشرات الترابط التي تم تشغيلها.	‏‏نعم‬
النوع	string	نوع خطوة التشغيل، والتي يمكن أن تكون إما `message_creation` أو `tool_calls`.	‏‏نعم‬

تعداد الكائن: RunStepObjectType

قيمة	وصف
assistant.run.step	نوع الكائن، الذي يكون دائما `assistant.run.step`

نوع التعداد: RunStepObjectType

قيمة	وصف
message_creation	خطوة تشغيل message_creation
tool_calls	خطوة تشغيل tool_calls

قائمة تعداد الحالة: RunStepObjectStatus

قيمة	وصف
in_progress	حالة تشغيل in_progress
cancelled	حالة التشغيل الملغاة
failed	حالة التشغيل الملغاة
completed	حالة التشغيل الملغاة
expired	حالة التشغيل الملغاة

runStepDeltaObject

يمثل دلتا خطوة تشغيل، أي أي حقول تم تغييرها في خطوة تشغيل أثناء البث.

الاسم	النوع	وصف	مطلوب
الدلتا	object	دلتا تحتوي على الحقول التي تم تغييرها في خطوة التشغيل.	‏‏نعم‬
└─ step_details	runStepDeltaStepDetailsMessageCreationObject أو runStepDeltaStepDetailsToolCallsObject	تفاصيل خطوة التشغيل.	لا
المعرف	string	معرف خطوة التشغيل، والتي يمكن الرجوع إليها في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم `thread.run.step.delta`دائما .	‏‏نعم‬

قائمة تعداد العناصر: RunStepDeltaObjectType

قيمة	وصف
thread.run.step.delta

listRunStepsResponse

الاسم	النوع	مطلوب
البيانات	صفيف	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
object	string	‏‏نعم‬

runStepDetailsMessageCreationObject

تفاصيل إنشاء الرسالة بواسطة خطوة التشغيل.

الاسم	النوع	وصف	مطلوب
message_creation	object		‏‏نعم‬
└─ message_id	string	معرف الرسالة التي تم إنشاؤها بواسطة خطوة التشغيل هذه.	لا
النوع	string	دائمًا `message_creation`.	‏‏نعم‬

نوع التعداد: RunStepDetailsMessageCreationObjectType

قيمة	وصف
message_creation

runStepDeltaStepDetailsMessageCreationObject

تفاصيل إنشاء الرسالة بواسطة خطوة التشغيل.

الاسم	النوع	وصف	مطلوب
message_creation	object		لا
└─ message_id	string	معرف الرسالة التي تم إنشاؤها بواسطة خطوة التشغيل هذه.	لا
النوع	string	دائمًا `message_creation`.	‏‏نعم‬

نوع التعداد: RunStepDeltaStepDetailsMessageCreationObjectType

قيمة	وصف
message_creation

runStepDetailsToolCallsObject

تفاصيل استدعاء الأداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
tool_calls	صفيف	مجموعة من الأدوات تستدعي خطوة التشغيل التي شاركت فيها. يمكن إقران هذه بإحدى الأنواع الثلاثة من الأدوات: `code_interpreter`أو `retrieval` .`function`	‏‏نعم‬
النوع	string	دائمًا `tool_calls`.	‏‏نعم‬

نوع التعداد: RunStepDetailsToolCallsObjectType

قيمة	وصف
tool_calls

runStepDeltaStepDetailsToolCallsObject

تفاصيل استدعاء الأداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
tool_calls	صفيف	مجموعة من الأدوات تستدعي خطوة التشغيل التي شاركت فيها. يمكن إقران هذه بإحدى الأنواع الثلاثة من الأدوات: `code_interpreter`أو `file_search` .`function`	لا
النوع	string	دائمًا `tool_calls`.	‏‏نعم‬

نوع التعداد: RunStepDeltaStepDetailsToolCallsObjectType

قيمة	وصف
tool_calls

runStepDetailsToolCallsCodeObject

تفاصيل أداة مترجم التعليمات البرمجية استدعاء خطوة التشغيل التي شاركت فيها.

الاسم	النوع	وصف	مطلوب
code_interpreter	object	تعريف استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
└─ المدخلات	string	الإدخال إلى استدعاء أداة مترجم التعليمات البرمجية.	لا
└─ المخرجات	صفيف	المخرجات من استدعاء أداة مترجم التعليمات البرمجية. يمكن لمترجم التعليمات البرمجية إخراج عنصر واحد أو أكثر، بما في ذلك النص (`logs`) أو الصور (`image`). يتم تمثيل كل من هذه بواسطة نوع كائن مختلف.	لا
المعرف	string	معرف استدعاء الأداة.	‏‏نعم‬
النوع	string	نوع استدعاء الأداة. سيكون هذا دائما `code_interpreter` لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

نوع التعداد: RunStepDetailsToolCallsCodeObjectType

قيمة	وصف
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

تفاصيل أداة مترجم التعليمات البرمجية استدعاء خطوة التشغيل التي شاركت فيها.

الاسم	النوع	وصف	مطلوب
code_interpreter	object	تعريف استدعاء أداة مترجم التعليمات البرمجية.	لا
└─ المدخلات	string	الإدخال إلى استدعاء أداة مترجم التعليمات البرمجية.	لا
└─ المخرجات	صفيف	المخرجات من استدعاء أداة مترجم التعليمات البرمجية. يمكن لمترجم التعليمات البرمجية إخراج عنصر واحد أو أكثر، بما في ذلك النص (`logs`) أو الصور (`image`). يتم تمثيل كل من هذه بواسطة نوع كائن مختلف.	لا
المعرف	string	معرف استدعاء الأداة.	لا
الفهرس	integer	يستدعي فهرس استدعاء الأداة في صفيف الأدوات.	‏‏نعم‬
النوع	string	نوع استدعاء الأداة. سيكون هذا دائما `code_interpreter` لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

نوع التعداد: RunStepDeltaStepDetailsToolCallsCodeObjectType

قيمة	وصف
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

إخراج النص من استدعاء أداة مترجم التعليمات البرمجية كجزء من خطوة تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
logs	string	إخراج النص من استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
النوع	string	دائمًا `logs`.	‏‏نعم‬

نوع التعداد: RunStepDetailsToolCallsCodeOutputLogsObjectType

قيمة	وصف
logs

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

إخراج النص من استدعاء أداة مترجم التعليمات البرمجية كجزء من خطوة تشغيل.

الاسم	النوع	وصف	مطلوب
الفهرس	integer	فهرس الإخراج في صفيف المخرجات.	‏‏نعم‬
logs	string	إخراج النص من استدعاء أداة مترجم التعليمات البرمجية.	لا
النوع	string	دائمًا `logs`.	‏‏نعم‬

نوع التعداد: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

قيمة	وصف
logs

runStepDetailsToolCallsCodeOutputImageObject

الاسم	النوع	وصف	مطلوب
صورة	object		‏‏نعم‬
└─ file_id	string	معرف الملف للصورة.	لا
النوع	string	دائمًا `image`.	‏‏نعم‬

نوع التعداد: RunStepDetailsToolCallsCodeOutputImageObjectType

قيمة	وصف
صورة

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

الاسم	النوع	وصف	مطلوب
صورة	object		لا
└─ file_id	string	معرف الملف للصورة.	لا
الفهرس	integer	فهرس الإخراج في صفيف المخرجات.	‏‏نعم‬
النوع	string	دائمًا `image`.	‏‏نعم‬

نوع التعداد: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

قيمة	وصف
صورة

runStepDetailsToolCallsFileSearchObject

الاسم	النوع	وصف	مطلوب
file_search	object	في الوقت الحالي، سيكون هذا دائما كائنا فارغا.	‏‏نعم‬
└─ النتائج	صفيف	نتائج البحث في الملفات.	لا
المعرف	string	معرف كائن استدعاء الأداة.	‏‏نعم‬
النوع	string	نوع استدعاء الأداة. سيكون هذا دائما `file_search` لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

نوع التعداد: RunStepDetailsToolCallsFileSearchObjectType

قيمة	وصف
file_search

runStepDetailsToolCallsFileSearchResultObject

مثيل نتيجة للبحث في الملفات.

الاسم	النوع	وصف	مطلوب
محتوى	صفيف	محتوى النتيجة التي تم العثور عليها. يتم تضمين المحتوى فقط إذا طلب عبر معلمة تضمين الاستعلام.	لا
file_id	string	معرف الملف الذي تم العثور على النتيجة فيه.	‏‏نعم‬
file_name	string	اسم الملف الذي تم العثور على النتيجة فيه.	‏‏نعم‬
score	رقم	درجة النتيجة. يجب أن تكون كافة القيم رقم فاصلة عائمة بين 0 و1.	‏‏نعم‬

runStepDeltaStepDetailsToolCallsFileSearchObject

الاسم	النوع	وصف	مطلوب
file_search	object	في الوقت الحالي، سيكون هذا دائما كائنا فارغا.	‏‏نعم‬
المعرف	string	معرف كائن استدعاء الأداة.	لا
الفهرس	integer	يستدعي فهرس استدعاء الأداة في صفيف الأدوات.	‏‏نعم‬
النوع	string	نوع استدعاء الأداة. سيكون هذا دائما `retrieval` لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

نوع التعداد: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

قيمة	وصف
file_search

runStepDetailsToolCallsFunctionObject

الاسم	النوع	وصف	مطلوب
دالة	object	تعريف الدالة التي تم استدعاؤها.	‏‏نعم‬
└─ الحجج	string	الوسيطات التي تم تمريرها إلى الدالة .	لا
└─ الاسم	string	اسم الدالة	لا
└─ الإخراج	string	إخراج الدالة. سيكون `null` هذا إذا لم يتم إرسال المخرجات بعد.	لا
المعرف	string	معرف كائن استدعاء الأداة.	‏‏نعم‬
النوع	string	نوع استدعاء الأداة. سيكون هذا دائما `function` لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

نوع التعداد: RunStepDetailsToolCallsFunctionObjectType

قيمة	وصف
دالة

runStepDeltaStepDetailsToolCallsFunctionObject

الاسم	النوع	وصف	مطلوب
دالة	object	تعريف الدالة التي تم استدعاؤها.	لا
└─ الحجج	string	الوسيطات التي تم تمريرها إلى الدالة .	لا
└─ الاسم	string	اسم الدالة	لا
└─ الإخراج	string	إخراج الدالة. سيكون `null` هذا إذا لم يتم إرسال المخرجات بعد.	لا
المعرف	string	معرف كائن استدعاء الأداة.	لا
الفهرس	integer	يستدعي فهرس استدعاء الأداة في صفيف الأدوات.	‏‏نعم‬
النوع	string	نوع استدعاء الأداة. سيكون هذا دائما `function` لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

نوع التعداد: RunStepDetailsToolCallsFunctionObjectType

قيمة	وصف
دالة

vectorStoreExpirationAfter

نهج انتهاء الصلاحية لمخزن المتجهات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
anchor	string	الطابع الزمني للارتساء الذي يتم بعده تطبيق نهج انتهاء الصلاحية. نقاط الارتساء المدعومة: `last_active_at`.	‏‏نعم‬
days	integer	عدد الأيام بعد وقت الارتساء الذي ستنتهي فيه صلاحية مخزن المتجهات.	‏‏نعم‬

قائمة تعداد الارتساء: VectorStoreExpirationAfterAnchor

قيمة	وصف
last_active_at	الطابع الزمني للارتساء الذي يتم بعده تطبيق نهج انتهاء الصلاحية.

vectorStoreObject

مخزن المتجهات هو مجموعة من الملفات المعالجة التي يمكن استخدامها بواسطة أداة file_search.

الاسم	النوع	وصف	مطلوب
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء مخزن المتجهات.	‏‏نعم‬
expires_after	vectorStoreExpirationAfter	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
expires_at	integer	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية مخزن المتجهات.	لا
file_counts	object		‏‏نعم‬
└─ ملغى	integer	عدد الملفات التي تم إلغاؤها.	لا
└─ مكتمل	integer	عدد الملفات التي تمت معالجتها بنجاح.	لا
└─ فشل	integer	عدد الملفات التي فشلت في معالجتها.	لا
└─ in_progress	integer	عدد الملفات التي تتم معالجتها حاليا.	لا
└─ المجموع	integer	العدد الإجمالي للملفات.	لا
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
last_active_at	integer	الطابع الزمني Unix (بالثوان) لوقت آخر نشاط لمخزن المتجهات.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	‏‏نعم‬
الاسم	string	اسم مخزن المتجهات.	‏‏نعم‬
object	enum	نوع الكائن، الذي يتم `vector_store`دائما . القيم المحتملة: `vector_store`	‏‏نعم‬
الحالة	string	حالة مخزن المتجهات، والتي يمكن أن تكون إما `expired`أو `in_progress`أو `completed`. تشير حالة `completed` إلى أن مخزن المتجهات جاهز للاستخدام.	‏‏نعم‬
usage_bytes	integer	إجمالي عدد وحدات البايت المستخدمة من قبل الملفات في مخزن المتجهات.	‏‏نعم‬

قائمة تعداد الحالة: VectorStoreObjectStatus

قيمة	وصف
expired
in_progress
completed

createVectorStoreRequest

الاسم	النوع	وصف	مطلوب
chunking_strategy	autoChunkingStrategyRequestParam أو staticChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` . ينطبق فقط إذا كان `file_ids` غير فارغ.	لا
expires_after	vectorStoreExpirationAfter	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
file_ids	صفيف	قائمة بمعرفات الملفات التي يجب أن يستخدمها مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
الاسم	string	اسم مخزن المتجهات.	لا

updateVectorStoreRequest

الاسم	النوع	وصف	مطلوب
expires_after	vectorStoreExpirationAfter	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	لا
الاسم	string	اسم مخزن المتجهات.	لا

listVectorStoresResponse

الاسم	النوع	مطلوب
البيانات	صفيف	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
object	string	‏‏نعم‬

deleteVectorStoreResponse

الاسم	النوع	مطلوب
deleted	boolean	‏‏نعم‬
المعرف	string	‏‏نعم‬
object	string	‏‏نعم‬

تعداد الكائن: DeleteVectorStoreResponseObject

قيمة	وصف
vector_store.deleted	حالة كائن استجابة مخزن متجه الحذف

vectorStoreFileObject

قائمة بالملفات المرفقة بمخزن متجهات.

الاسم	النوع	وصف	مطلوب
chunking_strategy	autoChunkingStrategyRequestParam أو staticChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` . ينطبق فقط إذا كان `file_ids` غير فارغ.	لا
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء ملف مخزن المتجهات.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
last_error	object	الخطأ الأخير المقترن بملف مخزن المتجهات هذا. سيتم `null` إذا لم تكن هناك أخطاء.	‏‏نعم‬
└─ كود	string	واحد من `server_error` أو `invalid_file` أو `unsupported_file`.	لا
└─ رسالة	string	وصف يمكن للإنسان قراءته للخطأ.	لا
object	string	نوع الكائن، الذي يتم `vector_store.file`دائما .	‏‏نعم‬
الحالة	string	حالة ملف مخزن المتجهات، والتي يمكن أن تكون إما `in_progress`أو `completed`أو `cancelled`أو `failed`. تشير الحالة `completed` إلى أن ملف مخزن المتجهات جاهز للاستخدام.	‏‏نعم‬
usage_bytes	integer	إجمالي استخدام مخزن المتجهات بالبايت. لاحظ أن هذا قد يكون مختلفا عن حجم الملف الأصلي.	‏‏نعم‬
vector_store_id	string	معرف مخزن المتجهات الذي يتم إرفاق الملف به.	‏‏نعم‬

تعداد الكائن: VectorStoreFileObjectType

قيمة	وصف
vector_store.file

قائمة تعداد الحالة: VectorStoreFileObjectStatus

قيمة	وصف
in_progress
completed
cancelled
failed

otherChunkingStrategyResponseParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	string	دائمًا `other`.	‏‏نعم‬

نوع التعداد: OtherChunkingStrategyResponseParamType

قيمة	وصف
other

staticChunkingStrategyResponseParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
ثابت	staticChunkingStrategy		‏‏نعم‬
النوع	string	دائمًا `static`.	‏‏نعم‬

نوع التعداد: StaticChunkingStrategyResponseParamType

قيمة	وصف
ثابت

staticChunkingStrategy

الاسم	النوع	وصف	مطلوب	الإفتراضي
chunk_overlap_tokens	integer	عدد الرموز المميزة التي تتداخل بين المجموعات. القيمة الافتراضية هي `400`. لاحظ أن التداخل يجب ألا يتجاوز نصف `max_chunk_size_tokens`.	‏‏نعم‬
max_chunk_size_tokens	integer	الحد الأقصى لعدد الرموز المميزة في كل مجموعة. القيمة الافتراضية هي `800`. الحد الأدنى للقيمة هو `100` والحد الأقصى للقيمة هو `4096`.	‏‏نعم‬

autoChunkingStrategyRequestParam

الاستراتيجية الافتراضية. تستخدم هذه الاستراتيجية حاليا من max_chunk_size_tokens800 و chunk_overlap_tokens من 400.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	دائمًا `auto`. القيم المحتملة: `auto`	‏‏نعم‬

staticChunkingStrategyRequestParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
ثابت	staticChunkingStrategy		‏‏نعم‬
النوع	enum	دائمًا `static`. القيم المحتملة: `static`	‏‏نعم‬

chunkingStrategyRequestParam

تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية auto .

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

autoChunkingStrategyRequestParam
staticChunkingStrategyRequestParam

createVectorStoreFileRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
chunking_strategy	chunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` .	لا
file_id	string	معرف ملف يجب أن يستخدمه مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	‏‏نعم‬

listVectorStoreFilesResponse

الاسم	النوع	مطلوب
البيانات	صفيف	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
object	string	‏‏نعم‬

deleteVectorStoreFileResponse

الاسم	النوع	مطلوب
deleted	boolean	‏‏نعم‬
المعرف	string	‏‏نعم‬
object	string	‏‏نعم‬

تعداد الكائن: DeleteVectorStoreFileResponseObject

قيمة	وصف
vector_store.file.deleted

vectorStoreFileBatchObject

مجموعة من الملفات المرفقة بمخزن متجهات.

الاسم	النوع	وصف	مطلوب
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء دفعة ملفات مخزن المتجهات.	‏‏نعم‬
file_counts	object		‏‏نعم‬
└─ ملغى	integer	عدد الملفات التي تم إلغاؤها.	لا
└─ مكتمل	integer	عدد الملفات التي تمت معالجتها.	لا
└─ فشل	integer	عدد الملفات التي فشلت في معالجتها.	لا
└─ in_progress	integer	عدد الملفات التي تتم معالجتها حاليا.	لا
└─ المجموع	integer	العدد الإجمالي للملفات.	لا
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم `vector_store.file_batch`دائما .	‏‏نعم‬
الحالة	string	حالة دفعة ملفات مخزن المتجهات، والتي يمكن أن تكون إما `in_progress`أو `completed`أو `cancelled` أو `failed`.	‏‏نعم‬
vector_store_id	string	معرف مخزن المتجهات الذي يتم إرفاق الملف به.	‏‏نعم‬

تعداد الكائن: VectorStoreFileBatchObjectType

قيمة	وصف
vector_store.files_batch

قائمة تعداد الحالة: VectorStoreFileBatchObjectStatus

قيمة	وصف
in_progress
completed
cancelled
failed

createVectorStoreFileBatchRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
chunking_strategy	chunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` .	لا
file_ids	صفيف	قائمة بمعرفات الملفات التي يجب أن يستخدمها مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	‏‏نعم‬

assistantStreamEvent

يمثل حدثا منبعثا عند دفق تشغيل.

يحتوي كل حدث في دفق الأحداث المرسلة من الخادم على خاصية event وخاصية data:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

نبعث الأحداث كلما تم إنشاء كائن جديد، أو الانتقال إلى حالة جديدة، أو يتم دفقها في أجزاء (دلتا). على سبيل المثال، نبعث thread.run.created عند إنشاء تشغيل جديد، thread.run.completed عند اكتمال التشغيل، وهكذا. عندما يختار مساعد إنشاء رسالة أثناء التشغيل، نبعث حدثا thread.message.created event، وحدثا thread.message.in_progress ، والعديد من thread.message.delta الأحداث، وأخيرا حدثا thread.message.completed .

قد نضيف أحداثا إضافية بمرور الوقت، لذلك نوصي بمعالجة الأحداث غير المعروفة بأمان في التعليمات البرمجية الخاصة بك.

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

threadStreamEvent
runStreamEvent
runStepStreamEvent
messageStreamEvent
errorEvent
doneEvent

threadStreamEvent

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

thread.created

يحدث عند إنشاء مؤشر ترابط جديد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	threadObject	يمثل مؤشر ترابط يحتوي على رسائل.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: threadObject

تعداد الأحداث: ThreadStreamEventEnum

قيمة	وصف
thread.created	حدث إنشاء مؤشر الترابط

runStreamEvent

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

thread.run.created

يحدث عند إنشاء تشغيل جديد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

تعداد الأحداث: RunStreamEventCreated

قيمة	وصف
thread.run.created

thread.run.queued

يحدث عندما ينتقل تشغيل إلى حالة queued .

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

قائمة تعداد الأحداث: RunStreamEventQueued

قيمة	وصف
thread.run.queued

thread.run.in_progress

يحدث عندما ينتقل تشغيل إلى حالة in_progress .

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

تعداد الأحداث: RunStreamEventInProgress

قيمة	وصف
thread.run.in_progress

thread.run.requires_action

يحدث عندما ينتقل تشغيل إلى حالة requires_action .

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

قائمة تعداد الأحداث: RunStreamEventRequiresAction

قيمة	وصف
thread.run.requires_action

thread.run.completed

يحدث عند اكتمال التشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

تعداد الأحداث: RunStreamEventCompleted

قيمة	وصف
thread.run.completed

thread.run.failed

يحدث عند فشل تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

تعداد الأحداث: RunStreamEventFailed

قيمة	وصف
thread.run.failed

thread.run.cancelling

يحدث عندما ينتقل تشغيل إلى حالة cancelling .

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

قائمة تعداد الأحداث: RunStreamEventCancelling

قيمة	وصف
thread.run.cancelling

thread.run.cancelled

يحدث عند إلغاء تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

قائمة تعداد الأحداث: RunStreamEventCancelled

قيمة	وصف
thread.run.cancelled

thread.run.expired

يحدث عند انتهاء صلاحية تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

تعداد الأحداث: RunStreamEventExpired

قيمة	وصف
thread.run.expired

runStepStreamEvent

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

thread.run.step.created

يحدث عند إنشاء خطوة تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ تشغيل.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

تعداد الأحداث: RunStepStreamEventCreated

قيمة	وصف
thread.run.step.created

thread.run.step.in_progress

يحدث عندما تنتقل خطوة تشغيل إلى حالة in_progress .

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ تشغيل.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

تعداد الأحداث: RunStepStreamEventInProgress

قيمة	وصف
thread.run.step.in_progress

thread.run.step.delta

يحدث عندما يتم دفق أجزاء من خطوة تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runStepDeltaObject	يمثل دلتا خطوة تشغيل، أي أي حقول تم تغييرها في خطوة تشغيل أثناء البث.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepDeltaObject

تعداد الأحداث: RunStepStreamEventDelta

قيمة	وصف
thread.run.step.delta

thread.run.step.completed

يحدث عند اكتمال خطوة تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ تشغيل.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

تعداد الأحداث: RunStepStreamEventCompleted

قيمة	وصف
thread.run.step.completed

thread.run.step.failed

يحدث عند فشل خطوة تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ تشغيل.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

قائمة تعداد الأحداث: RunStepStreamEventFailed

قيمة	وصف
thread.run.step.failed

thread.run.step.cancelled

يحدث عند إلغاء خطوة تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ تشغيل.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

قائمة تعداد الأحداث: RunStepStreamEventCancelled

قيمة	وصف
thread.run.step.cancelled

thread.run.step.expired

يحدث عند انتهاء صلاحية خطوة تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ تشغيل.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

تعداد الأحداث: RunStepStreamEventExpired

قيمة	وصف
thread.run.step.expired

messageStreamEvent

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

thread.message.created

يحدث عند إنشاء رسالة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	messageObject	يمثل رسالة داخل مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageObject

قائمة تعداد الأحداث: MessageStreamEventCreated

قيمة	وصف
thread.message.created

thread.message.in_progress

يحدث عندما تنتقل رسالة إلى حالة in_progress .

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	messageObject	يمثل رسالة داخل مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageObject

تعداد الأحداث: MessageStreamEventInProgress

قيمة	وصف
thread.message.in_progress

thread.message.delta

يحدث عندما يتم دفق أجزاء من الرسالة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	messageDeltaObject	يمثل دلتا رسالة، أي أي حقول تم تغييرها في رسالة أثناء البث.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageDeltaObject

قائمة تعداد الأحداث: MessageStreamEventDelta

قيمة	وصف
thread.message.delta

thread.message.completed

يحدث عند اكتمال رسالة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	messageObject	يمثل رسالة داخل مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageObject

قائمة تعداد الأحداث: MessageStreamEventCompleted

قيمة	وصف
thread.message.completed

thread.message.incomplete

يحدث عندما تنتهي الرسالة قبل اكتمالها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	messageObject	يمثل رسالة داخل مؤشرات ترابط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageObject

قائمة تعداد الأحداث: MessageStreamEventIncomplete

قيمة	وصف
thread.message.incomplete

Annotation

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

FileCitation
UrlCitation
FilePath

Click

إجراء النقر.

الاسم	النوع	وصف	مطلوب
زر	enum	يشير إلى زر الماوس الذي تم الضغط عليه أثناء النقر. واحد من `left`أو `rightwheel`أو `back`أو أو `forward`. القيم المحتملة: `left`، `right`، `wheel`، ، `backforward`	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. لإجراء النقر، يتم تعيين هذه الخاصية دائما إلى `click`. القيم المحتملة: `click`	‏‏نعم‬
×	integer	الإحداثي س حيث حدث النقر.	‏‏نعم‬
y	integer	الإحداثي ص حيث حدث النقر.	‏‏نعم‬

CodeInterpreterFileOutput

إخراج استدعاء أداة مترجم التعليمات البرمجية وهو ملف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
files	صفيف		‏‏نعم‬
النوع	enum	نوع إخراج ملف مترجم التعليمات البرمجية. دائمًا `files`. القيم المحتملة: `files`	‏‏نعم‬

CodeInterpreterTextOutput

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
logs	string	سجلات استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
النوع	enum	نوع إخراج نص مترجم التعليمات البرمجية. دائمًا `logs`. القيم المحتملة: `logs`	‏‏نعم‬

CodeInterpreterTool

أداة تقوم بتشغيل التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_ids	صفيف	معرفات الملفات لتشغيل التعليمات البرمجية عليها.	‏‏نعم‬
النوع	enum	نوع أداة مترجم التعليمات البرمجية. دائمًا `code_interpreter`. القيم المحتملة: `code_interpreter`	‏‏نعم‬

CodeInterpreterToolCall

استدعاء أداة لتشغيل التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب
رمز	string	التعليمات البرمجية المراد تشغيلها.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
results	صفيف	نتائج استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
الحالة	enum	حالة استدعاء أداة مترجم التعليمات البرمجية. القيم المحتملة: `in_progress`، ، `interpretingcompleted`	‏‏نعم‬
النوع	enum	نوع استدعاء أداة مترجم التعليمات البرمجية. دائمًا `code_interpreter_call`. القيم المحتملة: `code_interpreter_call`	‏‏نعم‬

CodeInterpreterToolOutput

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

CodeInterpreterTextOutput
CodeInterpreterFileOutput

ComparisonFilter

عامل تصفية يستخدم لمقارنة مفتاح سمة محدد بقيمة معينة باستخدام عملية مقارنة محددة.

الاسم	النوع	وصف	مطلوب
مفتاح	string	المفتاح للمقارنة مقابل القيمة.	‏‏نعم‬
النوع	enum	يحدد عامل المقارنة: `eq`، `ne`، `gt`، `gte`، `lt`، . `lte` - `eq`:يساوي - `ne`: غير متساوي - `gt`:اكبر - `gte`: أكبر من أو يساوي - `lt`:اقل - `lte`: أقل من أو يساوي القيم المحتملة: `eq`، `ne`، `gt`، `gte`، ، `ltlte`	‏‏نعم‬
القيمة	سلسلة أو رقم أو قيمة منطقية	القيمة المراد مقارنتها بمفتاح السمة؛ يدعم أنواع السلسلة أو الرقم أو القيم المنطقية.	‏‏نعم‬

CompoundFilter

دمج عوامل تصفية متعددة باستخدام and أو or.

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	صفيف	صفيف عوامل التصفية المراد دمجها. يمكن أن تكون `ComparisonFilter` العناصر أو `CompoundFilter`.	‏‏نعم‬
النوع	enum	نوع العملية: `and` أو `or`. القيم المحتملة: `and`، `or`	‏‏نعم‬

ComputerAction

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

Click
DoubleClick
Drag
KeyPress
Move
Screenshot
Scroll
Type
Wait

ComputerScreenshotImage

صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.

الاسم	النوع	وصف	مطلوب
file_id	string	معرف ملف تم تحميله يحتوي على لقطة الشاشة.	لا
image_url	string	عنوان URL لصورة لقطة الشاشة.	لا
النوع	enum	يحدد نوع الحدث. للحصول على لقطة شاشة للكمبيوتر، يتم تعيين هذه الخاصية دائما إلى `computer_screenshot`. القيم المحتملة: `computer_screenshot`	‏‏نعم‬

ComputerTool

أداة تتحكم في جهاز كمبيوتر ظاهري.

الاسم	النوع	وصف	مطلوب
display_height	رقم	ارتفاع جهاز عرض الكمبيوتر.	‏‏نعم‬
display_width	رقم	عرض جهاز عرض الكمبيوتر.	‏‏نعم‬
environment	enum	نوع بيئة الكمبيوتر التي يجب التحكم فيها. القيم المحتملة: `mac`، `windows`، ، `ubuntubrowser`	‏‏نعم‬
النوع	enum	نوع أداة استخدام الكمبيوتر. دائمًا `computer_use_preview`. القيم المحتملة: `computer-use-preview`	‏‏نعم‬

ComputerToolCall

استدعاء أداة إلى أداة استخدام الكمبيوتر.

الاسم	النوع	وصف	مطلوب
إجراء	ComputerAction		‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء الكمبيوتر.	‏‏نعم‬
pending_safety_checks	صفيف	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	‏‏نعم‬
النوع	enum	نوع مكالمة الكمبيوتر. دائمًا `computer_call`. القيم المحتملة: `computer_call`	‏‏نعم‬

ComputerToolCallOutput

إخراج استدعاء أداة الكمبيوتر.

الاسم	النوع	وصف	مطلوب
acknowledged_safety_checks	صفيف	عمليات التحقق من السلامة التي تم الإبلاغ عنها بواسطة واجهة برمجة التطبيقات التي أقر بها المطور.	لا
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج الإخراج.	‏‏نعم‬
المعرف	string	معرف إخراج استدعاء أداة الكمبيوتر.	لا
الناتج	ComputerScreenshotImage	صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من `in_progress`أو `completed`أو `incomplete`. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	لا
النوع	enum	نوع إخراج استدعاء أداة الكمبيوتر. دائمًا `computer_call_output`. القيم المحتملة: `computer_call_output`	‏‏نعم‬

ComputerToolCallOutputResource

الاسم	النوع	وصف	مطلوب
acknowledged_safety_checks	صفيف	عمليات التحقق من السلامة التي تم الإبلاغ عنها بواسطة واجهة برمجة التطبيقات التي أقر بها المطور.	لا
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج الإخراج.	‏‏نعم‬
المعرف	string	المعرف الفريد لإخراج أداة استدعاء الكمبيوتر.	‏‏نعم‬
الناتج	ComputerScreenshotImage	صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من `in_progress`أو `completed`أو `incomplete`. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	لا
النوع	enum	نوع إخراج استدعاء أداة الكمبيوتر. دائمًا `computer_call_output`. القيم المحتملة: `computer_call_output`	‏‏نعم‬

ComputerToolCallSafetyCheck

فحص أمان معلق لمكالمة الكمبيوتر.

الاسم	النوع	وصف	مطلوب
رمز	string	نوع فحص الأمان المعلق.	‏‏نعم‬
المعرف	string	معرف فحص السلامة المعلق.	‏‏نعم‬
رسالة	string	تفاصيل حول فحص السلامة المعلق.	‏‏نعم‬

المحتوى

محتويات الإدخال والإخراج متعددة الوسائط.

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

InputContent
OutputContent

Coordinate

زوج إحداثيات x/y، على سبيل المثال { x: 100, y: 200 }.

الاسم	النوع	وصف	مطلوب	الإفتراضي
×	integer	إحداثيات x.	‏‏نعم‬
y	integer	إحداثيات y.	‏‏نعم‬

CreateModelResponseProperties

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
نموذج	string	النموذج المستخدم لإنشاء الاستجابات.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	لا	1
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	لا	1
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد OpenAI على مراقبة إساءة الاستخدام واكتشافها. .	لا

createResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
include	صفيف	{"$ref": "#/components/schemas/includable/description"}	لا
الادخال	سلسلة أو مجموعة	النص أو الصورة أو إدخالات الملفات إلى النموذج، المستخدمة لإنشاء استجابة.	‏‏نعم‬
تعليمات	string	إدراج رسالة نظام (أو مطور) كعنصر أول في سياق النموذج. عند استخدام جنبا إلى جنب مع `previous_response_id`، لن يتم نقل الإرشادات من استجابة سابقة إلى الاستجابة التالية. وهذا يجعل من السهل تبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية.	لا
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	لا
المنطق	Reasoning	خيارات التكوين لنماذج المنطق.	لا
store	boolean	ما إذا كنت تريد تخزين استجابة النموذج التي تم إنشاؤها للاسترداد لاحقا عبر واجهة برمجة التطبيقات.	لا	صحيح
استدر	boolean	إذا تم تعيينها إلى true، دفق بيانات استجابة النموذج إلى العميل كما يتم إنشاؤها باستخدام الأحداث المرسلة من الخادم.	لا	خطأ
نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ التنسيق	TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين `{ "type": "json_schema" }` المخرجات المنظمة، مما يضمن تطابق النموذج مع مخطط JSON المقدم. التنسيق الافتراضي مع `{ "type": "text" }` عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: الإعداد لتمكين `{ "type": "json_object" }` وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام `json_schema` للنماذج التي تدعمه.	لا
tool_choice	ToolChoiceOptions أو ToolChoiceTypes أو ToolChoiceFunction	كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة `tools` لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.	لا
الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. يمكنك تحديد الأداة التي يجب استخدامها عن طريق تعيين المعلمة `tool_choice` . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة	لا
اقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - `auto`: إذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج، فسيقتطاع النموذج استجابة لاحتواء نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (افتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، فسيفشل الطلب مع حدوث خطأ 400. القيم المحتملة: `auto`، `disabled`	لا

DoubleClick

إجراء النقر المزدوج.

الاسم	النوع	وصف	مطلوب
النوع	enum	يحدد نوع الحدث. لإجراء النقر المزدوج، يتم تعيين هذه الخاصية دائما إلى `double_click`. القيم المحتملة: `double_click`	‏‏نعم‬
×	integer	الإحداثي س حيث حدث النقر المزدوج.	‏‏نعم‬
y	integer	الإحداثي ص حيث حدث النقر المزدوج.	‏‏نعم‬

Drag

إجراء سحب.

الاسم	النوع	وصف	مطلوب	الإفتراضي
path	صفيف	مصفوفة من الإحداثيات تمثل مسار إجراء السحب. ستظهر الإحداثيات كصفيف من العناصر، على سبيل المثال`[{ x: 100, y: 200 }, { x: 200, y: 300 }]`	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. لإجراء السحب، يتم تعيين هذه الخاصية دائما إلى `drag`. القيم المحتملة: `drag`	‏‏نعم‬

EasyInputMessage

إدخال رسالة إلى النموذج مع دور يشير إلى التعليمات التالية التسلسل الهرمي. الإرشادات المعطاة developer مع الدور أو system لها الأسبقية على الإرشادات المعطاة مع user الدور. يفترض أن الرسائل التي assistant لها الدور قد تم إنشاؤها بواسطة النموذج في التفاعلات السابقة.

الاسم	النوع	وصف	مطلوب
محتوى	سلسلة أو InputMessageContentList	إدخال النص أو الصورة أو الصوت إلى النموذج، المستخدم لإنشاء استجابة. يمكن أن يحتوي أيضا على استجابات المساعد السابقة.	‏‏نعم‬
role	enum	دور إدخال الرسالة. واحد من `user`أو `assistantsystem`أو أو `developer`. القيم المحتملة: `user`، `assistant`، ، `systemdeveloper`	‏‏نعم‬
النوع	enum	نوع إدخال الرسالة. دائمًا `message`. القيم المحتملة: `message`	لا

FileCitation

اقتباس إلى ملف.

الاسم	النوع	وصف	مطلوب
file_id	string	معرف الملف.	‏‏نعم‬
الفهرس	integer	فهرس الملف في قائمة الملفات.	‏‏نعم‬
النوع	enum	نوع الاقتباس من الملف. دائمًا `file_citation`. القيم المحتملة: `file_citation`	‏‏نعم‬

FilePath

مسار إلى ملف.

الاسم	النوع	وصف	مطلوب
file_id	string	معرف الملف.	‏‏نعم‬
الفهرس	integer	فهرس الملف في قائمة الملفات.	‏‏نعم‬
النوع	enum	نوع مسار الملف. دائمًا `file_path`. القيم المحتملة: `file_path`	‏‏نعم‬

FileSearchRanker

المصنف الذي يجب استخدامه للبحث عن الملفات. إذا لم يتم تحديد سيستخدم auto ranker.

الخاصية	قيمة
الوصف	المصنف الذي يجب استخدامه للبحث عن الملفات. إذا لم يتم تحديد سيستخدم `auto` ranker.
Type	string
Values	`auto` `default_2024_08_21`

FileSearchTool

أداة تبحث عن محتوى ذي صلة من الملفات التي تم تحميلها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	ComparisonFilter أو CompoundFilter	عامل تصفية لتطبيقه استنادا إلى سمات الملف.	لا
max_num_results	integer	الحد الأقصى لعدد النتائج التي سيتم إرجاعها. يجب أن يتراوح هذا الرقم بين 1 و50 ضمنا.	لا
ranking_options	object	خيارات تحديد المرتبة للبحث.	لا
└─ المرتبة	enum	المصنف الذي يجب استخدامه للبحث عن الملفات. القيم المحتملة: `auto`، `default-2024-11-15`	لا
└─ score_threshold	رقم	حد الدرجة للبحث في الملف، رقم بين 0 و1. ستحاول الأرقام الأقرب إلى 1 إرجاع النتائج الأكثر صلة فقط، ولكنها قد ترجع نتائج أقل.	لا	0
النوع	enum	نوع أداة البحث عن الملفات. دائمًا `file_search`. القيم المحتملة: `file_search`	‏‏نعم‬
vector_store_ids	صفيف	تخزن معرفات المتجهات للبحث.	‏‏نعم‬

FileSearchToolCall

نتائج استدعاء أداة البحث في الملفات.

الاسم	النوع	وصف	مطلوب
المعرف	string	المعرف الفريد لاستدعاء أداة البحث عن الملفات.	‏‏نعم‬
queries	صفيف	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
results	صفيف	نتائج استدعاء أداة البحث عن الملفات.	لا
الحالة	enum	حالة استدعاء أداة البحث عن الملفات. واحد من `in_progress`أو `searchingincomplete` أو أو `failed` القيم المحتملة: `in_progress`، `searching`، `completed`، ، `incompletefailed`	‏‏نعم‬
النوع	enum	نوع استدعاء أداة البحث عن الملفات. دائمًا `file_search_call`. القيم المحتملة: `file_search_call`	‏‏نعم‬

FunctionTool

تعريف دالة في التعليمات البرمجية الخاصة بك التي يمكن للنموذج اختيار الاتصال بها.

الاسم	النوع	وصف	مطلوب
الوصف	string	وصف للدالة. يستخدم من قبل النموذج لتحديد ما إذا كان يجب استدعاء الدالة أم لا.	لا
الاسم	string	اسم الدالة التي يجب استدعاها.	‏‏نعم‬
المعلمات	object	كائن مخطط JSON يصف معلمات الدالة.	‏‏نعم‬
صارم	boolean	ما إذا كان يجب فرض التحقق الصارم من صحة المعلمة. الافتراضي `true`.	‏‏نعم‬
النوع	enum	نوع أداة الدالة. دائمًا `function`. القيم المحتملة: `function`	‏‏نعم‬

FunctionToolCall

استدعاء أداة لتشغيل دالة.

الاسم	النوع	وصف	مطلوب
الحجج	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء أداة الدالة.	‏‏نعم‬
الاسم	string	اسم الدالة المراد تشغيلها.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	لا
النوع	enum	نوع استدعاء أداة الدالة. دائمًا `function_call`. القيم المحتملة: `function_call`	‏‏نعم‬

FunctionToolCallOutput

إخراج استدعاء أداة دالة.

الاسم	النوع	وصف	مطلوب
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
المعرف	string	المعرف الفريد لإخراج استدعاء أداة الدالة. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	لا
الناتج	string	سلسلة JSON من إخراج استدعاء أداة الدالة.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	لا
النوع	enum	نوع إخراج استدعاء أداة الدالة. دائمًا `function_call_output`. القيم المحتملة: `function_call_output`	‏‏نعم‬

FunctionToolCallOutputResource

الاسم	النوع	وصف	مطلوب
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
المعرف	string	المعرف الفريد لإخراج أداة استدعاء الدالة.	‏‏نعم‬
الناتج	string	سلسلة JSON من إخراج استدعاء أداة الدالة.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	لا
النوع	enum	نوع إخراج استدعاء أداة الدالة. دائمًا `function_call_output`. القيم المحتملة: `function_call_output`	‏‏نعم‬

includable

حدد بيانات إخراج إضافية لتضمينها في استجابة النموذج. القيم المدعومة حاليا هي:

file_search_call.resultsقم بتضمين نتائج البحث لاستدعاء أداة البحث عن الملفات.:
message.input_image.image_urlقم بتضمين عناوين URL للصور من رسالة الإدخال.:
computer_call_output.output.image_urlقم بتضمين عناوين URL للصور من إخراج استدعاء الكمبيوتر.:

الخاصية	قيمة
الوصف	حدد بيانات إخراج إضافية لتضمينها في استجابة النموذج. القيم المدعومة حاليا هي: - `file_search_call.results`: قم بتضمين نتائج البحث لاستدعاء أداة البحث عن الملفات. - `message.input_image.image_url`: قم بتضمين عناوين URL للصور من رسالة الإدخال. - `computer_call_output.output.image_url`: قم بتضمين عناوين URL للصور من إخراج استدعاء الكمبيوتر.
Type	string
Values	`file_search_call.results` `message.input_image.image_url` `computer_call_output.output.image_url`

InputAudio

إدخال صوتي للنموذج.

الاسم	النوع	وصف	مطلوب
البيانات	string	بيانات صوتية مرمزة ب Base64.	‏‏نعم‬
format	enum	تنسيق البيانات الصوتية. التنسيقات المدعومة حاليا هي `mp3` و `wav`. القيم المحتملة: `mp3`، `wav`	‏‏نعم‬
النوع	enum	نوع عنصر الإدخال. دائمًا `input_audio`. القيم المحتملة: `input_audio`	‏‏نعم‬

InputContent

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

InputText
InputImage
InputFile

InputFile

إدخال ملف إلى النموذج.

الاسم	النوع	وصف	مطلوب
file_data	string	محتوى الملف الذي سيتم إرساله إلى النموذج.	لا
file_id	string	معرف الملف الذي سيتم إرساله إلى النموذج.	لا
filename	string	اسم الملف الذي سيتم إرساله إلى النموذج.	لا
النوع	enum	نوع عنصر الإدخال. دائمًا `input_file`. القيم المحتملة: `input_file`	‏‏نعم‬

InputImage

إدخال صورة إلى النموذج.

الاسم	النوع	وصف	مطلوب
تفصيل	enum	مستوى تفاصيل الصورة التي سيتم إرسالها إلى النموذج. واحد من `high`أو `low`أو `auto`. الإعدادات الافتراضية لـ `auto`. القيم المحتملة: `high`، ، `lowauto`	‏‏نعم‬
file_id	string	معرف الملف الذي سيتم إرساله إلى النموذج.	لا
image_url	string	عنوان URL للصورة التي سيتم إرسالها إلى النموذج. عنوان URL مؤهل بالكامل أو صورة مشفرة base64 في عنوان URL للبيانات.	لا
النوع	enum	نوع عنصر الإدخال. دائمًا `input_image`. القيم المحتملة: `input_image`	‏‏نعم‬

InputItem

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

EasyInputMessage
Item
ItemReference

InputMessage

الاسم	النوع	وصف	مطلوب
محتوى	InputMessageContentList	قائمة بعناصر إدخال واحدة أو العديد من عناصر الإدخال إلى النموذج، تحتوي على محتوى مختلف types.	‏‏نعم‬
role	enum	دور إدخال الرسالة. واحد من `user`أو `system`أو `developer`. القيم المحتملة: `user`، ، `systemdeveloper`	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	لا
النوع	enum	نوع إدخال الرسالة. عيّنها بشل دائم إلى `message`. القيم المحتملة: `message`	لا

InputMessageContentList

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

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

InputMessageResource

الاسم	النوع	وصف	مطلوب
محتوى	InputMessageContentList	قائمة بعناصر إدخال واحدة أو العديد من عناصر الإدخال إلى النموذج، تحتوي على محتوى مختلف types.	‏‏نعم‬
المعرف	string	المعرف الفريد لإدخال الرسالة.	‏‏نعم‬
role	enum	دور إدخال الرسالة. واحد من `user`أو `system`أو `developer`. القيم المحتملة: `user`، ، `systemdeveloper`	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	لا
النوع	enum	نوع إدخال الرسالة. عيّنها بشل دائم إلى `message`. القيم المحتملة: `message`	لا

InputText

إدخال نص إلى النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	إدخال النص إلى النموذج.	‏‏نعم‬
النوع	enum	نوع عنصر الإدخال. دائمًا `input_text`. القيم المحتملة: `input_text`	‏‏نعم‬

عنصر

عنصر المحتوى المستخدم لإنشاء استجابة.

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

InputMessage
OutputMessage
FileSearchToolCall
ComputerToolCall
ComputerToolCallOutput
FunctionToolCall
FunctionToolCallOutput
ReasoningItem

ItemReference

معرف داخلي لعنصر للرجوع إليه.

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

ItemResource

عنصر المحتوى المستخدم لإنشاء استجابة.

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

InputMessageResource
OutputMessage
FileSearchToolCall
ComputerToolCall
ComputerToolCallOutputResource
FunctionToolCall
FunctionToolCallOutputResource

KeyPress

مجموعة من ضغطات المفاتيح التي يرغب النموذج في تنفيذها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
keys	صفيف	مجموعة المفاتيح التي يطلب النموذج الضغط عليها. هذا صفيف من السلاسل، يمثل كل منها مفتاحا.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. لإجراء keypress، يتم تعيين هذه الخاصية دائما إلى `keypress`. القيم المحتملة: `keypress`	‏‏نعم‬

بيانات التعريف

المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.

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

ModelResponseProperties

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
نموذج	string	النموذج المستخدم لإنشاء الاستجابات.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	لا	1
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	لا	1
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد OpenAI على مراقبة إساءة الاستخدام واكتشافها. .	لا

Move

إجراء تحريك الماوس.

الاسم	النوع	وصف	مطلوب
النوع	enum	يحدد نوع الحدث. لإجراء النقل، يتم تعيين هذه الخاصية دائما إلى `move`. القيم المحتملة: `move`	‏‏نعم‬
×	integer	الإحداثي س للانتقال إليه.	‏‏نعم‬
y	integer	الإحداثي ص للانتقال إليه.	‏‏نعم‬

OutputAudio

إخراج صوت من النموذج.

الاسم	النوع	وصف	مطلوب
البيانات	string	بيانات صوتية مرمزة ب Base64 من النموذج.	‏‏نعم‬
نسخه	string	نسخة البيانات الصوتية من النموذج.	‏‏نعم‬
النوع	enum	نوع صوت الإخراج. دائمًا `output_audio`. القيم المحتملة: `output_audio`	‏‏نعم‬

OutputContent

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

OutputText
Refusal

OutputItem

الاسم	النوع	وصف	مطلوب
إجراء	ComputerAction		‏‏نعم‬
الحجج	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	‏‏نعم‬
محتوى	صفيف	تحليل محتويات النص.	‏‏نعم‬
المعرف	string	المعرف الفريد لمحتوى المنطق.	‏‏نعم‬
الاسم	string	اسم الدالة المراد تشغيلها.	‏‏نعم‬
pending_safety_checks	صفيف	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
queries	صفيف	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
results	صفيف	نتائج استدعاء أداة البحث عن الملفات.	لا
role	enum	دور رسالة الإخراج. دائمًا `assistant`. القيم المحتملة: `assistant`	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	‏‏نعم‬
النوع	enum	نوع الكائن. دائمًا `reasoning`. القيم المحتملة: `reasoning`	‏‏نعم‬

OutputMessage

رسالة إخراج من النموذج.

الاسم	النوع	وصف	مطلوب
محتوى	صفيف	محتوى رسالة الإخراج.	‏‏نعم‬
المعرف	string	المعرف الفريد لرسالة الإخراج.	‏‏نعم‬
role	enum	دور رسالة الإخراج. دائمًا `assistant`. القيم المحتملة: `assistant`	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من `in_progress`أو `completed`أو `incomplete`. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	‏‏نعم‬
النوع	enum	نوع رسالة الإخراج. دائمًا `message`. القيم المحتملة: `message`	‏‏نعم‬

OutputText

إخراج نص من النموذج.

الاسم	النوع	وصف	مطلوب
annotations	صفيف	التعليقات التوضيحية لإخراج النص.	‏‏نعم‬
نص	string	إخراج النص من النموذج.	‏‏نعم‬
النوع	enum	نوع النص الناتج. دائمًا `output_text`. القيم المحتملة: `output_text`	‏‏نعم‬

RealtimeSessionCreateRequest

تكوين كائن جلسة العمل في الوقت الحقيقي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_audio_format	enum	تنسيق صوت الإدخال. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`. بالنسبة إلى `pcm16`، يجب أن يكون صوت الإدخال PCM 16 بت بمعدل عينة 24 كيلوهرتز وقناة واحدة (أحادية) وترتيب بايت ذي نهاية صغيرة. القيم المحتملة: `pcm16`، ، `g711_ulawg711_alaw`	لا
input_audio_noise_reduction	object	تكوين الحد من ضوضاء صوت الإدخال. يمكن تعيين هذا إلى `null` لإيقاف التشغيل. يعمل تقليل الضوضاء على تصفية الصوت المضاف إلى المخزن المؤقت لصوت الإدخال قبل إرساله إلى VAD والنموذج. يمكن أن تؤدي تصفية الصوت إلى تحسين VAD وتحويل دقة الكشف (تقليل الإيجابيات الزائفة) وأداء النموذج عن طريق تحسين تصور صوت الإدخال.	لا
└─ النوع	enum	نوع الحد من الضوضاء. `near_field` للميكروفونات القريبة مثل سماعات الرأس، `far_field` مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات. القيم المحتملة: `near_field`، `far_field`	لا
input_audio_transcription	object	تكوين النسخ الصوتي للإدخل، الإعدادات الافتراضية إلى إيقاف التشغيل ويمكن تعيينها إلى `null` إيقاف التشغيل مرة واحدة. النسخ الصوتي للإدخال ليس أصليا للنموذج، لأن النموذج يستهلك الصوت مباشرة. يتم تشغيل النسخ بشكل غير متزامن من خلال نقطة نهاية النسخ وينبغي التعامل معها على أنها إرشادات لمحتوى صوت الإدخال بدلا من ما سمعه النموذج بدقة. يمكن للعميل اختياريا تعيين اللغة والمطالبة بالنسخ، وهذه توفر إرشادات إضافية لخدمة النسخ.	لا
└─ اللغة	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 (على سبيل المثال `en`) إلى تحسين الدقة وزمن الوصول.	لا
└─ نموذج	string	النموذج المراد استخدامه للنسخ ، والخيارات الحالية هي `gpt-4o-transcribe`، `gpt-4o-mini-transcribe`و `gpt-4o-mini-transcribe-2025-12-15`، و `whisper-1`.	لا
└─ موجه	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. بالنسبة إلى `whisper-1`، تكون المطالبة عبارة عن قائمة بالكلمات الأساسية. بالنسبة للنماذج `gpt-4o-transcribe` ، تكون المطالبة عبارة عن سلسلة نصية مجانية، على سبيل المثال "توقع الكلمات المتعلقة بالتكنولوجيا".	لا
تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وتنسيقها، (على سبيل المثال، "كن مختصرا للغاية"، و"تصرف ودودا"، و"فيما يلي أمثلة للاستجابات الجيدة") وعلى السلوك الصوتي (على سبيل المثال، "التحدث بسرعة"، و"إدخال العاطفة في صوتك"، و"الضحك بشكل متكرر"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يعين الإرشادات الافتراضية التي سيتم استخدامها إذا لم يتم تعيين هذا الحقل وتكون مرئية `session.created` في الحدث في بداية جلسة العمل.	لا
max_response_output_tokens	عدد صحيح أو سلسلة	الحد الأقصى لعدد الرموز المميزة للإخراج لاستجابة مساعد واحد، بما في ذلك استدعاءات الأدوات. توفير عدد صحيح بين 1 و4096 للحد من الرموز المميزة للإخراج، أو `inf` للحد الأقصى من الرموز المميزة المتاحة لنموذج معين. الإعدادات الافتراضية لـ `inf`.	لا
طرائق		مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا إلى ["نص"].	لا
نموذج	string	اسم النشر المستخدم لجلسة العمل هذه.	لا
output_audio_format	enum	تنسيق صوت الإخراج. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`. بالنسبة إلى `pcm16`، يتم أخذ عينات من صوت الإخراج بمعدل 24 كيلوهرتز. القيم المحتملة: `pcm16`، ، `g711_ulawg711_alaw`	لا
درجة الحرارة	رقم	درجة حرارة أخذ العينات للنموذج، تقتصر على [0.6، 1.2]. بالنسبة لنماذج الصوت، يوصى بدرجة حرارة 0.8 للحصول على أفضل أداء.	لا	0.8
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي `auto`أو `nonerequired`أو أو تحديد دالة.	لا	تلقائي
الأدوات	صفيف	الأدوات (الوظائف) المتوفرة للنموذج.	لا
turn_detection	object	تكوين الكشف عن الدور أو ether Server VAD أو VAD الدلالي. يمكن تعيين هذا إلى `null` إيقاف التشغيل، وفي هذه الحالة يجب على العميل تشغيل استجابة النموذج يدويا. يعني خادم VAD أن النموذج سيكشف عن بدء الكلام ونهاته استنادا إلى مستوى الصوت والاستجابة في نهاية كلام المستخدم. يعد VAD الدلالي أكثر تقدما ويستخدم نموذج الكشف عن الأدوار (بالاقتران مع VAD) لتقدير ما إذا كان المستخدم قد انتهى من التحدث بشكل دلالي، ثم يعين مهلة ديناميكيا استنادا إلى هذا الاحتمال. على سبيل المثال، إذا تم إيقاف تشغيل صوت المستخدم باستخدام `uhhm`، فسيسجل النموذج احتمالا منخفضا بانتهاء الدوران والانتظار لفترة أطول حتى يستمر المستخدم في التحدث. يمكن أن يكون هذا مفيدا للمحادثات الأكثر طبيعية، ولكن قد يكون له زمن انتقال أعلى.	لا
└─ create_response	boolean	ما إذا كان يجب إنشاء استجابة تلقائيا عند حدوث حدث إيقاف VAD أم لا.	لا	صحيح
└─ الشغف	enum	يستخدم فقط في `semantic_vad` الوضع. رغبة النموذج في الاستجابة. `low` سينتظر المستخدم لفترة أطول حتى يستمر في التحدث، `high` وسيستجيب بسرعة أكبر. `auto` هو الافتراضي ومكافئ ل `medium`. القيم المحتملة: `low`، `medium`، ، `highauto`	لا
└─ interrupt_response	boolean	ما إذا كنت تريد مقاطعة أي استجابة مستمرة تلقائيا مع إخراج للمحادثة الافتراضية (أي `conversation` من `auto`) عند حدوث حدث بدء VAD.	لا	صحيح
└─ prefix_padding_ms	integer	يستخدم فقط في `server_vad` الوضع. مقدار الصوت المطلوب تضمينه قبل الكشف عن الكلام في VAD (بالمللي ثانية). الافتراضيات إلى 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	يستخدم فقط في `server_vad` الوضع. مدة الصمت للكشف عن توقف الكلام (بالمللي ثانية). الافتراضيات إلى 500 مللي ثانية. مع القيم الأقصر، سيستجيب النموذج بسرعة أكبر، ولكن قد يقفز في الإيقاف المؤقت القصير من المستخدم.	لا
└─ عتبة	رقم	يستخدم فقط في `server_vad` الوضع. حد التنشيط ل VAD (0.0 إلى 1.0)، هذا افتراضيا إلى 0.5. سيتطلب الحد الأعلى صوت أعلى لتنشيط النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات الصاخبة.	لا
└─ النوع	enum	نوع الكشف عن الأدوار. القيم المحتملة: `server_vad`، `semantic_vad`	لا
صوت	VoiceIdsShared		لا

RealtimeSessionCreateResponse

تكوين جلسة عمل في الوقت الحقيقي جديد، مع مفتاح سريع الزوال. TTL الافتراضي للمفاتيح هو دقيقة واحدة.

الاسم	النوع	وصف	مطلوب
client_secret	object	مفتاح سريع الزوال الذي تم إرجاعه بواسطة واجهة برمجة التطبيقات.	‏‏نعم‬
└─ expires_at	integer	الطابع الزمني لوقت انتهاء صلاحية الرمز المميز. حاليا، تنتهي صلاحية جميع الرموز المميزة بعد دقيقة واحدة.	لا
└─ القيمة	string	مفتاح سريع الزوال قابل للاستخدام في بيئات العميل لمصادقة الاتصالات بواجهة برمجة التطبيقات في الوقت الحقيقي. استخدم هذا في بيئات من جانب العميل بدلا من رمز مميز قياسي لواجهة برمجة التطبيقات، والذي يجب استخدامه فقط من جانب الخادم.	لا
input_audio_format	string	تنسيق صوت الإدخال. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`.	لا
input_audio_transcription	object	تكوين النسخ الصوتي للإدخل، الإعدادات الافتراضية إلى إيقاف التشغيل ويمكن تعيينها إلى `null` إيقاف التشغيل مرة واحدة. النسخ الصوتي للإدخال ليس أصليا للنموذج، لأن النموذج يستهلك الصوت مباشرة. يعمل النسخ بشكل غير متزامن من خلال الهمس ويجب التعامل معه على أنه إرشادات تقريبية بدلا من التمثيل الذي يفهمه النموذج.	لا
└─ نموذج	string	النموذج الذي يجب استخدامه للنسخ، `whisper-1` هو النموذج الوحيد المدعوم حاليا.	لا
تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وتنسيقها (على سبيل المثال، "كن مختصرا للغاية"، و"التصرف ودي"، و"فيما يلي أمثلة للاستجابات الجيدة") وعلى السلوك الصوتي (على سبيل المثال، "تحدث بسرعة"، و"حقن العاطفة في صوتك"، و"الضحك بشكل متكرر"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يعين الإرشادات الافتراضية التي سيتم استخدامها إذا لم يتم تعيين هذا الحقل وتكون مرئية `session.created` في الحدث في بداية جلسة العمل.	لا
max_response_output_tokens	عدد صحيح أو سلسلة	الحد الأقصى لعدد الرموز المميزة للإخراج لاستجابة مساعد واحد، بما في ذلك استدعاءات الأدوات. توفير عدد صحيح بين 1 و4096 للحد من الرموز المميزة للإخراج، أو `inf` للحد الأقصى من الرموز المميزة المتاحة لنموذج معين. الإعدادات الافتراضية لـ `inf`.	لا
طرائق		مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا إلى ["نص"].	لا
output_audio_format	string	تنسيق صوت الإخراج. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`.	لا
درجة الحرارة	رقم	درجة حرارة أخذ العينات للنموذج، تقتصر على [0.6، 1.2]. الإعدادات الافتراضية إلى 0.8.	لا
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي `auto`أو `nonerequired`أو أو تحديد دالة.	لا
الأدوات	صفيف	الأدوات (الوظائف) المتوفرة للنموذج.	لا
turn_detection	object	تكوين الكشف عن الأدوار. يمكن تعيين إلى `null` لإيقاف التشغيل. يعني خادم VAD أن النموذج سيكشف عن بدء الكلام ونهاته استنادا إلى مستوى الصوت والاستجابة في نهاية كلام المستخدم.	لا
└─ prefix_padding_ms	integer	مقدار الصوت المطلوب تضمينه قبل الكشف عن الكلام في VAD (بالمللي ثانية). الافتراضيات إلى 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	مدة الصمت للكشف عن توقف الكلام (بالمللي ثانية). الافتراضيات إلى 500 مللي ثانية. مع القيم الأقصر، سيستجيب النموذج بسرعة أكبر، ولكن قد يقفز في الإيقاف المؤقت القصير من المستخدم.	لا
└─ عتبة	رقم	حد التنشيط ل VAD (0.0 إلى 1.0)، هذا افتراضيا إلى 0.5. سيتطلب الحد الأعلى صوت أعلى لتنشيط النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات الصاخبة.	لا
└─ النوع	string	نوع الكشف عن الأدوار، معتمد حاليا فقط `server_vad` .	لا
صوت	VoiceIdsShared		لا

RealtimeTranscriptionSessionCreateRequest

تكوين كائن جلسة عمل النسخ في الوقت الحقيقي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
include	صفيف	مجموعة العناصر المراد تضمينها في النسخ. العناصر المتوفرة الحالية هي: - `item.input_audio_transcription.logprobs`	لا
input_audio_format	enum	تنسيق صوت الإدخال. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`. بالنسبة إلى `pcm16`، يجب أن يكون صوت الإدخال PCM 16 بت بمعدل عينة 24 كيلوهرتز وقناة واحدة (أحادية) وترتيب بايت ذي نهاية صغيرة. القيم المحتملة: `pcm16`، ، `g711_ulawg711_alaw`	لا
input_audio_noise_reduction	object	تكوين الحد من ضوضاء صوت الإدخال. يمكن تعيين هذا إلى `null` لإيقاف التشغيل. يعمل تقليل الضوضاء على تصفية الصوت المضاف إلى المخزن المؤقت لصوت الإدخال قبل إرساله إلى VAD والنموذج. يمكن أن تؤدي تصفية الصوت إلى تحسين VAD وتحويل دقة الكشف (تقليل الإيجابيات الزائفة) وأداء النموذج عن طريق تحسين تصور صوت الإدخال.	لا
└─ النوع	enum	نوع الحد من الضوضاء. `near_field` للميكروفونات القريبة مثل سماعات الرأس، `far_field` مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات. القيم المحتملة: `near_field`، `far_field`	لا
input_audio_transcription	object	تكوين النسخ الصوتي للإدخل. يمكن للعميل اختياريا تعيين اللغة والمطالبة بالنسخ، وهذه توفر إرشادات إضافية لخدمة النسخ.	لا
└─ اللغة	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 (على سبيل المثال `en`) إلى تحسين الدقة وزمن الوصول.	لا
└─ نموذج	enum	النموذج المستخدم للنسخ، الخيارات الحالية هي `gpt-4o-transcribe`، ، ، `gpt-4o-transcribe-diarizegpt-4o-mini-transcribe`، و `gpt-4o-mini-transcribe-2025-12-15whisper-1`. القيم المحتملة: `gpt-4o-transcribe`، `gpt-4o-transcribe-diarize`، `gpt-4o-mini-transcribe`، ، `gpt-4o-mini-transcribe-2025-12-15whisper-1`	لا
└─ موجه	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. بالنسبة إلى `whisper-1`، تكون المطالبة عبارة عن قائمة بالكلمات الأساسية. بالنسبة للنماذج `gpt-4o-transcribe` ، تكون المطالبة عبارة عن سلسلة نصية مجانية، على سبيل المثال "توقع الكلمات المتعلقة بالتكنولوجيا".	لا
طرائق		مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا إلى ["نص"].	لا
turn_detection	object	تكوين الكشف عن الدور أو ether Server VAD أو VAD الدلالي. يمكن تعيين هذا إلى `null` إيقاف التشغيل، وفي هذه الحالة يجب على العميل تشغيل استجابة النموذج يدويا. يعني خادم VAD أن النموذج سيكشف عن بدء الكلام ونهاته استنادا إلى مستوى الصوت والاستجابة في نهاية كلام المستخدم. يعد VAD الدلالي أكثر تقدما ويستخدم نموذج الكشف عن الأدوار (بالاقتران مع VAD) لتقدير ما إذا كان المستخدم قد انتهى من التحدث بشكل دلالي، ثم يعين مهلة ديناميكيا استنادا إلى هذا الاحتمال. على سبيل المثال، إذا تم إيقاف تشغيل صوت المستخدم باستخدام `uhhm`، فسيسجل النموذج احتمالا منخفضا بانتهاء الدوران والانتظار لفترة أطول حتى يستمر المستخدم في التحدث. يمكن أن يكون هذا مفيدا للمحادثات الأكثر طبيعية، ولكن قد يكون له زمن انتقال أعلى.	لا
└─ create_response	boolean	ما إذا كان يجب إنشاء استجابة تلقائيا عند حدوث حدث إيقاف VAD أم لا. غير متوفر لجلسات النسخ.	لا	صحيح
└─ الشغف	enum	يستخدم فقط في `semantic_vad` الوضع. رغبة النموذج في الاستجابة. `low` سينتظر المستخدم لفترة أطول حتى يستمر في التحدث، `high` وسيستجيب بسرعة أكبر. `auto` هو الافتراضي ومكافئ ل `medium`. القيم المحتملة: `low`، `medium`، ، `highauto`	لا
└─ interrupt_response	boolean	ما إذا كنت تريد مقاطعة أي استجابة مستمرة تلقائيا مع إخراج للمحادثة الافتراضية (أي `conversation` من `auto`) عند حدوث حدث بدء VAD. غير متوفر لجلسات النسخ.	لا	صحيح
└─ prefix_padding_ms	integer	يستخدم فقط في `server_vad` الوضع. مقدار الصوت المطلوب تضمينه قبل الكشف عن الكلام في VAD (بالمللي ثانية). الافتراضيات إلى 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	يستخدم فقط في `server_vad` الوضع. مدة الصمت للكشف عن توقف الكلام (بالمللي ثانية). الافتراضيات إلى 500 مللي ثانية. مع القيم الأقصر، سيستجيب النموذج بسرعة أكبر، ولكن قد يقفز في الإيقاف المؤقت القصير من المستخدم.	لا
└─ عتبة	رقم	يستخدم فقط في `server_vad` الوضع. حد التنشيط ل VAD (0.0 إلى 1.0)، هذا افتراضيا إلى 0.5. سيتطلب الحد الأعلى صوت أعلى لتنشيط النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات الصاخبة.	لا
└─ النوع	enum	نوع الكشف عن الأدوار. القيم المحتملة: `server_vad`، `semantic_vad`	لا

RealtimeTranscriptionSessionCreateResponse

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

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

الاسم	النوع	وصف	مطلوب
client_secret	object	مفتاح سريع الزوال الذي تم إرجاعه بواسطة واجهة برمجة التطبيقات. موجود فقط عند إنشاء جلسة العمل على الخادم عبر واجهة برمجة تطبيقات REST.	‏‏نعم‬
└─ expires_at	integer	الطابع الزمني لوقت انتهاء صلاحية الرمز المميز. حاليا، تنتهي صلاحية جميع الرموز المميزة بعد دقيقة واحدة.	لا
└─ القيمة	string	مفتاح سريع الزوال قابل للاستخدام في بيئات العميل لمصادقة الاتصالات بواجهة برمجة التطبيقات في الوقت الحقيقي. استخدم هذا في بيئات من جانب العميل بدلا من رمز مميز قياسي لواجهة برمجة التطبيقات، والذي يجب استخدامه فقط من جانب الخادم.	لا
input_audio_format	string	تنسيق صوت الإدخال. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`.	لا
input_audio_transcription	object	تكوين نموذج النسخ.	لا
└─ اللغة	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 (على سبيل المثال `en`) إلى تحسين الدقة وزمن الوصول.	لا
└─ نموذج	enum	النموذج الذي يجب استخدامه للنسخ. يمكن أن يكون `gpt-4o-transcribe` أو `gpt-4o-mini-transcribe` أو `gpt-4o-mini-transcribe-2025-12-15` أو `whisper-1`. القيم المحتملة: `gpt-4o-transcribe`، `gpt-4o-mini-transcribe`، ، `gpt-4o-mini-transcribe-2025-12-15whisper-1`	لا
└─ موجه	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت.	لا
طرائق		مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا إلى ["نص"].	لا
turn_detection	object	تكوين الكشف عن الأدوار. يمكن تعيين إلى `null` لإيقاف التشغيل. يعني خادم VAD أن النموذج سيكشف عن بدء الكلام ونهاته استنادا إلى مستوى الصوت والاستجابة في نهاية كلام المستخدم.	لا
└─ prefix_padding_ms	integer	مقدار الصوت المطلوب تضمينه قبل الكشف عن الكلام في VAD (بالمللي ثانية). الافتراضيات إلى 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	مدة الصمت للكشف عن توقف الكلام (بالمللي ثانية). الافتراضيات إلى 500 مللي ثانية. مع القيم الأقصر، سيستجيب النموذج بسرعة أكبر، ولكن قد يقفز في الإيقاف المؤقت القصير من المستخدم.	لا
└─ عتبة	رقم	حد التنشيط ل VAD (0.0 إلى 1.0)، هذا افتراضيا إلى 0.5. سيتطلب الحد الأعلى صوت أعلى لتنشيط النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات الصاخبة.	لا
└─ النوع	string	نوع الكشف عن الأدوار، معتمد حاليا فقط `server_vad` .	لا

Reasoning

خيارات التكوين لنماذج المنطق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
جهد	ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي `low`و `medium`و.`high` يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة.	‏‏نعم‬	medium
الملخص.	enum	ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيدا لتصحيح أخطاء عملية التفكير في النموذج وفهمها. أحد `concise` أو `detailed`. القيم المحتملة: `concise`، `detailed`	لا

ReasoningItem

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

الاسم	النوع	وصف	مطلوب
محتوى	صفيف	تحليل محتويات النص.	‏‏نعم‬
المعرف	string	المعرف الفريد لمحتوى المنطق.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	لا
النوع	enum	نوع الكائن. دائمًا `reasoning`. القيم المحتملة: `reasoning`	‏‏نعم‬

Refusal

رفض من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رفض	string	تفسير الرفض من النموذج.	‏‏نعم‬
النوع	enum	نوع الرفض. دائمًا `refusal`. القيم المحتملة: `refusal`	‏‏نعم‬

استجابه

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	رقم	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	‏‏نعم‬
خطأ	ResponseError	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	‏‏نعم‬
المعرف	string	معرف فريد لهذه الاستجابة.	‏‏نعم‬
incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	‏‏نعم‬
└─ السبب	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: `max_output_tokens`، `content_filter`	لا
تعليمات	string	إدراج رسالة نظام (أو مطور) كعنصر أول في سياق النموذج. عند استخدام جنبا إلى جنب مع `previous_response_id`، لن يتم نقل الإرشادات من استجابة سابقة إلى الاستجابة التالية. وهذا يجعل من السهل تبديل رسائل النظام (أو المطور) في استجابات جديدة.	‏‏نعم‬
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية وحالة المحادثة.	لا
metadata	Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	‏‏نعم‬
نموذج	string	النموذج المستخدم لإنشاء الاستجابات.	‏‏نعم‬
object	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى `response`. القيم المحتملة: `response`	‏‏نعم‬
الناتج	صفيف	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول العناصر وترتيبها `output` في الصفيف على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في `output` الصفيف وافتراض أنها رسالة `assistant` بالمحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية `output_text` حيث يتم دعمها في SDKs.	‏‏نعم‬
output_text	string	خاصية راحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع `output_text` العناصر في `output` الصفيف، إن وجدت موجودة. مدعوم في Python وJavaScript SDKs.	لا
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	‏‏نعم‬	صحيح
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	لا
المنطق	Reasoning	خيارات التكوين لنماذج المنطق.	لا
الحالة	enum	حالة توليد الاستجابة. واحد من `completed`أو `failedin_progress`أو أو `incomplete`. القيم المحتملة: `completed`، `failed`، ، `in_progressincomplete`	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	‏‏نعم‬	1
نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ التنسيق	TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين `{ "type": "json_schema" }` المخرجات المنظمة، مما يضمن تطابق النموذج مع مخطط JSON المقدم. التنسيق الافتراضي مع `{ "type": "text" }` عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: الإعداد لتمكين `{ "type": "json_object" }` وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام `json_schema` للنماذج التي تدعمه.	لا
tool_choice	ToolChoiceOptions أو ToolChoiceTypes أو ToolChoiceFunction	كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة `tools` لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.	‏‏نعم‬
الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. يمكنك تحديد الأداة التي يجب استخدامها عن طريق تعيين المعلمة `tool_choice` . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة	‏‏نعم‬
top_p	رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	‏‏نعم‬	1
اقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - `auto`: إذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج، فسيقتطاع النموذج الاستجابة لاحتواء نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (افتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، فسيفشل الطلب مع حدوث خطأ 400. القيم المحتملة: `auto`، `disabled`	لا
استخدام	ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك الرموز المميزة للإدخال والرموز المميزة للإخراج وتفصيل الرموز المميزة للإخراج وإجمالي الرموز المميزة المستخدمة.	لا
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد OpenAI على مراقبة إساءة الاستخدام واكتشافها. .	لا

ResponseAudioDeltaEvent

يتم إصداره عند وجود استجابة صوتية جزئية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	مجموعة من وحدات البايت الصوتية للاستجابة المرمزة Base64.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.audio.delta`. القيم المحتملة: `response.audio.delta`	‏‏نعم‬

ResponseAudioDoneEvent

يصدر عند اكتمال الاستجابة الصوتية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الحدث. دائمًا `response.audio.done`. القيم المحتملة: `response.audio.done`	‏‏نعم‬

ResponseAudioTranscriptDeltaEvent

يصدر عندما يكون هناك نسخة جزئية من الصوت.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	النسخة الجزئية للاستجابة الصوتية.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.audio.transcript.delta`. القيم المحتملة: `response.audio.transcript.delta`	‏‏نعم‬

ResponseAudioTranscriptDoneEvent

يتم إصداره عند اكتمال النسخة الصوتية الكاملة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الحدث. دائمًا `response.audio.transcript.done`. القيم المحتملة: `response.audio.transcript.done`	‏‏نعم‬

ResponseCodeInterpreterCallCodeDeltaEvent

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

الاسم	النوع	وصف	مطلوب
الدلتا	string	مقتطف التعليمات البرمجية الجزئي الذي أضافه مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.code_interpreter_call.code.delta`. القيم المحتملة: `response.code_interpreter_call.code.delta`	‏‏نعم‬

ResponseCodeInterpreterCallCodeDoneEvent

يتم إصداره عند إنهاء إخراج القصاصة البرمجية بواسطة مترجم التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب
رمز	string	إخراج مقتطف التعليمات البرمجية النهائي بواسطة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.code_interpreter_call.code.done`. القيم المحتملة: `response.code_interpreter_call.code.done`	‏‏نعم‬

ResponseCodeInterpreterCallCompletedEvent

تنبعث عند اكتمال استدعاء مترجم التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.code_interpreter_call.completed`. القيم المحتملة: `response.code_interpreter_call.completed`	‏‏نعم‬

ResponseCodeInterpreterCallInProgressEvent

تنبعث عندما تكون استدعاء مترجم التعليمات البرمجية قيد التقدم.

الاسم	النوع	وصف	مطلوب
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.code_interpreter_call.in_progress`. القيم المحتملة: `response.code_interpreter_call.in_progress`	‏‏نعم‬

ResponseCodeInterpreterCallInterpretingEvent

ينبعث عندما يقوم مترجم التعليمات البرمجية بتفسير مقتطف التعليمات البرمجية بنشاط.

الاسم	النوع	وصف	مطلوب
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.code_interpreter_call.interpreting`. القيم المحتملة: `response.code_interpreter_call.interpreting`	‏‏نعم‬

ResponseCompletedEvent

تنبعث عند اكتمال استجابة النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	response		‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.completed`. القيم المحتملة: `response.completed`	‏‏نعم‬

ResponseContentPartAddedEvent

تنبعث عند إضافة جزء محتوى جديد.

الاسم	النوع	وصف	مطلوب
content_index	integer	فهرس جزء المحتوى الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
جزء	OutputContent		‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.content_part.added`. القيم المحتملة: `response.content_part.added`	‏‏نعم‬

ResponseContentPartDoneEvent

تنبعث عند الانتهاء من جزء المحتوى.

الاسم	النوع	وصف	مطلوب
content_index	integer	فهرس جزء المحتوى الذي تم القيام به.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
جزء	OutputContent		‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.content_part.done`. القيم المحتملة: `response.content_part.done`	‏‏نعم‬

ResponseCreatedEvent

حدث ينبعث عند إنشاء استجابة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	response		‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.created`. القيم المحتملة: `response.created`	‏‏نعم‬

ResponseError

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	ResponseErrorCode	رمز الخطأ للاستجابة.	‏‏نعم‬
رسالة	string	وصف يمكن للإنسان قراءته للخطأ.	‏‏نعم‬

ResponseErrorCode

رمز الخطأ للاستجابة.

الخاصية	قيمة
الوصف	رمز الخطأ للاستجابة.
Type	string
Values	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

ResponseErrorEvent

تنبعث عند حدوث خطأ.

الاسم	النوع	وصف	مطلوب
رمز	string	رمز الخطأ.	‏‏نعم‬
رسالة	string	رسالة الخطأ.	‏‏نعم‬
بارام	string	معلمة الخطأ.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `error`. القيم المحتملة: `error`	‏‏نعم‬

ResponseFailedEvent

حدث ينبعث عند فشل الاستجابة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	response		‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.failed`. القيم المحتملة: `response.failed`	‏‏نعم‬

ResponseFileSearchCallCompletedEvent

تنبعث عند اكتمال استدعاء البحث عن الملف (تم العثور على النتائج).

الاسم	النوع	وصف	مطلوب
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يتم بدء استدعاء البحث في الملف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.file_search_call.completed`. القيم المحتملة: `response.file_search_call.completed`	‏‏نعم‬

ResponseFileSearchCallInProgressEvent

تنبعث عند بدء استدعاء البحث عن ملف.

الاسم	النوع	وصف	مطلوب
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يتم بدء استدعاء البحث في الملف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.file_search_call.in_progress`. القيم المحتملة: `response.file_search_call.in_progress`	‏‏نعم‬

ResponseFileSearchCallSearchingEvent

ينبعث عند البحث عن ملف حاليا.

الاسم	النوع	وصف	مطلوب
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تبحث عنه مكالمة البحث في الملف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.file_search_call.searching`. القيم المحتملة: `response.file_search_call.searching`	‏‏نعم‬

ResponseFunctionCallArgumentsDeltaEvent

تنبعث عندما يكون هناك دلتا جزئية لاستدعاء الدالة.

الاسم	النوع	وصف	مطلوب
الدلتا	string	وسيطات استدعاء الدالة دلتا التي تمت إضافتها.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة دلتا وسيطات استدعاء الدالة إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تتم إضافة وسيطات استدعاء الدالة إليه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.function_call_arguments.delta`. القيم المحتملة: `response.function_call_arguments.delta`	‏‏نعم‬

ResponseFunctionCallArgumentsDoneEvent

تنبعث عند الانتهاء من وسيطات استدعاء الدالة.

الاسم	النوع	وصف	مطلوب
الحجج	string	وسيطات استدعاء الدالة.	‏‏نعم‬
item_id	string	معرف العنصر.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج.	‏‏نعم‬
النوع	enum	القيم المحتملة: `response.function_call_arguments.done`	‏‏نعم‬

ResponseInProgressEvent

تنبعث عندما تكون الاستجابة قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	response		‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.in_progress`. القيم المحتملة: `response.in_progress`	‏‏نعم‬

ResponseIncompleteEvent

حدث ينبعث عند انتهاء الاستجابة على أنها غير مكتملة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	response		‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.incomplete`. القيم المحتملة: `response.incomplete`	‏‏نعم‬

responseItemList

قائمة بعناصر الاستجابة.

الاسم	النوع	وصف	مطلوب
البيانات	صفيف	قائمة بالعناصر المستخدمة لإنشاء هذه الاستجابة.	‏‏نعم‬
first_id	string	معرف العنصر الأول في القائمة.	‏‏نعم‬
has_more	boolean	ما إذا كان هناك المزيد من العناصر المتاحة.	‏‏نعم‬
last_id	string	معرف العنصر الأخير في القائمة.	‏‏نعم‬
object	enum	يجب أن يكون `list`نوع الكائن الذي تم إرجاعه . القيم المحتملة: `list`	‏‏نعم‬

ResponseModalities

أنواع الإخراج التي ترغب في أن ينشئها النموذج. معظم النماذج قادرة على إنشاء نص، وهو الافتراضي:

["text"]

["text", "audio"]

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

ResponseModalitiesTextOnly

أنواع الإخراج التي ترغب في أن ينشئها النموذج. معظم النماذج قادرة على إنشاء نص، وهو الافتراضي:

["text"]

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

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

ResponseOutputItemAddedEvent

تنبعث عند إضافة عنصر إخراج جديد.

الاسم	النوع	وصف	مطلوب
عنصر	OutputItem		‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافته.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.output_item.added`. القيم المحتملة: `response.output_item.added`	‏‏نعم‬

ResponseOutputItemDoneEvent

ينبعث عند وضع علامة على عنصر الإخراج تم.

الاسم	النوع	وصف	مطلوب
عنصر	OutputItem		‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تم وضع علامة عليه تم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.output_item.done`. القيم المحتملة: `response.output_item.done`	‏‏نعم‬

ResponseProperties

الاسم	النوع	وصف	مطلوب
تعليمات	string	إدراج رسالة نظام (أو مطور) كعنصر أول في سياق النموذج. عند استخدام جنبا إلى جنب مع `previous_response_id`، لن يتم نقل الإرشادات من استجابة سابقة إلى الاستجابة التالية. وهذا يجعل من السهل تبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية وحالة المحادثة.	لا
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	لا
المنطق	Reasoning	خيارات التكوين لنماذج المنطق.	لا
نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ التنسيق	TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين `{ "type": "json_schema" }` المخرجات المنظمة، مما يضمن تطابق النموذج مع مخطط JSON المقدم. التنسيق الافتراضي مع `{ "type": "text" }` عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: الإعداد لتمكين `{ "type": "json_object" }` وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام `json_schema` للنماذج التي تدعمه.	لا
tool_choice	ToolChoiceOptions أو ToolChoiceTypes أو ToolChoiceFunction	كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة `tools` لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.	لا
الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. يمكنك تحديد الأداة التي يجب استخدامها عن طريق تعيين المعلمة `tool_choice` . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة	لا
اقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - `auto`: إذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج، فسيقتطاع النموذج الاستجابة لاحتواء نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (افتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، فسيفشل الطلب مع حدوث خطأ 400. القيم المحتملة: `auto`، `disabled`	لا

ResponseRefusalDeltaEvent

تنبعث عندما يكون هناك نص رفض جزئي.

الاسم	النوع	وصف	مطلوب
content_index	integer	فهرس جزء المحتوى الذي تتم إضافة نص الرفض إليه.	‏‏نعم‬
الدلتا	string	نص الرفض الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة نص الرفض إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة نص الرفض إليه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.refusal.delta`. القيم المحتملة: `response.refusal.delta`	‏‏نعم‬

ResponseRefusalDoneEvent

تنبعث عند الانتهاء من نص الرفض.

الاسم	النوع	وصف	مطلوب
content_index	integer	فهرس جزء المحتوى الذي تم فيه إنهاء نص الرفض.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تم الانتهاء منه من نص الرفض.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تم الانتهاء من نص الرفض.	‏‏نعم‬
رفض	string	نص الرفض الذي تم الانتهاء منه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.refusal.done`. القيم المحتملة: `response.refusal.done`	‏‏نعم‬

responseStreamEvent

الاسم	النوع	وصف	مطلوب
annotation	Annotation		‏‏نعم‬
annotation_index	integer	فهرس التعليق التوضيحي الذي تمت إضافته.	‏‏نعم‬
الحجج	string	وسيطات استدعاء الدالة.	‏‏نعم‬
رمز	string	رمز الخطأ.	‏‏نعم‬
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل التعليمات البرمجية.	‏‏نعم‬
content_index	integer	فهرس جزء المحتوى الذي تم إنهاء محتوى النص فيه.	‏‏نعم‬
الدلتا	string	دلتا النص الذي تمت إضافته.	‏‏نعم‬
عنصر	OutputItem	عنصر الإخراج الذي تم وضع علامة عليه تم.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تم الانتهاء منه من محتوى النص.	‏‏نعم‬
رسالة	string	رسالة الخطأ.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تم إنهاء محتوى النص به.	‏‏نعم‬
بارام	string	معلمة الخطأ.	‏‏نعم‬
جزء	OutputContent	جزء المحتوى الذي تم.	‏‏نعم‬
رفض	string	نص الرفض الذي تم الانتهاء منه.	‏‏نعم‬
استجابه	response	الاستجابة غير المكتملة.	‏‏نعم‬
نص	string	محتوى النص الذي تم الانتهاء منه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.output_text.done`. القيم المحتملة: `response.output_text.done`	‏‏نعم‬

ResponseTextAnnotationDeltaEvent

يتم إصداره عند إضافة تعليق توضيحي نصي.

الاسم	النوع	وصف	مطلوب
annotation	Annotation		‏‏نعم‬
annotation_index	integer	فهرس التعليق التوضيحي الذي تمت إضافته.	‏‏نعم‬
content_index	integer	فهرس جزء المحتوى الذي تمت إضافة التعليق التوضيحي للنص إليه.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة التعليق التوضيحي للنص إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة التعليق التوضيحي للنص إليه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.output_text.annotation.added`. القيم المحتملة: `response.output_text.annotation.added`	‏‏نعم‬

ResponseTextDeltaEvent

تنبعث عندما يكون هناك دلتا نصية إضافية.

الاسم	النوع	وصف	مطلوب
content_index	integer	فهرس جزء المحتوى الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
الدلتا	string	دلتا النص الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.output_text.delta`. القيم المحتملة: `response.output_text.delta`	‏‏نعم‬

ResponseTextDoneEvent

تنبعث عند الانتهاء من محتوى النص.

الاسم	النوع	وصف	مطلوب
content_index	integer	فهرس جزء المحتوى الذي تم إنهاء محتوى النص فيه.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تم الانتهاء منه من محتوى النص.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تم إنهاء محتوى النص به.	‏‏نعم‬
نص	string	محتوى النص الذي تم الانتهاء منه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا `response.output_text.done`. القيم المحتملة: `response.output_text.done`	‏‏نعم‬

ResponseUsage

يمثل تفاصيل استخدام الرمز المميز بما في ذلك الرموز المميزة للإدخال والرموز المميزة للإخراج وتفصيل الرموز المميزة للإخراج وإجمالي الرموز المميزة المستخدمة.

الاسم	النوع	وصف	مطلوب
input_tokens	integer	عدد رموز الإدخال.	‏‏نعم‬
output_tokens	integer	عدد الرموز المميزة للإخراج.	‏‏نعم‬
output_tokens_details	object	تحليل مفصل للرموز المميزة للإخراج.	‏‏نعم‬
└─ reasoning_tokens	integer	عدد الرموز المميزة المنطقية.	لا
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة.	‏‏نعم‬

Screenshot

إجراء لقطة شاشة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	يحدد نوع الحدث. لإجراء لقطة شاشة، يتم تعيين هذه الخاصية دائما إلى `screenshot`. القيم المحتملة: `screenshot`	‏‏نعم‬

Scroll

إجراء تمرير.

الاسم	النوع	وصف	مطلوب
scroll_x	integer	مسافة التمرير الأفقية.	‏‏نعم‬
scroll_y	integer	مسافة التمرير العمودية.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. لإجراء التمرير، يتم تعيين هذه الخاصية دائما إلى `scroll`. القيم المحتملة: `scroll`	‏‏نعم‬
×	integer	الإحداثي س حيث حدث التمرير.	‏‏نعم‬
y	integer	الإحداثي ص حيث حدث التمرير.	‏‏نعم‬

StopConfiguration

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

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

TextResponseFormatConfiguration

كائن يحدد التنسيق الذي يجب على النموذج إخراجه.

يتيح التكوين { "type": "json_schema" } المخرجات المنظمة، والتي تضمن تطابق النموذج مع مخطط JSON المقدم.

التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية.

غير مستحسن لنماذج gpt-4o والأحدث:

الإعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام json_schema للنماذج التي تدعمه.

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

ResponseFormatText
TextResponseFormatJsonSchema
ResponseFormatJsonObject

TextResponseFormatJsonSchema

تنسيق استجابة مخطط JSON. يستخدم لإنشاء استجابات JSON منظمة. تعرف على المزيد حول المخرجات المنظمة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف لما هو تنسيق الاستجابة، يستخدمه النموذج لتحديد كيفية الاستجابة بالتنسيق.	لا
الاسم	string	اسم تنسيق الاستجابة. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64.	لا
Schema	ResponseFormatJsonSchemaSchema	مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON.	‏‏نعم‬
صارم	boolean	ما إذا كان سيتم تمكين الالتزام الصارم بالمخطط عند إنشاء الإخراج. إذا تم تعيينه إلى true، فسيتبع النموذج دائما المخطط الدقيق المحدد في `schema` الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما `strict` تكون `true`.	لا	خطأ
النوع	enum	نوع تنسيق الاستجابة الذي يتم تعريفه. دائمًا `json_schema`. القيم المحتملة: `json_schema`	‏‏نعم‬

أداة

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

FileSearchTool
FunctionTool
ComputerTool

ToolChoiceFunction

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

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

ToolChoiceOptions

يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج.

none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة.

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

required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر.

الخاصية	قيمة
الوصف	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. `auto` يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر.
Type	string
Values	`none` `auto` `required`

ToolChoiceTypes

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الأداة المستضافة التي يجب أن يستخدمها النموذج. القيم المسموح بها هي: - `file_search` - `computer_use_preview` القيم المحتملة: `file_search`، `computer_use_preview`	‏‏نعم‬

النوع

إجراء لكتابة نص.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	النص المراد كتابته.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء النوع، يتم تعيين هذه الخاصية دائما إلى `type`. القيم المحتملة: `type`	‏‏نعم‬

UpdateVectorStoreFileAttributesRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	VectorStoreFileAttributes	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا أو قيمة منطقية أو أرقام.	‏‏نعم‬

UrlCitation

اقتباس لمورد ويب يستخدم لإنشاء استجابة نموذج.

الاسم	النوع	وصف	مطلوب
end_index	integer	فهرس الحرف الأخير من اقتباس عنوان URL في الرسالة.	‏‏نعم‬
start_index	integer	فهرس الحرف الأول من اقتباس عنوان URL في الرسالة.	‏‏نعم‬
العنوان	string	عنوان مورد الويب.	‏‏نعم‬
النوع	enum	نوع اقتباس عنوان URL. دائمًا `url_citation`. القيم المحتملة: `url_citation`	‏‏نعم‬
عنوان URL	string	عنوان URL لمورد الويب.	‏‏نعم‬

VectorStoreFileAttributes

مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا أو قيمة منطقية أو أرقام.

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

VectorStoreFileContentResponse

يمثل المحتوى الذي تم تحليله لملف مخزن متجه.

الاسم	النوع	وصف	مطلوب
البيانات	صفيف	محتوى تم تحليله للملف.	‏‏نعم‬
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من صفحات المحتوى لإحضارها.	‏‏نعم‬
next_page	string	الرمز المميز للصفحة التالية، إن وجدت.	‏‏نعم‬
object	enum	نوع الكائن، الذي يكون دائما `vector_store.file_content.page` القيم المحتملة: `vector_store.file_content.page`	‏‏نعم‬

VectorStoreSearchRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	ComparisonFilter أو CompoundFilter	عامل تصفية لتطبيقه استنادا إلى سمات الملف.	لا
max_num_results	integer	الحد الأقصى لعدد النتائج التي سيتم إرجاعها. يجب أن يتراوح هذا الرقم بين 1 و50 ضمنا.	لا	10
استعلام	سلسلة أو مجموعة	سلسلة استعلام للبحث	‏‏نعم‬
ranking_options	object	خيارات تحديد المرتبة للبحث.	لا
└─ المرتبة	enum	القيم المحتملة: `auto`، `default-2024-11-15`	لا
└─ score_threshold	رقم		لا	0
rewrite_query	boolean	ما إذا كنت تريد إعادة كتابة استعلام اللغة الطبيعية للبحث عن المتجهات.	لا	خطأ

VectorStoreSearchResultContentObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	المحتوى النصي الذي تم إرجاعه من البحث.	‏‏نعم‬
النوع	enum	نوع المحتوى. القيم المحتملة: `text`	‏‏نعم‬

VectorStoreSearchResultItem

الاسم	النوع	وصف	مطلوب
attributes	VectorStoreFileAttributes	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا أو قيمة منطقية أو أرقام.	‏‏نعم‬
محتوى	صفيف	مجموعات المحتوى من الملف.	‏‏نعم‬
file_id	string	معرف ملف مخزن المتجهات.	‏‏نعم‬
filename	string	اسم ملف مخزن المتجهات.	‏‏نعم‬
score	رقم	درجة التشابه للنتيجة.	‏‏نعم‬

VectorStoreSearchResultsPage

الاسم	النوع	وصف	مطلوب
البيانات	صفيف	قائمة عناصر نتائج البحث.	‏‏نعم‬
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من النتائج لجلبها.	‏‏نعم‬
next_page	string	الرمز المميز للصفحة التالية، إن وجدت.	‏‏نعم‬
object	enum	نوع الكائن، الذي يكون دائما `vector_store.search_results.page` القيم المحتملة: `vector_store.search_results.page`	‏‏نعم‬
search_query	صفيف		‏‏نعم‬

VoiceIdsShared

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

Wait

إجراء انتظار.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	يحدد نوع الحدث. لإجراء الانتظار، يتم تعيين هذه الخاصية دائما إلى `wait`. القيم المحتملة: `wait`	‏‏نعم‬

ReasoningEffort

يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي lowو mediumو.high يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة.

الخاصية	قيمة
الوصف	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي `low`و `medium`و.`high` يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة.
Type	string
الإعداد الافتراضي	medium
Values	`low` `medium` `high`

errorEvent

يحدث عند حدوث خطأ. يمكن أن يحدث هذا بسبب خطأ خادم داخلي أو مهلة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	error		‏‏نعم‬
event	string		‏‏نعم‬

تعداد الحدث: ErrorEventEnum

قيمة	وصف
خطأ

doneEvent

يحدث عند انتهاء الدفق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	string		‏‏نعم‬
event	string		‏‏نعم‬

تعداد الحدث: DoneEventEnum

قيمة	وصف
done

تعداد البيانات: DoneEventDataEnum

قيمة	وصف
[DONE]

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

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

الملاحظات

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

Last updated on 2026-02-28

مشاركة عبر

Azure OpenAI في مرجع معاينة واجهة برمجة تطبيقات REST لنماذج Microsoft Foundry

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

المصادقة

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

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

الإكمال - إنشاء

معلمات URI

رأس الطلب

نص الطلب

الاستجابات

الأمثلة

مثال

التضمينات - إنشاء

معلمات URI

رأس الطلب

نص الطلب

الاستجابات

الأمثلة

مثال

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

معلمات URI

رأس الطلب

نص الطلب

الاستجابات

الأمثلة

مثال

مثال

مثال

مثال

مثال

مثال

مثال

مثال

النسخ - إنشاء

معلمات URI

رأس الطلب

نص الطلب

الاستجابات

الأمثلة

مثال

مثال

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

معلمات URI

رأس الطلب

نص الطلب

الاستجابات

الأمثلة

مثال

مثال

الكلام - إنشاء

معلمات URI

رأس الطلب

نص الطلب

الاستجابات

الأمثلة

مثال

أجيال الصور - إنشاء

معلمات URI

رأس الطلب

نص الطلب

الاستجابات

الأمثلة

مثال

أجيال الصور - تحرير

معلمات URI

رأس الطلب

نص الطلب

الاستجابات

قائمة - مساعدون

معلمات URI

رأس الطلب

الاستجابات

الأمثلة

مثال

إنشاء - مساعد

معلمات URI

رأس الطلب

نص الطلب

الاستجابات