مرجع معاينة API لنموذج Azure OpenAI في Microsoft Foundry Models

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

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

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

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

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

مهم

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

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

المصادقة

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

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

إصدار REST API

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

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

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

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

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

الإنجازات - إنشاء

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

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

معلمات URI

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

رأس الطلب

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

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

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

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

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

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

الأمثلة

مثال

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

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

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

معلمات URI

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

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

الأمثلة

مثال

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

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

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

رأس الطلب

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

هيئة الطلب

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

Name	النوع	الوصف	مطلوبة	افتراضي
الصوت	الهدف	معايير إخراج الصوت. مطلوب عند طلب إخراج الصوت باستخدام `modalities: ["audio"]`.	لا
صيغة └─	enum	يحدد صيغة الصوت المخرج. يجب أن يكون أحد ، `wavmp3`، `flac`، `opus`، أو `pcm16`. القيم الممكنة: `wav`, `mp3`, , `flacopus`,`pcm16`	لا
└─ صوت	enum	يحدد نوع الصوت. الأصوات المدعومة هي `alloy`، `echo`، `fable`، `onyx`، `nova`، و `shimmer`. القيم الممكنة: `alloy`، `echo`، `fable`، `onyx`، `novashimmer`	لا
data_sources	مصفوفة	إدخالات التكوين لإضافات الدردشة Azure OpenAI التي تستخدمها. هذه المواصفة الإضافية متوافقة فقط مع Azure OpenAI.	لا
frequency_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا.	لا	1
function_call	string أو chatCompletionFunctionCallOption	تم استبعاده لصالح `tool_choice`. يتحكم في أي وظيفة (إن وجدت) يتم استدعاؤها بواسطة النموذج. `none` يعني أن النموذج لن يستدعي دالة بل يولد رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء دالة. تحديد دالة معينة عبر `{"name": "my_function"}` يجبر النموذج على استدعاء تلك الدالة. `none` هي الوضع الافتراضي عندما لا توجد دوال. `auto` هي الافتراضية إذا كانت الدوال موجودة.	لا
الوظائف	مصفوفة	تم استبعاده لصالح `tools`. قائمة بالدوال التي قد يولد النموذج مدخلات JSON لها.	لا
logit_bias	الهدف	قم بتعديل احتمالية ظهور رموز محددة في الإكمال. يقبل كائن JSON يربط الرموز (المحددة بمعرف الرمز الخاص بها في الرمز) إلى قيمة تحيز مرتبطة من -100 إلى 100. رياضيا، يضاف التحيز إلى اللوجيتس التي يولدها النموذج قبل أخذ العينة. يختلف التأثير الدقيق حسب النموذج، لكن القيم بين -1 و1 يجب أن تقلل أو تزيد من احتمال الاختيار؛ قيم مثل -100 أو 100 يجب أن تؤدي إلى حظر أو اختيار حصري للرمز المعني.	لا	‏‫لا شيء‬
logprobs	boolean	هل يجب إعادة احتمالات السجل لرموز الإخراج أم لا. إذا كان صحيحا، يعيد احتمالات لوغاريتيم كل رمز مخرج تم إرجاعه في `content` .`message`	لا	خطأ
max_completion_tokens	integer	حد أعلى لعدد الرموز التي يمكن توليدها لإكمال، بما في ذلك رموز الإخراج المرئية ورموز الاستدلال.	لا
max_tokens	integer	الحد الأقصى لعدد الرموز التي يمكن إنشاؤها في إكمال الدردشة. الطول الكلي لرموز الإدخال والرموز المولدة محدود بطول سياق النموذج.	لا
الرسائل	مصفوفة	قائمة بالرسائل التي شكلت المحادثة حتى الآن. مثال Python code.	‏‏نعم‬
البيانات الوصفية	الهدف	العلامات والقيم المعرفة من قبل المطور المستخدمة لتصفية الإكمال في لوحة تحكم الإكمالات المخزنة.	لا
الأساليب	ChatCompletionModalities	أنواع المخرجات التي ترغب في أن يولدها النموذج لهذا الطلب. معظم النماذج قادرة على توليد نص، وهو الوضع الافتراضي: `["text"]` يمكن أيضا استخدام النموذج `gpt-4o-audio-preview` لتوليد الصوت. لطلب أن يولد هذا النموذج ردودا نصية وصوتية، يمكنك استخدام: `["text", "audio"]`	لا
n	integer	كم عدد خيارات إكمال المحادثة التي يجب إنشاؤها لكل رسالة إدخال. سيتم تحصيل الرسوم عليك بناء على عدد الرموز المولدة عبر جميع الخيارات. حافظ `n` على ذلك `1` لتقليل التكاليف.	لا	1
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تفعيل استدعاء الدوال المتوازية أثناء استخدام الأداة.	لا	صحيح
التنبؤ	PredictionContent	تكوين للمخرج المتوقع، والذي يمكن أن يحسن بشكل كبير أوقات الاستجابة عندما تكون أجزاء كبيرة من استجابة النموذج معروفة مسبقا. هذا شائع جدا عندما تقوم بإعادة توليد ملف مع تغييرات طفيفة فقط في معظم المحتوى.	لا
presence_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة.	لا	1
reasoning_effort	enum	نماذج O1 فقط يقيد الجهد في التفكير في نماذج الاستدلال. القيم المدعومة حاليا هي `low`، `medium`، و `high`. تقليل جهد التفكير يمكن أن يؤدي إلى استجابة أسرع واستخدام رموز أقل في الاستدلال. القيم الممكنة: `low`, `medium`, `high`	لا
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` التوليد تجاوز أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
البذور	integer	هذه الميزة موجودة في مرحلة البيتا. إذا تم تحديده، يبذل نظامنا جهدا قصارى جهده للأخذ عينات حتمية، بحيث يجب أن تعطي الطلبات المتكررة بنفس `seed` المعلمات نفس النتيجة. الحتمية ليست مضمونة، ويجب عليك الرجوع إلى `system_fingerprint` معامل الاستجابة لمراقبة التغيرات في الخلفية.	لا
توقف	السلسلة أو المصفوفة	حتى 4 تسلسلات تتوقف فيها واجهة برمجة التطبيقات عن توليد رموز إضافية.	لا
المتجر	boolean	ما إذا كان يجب تخزين مخرجات طلب إكمال الدردشة هذا لاستخدامه في منتجات تقطير أو تقييم النماذج الخاصة بنا أم لا.	لا
تدفق	boolean	إذا تم تعيينها، يتم إرسال دلتا جزئية للرسائل، كما في ChatGPT. يتم إرسال الرموز كأحداث مرسلة من الخادم فقط عبر البيانات بمجرد توفرها، وتنهي السلسلة برسالة `data: [DONE]` . مثال Python code.	لا	خطأ
stream_options	chatCompletionStreamOptions	خيارات للاستجابة عبر البث. قم بتعيين هذا فقط عندما تضبط `stream: true`.	لا	‏‫لا شيء‬
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 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	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا
user_security_context	userSecurityContext	يحتوي سياق أمان المستخدم على عدة معلمات تصف تطبيق الذكاء الاصطناعي نفسه، والمستخدم النهائي الذي يتفاعل مع تطبيق الذكاء الاصطناعي. تساعد هذه المجالات فرق عمليات الأمن لديك على التحقيق في الحوادث الأمنية والتخفيف منها من خلال توفير نهج شامل لحماية تطبيقات الذكاء الاصطناعي الخاصة بك. تعرف على المزيد حول حماية تطبيقات الذكاء الاصطناعي باستخدام Microsoft Defender for Cloud.	لا

Responses

رمز الحالة: 200

الوصف: موافق

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

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

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

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

الأمثلة

مثال

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

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 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}",
    "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 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 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 المرفقة.

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

مثال

ينشئ إكمال للبحث المرن المرفق.

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

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

رأس الطلب

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

هيئة الطلب

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

Name	النوع	الوصف	مطلوبة	افتراضي
النموذج	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	تنسيق الاستجابة الصوتية	يحدد تنسيق المخرج.	لا
درجة الحرارة	number	درجة حرارة العينة، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. إذا تم ضبطه على 0، يستخدم النموذج احتمال لوغاريتمية لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى عتبات معينة.	لا	1
timestamp_granularities[]	مصفوفة	الطابع الزمني لملء التفاصيل لهذا النسخ. `response_format` يجب ضبطه `verbose_json` لاستخدام تعدد الطابع الزمني. يدعم أحد هذين الخيارين أو كلاهما: `word`، أو `segment`. ملاحظة: لا يوجد زمن تأخير إضافي لطوابع المقاطع الزمنية (مقاطع الزمن)، لكن توليد طوابع زمنية للكلمات يسبب زمن تأخير إضافي.	لا	['segment']

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	الهدف
النص/البسيط	string	نسخ النص بصيغة الإخراج (عندما response_format أحد أو `textvttsrt`).

الأمثلة

مثال

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

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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	الهدف
النص/البسيط	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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

يولد دفعة من الصور من تعليق نصي على نشر نموذج إنشاء صورة معين

معلمات URI

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

رأس الطلب

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

هيئة الطلب

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

Name	النوع	الوصف	مطلوبة	افتراضي
الخلفية	الصورة الخلفية	يسمح بتعيين الشفافية لخلفية الصور المولدة. هذا المعامل مدعوم فقط لنماذج سلسلة 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، سيكون الرد صورة واحدة ترسل في حدث بث واحد. لاحظ أنه يمكن إرسال الصورة النهائية قبل توليد العدد الكامل من الصور الجزئية إذا تم توليد الصورة الكاملة بشكل أسرع.	1
تدفق	boolean	قم بتحرير الصورة في وضع البث.	لا	`false`
الجودة	imageQuality	جودة الصورة التي سيتم إنشاؤها.	لا	أوتو
response_format	imagesResponseFormat	الصيغة التي تعاد بها الصور المولدة. هذا المعامل غير مدعوم لنماذج `gpt-image-1`السلسلة التي ستعيد دائما الصور المشفرة بنظام base64. القيم الممكنة: `url`, `b64_json`.	لا	عنوان URL
الحجم	حجم الصورة	حجم الصور المولدة.	لا	أوتو
الأسلوب	imageStyle	أسلوب الصور المولدة. مدعوم فقط ل dall-e-3.	لا	حيه
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا

Responses

رمز الحالة: 200

الوصف: موافق

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

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

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

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

الأمثلة

مثال

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

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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

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

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

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

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

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

ملحوظة

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

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

يعيد قائمة بالمساعدين.

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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 https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

يستعيد مساعدا.

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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 https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

يستعيد خيطا.

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	حذفThreadResponse

الأمثلة

مثال

حذف موضوع.

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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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.typesubmit_tool_outputs، يمكن استخدام هذه النقطة النهائية لإرسال المخرجات من استدعاءات الأدوات بمجرد اكتمالها جميعا. يجب تقديم جميع المخرجات في طلب واحد.

معلمات URI

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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 https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

يسترجع مخزن متجه.

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	حذفVectorStoreResponse

الأمثلة

مثال

يحذف متجر فيكتور.

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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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 https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

يسترجع ملف مخزن متجه.

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

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

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

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

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

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

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

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

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

ابحث في مخزن المتجهات عن الأجزاء ذات الصلة بناء على فلتر خصائص الاستعلام والملف.

معلمات URI

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

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

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

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

أنشئ دفعة ملفات لمخزن المتجه.

معلمات URI

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

رأس الطلب

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

هيئة الطلب

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

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
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
  }
}

إنشاء - جلسة الوقت الحقيقي

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

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

هيئة الطلب

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

Name	النوع	الوصف	مطلوبة	افتراضي
input_audio_format	enum	صيغة الصوت المدخل. الخيارات هي `pcm16`، `g711_ulaw`، أو `g711_alaw`. بالنسبة ل `pcm16`، يجب أن يكون الصوت المدخل PCM 16-بت بمعدل عينة 24 كيلوهرتز، وقناة واحدة (أحادية)، وترتيب بايت صغير النهاية (ENDIAN). القيم الممكنة: `pcm16`, `g711_ulaw`, `g711_alaw`	لا
input_audio_noise_reduction	الهدف	تكوين تقليل الضوضاء الصوتية المدخلة. يمكن ضبط ذلك على `null` الإيقاف. يقوم مصطلح تقليل الضوضاء بإضافة الصوت إلى مخزن الصوت الداخلي قبل إرساله إلى VAD والنموذج. يمكن أن يؤدي تصفية الصوت إلى تحسين دقة VAD واكتشاف الدوران (تقليل الإيجابيات الكاذبة) وأداء النمذجة من خلال تحسين إدراك الصوت المدخل.	لا
└─ النوع	enum	نوع تقليل الضوضاء. `near_field` هو للميكروفونات التي تتحدث عن قرب مثل سماعات الرأس، وهو `far_field` مخصص للميكروفونات البعيدة مثل اللابتوب أو ميكروفونات غرف الاجتماعات. القيم الممكنة: `near_field`، `far_field`	لا
input_audio_transcription	الهدف	إعداد نسخ الصوت الداخلي يكون افتراضيا مغلقا ويمكن ضبطه `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_ulaw`, `g711_alaw`	لا
درجة الحرارة	number	درجة حرارة أخذ العينة للنموذج، محدودة ب [0.6، 1.2]. بالنسبة لنماذج الصوت، يوصى بشدة بدرجة حرارة 0.8 لأفضل أداء.	لا	0.8
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي `auto`، `none`، `required`، أو تحديد دالة.	لا	أوتو
الأدوات	مصفوفة	الأدوات (الدوال) المتاحة للنموذج.	لا
turn_detection	الهدف	تكوين لاكتشاف الأدوار، أو VAD خادم الإيثر أو VAD الدلالي. يمكن ضبط ذلك لإيقاف `null` التشغيل، وفي هذه الحالة يجب على العميل تفعيل استجابة النموذج يدويا. تعني VAD في الخادم أن النموذج سيكتشف بداية ونهاية الكلام بناء على حجم الصوت ويستجيب في نهاية كلام المستخدم. VAD الدلالي أكثر تقدما ويستخدم نموذج كشف الأدوار (بالتزامن مع VAD) لتقدير دلالي ما إذا كان المستخدم قد أنهى الكلام، ثم يحدد مهلة زمنية ديناميكية بناء على هذا الاحتمال. على سبيل المثال، إذا تراجع صوت المستخدم مع `uhhm`، فإن النموذج سيحصل على احتمال منخفض لنهاية الدوران وينتظر لفترة أطول حتى يستمر المستخدم في الكلام. قد يكون هذا مفيدا للمحادثات الطبيعية، لكنه قد يكون له زمن تأخير أعلى.	لا
└─ create_response	boolean	سواء كان يجب توليد استجابة تلقائيا عند حدوث حدث توقف VAD أم لا.	لا	صحيح
└─ الحرص	enum	يستخدم فقط للوضع `semantic_vad` . حماس النموذج للرد. `low` سينتظر وقتا أطول حتى يستمر المستخدم في الحديث، `high` وسيستجيب بسرعة أكبر. `auto` هو الافتراضي و يعادل `medium`. القيم الممكنة: `low`, `medium`, `high`, `auto`	لا
└─ interrupt_response	boolean	ما إذا كان يجب مقاطعة أي استجابة جارية تلقائيا مع إخراج المحادثة الافتراضية (أي `conversation` ل `auto`) عند حدوث حدث بدء VAD.	لا	صحيح
└─ prefix_padding_ms	integer	يستخدم فقط للوضع `server_vad` . كمية الصوت التي يجب تضمينها قبل أن يكتشف VAD الكلام (بالأجزاء من الثانية). الوضع الافتراضي على 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	يستخدم فقط للوضع `server_vad` . مدة الصمت لاكتشاف توقف الكلام (بالمللي ثانية). الوضع الافتراضي هو 500 مللي ثانية. مع القيم الأقصر سيستجيب النموذج بسرعة أكبر، لكنه قد يتدخل في فترات توقف قصيرة من المستخدم.	لا
└─ عتبة	number	يستخدم فقط للوضع `server_vad` . عتبة التفعيل ل VAD (من 0.0 إلى 1.0)، وتكون هذه البطاقة افتراضية 0.5. العتبة الأعلى ستتطلب صوتا أعلى لتفعيل النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات المزدحمة.	لا
└─ النوع	enum	نوع اكتشاف المنعطفات. القيم الممكنة: `server_vad`، `semantic_vad`	لا
الصوت	VoiceIdsShared		لا

Responses

رمز الحالة: 200

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

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

إنشاء - Transcriptionrealtimesession

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

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

هيئة الطلب

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

Name	النوع	الوصف	مطلوبة	افتراضي
تشمل	مصفوفة	مجموعة العناصر التي يجب تضمينها في النسخ. العناصر المتاحة حاليا هي: - `item.input_audio_transcription.logprobs`	لا
input_audio_format	enum	صيغة الصوت المدخل. الخيارات هي `pcm16`، `g711_ulaw`، أو `g711_alaw`. بالنسبة ل `pcm16`، يجب أن يكون الصوت المدخل PCM 16-بت بمعدل عينة 24 كيلوهرتز، وقناة واحدة (أحادية)، وترتيب بايت صغير النهاية (ENDIAN). القيم الممكنة: `pcm16`, `g711_ulaw`, `g711_alaw`	لا
input_audio_noise_reduction	الهدف	تكوين تقليل الضوضاء الصوتية المدخلة. يمكن ضبط ذلك على `null` الإيقاف. يقوم مصطلح تقليل الضوضاء بإضافة الصوت إلى مخزن الصوت الداخلي قبل إرساله إلى VAD والنموذج. يمكن أن يؤدي تصفية الصوت إلى تحسين دقة VAD واكتشاف الدوران (تقليل الإيجابيات الكاذبة) وأداء النمذجة من خلال تحسين إدراك الصوت المدخل.	لا
└─ النوع	enum	نوع تقليل الضوضاء. `near_field` هو للميكروفونات التي تتحدث عن قرب مثل سماعات الرأس، وهو `far_field` مخصص للميكروفونات البعيدة مثل اللابتوب أو ميكروفونات غرف الاجتماعات. القيم الممكنة: `near_field`، `far_field`	لا
input_audio_transcription	الهدف	تكوين لنقل الصوت المدخل. يمكن للعميل اختيار تعيين اللغة والمطالبة بالنسخ، وهذه النصائح تقدم إرشادات إضافية لخدمة النسخ.	لا
└─ اللغة	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-15`, `whisper-1`	لا
└─ الموضوع	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار مقطع صوتي سابق. ل `whisper-1`، الموضوع هو قائمة بالكلمات المفتاحية. بالنسبة للنماذج `gpt-4o-transcribe` ، التوجيه هو نص حر، مثل "توقع الكلمات المتعلقة بالتكنولوجيا".	لا
الأساليب		مجموعة الأنماط التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا على ["نص"].	لا
turn_detection	الهدف	تكوين لاكتشاف الأدوار، أو VAD خادم الإيثر أو VAD الدلالي. يمكن ضبط ذلك لإيقاف `null` التشغيل، وفي هذه الحالة يجب على العميل تفعيل استجابة النموذج يدويا. تعني VAD في الخادم أن النموذج سيكتشف بداية ونهاية الكلام بناء على حجم الصوت ويستجيب في نهاية كلام المستخدم. VAD الدلالي أكثر تقدما ويستخدم نموذج كشف الأدوار (بالتزامن مع VAD) لتقدير دلالي ما إذا كان المستخدم قد أنهى الكلام، ثم يحدد مهلة زمنية ديناميكية بناء على هذا الاحتمال. على سبيل المثال، إذا تراجع صوت المستخدم مع `uhhm`، فإن النموذج سيحصل على احتمال منخفض لنهاية الدوران وينتظر لفترة أطول حتى يستمر المستخدم في الكلام. قد يكون هذا مفيدا للمحادثات الطبيعية، لكنه قد يكون له زمن تأخير أعلى.	لا
└─ create_response	boolean	سواء كان يجب توليد استجابة تلقائيا عند حدوث حدث توقف VAD أم لا. غير متاح لجلسات النسخ.	لا	صحيح
└─ الحرص	enum	يستخدم فقط للوضع `semantic_vad` . حماس النموذج للرد. `low` سينتظر وقتا أطول حتى يستمر المستخدم في الحديث، `high` وسيستجيب بسرعة أكبر. `auto` هو الافتراضي و يعادل `medium`. القيم الممكنة: `low`, `medium`, `high`, `auto`	لا
└─ interrupt_response	boolean	ما إذا كان يجب مقاطعة أي استجابة جارية تلقائيا مع إخراج المحادثة الافتراضية (أي `conversation` ل `auto`) عند حدوث حدث بدء VAD. غير متاح لجلسات النسخ.	لا	صحيح
└─ prefix_padding_ms	integer	يستخدم فقط للوضع `server_vad` . كمية الصوت التي يجب تضمينها قبل أن يكتشف VAD الكلام (بالأجزاء من الثانية). الوضع الافتراضي على 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	يستخدم فقط للوضع `server_vad` . مدة الصمت لاكتشاف توقف الكلام (بالمللي ثانية). الوضع الافتراضي هو 500 مللي ثانية. مع القيم الأقصر سيستجيب النموذج بسرعة أكبر، لكنه قد يتدخل في فترات توقف قصيرة من المستخدم.	لا
└─ عتبة	number	يستخدم فقط للوضع `server_vad` . عتبة التفعيل ل VAD (من 0.0 إلى 1.0)، وتكون هذه البطاقة افتراضية 0.5. العتبة الأعلى ستتطلب صوتا أعلى لتفعيل النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات المزدحمة.	لا
└─ النوع	enum	نوع اكتشاف المنعطفات. القيم الممكنة: `server_vad`، `semantic_vad`	لا

Responses

رمز الحالة: 200

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

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

Responses

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

يخلق استجابة نموذجية.

هيئة الطلب

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

Name	النوع	الوصف	مطلوبة	افتراضي
تشمل	مصفوفة		لا
المدخلات	السلسلة أو المصفوفة	مدخلات النموذج	‏‏نعم‬
التعليمات	string	يدرج رسالة نظام (أو مطور) كأول عنصر في سياق النموذج. عند استخدام مع `previous_response_id`، لن تنتقل التعليمات من استجابة سابقة إلى الاستجابة التالية. هذا يجعل من السهل تبديل رسائل النظام (أو المطور) في ردود جديدة.	لا
max_output_tokens	integer	حد أعلى لعدد الرموز التي يمكن إنشاؤها للرد، بما في ذلك رموز الإخراج المرئية وحالة المحادثة.	لا
parallel_tool_calls	boolean	ما إذا كان يجب السماح للنموذج بتشغيل استدعاءات الأدوات بشكل متوازي.	لا	صحيح
previous_response_id	string	معرف فريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار. تعرف أكثر على حالة المحادثة.	لا
المنطق	المنطق	خيارات التكوين لنماذج التفكير.	لا
المتجر	boolean	ما إذا كان يجب تخزين استجابة النموذج المولدة لاسترجاعه لاحقا عبر واجهة برمجة التطبيقات (API).	لا	صحيح
تدفق	boolean	إذا تم تعيينه على true، سيتم بث بيانات استجابة النموذج إلى العميل أثناء توليدها باستخدام أحداث يرسلها الخادم. راجع قسم البث أدناه لمزيد من المعلومات.	لا	خطأ
النص	الهدف	خيارات التكوين للاستجابة النصية من النموذج. يمكن أن تكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
صيغة └─	تكوين TextResponseFormat	كائن يحدد الصيغة التي يجب أن ينتجها النموذج. يتيح التكوين `{ "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`	لا

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	استجابه
النص/الحدث	حدث تدفق الاستجابة

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

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

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

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

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

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

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

نوع المحتوى	نوع	الوصف
application/json	استجابه

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

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

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

حذف الرد

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

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

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

رمز الحالة: 404

الوصف: لم يتم العثور عليه

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

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

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

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

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

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

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

معلمات URI

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

رأس الطلب

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

Responses

رمز الحالة: 200

الوصف: موافق

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

المكونات

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

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

errorBase

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

خطأ

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

خطأ داخلي

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

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

innerErrorCode

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

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

داليErrorResponse

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

داليError

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

dalleInnerError

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

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

contentFilterCompletionTextSpan

يصف امتدادا داخل نص إكمال مولد. الإزاحة 0 هي أول نقطة رمز في UTF32 في نص الإكمال.

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

contentFilterResultBase

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

contentFilterSeverityResult

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

contentFilterDetectedResult

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

contentFilterDetectedWithCitationResult

Name	النوع	مطلوبة
الاقتباس	الهدف	لا
└─ عنوان URL	string	لا
└─ رخصة	string	لا

contentFilterDetectedWithCompletionTextSpansResult

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

contentFilterIdResult

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

contentFilterResultsBase

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

Name	النوع	الوصف	مطلوبة
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للأجزاء المفلترة.	لا
خطأ	errorBase		لا
الكراهية	contentFilterSeverityResult		لا
الألفاظ النابية	contentFilterDetectedResult		لا
self_harm	contentFilterSeverityResult		لا
الجنس	contentFilterSeverityResult		لا
العنف	contentFilterSeverityResult		لا

contentFilterPromptResults

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

Name	النوع	الوصف	مطلوبة
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للأجزاء المفلترة.	لا
خطأ	errorBase		لا
الكراهية	contentFilterSeverityResult		لا
indirect_attack	contentFilterDetectedResult		لا
الهروب من السجن	contentFilterDetectedResult		لا
الألفاظ النابية	contentFilterDetectedResult		لا
self_harm	contentFilterSeverityResult		لا
الجنس	contentFilterSeverityResult		لا
العنف	contentFilterSeverityResult		لا

contentFilterChoiceResults

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

Name	النوع	الوصف	مطلوبة
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للأجزاء المفلترة.	لا
خطأ	errorBase		لا
الكراهية	contentFilterSeverityResult		لا
الألفاظ النابية	contentFilterDetectedResult		لا
protected_material_code	contentFilterDetectedWithCitationResult		لا
protected_material_text	contentFilterDetectedResult		لا
self_harm	contentFilterSeverityResult		لا
الجنس	contentFilterSeverityResult		لا
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		لا
العنف	contentFilterSeverityResult		لا

contentFilterDetailedResults

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

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

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

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

dalleFilterResults

Name	النوع	الوصف	مطلوبة
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للأجزاء المفلترة.	لا
الكراهية	contentFilterSeverityResult		لا
الهروب من السجن	contentFilterDetectedResult		لا
الألفاظ النابية	contentFilterDetectedResult		لا
self_harm	contentFilterSeverityResult		لا
الجنس	contentFilterSeverityResult		لا
العنف	contentFilterSeverityResult		لا

chatCompletionsRequestCommon

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

إنشاءCompletionRequest

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

إنشاءCompletionResponse

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

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

createChatCompletionRequest

Name	النوع	الوصف	مطلوبة	افتراضي
الصوت	الهدف	معايير إخراج الصوت. مطلوب عند طلب إخراج الصوت باستخدام `modalities: ["audio"]`.	لا
صيغة └─	enum	يحدد صيغة الصوت المخرج. يجب أن يكون أحد ، `wavmp3`، `flac`، `opus`، أو `pcm16`. القيم الممكنة: `wav`, `mp3`, , `flacopus`,`pcm16`	لا
└─ صوت	enum	يحدد نوع الصوت. الأصوات المدعومة هي `alloy`، `echo`، `fable`، `onyx`، `nova`، و `shimmer`. القيم الممكنة: `alloy`، `echo`، `fable`، `onyx`، `novashimmer`	لا
data_sources	مصفوفة	إدخالات التكوين لإضافات الدردشة Azure OpenAI التي تستخدمها. هذه المواصفة الإضافية متوافقة فقط مع Azure OpenAI.	لا
frequency_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا.	لا	1
function_call	string أو chatCompletionFunctionCallOption	تم استبعاده لصالح `tool_choice`. يتحكم في أي وظيفة (إن وجدت) يتم استدعاؤها بواسطة النموذج. `none` يعني أن النموذج لن يستدعي دالة بل يولد رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء دالة. تحديد دالة معينة عبر `{"name": "my_function"}` يجبر النموذج على استدعاء تلك الدالة. `none` هي الوضع الافتراضي عندما لا توجد دوال. `auto` هي الافتراضية إذا كانت الدوال موجودة.	لا
الوظائف	مصفوفة	تم استبعاده لصالح `tools`. قائمة بالدوال التي قد يولد النموذج مدخلات JSON لها.	لا
logit_bias	الهدف	قم بتعديل احتمالية ظهور رموز محددة في الإكمال. يقبل كائن JSON يربط الرموز (المحددة بمعرف الرمز الخاص بها في الرمز) إلى قيمة تحيز مرتبطة من -100 إلى 100. رياضيا، يضاف التحيز إلى اللوجيتس التي يولدها النموذج قبل أخذ العينة. يختلف التأثير الدقيق حسب النموذج، لكن القيم بين -1 و1 يجب أن تقلل أو تزيد من احتمال الاختيار؛ قيم مثل -100 أو 100 يجب أن تؤدي إلى حظر أو اختيار حصري للرمز المعني.	لا	‏‫لا شيء‬
logprobs	boolean	هل يجب إعادة احتمالات السجل لرموز الإخراج أم لا. إذا كان صحيحا، يعيد احتمالات لوغاريتيم كل رمز مخرج تم إرجاعه في `content` .`message`	لا	خطأ
max_completion_tokens	integer	حد أعلى لعدد الرموز التي يمكن توليدها لإكمال، بما في ذلك رموز الإخراج المرئية ورموز الاستدلال.	لا
max_tokens	integer	الحد الأقصى لعدد الرموز التي يمكن إنشاؤها في إكمال الدردشة. الطول الكلي لرموز الإدخال والرموز المولدة محدود بطول سياق النموذج.	لا
الرسائل	مصفوفة	قائمة بالرسائل التي شكلت المحادثة حتى الآن. مثال Python code.	‏‏نعم‬
البيانات الوصفية	الهدف	العلامات والقيم المعرفة من قبل المطور المستخدمة لتصفية الإكمال في لوحة تحكم الإكمالات المخزنة.	لا
الأساليب	ChatCompletionModalities	أنواع المخرجات التي ترغب في أن يولدها النموذج لهذا الطلب. معظم النماذج قادرة على توليد نص، وهو الوضع الافتراضي: `["text"]` يمكن أيضا استخدام النموذج `gpt-4o-audio-preview` لتوليد الصوت. لطلب أن يولد هذا النموذج ردودا نصية وصوتية، يمكنك استخدام: `["text", "audio"]`	لا
n	integer	كم عدد خيارات إكمال المحادثة التي يجب إنشاؤها لكل رسالة إدخال. لاحظ أنه سيتم تحصيل الرسوم بناء على عدد الرموز المولدة عبر جميع الخيارات. حافظ `n` على ذلك `1` لتقليل التكاليف.	لا	1
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تفعيل استدعاء الدوال المتوازية أثناء استخدام الأداة.	لا	صحيح
التنبؤ	PredictionContent	تكوين للمخرج المتوقع، والذي يمكن أن يحسن بشكل كبير أوقات الاستجابة عندما تكون أجزاء كبيرة من استجابة النموذج معروفة مسبقا. هذا شائع جدا عندما تقوم بإعادة توليد ملف مع تغييرات طفيفة فقط في معظم المحتوى.	لا
presence_penalty	number	الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة.	لا	1
reasoning_effort	enum	نماذج O1 فقط يقيد الجهد في التفكير في نماذج الاستدلال. القيم المدعومة حاليا هي `low`، `medium`، و `high`. تقليل جهد التفكير يمكن أن يؤدي إلى استجابة أسرع واستخدام رموز أقل في الاستدلال. القيم الممكنة: `low`, `medium`, `high`	لا
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` التوليد تجاوز أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
البذور	integer	هذه الميزة موجودة في مرحلة البيتا. إذا تم تحديده، يبذل نظامنا جهدا قصارى جهده للأخذ عينات حتمية، بحيث يجب أن تعطي الطلبات المتكررة بنفس `seed` المعلمات نفس النتيجة. الحتمية ليست مضمونة، ويجب عليك الرجوع إلى `system_fingerprint` معامل الاستجابة لمراقبة التغيرات في الخلفية.	لا
توقف	السلسلة أو المصفوفة	حتى 4 تسلسلات تتوقف فيها واجهة برمجة التطبيقات عن توليد رموز إضافية.	لا
المتجر	boolean	ما إذا كان يجب تخزين مخرجات طلب إكمال الدردشة هذا لاستخدامه في منتجات تقطير أو تقييم النماذج الخاصة بنا أم لا.	لا
تدفق	boolean	إذا تم تعيينها، يتم إرسال دلتا جزئية للرسائل، كما في ChatGPT. يتم إرسال الرموز كأحداث مرسلة من الخادم فقط عبر البيانات بمجرد توفرها، وتنهي السلسلة برسالة `data: [DONE]` . مثال Python code.	لا	خطأ
stream_options	chatCompletionStreamOptions	خيارات للاستجابة عبر البث. قم بتعيين هذا فقط عندما تضبط `stream: true`.	لا	‏‫لا شيء‬
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 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	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا
user_security_context	userSecurityContext	يحتوي سياق أمان المستخدم على عدة معلمات تصف تطبيق الذكاء الاصطناعي نفسه، والمستخدم النهائي الذي يتفاعل مع تطبيق الذكاء الاصطناعي. تساعد هذه المجالات فرق عمليات الأمن لديك على التحقيق في الحوادث الأمنية والتخفيف منها من خلال توفير نهج شامل لحماية تطبيقات الذكاء الاصطناعي الخاصة بك. تعرف على المزيد حول حماية تطبيقات الذكاء الاصطناعي باستخدام Microsoft Defender for Cloud.	لا

userSecurityContext

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

Name	النوع	الوصف	مطلوبة
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.	لا

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

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

chatCompletionFunctionCallOption

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

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

chatCompletionFunctionParameters

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

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

chatCompletionRequestMessage

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

ChatCompletionRequestDeveloperMessage
chatCompletionRequestSystemMessage
chatCompletionRequestUserMessage
chatCompletionRequestAssistantMessage
chatCompletionRequestToolMessage
chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

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

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

chatCompletionRequestSystemMessage

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

chatCompletionRequestUserMessage

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

chatCompletionRequestAssistantMessage

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

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatCompletionRequestDeveloperMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestMessageContentPartText
chatCompletionRequestMessageContentPartImage
chatCompletionRequestMessageContentPartAudio

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestMessageContentPartText
chatCompletionRequestMessageContentPartRefusal

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartAudio

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

chatCompletionRequestMessageContentPartImage

Name	النوع	الوصف	مطلوبة
image_url	الهدف		‏‏نعم‬
└─ التفاصيل	enum	يحدد مستوى التفاصيل في الصورة. تعرف على المزيد في دليل الرؤية. القيم الممكنة: `auto`, `low`, `high`	لا
└─ عنوان URL	string	إما رابط URL للصورة أو بيانات الصورة المشفرة في base64.	لا
النوع	enum	نوع المحتوى الجزئي. القيم المحتملة: `image_url`	‏‏نعم‬

chatCompletionRequestMessageContentPartRefusal

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

تكوين azureChatExtension

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

###Discriminator ل azureChatExtensionConfiguration

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

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

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

نوع azureChatExtension

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

تكوين azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

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

azureSearchIndexFieldMappingOptions

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

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

نوع azureSearchQuery

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

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

تكوين azureCosmosDBChatExtensionConfiguration

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

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

azureCosmosDBChatExtensionParameters

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

Name	النوع	الوصف	مطلوبة	افتراضي
allow_partial_result	boolean	إذا تم تحديد النتيجة كصحيحة، سيسمح النظام باستخدام نتائج بحث جزئية ويفشل الطلب إذا فشلت جميع الاستعلامات. إذا لم يتم تحديده أو تحديده كخطأ، سيفشل الطلب إذا فشل أي استعلام بحث.	لا	خطأ
authentication	onYourDataConnectionStringAuthenticationOptions	خيارات المصادقة ل Azure OpenAI On Your Data عند استخدام سلسلة الاتصال.	‏‏نعم‬
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 index المستخدم مع Azure Cosmos DB.	‏‏نعم‬
max_search_queries	integer	يجب إرسال الحد الأقصى لعدد الاستعلامات المعاد كتابتها إلى مزود البحث لرسالة مستخدم واحدة. إذا لم يتم تحديدها، سيقرر النظام عدد الاستعلامات التي سيتم إرسالها.	لا
التشدد	integer	التكوين الصارم لتصفية ملاءمة البحث. كلما زادت الدقة، زادت الدقة ولكن تقليل التذكر للإجابة.	لا
top_n_documents	integer	العدد الأعلى المكون من المستندات التي يجب عرضها في الاستعلام المكون.	لا

azureCosmosDBFieldMappingOptions

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

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

تكوين elasticsearchChatExtensionConfiguration

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

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

elasticsearchChatExtensionParameters

المعلمات المستخدمة عند تكوين ElasticsearchÂ® كإضافة دردشة Azure OpenAI.

Name	النوع	الوصف	مطلوبة	افتراضي
allow_partial_result	boolean	إذا تم تحديد النتيجة كصحيحة، سيسمح النظام باستخدام نتائج بحث جزئية ويفشل الطلب إذا فشلت جميع الاستعلامات. إذا لم يتم تحديده أو تحديده كخطأ، سيفشل الطلب إذا فشل أي استعلام بحث.	لا	خطأ
authentication	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.	لا
التشدد	integer	التكوين الصارم لتصفية ملاءمة البحث. كلما زادت الدقة، زادت الدقة ولكن تقليل التذكر للإجابة.	لا
top_n_documents	integer	العدد الأعلى المكون من المستندات التي يجب عرضها في الاستعلام المكون.	لا

elasticsearchIndexFieldMappingOptions

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

Name	النوع	الوصف	مطلوبة
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.
نوع	string
القيم	`simple` `vector`

mongoDBChatExtensionConfiguration

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

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

mongoDBChatExtensionParameters

المعلمات التي يجب استخدامها عند تكوين إضافات دردشة Azure OpenAI On Your Data عند استخدام Mongo DB.

Name	النوع	الوصف	مطلوبة	افتراضي
allow_partial_result	boolean	إذا تم تحديد النتيجة كصحيحة، سيسمح النظام باستخدام نتائج بحث جزئية ويفشل الطلب إذا فشلت جميع الاستعلامات. إذا لم يتم تحديده أو تحديده كخطأ، سيفشل الطلب إذا فشل أي استعلام بحث.	لا	خطأ
app_name	string	اسم تطبيق Mongo DB.	‏‏نعم‬
authentication	onYourDataUsernameAndPasswordAuthenticationOptions	خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام اسم مستخدم وكلمة مرور.	‏‏نعم‬
collection_name	string	اسم مجموعة مونغو دي بي.	‏‏نعم‬
database_name	string	اسم قاعدة بيانات مونغو ديبس.	‏‏نعم‬
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	يجب إرسال الحد الأقصى لعدد الاستعلامات المعاد كتابتها إلى مزود البحث لرسالة مستخدم واحدة. إذا لم يتم تحديدها، سيقرر النظام عدد الاستعلامات التي سيتم إرسالها.	لا
التشدد	integer	التكوين الصارم لتصفية ملاءمة البحث. كلما زادت الدقة، زادت الدقة ولكن تقليل التذكر للإجابة.	لا
top_n_documents	integer	العدد الأعلى المكون من المستندات التي يجب عرضها في الاستعلام المكون.	لا

mongoDBFieldMappingOptions

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

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

تكوين pineconeChatExtension

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

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

pineconeChatExtensionParameters

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

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

pineconeFieldMappingOptions

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

Name	النوع	الوصف	مطلوبة
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

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

onYourDataContextProperty

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

الملكية	قيمة
الوصف	خاصية السياق.
نوع	string
القيم	`citations` `intent` `all_retrieved_documents`

onYourDataAuthenticationType

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

الملكية	قيمة
الوصف	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.
نوع	string
القيم	`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.

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

onYourDataConnectionStringAuthenticationOptions

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

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

onYourDataKeyAndKeyIdAuthenticationOptions

خيارات المصادقة ل Azure OpenAI On Your Data عند استخدام مفتاح Elasticsearch وزوج معرف المفاتيح.

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

onYourDataEncodedApiKeyAuthenticationOptions

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

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

onYourDataAccessTokenAuthenticationOptions

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

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUsernameAndPasswordAuthenticationOptions

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

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

onYourDataVectorizationSource

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

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

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

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

onYourDataVectorizationSourceType

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

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

onYourDataEndpointVectorizationSource

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

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

onYourDataDeploymentNameVectorizationSource

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

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

onYourDataIntegratedVectorizationSource

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

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

onYourDataModelIdVectorizationSource

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

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

azureChatExtensionsMessageContext

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

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

الاقتباس

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

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

استرداد مستند

الوثيقة المسترجعة.

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

filterReason

سبب التصفية للمستند المسترجع.

الملكية	قيمة
الوصف	سبب التصفية للمستند المسترجع.
نوع	string
القيم	`score` `rerank`

chatCompletionMessageToolCall

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

toolCallType

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

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

chatCompletionRequestMessageTool

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

chatCompletionRequestMessageFunction

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

إنشاءChatCompletionResponse

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

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

إنشاءChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

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

chatCompletionMessageToolCallChunk

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

chatCompletionStreamOptions

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

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

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

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

chatCompletionResponseMessageRole

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

الملكية	قيمة
الوصف	دور كاتب رسالة الرد.
نوع	string
القيم	`assistant`

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

chatCompletionNamedToolChoice

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

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

ParallelToolCalls

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

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

PredictionContent

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

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

chatCompletionMessageToolCalls

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

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

ChatCompletionModalities

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

["text"]

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

["text", "audio"]

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

chatCompletionFunctionCall

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

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

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

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

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

chatCompletionTool

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

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

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

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

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

FunctionObject

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

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

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

ResponseFormatJsonObject

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

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

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

chatCompletionChoiceCommon

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

createTranslationRequest

طلب الترجمة.

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

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

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

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

audioVerboseResponse

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

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

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

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

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

createTranscriptionRequest

طلب النسخ.

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

ملف صوتي

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

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

audioWord

كلمة نقل أو ترجمة.

Name	النوع	الوصف	مطلوبة
النهاية	number	تعويض نهاية Word.	لا
ابدأ	number	Word إزاحة البدء.	لا
كلمة	string	كلمة	لا

createSpeechRequest

طلب الكلام.

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

imageQuality

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

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

imagesResponseFormat

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

الملكية	قيمة
الوصف	الصيغة التي تعاد بها الصور المولدة.
نوع	string
الافتراضي	عنوان URL
القيم	`url` `b64_json`

imagesOutputFormat

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

الملكية	قيمة
الوصف	تنسيق الملف الذي تعاد به الصور المولدة. مدعوم فقط لنماذج سلسلة gpt-image-1.
نوع	string
الافتراضي	png
القيم	`png` `jpeg`

حجم الصورة

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

الملكية	قيمة
الوصف	حجم الصور المولدة.
نوع	string
الافتراضي	أوتو
القيم	`auto` `1792x1024` `1024x1792` `1024x1024` `1024x1536` `1536x1024`

imageStyle

أسلوب الصور المولدة. مدعوم فقط ل dall-e-3.

الملكية	قيمة
الوصف	أسلوب الصور المولدة. مدعوم فقط ل dall-e-3.
نوع	string
الافتراضي	حيه
القيم	`vivid` `natural`

الصورة الخلفية

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

الملكية	قيمة
الوصف	يسمح بتعيين الشفافية لخلفية الصورة أو الصور المولدة. هذا المعامل مدعوم فقط لنماذج سلسلة gpt-image-1.
نوع	string
الافتراضي	أوتو
القيم	`transparent` `opaque` `auto`

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

Name	النوع	الوصف	مطلوبة	افتراضي
الخلفية	الصورة الخلفية	يسمح بتعيين الشفافية لخلفية الصورة أو الصور المولدة. هذا المعامل مدعوم فقط لنماذج سلسلة 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
الحجم	حجم الصورة	حجم الصور المولدة.	لا	أوتو
الأسلوب	imageStyle	أسلوب الصور المولدة. مدعوم فقط ل dall-e-3.	لا	حيه
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد في مراقبة واكتشاف سوء الاستخدام.	لا

imageEditsRequest

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

إنشاءImagesResponse

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

imageResult

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

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

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

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

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

الخط

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

Name	النوع	الوصف	مطلوبة	افتراضي
يمتد	مصفوفة	مصفوفة من الامتدادات التي تمثل الكائنات المكتشفة ومعلومات صندوق الحدود الخاص بها.	‏‏نعم‬
النص	string		‏‏نعم‬

تمتد

كائن span يمثل كائنا مكتشفا ومعلومات صندوق الحدود الخاص به.

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

runCompletionUsage

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

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

runStepCompletionUsage

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

Name	النوع	الوصف	مطلوبة
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 التوليد تجاوز أو تجاوز المحادثة الحد الأقصى لطول السياق.

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

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

تنسيق مساعد ApiResponse

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

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	string	يجب أن يكون أحد أو `textjson_object`.	لا	النص

اtype: AssistantsApiResponseFormat

قيمة	الوصف
النص
json_object

assistantObject

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

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

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

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

createAssistantRequest

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

تعديلAssistantRequest

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

deleteAssistantResponse

Name	النوع	مطلوبة
تم الحذف	boolean	‏‏نعم‬
معرف	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

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

قيمة	الوصف
assistant.deleted

listAssistantsResponse

Name	النوع	مطلوبة
البيانات	مصفوفة	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

assistantToolsCode

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	string	نوع الأداة التي يتم تعريفها: `code_interpreter`	‏‏نعم‬

نوع Enum: assistantToolsCodeType

قيمة	الوصف
code_interpreter

assistantToolsFileSearch

Name	النوع	الوصف	مطلوبة
file_search	الهدف	تجاوزات أداة البحث عن الملفات.	لا
└─ max_num_results	integer	الحد الأقصى لعدد النتائج التي يجب أن تنتجها أداة البحث عن الملفات. الافتراضي هو 20 لطرازات GPT-4* و5 لفئة GPT-3.5 توربو. يجب أن يكون هذا الرقم بين 1 و50 شاملا. لاحظ أن أداة البحث عن الملفات قد تنتج نتائج أقل من `max_num_results` النتائج.	لا
النوع	string	نوع الأداة التي يتم تعريفها: `file_search`	‏‏نعم‬

اكتب Enum: assistantToolsFileSearchType

قيمة	الوصف
file_search

assistantToolsFileSearchTypeOnly

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	string	نوع الأداة التي يتم تعريفها: `file_search`	‏‏نعم‬

اكتب Enum: assistantToolsFileSearchType

قيمة	الوصف
file_search

assistantToolsFunction

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

نوع Enum: assistantToolsFunction

قيمة	الوصف
دالة

truncationObject

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

Name	النوع	الوصف	مطلوبة	افتراضي
last_messages	integer	عدد أحدث الرسائل من الخيط عند بناء السياق الخاص بالجري.	لا
النوع	string	استراتيجية القطع المستخدمة في الخيط. الافتراضي هو `auto`. إذا تم تعيينه على `last_messages`، سيتم اختصار الخيط إلى أحدث n رسالة في الخيط. عند تعيينه على `auto`، سيتم إسقاط الرسائل في منتصف الخيط لتتناسب مع طول السياق للنموذج، `max_prompt_tokens`.	‏‏نعم‬

نوع Enum: اقتطاع النوع

قيمة	الوصف
أوتو
last_messages

assistantsApiToolChoiceOption

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

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

assistantsNamedToolChoice

assistantsNamedToolChoice

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

Name	النوع	الوصف	مطلوبة
دالة	الهدف		لا
└─ الاسم	string	اسم الدالة التي يجب استدعاؤها.	لا
النوع	string	نوع الأداة. إذا كان النوع هو `function`، يجب تعيين اسم الدالة	‏‏نعم‬

نوع Enum: المساعدون اسم الأداة الاختياريالنوع

قيمة	الوصف
دالة
code_interpreter
file_search

runObject

يمثل تنفيذ على خيوط.

Name	النوع	الوصف	مطلوبة	افتراضي
assistant_id	string	معرف المساعد المستخدم لتنفيذ هذه الجولة.	‏‏نعم‬
cancelled_at	integer	طابع الوقت ليونكس (بالثواني) ليتم إلغاء التشغيل.	‏‏نعم‬
completed_at	integer	طابع يونكس الزمني (بالثواني) لانتهاء التشغيل.	‏‏نعم‬
created_at	integer	طابع يونكس الزمني (بالثواني) لوقت إنشاء اللعبة.	‏‏نعم‬
expires_at	integer	طابع يونكس الزمني (بالثواني) لانتهاء صلاحية التشغيل.	‏‏نعم‬
failed_at	integer	طابع يونكس الزمني (بالثواني) للحظة فشل التشغيل.	‏‏نعم‬
معرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
incomplete_details	الهدف	تفاصيل عن سبب عدم اكتمال السلسلة. سيكون كذلك `null` إذا لم تكن السلسلة غير مكتملة.	‏‏نعم‬
└─ السبب	string	سبب عدم اكتمال السلسلة. هذا سيشير إلى الحد المحدد للرمز الذي تم الوصول إليه خلال التشغيل.	لا
التعليمات	string	التعليمات التي استخدمها المساعد في هذه الجولة.	‏‏نعم‬
last_error	الهدف	آخر خطأ مرتبط بهذه الجولة. سيكون كذلك `null` إذا لم تكن هناك أخطاء.	‏‏نعم‬
└─ رمز	string	واحد من `server_error` أو `rate_limit_exceeded`.	لا
└─ رسالة	string	وصف يمكن للبشر قراءته للخطأ.	لا
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المحددة لاستخدامها خلال التشغيل.	‏‏نعم‬
max_prompt_tokens	integer	الحد الأقصى لعدد رموز الأوامر المحددة لاستخدامها خلال التشغيل.	‏‏نعم‬
البيانات الوصفية	الهدف	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة. يمكن أن تكون المفاتيح بحد أقصى 64 حرفا وحتى 512 حرفا.	‏‏نعم‬
النموذج	string	النموذج الذي استخدمه المساعد في هذه الجولة.	‏‏نعم‬
الهدف	string	نوع الكائن، والذي يكون دائما `thread.run`.	‏‏نعم‬
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تفعيل استدعاء الدوال المتوازية أثناء استخدام الأداة.	لا	صحيح
required_action	الهدف	تفاصيل حول الأحداث المطلوبة لمواصلة الجولة. سيكون كذلك `null` إذا لم يكن هناك حاجة لأي إجراء.	‏‏نعم‬
└─ submit_tool_outputs	الهدف	تفاصيل حول مخرجات الأدوات اللازمة لاستمرار هذه الجولة.	لا
└─ 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	طابع الوقت ليونكس (بالثواني) لبدء التشغيل.	‏‏نعم‬
الحالة	string	حالة الجولة، والتي يمكن أن تكون إما `queued`، `in_progress`، `requires_action`، `cancelling`، `cancelledfailedcompleted`، ، أو .`expired`	‏‏نعم‬
درجة الحرارة	number	درجة حرارة أخذ العينات المستخدمة في هذا الدور. إذا لم يكن ضبطا، يتحول افتراضيا إلى 1.	لا
thread_id	string	معرف الخيوط التي تم تنفيذها كجزء من هذا التشغيل.	‏‏نعم‬
tool_choice	assistantsApiToolChoiceOption	يتحكم في أي أداة (إن وجدت) يتم استدعاؤها بواسطة النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات بل يولد رسالة. `auto` هي القيمة الافتراضية و تعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` إجبار النموذج على استدعاء تلك الأداة.	‏‏نعم‬
الأدوات	مصفوفة	قائمة الأدوات التي استخدمها المساعد في هذه الجولة.	‏‏نعم‬	[]
top_p	number	قيمة أخذ عينات النواة المستخدمة في هذه الجولة. إذا لم يكن ضبطا، يتحول افتراضيا إلى 1.	لا
truncation_strategy	truncationObject	ضوابط لكيفية اقتطاع الخيط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للجري.	‏‏نعم‬
الاستخدام	runCompletionUsage	إحصائيات الاستخدام المتعلقة بالجري. هذه القيمة ستكون `null` إذا لم تكن السلسلة في حالة نهائية (مثل `in_progress`، `queued`، إلخ).	‏‏نعم‬

قائمة تعداد العناصر: runObjectType

قيمة	الوصف
thread.run	نوع كائن التشغيل الذي يكون دائما thread.run

قيمة الحالة: RunObjectStatus

قيمة	الوصف
قائمه الانتظار	الولاية المنتظرة في الطابور
in_progress	الدولة in_progress
requires_action	الدولة required_action
الغاء	حالة الإلغاء
تم إلغاء	الحالة الملغاة
فشل	الدولة الفاشلة
اكتمل	الحالة المكتملة
انتهت	الحالة المنتهية

createRunRequest

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

listRunsResponse

Name	النوع	مطلوبة
البيانات	مصفوفة	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

تعديلRunRequest

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

submitToolOutputsRunRequest

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

runToolCallObject

كائنات استدعاء الأدوات

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

نوع Enum: RunToolCallObjectType

قيمة	الوصف
دالة

إنشاءThreadAndRunRequest

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

threadObject

يمثل خيطا يحتوي على رسائل.

Name	النوع	الوصف	مطلوبة	افتراضي
created_at	integer	طابع الوقت ليونكس (بالثواني) لوقت إنشاء الخيط.	‏‏نعم‬
معرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
البيانات الوصفية	الهدف	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة. يمكن أن تكون المفاتيح بحد أقصى 64 حرفا وحتى 512 حرفا.	‏‏نعم‬
الهدف	string	نوع الكائن، والذي يكون دائما `thread`.	‏‏نعم‬
tool_resources	الهدف	مجموعة من الموارد التي تتوفر لأدوات المساعد في هذا الموضوع. الموارد تعتمد على نوع الأداة. على سبيل المثال، تتطلب الأداة `code_interpreter` قائمة معرفات الملفات، بينما تتطلب قائمة `file_search` معرفات مخزن متجه.	‏‏نعم‬
└─ code_interpreter	الهدف		لا
└─ file_ids	مصفوفة	قائمة بمعرفات الملفات المتاحة للأداة `code_interpreter` . يمكن أن يكون هناك ما يصل إلى 20 ملفا مرتبطا بالأداة.	لا	[]
└─ file_search	الهدف		لا
└─ vector_store_ids	مصفوفة	متجر الناقلات المرفق بهذا الموضوع. يمكن أن يكون هناك حد أقصى لمخزن متجه واحد متصل بالخيوط.	لا

عنصر الموضوع: ThreadObjectType

قيمة	الوصف
الخيط	نوع كائن الخيط الذي يكون دائما `thread`

createThreadRequest

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

تعديلThreadRequest

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

حذفThreadResponse

Name	النوع	مطلوبة
تم الحذف	boolean	‏‏نعم‬
معرف	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

عنصر الموضوع: حذف الخيوط الرباعية للكائن

قيمة	الوصف
thread.deleted	حالة كائن استجابة حذف الخيط وهي `thread.deleted`

listThreadsResponse

Name	النوع	مطلوبة
البيانات	مصفوفة	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

messageObject

تمثل رسالة داخل خيوط.

Name	النوع	الوصف	مطلوبة
assistant_id	string	إذا كان ذلك مناسبا، معرف المساعد الذي كتب هذه الرسالة.	‏‏نعم‬
المرفقات	مصفوفة	قائمة بالملفات المرفقة بالرسالة، والأدوات التي أضيفت إليها.	‏‏نعم‬
completed_at	integer	طابع الوقت في يونكس (بالثواني) لوقت اكتمال الرسالة.	‏‏نعم‬
محتوى	مصفوفة	محتوى الرسالة في مجموعة من النصوص و/أو الصور.	‏‏نعم‬
created_at	integer	طابع يونكس الزمني (بالثواني) لوقت إنشاء الرسالة.	‏‏نعم‬
معرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
incomplete_at	integer	طابع يونكس الزمني (بالثواني) عندما يتم وضع علامة على الرسالة كغير مكتملة.	‏‏نعم‬
incomplete_details	الهدف	في رسالة غير مكتملة، تفاصيل عن سبب عدم اكتمال الرسالة.	‏‏نعم‬
└─ السبب	string	السبب في أن الرسالة غير مكتملة.	لا
البيانات الوصفية	الهدف	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة. يمكن أن تكون المفاتيح بحد أقصى 64 حرفا وحتى 512 حرفا.	‏‏نعم‬
الهدف	string	نوع الكائن، والذي يكون دائما `thread.message`.	‏‏نعم‬
الدور	string	الكيان الذي أنتج الرسالة. واحد من `user` أو `assistant`.	‏‏نعم‬
run_id	string	إذا كان ذلك مناسبا، معرف السلسلة المرتبط بتأليف هذه الرسالة.	‏‏نعم‬
الحالة	string	حالة الرسالة، والتي يمكن أن تكون إما `in_progress`، `incomplete`، أو `completed`.	‏‏نعم‬
thread_id	string	معرف الخيوط الذي تنتمي إليه هذه الرسالة.	‏‏نعم‬

أوبكت إينوم: MessageObjectType

قيمة	الوصف
thread.message	نوع كائن الرسالة وهو `thread.message`

قيمة الحالة: MessageObjectStatus

قيمة	الوصف
in_progress
كامله
اكتمل

إينوم الدور: MessageObjectRole

قيمة	الوصف
المستخدم
مساعد

messageDeltaObject

يمثل دلتا الرسالة أي أي حقول تغيرت على رسالة أثناء البث.

Name	النوع	الوصف	مطلوبة
دلتا	الهدف	الدلتا التي تحتوي على الحقول التي تغيرت في الرسالة.	‏‏نعم‬
└─ المحتوى	مصفوفة	محتوى الرسالة في مجموعة من النصوص و/أو الصور.	لا
└─ دور	string	الكيان الذي أنتج الرسالة. واحد من `user` أو `assistant`.	لا
معرف	string	معرف الرسالة، والذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
الهدف	string	نوع الكائن، والذي يكون دائما `thread.message.delta`.	‏‏نعم‬

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

قيمة	الوصف
thread.message.delta

createMessageRequest

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

أدوار Enum: إنشاء رسالة طلب الدور

قيمة	الوصف
المستخدم
مساعد

modifyMessageRequest

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

deleteMessageResponse

Name	النوع	مطلوبة
تم الحذف	boolean	‏‏نعم‬
معرف	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

كائن Enum: حذف الرسالة الرسالةResponseObject

قيمة	الوصف
thread.message.deleted	حالة كائن استجابة الحذف

listMessagesResponse

Name	النوع	مطلوبة
البيانات	مصفوفة	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

messageContentImageFileObject

يشير إلى ملف صورة في محتوى الرسالة.

Name	النوع	الوصف	مطلوبة
image_file	الهدف		‏‏نعم‬
└─ file_id	string	معرف الملف للصورة في محتوى الرسالة.	لا
النوع	string	دائما `image_file`.	‏‏نعم‬

اكتب Enum: MessageContentImageFileObjectType

قيمة	الوصف
image_file	نوع ملف صورة محتوى الرسالة

messageContentTextObject

المحتوى النصي الذي هو جزء من رسالة.

Name	النوع	الوصف	مطلوبة
النص	الهدف		‏‏نعم‬
└─ التعليقات التوضيحية	مصفوفة		لا
└─ القيمة	string	البيانات التي تشكل النص.	لا
النوع	string	دائما `text`.	‏‏نعم‬

typeEnum: messageContentTextObjectType

قيمة	الوصف
النص	نص محتوى الرسالة نوع الكائن

messageContentTextAnnotationsFileCitationObject

استشهاد داخل الرسالة يشير إلى اقتباس محدد من ملف معين مرتبط بالمساعد أو بالرسالة. يتم إنشاؤه عندما يستخدم المساعد أداة "الاسترجاع" للبحث في ملفات.

Name	النوع	الوصف	مطلوبة
end_index	integer		‏‏نعم‬
file_citation	الهدف		‏‏نعم‬
└─ file_id	string	معرف الملف المحدد الذي جاء منه الاستشهاد.	لا
start_index	integer		‏‏نعم‬
النص	string	النص في محتوى الرسالة الذي يحتاج إلى استبدال.	‏‏نعم‬
النوع	string	دائما `file_citation`.	‏‏نعم‬

اtype: FileCitationObjectType

قيمة	الوصف
file_citation	نوع كائن الاستشهاد في الملف

messageContentTextAnnotationsFilePathObject

عنوان URL للملف الذي يتم إنشاؤه عندما استخدم المساعد الأداة code_interpreter لإنشاء ملف.

Name	النوع	الوصف	مطلوبة
end_index	integer		‏‏نعم‬
file_path	الهدف		‏‏نعم‬
└─ file_id	string	معرف الملف الذي تم إنشاؤه.	لا
start_index	integer		‏‏نعم‬
النص	string	النص في محتوى الرسالة الذي يحتاج إلى استبدال.	‏‏نعم‬
النوع	string	دائما `file_path`.	‏‏نعم‬

نوع Enum: FilePathObjectType

قيمة	الوصف
file_path	نوع كائن مسار الملف

messageDeltaContentImageFileObject

يشير إلى ملف صورة في محتوى الرسالة.

Name	النوع	الوصف	مطلوبة
image_file	الهدف		لا
└─ file_id	string	معرف الملف للصورة في محتوى الرسالة.	لا
فهرس	integer	فهرس جزء المحتوى في الرسالة.	‏‏نعم‬
النوع	string	دائما `image_file`.	‏‏نعم‬

اكتب Enum: MessageDeltaContentImageFileObjectType

قيمة	الوصف
image_file

messageDeltaContentTextObject

المحتوى النصي الذي هو جزء من رسالة.

Name	النوع	الوصف	مطلوبة
فهرس	integer	فهرس جزء المحتوى في الرسالة.	‏‏نعم‬
النص	الهدف		لا
└─ التعليقات التوضيحية	مصفوفة		لا
└─ القيمة	string	البيانات التي تشكل النص.	لا
النوع	string	دائما `text`.	‏‏نعم‬

نوع Enum: MessageDeltaContentTextObjectType

قيمة	الوصف
النص

messageDeltaContentTextAnnotationsFileCitationObject

استشهاد داخل الرسالة يشير إلى اقتباس محدد من ملف معين مرتبط بالمساعد أو بالرسالة. يتم إنشاؤه عندما يستخدم المساعد أداة "file_search" للبحث في الملفات.

Name	النوع	الوصف	مطلوبة
end_index	integer		لا
file_citation	الهدف		لا
└─ file_id	string	معرف الملف المحدد الذي جاء منه الاستشهاد.	لا
└─ quote	string	الاقتباس المحدد في الملف.	لا
فهرس	integer	فهرس التعليق في جزء محتوى النص.	‏‏نعم‬
start_index	integer		لا
النص	string	النص في محتوى الرسالة الذي يحتاج إلى استبدال.	لا
النوع	string	دائما `file_citation`.	‏‏نعم‬

اtype: MessageDeltaContentTextAnnotationsFileCitationObjectType

قيمة	الوصف
file_citation

messageDeltaContentTextAnnotationsFilePathObject

عنوان URL للملف الذي يتم إنشاؤه عندما استخدم المساعد الأداة code_interpreter لإنشاء ملف.

Name	النوع	الوصف	مطلوبة
end_index	integer		لا
file_path	الهدف		لا
└─ file_id	string	معرف الملف الذي تم إنشاؤه.	لا
فهرس	integer	فهرس التعليق في جزء محتوى النص.	‏‏نعم‬
start_index	integer		لا
النص	string	النص في محتوى الرسالة الذي يحتاج إلى استبدال.	لا
النوع	string	دائما `file_path`.	‏‏نعم‬

اكتب Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

قيمة	الوصف
file_path

runStepObject

يمثل خطوة في تنفيذ الجري.

Name	النوع	الوصف	مطلوبة
assistant_id	string	معرف المساعد المرتبط بخطوة التشغيل.	‏‏نعم‬
cancelled_at	integer	طابع الوقت ليونكس (بالثواني) للحظة إلغاء خطوة التشغيل.	‏‏نعم‬
completed_at	integer	طابع يونكس الزمني (بالثواني) عند اكتمال خطوة التشغيل.	‏‏نعم‬
created_at	integer	طابع يونكس الزمني (بالثواني) للحظة إنشاء خطوة التشغيل.	‏‏نعم‬
expired_at	integer	طابع يونكس الزمني (بالثواني) لانتهاء خطوة التشغيل. تعتبر الخطوة منتهية الصلاحية إذا كانت فترة الأصل منتهية.	‏‏نعم‬
failed_at	integer	طابع الوقت في يونكس (بالثواني) عندما تفشل خطوة التشغيل.	‏‏نعم‬
معرف	string	معرف خطوة التشغيل، والذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
last_error	الهدف	آخر خطأ مرتبط بهذه الخطوة التشغيلية. سيكون كذلك `null` إذا لم تكن هناك أخطاء.	‏‏نعم‬
└─ رمز	string	واحد من `server_error` أو `rate_limit_exceeded`.	لا
└─ رسالة	string	وصف يمكن للبشر قراءته للخطأ.	لا
البيانات الوصفية	الهدف	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة. يمكن أن تكون المفاتيح بحد أقصى 64 حرفا وحتى 512 حرفا.	‏‏نعم‬
الهدف	string	نوع الكائن، والذي يكون دائما `assistant.run.step`.	‏‏نعم‬
run_id	string	معرف الجولة التي تنتمي إليها خطوة الجري.	‏‏نعم‬
الحالة	string	حالة الجولة، والتي يمكن أن تكون إما `in_progress`، `cancelled`، `failed`، `completed`، أو `expired`.	‏‏نعم‬
step_details	runStepDetailsMessageCreationObject أو runStepDetailsToolCallsObject	تفاصيل خطوة الجري.	‏‏نعم‬
thread_id	string	معرف المواضيع التي تم تشغيلها.	‏‏نعم‬
النوع	string	نوع خطوة الجري، والتي يمكن أن تكون إما `message_creation` أو `tool_calls`.	‏‏نعم‬

عنصر الموضوع: RunStepObjectType

قيمة	الوصف
assistant.run.step	نوع الكائن، وهو دائما `assistant.run.step`

نوع Enum: RunStepObjectType

قيمة	الوصف
message_creation	خطوة message_creation جري
tool_calls	خطوة tool_calls جري

قيمة الحالة: RunStepObjectStatus

قيمة	الوصف
in_progress	حالة in_progress الجولة
تم إلغاء	حالة إلغاء الجولة
فشل	حالة إلغاء الجولة
اكتمل	حالة إلغاء الجولة
انتهت	حالة إلغاء الجولة

runStepDeltaObject

يمثل دلتا خطوة التشغيل، أي أي حقول متغيرة على خطوة التشغيل أثناء البث.

Name	النوع	الوصف	مطلوبة
دلتا	الهدف	الدلتا التي تحتوي على الحقول التي تغيرت في خطوة الجري.	‏‏نعم‬
└─ step_details	runStepDeltaStepDetailsMessageCreationObject أو runStepDeltaStepDetailsToolCallsObject	تفاصيل خطوة الجري.	لا
معرف	string	معرف خطوة التشغيل، والذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
الهدف	string	نوع الكائن، والذي يكون دائما `thread.run.step.delta`.	‏‏نعم‬

object enum: RunStepDeltaObjectType

قيمة	الوصف
thread.run.step.delta

listRunStepsResponse

Name	النوع	مطلوبة
البيانات	مصفوفة	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

runStepDetailsMessageCreationObject

تفاصيل إنشاء الرسالة حسب خطوة التشغيل.

Name	النوع	الوصف	مطلوبة
message_creation	الهدف		‏‏نعم‬
└─ message_id	string	معرف الرسالة التي تم إنشاؤها بواسطة هذه الخطوة التشغيلية.	لا
النوع	string	دائما `message_creation`.	‏‏نعم‬

اكتب Enum: RunStepDetailsMessageCreationObjectType

قيمة	الوصف
message_creation

runStepDeltaStepDetailsMessageCreationObject

تفاصيل إنشاء الرسالة حسب خطوة التشغيل.

Name	النوع	الوصف	مطلوبة
message_creation	الهدف		لا
└─ message_id	string	معرف الرسالة التي تم إنشاؤها بواسطة هذه الخطوة التشغيلية.	لا
النوع	string	دائما `message_creation`.	‏‏نعم‬

اtypeEnum: RunStepDeltaStepDetailsMessageCreationObjectType

قيمة	الوصف
message_creation

runStepDetailsToolCallsObject

تفاصيل استدعاء الأدوات.

Name	النوع	الوصف	مطلوبة	افتراضي
tool_calls	مصفوفة	مجموعة من استدعاءات الأدوات التي كانت خطوة الجري متورطة فيها. يمكن ربط هذه القواعد بأحد ثلاثة أنواع من الأدوات: `code_interpreter`، `retrieval` أو `function`.	‏‏نعم‬
النوع	string	دائما `tool_calls`.	‏‏نعم‬

اtype: RunStepDetailsToolCallsObjectType

قيمة	الوصف
tool_calls

runStepDeltaStepDetailsToolCallsObject

تفاصيل استدعاء الأدوات.

Name	النوع	الوصف	مطلوبة	افتراضي
tool_calls	مصفوفة	مجموعة من استدعاءات الأدوات التي كانت خطوة الجري متورطة فيها. يمكن ربط هذه القواعد بأحد ثلاثة أنواع من الأدوات: `code_interpreter`، `file_search` أو `function`.	لا
النوع	string	دائما `tool_calls`.	‏‏نعم‬

اtypeEnum: RunStepDeltaStepDetailsToolCallsObjectType

قيمة	الوصف
tool_calls

runStepDetailsToolCallsCodeObject

تفاصيل استدعاء أداة مفسر الشيفرة التي شاركت فيها خطوة التشغيل.

Name	النوع	الوصف	مطلوبة
code_interpreter	الهدف	أداة استدعاء رمز التعريف.	‏‏نعم‬
└─ مدخل	string	الإدخال إلى أداة مفسر الكود.	لا
└─ المخرجات	مصفوفة	المخرجات من استدعاء أداة مفسر الكود. يمكن لكود فسر إخراج عنصر واحد أو أكثر، بما في ذلك النص (`logs`) أو الصور (`image`). كل واحد من هذه يمثل بنوع مختلف من الكائنات.	لا
معرف	string	معرف نداء الأداة.	‏‏نعم‬
النوع	string	نوع استدعاء الأدوات. هذا دائما `code_interpreter` سيكون لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

اtypeTypeEnum: RunStepDetailsToolCallsCodeObjectType

قيمة	الوصف
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

تفاصيل استدعاء أداة مفسر الشيفرة التي شاركت فيها خطوة التشغيل.

Name	النوع	الوصف	مطلوبة
code_interpreter	الهدف	أداة استدعاء رمز التعريف.	لا
└─ مدخل	string	الإدخال إلى أداة مفسر الكود.	لا
└─ المخرجات	مصفوفة	المخرجات من استدعاء أداة مفسر الكود. يمكن لكود فسر إخراج عنصر واحد أو أكثر، بما في ذلك النص (`logs`) أو الصور (`image`). كل واحد من هذه يمثل بنوع مختلف من الكائنات.	لا
معرف	string	معرف نداء الأداة.	لا
فهرس	integer	مؤشر استدعاء الأداة في مصفوفة استدعاءات الأداة.	‏‏نعم‬
النوع	string	نوع استدعاء الأدوات. هذا دائما `code_interpreter` سيكون لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

اكتب Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

قيمة	الوصف
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

استدعاء النص الناتج عن أداة مفسر الشيفرة كجزء من خطوة تشغيل.

Name	النوع	الوصف	مطلوبة	افتراضي
السجلات	string	إخراج النص من أداة مفسر الشيفرة.	‏‏نعم‬
النوع	string	دائما `logs`.	‏‏نعم‬

اtype: RunStepDetailsToolCallsCodeOutputLogsObjectType

قيمة	الوصف
السجلات

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

استدعاء النص الناتج عن أداة مفسر الشيفرة كجزء من خطوة تشغيل.

Name	النوع	الوصف	مطلوبة
فهرس	integer	مؤشر المخرج في مصفوفة المخرجات.	‏‏نعم‬
السجلات	string	إخراج النص من أداة مفسر الشيفرة.	لا
النوع	string	دائما `logs`.	‏‏نعم‬

typeEnum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

قيمة	الوصف
السجلات

runStepDetailsToolCallsCodeOutputImageObject

Name	النوع	الوصف	مطلوبة
صورة	الهدف		‏‏نعم‬
└─ file_id	string	معرف الملف للصورة.	لا
النوع	string	دائما `image`.	‏‏نعم‬

اكتب Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

قيمة	الوصف
صورة

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Name	النوع	الوصف	مطلوبة
صورة	الهدف		لا
└─ file_id	string	معرف الملف للصورة.	لا
فهرس	integer	مؤشر المخرج في مصفوفة المخرجات.	‏‏نعم‬
النوع	string	دائما `image`.	‏‏نعم‬

اكتب Enum: RunStepDeltaStepDetailsToolcallsCodeOutputImageObject

قيمة	الوصف
صورة

runStepDetailsToolCallsFileSearchObject

Name	النوع	الوصف	مطلوبة
file_search	الهدف	في الوقت الحالي، سيكون هذا دائما كائن فارغ.	‏‏نعم‬
└─ النتائج	مصفوفة	نتائج البحث في الملفات.	لا
معرف	string	معرف كائن استدعاء الأداة.	‏‏نعم‬
النوع	string	نوع استدعاء الأدوات. هذا دائما `file_search` سيكون لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

اtype: RunStepDetailsToolCallsFileSearchObjectType

قيمة	الوصف
file_search

runStepDetailsToolCallsFileSearchResultObject

نسخة نتيجة من بحث الملف.

Name	النوع	الوصف	مطلوبة
محتوى	مصفوفة	محتوى النتيجة التي تم العثور عليها. يتم تضمين المحتوى فقط إذا طلب ذلك عبر معامل استعلام الإضافة.	لا
file_id	string	معرف الملف الذي تم العثور عليه في تلك النتيجة.	‏‏نعم‬
file_name	string	اسم الملف الذي تم العثور عليه في تلك النتيجة.	‏‏نعم‬
الموسيقى التصويرية	number	نتيجة النتيجة. يجب أن تكون جميع القيم رقما فاصلا عائما بين 0 و1.	‏‏نعم‬

runStepDeltaStepDetailsToolCallsFileSearchObject

Name	النوع	الوصف	مطلوبة
file_search	الهدف	في الوقت الحالي، سيكون هذا دائما كائن فارغ.	‏‏نعم‬
معرف	string	معرف كائن استدعاء الأداة.	لا
فهرس	integer	مؤشر استدعاء الأداة في مصفوفة استدعاءات الأداة.	‏‏نعم‬
النوع	string	نوع استدعاء الأدوات. هذا دائما `retrieval` سيكون لهذا النوع من استدعاء الأدوات.	‏‏نعم‬

typeEnum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

قيمة	الوصف
file_search

runStepDetailsToolCallsFunctionObject

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

نوع Enum: RunStepDetailsToolCallsFunctionObjectType

قيمة	الوصف
دالة

runStepDeltaStepDetailsToolCallsFunctionObject

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

نوع Enum: RunStepDetailsToolCallsFunctionObjectType

قيمة	الوصف
دالة

vectorStoreExpirationAfter

سياسة انتهاء الصلاحية لمتجر متجهات.

Name	النوع	الوصف	مطلوبة	افتراضي
المرساة	string	طابع زمني مرسا، وبعدها تنطبق سياسة انتهاء الصلاحية. المراسي المدعومة: `last_active_at`.	‏‏نعم‬
الأيام	integer	عدد الأيام التي سينتهي فيها المخزن المتجه بعد وقت التثبيت المحدد.	‏‏نعم‬

رقم المرساة: VectorStoreExpirationAfterAnchor

قيمة	الوصف
last_active_at	الطابع الزمني الأساسي الذي بعده تنطبق سياسة الانتهاء.

vectorStoreObject

المخزن المتجه هو مجموعة من الملفات المعالجة التي يمكن للأداة file_search استخدامها.

Name	النوع	الوصف	مطلوبة
created_at	integer	طابع يونكس الزمني (بالثواني) لوقت إنشاء مخزن المتجهات.	‏‏نعم‬
expires_after	vectorStoreExpirationAfter	سياسة انتهاء الصلاحية لمتجر متجهات.	لا
expires_at	integer	طابع الوقت ليونكس (بالثواني) لوقت انتهاء صلاحية مخزن المتجهات.	لا
file_counts	الهدف		‏‏نعم‬
└─ ملغى	integer	عدد الملفات التي تم إلغاؤها.	لا
└─ مكتمل	integer	عدد الملفات التي تمت معالجتها بنجاح.	لا
└─ فشل	integer	عدد الملفات التي فشلت في المعالجة.	لا
└─ in_progress	integer	عدد الملفات التي يتم معالجتها حاليا.	لا
└─ الإجمالي	integer	إجمالي عدد الملفات.	لا
معرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
last_active_at	integer	طابع الوقت في يونكس (بالثواني) لآخر مرة كان فيها مخزن المتجهات نشطا.	‏‏نعم‬
البيانات الوصفية	الهدف	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة. يمكن أن تكون المفاتيح بحد أقصى 64 حرفا وحتى 512 حرفا.	‏‏نعم‬
الاسم	string	اسم متجر المتجهات.	‏‏نعم‬
الهدف	enum	نوع الكائن، والذي يكون دائما `vector_store`. القيم المحتملة: `vector_store`	‏‏نعم‬
الحالة	string	حالة المخزن المتجه، الذي يمكن أن يكون إما `expired`، `in_progress`، أو `completed`. حالة تشير إلى `completed` أن مخزن المتجهات جاهز للاستخدام.	‏‏نعم‬
usage_bytes	integer	إجمالي عدد البايتات المستخدمة من قبل الملفات في مخزن المتجه.	‏‏نعم‬

قيمة الحالة: VectorStoreObjectStatus

قيمة	الوصف
انتهت
in_progress
اكتمل

createVectorStoreRequest

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

updateVectorStoreRequest

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

listVectorStoresResponse

Name	النوع	مطلوبة
البيانات	مصفوفة	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

حذفVectorStoreResponse

Name	النوع	مطلوبة
تم الحذف	boolean	‏‏نعم‬
معرف	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

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

قيمة	الوصف
تم حذف vector_store	حالة كائن الاستجابة لمخزن الحذف المتجه

vectorStoreFileObject

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

Name	النوع	الوصف	مطلوبة
chunking_strategy	autoChunkingStrategyRequestParam أو staticChunkingStrategyRequestParam	استراتيجية التقسيم المستخدمة لتقسيم الملفات (الملفات). إذا لم تكن محددة، سأستخدم `auto` الاستراتيجية. ينطبق فقط إذا `file_ids` كان غير فارغ.	لا
created_at	integer	طابع الوقت ليونكس (بالثواني) لوقت إنشاء ملف مخزن المتجه.	‏‏نعم‬
معرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
last_error	الهدف	آخر خطأ مرتبط بملف المخزن المتجه هذا. سيكون كذلك `null` إذا لم تكن هناك أخطاء.	‏‏نعم‬
└─ رمز	string	واحد من `server_error` أو `invalid_file` أو `unsupported_file`.	لا
└─ رسالة	string	وصف يمكن للبشر قراءته للخطأ.	لا
الهدف	string	نوع الكائن، والذي يكون دائما `vector_store.file`.	‏‏نعم‬
الحالة	string	حالة ملف مخزن المتجه، والتي يمكن أن تكون إما `in_progress`، `completed`، `cancelled`، أو `failed`. تشير الحالة `completed` إلى أن ملف مخزن المتجهات جاهز للاستخدام.	‏‏نعم‬
usage_bytes	integer	إجمالي استخدام مخزن المتجهات بالبايتات. لاحظ أن هذا قد يختلف عن حجم الملف الأصلي.	‏‏نعم‬
vector_store_id	string	معرف مخزن المتجهات الذي يرفق به الملف.	‏‏نعم‬

object enum: VectorStoreFileObjectType

قيمة	الوصف
vector_store.file

قيمة الحالة: VectorStoreFileObjectStatus

قيمة	الوصف
in_progress
اكتمل
تم إلغاء
فشل

OtherChunkingStrategyResponseParam

يتم إرجاع هذا عندما تكون استراتيجية التقطيع غير معروفة. عادة، يكون ذلك لأن الملف تم فهرسته قبل تقديم المفهوم chunking_strategy في واجهة برمجة التطبيقات (API).

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	string	دائما `other`.	‏‏نعم‬

نوع Enum: OtherChunkingStrategyResponseParamType

قيمة	الوصف
الاخري

staticChunkingStrategyResponseParam

Name	النوع	الوصف	مطلوبة	افتراضي
ثابت	staticChunkingStrategy		‏‏نعم‬
النوع	string	دائما `static`.	‏‏نعم‬

نوع Enum: StaticChunkingStrategyResponseParamType

قيمة	الوصف
ثابت

staticChunkingStrategy

Name	النوع	الوصف	مطلوبة	افتراضي
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

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	دائما `auto`. القيم المحتملة: `auto`	‏‏نعم‬

staticChunkingStrategyRequestParam

Name	النوع	الوصف	مطلوبة	افتراضي
ثابت	staticChunkingStrategy		‏‏نعم‬
النوع	enum	دائما `static`. القيم المحتملة: `static`	‏‏نعم‬

chunkingStrategyRequestParam

استراتيجية التقسيم المستخدمة لتقسيم الملفات (الملفات). إذا لم تكن محددة، سأستخدم auto الاستراتيجية.

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

AutoChunkingStrategyRequestParam
staticChunkingStrategyRequestParam

createVectorStoreFileRequest

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

listVectorStoreFilesResponse

Name	النوع	مطلوبة
البيانات	مصفوفة	‏‏نعم‬
first_id	string	‏‏نعم‬
has_more	boolean	‏‏نعم‬
last_id	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

deleteVectorStoreFileResponse

Name	النوع	مطلوبة
تم الحذف	boolean	‏‏نعم‬
معرف	string	‏‏نعم‬
الهدف	string	‏‏نعم‬

عنصر الموضوع: حذف المخزن الملفي الرباعي

قيمة	الوصف
vector_store.file.deleted

vectorStoreFileBatchObject

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

Name	النوع	الوصف	مطلوبة
created_at	integer	طابع الوقت في يونكس (بالثواني) ليتم إنشاء دفعة ملفات التخزين المتجه.	‏‏نعم‬
file_counts	الهدف		‏‏نعم‬
└─ ملغى	integer	عدد الملفات التي تم إلغاؤها.	لا
└─ مكتمل	integer	عدد الملفات التي تمت معالجتها.	لا
└─ فشل	integer	عدد الملفات التي فشلت في المعالجة.	لا
└─ in_progress	integer	عدد الملفات التي يتم معالجتها حاليا.	لا
└─ الإجمالي	integer	إجمالي عدد الملفات.	لا
معرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية API.	‏‏نعم‬
الهدف	string	نوع الكائن، والذي يكون دائما `vector_store.file_batch`.	‏‏نعم‬
الحالة	string	حالة دفعة ملفات التخزين المتجه، والتي يمكن أن تكون إما `in_progress`، `completed`، `cancelled` أو `failed`.	‏‏نعم‬
vector_store_id	string	معرف مخزن المتجهات الذي يرفق به الملف.	‏‏نعم‬

أوبجكت إينوم: فيكتورستورففيتباتشباتشأوبتيبايتايفي

قيمة	الوصف
vector_store.files_batch

قيمة الحالة: VectorStoreFileBatchObjectStatus

قيمة	الوصف
in_progress
اكتمل
تم إلغاء
فشل

إنشاءVectorStoreFileBatchRequest

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

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
حدث runStepStream
حدث تدفق الرسالة
حدث خطأ
حدث تم

threadStreamEvent

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

مؤشر الترابط.تم إنشاؤه

يحدث عندما يتم إنشاء خيط جديد.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	threadObject	يمثل خيطا يحتوي على رسائل.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: threadObject

تعداد الأحداث: ThreadStreamEventEnum

قيمة	الوصف
مؤشر الترابط.تم إنشاؤه	حدث إنشاء الخيط

runStreamEvent

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

thread.run.created

يحدث عندما يتم إنشاء جولة جديدة.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

عدد الحدث: RunStreamEventCreatedT

قيمة	الوصف
thread.run.created

thread.run.queued

يحدث عندما تنتقل الجولة إلى حالة معينة queued .

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

عدد الحدث: RunStreamEventQueued

قيمة	الوصف
thread.run.queued

thread.run.in_progress

يحدث عندما تنتقل الجولة إلى حالة معينة in_progress .

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

عدد الحدث: RunStreamEventInProgress

قيمة	الوصف
thread.run.in_progress

thread.run.requires_action

يحدث عندما تنتقل الجولة إلى حالة معينة requires_action .

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

عدد الحدث: RunStreamEventRequiresAction

قيمة	الوصف
thread.run.requires_action

thread.run.completed

يحدث عند اكتمال التشغيل.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

تاريخ الحدث: RunStreamEvent Completed

قيمة	الوصف
thread.run.completed

thread.run.failed

يحدث عندما يفشل التشغيل.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

عدد الحدث: RunStreamEventFail

قيمة	الوصف
thread.run.failed

thread.run.cancelling

يحدث عندما تنتقل الجولة إلى حالة معينة cancelling .

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

حدث الحدث: RunStreamEventCancelling

قيمة	الوصف
thread.run.cancelling

thread.run.cancelled

يحدث عندما يتم إلغاء جولة.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

تاريخ الحدث: RunStreamEventCancelled

قيمة	الوصف
thread.run.cancelled

thread.run.expired

يحدث عندما تنتهي صلاحية الجولة.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runObject	يمثل تنفيذ على خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runObject

عدد الحدث: RunStreamEventExpired

قيمة	الوصف
thread.run.expired

حدث runStepStream

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

thread.run.step.created

يحدث عند إنشاء خطوة الجري.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ الجري.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

قيمة الحدث: RunStepStreamEventCreated

قيمة	الوصف
thread.run.step.created

thread.run.step.in_progress

يحدث عندما تنتقل خطوة الجري إلى حالة معينة in_progress .

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ الجري.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

عدد الحدث: RunStepStreamEventInProgress

قيمة	الوصف
thread.run.step.in_progress

thread.run.step.delta

يحدث عندما يتم بث أجزاء من خطوة التشغيل.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runStepDeltaObject	يمثل دلتا خطوة التشغيل، أي أي حقول متغيرة على خطوة التشغيل أثناء البث.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepDeltaObject

تعداد الأحداث: RunStepStreamEventDelta

قيمة	الوصف
thread.run.step.delta

thread.run.step.completed

يحدث عند اكتمال خطوة الجري.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ الجري.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

عدد الحدث: RunStepStream Event

قيمة	الوصف
thread.run.step.completed

thread.run.step.failed

يحدث عندما تفشل خطوة التشغيل.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ الجري.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

رقم الحدث: RunStepStreamEventFail

قيمة	الوصف
thread.run.step.failed

thread.run.step.cancelled

يحدث عندما يتم إلغاء خطوة الجري.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ الجري.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

رقم الحدث: RunStepStepStreamEventCanceled

قيمة	الوصف
thread.run.step.cancelled

thread.run.step.expired

يحدث عندما تنتهي صلاحية خطوة التشغيل.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	runStepObject	يمثل خطوة في تنفيذ الجري.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: runStepObject

عدد الحدث: RunStepStreamEventExpired

قيمة	الوصف
thread.run.step.expired

حدث تدفق الرسالة

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

thread.message.created

يحدث عند إنشاء رسالة.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	messageObject	تمثل رسالة داخل خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageObject

رقم الحدث: MessageStreamEventCreatedT

قيمة	الوصف
thread.message.created

thread.message.in_progress

يحدث عندما تنتقل رسالة إلى حالة معينة in_progress .

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	messageObject	تمثل رسالة داخل خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageObject

رقم الحدث: MessageStreamEventInProgress

قيمة	الوصف
thread.message.in_progress

thread.message.delta

يحدث عندما يتم بث أجزاء من الرسالة.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	messageDeltaObject	يمثل دلتا الرسالة أي أي حقول تغيرت على رسالة أثناء البث.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageDeltaObject

قائمة تعداد الأحداث: MessageStreamEventDelta

قيمة	الوصف
thread.message.delta

thread.message.completed

يحدث عند إكمال رسالة.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	messageObject	تمثل رسالة داخل خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageObject

عدد الحدث: رسالةتدفق الحدث مكتمل

قيمة	الوصف
thread.message.completed

thread.message.incomplete

يحدث عندما تنتهي رسالة قبل أن تكمل.

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات	messageObject	تمثل رسالة داخل خيوط.	‏‏نعم‬
event	string		‏‏نعم‬

البيانات: messageObject

عدد الحدث: MessageStreamEventIncomplete

قيمة	الوصف
thread.message.incomplete

تعليق توضيحي

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

اقتباس الملف
اقتباس Url
مسار الملف

انقر فوق

إجراء نقرة.

Name	النوع	الوصف	مطلوبة
زر	enum	يشير إلى زر الفأرة الذي تم الضغط عليه أثناء النقرة. واحد من `left`، `right`، `wheel`، `back`، أو `forward`. القيم الممكنة: `left`, `right`, , `wheelback`,`forward`	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء النقر، يتم تعيين هذه الخاصية دائما على `click`. القيم المحتملة: `click`	‏‏نعم‬
x	integer	الإحداثي x حيث حدث النقرة.	‏‏نعم‬
y	integer	الإحداثي y حيث حدث النقرة.	‏‏نعم‬

CodeInterpreterFileOutput

مخرج استدعاء أداة مفسر الشيفرة هو ملف.

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

CodeInterpreterTextOutput

مخرجات أداة مفسر الشيفرة التي تكون نصية.

Name	النوع	الوصف	مطلوبة	افتراضي
السجلات	string	سجلات استدعاء أداة مفسر الكود.	‏‏نعم‬
النوع	enum	نوع مفسر الشيفرة، وإخراج النص. دائما `logs`. القيم المحتملة: `logs`	‏‏نعم‬

CodeInterpreterTool

أداة تدير الكود.

Name	النوع	الوصف	مطلوبة	افتراضي
file_ids	مصفوفة	معرفات الملفات التي يجب تشغيل الكود عليها.	‏‏نعم‬
النوع	enum	نوع أداة مفسر الكود. دائما `code_interpreter`. القيم المحتملة: `code_interpreter`	‏‏نعم‬

CodeInterpreterToolCall

استدعاء أداة لتشغيل الكود.

Name	النوع	الوصف	مطلوبة
الرمز	string	الكود الذي يجب تشغيله.	‏‏نعم‬
معرف	string	معرف أداة مفسر الشيفرة الفريدة.	‏‏نعم‬
النتائج	مصفوفة	نتائج استدعاء أداة مفسر الشيفرة.	‏‏نعم‬
الحالة	enum	حالة استدعاء أداة مفسر الكود. القيم الممكنة: `in_progress`, `interpreting`, `completed`	‏‏نعم‬
النوع	enum	نوع استدعاء أداة مفسر الشيفرة. دائما `code_interpreter_call`. القيم المحتملة: `code_interpreter_call`	‏‏نعم‬

CodeInterpreterToolOutput

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

CodeInterpreterTextOutput
CodeInterpreterFileOutput

تصفية المقارنة

مرشح يستخدم لمقارنة مفتاح سمة محدد مع قيمة معينة باستخدام عملية مقارنة محددة.

Name	النوع	الوصف	مطلوبة
المفتاح	string	المفتاح هو المقارنة مع القيمة.	‏‏نعم‬
النوع	enum	يحدد عامل المقارنة: `eq`، `ne`، `gt`، `gte`، `ltlte`، . - `eq`: يساوي - `ne`: غير متساوي - `gt`: أعظم من - `gte`: أكبر من أو متساوي - `lt`: أقل من - `lte`: أقل من أو متساوي القيم الممكنة: `eq`، `ne`، `gt`، `gte`، `ltlte`	‏‏نعم‬
قيمة	الوتر أو العدد أو البوليان	القيمة التي يجب مقارنتها مع مفتاح السمات؛ يدعم أنواع السلاسل أو الأرقام أو البوليان.	‏‏نعم‬

التصفية المركبة

ادمج عدة مرشحات باستخدام and أو or.

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

ComputerAction

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

انقر فوق
دبل ك ليك
اسحب
Keypress
نقل
لقطه
التمرير
نوع
انتظري

صورة الشاشة للكمبيوتر

صورة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.

Name	النوع	الوصف	مطلوبة
file_id	string	معرف الملف المرفوع الذي يحتوي على لقطة الشاشة.	لا
image_url	string	رابط صورة لقطة الشاشة.	لا
النوع	enum	يحدد نوع الحدث. بالنسبة لقطة شاشة للكمبيوتر، يتم تعيين هذه الخاصية دائما على `computer_screenshot`. القيم المحتملة: `computer_screenshot`	‏‏نعم‬

ComputerTool

أداة تتحكم في كمبيوتر افتراضي.

Name	النوع	الوصف	مطلوبة
display_height	number	ارتفاع شاشة الكمبيوتر.	‏‏نعم‬
display_width	number	عرض شاشة الكمبيوتر.	‏‏نعم‬
البيئة	enum	نوع بيئة الكمبيوتر التي يجب التحكم بها. القيم الممكنة: `mac`, `windows`, `ubuntu`, `browser`	‏‏نعم‬
النوع	enum	نوع أداة استخدام الكمبيوتر. دائما `computer_use_preview`. القيم المحتملة: `computer-use-preview`	‏‏نعم‬

ComputerToolCall

استدعاء أداة لأداة استخدام الكمبيوتر.

Name	النوع	الوصف	مطلوبة
الأكشن	ComputerAction		‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لنداء الأداة بالإخراج.	‏‏نعم‬
معرف	string	المعرف الفريد لمكالمة الكمبيوتر.	‏‏نعم‬
pending_safety_checks	مصفوفة	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`، `completed`، أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	‏‏نعم‬
النوع	enum	نوع مكالمة الكمبيوتر. دائما `computer_call`. القيم المحتملة: `computer_call`	‏‏نعم‬

ComputerToolCallOutput

مخرج استدعاء أداة الحاسوب.

Name	النوع	الوصف	مطلوبة
acknowledged_safety_checks	مصفوفة	الفحوصات الأمنية التي أبلغ عنها API والتي تم الاعتراف بها من قبل المطور.	لا
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج المخرج.	‏‏نعم‬
معرف	string	معرف مخرجات استدعاء أداة الكمبيوتر.	لا
الإنتاج	صورة الشاشة للكمبيوتر	صورة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من `in_progress`، `completed`، أو `incomplete`. يتم ملؤها عند إعادة عناصر الإدخال عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	لا
النوع	enum	نوع مخرجات استدعاء أداة الكمبيوتر. دائما `computer_call_output`. القيم المحتملة: `computer_call_output`	‏‏نعم‬

ComputerToolCallOutputResource

Name	النوع	الوصف	مطلوبة
acknowledged_safety_checks	مصفوفة	الفحوصات الأمنية التي أبلغ عنها API والتي تم الاعتراف بها من قبل المطور.	لا
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج المخرج.	‏‏نعم‬
معرف	string	معرف فريد لمخرجات أداة استدعاء الكمبيوتر.	‏‏نعم‬
الإنتاج	صورة الشاشة للكمبيوتر	صورة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من `in_progress`، `completed`، أو `incomplete`. يتم ملؤها عند إعادة عناصر الإدخال عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	لا
النوع	enum	نوع مخرجات استدعاء أداة الكمبيوتر. دائما `computer_call_output`. القيم المحتملة: `computer_call_output`	‏‏نعم‬

ComputerToolCallSafetyCheck

فحص أمان قيد الانتظار لمكالمة الكمبيوتر.

Name	النوع	الوصف	مطلوبة
الرمز	string	نوع فحص السلامة المعلق.	‏‏نعم‬
معرف	string	هوية فحص السلامة المعلق.	‏‏نعم‬
رسالة	string	تفاصيل حول فحص السلامة المعلق.	‏‏نعم‬

المحتوى

محتوى الإدخال والإخراج متعدد الوسائط.

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

InputContent
OutputContent

تنسيق

زوج إحداثيات x/y، مثل { x: 100, y: 200 }.

Name	النوع	الوصف	مطلوبة	افتراضي
x	integer	إحداثي x.	‏‏نعم‬
y	integer	إحداثيات y.	‏‏نعم‬

CreateModelResponseProperties

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات الوصفية	بيانات التعريف	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا.	لا
النموذج	string	النموذج المستخدم لتوليد الردود.	لا
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو `top_p` ليس كلاهما.	لا	1
top_p	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد OpenAI على مراقبة واكتشاف الإساءة. .	لا

createResponse

Name	النوع	الوصف	مطلوبة	افتراضي
تشمل	مصفوفة	{"$ref": "#/components/schemas/includable/description"}	لا
المدخلات	السلسلة أو المصفوفة	مدخلات نصية أو صورة أو ملفات إلى النموذج، تستخدم لتوليد استجابة.	‏‏نعم‬
التعليمات	string	يدرج رسالة نظام (أو مطور) كأول عنصر في سياق النموذج. عند استخدام مع `previous_response_id`، لن تنتقل التعليمات من استجابة سابقة إلى الاستجابة التالية. هذا يجعل من السهل تبديل رسائل النظام (أو المطور) في ردود جديدة.	لا
max_output_tokens	integer	حد أعلى لعدد الرموز التي يمكن إنشاؤها للاستجابة، بما في ذلك رموز الإخراج المرئية ورموز الاستدلال.	لا
parallel_tool_calls	boolean	ما إذا كان يجب السماح للنموذج بتشغيل استدعاءات الأدوات بشكل متوازي.	لا	صحيح
previous_response_id	string	معرف فريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	لا
المنطق	المنطق	خيارات التكوين لنماذج التفكير.	لا
المتجر	boolean	ما إذا كان يجب تخزين استجابة النموذج المولدة لاسترجاعه لاحقا عبر واجهة برمجة التطبيقات (API).	لا	صحيح
تدفق	boolean	إذا تم تعيينه على true، سيتم بث بيانات استجابة النموذج إلى العميل أثناء توليدها باستخدام أحداث يرسلها الخادم.	لا	خطأ
النص	الهدف	خيارات التكوين للاستجابة النصية من النموذج. يمكن أن تكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
صيغة └─	تكوين TextResponseFormat	كائن يحدد الصيغة التي يجب أن ينتجها النموذج. يتيح التكوين `{ "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`	لا

دبل ك ليك

إجراء نقرة مزدوجة.

Name	النوع	الوصف	مطلوبة
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء النقر المزدوج، يتم تعيين هذه الخاصية دائما على `double_click`. القيم المحتملة: `double_click`	‏‏نعم‬
x	integer	الإحداثي x حيث حدث النقر المزدوج.	‏‏نعم‬
y	integer	الإحداثي y حيث حدث النقر المزدوج.	‏‏نعم‬

اسحب

حركة دراج.

Name	النوع	الوصف	مطلوبة	افتراضي
مسار	مصفوفة	مصفوفة من الإحداثيات تمثل مسار إجراء السحب. ستظهر الإحداثيات كمصفوفة من الأجسام، مثل`[{ x: 100, y: 200 }, { x: 200, y: 300 }]`	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء السحب، يتم تعيين هذه الخاصية دائما إلى `drag`. القيم المحتملة: `drag`	‏‏نعم‬

EasyInputMessage

رسالة مدخلة للنموذج مع دور يشير إلى التعليمات التي تتبع التسلسل الهرمي. التعليمات المعطاة مع developer دور أو system لها الأولوية على التعليمات المعطاة مع الدور user . يفترض أن الرسائل التي تحمل هذا assistant الدور قد تم توليدها بواسطة النموذج في تفاعلات سابقة.

Name	النوع	الوصف	مطلوبة
محتوى	السلسلة أو قائمة الرسائل المعتمدة	يستخدم إدخال نص أو صورة أو صوت إلى النموذج، لتوليد استجابة. يمكن أن تحتوي أيضا على ردود المساعدين السابقة.	‏‏نعم‬
الدور	enum	دور إدخال الرسالة. واحد من `user`، `assistant`، `system`، أو `developer`. القيم الممكنة: `user`, `assistant`, `system`, `developer`	‏‏نعم‬
النوع	enum	نوع إدخال الرسالة. دائما `message`. القيم المحتملة: `message`	لا

اقتباس الملف

استشهاد إلى ملف.

Name	النوع	الوصف	مطلوبة
file_id	string	معرف الملف.	‏‏نعم‬
فهرس	integer	فهرس الملف في قائمة الملفات.	‏‏نعم‬
النوع	enum	نوع الاستشهاد بالملف. دائما `file_citation`. القيم المحتملة: `file_citation`	‏‏نعم‬

مسار الملف

مسار إلى ملف.

Name	النوع	الوصف	مطلوبة
file_id	string	معرف الملف.	‏‏نعم‬
فهرس	integer	فهرس الملف في قائمة الملفات.	‏‏نعم‬
النوع	enum	نوع مسار الملف. دائما `file_path`. القيم المحتملة: `file_path`	‏‏نعم‬

FileSearchRanker

التصنيف المستخدم في البحث عن الملفات. إذا لم يتم تحديده، سيستخدم التصنيف.auto

الملكية	قيمة
الوصف	التصنيف المستخدم في البحث عن الملفات. إذا لم يتم تحديده، سيستخدم التصنيف.`auto`
نوع	string
القيم	`auto` `default_2024_08_21`

FileSearchTool

أداة تبحث عن محتوى ذي صلة من الملفات المرفوعة.

Name	النوع	الوصف	مطلوبة	افتراضي
المرشحات	فلتر المقارنة أو فلتر المركب	فلتر يمكن تطبيقه بناء على خصائص الملف.	لا
max_num_results	integer	أقصى عدد من النتائج التي يجب إرجاعها. يجب أن يكون هذا الرقم بين 1 و50 شاملا.	لا
ranking_options	الهدف	خيارات الترتيب للبحث.	لا
└─ رتبة	enum	التصنيف المستخدم في البحث عن الملفات. القيم الممكنة: `auto`، `default-2024-11-15`	لا
└─ score_threshold	number	عتبة الدرجة في البحث عن الملف، رقم بين 0 و1. الأرقام الأقرب إلى 1 ستحاول إعادة النتائج الأكثر صلة فقط، لكنها قد تعطي نتائج أقل.	لا	1
النوع	enum	نوع أداة البحث عن الملفات. دائما `file_search`. القيم المحتملة: `file_search`	‏‏نعم‬
vector_store_ids	مصفوفة	تخزن معرفات المتجه للبحث.	‏‏نعم‬

FileSearchToolCall

نتائج استدعاء أداة بحث الملفات.

Name	النوع	الوصف	مطلوبة
معرف	string	معرف فريد لأداة البحث عن الملفات.	‏‏نعم‬
الاستعلامات	مصفوفة	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
النتائج	مصفوفة	نتائج استدعاء أداة البحث عن الملفات.	لا
الحالة	enum	حالة استدعاء أداة البحث عن الملفات. واحد من `in_progress`، `searching`، `incomplete` أو `failed`، القيم الممكنة: `in_progress`, `searching`, , `completedincomplete`,`failed`	‏‏نعم‬
النوع	enum	نوع استدعاء أداة البحث عن الملفات. دائما `file_search_call`. القيم المحتملة: `file_search_call`	‏‏نعم‬

FunctionTool

يحدد دالة في كودك الخاص يمكن للنموذج اختيار استدعاؤها.

Name	النوع	الوصف	مطلوبة
الوصف	string	وصف للوظيفة. يستخدمها النموذج لتحديد ما إذا كان يجب استدعاء الدالة أم لا.	لا
الاسم	string	اسم الدالة التي يجب استدعاؤها.	‏‏نعم‬
المعلمات	الهدف	كائن مخطط JSON يصف معلمات الدالة.	‏‏نعم‬
صارم	boolean	ما إذا كان يجب فرض التحقق الصارم من المعاملات. الافتراضي `true`.	‏‏نعم‬
النوع	enum	نوع أداة الوظيفة. دائما `function`. القيم المحتملة: `function`	‏‏نعم‬

FunctionToolCall

استدعاء أداة لتشغيل دالة.

Name	النوع	الوصف	مطلوبة
الحجج	string	سلسلة JSON من الوسائط التي يجب تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	معرف فريد لاستدعاء أداة الدالة الذي يولده النموذج.	‏‏نعم‬
معرف	string	معرف فريد لاستدعاء أداة الدالة.	‏‏نعم‬
الاسم	string	اسم الدالة التي يجب تشغيلها.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`، `completed`، أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	لا
النوع	enum	نوع استدعاء أداة الدالة. دائما `function_call`. القيم المحتملة: `function_call`	‏‏نعم‬

FunctionToolCallOutput

مخرجات استدعاء أداة دالة.

Name	النوع	الوصف	مطلوبة
call_id	string	معرف فريد لاستدعاء أداة الدالة الذي يولده النموذج.	‏‏نعم‬
معرف	string	معرف فريد لمخرجات استدعاء أداة الدالة. يتم تعبئته عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات (API).	لا
الإنتاج	string	سلسلة JSON من مخرج استدعاء أداة الدالة.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`، `completed`، أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	لا
النوع	enum	نوع مخرجات استدعاء أداة الدالة. دائما `function_call_output`. القيم المحتملة: `function_call_output`	‏‏نعم‬

FunctionToolCallOutputResource

Name	النوع	الوصف	مطلوبة
call_id	string	معرف فريد لاستدعاء أداة الدالة الذي يولده النموذج.	‏‏نعم‬
معرف	string	معرف فريد لمخرج أداة استدعاء الدالة.	‏‏نعم‬
الإنتاج	string	سلسلة JSON من مخرج استدعاء أداة الدالة.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`، `completed`، أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	لا
النوع	enum	نوع مخرجات استدعاء أداة الدالة. دائما `function_call_output`. القيم المحتملة: `function_call_output`	‏‏نعم‬

غير قابل للعزل

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

file_search_call.results: أضف نتائج البحث لنداء أداة البحث في الملف.
message.input_image.image_url: أضف عناوين URL للصور من رسالة الإدخال.
computer_call_output.output.image_url: تضمين روابط الصور من مخرج مكالمة الكمبيوتر.

الملكية	قيمة
الوصف	حدد بيانات إضافية لإخراج النموذج لتضمينها في استجابة النموذج. القيم المدعومة حاليا هي: - `file_search_call.results`: أضف نتائج البحث لنداء أداة البحث في الملف. - `message.input_image.image_url`: أضف عناوين URL للصور من رسالة الإدخال. - `computer_call_output.output.image_url`: تضمين روابط الصور من مخرج مكالمة الكمبيوتر.
نوع	string
القيم	`file_search_call.results` `message.input_image.image_url` `computer_call_output.output.image_url`

InputAudio

مدخل صوتي للنموذج.

Name	النوع	الوصف	مطلوبة
البيانات	string	بيانات صوتية مشفرة في Base64.	‏‏نعم‬
الشكل	enum	تنسيق بيانات الصوت. الصيغ المدعومة حاليا هي `mp3` و `wav`. القيم الممكنة: `mp3`، `wav`	‏‏نعم‬
النوع	enum	نوع عنصر الإدخال. دائما `input_audio`. القيم المحتملة: `input_audio`	‏‏نعم‬

InputContent

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

نص الإدخال
صورة الإدخال
InputFile

InputFile

ملف مدخل إلى النموذج.

Name	النوع	الوصف	مطلوبة
file_data	string	محتوى الملف الذي سيتم إرساله إلى النموذج.	لا
file_id	string	معرف الملف الذي سيتم إرساله إلى النموذج.	لا
اسم الملف	string	اسم الملف الذي سيتم إرساله إلى النموذج.	لا
النوع	enum	نوع عنصر الإدخال. دائما `input_file`. القيم المحتملة: `input_file`	‏‏نعم‬

صورة الإدخال

إدخال صورة إلى النموذج.

Name	النوع	الوصف	مطلوبة
التفاصيل	enum	مستوى التفاصيل للصورة التي سيتم إرسالها إلى النموذج. واحد من `high`، `low`، أو `auto`. تتغير افتراضيا إلى `auto`. القيم الممكنة: `high`, `low`, `auto`	‏‏نعم‬
file_id	string	معرف الملف الذي سيتم إرساله إلى النموذج.	لا
image_url	string	رابط الصورة التي سيتم إرسالها إلى النموذج. رابط URL مؤهل بالكامل أو صورة مشفرة ب base64 في عنوان URL.	لا
النوع	enum	نوع عنصر الإدخال. دائما `input_image`. القيم المحتملة: `input_image`	‏‏نعم‬

InputItem

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

EasyInputMessage
البند
مرجع العنصر

رسالة إدخال

رسالة مدخلة للنموذج مع دور يشير إلى التعليمات التي تتبع التسلسل الهرمي. التعليمات المعطاة مع developer دور أو system لها الأولوية على التعليمات المعطاة مع الدور user .

Name	النوع	الوصف	مطلوبة
محتوى	InputMessageContentList	قائمة بعنصر إدخال واحد أو عدة عناصر للنموذج، تحتوي على محتوى مختلف أنواع.	‏‏نعم‬
الدور	enum	دور إدخال الرسالة. واحد من `user`، `system`، أو `developer`. القيم الممكنة: `user`, `system`, `developer`	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`، `completed`، أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	لا
النوع	enum	نوع إدخال الرسالة. دائما تضبط على `message`. القيم المحتملة: `message`	لا

InputMessageContentList

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

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

مصدر رسالة الإدخال

Name	النوع	الوصف	مطلوبة
محتوى	InputMessageContentList	قائمة بعنصر إدخال واحد أو عدة عناصر للنموذج، تحتوي على محتوى مختلف أنواع.	‏‏نعم‬
معرف	string	معرف فريد للرسالة المدخلة.	‏‏نعم‬
الدور	enum	دور إدخال الرسالة. واحد من `user`، `system`، أو `developer`. القيم الممكنة: `user`, `system`, `developer`	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`، `completed`، أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	لا
النوع	enum	نوع إدخال الرسالة. دائما تضبط على `message`. القيم المحتملة: `message`	لا

نص الإدخال

إدخال نصي إلى النموذج.

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

Item

عنصر المحتوى المستخدم لتوليد الرد.

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

رسالة إدخال
OutputMessage
FileSearchToolCall
ComputerToolCall
ComputerToolCallOutput
FunctionToolCall
FunctionToolCallOutput
ReasoningItem

مرجع العنصر

معرف داخلي لعنصر يمكن الرجوع إليه.

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

مصدر العنصر

عنصر المحتوى المستخدم لتوليد الرد.

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

مصدر رسالة الإدخال
OutputMessage
FileSearchToolCall
ComputerToolCall
ComputerToolCallOutputResource
FunctionToolCall
FunctionToolCallOutputResource

Keypress

مجموعة من ضغطات المفاتيح التي يرغب النموذج في تنفيذها.

Name	النوع	الوصف	مطلوبة	افتراضي
المفاتيح	مصفوفة	تركيبة المفاتيح التي يطلب النموذج الضغط عليها. هذه مصفوفة من السلاسل النصية، كل منها يمثل مفتاحا.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. لإجراء الضغط على لوحة المفاتيح، يتم تعيين هذه الخاصية دائما على `keypress`. القيم المحتملة: `keypress`	‏‏نعم‬

بيانات التعريف

المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا.

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

خصائص المسؤولية النموذجية

Name	النوع	الوصف	مطلوبة	افتراضي
البيانات الوصفية	بيانات التعريف	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا.	لا
النموذج	string	النموذج المستخدم لتوليد الردود.	لا
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو `top_p` ليس كلاهما.	لا	1
top_p	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	لا	1
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد OpenAI على مراقبة واكتشاف الإساءة. .	لا

نقل

حركة فأرة.

Name	النوع	الوصف	مطلوبة
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء النقل، يتم تعيين هذه الخاصية دائما إلى `move`. القيم المحتملة: `move`	‏‏نعم‬
x	integer	الإحداثي x للانتقال إليه.	‏‏نعم‬
y	integer	الإحداثي y للانتقال إليه.	‏‏نعم‬

OutputAudio

مخرج صوتي من النموذج.

Name	النوع	الوصف	مطلوبة
البيانات	string	بيانات صوتية مشفرة بواسطة Base64 من النموذج.	‏‏نعم‬
النص الكامل	string	نص بيانات الصوت من النموذج.	‏‏نعم‬
النوع	enum	نوع الصوت المخرج. دائما `output_audio`. القيم المحتملة: `output_audio`	‏‏نعم‬

OutputContent

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

نص الإخراج
رفض

عنصر الإخراج

Name	النوع	الوصف	مطلوبة
الأكشن	ComputerAction		‏‏نعم‬
الحجج	string	سلسلة JSON من الوسائط التي يجب تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لنداء الأداة بالإخراج.	‏‏نعم‬
محتوى	مصفوفة	محتوى نص المنطق.	‏‏نعم‬
معرف	string	المعرف الفريد لمحتوى المنطق.	‏‏نعم‬
الاسم	string	اسم الدالة التي يجب تشغيلها.	‏‏نعم‬
pending_safety_checks	مصفوفة	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
الاستعلامات	مصفوفة	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
النتائج	مصفوفة	نتائج استدعاء أداة البحث عن الملفات.	لا
الدور	enum	دور رسالة الناتج. دائما `assistant`. القيم المحتملة: `assistant`	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`، `completed`، أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	‏‏نعم‬
النوع	enum	نوع الجسم. دائما `reasoning`. القيم المحتملة: `reasoning`	‏‏نعم‬

OutputMessage

رسالة إخراج من النموذج.

Name	النوع	الوصف	مطلوبة
محتوى	مصفوفة	محتوى رسالة الإخراج.	‏‏نعم‬
معرف	string	معرف الرسالة الفريدة.	‏‏نعم‬
الدور	enum	دور رسالة الناتج. دائما `assistant`. القيم المحتملة: `assistant`	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من `in_progress`، `completed`، أو `incomplete`. يتم ملؤها عند إعادة عناصر الإدخال عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	‏‏نعم‬
النوع	enum	نوع رسالة الإخراج. دائما `message`. القيم المحتملة: `message`	‏‏نعم‬

نص الإخراج

مخرج نصي من النموذج.

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

RealtimeSessionCreateRequest

تكوين كائن الجلسة في الوقت الحقيقي.

Name	النوع	الوصف	مطلوبة	افتراضي
input_audio_format	enum	صيغة الصوت المدخل. الخيارات هي `pcm16`، `g711_ulaw`، أو `g711_alaw`. بالنسبة ل `pcm16`، يجب أن يكون الصوت المدخل PCM 16-بت بمعدل عينة 24 كيلوهرتز، وقناة واحدة (أحادية)، وترتيب بايت صغير النهاية (ENDIAN). القيم الممكنة: `pcm16`, `g711_ulaw`, `g711_alaw`	لا
input_audio_noise_reduction	الهدف	تكوين تقليل الضوضاء الصوتية المدخلة. يمكن ضبط ذلك على `null` الإيقاف. يقوم مصطلح تقليل الضوضاء بإضافة الصوت إلى مخزن الصوت الداخلي قبل إرساله إلى VAD والنموذج. يمكن أن يؤدي تصفية الصوت إلى تحسين دقة VAD واكتشاف الدوران (تقليل الإيجابيات الكاذبة) وأداء النمذجة من خلال تحسين إدراك الصوت المدخل.	لا
└─ النوع	enum	نوع تقليل الضوضاء. `near_field` هو للميكروفونات التي تتحدث عن قرب مثل سماعات الرأس، وهو `far_field` مخصص للميكروفونات البعيدة مثل اللابتوب أو ميكروفونات غرف الاجتماعات. القيم الممكنة: `near_field`، `far_field`	لا
input_audio_transcription	الهدف	إعداد نسخ الصوت الداخلي يكون افتراضيا مغلقا ويمكن ضبطه `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_ulaw`, `g711_alaw`	لا
درجة الحرارة	number	درجة حرارة أخذ العينة للنموذج، محدودة ب [0.6، 1.2]. بالنسبة لنماذج الصوت، يوصى بشدة بدرجة حرارة 0.8 لأفضل أداء.	لا	0.8
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي `auto`، `none`، `required`، أو تحديد دالة.	لا	أوتو
الأدوات	مصفوفة	الأدوات (الدوال) المتاحة للنموذج.	لا
turn_detection	الهدف	تكوين لاكتشاف الأدوار، أو VAD خادم الإيثر أو VAD الدلالي. يمكن ضبط ذلك لإيقاف `null` التشغيل، وفي هذه الحالة يجب على العميل تفعيل استجابة النموذج يدويا. تعني VAD في الخادم أن النموذج سيكتشف بداية ونهاية الكلام بناء على حجم الصوت ويستجيب في نهاية كلام المستخدم. VAD الدلالي أكثر تقدما ويستخدم نموذج كشف الأدوار (بالتزامن مع VAD) لتقدير دلالي ما إذا كان المستخدم قد أنهى الكلام، ثم يحدد مهلة زمنية ديناميكية بناء على هذا الاحتمال. على سبيل المثال، إذا تراجع صوت المستخدم مع `uhhm`، فإن النموذج سيحصل على احتمال منخفض لنهاية الدوران وينتظر لفترة أطول حتى يستمر المستخدم في الكلام. قد يكون هذا مفيدا للمحادثات الطبيعية، لكنه قد يكون له زمن تأخير أعلى.	لا
└─ create_response	boolean	سواء كان يجب توليد استجابة تلقائيا عند حدوث حدث توقف VAD أم لا.	لا	صحيح
└─ الحرص	enum	يستخدم فقط للوضع `semantic_vad` . حماس النموذج للرد. `low` سينتظر وقتا أطول حتى يستمر المستخدم في الحديث، `high` وسيستجيب بسرعة أكبر. `auto` هو الافتراضي و يعادل `medium`. القيم الممكنة: `low`, `medium`, `high`, `auto`	لا
└─ interrupt_response	boolean	ما إذا كان يجب مقاطعة أي استجابة جارية تلقائيا مع إخراج المحادثة الافتراضية (أي `conversation` ل `auto`) عند حدوث حدث بدء VAD.	لا	صحيح
└─ prefix_padding_ms	integer	يستخدم فقط للوضع `server_vad` . كمية الصوت التي يجب تضمينها قبل أن يكتشف VAD الكلام (بالأجزاء من الثانية). الوضع الافتراضي على 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	يستخدم فقط للوضع `server_vad` . مدة الصمت لاكتشاف توقف الكلام (بالمللي ثانية). الوضع الافتراضي هو 500 مللي ثانية. مع القيم الأقصر سيستجيب النموذج بسرعة أكبر، لكنه قد يتدخل في فترات توقف قصيرة من المستخدم.	لا
└─ عتبة	number	يستخدم فقط للوضع `server_vad` . عتبة التفعيل ل VAD (من 0.0 إلى 1.0)، وتكون هذه البطاقة افتراضية 0.5. العتبة الأعلى ستتطلب صوتا أعلى لتفعيل النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات المزدحمة.	لا
└─ النوع	enum	نوع اكتشاف المنعطفات. القيم الممكنة: `server_vad`، `semantic_vad`	لا
الصوت	VoiceIdsShared		لا

RealtimeSessionCreateResponse

تكوين جلسة في الوقت الحقيقي جديد، مع مفتاح مؤقت. العائد الافتراضي للمفاتيح هو دقيقة واحدة.

Name	النوع	الوصف	مطلوبة
client_secret	الهدف	المفتاح المؤقتة الذي يعاد بواسطة واجهة برمجة التطبيقات.	‏‏نعم‬
└─ expires_at	integer	الطابع الزمني لانتهاء صلاحية الرمز. حاليا، جميع الرموز تنتهي صلاحيتها بعد دقيقة واحدة.	لا
└─ القيمة	string	مفتاح مؤقت قابل للاستخدام في بيئات العملاء للمصادقة على الاتصالات مع واجهة برمجة التطبيقات في الوقت الحقيقي. استخدم هذا في بيئات جانب العميل بدلا من رمز API القياسي، والذي يجب استخدامه فقط على جانب الخادم.	لا
input_audio_format	string	صيغة الصوت المدخل. الخيارات هي `pcm16`، `g711_ulaw`، أو `g711_alaw`.	لا
input_audio_transcription	الهدف	إعداد نسخ الصوت الداخلي يكون افتراضيا مغلقا ويمكن ضبطه `null` ليكون مطفئا بمجرد التشغيل. نسخ الصوت المدخل ليس أصليا للنموذج، لأن النموذج يستهلك الصوت مباشرة. يعمل النسخ بشكل غير متزامن عبر Whisper ويجب اعتباره إرشادا تقريبيا بدلا من التمثيل الذي يفهمه النموذج.	لا
└─ نموذج	string	النموذج المستخدم في النسخ `whisper-1` هو النموذج الوحيد المدعوم حاليا.	لا
التعليمات	string	كانت تعليمات النظام الافتراضية (أي رسالة النظام) تسبق استدعاءات النماذج. يتيح هذا المجال للعميل توجيه النموذج نحو الاستجابات المرغوبة. يمكن توجيه النموذج حول محتوى الاستجابة وصيغتها (مثل "كن موجزة للغاية"، "تصرف وديا"، "إليك أمثلة على الردود الجيدة") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر في صوتك"، "الضحك كثيرا"). التعليمات ليست مضمونة أن يتبعها النموذج، لكنها تقدم إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يضبط تعليمات افتراضية ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في `session.created` الحدث عند بداية الجلسة.	لا
max_response_output_tokens	العدد الصحيح أو السلسلة	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحد، بما في ذلك استدعاءات الأدوات. توفير عدد صحيح بين 1 و4096 لتحديد رموز الإخراج، أو `inf` لأقصى رموز متاحة لنموذج معين. تتغير افتراضيا إلى `inf`.	لا
الأساليب		مجموعة الأنماط التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا على ["نص"].	لا
output_audio_format	string	صيغة الصوت المخرج. الخيارات هي `pcm16`، `g711_ulaw`، أو `g711_alaw`.	لا
درجة الحرارة	number	درجة حرارة أخذ العينة للنموذج، محدودة ب [0.6، 1.2]. الوضع الافتراضي هو 0.8.	لا
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي `auto`، `none`، `required`، أو تحديد دالة.	لا
الأدوات	مصفوفة	الأدوات (الدوال) المتاحة للنموذج.	لا
turn_detection	الهدف	إعداد اكتشاف المنعطفات. يمكن ضبطه على `null` الإيقاف. تعني VAD في الخادم أن النموذج سيكتشف بداية ونهاية الكلام بناء على حجم الصوت ويستجيب في نهاية كلام المستخدم.	لا
└─ prefix_padding_ms	integer	كمية الصوت التي يجب تضمينها قبل أن يكتشف VAD الكلام (بالأجزاء من الثانية). الوضع الافتراضي على 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	مدة الصمت لاكتشاف توقف الكلام (بالمللي ثانية). الوضع الافتراضي هو 500 مللي ثانية. مع القيم الأقصر سيستجيب النموذج بسرعة أكبر، لكنه قد يتدخل في فترات توقف قصيرة من المستخدم.	لا
└─ عتبة	number	عتبة التفعيل ل VAD (من 0.0 إلى 1.0)، وتكون هذه البطاقة افتراضية 0.5. العتبة الأعلى ستتطلب صوتا أعلى لتفعيل النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات المزدحمة.	لا
└─ النوع	string	نوع اكتشاف المنعطفات مدعوم حاليا فقط `server_vad` .	لا
الصوت	VoiceIdsShared		لا

RealtimeTranscriptionSessionCreateRequest

تكوين كائن جلسة النسخ في الوقت الحقيقي.

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

RealtimeTranscriptionSessionCreateResponse

تكوين جلسة نسخ في الوقت الحقيقي جديد.

عند إنشاء جلسة على الخادم عبر واجهة برمجة تطبيقات REST، يحتوي كائن الجلسة أيضا على مفتاح مؤقت. العائد الافتراضي للمفاتيح هو دقيقة واحدة. هذه الخاصية غير موجودة عند تحديث الجلسة عبر واجهة برمجة تطبيقات WebSocket.

Name	النوع	الوصف	مطلوبة
client_secret	الهدف	المفتاح المؤقتة الذي يعاد بواسطة واجهة برمجة التطبيقات. تظهر فقط عند إنشاء الجلسة على الخادم عبر واجهة برمجة تطبيقات REST.	‏‏نعم‬
└─ expires_at	integer	الطابع الزمني لانتهاء صلاحية الرمز. حاليا، جميع الرموز تنتهي صلاحيتها بعد دقيقة واحدة.	لا
└─ القيمة	string	مفتاح مؤقت قابل للاستخدام في بيئات العملاء للمصادقة على الاتصالات مع واجهة برمجة التطبيقات في الوقت الحقيقي. استخدم هذا في بيئات جانب العميل بدلا من رمز API القياسي، والذي يجب استخدامه فقط على جانب الخادم.	لا
input_audio_format	string	صيغة الصوت المدخل. الخيارات هي `pcm16`، `g711_ulaw`، أو `g711_alaw`.	لا
input_audio_transcription	الهدف	تكوين نموذج النسخ.	لا
└─ اللغة	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-15`, `whisper-1`	لا
└─ الموضوع	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار مقطع صوتي سابق. يجب أن يتطابق الموضوع مع لغة الصوت.	لا
الأساليب		مجموعة الأنماط التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا على ["نص"].	لا
turn_detection	الهدف	إعداد اكتشاف المنعطفات. يمكن ضبطه على `null` الإيقاف. تعني VAD في الخادم أن النموذج سيكتشف بداية ونهاية الكلام بناء على حجم الصوت ويستجيب في نهاية كلام المستخدم.	لا
└─ prefix_padding_ms	integer	كمية الصوت التي يجب تضمينها قبل أن يكتشف VAD الكلام (بالأجزاء من الثانية). الوضع الافتراضي على 300 مللي ثانية.	لا
└─ silence_duration_ms	integer	مدة الصمت لاكتشاف توقف الكلام (بالمللي ثانية). الوضع الافتراضي هو 500 مللي ثانية. مع القيم الأقصر سيستجيب النموذج بسرعة أكبر، لكنه قد يتدخل في فترات توقف قصيرة من المستخدم.	لا
└─ عتبة	number	عتبة التفعيل ل VAD (من 0.0 إلى 1.0)، وتكون هذه البطاقة افتراضية 0.5. العتبة الأعلى ستتطلب صوتا أعلى لتفعيل النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات المزدحمة.	لا
└─ النوع	string	نوع اكتشاف المنعطفات مدعوم حاليا فقط `server_vad` .	لا

الأسباب

خيارات التكوين لنماذج التفكير.

Name	النوع	الوصف	مطلوبة	افتراضي
الجهد	ReasoningEffort	يقيد الجهد في التفكير في نماذج الاستدلال. القيم المدعومة حاليا هي `low`، `medium`، و `high`. تقليل جهد التفكير يمكن أن يؤدي إلى استجابة أسرع واستخدام رموز أقل في الاستدلال.	‏‏نعم‬	متوسطة
ملخص	enum	ملخص للمنطق الذي قام به النموذج. يمكن أن يكون هذا مفيدا لتصحيح الأخطاء وفهم عملية التفكير في النموذج. واحد من `concise` أو `detailed`. القيم الممكنة: `concise`، `detailed`	لا

ReasoningItem

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

Name	النوع	الوصف	مطلوبة
محتوى	مصفوفة	محتوى نص المنطق.	‏‏نعم‬
معرف	string	المعرف الفريد لمحتوى المنطق.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من `in_progress`، `completed`، أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات (API). القيم الممكنة: `in_progress`, `completed`, `incomplete`	لا
النوع	enum	نوع الجسم. دائما `reasoning`. القيم المحتملة: `reasoning`	‏‏نعم‬

رفض

رفض من النموذج.

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

الرد

Name	النوع	الوصف	مطلوبة	افتراضي
created_at	number	طابع زمني يونكس (بثوان) لوقت إنشاء هذا الرد.	‏‏نعم‬
خطأ	ResponseError	يرجع كائن خطأ عندما يفشل النموذج في توليد استجابة.	‏‏نعم‬
معرف	string	معرف فريد لهذا الرد.	‏‏نعم‬
incomplete_details	الهدف	تفاصيل عن سبب عدم اكتمال الرد.	‏‏نعم‬
└─ السبب	enum	السبب في أن الرد غير مكتمل. القيم الممكنة: `max_output_tokens`، `content_filter`	لا
التعليمات	string	يدرج رسالة نظام (أو مطور) كأول عنصر في سياق النموذج. عند استخدام مع `previous_response_id`، لن تنتقل التعليمات من استجابة سابقة إلى الاستجابة التالية. هذا يجعل من السهل تبديل رسائل النظام (أو المطور) في ردود جديدة.	‏‏نعم‬
max_output_tokens	integer	حد أعلى لعدد الرموز التي يمكن إنشاؤها للرد، بما في ذلك رموز الإخراج المرئية وحالة المحادثة.	لا
البيانات الوصفية	بيانات التعريف	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا.	‏‏نعم‬
النموذج	string	النموذج المستخدم لتوليد الردود.	‏‏نعم‬
الهدف	enum	نوع كائن هذا المورد - دائما يضبط على `response`. القيم المحتملة: `response`	‏‏نعم‬
الإنتاج	مصفوفة	مجموعة من عناصر المحتوى التي يولدها النموذج. - طول وترتيب العناصر في المصفوفة `output` يعتمدان على استجابة النموذج. - بدلا من الوصول إلى أول عنصر في المصفوفة `output` وافتراض أنه `assistant` رسالة تحتوي على المحتوى الذي يولده النموذج، قد تفكر في استخدام `output_text` الخاصية حيث يتم دعمها في SDKs.	‏‏نعم‬
output_text	string	خاصية الراحة الخاصة ب SDK فقط التي تحتوي على النص المجمع الناتج من جميع `output_text` العناصر في المصفوفة `output` ، إذا كان موجودا. مدعوم في مجموعات تطوير البرمجيات للغات Python وJavaScript.	لا
parallel_tool_calls	boolean	ما إذا كان يجب السماح للنموذج بتشغيل استدعاءات الأدوات بشكل متوازي.	‏‏نعم‬	صحيح
previous_response_id	string	معرف فريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	لا
المنطق	المنطق	خيارات التكوين لنماذج التفكير.	لا
الحالة	enum	حالة جيل الاستجابة. واحد من `completed`، `failed`، `in_progress`، أو `incomplete`. القيم الممكنة: `completed`, `failed`, `in_progress`, `incomplete`	لا
درجة الحرارة	number	ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو `top_p` ليس كلاهما.	‏‏نعم‬	1
النص	الهدف	خيارات التكوين للاستجابة النصية من النموذج. يمكن أن تكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
صيغة └─	تكوين TextResponseFormat	كائن يحدد الصيغة التي يجب أن ينتجها النموذج. يتيح التكوين `{ "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	number	بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز التي تشكل أعلى 10% كتلة الاحتمالية تؤخذ بعين الاعتبار. نوصي عموما بتعديل هذا أو `temperature` ليس كلاهما.	‏‏نعم‬	1
الاقتطاع	enum	استراتيجية الاقتطاع المستخدمة في استجابة النموذج. - `auto`: إذا تجاوز سياق هذا الرد والسابقين حجم نافذة السياق الخاصة بالنموذج، يقوم النموذج باختصار الاستجابة لتناسب نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (الافتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، سيفشل الطلب مع خطأ 400. القيم الممكنة: `auto`، `disabled`	لا
الاستخدام	استخدام الاستجابة	يمثل تفاصيل استخدام الرموز بما في ذلك رموز الإدخال، رموز الإخراج، تفصيل رموز الإخراج، وإجمالي الرموز المستخدمة.	لا
المستخدم	string	معرف فريد يمثل المستخدم النهائي، يمكن أن يساعد OpenAI على مراقبة واكتشاف الإساءة. .	لا

ResponseAudioDeltaEvent

يصدر عندما يكون هناك استجابة صوتية جزئية.

Name	النوع	الوصف	مطلوبة	افتراضي
دلتا	string	جزء من بايتات الصوت المشفرة للاستجابة في Base64.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.audio.delta`. القيم المحتملة: `response.audio.delta`	‏‏نعم‬

ResponseAudioDoneEvent

يصدر عندما يكتمل استجابة الصوت.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع الحدث. دائما `response.audio.done`. القيم المحتملة: `response.audio.done`	‏‏نعم‬

ResponseAudioTranscriptDeltaEvent

يصدر عندما يكون هناك نص جزئي من الصوت.

Name	النوع	الوصف	مطلوبة	افتراضي
دلتا	string	نص جزئي للاستجابة الصوتية.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.audio.transcript.delta`. القيم المحتملة: `response.audio.transcript.delta`	‏‏نعم‬

ResponseAudioTranscriptDoneEvent

يصدر عند اكتمال النص الصوتي الكامل.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع الحدث. دائما `response.audio.transcript.done`. القيم المحتملة: `response.audio.transcript.done`	‏‏نعم‬

ResponseCodeInterpreterCallCodeDeltaEvent

يتم إصدار ذلك عندما يضيف مفسر الشيفرة مقتطفا جزئيا للكود.

Name	النوع	الوصف	مطلوبة
دلتا	string	المقتطف الجزئي للكود الذي أضيفه مفسر الشيفرة.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مفسر الشيفرة قيد التنفيذ.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.code_interpreter_call.code.delta`. القيم المحتملة: `response.code_interpreter_call.code.delta`	‏‏نعم‬

ResponseCodeInterpreterCallCodeDoneEvent

يتم الانبعاث عند الانتهاء من مخرج مقتطف الكود بواسطة مفسر الكود.

Name	النوع	الوصف	مطلوبة
الرمز	string	مخرج آخر مقتطف من الكود بواسطة مفسر الكود.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مفسر الشيفرة قيد التنفيذ.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.code_interpreter_call.code.done`. القيم المحتملة: `response.code_interpreter_call.code.done`	‏‏نعم‬

ResponseCodeInterpreterCallCompletedEvent

يتم إبداعه عند اكتمال استدعاء مفسر الشيفرة.

Name	النوع	الوصف	مطلوبة
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل الكود.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مفسر الشيفرة قيد التنفيذ.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.code_interpreter_call.completed`. القيم المحتملة: `response.code_interpreter_call.completed`	‏‏نعم‬

ResponseCodeInterpreterCallInProgressEvent

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

Name	النوع	الوصف	مطلوبة
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل الكود.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مفسر الشيفرة قيد التنفيذ.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.code_interpreter_call.in_progress`. القيم المحتملة: `response.code_interpreter_call.in_progress`	‏‏نعم‬

ResponseCodeInterpreterCallInterpretingEvent

ينبعث عندما يكون مفسر الشيفرة يفسر مقطع الشيفرة بنشاط.

Name	النوع	الوصف	مطلوبة
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل الكود.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مفسر الشيفرة قيد التنفيذ.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.code_interpreter_call.interpreting`. القيم المحتملة: `response.code_interpreter_call.interpreting`	‏‏نعم‬

حدث استجابة الإكمال

يصدر عندما يكتمل استجابة النموذج.

Name	النوع	الوصف	مطلوبة	افتراضي
الرد	استجابه		‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.completed`. القيم المحتملة: `response.completed`	‏‏نعم‬

حدث مضاف ل ResponseContentPart

يتم إبداعها عند إضافة جزء محتوى جديد.

Name	النوع	الوصف	مطلوبة
content_index	integer	فهرس جزء المحتوى الذي أضيف.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي أضيف إليه جزء المحتوى.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي أضيف إليه جزء المحتوى.	‏‏نعم‬
الجزء	OutputContent		‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.content_part.added`. القيم المحتملة: `response.content_part.added`	‏‏نعم‬

ResponseContentPartDoneEvent

يصدر عند الانتهاء من جزء المحتوى.

Name	النوع	الوصف	مطلوبة
content_index	integer	فهرس جزء المحتوى الذي تم إنجازه.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي أضيف إليه جزء المحتوى.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي أضيف إليه جزء المحتوى.	‏‏نعم‬
الجزء	OutputContent		‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.content_part.done`. القيم المحتملة: `response.content_part.done`	‏‏نعم‬

ResponseCreatedEvent

حدث يصدر عند إنشاء استجابة.

Name	النوع	الوصف	مطلوبة	افتراضي
الرد	استجابه		‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.created`. القيم المحتملة: `response.created`	‏‏نعم‬

ResponseError

يرجع كائن خطأ عندما يفشل النموذج في توليد استجابة.

Name	النوع	الوصف	مطلوبة	افتراضي
الرمز	رمز الاستجابة	رمز الخطأ للرد.	‏‏نعم‬
رسالة	string	وصف يمكن للبشر قراءته للخطأ.	‏‏نعم‬

رمز الاستجابة

رمز الخطأ للرد.

الملكية	قيمة
الوصف	رمز الخطأ للرد.
نوع	string
القيم	`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`

حدث الاستجابة

يصدر عند حدوث خطأ.

Name	النوع	الوصف	مطلوبة
الرمز	string	رمز الخطأ.	‏‏نعم‬
رسالة	string	رسالة الخطأ.	‏‏نعم‬
برام	string	معامل الخطأ.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `error`. القيم المحتملة: `error`	‏‏نعم‬

حدث ResponseFailedEvent

حدث يصدر عند فشل الاستجابة.

Name	النوع	الوصف	مطلوبة	افتراضي
الرد	استجابه		‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.failed`. القيم المحتملة: `response.failed`	‏‏نعم‬

ResponseFileSearchCallCompletedEvent

يتم إبداعها عند اكتمال استدعاء بحث الملف (تم العثور على النتائج).

Name	النوع	الوصف	مطلوبة
item_id	string	معرف عنصر الإخراج الذي يتم استدعائه في البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس العنصر الناتج الذي يبدأ استدعاء بحث الملف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.file_search_call.completed`. القيم المحتملة: `response.file_search_call.completed`	‏‏نعم‬

ResponseFileSearchCallInProgressEvent

يتم إصدار ذلك عند بدء استدعاء بحث الملفات.

Name	النوع	الوصف	مطلوبة
item_id	string	معرف عنصر الإخراج الذي يتم استدعائه في البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس العنصر الناتج الذي يبدأ استدعاء بحث الملف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.file_search_call.in_progress`. القيم المحتملة: `response.file_search_call.in_progress`	‏‏نعم‬

ResponseFileSearchCallSearchingEvent

يتم إصدار الإشارة عندما يكون البحث في ملف يبحث حاليا.

Name	النوع	الوصف	مطلوبة
item_id	string	معرف عنصر الإخراج الذي يتم استدعائه في البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس العنصر الناتج الذي يستدعى بحث الملف عنه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.file_search_call.searching`. القيم المحتملة: `response.file_search_call.searching`	‏‏نعم‬

ResponseFunctionCallArgumentsDeltaEvent

يصدر عندما يكون هناك دلتا جزئي لاستدعاء الدالة.

Name	النوع	الوصف	مطلوبة
دلتا	string	حجج استدعاء الدالة تحسب التي تضيف.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تضاف إليه وسائط استدعاء الدالة.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تضاف إليه أوساط استدعاء الدالة دلتا.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.function_call_arguments.delta`. القيم المحتملة: `response.function_call_arguments.delta`	‏‏نعم‬

ResponseFunctionCallArgumentsDoneEvent

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

Name	النوع	الوصف	مطلوبة
الحجج	string	حجج استدعاء الدوال.	‏‏نعم‬
item_id	string	هوية العنصر.	‏‏نعم‬
output_index	integer	فهرس العنصر المخرج.	‏‏نعم‬
النوع	enum	القيم المحتملة: `response.function_call_arguments.done`	‏‏نعم‬

حدث استجابة التقدم

يصدر عندما يكون الرد جاريا.

Name	النوع	الوصف	مطلوبة	افتراضي
الرد	استجابه		‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.in_progress`. القيم المحتملة: `response.in_progress`	‏‏نعم‬

حدث ResponseIncomplete

حدث يصدر عندما ينتهي الرد كغير مكتمل.

Name	النوع	الوصف	مطلوبة	افتراضي
الرد	استجابه		‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.incomplete`. القيم المحتملة: `response.incomplete`	‏‏نعم‬

responseItemList

قائمة بعناصر الرد.

Name	النوع	الوصف	مطلوبة
البيانات	مصفوفة	قائمة بالعناصر المستخدمة لتوليد هذا الرد.	‏‏نعم‬
first_id	string	معرف أول عنصر في القائمة.	‏‏نعم‬
has_more	boolean	هل هناك المزيد من العناصر المتاحة.	‏‏نعم‬
last_id	string	معرف آخر عنصر في القائمة.	‏‏نعم‬
الهدف	enum	يجب أن يكون نوع الكائن الذي تم إرجاعه هو `list`. القيم المحتملة: `list`	‏‏نعم‬

الاستجابةطرائق

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

["text"]

["text", "audio"]

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

ResponseModalitiesTextOnly

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

["text"]

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

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

حدث تمت إضافة ResponseOutputItem

يتم إصدار ذلك عند إضافة عنصر إخراج جديد.

Name	النوع	الوصف	مطلوبة
العنصر	عنصر الإخراج		‏‏نعم‬
output_index	integer	فهرس العنصر الناتج الذي أضيف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.output_item.added`. القيم المحتملة: `response.output_item.added`	‏‏نعم‬

ResponseOutputItemDoneEvent

يصدر عندما يتم وضع علامة على عنصر الإخراج الذي تم تحديده "انتهى".

Name	النوع	الوصف	مطلوبة
العنصر	عنصر الإخراج		‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تم وسمه بأنه تم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.output_item.done`. القيم المحتملة: `response.output_item.done`	‏‏نعم‬

خصائص الاستجابة

Name	النوع	الوصف	مطلوبة
التعليمات	string	يدرج رسالة نظام (أو مطور) كأول عنصر في سياق النموذج. عند استخدام مع `previous_response_id`، لن تنتقل التعليمات من استجابة سابقة إلى الاستجابة التالية. هذا يجعل من السهل تبديل رسائل النظام (أو المطور) في ردود جديدة.	لا
max_output_tokens	integer	حد أعلى لعدد الرموز التي يمكن إنشاؤها للرد، بما في ذلك رموز الإخراج المرئية وحالة المحادثة.	لا
previous_response_id	string	معرف فريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	لا
المنطق	المنطق	خيارات التكوين لنماذج التفكير.	لا
النص	الهدف	خيارات التكوين للاستجابة النصية من النموذج. يمكن أن تكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
صيغة └─	تكوين TextResponseFormat	كائن يحدد الصيغة التي يجب أن ينتجها النموذج. يتيح التكوين `{ "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

يصدر عندما يكون هناك نص رفض جزئي.

Name	النوع	الوصف	مطلوبة
content_index	integer	فهرس جزء المحتوى الذي يضاف إليه نص الرفض.	‏‏نعم‬
دلتا	string	نص الرفض الذي أضيف.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي يضاف إليه نص الرفض.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يضاف إليه نص الرفض.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.refusal.delta`. القيم المحتملة: `response.refusal.delta`	‏‏نعم‬

ResponseRefusalDoneEvent

يصدر عند الانتهاء من نص الرفض.

Name	النوع	الوصف	مطلوبة
content_index	integer	فهرس جزء المحتوى الذي يتم فيه تحديد نص الرفض.	‏‏نعم‬
item_id	string	معرف العنصر الناتج الذي يتم الانتهاء منه من نص الرفض.	‏‏نعم‬
output_index	integer	فهرس البند الناتج الذي يتم فيه الانتهاء من نص الرفض.	‏‏نعم‬
الرفض	string	نص الرفض النهائي.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.refusal.done`. القيم المحتملة: `response.refusal.done`	‏‏نعم‬

حدث تدفق الاستجابة

Name	النوع	الوصف	مطلوبة
التعليق	التعليق التوضيحي		‏‏نعم‬
annotation_index	integer	فهرس التعليق الذي أضيف.	‏‏نعم‬
الحجج	string	حجج استدعاء الدوال.	‏‏نعم‬
الرمز	string	رمز الخطأ.	‏‏نعم‬
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل الكود.	‏‏نعم‬
content_index	integer	فهرس جزء المحتوى الذي يتم فيه الانتهاء من محتوى النص.	‏‏نعم‬
دلتا	string	الرسالة التي أضيفت.	‏‏نعم‬
العنصر	عنصر الإخراج	العنصر الناتج الذي تم وسمه أنه انتهى.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي يتم الانتهاء منه من محتوى النص.	‏‏نعم‬
رسالة	string	رسالة الخطأ.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يتم فيه الانتهاء من محتوى النص.	‏‏نعم‬
برام	string	معامل الخطأ.	‏‏نعم‬
الجزء	OutputContent	الجزء الذي تم فيه المحتوى.	‏‏نعم‬
الرفض	string	نص الرفض النهائي.	‏‏نعم‬
الرد	استجابه	الرد كان غير مكتمل.	‏‏نعم‬
النص	string	المحتوى النصي الذي تم إنهائه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.output_text.done`. القيم المحتملة: `response.output_text.done`	‏‏نعم‬

ResponseTextAnnotationDeltaEvent

يصدر عند إضافة تعليق نصي.

Name	النوع	الوصف	مطلوبة
التعليق	التعليق التوضيحي		‏‏نعم‬
annotation_index	integer	فهرس التعليق الذي أضيف.	‏‏نعم‬
content_index	integer	فهرس جزء المحتوى الذي أضيفت إليه تعليقات النص.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي أضيفت إليه التعليقات النصية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي أضيفت إليه التعليقات النصية.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.output_text.annotation.added`. القيم المحتملة: `response.output_text.annotation.added`	‏‏نعم‬

ResponseTextDeltaEvent

يصدر عندما يكون هناك دلتا نصية إضافية.

Name	النوع	الوصف	مطلوبة
content_index	integer	فهرس جزء المحتوى الذي أضيفت إليه دلتا النص.	‏‏نعم‬
دلتا	string	الرسالة التي أضيفت.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي أضيفت إليه دلتا النص.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي أضيفت إليه دلتا النص.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.output_text.delta`. القيم المحتملة: `response.output_text.delta`	‏‏نعم‬

حدث نص الاستجابة

يصدر عند الانتهاء من محتوى النص.

Name	النوع	الوصف	مطلوبة
content_index	integer	فهرس جزء المحتوى الذي يتم فيه الانتهاء من محتوى النص.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي يتم الانتهاء منه من محتوى النص.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يتم فيه الانتهاء من محتوى النص.	‏‏نعم‬
النص	string	المحتوى النصي الذي تم إنهائه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما `response.output_text.done`. القيم المحتملة: `response.output_text.done`	‏‏نعم‬

استخدام الاستجابة

يمثل تفاصيل استخدام الرموز بما في ذلك رموز الإدخال، رموز الإخراج، تفصيل رموز الإخراج، وإجمالي الرموز المستخدمة.

Name	النوع	الوصف	مطلوبة
input_tokens	integer	عدد رموز الإدخال.	‏‏نعم‬
output_tokens	integer	عدد رموز الإخراج.	‏‏نعم‬
output_tokens_details	الهدف	تفصيل تفصيلي للرموز الناتجة.	‏‏نعم‬
└─ reasoning_tokens	integer	عدد رموز التفكير.	لا
total_tokens	integer	إجمالي عدد الرموز المستخدمة.	‏‏نعم‬

لقطه

إجراء لقطة شاشة.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء لقطة شاشة، يتم تعيين هذه الخاصية دائما على `screenshot`. القيم المحتملة: `screenshot`	‏‏نعم‬

تمرير

حركة تمرير.

Name	النوع	الوصف	مطلوبة
scroll_x	integer	مسافة التمرير الأفقية.	‏‏نعم‬
scroll_y	integer	مسافة التمرير العمودية.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء التمرير، يتم تعيين هذه الخاصية دائما على `scroll`. القيم المحتملة: `scroll`	‏‏نعم‬
x	integer	الإحداثي x حيث حدث اللفافة.	‏‏نعم‬
y	integer	إحداثي y حيث حدث اللفافة.	‏‏نعم‬

إيقاف التكوين

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

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

تكوين TextResponseFormat

كائن يحدد الصيغة التي يجب أن ينتجها النموذج.

يتيح التكوين { "type": "json_schema" } مخرجات منظمة، والتي تضمن تطابق النموذج لمخطط JSON المرفق لديك.

التنسيق الافتراضي هو { "type": "text" } بدون خيارات إضافية.

غير موصى به للطرازات GPT-4O والأحدث:

الإعداد لتفعيل { "type": "json_object" } وضع JSON الأقدم، الذي يضمن أن الرسالة التي يولدها النموذج هي JSON صالحة. الاستخدام json_schema مفضل للنماذج التي تدعمه.

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

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

TextResponseFormatJsonSchema

صيغة استجابة مخطط JSON. يستخدم لتوليد استجابات JSON منظمة. تعرف أكثر على المخرجات المنظمة.

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

أداة

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

FileSearchTool
FunctionTool
ComputerTool

ToolChoiceFunction

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

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

خيارات الأدوات

يتحكم في أي أداة (إن وجدت) يتم استدعاؤها بواسطة النموذج.

none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك يولد رسالة.

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

required يعني أن النموذج يجب أن يستدعي أداة أو أكثر.

الملكية	قيمة
الوصف	يتحكم في أي أداة (إن وجدت) يتم استدعاؤها بواسطة النموذج. `none` يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك يولد رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة أو أكثر.
نوع	string
القيم	`none` `auto` `required`

أنواع الأدوات

يشير إلى أن النموذج يجب أن يستخدم أداة مدمجة لتوليد الاستجابة.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	نوع الأداة المستضافة التي يجب أن يستخدمها النموذج. القيم المسموح بها هي: - `file_search` - `computer_use_preview` القيم الممكنة: `file_search`، `computer_use_preview`	‏‏نعم‬

النوع

إجراء للكتابة في النص.

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

UpdateVectorStoreFileAttributesRequest

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

اقتباس Url

استشهاد لمورد ويب يستخدم لتوليد استجابة نموذجية.

Name	النوع	الوصف	مطلوبة
end_index	integer	فهرس الحرف الأخير من استشهاد الرابط في الرسالة.	‏‏نعم‬
start_index	integer	فهرس الحرف الأول من استشهاد الرابط في الرسالة.	‏‏نعم‬
العنوان	string	عنوان مورد الويب.	‏‏نعم‬
النوع	enum	نوع الاستشهاد بعنوان URL. دائما `url_citation`. القيم المحتملة: `url_citation`	‏‏نعم‬
عنوان URL	string	رابط مورد الويب.	‏‏نعم‬

VectorStoreFileAttributes

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

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

VectorStoreFileContentResponse

يمثل المحتوى المحلل لملف مخزن متجه.

Name	النوع	الوصف	مطلوبة
البيانات	مصفوفة	تم تحليل محتوى الملف.	‏‏نعم‬
has_more	boolean	يشير إذا كان هناك صفحات محتوى إضافية لجلبها.	‏‏نعم‬
next_page	string	الرمز للصفحة التالية، إن وجد.	‏‏نعم‬
الهدف	enum	نوع الكائن، وهو دائما `vector_store.file_content.page` القيم المحتملة: `vector_store.file_content.page`	‏‏نعم‬

طلب البحث في VectorStore

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

VectorStoreSearchResultContentObject

Name	النوع	الوصف	مطلوبة	افتراضي
النص	string	عاد محتوى النص من البحث.	‏‏نعم‬
النوع	enum	نوع المحتوى. القيم المحتملة: `text`	‏‏نعم‬

VectorStoreSearchResultItem

Name	النوع	الوصف	مطلوبة
السمات	VectorStoreFileAttributes	مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا، أو بوليان، أو أرقام.	‏‏نعم‬
محتوى	مصفوفة	أجزاء المحتوى من الملف.	‏‏نعم‬
file_id	string	معرف ملف مخزن المتجه.	‏‏نعم‬
اسم الملف	string	اسم ملف مخزن المتجه.	‏‏نعم‬
الموسيقى التصويرية	number	درجة التشابه للنتيجة.	‏‏نعم‬

VectorStoreSearchResultsPage

Name	النوع	الوصف	مطلوبة
البيانات	مصفوفة	قائمة عناصر نتائج البحث.	‏‏نعم‬
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من النتائج التي يجب جلبها.	‏‏نعم‬
next_page	string	الرمز للصفحة التالية، إن وجد.	‏‏نعم‬
الهدف	enum	نوع الكائن، وهو دائما `vector_store.search_results.page` القيم المحتملة: `vector_store.search_results.page`	‏‏نعم‬
search_query	مصفوفة		‏‏نعم‬

VoiceIdsShared

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

انتظر

إجراء انتظار.

Name	النوع	الوصف	مطلوبة	افتراضي
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء الانتظار، يتم تعيين هذه الخاصية دائما إلى `wait`. القيم المحتملة: `wait`	‏‏نعم‬

ReasoningEffort

يقيد الجهد في التفكير في نماذج الاستدلال. القيم المدعومة حاليا هي low، medium، و high. تقليل جهد التفكير يمكن أن يؤدي إلى استجابة أسرع واستخدام رموز أقل في الاستدلال.

الملكية	قيمة
الوصف	يقيد الجهد في التفكير في نماذج الاستدلال. القيم المدعومة حاليا هي `low`، `medium`، و `high`. تقليل جهد التفكير يمكن أن يؤدي إلى استجابة أسرع واستخدام رموز أقل في الاستدلال.
نوع	string
الافتراضي	متوسطة
القيم	`low` `medium` `high`

حدث خطأ

يحدث عندما يحدث خطأ. قد يحدث هذا بسبب خطأ داخلي في الخادم أو انتهاء الوقت.

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

تعداد الحدث: ErrorEventEnum

قيمة	الوصف
خطأ

حدث تم

يحدث عندما ينتهي التيار.

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

حدث إينوم: دون إيفينت إينوم

قيمة	الوصف
القيام به

تعداد البيانات: DoneEventDataEnum

قيمة	الوصف
[تم]

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

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

الملاحظات

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

Last updated on 2026-05-20