Azure OpenAI in Microsoft Foundry Models v1 مرجع REST API

• v1 مواصفات OpenAPI 3.0

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

متغيرات الخادم:

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

المصادقة

API key

مرر مفتاح API مع الرأس api-key .

رموز المصادقة

مرر رمز تصريح مع الرأس authorization .

Oauth2authoauth20

التدفق: ضمني

عنوان URL للتخويل:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

نطاقات:

• https://ai.azure.com/.default

Batch

إنشاء دفعة

POST {endpoint}/openai/v1/batches

ينشئ وينفذ دفعة من ملف طلبات مرفع

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
تقبل	صحيح	string القيم المحتملة: application/json

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
completion_window	enum	الإطار الزمني الذي يجب معالجة الدفعة خلاله. حاليا يتم دعم فقط 24h . القيم المحتملة: 24h	‏‏نعم‬
نقطه النهايه	enum	نقطة النهاية التي تستخدم لجميع الطلبات في الدفعة. حاليا /v1/chat/completions مدعوم. القيم المحتملة: /v1/chat/completions، /v1/embeddings	‏‏نعم‬
input_file_id	string	معرف ملف تم رفعه يحتوي على طلبات للدفعة الجديدة. يجب أن يكون ملف الإدخال منسقا كملف JSON, ويجب رفعه بهدف batch.	لا

الاستجابات

رمز الحالة: 201

الوصف: نجح الطلب وتم إنشاء مورد جديد نتيجة لذلك.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

دفعات القائمة

GET {endpoint}/openai/v1/batches

قم بإدراج دفعات منظمتك.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
تقبل	صحيح	string القيم المحتملة: application/json

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListBatchesResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرجاع دفعة

GET {endpoint}/openai/v1/batches/{batch_id}

يستعيد دفعة.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
تقبل	صحيح	string القيم المحتملة: application/json

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إلغاء الدفعة

POST {endpoint}/openai/v1/batches/{batch_id}/cancel

إلغاء دفعة قيد التقدم.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
تقبل	صحيح	string القيم المحتملة: application/json

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

دردشة

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

POST {endpoint}/openai/v1/chat/completions

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
صوتي	OpenAI.CreateChatCompletionRequestAudio أو null	معلمات لإخراج الصوت. مطلوب عند طلب إخراج الصوت مع modalities: ["audio"].	لا
frequency_penalty	عدد أو صفرا	رقم يتراوح بين 2.0 و2.0. القيم الإيجابية تعاقب الرموز المميزة الجديدة بناء على ترددها الحالي في النص حتى الآن ، مما يقلل من النموذج احتمالية تكرار نفس السطر حرفيا.	لا
function_call	string أو OpenAI.ChatCompletionFunctionCallOption	مهمل لصالح tool_choice. عناصر التحكم التي يتم استدعاء الدالة (إن وجدت) بواسطة النموذج. none يعني أن النموذج لن يستدعي دالة بل يولد رسالة. auto يعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء وظيفة. تحديد دالة معينة عبر {"name": "my_function"} القوى نموذج لاستدعاء تلك الدالة. none هو الافتراضي عندما لا تكون هناك دالات. auto هو الافتراضي إذا كانت الدوال موجودة.	لا
functions	مصفوفة من OpenAI.ChatCompletionFunctions	مهمل لصالح tools. قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها.	لا
logit_bias	مفعول أم صفرا	تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز الخاص بها في tokenizer) إلى قيمة التحيز المقترنة من -100 إلى 100. رياضيا تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. سيختلف التأثير الدقيق حسب الطراز ، ولكن يجب أن تختلف القيم بين -1 و 1 تقليل أو زيادة احتمالية الاختيار ؛ قيم مثل -100 أو 100 يجب أن يؤدي إلى حظر أو اختيار حصري للرمز المميز ذي الصلة.	لا
سجلات الحماية	بوليان أو نول	ما إذا كان يجب إرجاع احتمالات السجل للرمز المميزة للإخراج أم لا. إذا كان هذا صحيحا، إرجاع احتمالات السجل لكل رمز مميز للإخراج تم إرجاعه في السمة content من message.	لا
max_completion_tokens	عدد صحيح أو صفري	الحد الأعلى لعدد الرموز المميزة التي يمكن إنشاؤها ل الإكمال ، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة للتفكير.	لا
max_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها في إكمال الدردشة. يمكن استخدام هذه القيمة للتحكم في تكاليف النص الذي تم إنشاؤه عبر واجهة برمجة التطبيقات. تم إهمال هذه القيمة الآن لصالح max_completion_tokens، وهي غير متوافق مع طرازات سلسلة O1.	لا
messages	مصفوفة من OpenAI.ChatCompletionRequestMessage	قائمة بالرسائل التي تتضمن المحادثة حتى الآن. اعتمادا على النموذج الذي تستخدمه، يتم دعم أنواع الرسائل المختلفة (الطرائق)، مثل النص والصور والصوت.	‏‏نعم‬
metadata	OpenAI.Metadata أو null		لا
طرائق	OpenAI.ResponseModalities	أنواع الإخراج التي ترغب في أن ينشئها النموذج. معظم النماذج قادرة على إنشاء نص، وهو الافتراضي: ["text"] يمكن أيضا استخدام النموذج gpt-4o-audio-preview إلى توليد الصوت. لطلب إنشاء هذا النموذج يمكنك استخدام كل من الاستجابات النصية والصوتية: ["text", "audio"]	لا
نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	‏‏نعم‬
n	عدد صحيح أو صفري	كم عدد خيارات إكمال الدردشة التي يجب إنشاؤها لكل رسالة إدخال. لاحظ أنه سيتم تحصيل رسوم منك استنادا إلى عدد الرموز المميزة التي تم إنشاؤها عبر جميع الخيارات. احتفظ n بأدنى 1 قدر من التكاليف.	لا
parallel_tool_calls	OpenAI.ParallelToolCalls	ما إذا كنت تريد تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا
prediction	OpenAI.PredictionContent	المحتوى المتوقع الثابت الناتج عن النتائج، مثل محتوى ملف نصي هو يتجدد.	لا
└─ المحتوى	السلسلة أو المصفوفة من OpenAI.ChatCompletionRequestMessageContentPartText	المحتوى الذي يجب مطابقته عند إنشاء استجابة نموذج. إذا كانت الرموز المولدة ستتطابق هذا المحتوى، فإن استجابة النموذج بأكملها يمكن إرجاعه بسرعة أكبر بكثير.	‏‏نعم‬
└─ النوع	enum	نوع المحتوى المتوقع الذي تريد توفيره. هذا النوع هو حاليا دائما content. القيم المحتملة: content	‏‏نعم‬
presence_penalty	عدد أو صفرا	رقم يتراوح بين 2.0 و2.0. القيم الإيجابية تعاقب الرموز المميزة الجديدة بناء على ما إذا كانت تظهر في النص حتى الآن ، مما يزيد من احتمالية النموذج للحديث عن مواضيع جديدة.	لا
prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
prompt_cache_retention	سلسلة أو قيمة خالية		لا
reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
response_format	OpenAI.CreateChatCompletionRequestResponseFormat	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. إعداد تفعيل { "type": "json_schema", "json_schema": {...} } مخرجات منظمة تضمن أن النموذج سيتطابق مع JSON الذي قدمته المخطط. تعرف على المزيد في المخرجات المنظمة دليل. إعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. استخدام json_schema يفضل للنماذج التي تدعمه.	لا
└─ النوع	OpenAI.CreateChatCompletionRequestResponseFormatType		‏‏نعم‬
safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
seed	عدد صحيح أو صفري	هذه الميزة في Beta. إذا تم تحديده ، سيبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات seed المتكررة بنفس المعلمات والمعلمات نفس النتيجة. الحتمية غير مضمونة ، ويجب عليك الرجوع إلى معلمة system_fingerprint الاستجابة لمراقبة التغييرات في الواجهة الخلفية.	لا
stop	OpenAI.StopConfiguration	غير مدعوم بأحدث نماذج o3 التفكير و o4-mini. ما يصل إلى أربعة تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. ال لن يحتوي النص الذي تم إرجاعه على تسلسل التوقف.	لا
store	بوليان أو نول	ما إذا كنت تريد تخزين إخراج طلب إكمال الدردشة هذا أم لا ل استخدم في منتجات تقطير النموذج أو Evals.	لا
استدر	بوليان أو نول	إذا تم تعيينه إلى صواب، دفق بيانات استجابة النموذج إلى العميل حيث يتم إنشاؤه باستخدام الأحداث المرسلة من الخادم.	لا
stream_options	OpenAI.ChatCompletionStreamOptions أو null		لا
درجة الحرارة	عدد أو صفرا		لا
tool_choice	OpenAI.ChatCompletionToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. auto يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر. required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر. تحديد أداة معينة عبر {"type": "function", "function": {"name": "my_function"}} يفرض على النموذج استدعاء تلك الأداة. none هو الافتراضي عندما لا تكون هناك أدوات موجودة. auto هو الافتراضي إذا كانت الأدوات موجودة.	لا
الأدوات	مصفوفة من OpenAI.ChatCompletionTool أو OpenAI.CustomToolChatCompletetions	قائمة بالأدوات التي قد يستدعيها النموذج. يمكنك تقديم أي منهما أدوات مخصصة أو أدوات الوظيفة.	لا
top_logprobs	عدد صحيح أو صفري		لا
top_p	عدد أو صفرا		لا
user	سلسلة (مهملة)	معرف فريد يمثل المستخدم النهائي الخاص بك، والذي يمكن أن يساعد في مراقبة واكتشاف إساءة الاستخدام.	لا
user_security_context	AzureUserSecurityContext	يحتوي سياق أمان المستخدم على العديد من المعلمات التي تصف التطبيق نفسه، والمستخدم النهائي الذي يتفاعل مع التطبيق. تساعد هذه الحقول فرق عمليات الأمان الخاصة بك على التحقيق في الحوادث الأمنية والتخفيف من حدتها من خلال توفير نهج شامل لحماية تطبيقاتك الذكاء الاصطناعي. تعرف على المزيد حول حماية تطبيقات الذكاء الاصطناعي باستخدام Microsoft Defender for Cloud.	لا
الاسهاب	OpenAI.Verbosity	يحد من كثرة استجابة النموذج. ستؤدي القيم الأقل إلى استجابات أكثر إيجازا، بينما ستؤدي القيم الأعلى إلى المزيد من الاستجابات المطولة. القيم المدعومة حاليا هي lowو mediumو.high	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	مفعول أو كائن

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الأمثلة

مثال

POST {endpoint}/openai/v1/chat/completions

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

إنشاء إكمال

POST {endpoint}/openai/v1/completions

يخلق إكمالا.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
best_of	عدد صحيح أو صفري	إنشاء إكمال من best_of جانب الخادم وإرجاع "الأفضل" (واحد مع أعلى احتمال سجل لكل رمز مميز). لا يمكن بث النتائج. عند استخدامه مع n، best_of يتحكم في عدد المرشحين المكتملين ويحدد n عدد المرات التي يجب إرجاعها – best_of يجب أن يكون أكبر من n. ملاحظة:* نظرا لأن هذا المعامل يولد العديد من الإكمالات، يمكنه استهلاك حصة الرموز الخاصة بك بسرعة. استخدم بعناية وتأكد من أن لديك إعدادات معقولة ل max_tokens و stop.	لا
echo	بوليان أو نول	إعادة توجيه المطالبة بالإضافة إلى الاكتمال	لا
frequency_penalty	عدد أو صفرا	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي. اطلع على مزيد من المعلومات حول عقوبات التكرار والتواجد.	لا
logit_bias	مفعول أم صفرا	تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في GPT tokenizer) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. سيختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو تحديد حصري للرمز المميز ذي الصلة. على سبيل المثال، يمكنك التمرير {"50256": -100} لمنع <إنشاء الرمز المميز |endoftext|> .	لا
سجلات الحماية	عدد صحيح أو صفري	قم بتضمين احتمالات السجل على logprobs الرموز المميزة للإخراج الأكثر احتمالا، بالإضافة إلى الرموز المميزة المختارة. على سبيل المثال، إذا كان logprobs هو 5، فسترجع واجهة برمجة التطبيقات قائمة بالرموز المميزة الخمسة الأكثر احتمالا. ستقوم واجهة برمجة التطبيقات دائما بإعادة logprob الرمز المميز الذي تم أخذ عينات له، لذلك قد يكون هناك ما يصل إلى logprobs+1 عناصر في الاستجابة. الحد الأقصى لقيمة logprobs هو 5.	لا
max_tokens	عدد صحيح أو صفري	يمكن إنشاء الحد الأقصى لعدد الرموز المميزة في الاكتمال. لا يمكن أن يتجاوز عدد الرموز في الطلب زائد max_tokens طول سياق النموذج. مثال على كود بايثون لعد الرموز.	لا
نموذج	string	معرف النموذج المراد استخدامه. يمكنك استخدام واجهة برمجة تطبيقات نماذج القائمة لرؤية جميع النماذج المتاحة لديك، أو الاطلاع على نظرة عامة على النماذج لوصفها.	‏‏نعم‬
n	عدد صحيح أو صفري	مقدار عدد عمليات الإكمال التي يجب إنشاؤها لكل مطالبة. ملاحظة:* نظرا لأن هذا المعامل يولد العديد من الإكمالات، يمكنه استهلاك حصة الرموز الخاصة بك بسرعة. استخدم بعناية وتأكد من أن لديك إعدادات معقولة ل max_tokens و stop.	لا
presence_penalty	عدد أو صفرا	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج. اطلع على مزيد من المعلومات حول عقوبات التكرار والتواجد.	لا
فوري	السلسلة أو المصفوفة من الوتر أو الصفر		لا
seed	عدد صحيح أو صفري	إذا تم تحديده ، سيبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات seed المتكررة بنفس المعلمات والمعلمات نفس النتيجة. الحتمية غير مضمونة ، ويجب عليك الرجوع إلى معلمة system_fingerprint الاستجابة لمراقبة التغييرات في الواجهة الخلفية.	لا
stop	OpenAI.StopConfiguration	غير مدعوم بأحدث نماذج o3 التفكير و o4-mini. ما يصل إلى أربعة تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. ال لن يحتوي النص الذي تم إرجاعه على تسلسل التوقف.	لا
استدر	بوليان أو نول	سواء كنت تريد إرجاع التقدم الجزئي أم لا. إذا تم تعيينها، إرسال الرموز المميزة كأحداث مرسلة إلى الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالة data: [DONE] . التعليمات البرمجية Python Example.	لا
stream_options	OpenAI.ChatCompletionStreamOptions أو null		لا
لاحقه	سلسلة أو قيمة خالية	اللاحقة التي تأتي بعد إكمال النص المدرج. هذه المعلمة مدعومة فقط ل gpt-3.5-turbo-instruct.	لا
درجة الحرارة	عدد أو صفرا	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا
top_p	عدد أو صفرا	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا
user	string	تعرّف على المزيد.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الأمثلة

مثال

POST {endpoint}/openai/v1/completions

الحَاويَات

قائمة الحاويات

GET {endpoint}/openai/v1/containers

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ContainerListResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء الحاوية

POST {endpoint}/openai/v1/containers

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_after	OpenAI.CreateContainerBodyExpiresAfter		لا
└─ مرساة	enum	القيم المحتملة: last_active_at	‏‏نعم‬
└─ دقائق	integer		‏‏نعم‬
file_ids	صفيف سلسلة	معرفات الملفات التي يجب نسخها إلى الحاوية.	لا
memory_limit	enum	حد ذاكرة اختياري للحاوية. الإعدادات الافتراضية لـ 1g. القيم المحتملة: 1g، 4g، ، 16g64g	لا
الاسم	string	اسم الحاوية التي يجب إنشاؤها.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ContainerResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حاوية الاسترجاع

GET {endpoint}/openai/v1/containers/{container_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ContainerResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف الحاوية

DELETE {endpoint}/openai/v1/containers/{container_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

ملفات قائمة الحاويات

GET {endpoint}/openai/v1/containers/{container_id}/files

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ContainerFileListResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء ملف حاوية

POST {endpoint}/openai/v1/containers/{container_id}/files

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
ملف		كائن الملف (وليس اسم الملف) الذي يجب رفعه.	لا
file_id	string	اسم الملف الذي يجب إنشاؤه.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ContainerFileResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرجاع ملف الحاوية

GET {endpoint}/openai/v1/containers/{container_id}/files/{file_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ContainerFileResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف ملف الحاوية

DELETE {endpoint}/openai/v1/containers/{container_id}/files/{file_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرجاع محتوى ملف الحاوية

GET {endpoint}/openai/v1/containers/{container_id}/files/{file_id}/content

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/octet-stream	object

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

المحادثات

إنشاء محادثة

POST {endpoint}/openai/v1/conversations

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
العناصر	مصفوفة من OpenAI.InputItem أو null		لا
metadata	OpenAI.Metadata أو null		لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ConversationResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرجاع المحادثة

GET {endpoint}/openai/v1/conversations/{conversation_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ConversationResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

تحديث المحادثة

POST {endpoint}/openai/v1/conversations/{conversation_id}

معلمات URI

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ConversationResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف المحادثة

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.DeletedConversationResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

سرد عناصر المحادثة

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ConversationItemList

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء عناصر محادثة

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
العناصر	صفيف OpenAI.InputItem		‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ConversationItemList

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرجاع عنصر المحادثة

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ConversationItem

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف عنصر المحادثة

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ConversationResource

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

التقييمات

قائمة الإيفالات

GET {endpoint}/openai/v1/evals

سرد التقييمات لمشروع.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.EvalList

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء eval

POST {endpoint}/openai/v1/evals

إنشاء بنية تقييم يمكن استخدامها لاختبار أداء النموذج.

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_source_config	OpenAI.CreateEvalCustomDataSourceConfig أو OpenAI.CreateEvalLogsDataSourceConfig أو OpenAI.CreateEvalStoredCompletionsDataSourceConfig	يتم تشغيل تكوين مصدر البيانات المستخدم للتقييم. إملاء مخطط البيانات المستخدمة في التقييم.	‏‏نعم‬
metadata	OpenAI.Metadata أو null		لا
الاسم	string	اسم التقييم.	لا
رمز الحالة	enum	القيم المحتملة: 201	‏‏نعم‬
testing_criteria	مصفوفة من OpenAI.CreateEvalLabelModelGrader أو OpenAI.EvalGraderStringCheck أو OpenAI.EvalGraderTextSimilarity أو OpenAI.EvalGraderPython أو OpenAI.EvalGraderScoreModel أو EvalGraderEndpoint	يتم تشغيل قائمة بالدرجات لجميع التقييمات في هذه المجموعة. يمكن لمصنفي التقديرات الرجوع إلى المتغيرات في مصدر البيانات باستخدام تدوين الأقواس المتعرجة المزدوجة، مثل {{item.variable_name}}. للإشارة إلى إخراج النموذج ، استخدم sample مساحة الاسم (على سبيل المثال ، {{sample.output_text}}).	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.Eval

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

احصل على eval

GET {endpoint}/openai/v1/evals/{eval_id}

استرداد تقييم من خلال معرفه. استرداد تقييم حسب معرفه.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.Eval

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

تحديث التقييم

POST {endpoint}/openai/v1/evals/{eval_id}

تحديث الخصائص المحددة القابلة للتغيير لتقييم محدد.

معلمات URI

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.Eval

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف التقييم

DELETE {endpoint}/openai/v1/evals/{eval_id}

حذف تقييم محدد.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

احصل على عمليات تشغيل eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs

استرداد قائمة بعمليات التشغيل لتقييم محدد.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة تطبيقات نماذج Azure الذكاء الاصطناعي Foundry الصريح لاستخدامه لهذا الطلب. v1 إذا لم يتم تحديد خلاف ذلك.
eval_id	path	‏‏نعم‬	string
after	استعلام	لا	string
الحد	استعلام	لا	integer
order	استعلام	لا	string القيم المحتملة: asc، desc
الحالة	استعلام	لا	string القيم المحتملة: queued، in_progress، completed، ، canceledfailed

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.EvalRunList

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء تشغيل eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs

قم بإنشاء تشغيل تقييم جديد، وبدء عملية التقدير.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_source	OpenAI.CreateEvalJsonlRunDataSource أو OpenAI.CreateEvalCompletionsRunDataSource أو OpenAI.CreateEvalResponsesRunDataSource	تفاصيل حول مصدر بيانات التشغيل.	‏‏نعم‬
metadata	OpenAI.Metadata أو null		لا
الاسم	string	اسم التشغيل.	لا

الاستجابات

رمز الحالة: 201

الوصف: نجح الطلب وتم إنشاء مورد جديد نتيجة لذلك.

Content-Type	نوع	الوصف
application/json	OpenAI.EvalRun

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

استرداد تقييم معين يتم تشغيله بواسطة معرفه.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.EvalRun

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إلغاء تشغيل التقييم

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

إلغاء تقييم معين يتم تشغيله بواسطة معرفه.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.EvalRun

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف تشغيل eval

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

حذف تقييم معين يتم تشغيله بواسطة معرفه.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الحصول على عناصر إخراج تشغيل eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

احصل على قائمة بعناصر الإخراج لتشغيل تقييم محدد.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة تطبيقات نماذج Azure الذكاء الاصطناعي Foundry الصريح لاستخدامه لهذا الطلب. v1 إذا لم يتم تحديد خلاف ذلك.
eval_id	path	‏‏نعم‬	string
run_id	path	‏‏نعم‬	string
after	استعلام	لا	string
الحد	استعلام	لا	integer
الحالة	استعلام	لا	string القيم المحتملة: fail، pass
order	استعلام	لا	string القيم المحتملة: asc، desc

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.EvalRunOutputItemList

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الحصول على عنصر إخراج تشغيل eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.EvalRunOutputItem

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

Files

إنشاء ملف

POST {endpoint}/openai/v1/files

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_after	object		‏‏نعم‬
└─ مرساة	AzureFileExpiryAnchor		‏‏نعم‬
└─ ثواني	integer		‏‏نعم‬
ملف		كائن الملف (وليس اسم الملف) الذي يجب رفعه.	‏‏نعم‬
قصد	enum	الغرض المقصود من الملف الذي تم تحميله. واحد من: - assistants: يستخدم في واجهة برمجة تطبيقات المساعدين - batch: يستخدم في واجهة برمجة التطبيقات الدفعية - fine-tune: يستخدم للضبط الدقيق - evals: يستخدم لمجموعات بيانات التقييم القيم المحتملة: assistants، batch، ، fine-tuneevals	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الأمثلة

مثال

POST {endpoint}/openai/v1/files

قائمة الملفات

GET {endpoint}/openai/v1/files

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListFilesResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرداد الملف

GET {endpoint}/openai/v1/files/{file_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف الملف

DELETE {endpoint}/openai/v1/files/{file_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.DeleteFileResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

تنزيل الملف

GET {endpoint}/openai/v1/files/{file_id}/content

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/octet-stream	object

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

التضمينات

إنشاء تضمين

POST {endpoint}/openai/v1/embeddings

إنشاء متجه تضمين يمثل نص الإدخال.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
ابعاد	integer	عدد الأبعاد التي يجب أن تحتوي عليها تضمينات الإخراج الناتجة. مدعوم فقط في text-embedding-3 والنماذج الأحدث. القيود: الحد الأدنى: 1	لا
encoding_format	enum	التنسيق الذي يجب إرجاع التضمينات فيه. يمكن أن يكون إما float أو base64. القيم المحتملة: float، base64	لا
الادخال	سلسلة أو مصفوفة من السلسلة أو مصفوفة من عدد صحيح أو مصفوفة من المصفوفة	إدخال نص لتضمينه أو ترميزه كسلسلة أو صفيف من الرموز المميزة. لتضمين مدخلات متعددة في طلب واحد، مرر صفيف سلاسل أو صفيف من صفائف الرمز المميز. يجب ألا يتجاوز الإدخال الحد الأقصى لرموز الإدخال للنموذج (8,192 رمزا لجميع نماذج التضمين)، ولا يمكن أن يكون سلسلة فارغة، ويجب أن تكون أي مصفوفة ببعد 2,048 أو أقل. مثال على كود بايثون لعد الرموز. بالإضافة إلى حد الرمز لكل إدخال، تفرض جميع نماذج التضمين مجموع حد أقصى يصل إلى 300,000 رمز عبر جميع المدخلات في طلب واحد.	‏‏نعم‬
نموذج	string	معرف النموذج المراد استخدامه. يمكنك استخدام واجهة برمجة تطبيقات نماذج القائمة لرؤية جميع النماذج المتاحة لديك، أو الاطلاع على نظرة عامة على النماذج لوصفها.	‏‏نعم‬
user	string	تعرّف على المزيد.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.CreateEmbeddingResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الأمثلة

مثال

POST {endpoint}/openai/v1/embeddings

Fine-tuning

تشغيل ممهد التقديرات

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run

تشغيل مصنف تقديرات.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الصف	OpenAI.GraderStringCheck أو OpenAI.GraderTextSimilarity أو OpenAI.GraderPython أو OpenAI.GraderScoreModel أو OpenAI.GraderMulti أو GraderEndpoint	الصف المستخدم لوظيفة الضبط الدقيق.	‏‏نعم‬
عنصر	OpenAI.RunGraderRequestItem		لا
model_sample	string	عينة النموذج المراد تقييمها. سيتم استخدام هذه القيمة لتعبئة مساحة sample الاسم. انظر الدليل لمزيد من التفاصيل. سيتم ملء المتغير output_json إذا كان عينة النموذج هي سلسلة JSON صالحة.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RunGraderResponse

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate

التحقق من صحة مصنف التقديرات.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الصف	OpenAI.GraderStringCheck أو OpenAI.GraderTextSimilarity أو OpenAI.GraderPython أو OpenAI.GraderScoreModel أو OpenAI.GraderMulti أو GraderEndpoint		لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ValidateGraderResponse

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

قائمة صلاحيات ضبط نقاط التحقق بدقة

GET {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

أذونات نقاط التفتيش القائمة

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة تطبيقات نماذج Azure الذكاء الاصطناعي Foundry الصريح لاستخدامه لهذا الطلب. v1 إذا لم يتم تحديد خلاف ذلك.
fine_tuned_model_checkpoint	path	‏‏نعم‬	string	معرف نقطة التحقق الدقيقة للنموذج المضبوط للحصول على الأذونات لها.
project_id	استعلام	لا	string	معرف المشروع للحصول على الأذونات له.
after	استعلام	لا	string	معرف آخر معرف للإذن من طلب الترقيم السابق.
الحد	استعلام	لا	integer	عدد الأصوات التي يجب استرجاعها.
order	استعلام	لا	string القيم المحتملة: ascending، descending	ترتيب استرجاع الأذونات.

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListFineTuningCheckpointPermissionResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء صلاحيات نقطة التحقق للضبط الدقيق

POST {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

إنشاء أذونات نقاط التحقق

معلمات URI

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListFineTuningCheckpointPermissionResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف ضبط دقيق لصلاحيات نقطة التفتيش

DELETE {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}

حذف إذن نقطة التفتيش

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.DeleteFineTuningCheckPointPermissionResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء مهمة ضبط دقيقة

POST {endpoint}/openai/v1/fine_tuning/jobs

ينشئ مهمة ضبط دقيقة تبدأ عملية إنشاء نموذج جديد من مجموعة بيانات معينة.

تتضمن الاستجابة تفاصيل الوظيفة المدرجة في قائمة الانتظار بما في ذلك حالة الوظيفة واسم النماذج المضبوطة بدقة بمجرد اكتمالها.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعلمات الفائقة	OpenAI.CreateFineTuningJobRequestHyperparameters		لا
└─ batch_size	سلسلة أو عدد صحيح		لا	تلقائي
└─ learning_rate_multiplier	السلسلة أو الرقم		لا
└─ n_epochs	سلسلة أو عدد صحيح		لا	تلقائي
التكامل	مصفوفة من OpenAI.CreateFineTuningJobRequestIntegrations أو null	قائمة عمليات التكامل لتمكينها من مهمة الضبط الدقيق.	لا
metadata	OpenAI.Metadata أو null		لا
method	OpenAI.FineTuneMethod	الطريقة المستخدمة للضبط الدقيق.	لا
نموذج	سلسلة (راجع النماذج الصالحة أدناه)	اسم النموذج المراد ضبطه. يمكنك تحديد أحد الرموز النماذج المدعومة.	‏‏نعم‬
seed	عدد صحيح أو صفري	تتحكم البيانات الأولية في إمكانية إعادة إنتاج الوظيفة. يجب أن يؤدي في نفس البيانات الأولية ونفس معلمات الوظيفة أن ينتج نفس النتائج، لكن قد يحدث اختلاف في حالات نادرة. إذا لم يتم تحديد البذور، إنشاء واحد لك.	لا
لاحقه	سلسلة أو قيمة خالية	سلسلة تصل إلى 64 حرفا ستتم إضافتها إلى اسم الطراز المضبوط بدقة. على سبيل المثال ، سينتج عن suffix "custom-model-name" اسم نموذج مثل ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	لا
training_file	string	معرف الملف الذي تم تحميله والذي يحتوي على بيانات التدريب. راجع تحميل ملف لمعرفة كيفية تحميل ملف. يجب تنسيق مجموعة البيانات الخاصة بك كملف JSONL. بالإضافة إلى ذلك ، يجب عليك تحميل ملفك لهذا الغرض fine-tune. يجب أن تختلف محتويات الملف بناء على ما إذا كان النموذج يستخدم الدردشة أو تنسيق الإكمال أو إذا كان أسلوب الضبط يستخدم تنسيق التفضيل . راجع دليل الضبط الدقيق لمزيد من التفاصيل.	‏‏نعم‬
validation_file	سلسلة أو قيمة خالية	معرف الملف الذي تم تحميله والذي يحتوي على بيانات التحقق من الصحة. إذا قمت بتوفير هذا الملف، استخدام البيانات لإنشاء التحقق من الصحة المقاييس بشكل دوري أثناء الضبط الدقيق. يمكن الاطلاع على هذه المقاييس في ملف نتائج الضبط الدقيق. يجب ألا تكون نفس البيانات موجودة في كل من ملفات التدريب والتحقق من الصحة. يجب تنسيق مجموعة البيانات الخاصة بك كملف JSONL. يجب عليك تحميل ملفك لهذا الغرض fine-tune. راجع دليل الضبط الدقيق لمزيد من التفاصيل.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.FineTuningJob

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

سرد مهام الضبط الدقيقة المرقمة

GET {endpoint}/openai/v1/fine_tuning/jobs

سرد مهام الضبط الدقيق لمؤسستك

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرداد مهمة الضبط الدقيق

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}

احصل على معلومات حول وظيفة الضبط الدقيق.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.FineTuningJob

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إلغاء مهمة الضبط الدقيق

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel

قم بإلغاء وظيفة الضبط الدقيق على الفور.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.FineTuningJob

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

سرد نقاط التحقق من مهمة الضبط الدقيقة

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

ضع قائمة بنقاط التفتيش لوظيفة الضبط الدقيق.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الضبط الدقيق - نقطة التحقق الجاهزة

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy

إنشاء نسخة من نقطة تفتيش الضبط الدقيق في حساب الوجهة والمنطقة المحددة.

ملاحظة: واجهة برمجة تطبيقات Azure OpenAI هذه قيد المعاينة وعرضة للتغيير.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
نقاط تفتيش AOAI-نسخ FT	صحيح	string القيم المحتملة: preview	يتيح الوصول إلى عمليات نسخ نقطة التفتيش للنماذج، ميزة معاينة AOAI. تتطلب هذه الميزة تعيين رأس "aoai-copy-ft-checkpoints" على "معاينة".
تقبل	صحيح	string القيم المحتملة: application/json

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	CopyModelResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الضبط الدقيق - احصل على نقطة التفتيش

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy

يحصل على حالة نسخة نقطة تفتيش ضبطية دقيقة.

ملاحظة: واجهة برمجة تطبيقات Azure OpenAI هذه قيد المعاينة وعرضة للتغيير.

معلمات URI

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

رأس الطلب

الاسم	مطلوب	النوع	وصف
نقاط تفتيش AOAI-نسخ FT	صحيح	string القيم المحتملة: preview	يتيح الوصول إلى عمليات نسخ نقطة التفتيش للنماذج، ميزة معاينة AOAI. تتطلب هذه الميزة تعيين رأس "aoai-copy-ft-checkpoints" على "معاينة".
تقبل	صحيح	string القيم المحتملة: application/json

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	CopyModelResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

قائمة فعاليات الضبط الدقيق

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events

احصل على تحديثات الحالة لمهمة ضبط دقيقة.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListFineTuningJobEventsResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إيقاف مهمة ضبط الضبط بشكل مؤقت

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause

إيقاف وظيفة ضبط دقيقة مؤقتا.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.FineTuningJob

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استئناف مهمة الضبط الدقيق

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume

استئناف مهمة ضبط دقيقة متوقفة مؤقتا.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.FineTuningJob

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

Models

سرد النماذج

GET {endpoint}/openai/v1/models

يسرد النماذج المتوفرة حاليا، ويوفر معلومات أساسية حول كل منها مثل المالك والتوافر.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListModelsResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرداد النموذج

GET {endpoint}/openai/v1/models/{model}

استرداد مثيل نموذج، وتوفير معلومات أساسية حول النموذج مثل المالك والأذون.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	نموذج OpenAI.

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف نموذج

DELETE {endpoint}/openai/v1/models/{model}

يحذف نسخة نموذجية.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.DeleteModelResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الوقت الحقيقي

إنشاء مكالمة في الوقت الحقيقي

POST {endpoint}/openai/v1/realtime/calls

أنشئ استدعاء API في الوقت الحقيقي عبر WebRTC واستلم إجابة SDP اللازمة لإكمال اتصال الأقران.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
SDP	string	بروتوكول وصف جلسة WebRTC (SDP) الذي يولده المتصل.	‏‏نعم‬
جلسة	OpenAI.RealtimeSessionCreateRequestGA	تكوين كائن جلسة العمل في الوقت الحقيقي.	لا
└─ الصوت	OpenAI.RealtimeSessionCreateRequestGAAudio	تكوين الصوت المدخل والإخراج.	لا
└─ تشمل	صفيف سلسلة	حقول إضافية يجب تضمينها في مخرجات الخادم. item.input_audio_transcription.logprobs: تضمين logprobs لنقل الصوت المدخل.	لا
└─ تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وصيغتها، (مثل "كن موجزا للغاية"، "تصرف وديا"، "إليك أمثلة على الردود الجيدة") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر في صوتك"، "ضحك كثيرا"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.	لا
└─ max_output_tokens	عدد صحيح (انظر النماذج الصحيحة أدناه)	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحدة، بما في ذلك استدعاءات الأدوات. قدم عددا صحيحا بين 1 و 4096 إلى تحديد رموز الإخراج، أو inf الحد الأقصى المتاح للرموز ل النموذج المعطى. الإعدادات الافتراضية لـ inf.	لا
└─ نموذج	string	النموذج الزمني المستخدم لهذه الجلسة.	لا
└─ output_modalities	صفيف سلسلة	مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. يتم تلقائيا إلى ["audio"]، مما يشير إلى وأن النموذج سيرد بالصوت بالإضافة إلى نص مكتوب. ["text"] يمكن استخدامها لصنع يرد النموذج بالنص فقط. لا يمكن طلب الاثنين textaudio معا في نفس الوقت.	لا	['صوت']
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
└─ tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceFunction أو OpenAI.ToolChoiceMCP	كيف يختار النموذج الأدوات. قدم أحد أوضاع الوتر أو فرض على وضع معين أداة الدالة/MCP.	لا	تلقائي
└─ الأدوات	مصفوفة من OpenAI.RealtimeFunctionTool أو OpenAI.MCPTool	الأدوات المتاحة للنموذج.	لا
└─ التتبع	string أو OpenAI.RealtimeSessionCreateRequestGATracing أو null	"" ضبطه على الصفر لتعطيل التتبع. مرة واحدة يتم تفعيل التتبع للجلسة، ولا يمكن تعديل التكوين. auto سيقوم بإنشاء تتبع للجلسة مع قيم افتراضية ل اسم سير العمل، معرف المجموعة، والبيانات الوصفية.	لا	تلقائي
└─ الاقتطاع	OpenAI.RealtimeCutncation	عندما يتجاوز عدد الرموز في المحادثة حد رموز الإدخال في النموذج، يتم اختصار المحادثة، مما يعني أن الرسائل (التي تبدأ من الأقدم) لن تدرج في سياق النموذج. نموذج السياق 32k مع 4,096 رمز إخراج أقصى يمكنه فقط تضمين 28,224 رمزا في السياق قبل حدوث القطع. يمكن للعملاء تكوين سلوك القطع بحيث يتم القطع بحد أقصى أقل للرمز، وهو طريقة فعالة للتحكم في استخدام الرموز وتكلفتها. القطع سيقلل عدد الرموز المخزنة في الدور التالي (مما يؤدي إلى تدمير الكاش)، لأن الرسائل تسقط من بداية السياق. ومع ذلك، يمكن للعملاء أيضا تكوين القطع للاحتفاظ بالرسائل حتى جزء بسيط من الحد الأقصى لحجم السياق، مما يقلل الحاجة إلى القطع المستقبلي وبالتالي يحسن معدل الكاش. يمكن تعطيل القطع تماما، مما يعني أن الخادم لن يقطع أبدا بل سيعيد خطأ إذا تجاوزت المحادثة حد رموز الإدخال في النموذج.	لا
└─ النوع	enum	نوع الجلسة التي يجب إنشاؤها. دائما realtime لواجهة برمجة التطبيقات في الوقت الحقيقي. القيم المحتملة: realtime	‏‏نعم‬

الاستجابات

رمز الحالة: 201

الوصف: نجح الطلب وتم إنشاء مورد جديد نتيجة لذلك.

Content-Type	نوع	الوصف
التطبيق/SDP	string

عناوين الاستجابة:

عنوان	النوع	وصف
مكان	string	رابط الرابط النسبي الذي يحتوي على معرف النداء لطلبات التحكم اللاحقة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

قبول المكالمة الفورية

POST {endpoint}/openai/v1/realtime/calls/{call_id}/accept

قبول مكالمة SIP واردة وقم بتكوين الجلسة الفورية التي ستتعامل معها.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
صوتي	OpenAI.RealtimeSessionCreateRequestGAAudio		لا
└─ المدخلات	OpenAI.RealtimeSessionCreateRequestGAAudioInput		لا
└─ الإخراج	OpenAI.RealtimeSessionCreateRequestGAAudioOutput		لا
include	صفيف سلسلة	حقول إضافية يجب تضمينها في مخرجات الخادم. item.input_audio_transcription.logprobs: تضمين logprobs لنقل الصوت المدخل.	لا
تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وصيغتها، (مثل "كن موجزا للغاية"، "تصرف وديا"، "إليك أمثلة على الردود الجيدة") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر في صوتك"، "ضحك كثيرا"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.	لا
max_output_tokens	عدد صحيح (انظر النماذج الصحيحة أدناه)	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحدة، بما في ذلك استدعاءات الأدوات. قدم عددا صحيحا بين 1 و 4096 إلى تحديد رموز الإخراج، أو inf الحد الأقصى المتاح للرموز ل النموذج المعطى. الإعدادات الافتراضية لـ inf.	لا
نموذج	string	النموذج الزمني المستخدم لهذه الجلسة.	لا
output_modalities	صفيف سلسلة	مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. يتم تلقائيا إلى ["audio"]، مما يشير إلى وأن النموذج سيرد بالصوت بالإضافة إلى نص مكتوب. ["text"] يمكن استخدامها لصنع يرد النموذج بالنص فقط. لا يمكن طلب الاثنين textaudio معا في نفس الوقت.	لا	['صوت']
فوري	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceFunction أو OpenAI.ToolChoiceMCP	كيف يختار النموذج الأدوات. قدم أحد أوضاع الوتر أو فرض على وضع معين أداة الدالة/MCP.	لا
الأدوات	مصفوفة من OpenAI.RealtimeFunctionTool أو OpenAI.MCPTool	الأدوات المتاحة للنموذج.	لا
tracing	string أو OpenAI.RealtimeSessionCreateRequestGATracing أو null	"" ضبطه على الصفر لتعطيل التتبع. مرة واحدة يتم تفعيل التتبع للجلسة، ولا يمكن تعديل التكوين. auto سيقوم بإنشاء تتبع للجلسة مع قيم افتراضية ل اسم سير العمل، معرف المجموعة، والبيانات الوصفية.	لا
اقتطاع	OpenAI.RealtimeCutncation	عندما يتجاوز عدد الرموز في المحادثة حد رموز الإدخال في النموذج، يتم اختصار المحادثة، مما يعني أن الرسائل (التي تبدأ من الأقدم) لن تدرج في سياق النموذج. نموذج السياق 32k مع 4,096 رمز إخراج أقصى يمكنه فقط تضمين 28,224 رمزا في السياق قبل حدوث القطع. يمكن للعملاء تكوين سلوك القطع بحيث يتم القطع بحد أقصى أقل للرمز، وهو طريقة فعالة للتحكم في استخدام الرموز وتكلفتها. القطع سيقلل عدد الرموز المخزنة في الدور التالي (مما يؤدي إلى تدمير الكاش)، لأن الرسائل تسقط من بداية السياق. ومع ذلك، يمكن للعملاء أيضا تكوين القطع للاحتفاظ بالرسائل حتى جزء بسيط من الحد الأقصى لحجم السياق، مما يقلل الحاجة إلى القطع المستقبلي وبالتالي يحسن معدل الكاش. يمكن تعطيل القطع تماما، مما يعني أن الخادم لن يقطع أبدا بل سيعيد خطأ إذا تجاوزت المحادثة حد رموز الإدخال في النموذج.	لا
النوع	enum	نوع الجلسة التي يجب إنشاؤها. دائما realtime لواجهة برمجة التطبيقات في الوقت الحقيقي. القيم المحتملة: realtime	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنهاء المكالمة في الوقت الحقيقي

POST {endpoint}/openai/v1/realtime/calls/{call_id}/hangup

إنهاء استدعاء API نشط في الوقت الحقيقي، سواء تم تشغيله عبر SIP أو WebRTC.

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

يرجى الإشارة إلى الاتصال الفوري.

POST {endpoint}/openai/v1/realtime/calls/{call_id}/refer

نقل استدعاء SIP نشط إلى وجهة جديدة باستخدام فعل SIP REFER.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
target_uri	string	URI الذي يجب أن يظهر في رأس SIP Refer-To. يدعم القيم مثل tel:+14155550123 أو sip:agent\@example.com.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

رفض المكالمة في الوقت الحقيقي

POST {endpoint}/openai/v1/realtime/calls/{call_id}/reject

رفض مكالمة SIP الواردة بإعادة رمز حالة SIP إلى المتصل.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
status_code	integer	رمز استجابة SIP لإرسالها إلى المتصل. الإعدادات الافتراضية إلى 603 (تراجع) عندما يتم حذفها.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء سر العميل في الوقت الحقيقي

POST {endpoint}/openai/v1/realtime/client_secrets

أنشئ سر عميل في الوقت الحقيقي مع تكوين جلسة مرتبط.

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_after	OpenAI.RealtimeCreateClientSecretRequestexpiresAfter		لا
└─ مرساة	enum	القيم المحتملة: created_at	لا
└─ ثواني	integer	القيود: الحد الأدنى: 10، الحد الأقصى: 7200	لا	600
جلسة	OpenAI.RealtimeSessionCreateRequestUnion		لا
└─ النوع	OpenAI.RealtimeSessionCreateRequestUnionType		‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RealtimeCreateClientSecretResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/realtime/sessions

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
client_secret	OpenAI.RealtimeSessionCreateRequestClientSecret		‏‏نعم‬
└─ expires_at	integer		‏‏نعم‬
└─ القيمة	string		‏‏نعم‬
input_audio_format	string	تنسيق صوت الإدخال. الخيارات هي pcm16أو g711_ulawأو g711_alaw.	لا
input_audio_transcription	OpenAI.RealtimeSessionCreateRequestInputAudioTranscription		لا
└─ نموذج	string		لا
تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وصيغتها، (مثل "كن موجزا للغاية"، "تصرف وديا"، "إليك أمثلة على الردود الجيدة") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر في صوتك"، "ضحك كثيرا"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.	لا
max_response_output_tokens	عدد صحيح (انظر النماذج الصحيحة أدناه)	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحدة، بما في ذلك استدعاءات الأدوات. قدم عددا صحيحا بين 1 و 4096 إلى تحديد رموز الإخراج، أو inf الحد الأقصى المتاح للرموز ل النموذج المعطى. الإعدادات الافتراضية لـ inf.	لا
طرائق	صفيف سلسلة	مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، اضبط هذا على ["نص"].	لا	['نص'، 'صوت']
output_audio_format	string	تنسيق صوت الإخراج. الخيارات هي pcm16أو g711_ulawأو g711_alaw.	لا
فوري	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
speed	رقم	سرعة استجابة النموذج المنطوقة. 1.0 هي السرعة الافتراضية. 0.25 هو السرعة الدنيا فقط. 1.5 هي السرعة القصوى. يمكن تغيير هذه القيمة فقط بين أدوار النموذج، ليس أثناء حدوث الرد. القيود: الحد الأدنى: 0.25، الحد الأقصى: 1.5	لا	1
درجة الحرارة	رقم	درجة حرارة أخذ العينات للنموذج، تقتصر على [0.6، 1.2]. الإعدادات الافتراضية إلى 0.8.	لا
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي auto، none، required، أو حدد دالة.	لا
الأدوات	مصفوفة من OpenAI.RealtimeSessionCreateRequestTools	الأدوات (الوظائف) المتوفرة للنموذج.	لا
tracing	سلسلة أو كائن	خيارات التكوين للتتبع. ضبطه على الصفر لتعطيل التتبع. مرة واحدة يتم تفعيل التتبع للجلسة، ولا يمكن تعديل التكوين. auto سيقوم بإنشاء تتبع للجلسة مع قيم افتراضية ل اسم سير العمل، معرف المجموعة، والبيانات الوصفية.	لا
اقتطاع	OpenAI.RealtimeCutncation	عندما يتجاوز عدد الرموز في المحادثة حد رموز الإدخال في النموذج، يتم اختصار المحادثة، مما يعني أن الرسائل (التي تبدأ من الأقدم) لن تدرج في سياق النموذج. نموذج السياق 32k مع 4,096 رمز إخراج أقصى يمكنه فقط تضمين 28,224 رمزا في السياق قبل حدوث القطع. يمكن للعملاء تكوين سلوك القطع بحيث يتم القطع بحد أقصى أقل للرمز، وهو طريقة فعالة للتحكم في استخدام الرموز وتكلفتها. القطع سيقلل عدد الرموز المخزنة في الدور التالي (مما يؤدي إلى تدمير الكاش)، لأن الرسائل تسقط من بداية السياق. ومع ذلك، يمكن للعملاء أيضا تكوين القطع للاحتفاظ بالرسائل حتى جزء بسيط من الحد الأقصى لحجم السياق، مما يقلل الحاجة إلى القطع المستقبلي وبالتالي يحسن معدل الكاش. يمكن تعطيل القطع تماما، مما يعني أن الخادم لن يقطع أبدا بل سيعيد خطأ إذا تجاوزت المحادثة حد رموز الإدخال في النموذج.	لا
turn_detection	OpenAI.RealtimeSessionCreateRequestTurnDetection		لا
└─ prefix_padding_ms	integer		لا
└─ silence_duration_ms	integer		لا
└─ عتبة	رقم		لا
└─ النوع	string		لا
النوع	enum	القيم المحتملة: realtime	‏‏نعم‬
صوت	OpenAI.VoiceIdsShared		لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RealtimeSessionCreateResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/realtime/transcription_sessions

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
include	صفيف سلسلة	مجموعة العناصر المراد تضمينها في النسخ. العناصر المتوفرة الحالية هي: item.input_audio_transcription.logprobs	لا
input_audio_format	enum	تنسيق صوت الإدخال. الخيارات هي pcm16أو g711_ulawأو g711_alaw. بالنسبة ل pcm16، يجب أن يكون الصوت المدخل PCM 16-بت بمعدل عينة 24 كيلوهرتز، وترتيب بايت القناة الواحدة (أحادي)، وترتيب بايت النهاية الصغيرة. القيم المحتملة: pcm16، ، g711_ulawg711_alaw	لا
input_audio_noise_reduction	OpenAI.RealtimeTranscriptionSessionCreateRequestInput AudioNoiseReduction		لا
└─ النوع	OpenAI.NoiseReductionType	نوع الحد من الضوضاء. near_field للميكروفونات القريبة مثل سماعات الرأس، far_field مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات.	لا
input_audio_transcription	OpenAI.AudioTranscription		لا
└─ اللغة	string	لغة صوت الإدخال. توفير لغة الإدخال في تنسيق ISO-639-1 (مثل en) سيحسن الدقة والتأخير.	لا
└─ نموذج	string	النموذج الذي يجب استخدامه للنسخ. الخيارات الحالية هي whisper-1، gpt-4o-mini-transcribe، gpt-4o-mini-transcribe-2025-12-15، gpt-4o-transcribe، و gpt-4o-transcribe-diarize. استخدمها gpt-4o-transcribe-diarize عندما تحتاج إلى توثيق مع تسميات السماعات.	لا
└─ موجه	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار صوت سابق القطاع. ل whisper-1، الموضوع هو قائمة بالكلمات المفتاحية. بالنسبة للنماذج gpt-4o-transcribe (باستثناء gpt-4o-transcribe-diarizeالنماذج )، فإن التوجيه هو سلسلة نصية حرة، مثل "توقع كلمات متعلقة بالتكنولوجيا".	لا
turn_detection	OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection		لا
└─ prefix_padding_ms	integer		لا
└─ silence_duration_ms	integer		لا
└─ عتبة	رقم		لا
└─ النوع	enum	القيم المحتملة: server_vad	لا
النوع	enum	القيم المحتملة: transcription	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RealtimeTranscriptionSessionCreateResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الاستجابات

إنشاء استجابة

POST {endpoint}/openai/v1/responses

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
background	بوليان أو نول		لا
حوار	OpenAI.ConversationParam أو null		لا
include	مصفوفة OpenAI.IncludeEnum أو null		لا
الادخال	OpenAI.InputParam	النص أو الصورة أو إدخالات الملفات إلى النموذج، المستخدمة لإنشاء استجابة. اعرف المزيد‬: - مدخلات ومخرجات النص - إدخالات الصور - إدخالات الملفات - حالة المحادثة - استدعاء الدالة	لا
تعليمات	سلسلة أو قيمة خالية		لا
max_output_tokens	عدد صحيح أو صفري		لا
max_tool_calls	عدد صحيح أو صفري		لا
metadata	OpenAI.Metadata أو null		لا
نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	لا
parallel_tool_calls	بوليان أو نول		لا
previous_response_id	سلسلة أو قيمة خالية		لا
فوري	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
prompt_cache_retention	سلسلة أو قيمة خالية		لا
المنطق	OpenAI.Reasoning أو null		لا
safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
store	بوليان أو نول		لا
استدر	بوليان أو نول		لا
stream_options	OpenAI.ResponseStreamOptions أو null		لا
درجة الحرارة	عدد أو صفرا		لا
نص	OpenAI.ResponseTextParam	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
tool_choice	OpenAI.ToolChoiceParam	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
الأدوات	OpenAI.ToolsArray	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . ندعم الفئات التالية من الأدوات: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. معرفة المزيد حول الأدوات المضمنة. - أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو موصلات معرفة مسبقا مثل Google Drive وSharePoint. معرفة المزيد حول أدوات MCP. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك باستخدام وسيطات مكتوبة بقوة والمخرجات. معرفة المزيد حول استدعاء الدالة. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.	لا
top_logprobs	عدد صحيح أو صفري		لا
top_p	عدد أو صفرا		لا
اقتطاع	سلسلة أو قيمة خالية		لا
user	سلسلة (مهملة)	يتم استبدال هذا الحقل ب safety_identifier و prompt_cache_key. استخدم prompt_cache_key بدلا من ذلك للحفاظ على تحسينات التخزين المؤقت. معرف ثابت للمستخدمين النهائيين. يستخدم لزيادة معدلات الوصول إلى ذاكرة التخزين المؤقت عن طريق تجميع الطلبات المماثلة بشكل أفضل ولمساعدة OpenAI في اكتشاف إساءة الاستخدام ومنعها. تعرّف على المزيد.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الأمثلة

مثال

POST {endpoint}/openai/v1/responses

احصل على استجابة

GET {endpoint}/openai/v1/responses/{response_id}

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة تطبيقات نماذج Azure الذكاء الاصطناعي Foundry الصريح لاستخدامه لهذا الطلب. v1 إذا لم يتم تحديد خلاف ذلك.
response_id	path	‏‏نعم‬	string
تشمل []	استعلام	لا	صفيف	حقول إضافية لتضمينها في الاستجابة. راجع معامل التضمين لإنشاء الاستجابة أعلاه لمزيد من المعلومات.
استدر	استعلام	لا	boolean	إذا تم تعيينها إلى true، دفق بيانات استجابة النموذج إلى العميل كما يتم إنشاؤها باستخدام الأحداث المرسلة من الخادم.
starting_after	استعلام	لا	integer	رقم تسلسل الحدث الذي يبدأ بعده البث.
include_obfuscation	استعلام	لا	boolean	عندما يكون هذا صحيحا، سيتم تمكين تشويش الدفق. يضيف تشويش الدفق أحرفا عشوائية obfuscation إلى حقل في أحداث دلتا المتدفقة لتطبيع أحجام الحمولة كتخفيف لبعض هجمات القنوات الجانبية. يتم تضمين حقول التعتيم هذه افتراضيا، ولكنها تضيف قدرا صغيرا من النفقات العامة إلى دفق البيانات. يمكنك التعيين include_obfuscation على false لتحسين النطاق الترددي إذا كنت تثق في روابط الشبكة بين تطبيقك وواجهة برمجة تطبيقات OpenAI.

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف الرد

DELETE {endpoint}/openai/v1/responses/{response_id}

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إلغاء الاستجابة

POST {endpoint}/openai/v1/responses/{response_id}/cancel

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

سرد عناصر الإدخال

GET {endpoint}/openai/v1/responses/{response_id}/input_items

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ResponseItemList

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

المواضيع

إنشاء الموضوع

POST {endpoint}/openai/v1/threads

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
messages	مصفوفة OpenAI.CreateMessageRequest	قائمة بالرسائل لبدء الموضوع.	لا
metadata	OpenAI.Metadata أو null		لا
tool_resources	OpenAI.CreateThreadRequestToolResources أو null		لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ThreadObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء الموضوع وتشغيل

POST {endpoint}/openai/v1/threads/runs

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
assistant_id	string	معرف المساعد الذي سيستخدم لتنفيذ هذه الجولة.	‏‏نعم‬
تعليمات	سلسلة أو قيمة خالية	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
max_completion_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. ستبذل الجولة قصارى جهدها لاستخدام عدد رموز الإكمال المحددة فقط، عبر عدة أدوار من الجولة. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.	لا
max_prompt_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. ستبذل الجولة أقصى جهد لاستخدام عدد رموز الأوامر المحددة فقط، عبر عدة أدوار من الجولة. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.	لا
metadata	OpenAI.Metadata أو null		لا
نموذج	string	معرف النموذج المستخدم لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	لا
parallel_tool_calls	OpenAI.ParallelToolCalls	ما إذا كنت تريد تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا
response_format	OpenAI.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 الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
استدر	بوليان أو نول	إذا true، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة data: [DONE].	لا
درجة الحرارة	عدد أو صفرا	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا
thread	OpenAI.CreateThreadRequest	خيارات لإنشاء موضوع جديد. إذا لم يتم توفير خيط عند تشغيل طلب، سيتم إنشاء خيط فارغ.	لا
tool_choice	OpenAI.AssistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. auto هي القيمة الافتراضية وتعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. required يعني أن النموذج يجب أن يستدعي أداة أو أكثر قبل الرد على المستخدم. تحديد أداة معينة مثل {"type": "file_search"} أو {"type": "function", "function": {"name": "my_function"}} يجبر النموذج على استدعاء تلك الأداة.	لا
tool_resources	OpenAI.CreateThreadAndRunRequestToolResources أو null	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة code_interpreter قائمة بمعرفات الملفات، بينما تتطلب أداة file_search قائمة بمعرفات مخزن المتجهات.	لا
الأدوات	مصفوفة من OpenAI.AssistantTool	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
top_p	عدد أو صفرا	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا
truncation_strategy	OpenAI.CutncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RunObject

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف الموضوع

DELETE {endpoint}/openai/v1/threads/{thread_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.DeleteThreadResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرجاع الخيط

GET {endpoint}/openai/v1/threads/{thread_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ThreadObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

تعديل الخيط

POST {endpoint}/openai/v1/threads/{thread_id}

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata أو null		لا
tool_resources	OpenAI.ModifyThreadRequestToolResources أو null		لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ThreadObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

GET {endpoint}/openai/v1/threads/{thread_id}/messages

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة تطبيقات نماذج Azure الذكاء الاصطناعي Foundry الصريح لاستخدامه لهذا الطلب. v1 إذا لم يتم تحديد خلاف ذلك.
thread_id	path	‏‏نعم‬	string
الحد	استعلام	لا	integer
order	استعلام	لا	string القيم المحتملة: asc، desc
after	استعلام	لا	string
قبل	استعلام	لا	string
run_id	استعلام	لا	string

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListMessagesResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء رسالة

POST {endpoint}/openai/v1/threads/{thread_id}/messages

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
attachments	مصفوفة من OpenAI.CreateMessageRequestAttachments أو null		لا
محتوى	سلسلة أو مصفوفة من OpenAI.MessageContentImageFileObject أو OpenAI.MessageContentImageUrlObject أو OpenAI.MessageRequestContentTextObject		‏‏نعم‬
metadata	OpenAI.Metadata أو null		لا
role	enum	دور الكيان الذي يقوم بإنشاء الرسالة. تتضمن القيم المسموح بها ما يلي: - user: يشير إلى أن الرسالة يتم إرسالها بواسطة مستخدم فعلي ويجب استخدامها في معظم الحالات لتمثيل الرسائل التي أنشأها المستخدم. - assistant: يشير إلى إنشاء الرسالة بواسطة المساعد. استخدم هذه القيمة لإدراج رسائل من المساعد في المحادثة. القيم المحتملة: user، assistant	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.MessageObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

حذف الرسَالة

DELETE {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.DeleteMessageResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرجاع الرسالة

GET {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.MessageObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

تعديل الرسالة

POST {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata أو null		لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.MessageObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إنشاء جولة

POST {endpoint}/openai/v1/threads/{thread_id}/runs

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
additional_instructions	سلسلة أو قيمة خالية	إلحاق إرشادات إضافية في نهاية التعليمات الخاصة بالتشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل دون تجاوز إرشادات أخرى.	لا
additional_messages	مصفوفة OpenAI.CreateMessageRequest أو null	إضافة رسائل إضافية إلى مؤشر الترابط قبل إنشاء التشغيل.	لا
assistant_id	string	معرف المساعد الذي سيستخدم لتنفيذ هذه الجولة.	‏‏نعم‬
تعليمات	سلسلة أو قيمة خالية	يتجاوز تعليمات المساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
max_completion_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. ستبذل الجولة قصارى جهدها لاستخدام عدد رموز الإكمال المحددة فقط، عبر عدة أدوار من الجولة. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.	لا
max_prompt_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. ستبذل الجولة أقصى جهد لاستخدام عدد رموز الأوامر المحددة فقط، عبر عدة أدوار من الجولة. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.	لا
metadata	OpenAI.Metadata أو null		لا
نموذج	string	معرف النموذج المستخدم لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	لا
parallel_tool_calls	OpenAI.ParallelToolCalls	ما إذا كنت تريد تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا
reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
response_format	OpenAI.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 الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
استدر	بوليان أو نول	إذا true، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة data: [DONE].	لا
درجة الحرارة	عدد أو صفرا	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا
tool_choice	OpenAI.AssistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. auto هي القيمة الافتراضية وتعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. required يعني أن النموذج يجب أن يستدعي أداة أو أكثر قبل الرد على المستخدم. تحديد أداة معينة مثل {"type": "file_search"} أو {"type": "function", "function": {"name": "my_function"}} يجبر النموذج على استدعاء تلك الأداة.	لا
الأدوات	مصفوفة من OpenAI.AssistantTool	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
top_p	عدد أو صفرا	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا
truncation_strategy	OpenAI.CutncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RunObject

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

قوائم الرحلات

GET {endpoint}/openai/v1/threads/{thread_id}/runs

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة تطبيقات نماذج Azure الذكاء الاصطناعي Foundry الصريح لاستخدامه لهذا الطلب. v1 إذا لم يتم تحديد خلاف ذلك.
thread_id	path	‏‏نعم‬	string
الحد	استعلام	لا	integer
order	استعلام	لا	string القيم المحتملة: asc، desc
after	استعلام	لا	string
قبل	استعلام	لا	string

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListRunsResponse

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

استرجاع السلسلة

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RunObject

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

تعديل السلسلة

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata أو null		لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RunObject

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

إلغاء الجولة

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/cancel

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RunObject

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

خطوات الجدول

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string	دعم Azure نقاط نهاية OpenAI (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI الخاص بك). https://{your-resource-name}.openai.azure.com
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة تطبيقات نماذج Azure الذكاء الاصطناعي Foundry الصريح لاستخدامه لهذا الطلب. v1 إذا لم يتم تحديد خلاف ذلك.
thread_id	path	‏‏نعم‬	string
run_id	path	‏‏نعم‬	string
الحد	استعلام	لا	integer
order	استعلام	لا	string القيم المحتملة: asc، desc
after	استعلام	لا	string
قبل	استعلام	لا	string

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListRunStepsResponse

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

خطوة الركض

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RunStepObject

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

تقديم مخرجات الأدوات للتشغيل

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
استدر	بوليان أو نول		لا
tool_outputs	مصفوفة من OpenAI.SubmitToolOutputsRunRequestToolOutputs	قائمة بالأدوات التي يتم إرسال المخرجات لها.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.RunObject

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

متاجر فيكتور

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

GET {endpoint}/openai/v1/vector_stores

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListVectorStoresResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/vector_stores

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية auto . ينطبق فقط إذا كان file_ids غير فارغ.	لا
الوصف	string	وصف لمتجر المتجهات. يمكن استخدامه لوصف هدف متجر المتجهات.	لا
expires_after	OpenAI.VectorStoreExpirationبعد	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
file_ids	صفيف سلسلة	قائمة بمعرفات الملفات التي يجب أن يستخدمها المخزن المتجه. مفيد لأدوات مثل file_search التي يمكنها الوصول إلى الملفات.	لا
metadata	OpenAI.Metadata أو null		لا
الاسم	string	اسم مخزن المتجهات.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الأمثلة

مثال

POST {endpoint}/openai/v1/vector_stores

احصل على متجر vector

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_after	OpenAI.VectorStoreExpirationبعد	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
metadata	OpenAI.Metadata أو null		لا
الاسم	سلسلة أو قيمة خالية	اسم مخزن المتجهات.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.DeleteVectorStoreResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		لا
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية auto . ينطبق فقط إذا كان file_ids غير فارغ.	لا
file_ids	صفيف سلسلة	قائمة بمعرفات الملفات التي يجب أن يستخدمها المخزن المتجه. مفيد لأدوات مثل file_search التي يمكنها الوصول إلى الملفات. إذا attributes تم توفيرها أو chunking_strategy تم توفيرها، فسيتم تطبيقها على جميع الملفات في الدفعة. غير متعارضين مع files.	لا
files	مصفوفة OpenAI.CreateVectorStoreFileRequest	قائمة بالكائنات التي تحتوي file_id كل منها على جمع أو اختياري attributes أو chunking_strategy. استخدم هذا عندما تحتاج إلى تجاوز البيانات الوصفية لملفات محددة. سيتم تجاهل الرقم العام (or chunking_strategy العموميattributes) ويجب تحديده لكل ملف. غير متعارضين مع file_ids.	لا

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreFileBatchObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreFileBatchObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreFileBatchObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListVectorStoreFilesResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.ListVectorStoreFilesResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

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

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		لا
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية auto . ينطبق فقط إذا كان file_ids غير فارغ.	لا
file_id	string	معرف ملف يجب أن يستخدمه متجر المتجهات. مفيد لأدوات مثل file_search التي يمكنها الوصول إلى الملفات.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreFileObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

الحصول على ملف مخزن vector

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreFileObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

معلمات URI

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		‏‏نعم‬

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreFileObject

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.DeleteVectorStoreFileResponse

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}/content

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

معلمات URI

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreSearchResultsPage

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/search

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

معلمات URI

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

الوصف: نجح الطلب.

Content-Type	نوع	الوصف
application/json	OpenAI.VectorStoreSearchResultsPage

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

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

الوصف: استجابة خطأ غير متوقعة.

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

عناوين الاستجابة:

عنوان	النوع	وصف
apim-request-id	string	معرف الطلب المستخدم لأغراض استكشاف المشكلة.

مكونات

مقطع الصوت

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

AudioTaskLabel

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

الخاصية	قيمة
الوصف	يحدد الواصفات المحتملة لاستجابات عمليات الصوت المتوفرة.
نوع	string
Values	transcribe translate

الترجمة الصوتية

معلومات موسعة حول مقطع واحد من البيانات الصوتية المترجمة. تمثل المقاطع بشكل عام ما يقرب من 5-10 ثوان من الكلام. عادة ما تحدث حدود المقطع بين الكلمات ولكن ليس بالضرورة الجمل.

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

AzureAIFoundryModelsApiVersion

الخاصية	قيمة
نوع	string
Values	v1 preview

AzureAudioTranscriptionResponse

معلومات النتيجة لعملية نسخت الصوت المنطوق إلى نص مكتوب.

الاسم	النوع	وصف	مطلوب	الإفتراضي
duration	رقم	المدة الإجمالية للصوت المعالج لإنتاج معلومات النسخ المصاحبة.	لا
اللغة	string	اللغة المنطوقة التي تم الكشف عنها في البيانات الصوتية المنسوخة. يتم التعبير عن ذلك كتعلم برمجي للغة ISO-639-1 من حرفين مثل "en" أو "fr".	لا
segments	مصفوفة من OpenAI.TranscriptionSegment	مجموعة من المعلومات حول التوقيت والاحتمالات وتفاصيل أخرى لكل مقطع صوتي تمت معالجته.	لا
مهمة	أوديو تاسك ليبل	يحدد الواصفات المحتملة لاستجابات عمليات الصوت المتوفرة.	لا
نص	string	النص المنسوخ للبيانات الصوتية المقدمة.	‏‏نعم‬
words	مصفوفة OpenAI.TranscriptionWord	مجموعة من المعلومات حول توقيت كل كلمة تمت معالجتها.	لا

AzureAudioTranslationResponse

معلومات النتائج لعملية ترجمت الصوت المنطوق إلى نص مكتوب.

الاسم	النوع	وصف	مطلوب	الإفتراضي
duration	رقم	المدة الإجمالية للصوت الذي تمت معالجته لإنتاج معلومات الترجمة المصاحبة.	لا
اللغة	string	اللغة المنطوقة التي تم اكتشافها في البيانات الصوتية المترجمة. يتم التعبير عن ذلك كتعلم برمجي للغة ISO-639-1 من حرفين مثل "en" أو "fr".	لا
segments	مجموعة من AudioTranslationSegment	مجموعة من المعلومات حول التوقيت والاحتمالات وتفاصيل أخرى لكل مقطع صوتي تمت معالجته.	لا
مهمة	أوديو تاسك ليبل	يحدد الواصفات المحتملة لاستجابات عمليات الصوت المتوفرة.	لا
نص	string	النص المترجم للبيانات الصوتية المقدمة.	‏‏نعم‬

AzureCompletionsSamplingParams

معايير أخذ عينات للتحكم في سلوك الإكمالات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_completion_tokens	integer		لا
max_tokens	integer	الحد الأقصى لعدد الرموز المميزة في الإخراج الذي تم إنشاؤه.	لا
reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
response_format	OpenAI.ResponseFormatText أو OpenAI.ResponseFormatJsonSchema أو OpenAI.ResponseFormatJsonObject		لا
seed	integer	قيمة البذرة تهيئ العشوائية أثناء أخذ العينة.	لا	42
درجة الحرارة	رقم	تزيد درجة الحرارة الأعلى من العشوائية في المخرجات.	لا	1
الأدوات	صفيف OpenAI.ChatCompletionTool		لا
top_p	رقم	بديل لدرجة الحرارة لأخذ عينات النواة؛ يتضمن 1.0 جميع الرموز المميزة.	لا	1

AzureContentFilterBlocklistIdResult

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
filtered	boolean	ما إذا كانت قائمة الحظر المرتبطة تؤدى إلى تصفية المحتوى.	‏‏نعم‬
المعرف	string	معرف قائمة الحظر المخصصة المرتبطة بالحالة المصفاة.	‏‏نعم‬

AzureContentFilterBlocklistResult

مجموعة من نتائج تصفية صواب/خطأ لقوائم الحظر المخصصة التي تم تكوينها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
details	صفيف من العناصر	أزواج معرفات قائمة الحظر الفردية وما إذا كانت أدت إلى إجراء تصفية.	لا
filtered	boolean	قيمة تشير إلى ما إذا كانت أي من قوائم الحظر التفصيلية قد أدت إلى إجراء تصفية أم لا.	‏‏نعم‬

AzureContentFilterCompletionTextSpan

تمثيل لنطاق نص الإكمال كما هو مستخدم في نتائج تصفية المحتوى في Azure OpenAI.

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

AzureContentFilterCompletionTextSpanDetectionResult

الاسم	النوع	وصف	مطلوب	الإفتراضي
details	array of AzureContentFilterCompletionTextSpan	معلومات مفصلة حول امتدادات نص الإكمال المكتشفة.	‏‏نعم‬
detected	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
filtered	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬

AzureContentFilterCustomTopicIdResult

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
detected	boolean	ما إذا كان الموضوع المخصص المرتبط هو ما أدى إلى اكتشاف المحتوى.	‏‏نعم‬
المعرف	string	معرف الموضوع المخصص المرتبط بالحالة التي تم اكتشافها.	‏‏نعم‬

AzureContentFilterCustomTopicResult

مجموعة من نتائج تصفية صواب/خطأ للموضوعات المخصصة التي تم تكوينها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
details	صفيف من العناصر	أزواج معرفات الموضوعات الفردية وما إذا كان قد تم اكتشافها.	لا
filtered	boolean	قيمة تشير إلى ما إذا كان أي من الموضوعات التفصيلية قد أدى إلى إجراء تصفية أم لا.	‏‏نعم‬

AzureContentFilterDetectionResult

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
detected	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
filtered	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬

AzureContentFilterForResponsesAPI

الاسم	النوع	وصف	مطلوب	الإفتراضي
تم حجبها	boolean	أشر إذا كان الرد محجوبا.	‏‏نعم‬
content_filter_offsets	AzureContentFilterResultOffsets		‏‏نعم‬
content_filter_results	AzureContentFilterResultsForResponsesAPI		‏‏نعم‬
└─ custom_blocklists	AzureContentFilterBlocklistResult	مجموعة من نتائج التصفية الثنائية لقوائم حظر مخصصة مهيأة.	لا
└─ custom_topics	AzureContentFilterCustomTopicResult	مجموعة من نتائج التصفية الثنائية لمواضيع مخصصة مهيأة.	لا
└─ خطأ	object	في حالة وجودها، تفاصيل حول خطأ منع تصفية المحتوى من إكمال تقييمها.	لا
└─ كود	integer	رمز مميز يمكن قراءته آليا مرتبط بالخطأ.	‏‏نعم‬
└─ رسالة	string	رسالة يمكن للبشر قراءتها مقترنة بالخطأ.	‏‏نعم‬
└─ الكراهية	AzureContentFilterSeverityResult	فئة مرشح المحتوى يمكن أن تشير إلى أي محتوى يهاجم أو يستخدم ألفا سلبية أو تمييزية لغة تشير إلى شخص أو مجموعة هوية بناء على بعض السمات المميزة لهذه المجموعات بما في ذلك على سبيل المثال لا الحصر، العرق، الإثنية، الجنسية، الهوية الجندرية والتعبير، التوجه الجنسي، الدين، حالة الهجرة، حالة القدرة، المظهر الشخصي، وحجم الجسم.	لا
└─ indirect_attack	AzureContentFilterDetectionResult	نتيجة كشف تصف هجمات على أنظمة مدعومة بنماذج ذكاء اصطناعي توليدي يمكن أن تحدث في كل مرة يعالج التطبيق معلومات لم تكن من تأليف مطور التطبيق أو المطور مباشرة المستخدم.	لا
└─ الهروب من السجن	AzureContentFilterDetectionResult	نتيجة اكتشاف تصف هجمات حقن الأوامر من المستخدم، حيث يستغل المستخدمون الخبيثون عمدا ثغرات النظام لإثارة سلوك غير مصرح به من نموذج اللغة الكبير. قد يؤدي ذلك إلى محتوى غير لائق توليد أو انتهاكات القيود التي فرضها النظام.	‏‏نعم‬
└─ personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	نتيجة اكتشاف تصف تطابقات مع معلومات شخصية قابلة للتعرف مع فئات فرعية قابلة للتكوين.	لا
└─ الألفاظ النابية	AzureContentFilterDetectionResult	نتيجة كشف تحدد ما إذا كانت لغة اعتراض بدائية أو فظة أو غير متدرجة في راض.	لا
└─ protected_material_code	object	نتيجة اكتشاف تصف تطابقا مع التعليمات البرمجية المرخصة أو مواد المصدر المحمية الأخرى.	لا
└─ الاقتباس	object	إذا كان ذلك متاحا ، فإن تفاصيل الاقتباس التي تصف الترخيص المرتبط وموقعه.	لا
└─ عنوان URL	string	عنوان URL المقترن بالترخيص.	لا
└─ الترخيص	string	اسم أو معرف الترخيص المقترن بالاكتشاف.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ protected_material_text	AzureContentFilterDetectionResult	نتيجة اكتشاف تصف تطابقا مع نص محمي بموجب حقوق النشر أو حالة أخرى.	لا
└─ self_harm	AzureContentFilterSeverityResult	فئة مرشح المحتوى تصف لغة متعلقة بأفعال جسدية تهدف إلى إيذاء أو إيذاء متعمد إلحاق الضرر بجسد الشخص أو قتل نفسه.	لا
└─ جنسي	AzureContentFilterSeverityResult	فئة مرشح المحتوى للغة المتعلقة بالأعضاء التشريحية والأعضاء التناسلية، العلاقات العاطفية، الأفعال يصور بمصطلحات إيروتيكية أو عاطفية، مثل الحمل، والأفعال الجنسية الجسدية، بما في ذلك تلك التي تصور على أنها الاعتداء أو فعل عنف جنسي قسري ضد إرادته، الدعارة، الإباحية، والإساءة.	لا
└─ task_adherence	AzureContentFilterDetectionResult	نتيجة كشف تشير إلى ما إذا كان تدفق التنفيذ لا يزال يلتصق بالخطة.	‏‏نعم‬
└─ ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		لا
└─ العنف	AzureContentFilterSeverityResult	فئة فلتر المحتوى للغة المتعلقة بالأفعال الجسدية التي تهدف إلى إيذاء أو إصابة أو إلحاق ضرر أو قتل شخص أو شيء ما؛ يصف الأسلحة والأسلحة والكيانات ذات الصلة، مثل الشركات المصنعة والجمعيات، تشريع، وهكذا.	لا
source_type	string	اسم نوع المصدر للرسالة.	‏‏نعم‬

AzureContentFilterHarmExtensions

تمديدات لفئات الأضرار، مما يوفر خيارات تكوين إضافية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
pii_sub_categories	مصفوفة AzurePiiSubCategory	تكوين فئات PIIHarm الفرعية.	لا

AzureContentFilterImagePromptResults

نتيجة عامل تصفية المحتوى لمحتوى طلب إدخال عملية إنشاء صورة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
custom_blocklists	AzureContentFilterBlocklistResult	مجموعة من نتائج تصفية صواب/خطأ لقوائم الحظر المخصصة التي تم تكوينها.	لا
└─ التفاصيل	صفيف من العناصر	أزواج معرفات قائمة الحظر الفردية وما إذا كانت أدت إلى إجراء تصفية.	لا
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كانت قائمة الحظر أنتجت إجراء تصفيت.	‏‏نعم‬
└─ الهوية	string	معرف قائمة الحظر المخصصة التي تم تقييمها.	‏‏نعم‬
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كانت أي من قوائم الحظر التفصيلية قد أدت إلى إجراء تصفية أم لا.	‏‏نعم‬
custom_topics	AzureContentFilterCustomTopicResult	مجموعة من نتائج تصفية صواب/خطأ للموضوعات المخصصة التي تم تكوينها.	لا
└─ التفاصيل	صفيف من العناصر	أزواج معرفات الموضوعات الفردية وما إذا كان قد تم اكتشافها.	لا
└─ تم اكتشافه	boolean	قيمة تشير إلى ما إذا كان الموضوع قد تم اكتشافه.	‏‏نعم‬
└─ الهوية	string	معرف الموضوع المخصص الذي تم تقييمه.	‏‏نعم‬
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كان أي من الموضوعات التفصيلية قد أدى إلى إجراء تصفية أم لا.	‏‏نعم‬
hate	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
jailbreak	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	‏‏نعم‬
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
profanity	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
self_harm	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
sexual	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
violence	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬

AzureContentFilterImageResponseResults

نتيجة عامل تصفية المحتوى لمحتوى استجابة إخراج عملية إنشاء صورة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
hate	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
self_harm	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
sexual	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
violence	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬

AzureContentFilterPersonallyIdentifiableInformationResult

نتيجة اكتشاف فلتر المحتوى لمعلومات التعريف الشخصية التي تتضمن ملحقات الضرر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
detected	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
filtered	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
redacted_text	string	تمت إزالة النص المنقح مع معلومات تحديد الهوية الشخصية أو إخفاؤه.	لا
sub_categories	مصفوفة من AzurePiiSubCategoryResult	النتائج التفصيلية للفئة (الفئات) الفرعية الفردية PIIHarm.	لا

AzureContentFilterResultForChoice

نتيجة عامل تصفية المحتوى لعنصر استجابة واحد ينتج بواسطة نظام الذكاء الاصطناعي التوليدي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
custom_blocklists	AzureContentFilterBlocklistResult	مجموعة من نتائج تصفية صواب/خطأ لقوائم الحظر المخصصة التي تم تكوينها.	لا
└─ التفاصيل	صفيف من العناصر	أزواج معرفات قائمة الحظر الفردية وما إذا كانت أدت إلى إجراء تصفية.	لا
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كانت قائمة الحظر أنتجت إجراء تصفيت.	‏‏نعم‬
└─ الهوية	string	معرف قائمة الحظر المخصصة التي تم تقييمها.	‏‏نعم‬
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كانت أي من قوائم الحظر التفصيلية قد أدت إلى إجراء تصفية أم لا.	‏‏نعم‬
custom_topics	AzureContentFilterCustomTopicResult	مجموعة من نتائج تصفية صواب/خطأ للموضوعات المخصصة التي تم تكوينها.	لا
└─ التفاصيل	صفيف من العناصر	أزواج معرفات الموضوعات الفردية وما إذا كان قد تم اكتشافها.	لا
└─ تم اكتشافه	boolean	قيمة تشير إلى ما إذا كان الموضوع قد تم اكتشافه.	‏‏نعم‬
└─ الهوية	string	معرف الموضوع المخصص الذي تم تقييمه.	‏‏نعم‬
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كان أي من الموضوعات التفصيلية قد أدى إلى إجراء تصفية أم لا.	‏‏نعم‬
خطأ	object	في حالة وجودها، تفاصيل حول خطأ منع تصفية المحتوى من إكمال تقييمها.	لا
└─ كود	integer	رمز مميز يمكن قراءته آليا مرتبط بالخطأ.	‏‏نعم‬
└─ رسالة	string	رسالة يمكن للبشر قراءتها مقترنة بالخطأ.	‏‏نعم‬
hate	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	نتيجة اكتشاف فلتر المحتوى لمعلومات التعريف الشخصية التي تتضمن ملحقات الضرر.	لا
└─ redacted_text	string	تمت إزالة النص المنقح مع معلومات تحديد الهوية الشخصية أو إخفاؤه.	لا
└─ sub_categories	مصفوفة من AzurePiiSubCategoryResult	النتائج التفصيلية للفئة (الفئات) الفرعية الفردية PIIHarm.	لا
profanity	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
protected_material_code	object	نتيجة اكتشاف تصف تطابقا مع التعليمات البرمجية المرخصة أو مواد المصدر المحمية الأخرى.	لا
└─ الاقتباس	object	إذا كان ذلك متاحا ، فإن تفاصيل الاقتباس التي تصف الترخيص المرتبط وموقعه.	لا
└─ عنوان URL	string	عنوان URL المقترن بالترخيص.	لا
└─ الترخيص	string	اسم أو معرف الترخيص المقترن بالاكتشاف.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
protected_material_text	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
self_harm	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
sexual	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		لا
violence	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬

AzureContentFilterResultForPrompt

نتيجة عامل تصفية المحتوى المقترنة بعنصر موجه إدخال واحد في نظام الذكاء الاصطناعي التوليدي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_filter_results	object	تفاصيل فئة عامل تصفية المحتوى للنتيجة.	لا
└─ custom_blocklists	AzureContentFilterBlocklistResult	مجموعة من نتائج تصفية صواب/خطأ لقوائم الحظر المخصصة التي تم تكوينها.	لا
└─ التفاصيل	صفيف من العناصر	أزواج معرفات قائمة الحظر الفردية وما إذا كانت أدت إلى إجراء تصفية.	لا
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كانت قائمة الحظر أنتجت إجراء تصفيت.	‏‏نعم‬
└─ الهوية	string	معرف قائمة الحظر المخصصة التي تم تقييمها.	‏‏نعم‬
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كانت أي من قوائم الحظر التفصيلية قد أدت إلى إجراء تصفية أم لا.	‏‏نعم‬
└─ custom_topics	AzureContentFilterCustomTopicResult	مجموعة من نتائج تصفية صواب/خطأ للموضوعات المخصصة التي تم تكوينها.	لا
└─ التفاصيل	صفيف من العناصر	أزواج معرفات الموضوعات الفردية وما إذا كان قد تم اكتشافها.	لا
└─ تم اكتشافه	boolean	قيمة تشير إلى ما إذا كان الموضوع قد تم اكتشافه.	‏‏نعم‬
└─ الهوية	string	معرف الموضوع المخصص الذي تم تقييمه.	‏‏نعم‬
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كان أي من الموضوعات التفصيلية قد أدى إلى إجراء تصفية أم لا.	‏‏نعم‬
└─ خطأ	object	في حالة وجودها، تفاصيل حول خطأ منع تصفية المحتوى من إكمال تقييمها.	لا
└─ كود	integer	رمز مميز يمكن قراءته آليا مرتبط بالخطأ.	‏‏نعم‬
└─ رسالة	string	رسالة يمكن للبشر قراءتها مقترنة بالخطأ.	‏‏نعم‬
└─ الكراهية	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
└─ indirect_attack	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	‏‏نعم‬
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الهروب من السجن	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	‏‏نعم‬
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الألفاظ النابية	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ self_harm	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
└─ جنسي	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
└─ العنف	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
prompt_index	integer	فهرس موجه الإدخال المقترن بفئات نتائج عامل تصفية المحتوى المصاحبة.	لا

AzureContentFilterResultOffsets

الاسم	النوع	وصف	مطلوب	الإفتراضي
check_offset	integer		‏‏نعم‬
end_offset	integer		‏‏نعم‬
start_offset	integer		‏‏نعم‬

AzureContentFilterResultsForResponsesAPI

الاسم	النوع	وصف	مطلوب	الإفتراضي
custom_blocklists	AzureContentFilterBlocklistResult	مجموعة من نتائج تصفية صواب/خطأ لقوائم الحظر المخصصة التي تم تكوينها.	لا
└─ التفاصيل	صفيف من العناصر	أزواج معرفات قائمة الحظر الفردية وما إذا كانت أدت إلى إجراء تصفية.	لا
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كانت قائمة الحظر أنتجت إجراء تصفيت.	‏‏نعم‬
└─ الهوية	string	معرف قائمة الحظر المخصصة التي تم تقييمها.	‏‏نعم‬
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كانت أي من قوائم الحظر التفصيلية قد أدت إلى إجراء تصفية أم لا.	‏‏نعم‬
custom_topics	AzureContentFilterCustomTopicResult	مجموعة من نتائج تصفية صواب/خطأ للموضوعات المخصصة التي تم تكوينها.	لا
└─ التفاصيل	صفيف من العناصر	أزواج معرفات الموضوعات الفردية وما إذا كان قد تم اكتشافها.	لا
└─ تم اكتشافه	boolean	قيمة تشير إلى ما إذا كان الموضوع قد تم اكتشافه.	‏‏نعم‬
└─ الهوية	string	معرف الموضوع المخصص الذي تم تقييمه.	‏‏نعم‬
└─ تمت تصفيته	boolean	قيمة تشير إلى ما إذا كان أي من الموضوعات التفصيلية قد أدى إلى إجراء تصفية أم لا.	‏‏نعم‬
خطأ	object	في حالة وجودها، تفاصيل حول خطأ منع تصفية المحتوى من إكمال تقييمها.	لا
└─ كود	integer	رمز مميز يمكن قراءته آليا مرتبط بالخطأ.	‏‏نعم‬
└─ رسالة	string	رسالة يمكن للبشر قراءتها مقترنة بالخطأ.	‏‏نعم‬
hate	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
indirect_attack	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
jailbreak	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	‏‏نعم‬
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	نتيجة اكتشاف فلتر المحتوى لمعلومات التعريف الشخصية التي تتضمن ملحقات الضرر.	لا
└─ redacted_text	string	تمت إزالة النص المنقح مع معلومات تحديد الهوية الشخصية أو إخفاؤه.	لا
└─ sub_categories	مصفوفة من AzurePiiSubCategoryResult	النتائج التفصيلية للفئة (الفئات) الفرعية الفردية PIIHarm.	لا
profanity	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
protected_material_code	object	نتيجة اكتشاف تصف تطابقا مع التعليمات البرمجية المرخصة أو مواد المصدر المحمية الأخرى.	لا
└─ الاقتباس	object	إذا كان ذلك متاحا ، فإن تفاصيل الاقتباس التي تصف الترخيص المرتبط وموقعه.	لا
└─ عنوان URL	string	عنوان URL المقترن بالترخيص.	لا
└─ الترخيص	string	اسم أو معرف الترخيص المقترن بالاكتشاف.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
protected_material_text	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	لا
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
self_harm	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
sexual	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬
task_adherence	AzureContentFilterDetectionResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تم اكتشافه وما إذا كان المحتوى قد تم اكتشافه أم لا تصفيه.	‏‏نعم‬
└─ تم اكتشافه	boolean	ما إذا كان قد تم اكتشاف فئة المحتوى المسمى في المحتوى.	‏‏نعم‬
└─ تمت تصفيته	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى.	‏‏نعم‬
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		لا
violence	AzureContentFilterSeverityResult	عنصر نتيجة عامل تصفية المحتوى المسمى يشير إلى ما إذا كان المحتوى قد تمت تصفيته وما هو نوعي كان مستوى خطورة المحتوى، كما تم تقييمه مقابل تكوين عامل تصفية المحتوى للفئة.	لا
└─ تمت تصفيته	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
└─ الخطورة	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬

AzureContentFilterSeverityResult

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
filtered	boolean	ما إذا كانت خطورة المحتوى قد أدت إلى إجراء تصفية المحتوى.	‏‏نعم‬
severity	enum	الخطورة المسماة للمحتوى. القيم المحتملة: safe، low، ، mediumhigh	‏‏نعم‬

AzureFileExpiryAnchor

الخاصية	قيمة
نوع	string
Values	created_at

AzureFineTuneReinforcementMethod

الاسم	النوع	وصف	مطلوب	الإفتراضي
الصف	OpenAI.GraderStringCheck أو OpenAI.GraderTextSimilarity أو OpenAI.GraderScoreModel أو OpenAI.GraderMulti أو GraderEndpoint		‏‏نعم‬
المعلمات الفائقة	OpenAI.FineTuneReinforcementHyperparameters	المعلمات الفائقة المستخدمة في وظيفة الضبط الدقيق للتعزيز.	لا
response_format	ResponseFormatJSONSchemaRequest		لا
└─ json_schema	object	مخطط JSON لتنسيق الاستجابة	‏‏نعم‬
└─ النوع	enum	نوع تنسيق الاستجابة القيم المحتملة: json_schema	‏‏نعم‬

الفئة الفرعية لمنطقة Azure Pii

تكوين الفئة الفرعية الفردية من PIIHarm ضمن إطار امتدادات الضرر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الكشف عن	boolean	ما إذا كان الكشف مفعلا لهذه الفئة الفرعية.	‏‏نعم‬
filter	boolean	ما إذا كان يجب حظر المحتوى الذي يحتوي على هذه الفئة الفرعية.	‏‏نعم‬
حذف	boolean	ما إذا كان يجب حذف المحتوى الذي يحتوي على هذه الفئة الفرعية.	‏‏نعم‬
sub_category	string	يتم تكوين فئة PIIHarm الفرعية.	‏‏نعم‬

AzurePiiSubCategoryResult

تفاصيل النتيجة لفئة (فئات) PIIHarmSub الفردية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
detected	boolean	ما إذا كان قد تم اكتشاف الفئة الفرعية للمحتوى المسمى في المحتوى.	‏‏نعم‬
filtered	boolean	ما إذا كان اكتشاف المحتوى قد أدى إلى إجراء تصفية المحتوى لهذه الفئة الفرعية.	‏‏نعم‬
منقحه	boolean	ما إذا كان المحتوى قد تم تنقيحه لهذه الفئة الفرعية.	‏‏نعم‬
sub_category	string	الفئة الفرعية PIIHarm التي تم تقييمها.	‏‏نعم‬

AzureResponsesSamplingParams

معايير أخذ عينات للتحكم في سلوك الاستجابات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_tokens	integer	الحد الأقصى لعدد الرموز المميزة في الإخراج الذي تم إنشاؤه.	لا
reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
seed	integer	قيمة البذرة تهيئ العشوائية أثناء أخذ العينة.	لا	42
درجة الحرارة	رقم	تزيد درجة الحرارة الأعلى من العشوائية في المخرجات.	لا	1
نص	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		لا
الأدوات	صفيف OpenAI.Tool		لا
top_p	رقم	بديل لدرجة الحرارة لأخذ عينات النواة؛ يتضمن 1.0 جميع الرموز المميزة.	لا	1

AzureUserSecurityContext

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

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

الحساب المنسوخالتفاصيل

الاسم	النوع	وصف	مطلوب	الإفتراضي
destinationResourceId	string	معرف مورد الوجهة حيث تم نسخ النموذج إليه.	‏‏نعم‬
region	string	المنطقة التي تم نسخ النموذج إليها.	‏‏نعم‬
الحالة	enum	حالة عملية النسخ. القيم المحتملة: Completed، ، FailedInProgress	‏‏نعم‬

طلب نسخ

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

CopyModelResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
checkpointedModelName	string	معرف النموذج المنسوخ.	‏‏نعم‬
نسخ الحسابالتفاصيل	مصفوفة من تفاصيل الحساب المنسوخ	معرف معرف مورد الوجهة حيث تم نسخه	‏‏نعم‬
fineTuningJobId	string	هوية مهمة الضبط الدقيق التي تم نسخ نقطة التفتيش منها.	‏‏نعم‬

إنشاء فيديو بودي

الاسم	النوع	وصف	مطلوب	الإفتراضي
نموذج	string	اسم النشر المراد استخدامه لهذا الطلب.	‏‏نعم‬
فوري	string	رسالة نصية تصف الفيديو الذي يجب إنشاؤه. القيود: minLength: 1	‏‏نعم‬
الثواني	فيديوثونز	تم دعم مدة المقطع، تقاس بالثواني.	لا	4
size	حجم الفيديو	أبعاد الإخراج منسقة ك {width}x{height}.	لا	720x1280

إنشاء فيديو بودي مع مدخلي

خصائص طلب وظيفة إنشاء الفيديو مع ملفات الوسائط.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_reference	object	مرجع صورة اختياري يوجه التوليد.	‏‏نعم‬
نموذج	object	اسم النشر المراد استخدامه لهذا الطلب.	‏‏نعم‬
فوري	object	رسالة نصية تصف الفيديو الذي يجب إنشاؤه.	‏‏نعم‬
الثواني	object	مدة القطع بثوان. الوضع الافتراضي هو 4 ثوان.	لا
size	object	تم تنسيق دقة الإخراج بعرض × ارتفاع. الوضع الافتراضي هو 720x1280.	لا

إنشاء فيديو ريميكس بودي

معايير لإعادة مزج فيديو مولد موجود.

الاسم	النوع	وصف	مطلوب	الإفتراضي
فوري	string	تحديث النص الذي يوجه توليد الريمكس. القيود: minLength: 1	‏‏نعم‬

DeletedVideoResource

عاد حمولة التأكيد بعد حذف فيديو.

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean	يشير إلى حذف مورد الفيديو.	‏‏نعم‬	صحيح
المعرف	string	معرف الفيديو المحذوف.	‏‏نعم‬
object	string	نوع الكائن الذي يشير إلى استجابة الحذف.	‏‏نعم‬	الفيديو.محذوف

خطأ

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

EvalGraderEndpoint

الاسم	النوع	وصف	مطلوب	الإفتراضي
headers	مفعول أم صفرا	رؤوس HTTP اختيارية لتضمينها في الطلبات إلى نقطة النهاية	لا
الاسم	string	اسم المصحح	‏‏نعم‬
pass_threshold	عدد أو صفرا	درجة اختيارية تعتبر الدرجة التي تجاوزها الدرجة ناجحة إذا لم يتم تحديدها، تعتبر جميع الدرجات صالحة	لا
rate_limit	عدد صحيح أو صفري	حد معدل اختياري للطلبات في الثانية إلى نقطة النهاية يجب أن يكون العدد الصحيح موجبا	لا
النوع	enum	القيم المحتملة: endpoint	‏‏نعم‬
عنوان URL	string	رابط HTTPS لنقطة النهاية لطلب التصحيح القيود: النمط: ^https://	‏‏نعم‬

نقطة النهاية التصحيحية

تكوين مصحح نقطة النهاية لتقييم نقاط النهاية الخارجية لتقنية HTTP

الاسم	النوع	وصف	مطلوب	الإفتراضي
headers	مفعول أم صفرا	رؤوس HTTP اختيارية لتضمينها في الطلبات إلى نقطة النهاية	لا
الاسم	string	اسم المصحح	‏‏نعم‬
pass_threshold	عدد أو صفرا	درجة اختيارية تعتبر الدرجة التي تجاوزها الدرجة ناجحة إذا لم يتم تحديدها، تعتبر جميع الدرجات صالحة	لا
rate_limit	عدد صحيح أو صفري	حد معدل اختياري للطلبات في الثانية إلى نقطة النهاية يجب أن يكون العدد الصحيح موجبا	لا
النوع	enum	القيم المحتملة: endpoint	‏‏نعم‬
عنوان URL	string	رابط HTTPS لنقطة النهاية لطلب التصحيح القيود: النمط: ^https://	‏‏نعم‬

OpenAI.التعليق التوضيحي

تعليق توضيحي ينطبق على نطاق من نص الإخراج.

المميز ل OpenAI.Annotation

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

قيمة النوع	Schema
file_citation	OpenAI.FileCitationBody
url_citation	OpenAI.UrlCitationBody
container_file_citation	OpenAI.ContainerFileCitationBody
file_path	OpenAI.FilePath

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.AnnotationType		‏‏نعم‬

OpenAI.AnnotationType

الخاصية	قيمة
نوع	string
Values	file_citation url_citation container_file_citation file_path

OpenAI.ApplyPatchCallOutputStatus

الخاصية	قيمة
نوع	string
Values	completed failed

OpenAI.ApplyPatchCallStatus

الخاصية	قيمة
نوع	string
Values	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

تعليمات تصف كيفية إنشاء ملف عبر أداة apply_patch.

الاسم	النوع	وصف	مطلوب	الإفتراضي
فرق	string	يجب تطبيق Diff.	‏‏نعم‬
path	string	مسار الملف المراد إنشاؤه.	‏‏نعم‬
النوع	enum	إنشاء ملف جديد مع diff المتوفرة. القيم المحتملة: create_file	‏‏نعم‬

OpenAI.ApplyPatchDeleteFileOperation

تعليمات تصف كيفية حذف ملف عبر أداة apply_patch.

الاسم	النوع	وصف	مطلوب	الإفتراضي
path	string	مسار الملف المراد حذفه.	‏‏نعم‬
النوع	enum	حذف الملف المحدد. القيم المحتملة: delete_file	‏‏نعم‬

OpenAI.ApplyPatchFileOperation

إحدى العمليات create_file أو delete_file أو update_file المطبقة عبر apply_patch.

تمييزي ل OpenAI.ApplyPatchFileOperation

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

قيمة النوع	Schema
create_file	OpenAI.ApplyPatchCreateFileOperation
delete_file	OpenAI.ApplyPatchDeleteFileOperation
update_file	OpenAI.ApplyPatchUpdateFileOperation

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ApplyPatchFileOperationType		‏‏نعم‬

OpenAI.ApplyPatchFileOperationType

الخاصية	قيمة
نوع	string
Values	create_file delete_file update_file

OpenAI.ApplyPatchToolParam

يسمح للمساعد بإنشاء أو حذف أو تحديث الملفات باستخدام تفاضلات موحدة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الأداة. دائمًا apply_patch. القيم المحتملة: apply_patch	‏‏نعم‬

OpenAI.ApplyPatchUpdateFileOperation

تعليمات تصف كيفية تحديث ملف عبر أداة apply_patch.

الاسم	النوع	وصف	مطلوب	الإفتراضي
فرق	string	يجب تطبيق Diff.	‏‏نعم‬
path	string	مسار الملف المراد تحديثه.	‏‏نعم‬
النوع	enum	تحديث ملف موجود مع diff المتوفرة. القيم المحتملة: update_file	‏‏نعم‬

OpenAI.ApproximateLocation

الاسم	النوع	وصف	مطلوب	الإفتراضي
مدينة	سلسلة أو قيمة خالية		لا
country	سلسلة أو قيمة خالية		لا
region	سلسلة أو قيمة خالية		لا
المنطقة الزمنية	سلسلة أو قيمة خالية		لا
النوع	enum	نوع تقريب الموقع. دائمًا approximate. القيم المحتملة: approximate	‏‏نعم‬

OpenAI.AssistantTool

المميز لأداة OpenAI.AssistantTool

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

قيمة النوع	Schema
code_interpreter	OpenAI.AssistantToolsCode
file_search	OpenAI.AssistantToolsFileSearch
function	OpenAI.AssistantToolsFunction

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.AssistantToolType		‏‏نعم‬

OpenAI.AssistantToolType

الخاصية	قيمة
نوع	string
Values	code_interpreter file_search function

OpenAI.AssistantToolsCode

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الأداة التي يتم تعريفها: code_interpreter القيم المحتملة: code_interpreter	‏‏نعم‬

OpenAI.AssistantToolsFileSearch

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_search	OpenAI.AssistantToolsFileSearchFileSearch		لا
└─ max_num_results	integer	القيود: الحد الأدنى: 1، الحد الأقصى: 50	لا
└─ ranking_options	OpenAI.FileSearchRankingOptions	خيارات الترتيب للبحث عن الملفات. إذا لم يتم تحديده، ستستخدم أداة البحث عن الملفات الرتبة auto score_threshold 0. راجع توثيق أداة البحث عن الملفات لمزيد من المعلومات.	لا
النوع	enum	نوع الأداة التي يتم تعريفها: file_search القيم المحتملة: file_search	‏‏نعم‬

OpenAI.AssistantToolsFileSearchFileSearch

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_num_results	integer	القيود: الحد الأدنى: 1، الحد الأقصى: 50	لا
ranking_options	OpenAI.FileSearchRankingOptions	خيارات الترتيب للبحث عن الملفات. إذا لم يتم تحديده، ستستخدم أداة البحث عن الملفات الرتبة auto score_threshold 0. راجع توثيق أداة البحث عن الملفات لمزيد من المعلومات.	لا

OpenAI.AssistantToolsFileSearchTypeOnly

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الأداة التي يتم تعريفها: file_search القيم المحتملة: file_search	‏‏نعم‬

OpenAI.AssistantToolsFunction

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

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

النوع: نصية أو OpenAI.ResponseFormatText أو OpenAI.ResponseFormatJsonObject أو OpenAI.ResponseFormatJsonSchema

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

OpenAI.AssistantsApiToolChoiceOption

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

النوع: string أو OpenAI.AssistantsNamedToolChoice

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

OpenAI.AssistantsNamedToolChoice

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
دالة	OpenAI.AssistantsNamedToolChoiceFunction		لا
النوع	enum	نوع الأداة. إذا كان النوع هو function، يجب تعيين اسم الدالة القيم المحتملة: function، ، code_interpreterfile_search	‏‏نعم‬

OpenAI.AssistantsNamedToolChoiceFunction

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

OpenAI.AudioTranscription

الاسم	النوع	وصف	مطلوب	الإفتراضي
اللغة	string	لغة صوت الإدخال. توفير لغة الإدخال في تنسيق ISO-639-1 (مثل en) سيحسن الدقة والتأخير.	لا
نموذج	string	النموذج الذي يجب استخدامه للنسخ. الخيارات الحالية هي whisper-1، gpt-4o-mini-transcribe، gpt-4o-mini-transcribe-2025-12-15، gpt-4o-transcribe، و gpt-4o-transcribe-diarize. استخدمها gpt-4o-transcribe-diarize عندما تحتاج إلى توثيق مع تسميات السماعات.	لا
فوري	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار صوت سابق القطاع. ل whisper-1، الموضوع هو قائمة بالكلمات المفتاحية. بالنسبة للنماذج gpt-4o-transcribe (باستثناء gpt-4o-transcribe-diarizeالنماذج )، فإن التوجيه هو سلسلة نصية حرة، مثل "توقع كلمات متعلقة بالتكنولوجيا".	لا

OpenAI.AutoChunkingStrategyRequestParam

الاستراتيجية الافتراضية. تستخدم هذه الاستراتيجية حاليا من max_chunk_size_tokens800 و chunk_overlap_tokens من 400.

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

OpenAI.Batch

الاسم	النوع	وصف	مطلوب	الإفتراضي
cancelled_at	integer	الطابع الزمني ليونكس (بالثواني) لوقت إلغاء الدفعة.	لا
cancelling_at	integer	طابع يونكس الزمني (بثوان) لبدء إلغاء الدفعة.	لا
completed_at	integer	طابع يونكس الزمني (بثوان) لوقت اكتمال الدفعة.	لا
completion_window	string	الإطار الزمني الذي يجب معالجة الدفعة خلاله.	‏‏نعم‬
created_at	integer	طابع يونكس الزمني (بالثواني) لوقت إنشاء الدفعة.	‏‏نعم‬
نقطه النهايه	string	نقطة نهاية واجهة برمجة التطبيقات OpenAI التي تستخدمها الدفعة.	‏‏نعم‬
error_file_id	string	معرف الملف الذي يحتوي على مخرجات الطلبات ذات الأخطاء.	لا
اخطاء	OpenAI.BatchErrors		لا
expired_at	integer	طابع يونكس الزمني (بالثواني) لانتهاء صلاحية الدفعة.	لا
expires_at	integer	طابع يونكس الزمني (بثوان) لوقت انتهاء صلاحية الدفعة.	لا
failed_at	integer	طابع يونكس الزمني (بالثواني) عندما تفشل الدفعة.	لا
finalizing_at	integer	طابع يونكس الزمني (بثوان) لبدء الدفعة في الانتهاء منها.	لا
المعرف	string		‏‏نعم‬
in_progress_at	integer	طابع الوقت ليونكس (بثوان) لبدء الدفعة في المعالجة.	لا
input_file_id	سلسلة أو قيمة خالية		لا
metadata	OpenAI.Metadata أو null		لا
نموذج	string	معرف النموذج المستخدم لمعالجة الدفعة، مثل gpt-5-2025-08-07. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع النموذج دليل لتصفح ومقارنة النماذج المتاحة.	لا
object	enum	نوع الكائن، الذي يتم batchدائما . القيم المحتملة: batch	‏‏نعم‬
output_file_id	string	معرف الملف الذي يحتوي على مخرجات الطلبات التي تم تنفيذها بنجاح.	لا
request_counts	OpenAI.BatchRequestCounts	يحسب الطلب للحالات المختلفة داخل الدفعة.	لا
الحالة	enum	الحالة الحالية للدفعة. القيم المحتملة: validating، failed، in_progress، finalizing، completed، expired، ، cancellingcancelled	‏‏نعم‬
استخدام	OpenAI.BatchUsage		لا
└─ input_tokens	integer		‏‏نعم‬
└─ input_tokens_details	OpenAI.BatchUsageInputTokensتفاصيل		‏‏نعم‬
└─ output_tokens	integer		‏‏نعم‬
└─ output_tokens_details	OpenAI.BatchUsageOutputTokensتفاصيل		‏‏نعم‬
└─ total_tokens	integer		‏‏نعم‬

OpenAI.BatchError

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

OpenAI.BatchErrors

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة من OpenAI.BatchError		لا
object	string		لا

OpenAI.BatchRequestCounts

يحسب الطلب للحالات المختلفة داخل الدفعة.

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

OpenAI.BatchUsage

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_tokens	integer		‏‏نعم‬
input_tokens_details	OpenAI.BatchUsageInputTokensتفاصيل		‏‏نعم‬
output_tokens	integer		‏‏نعم‬
output_tokens_details	OpenAI.BatchUsageOutputTokensتفاصيل		‏‏نعم‬
total_tokens	integer		‏‏نعم‬

OpenAI.BatchUsageInputTokensتفاصيل

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

OpenAI.BatchUsageOutputTokensتفاصيل

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

OpenAI.ChatCompletionAllowedTools

يقيد الأدوات المتاحة للنموذج على مجموعة محددة مسبقا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوضع	enum	يقيد الأدوات المتاحة للنموذج على مجموعة محددة مسبقا. auto يسمح للنموذج بالاختيار من بين الأدوات المسموح بها وإنشاء رسالة. required يتطلب النموذج استدعاء واحد أو أكثر من الأدوات المسموح بها. القيم المحتملة: auto، required	‏‏نعم‬
الأدوات	صفيف من العناصر	قائمة بتعريفات الأدوات التي يجب السماح للنموذج باستدعاءها. بالنسبة لواجهة برمجة تطبيقات إكمال الدردشة، قد تبدو قائمة تعريفات الأدوات كما يلي: json<br> [<br> { "type": "function", "function": { "name": "get_weather" } },<br> { "type": "function", "function": { "name": "get_time" } }<br> ]<br>	‏‏نعم‬

OpenAI.ChatCompletionAllowedToolsChoice

يقيد الأدوات المتاحة للنموذج على مجموعة محددة مسبقا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
allowed_tools	OpenAI.ChatCompletionAllowedTools	يقيد الأدوات المتاحة للنموذج على مجموعة محددة مسبقا.	‏‏نعم‬
النوع	enum	نوع تكوين الأداة المسموح به. دائمًا allowed_tools. القيم المحتملة: allowed_tools	‏‏نعم‬

OpenAI.ChatCompletionFunctionCallOption

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

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

OpenAI.ChatCompletionFunctions

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

OpenAI.ChatCompletionMessageCustomToolCall

استدعاء لأداة مخصصة أنشأها النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تقليد	OpenAI.ChatCompletionMessageCustomToolCallCustom		‏‏نعم‬
└─ المدخلات	string		‏‏نعم‬
└─ الاسم	string		‏‏نعم‬
المعرف	string	معرف استدعاء الأداة.	‏‏نعم‬
النوع	enum	نوع الأداة. دائمًا custom. القيم المحتملة: custom	‏‏نعم‬

OpenAI.ChatCompletionMessageCustomToolCallCustom

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

OpenAI.ChatCompletionMessageToolCall

استدعاء إلى أداة دالة أنشأها النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
دالة	OpenAI.ChatCompletionMessageToolCallFunction		‏‏نعم‬
└─ الحجج	string		‏‏نعم‬
└─ الاسم	string		‏‏نعم‬
المعرف	string	معرف استدعاء الأداة.	‏‏نعم‬
النوع	enum	نوع الأداة. حاليا، يتم دعم فقط function . القيم المحتملة: function	‏‏نعم‬

OpenAI.ChatCompletionMessageToolCallChunk

الاسم	النوع	وصف	مطلوب	الإفتراضي
دالة	OpenAI.ChatCompletionMessageToolCallChunkFunction		لا
المعرف	string	معرف استدعاء الأداة.	لا
الفهرس	integer		‏‏نعم‬
النوع	enum	نوع الأداة. حاليا، يتم دعم فقط function . القيم المحتملة: function	لا

OpenAI.ChatCompletionMessageToolCallChunkFunction

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

OpenAI.ChatCompletionMessageToolCallFunction

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

OpenAI.ChatCompletionMessageToolcalls

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

OpenAI.ChatCompletionMessageToolCallsItem

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

OpenAI.ChatCompletionNamedToolChoice

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
دالة	OpenAI.ChatCompletionNamedToolChoiceFunction		‏‏نعم‬
النوع	enum	لاستدعاء الدالة ، يكون النوع دائما function. القيم المحتملة: function	‏‏نعم‬

OpenAI.ChatCompletionNamedToolChoiceCustom

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
تقليد	OpenAI.ChatCompletionNamedToolChoiceCustomCustom		‏‏نعم‬
النوع	enum	بالنسبة لاستدعاء الأداة المخصصة، يكون النوع دائما custom. القيم المحتملة: custom	‏‏نعم‬

OpenAI.ChatCompletionNamedToolChoiceCustomCustom

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

OpenAI.ChatCompletionNamedToolChoiceFunction

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

OpenAI.ChatCompletionRequestAssistantMessage

الرسائل المرسلة من قبل النموذج استجابة لرسائل المستخدم.

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

OpenAI.ChatCompletionRequestAssistantMessageAudio

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

OpenAI.ChatCompletionRequestAssistantMessageContentPart

المميز ل OpenAI.ChatCompletionRequestAssistantMessageContentPart

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

قيمة النوع	Schema
refusal	OpenAI.ChatCompletionRequestMessageContentPartRefusal
text	OpenAI.ChatCompletionRequestAssistantMessageContentPart ChatCompletionRequestMessageContentContentPartText

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ChatCompletionRequestAssistantMessageContentPartType		‏‏نعم‬

OpenAI.ChatCompletionRequestAssistantMessageContentPart ChatCompletionRequestMessageContentContentPartText

تعرف على مدخلات النص.

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

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

الخاصية	قيمة
نوع	string
Values	text refusal

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

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

OpenAI.ChatCompletionRequestDeveloperMessage

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

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

OpenAI.ChatCompletionRequestFunctionMessage

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

OpenAI.ChatCompletionRequestMessage

Discriminator ل OpenAI.ChatCompletionRequestMessage

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

قيمة النوع	Schema
assistant	OpenAI.ChatCompletionRequestAssistantMessage
developer	OpenAI.ChatCompletionRequestDeveloperMessage
function	OpenAI.ChatCompletionRequestFunctionMessage
system	OpenAI.ChatCompletionRequestSystemMessage
user	OpenAI.ChatCompletionRequestUserMessage
tool	OpenAI.ChatCompletionRequestToolMessage

الاسم	النوع	وصف	مطلوب	الإفتراضي
role	OpenAI.ChatCompletionRequestMessageType		‏‏نعم‬

OpenAI.ChatCompletionRequestMessageContentPartAudio

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_audio	OpenAI.ChatCompletionRequestMessageContentParts AudioInput Audio		‏‏نعم‬
النوع	enum	نوع جزء المحتوى. دائمًا input_audio. القيم المحتملة: input_audio	‏‏نعم‬

OpenAI.ChatCompletionRequestMessageContentParts AudioInput Audio

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	string		‏‏نعم‬
format	enum	القيم المحتملة: wav، mp3	‏‏نعم‬

OpenAI.ChatCompletionRequestMessageContentPartFile

تعرف على مدخلات الملفات لتوليد النصوص.

الاسم	النوع	وصف	مطلوب	الإفتراضي
ملف	OpenAI.ChatCompletionRequestMessageContentContentPartFileFile		‏‏نعم‬
└─ file_data	string		لا
└─ file_id	string		لا
└─ اسم الملف	string		لا
النوع	enum	نوع جزء المحتوى. دائمًا file. القيم المحتملة: file	‏‏نعم‬

OpenAI.ChatCompletionRequestMessageContentContentPartFileFile

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_data	string		لا
file_id	string		لا
filename	string		لا

OpenAI.ChatCompletionRequestMessageContentPartImage

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

OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	enum	القيم المحتملة: auto، ، lowhigh	لا
عنوان URL	string		‏‏نعم‬

OpenAI.ChatCompletionRequestMessageContentPartRefusal

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

OpenAI.ChatCompletionRequestMessageContentPartText

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

OpenAI.ChatCompletionRequestMessageType

الخاصية	قيمة
نوع	string
Values	developer system user assistant tool function

OpenAI.ChatCompletionRequestSystemMessage

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

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

OpenAI.ChatCompletionRequestSystemMessageContentPart

المراجع: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

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

OpenAI.ChatCompletionRequestToolMessageContentالجزء

المراجع: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

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

OpenAI.ChatCompletionRequestUserMessageContentPart

المميز ل OpenAI.ChatCompletionRequestUserMessageContentPart

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

قيمة النوع	Schema
image_url	OpenAI.ChatCompletionRequestMessageContentPartImage
input_audio	OpenAI.ChatCompletionRequestMessageContentPartAudio
file	OpenAI.ChatCompletionRequestMessageContentPartFile
text	OpenAI.ChatCompletionRequestUserMessage Content PartChatCompletionRequestMessageContentPartText

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ChatCompletionRequestUserMessageContentPartType		‏‏نعم‬

OpenAI.ChatCompletionRequestUserMessage Content PartChatCompletionRequestMessageContentPartText

تعرف على مدخلات النص.

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

OpenAI.ChatCompletionRequestUserMessageContentPartType

الخاصية	قيمة
نوع	string
Values	text image_url input_audio file

OpenAI.ChatCompletionResponseMessage

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotations	مصفوفة من OpenAI.ChatCompletionResponseMessageAnnotations	التعليقات التوضيحية للرسالة، عند الاقتضاء، كما هو الحال عند استخدام أداة بحث على الويب.	لا
صوتي	OpenAI.ChatCompletionResponseMessageAudio أو null		لا
محتوى	سلسلة أو قيمة خالية		‏‏نعم‬
function_call	OpenAI.ChatCompletionResponseMessageFunctionCall		لا
└─ الحجج	string		‏‏نعم‬
└─ الاسم	string		‏‏نعم‬
reasoning_content	string	خاصية امتداد خاصة ب Azure تحتوي على محتوى استدلالي مولد من النماذج المدعومة.	لا
رفض	سلسلة أو قيمة خالية		‏‏نعم‬
role	enum	دور كاتب هذه الرسالة. القيم المحتملة: assistant	‏‏نعم‬
tool_calls	OpenAI.ChatCompletionMessageToolCallsItem	تستدعي الأداة التي تم إنشاؤها بواسطة النموذج، مثل استدعاءات الدالة.	لا

OpenAI.ChatCompletionResponseMessageAnnotations

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: url_citation	‏‏نعم‬
url_citation	OpenAI.ChatCompletionResponseMessageAnnotationsURL		‏‏نعم‬

OpenAI.ChatCompletionResponseMessageAnnotationsURL

الاسم	النوع	وصف	مطلوب	الإفتراضي
end_index	integer		‏‏نعم‬
start_index	integer		‏‏نعم‬
العنوان	string		‏‏نعم‬
عنوان URL	string		‏‏نعم‬

OpenAI.ChatCompletionResponseMessageAudio

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	string		‏‏نعم‬
expires_at	integer		‏‏نعم‬
المعرف	string		‏‏نعم‬
نسخه	string		‏‏نعم‬

OpenAI.ChatCompletionResponseMessageFunctionCall

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

OpenAI.ChatCompletionStreamOptions

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

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

OpenAI.ChatCompletionStreamResponseDelta

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	سلسلة أو قيمة خالية		لا
function_call	OpenAI.ChatCompletionStreamResponseDeltaFunctionCall		لا
└─ الحجج	string		لا
└─ الاسم	string		لا
reasoning_content	string	خاصية امتداد خاصة ب Azure تحتوي على محتوى استدلالي مولد من النماذج المدعومة.	لا
رفض	سلسلة أو قيمة خالية		لا
role	enum	دور كاتب هذه الرسالة. القيم المحتملة: developer، system، user، ، assistanttool	لا
tool_calls	مصفوفة OpenAI.ChatCompletionMessageToolCallChunk		لا

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

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

OpenAI.ChatCompletionTokenLogprob

الاسم	النوع	وصف	مطلوب	الإفتراضي
بايت	مصفوفة من الأعداد الصحيحة أو الصفرية		‏‏نعم‬
لوغاربوب	رقم	احتمال السجل لهذا الرمز المميز ، إذا كان ضمن أفضل 20 رمزا مميزا على الأرجح. خلاف ذلك ، يتم استخدام القيمة -9999.0 للدلالة على أن الرمز المميز غير مرجح للغاية.	‏‏نعم‬
الرمز المميز	string	الرمز المميز.	‏‏نعم‬
top_logprobs	مصفوفة OpenAI.ChatCompletionTokenLogprobTopLogprobs	قائمة بالرموز المميزة الأكثر احتمالا واحتمال سجلها، في موضع الرمز المميز هذا. في حالات نادرة، قد يكون هناك أقل من عدد الطلبات التي تم top_logprobs إرجاعها.	‏‏نعم‬

OpenAI.ChatCompletionTokenLogprobTopLogprobs

الاسم	النوع	وصف	مطلوب	الإفتراضي
بايت	مصفوفة من الأعداد الصحيحة أو الصفرية		‏‏نعم‬
لوغاربوب	رقم		‏‏نعم‬
الرمز المميز	string		‏‏نعم‬

OpenAI.ChatCompletionTool

أداة دالة يمكن استخدامها لإنشاء استجابة.

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

OpenAI.ChatCompletionToolChoiceOption

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

النوع: نص نصي أو OpenAI.ChatCompletionAllowedToolsChoice أو OpenAI.ChatCompletionNamedToolChoice أو OpenAI.ChatCompletionNamedToolChoiceCustom

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

OpenAI.ChunkingStrategyRequestParam

تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية auto . ينطبق فقط إذا كان file_ids غير فارغ.

المميز ل OpenAI.ChunkingStrategyRequestParam

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

قيمة النوع	Schema
auto	OpenAI.AutoChunkingStrategyRequestParam
static	OpenAI.StaticChunkingStrategyRequestParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ChunkingStrategyRequestParamType		‏‏نعم‬

OpenAI.ChunkingStrategyRequestParamType

الخاصية	قيمة
نوع	string
Values	auto static

OpenAI.ChunkingStrategyResponse

الاستراتيجية المستخدمة لتقسيم الملف.

مميز ل OpenAI.ChunkingStrategyResponse

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

قيمة النوع	Schema
static	OpenAI.StaticChunkingStrategyResponseParam
other	OpenAI.OtherChunkingStrategyResponseParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ChunkingStrategyResponseType		‏‏نعم‬

OpenAI.ChunkingStrategyResponseType

الخاصية	قيمة
نوع	string
Values	static other

OpenAI.ClickButtonType

الخاصية	قيمة
نوع	string
Values	left right wheel back forward

OpenAI.ClickParam

إجراء النقر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
زر	OpenAI.ClickButtonType		‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء النقر، هذه الخاصية دائما clickهي . القيم المحتملة: click	‏‏نعم‬
×	integer	الإحداثي س حيث حدث النقر.	‏‏نعم‬
y	integer	الإحداثي ص حيث حدث النقر.	‏‏نعم‬

OpenAI.CodeInterpreterContainerAuto

تكوين حاوية مترجم التعليمات البرمجية. حدد معرفات الملفات لتشغيل التعليمات البرمجية عليها اختياريا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_ids	صفيف سلسلة	قائمة اختيارية بالملفات التي تم تحميلها لتوفيرها للتعليمات البرمجية الخاصة بك.	لا
memory_limit	OpenAI.ContainerMemoryLimit أو null		لا
النوع	enum	دائمًا auto. القيم المحتملة: auto	‏‏نعم‬

OpenAI.CodeInterpreterOutputImage

إخراج الصورة من مترجم الكود.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الإخراج. دائمًا image. القيم المحتملة: image	‏‏نعم‬
عنوان URL	string	عنوان URL لإخراج الصورة من مترجم التعليمات البرمجية.	‏‏نعم‬

OpenAI.CodeInterpreterOutputLogs

إخراج السجلات من مترجم التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
logs	string	إخراج السجلات من مترجم التعليمات البرمجية.	‏‏نعم‬
النوع	enum	نوع الإخراج. دائمًا logs. القيم المحتملة: logs	‏‏نعم‬

OpenAI.CodeInterpreterTool

أداة تعمل بكود Python للمساعدة في توليد استجابة لطلب.

الاسم	النوع	وصف	مطلوب	الإفتراضي
container	سلسلة أو OpenAI.CodeInterpreterContainerAuto	حاوية مترجم التعليمات البرمجية. يمكن أن يكون معرف حاوية أو كائن يحدد معرفات الملفات التي تم تحميلها لتوفيرها للتعليمات البرمجية الخاصة بك، جنبا إلى جنب مع إعداد اختياري memory_limit .	‏‏نعم‬
النوع	enum	نوع أداة مترجم التعليمات البرمجية. دائمًا code_interpreter. القيم المحتملة: code_interpreter	‏‏نعم‬

OpenAI.ComparisonFilter

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
مفتاح	string	المفتاح للمقارنة مقابل القيمة.	‏‏نعم‬
النوع	enum	يحدد عامل المقارنة: eq، ne، gt، gte، ltlteinnin. - eq:يساوي - ne: غير متساوي - gt:اكبر - gte: أكبر من أو يساوي - lt:اقل - lte: أقل من أو يساوي - in:في - nin: ليس في القيم المحتملة: eq، ne، gt، gte، ، ltlte	‏‏نعم‬
القيمة	نص أو رقم أو بوليان أو مصفوفة من OpenAI.ComparisonFilterValueItems	القيمة المراد مقارنتها بمفتاح السمة؛ يدعم أنواع السلسلة أو الرقم أو القيم المنطقية.	‏‏نعم‬

OpenAI.ComparisonFilterValueItems

يقبل هذا المخطط أحد الأنواع التالية:

• سلسلة
• رقم

OpenAI.CompletionUse

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
completion_tokens	integer	عدد الرموز المميزة في الإكمال الذي تم إنشاؤه.	‏‏نعم‬
completion_tokens_details	OpenAI.CompletionUsageCompletionTokensDetails		لا
└─ accepted_prediction_tokens	integer		لا
└─ audio_tokens	integer		لا
└─ reasoning_tokens	integer		لا
└─ rejected_prediction_tokens	integer		لا
prompt_tokens	integer	عدد الرموز المميزة في المطالبة.	‏‏نعم‬
prompt_tokens_details	OpenAI.CompletionUsagePromptTokensDetails		لا
└─ audio_tokens	integer		لا
└─ cached_tokens	integer		لا
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة في الطلب (المطالبة + الإكمال).	‏‏نعم‬

OpenAI.CompletionUsageCompletionTokensDetails

الاسم	النوع	وصف	مطلوب	الإفتراضي
accepted_prediction_tokens	integer		لا
audio_tokens	integer		لا
reasoning_tokens	integer		لا
rejected_prediction_tokens	integer		لا

OpenAI.CompletionUsagePromptTokensDetails

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

OpenAI.CompoundFilter

دمج عوامل تصفية متعددة باستخدام and أو or.

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	صفيف OpenAI.ComparisonFilter أو كائن	صفيف عوامل التصفية المراد دمجها. يمكن أن تكون ComparisonFilter العناصر أو CompoundFilter.	‏‏نعم‬
النوع	enum	نوع العملية: and أو or. القيم المحتملة: and، or	‏‏نعم‬

OpenAI.ComputerAction

المميز ل OpenAI.ComputerAction

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

قيمة النوع	Schema
click	OpenAI.ClickParam
double_click	OpenAI.DoubleClickAction
drag	OpenAI.Drag
keypress	OpenAI.KeyPressAction
move	OpenAI.Move
screenshot	OpenAI.لقطة شاشة
scroll	OpenAI.Scroll
type	OpenAI.Type
wait	OpenAI.Wait

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ComputerActionType		‏‏نعم‬

OpenAI.ComputerActionType

الخاصية	قيمة
نوع	string
Values	click double_click drag keypress move screenshot scroll type wait

OpenAI.ComputerCallSafetyCheckParam

فحص أمان معلق لمكالمة الكمبيوتر.

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

OpenAI.ComputerEnvironment

الخاصية	قيمة
نوع	string
Values	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

لقطة شاشة لجهاز كمبيوتر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	سلسلة أو قيمة خالية		‏‏نعم‬
image_url	سلسلة أو قيمة خالية		‏‏نعم‬
النوع	enum	يحدد نوع الحدث. للحصول على لقطة شاشة للكمبيوتر، يتم تعيين هذه الخاصية دائما إلى computer_screenshot. القيم المحتملة: computer_screenshot	‏‏نعم‬

OpenAI.ComputerScreenshotImage

صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	string	معرف ملف تم تحميله يحتوي على لقطة الشاشة.	لا
image_url	string	عنوان URL لصورة لقطة الشاشة.	لا
النوع	enum	يحدد نوع الحدث. بالنسبة إلى لقطة شاشة الكمبيوتر، تكون هذه الخاصية اضبط دائما على computer_screenshot. القيم المحتملة: computer_screenshot	‏‏نعم‬

OpenAI.ComputerUsePreviewTool

أداة تتحكم في جهاز كمبيوتر ظاهري.

الاسم	النوع	وصف	مطلوب	الإفتراضي
display_height	integer	ارتفاع جهاز عرض الكمبيوتر.	‏‏نعم‬
display_width	integer	عرض جهاز عرض الكمبيوتر.	‏‏نعم‬
environment	OpenAI.ComputerEnvironment		‏‏نعم‬
النوع	enum	نوع أداة استخدام الكمبيوتر. دائمًا computer_use_preview. القيم المحتملة: computer_use_preview	‏‏نعم‬

OpenAI.ContainerFileCitationBody

استشهاد لملف حاوية يستخدم لتوليد استجابة نموذجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
container_id	string	معرف ملف الحاوية.	‏‏نعم‬
end_index	integer	فهرس آخر حرف في استشهاد ملف الحاوية في الرسالة.	‏‏نعم‬
file_id	string	معرف الملف.	‏‏نعم‬
filename	string	اسم ملف الحاوية المذكور.	‏‏نعم‬
start_index	integer	فهرس الحرف الأول من استشهاد ملف الحاوية في الرسالة.	‏‏نعم‬
النوع	enum	نوع استشهاد ملف الحاوية. دائمًا container_file_citation. القيم المحتملة: container_file_citation	‏‏نعم‬

OpenAI.ContainerFileListResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.ContainerFileResource	قائمة بملفات الحاويات.	‏‏نعم‬
first_id	string	معرف الملف الأول في القائمة.	‏‏نعم‬
has_more	boolean	هل هناك المزيد من الملفات المتاحة.	‏‏نعم‬
last_id	string	معرف آخر ملف في القائمة.	‏‏نعم‬
object	enum	نوع الكائن الذي تم إرجاعه يجب أن يكون 'قائمة'. القيم المحتملة: list	‏‏نعم‬

OpenAI.ContainerFileResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
بايت	integer	حجم الملف بالبايت.	‏‏نعم‬
container_id	string	الحاوية التي ينتمي إليها هذا الملف.	‏‏نعم‬
created_at	integer	طابع الوقت ليونكس (بالثواني) عند إنشاء الملف.	‏‏نعم‬
المعرف	string	معرف فريد للملف.	‏‏نعم‬
object	enum	نوع هذا الجسم (container.file). القيم المحتملة: container.file	‏‏نعم‬
path	string	مسار الملف داخل الحاوية.	‏‏نعم‬
المصدر	string	مصدر الملف (على سبيل المثال، user، assistant).	‏‏نعم‬

OpenAI.ContainerListResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.ContainerResource	قائمة بالحاويات.	‏‏نعم‬
first_id	string	معرف الحاوية الأولى في القائمة.	‏‏نعم‬
has_more	boolean	هل هناك المزيد من الحاويات المتاحة.	‏‏نعم‬
last_id	string	معرف الحاوية الأخيرة في القائمة.	‏‏نعم‬
object	enum	نوع الكائن الذي تم إرجاعه يجب أن يكون 'قائمة'. القيم المحتملة: list	‏‏نعم‬

OpenAI.ContainerMemoryLimit

الخاصية	قيمة
نوع	string
Values	1g 4g 16g 64g

OpenAI.ContainerResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	طابع زمني يونكس (بثوان) عند إنشاء الحاوية.	‏‏نعم‬
expires_after	OpenAI.ContainerResourceexpiresAfter		لا
└─ مرساة	enum	القيم المحتملة: last_active_at	لا
└─ دقائق	integer		لا
المعرف	string	معرف فريد للحاوية.	‏‏نعم‬
last_active_at	integer	طابع زمني يونكس (بثوان) عندما كانت الحاوية نشطة آخر مرة.	لا
memory_limit	enum	الحد الأقصى للذاكرة الذي تم تكوينه للحاوية. القيم المحتملة: 1g، 4g، ، 16g64g	لا
الاسم	string	اسم الحاوية.	‏‏نعم‬
object	string	نوع هذا الكائن.	‏‏نعم‬
الحالة	string	حالة الحاوية (على سبيل المثال، نشطة، محذوفة).	‏‏نعم‬

OpenAI.ContainerResourceexpiresAfter

الاسم	النوع	وصف	مطلوب	الإفتراضي
anchor	enum	القيم المحتملة: last_active_at	لا
محضر	integer		لا

OpenAI.ConversationItem

عنصر واحد داخل محادثة. مجموعة الأنواع المحتملة هي نفس output نوع كائن الاستجابة.

تمييز ل OpenAI.ConversationItem

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

قيمة النوع	Schema
message	OpenAI.ConversationItemMessage
function_call	OpenAI.ConversationItemFunctionToolCallResource
function_call_output	OpenAI.ConversationItemFunctionToolCallOutputResource
file_search_call	OpenAI.ConversationItemFileSearchToolCall
web_search_call	OpenAI.ConversationItemWebSearchToolCall
image_generation_call	OpenAI.ConversationItemImageGenToolCall
computer_call	OpenAI.ConversationItemComputerToolCall
computer_call_output	OpenAI.ConversationItemComputerToolCallOutputResource
reasoning	OpenAI.ConversationItemReasoningItem
code_interpreter_call	OpenAI.ConversationItemCodeInterpreterToolCall
local_shell_call	OpenAI.ConversationItemLocalShellToolCall
local_shell_call_output	OpenAI.ConversationItemLocalShellToolCallOutput
shell_call	OpenAI.ConversationItemFunctionShellCall
shell_call_output	OpenAI.ConversationItemFunctionShellCallOutput
apply_patch_call	OpenAI.ConversationItemApplyPatchToolCall
apply_patch_call_output	OpenAI.ConversationItemApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ConversationItemMcpListTools
mcp_approval_request	OpenAI.ConversationItemMcpApprovalRequest
mcp_approval_response	OpenAI.ConversationItemMcpApprovalResponseResource
mcp_call	OpenAI.ConversationItemMcpToolCall
custom_tool_call	OpenAI.ConversationItemCustomToolCall
custom_tool_call_output	OpenAI.ConversationItemCustomToolCallOutput

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ConversationItemType		‏‏نعم‬

OpenAI.ConversationItemApplyPatchToolCall

استدعاء أداة يطبق تلميحات الملفات عن طريق إنشاء الملفات أو حذفها أو تحديثها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة تطبيق التصحيح الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لاستدعاء أداة تطبيق التصحيح. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
operation	OpenAI.ApplyPatchFileOperation	إحدى العمليات create_file أو delete_file أو update_file المطبقة عبر apply_patch.	‏‏نعم‬
└─ النوع	OpenAI.ApplyPatchFileOperationType		‏‏نعم‬
الحالة	OpenAI.ApplyPatchCallStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا apply_patch_call. القيم المحتملة: apply_patch_call	‏‏نعم‬

OpenAI.ConversationItemApplyPatchToolCallOutput

الإخراج المنبعثة من استدعاء تطبيق أداة التصحيح.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة تطبيق التصحيح الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ إخراج استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لتطبيق إخراج استدعاء أداة التصحيح. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
الناتج	سلسلة أو قيمة خالية		لا
الحالة	OpenAI.ApplyPatchCallOutputStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا apply_patch_call_output. القيم المحتملة: apply_patch_call_output	‏‏نعم‬

OpenAI.ConversationItemCodeInterpreterToolCall

استدعاء أداة لتشغيل التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	سلسلة أو قيمة خالية		‏‏نعم‬
container_id	string	معرف الحاوية المستخدمة لتشغيل التعليمات البرمجية.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
outputs	مصفوفة من OpenAI.CodeInterpreterOutputLogs أو OpenAI.CodeInterpreterOutputImage أو null		‏‏نعم‬
الحالة	enum	حالة استدعاء أداة مترجم التعليمات البرمجية. القيم الصالحة هي in_progressوcompletedincompleteinterpreting.failed القيم المحتملة: in_progress، completed، incomplete، ، interpretingfailed	‏‏نعم‬
النوع	enum	نوع استدعاء أداة مترجم التعليمات البرمجية. دائمًا code_interpreter_call. القيم المحتملة: code_interpreter_call	‏‏نعم‬

OpenAI.ConversationItemComputerToolCall

استدعاء أداة إلى أداة استخدام الكمبيوتر. انظر دليل استخدام الكمبيوتر للحصول على مزيد من المعلومات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.ComputerAction		‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء الكمبيوتر.	‏‏نعم‬
pending_safety_checks	صفيف OpenAI.ComputerCallSafetyCheckParam	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع مكالمة الكمبيوتر. دائمًا computer_call. القيم المحتملة: computer_call	‏‏نعم‬

OpenAI.ConversationItemComputerToolCallOutputResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
acknowledged_safety_checks	صفيف OpenAI.ComputerCallSafetyCheckParam	فحوصات السلامة التي أبلغت عنها واجهة برمجة التطبيقات والتي تم الاعتراف بها من قبل المطور.	لا
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج الإخراج.	‏‏نعم‬
المعرف	string	معرف إخراج استدعاء أداة الكمبيوتر.	لا
الناتج	OpenAI.ComputerScreenshotImage	صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من in_progressأو completedأو incomplete. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
النوع	enum	نوع إخراج استدعاء أداة الكمبيوتر. دائمًا computer_call_output. القيم المحتملة: computer_call_output	‏‏نعم‬

OpenAI.ConversationItemCustomToolCall

استدعاء لأداة مخصصة أنشأها النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف يستخدم لربط استدعاء الأداة المخصص هذا بمخرج استدعاء أداة.	‏‏نعم‬
المعرف	string	المعرف الفريد لنداء الأداة المخصصة في منصة OpenAI.	لا
الادخال	string	المدخلات لاستدعاء الأداة المخصصة التي يولدها النموذج.	‏‏نعم‬
الاسم	string	اسم الأداة المخصصة التي يتم استدعاؤها.	‏‏نعم‬
النوع	enum	نوع استدعاء الأداة المخصصة. دائمًا custom_tool_call. القيم المحتملة: custom_tool_call	‏‏نعم‬

OpenAI.ConversationItemCustomToolCallOutput

يتم إرسال مخرجات استدعاء أداة مخصصة من كودك، إلى النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف النداء، المستخدم لتعيين مخرجات استدعاء الأداة المخصصة إلى أداة مخصصة.	‏‏نعم‬
المعرف	string	معرف فريد لإخراج استدعاء الأداة المخصصة في منصة OpenAI.	لا
الناتج	سلسلة أو صفيف OpenAI.FunctionAndCustomToolCallOutput	الناتج عن استدعاء الأداة المخصصة الذي يولده كودك. يمكن أن تكون سلسلة أو قائمة بمحتوى الإخراج.	‏‏نعم‬
النوع	enum	نوع مخرجات استدعاء الأداة المخصصة. دائمًا custom_tool_call_output. القيم المحتملة: custom_tool_call_output	‏‏نعم‬

OpenAI.ConversationItemFileSearchToolCall

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الفريد لاستدعاء أداة البحث عن الملفات.	‏‏نعم‬
queries	صفيف سلسلة	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
results	مصفوفة من OpenAI.FileSearchToolCallResults أو null		لا
الحالة	enum	حالة استدعاء أداة البحث عن الملفات. واحد من in_progress، searching، incomplete أو failed، القيم المحتملة: in_progress، searching، completed، ، incompletefailed	‏‏نعم‬
النوع	enum	نوع استدعاء أداة البحث عن الملفات. دائمًا file_search_call. القيم المحتملة: file_search_call	‏‏نعم‬

OpenAI.ConversationItemFunctionShellCall

استدعاء أداة ينفذ أمر shell واحد أو أكثر في بيئة مدارة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.FunctionShellAction	تنفيذ أمر shell.	‏‏نعم‬
└─ الأوامر	صفيف سلسلة		‏‏نعم‬
└─ max_output_length	عدد صحيح أو صفري		‏‏نعم‬
└─ timeout_ms	عدد صحيح أو صفري		‏‏نعم‬
call_id	string	معرف فريد لاستدعاء أداة الشل الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لاستدعاء أداة shell. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
الحالة	OpenAI.LocalShellCallStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا shell_call. القيم المحتملة: shell_call	‏‏نعم‬

OpenAI.ConversationItemFunctionShellCallOutput

إخراج استدعاء أداة shell التي تم إصدارها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة الشل الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الممثل الذي أنشأ العنصر.	لا
المعرف	string	المعرف الفريد لإخراج استدعاء shell. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
max_output_length	عدد صحيح أو صفري		‏‏نعم‬
الناتج	صفيف OpenAI.FunctionShellCallOutputContent	صفيف من محتويات إخراج استدعاء shell	‏‏نعم‬
النوع	enum	نوع إخراج استدعاء shell. دائمًا shell_call_output. القيم المحتملة: shell_call_output	‏‏نعم‬

OpenAI.ConversationItemFunctionToolCallOutputResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
المعرف	string	المعرف الفريد لإخراج استدعاء أداة الدالة. يتم ملؤه عند هذا العنصر يتم إرجاعها عبر واجهة برمجة التطبيقات.	لا
الناتج	سلسلة أو صفيف OpenAI.FunctionAndCustomToolCallOutput	الإخراج من استدعاء الدالة الذي تم إنشاؤه بواسطة التعليمات البرمجية الخاصة بك. يمكن أن تكون سلسلة أو قائمة بمحتوى الإخراج.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
النوع	enum	نوع إخراج استدعاء أداة الدالة. دائمًا function_call_output. القيم المحتملة: function_call_output	‏‏نعم‬

OpenAI.ConversationItemFunctionToolCallResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء أداة الدالة.	لا
الاسم	string	اسم الدالة المراد تشغيلها.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
النوع	enum	نوع استدعاء أداة الدالة. دائمًا function_call. القيم المحتملة: function_call	‏‏نعم‬

OpenAI.ConversationItemImageGenToolCall

طلب إنشاء صورة قام به النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	معرف فريد لنداء توليد الصورة.	‏‏نعم‬
نتيجة	سلسلة أو قيمة خالية		‏‏نعم‬
الحالة	enum	حالة مكالمة توليد الصور. القيم المحتملة: in_progress، completed، ، generatingfailed	‏‏نعم‬
النوع	enum	نوع مكالمة توليد الصور. دائمًا image_generation_call. القيم المحتملة: image_generation_call	‏‏نعم‬

OpenAI.ConversationItemList

قائمة بعناصر المحادثة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	صفيف OpenAI.ConversationItem	قائمة بعناصر المحادثة.	‏‏نعم‬
first_id	string	معرف العنصر الأول في القائمة.	‏‏نعم‬
has_more	boolean	ما إذا كان هناك المزيد من العناصر المتاحة.	‏‏نعم‬
last_id	string	معرف العنصر الأخير في القائمة.	‏‏نعم‬
object	enum	يجب أن يكون listنوع الكائن الذي تم إرجاعه . القيم المحتملة: list	‏‏نعم‬

OpenAI.ConversationItemLocalShellToolCall

استدعاء أداة لتشغيل أمر على الغلاف المحلي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.LocalShellExecAction	قم بتنفيذ أمر shell على الخادم.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة shell المحلية التي تم إنشاؤها بواسطة النموذج.	‏‏نعم‬
المعرف	string	معرف فريد لنداء الشل المحلي.	‏‏نعم‬
الحالة	enum	حالة نداء القذائف المحلي. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع نداء القذائف المحلي. دائمًا local_shell_call. القيم المحتملة: local_shell_call	‏‏نعم‬

OpenAI.ConversationItemLocalShellToolCallOutput

إخراج استدعاء أداة shell محلية.

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

OpenAI.ConversationItemMcpApprovalRequest

طلب موافقة بشرية على استدعاء أداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات للأداة.	‏‏نعم‬
المعرف	string	المعرف الفريد لطلب الموافقة.	‏‏نعم‬
الاسم	string	اسم الأداة المراد تشغيلها.	‏‏نعم‬
server_label	string	تسمية خادم MCP الذي يقدم الطلب.	‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا mcp_approval_request. القيم المحتملة: mcp_approval_request	‏‏نعم‬

OpenAI.ConversationItemMcpApprovalResponseResource

استجابة لطلب موافقة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
approval_request_id	string	معرف طلب الموافقة الذي يتم الرد عليه.	‏‏نعم‬
approve	boolean	ما إذا كان قد تمت الموافقة على الطلب.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستجابة الموافقة	‏‏نعم‬
السبب	سلسلة أو قيمة خالية		لا
النوع	enum	نوع العنصر. دائمًا mcp_approval_response. القيم المحتملة: mcp_approval_response	‏‏نعم‬

OpenAI.ConversationItemMcpListTools

قائمة بالأدوات المتوفرة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	سلسلة أو قيمة خالية		لا
المعرف	string	معرف القائمة.	‏‏نعم‬
server_label	string	تسمية خادم MCP.	‏‏نعم‬
الأدوات	صفيف OpenAI.MCPListToolsTool	الأدوات المتوفرة على الخادم.	‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا mcp_list_tools. القيم المحتملة: mcp_list_tools	‏‏نعم‬

OpenAI.ConversationItemMcpToolCall

استدعاء أداة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
approval_request_id	سلسلة أو قيمة خالية		لا
الحجج	string	سلسلة JSON من الوسيطات التي تم تمريرها إلى الأداة.	‏‏نعم‬
خطأ	سلسلة أو قيمة خالية		لا
المعرف	string	معرف فريد لاستدعاء الأداة.	‏‏نعم‬
الاسم	string	اسم الأداة التي تم تشغيلها.	‏‏نعم‬
الناتج	سلسلة أو قيمة خالية		لا
server_label	string	تسمية خادم MCP الذي يقوم بتشغيل الأداة.	‏‏نعم‬
الحالة	OpenAI.MCPToolCallStatus		لا
النوع	enum	نوع العنصر. دائمًا mcp_call. القيم المحتملة: mcp_call	‏‏نعم‬

OpenAI.ConversationItemMessage

رسالة إلى النموذج أو منه.

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	مصفوفة من OpenAI.InputTextContent أو OpenAI.OutputTextContent أو OpenAI.TextContent أو OpenAI.SummaryTextContent أو OpenAI.ReasoningTextContent أو OpenAI.RefusalContent أو OpenAI.InputImageContent أو OpenAI.ComputerScreenshotContent أو OpenAI.InputFileContent	محتوى الرسالة	‏‏نعم‬
المعرف	string	المعرف الفريد للرسالة.	‏‏نعم‬
role	OpenAI.MessageRole		‏‏نعم‬
الحالة	OpenAI.MessageStatus		‏‏نعم‬
النوع	enum	نوع الرسالة. عيّنها بشل دائم إلى message. القيم المحتملة: message	‏‏نعم‬

OpenAI.ConversationItemReasoningItem

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف OpenAI.ReasoningTextContent	محتوى نص منطقي.	لا
encrypted_content	سلسلة أو قيمة خالية		لا
المعرف	string	المعرف الفريد لمحتوى المنطق.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
الملخص.	صفيف OpenAI.Summary	ملخص المنطق والمحتوى.	‏‏نعم‬
النوع	enum	نوع الكائن. دائمًا reasoning. القيم المحتملة: reasoning	‏‏نعم‬

OpenAI.ConversationItemType

الخاصية	قيمة
نوع	string
Values	message function_call function_call_output file_search_call web_search_call image_generation_call computer_call computer_call_output reasoning code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call custom_tool_call custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.WebSearchActionSearch أو OpenAI.WebSearchActionOpenPage أو OpenAI.WebSearchActionFind	كائن يصف الإجراء المحدد الذي تم اتخاذه في استدعاء بحث الويب هذا. يتضمن تفاصيل حول كيفية استخدام النموذج للويب (البحث ، open_page ، البحث).	‏‏نعم‬
المعرف	string	المعرف الفريد لأداة البحث على الويب.	‏‏نعم‬
الحالة	enum	حالة استدعاء أداة البحث على الويب. القيم المحتملة: in_progress، searching، ، completedfailed	‏‏نعم‬
النوع	enum	نوع مكالمة أداة البحث على الويب. دائمًا web_search_call. القيم المحتملة: web_search_call	‏‏نعم‬

OpenAI.ConversationParam

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

النوع: سلسلة أو OpenAI.ConversationParam-2

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

OpenAI.ConversationParam-2

المحادثة التي تنتمي إليها هذه الاستجابة.

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

OpenAI.ConversationReference

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

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

OpenAI.ConversationResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الوقت الذي تم فيه إنشاء المحادثة، تم قياسها بالثوان منذ عهد Unix.	‏‏نعم‬
المعرف	string	المعرف الفريد للمحادثة.	‏‏نعم‬
metadata		مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	‏‏نعم‬
object	enum	نوع الكائن، الذي يتم conversationدائما . القيم المحتملة: conversation	‏‏نعم‬

OpenAI.CreateChatCompletionRequestAudio

الاسم	النوع	وصف	مطلوب	الإفتراضي
format	enum	القيم المحتملة: wav، aac، mp3، flac، ، opuspcm16	‏‏نعم‬
صوت	OpenAI.VoiceIdsShared		‏‏نعم‬

OpenAI.CreateChatCompletionRequestResponseFormat

كائن يحدد التنسيق الذي يجب على النموذج إخراجه. الإعداد لتمكين { "type": "json_schema", "json_schema": {...} } المخرجات المنظمة التي تضمن أن النموذج سيتطابق مخطط JSON المرفق لديك. تعرف على المزيد في دليل المخرجات المنظمة. الإعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام json_schema للنماذج التي تدعمه.

تمييز ل OpenAI.CreateChatCompletionRequestResponseFormat

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

قيمة النوع	Schema
json_schema	OpenAI.ResponseFormatJsonSchema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.CreateChatCompletionRequestResponseFormatType		‏‏نعم‬

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

تنسيق استجابة كائن JSON. طريقة قديمة لإنشاء استجابات JSON. يوصى باستخدام json_schema للنماذج التي تدعمه. لاحظ أن النموذج لن ينشئ JSON بدون رسالة نظام أو مستخدم ترشده إلى القيام بذلك.

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

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

تنسيق الاستجابة الافتراضي. يستخدم لإنشاء استجابات نصية.

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

OpenAI.CreateChatCompletionRequestResponseFormatType

الخاصية	قيمة
نوع	string
Values	text json_schema json_object

OpenAI.Create ChatCompletionResponseChoices

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_filter_results	AzureContentFilterResultForChoice	نتيجة عامل تصفية المحتوى لعنصر استجابة واحد ينتج بواسطة نظام الذكاء الاصطناعي التوليدي.	لا
finish_reason	enum	القيم المحتملة: stop، length، tool_calls، ، content_filterfunction_call	‏‏نعم‬
الفهرس	integer		‏‏نعم‬
سجلات الحماية	OpenAI.CreateChatCompletionResponseChoicesLogprobs أو null		‏‏نعم‬
رسالة	OpenAI.ChatCompletionResponseMessage	إذا تم طلب طريقة إخراج الصوت، فإن هذا الكائن يحتوي على بيانات حول الاستجابة الصوتية من النموذج.	‏‏نعم‬

OpenAI.CreateChatCompletionResponseChoicesLogprobs

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	مصفوفة OpenAI.ChatCompletionTokenLogprob أو null		‏‏نعم‬
رفض	مصفوفة OpenAI.ChatCompletionTokenLogprob أو null		‏‏نعم‬

OpenAI.Create ChatCompletionStreamResponseChoices

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	OpenAI.ChatCompletionStreamResponseDelta	دلتا إكمال الدردشة التي تم إنشاؤها بواسطة استجابات النموذج المتدفقة.	‏‏نعم‬
finish_reason	سلسلة أو قيمة خالية		‏‏نعم‬
الفهرس	integer		‏‏نعم‬
سجلات الحماية	OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs أو null		لا

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	مصفوفة OpenAI.ChatCompletionTokenLogprob أو null		‏‏نعم‬
رفض	مصفوفة OpenAI.ChatCompletionTokenLogprob أو null		‏‏نعم‬

OpenAI.CreateCompletionResponseChoices

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_filter_results	AzureContentFilterResultForChoice	نتيجة عامل تصفية المحتوى لعنصر استجابة واحد ينتج بواسطة نظام الذكاء الاصطناعي التوليدي.	لا
finish_reason	enum	القيم المحتملة: stop، ، lengthcontent_filter	‏‏نعم‬
الفهرس	integer		‏‏نعم‬
سجلات الحماية	OpenAI.CreateCompletionResponseChoicesLogprobs أو null		‏‏نعم‬
نص	string		‏‏نعم‬

OpenAI.CreateCompletionResponseChoicesLogprobs

الاسم	النوع	وصف	مطلوب	الإفتراضي
text_offset	صفيف من الأعداد الصحيحة		لا
token_logprobs	مصفوفة الأعداد		لا
tokens	صفيف سلسلة		لا
top_logprobs	صفيف من العناصر		لا

OpenAI.CreateContainerBody

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_after	OpenAI.CreateContainerBodyExpiresAfter		لا
└─ مرساة	enum	القيم المحتملة: last_active_at	‏‏نعم‬
└─ دقائق	integer		‏‏نعم‬
file_ids	صفيف سلسلة	معرفات الملفات التي يجب نسخها إلى الحاوية.	لا
memory_limit	enum	حد ذاكرة اختياري للحاوية. الوضع الافتراضي هو "1g". القيم المحتملة: 1g، 4g، ، 16g64g	لا
الاسم	string	اسم الحاوية التي يجب إنشاؤها.	‏‏نعم‬

OpenAI.CreateContainerBodyExpiresAfter

الاسم	النوع	وصف	مطلوب	الإفتراضي
anchor	enum	القيم المحتملة: last_active_at	‏‏نعم‬
محضر	integer		‏‏نعم‬

OpenAI.CreateContainerFileBody

الاسم	النوع	وصف	مطلوب	الإفتراضي
ملف		كائن الملف (وليس اسم الملف) الذي يجب رفعه.	لا
file_id	string	اسم الملف الذي يجب إنشاؤه.	لا

OpenAI.CreateConversationBody

الاسم	النوع	وصف	مطلوب	الإفتراضي
العناصر	مصفوفة من OpenAI.InputItem أو null		لا
metadata	OpenAI.Metadata أو null		لا

OpenAI.CreateConversationItemsParametersBody

الاسم	النوع	وصف	مطلوب	الإفتراضي
العناصر	صفيف OpenAI.InputItem		‏‏نعم‬

OpenAI.CreateEmbeddingRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
ابعاد	integer	عدد الأبعاد التي يجب أن تحتوي عليها تضمينات الإخراج الناتجة. مدعوم فقط في text-embedding-3 والنماذج الأحدث. القيود: الحد الأدنى: 1	لا
encoding_format	enum	التنسيق الذي يجب إرجاع التضمينات فيه. يمكن أن يكون إما float أو base64. القيم المحتملة: float، base64	لا
الادخال	سلسلة أو مصفوفة من السلسلة أو مصفوفة من عدد صحيح أو مصفوفة من المصفوفة	إدخال نص لتضمينه أو ترميزه كسلسلة أو صفيف من الرموز المميزة. لتضمين مدخلات متعددة في طلب واحد، مرر صفيف سلاسل أو صفيف من صفائف الرمز المميز. يجب ألا يتجاوز الإدخال الحد الأقصى لرموز الإدخال للنموذج (8,192 رمزا لجميع نماذج التضمين)، ولا يمكن أن يكون سلسلة فارغة، ويجب أن تكون أي مصفوفة ببعد 2,048 أو أقل. مثال على كود بايثون لعد الرموز. بالإضافة إلى حد الرمز لكل إدخال، تفرض جميع نماذج التضمين مجموع حد أقصى يصل إلى 300,000 رمز عبر جميع المدخلات في طلب واحد.	‏‏نعم‬
نموذج	string	معرف النموذج المراد استخدامه. يمكنك استخدام واجهة برمجة تطبيقات نماذج القائمة لرؤية جميع النماذج المتاحة لديك، أو الاطلاع على نظرة عامة على النماذج لوصفها.	‏‏نعم‬
user	string	تعرّف على المزيد.	لا

OpenAI.CreateEmbeddingResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة من OpenAI.Embedding	قائمة التضمينات التي تم إنشاؤها بواسطة النموذج.	‏‏نعم‬
نموذج	string	اسم النموذج المستخدم لإنشاء التضمين.	‏‏نعم‬
object	enum	نوع الكائن، وهو دائما "قائمة". القيم المحتملة: list	‏‏نعم‬
استخدام	OpenAI.CreateEmbeddingResponseUsage		‏‏نعم‬
└─ prompt_tokens	integer		‏‏نعم‬
└─ total_tokens	integer		‏‏نعم‬

OpenAI.CreateEmbeddingResponseUsage

الاسم	النوع	وصف	مطلوب	الإفتراضي
prompt_tokens	integer		‏‏نعم‬
total_tokens	integer		‏‏نعم‬

OpenAI.CreateEvalCompletionsRunDataSource

كائن CompletionsRunDataSource يصف تكوين أخذ عينات نموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_messages	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate أو OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	يستخدم عند أخذ العينات من نموذج. تملي بنية الرسائل التي تم تمريرها إلى النموذج. يمكن أن يكون إما مرجعا لمسار تم إنشاؤه مسبقا (أي)، item.input_trajectoryأو قالب مع مراجع متغيرة item لمساحة الاسم.	لا
نموذج	string	اسم النموذج المستخدم لتوليد الإكمال (مثل "o3-mini").	لا
sampling_params	AzureCompletionsSamplingParams	معايير أخذ عينات للتحكم في سلوك الإكمالات.	لا
المصدر	OpenAI.EvalJsonlFileContentSource أو OpenAI.EvalJsonlFileIdSource أو OpenAI.EvalStoredCompletionsSource	تحديد ما يملأ item مساحة الاسم في مصدر بيانات هذا التشغيل.	‏‏نعم‬
النوع	enum	نوع مصدر بيانات التشغيل. دائمًا completions. القيم المحتملة: completions	‏‏نعم‬

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_reference	string		‏‏نعم‬
النوع	enum	القيم المحتملة: item_reference	‏‏نعم‬

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

الاسم	النوع	وصف	مطلوب	الإفتراضي
template	صفيف OpenAI.EasyInputMessage أو OpenAI.EvalItem		‏‏نعم‬
النوع	enum	القيم المحتملة: template	‏‏نعم‬

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_completion_tokens	integer		لا
reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
response_format	OpenAI.ResponseFormatText أو OpenAI.ResponseFormatJsonSchema أو OpenAI.ResponseFormatJsonObject		لا
seed	integer	قيمة البذرة تهيئ العشوائية أثناء أخذ العينة.	لا	42
درجة الحرارة	رقم	تزيد درجة الحرارة الأعلى من العشوائية في المخرجات.	لا	1
الأدوات	صفيف OpenAI.ChatCompletionTool		لا
top_p	رقم	بديل لدرجة الحرارة لأخذ عينات النواة؛ يتضمن 1.0 جميع الرموز المميزة.	لا	1

OpenAI.CreateEvalCustomDataSourceConfig

كائن CustomDataSourceConfig الذي يعرف مخطط مصدر البيانات المستخدم في عمليات تشغيل التقييم. يستخدم هذا المخطط لتحديد شكل البيانات التي ستكون:

• تستخدم لتحديد معايير الاختبار الخاصة بك و
• ما هي البيانات المطلوبة عند إنشاء تشغيل

الاسم	النوع	وصف	مطلوب	الإفتراضي
include_sample_schema	boolean	ما إذا كان يجب أن يتوقع التقييم ملء مساحة الاسم النموذجية (أي عن طريق إنشاء استجابات من مصدر البيانات الخاص بك)	لا
item_schema	object	مخطط json لكل صف في مصدر البيانات.	‏‏نعم‬
النوع	enum	نوع مصدر البيانات. دائمًا custom. القيم المحتملة: custom	‏‏نعم‬

OpenAI.CreateEvalItem

رسالة دردشة تشكل المطالبة أو السياق. قد تتضمن مراجع متغيرة إلى item مساحة الاسم، أي {{item.name}}.

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	string	محتوى الرسالة.	‏‏نعم‬
role	string	دور الرسالة (مثل "نظام"، "مساعد"، "مستخدم").	‏‏نعم‬

OpenAI.CreateEvalJsonlRunDataSource

كائن JsonlRunDataSource مع الذي يحدد ملف JSONL الذي يطابق التقييم

الاسم	النوع	وصف	مطلوب	الإفتراضي
المصدر	OpenAI.EvalJsonlFileContentSource أو OpenAI.EvalJsonlFileIdSource	تحديد ما يملأ item مساحة الاسم في مصدر البيانات.	‏‏نعم‬
النوع	enum	نوع مصدر البيانات. دائمًا jsonl. القيم المحتملة: jsonl	‏‏نعم‬

OpenAI.CreateEvalLabelModelGrader

عنصر LabelModelGrader الذي يستخدم نموذجا لتعيين تسميات لكل عنصر في التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	مصفوفة من OpenAI.CreateEvalItem	قائمة برسائل الدردشة التي تشكل المطالبة أو السياق. قد تتضمن مراجع متغيرة إلى item مساحة الاسم، أي {{item.name}}.	‏‏نعم‬
labels	صفيف سلسلة	التسميات المراد تصنيفها إلى كل عنصر في التقييم.	‏‏نعم‬
نموذج	string	النموذج الذي يجب استخدامه للتقييم. يجب أن يدعم المخرجات المنظمة.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
passing_labels	صفيف سلسلة	التسميات التي تشير إلى نتيجة تمرير. يجب أن تكون مجموعة فرعية من التسميات.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: label_model	‏‏نعم‬

OpenAI.CreateEvalLogsDataSourceConfig

تكوين مصدر البيانات الذي يحدد خاصية بيانات التعريف لاستعلام السجلات. عادة ما تكون هذه بيانات تعريف مثل usecase=chatbot أو prompt-version=v2، وما إلى ذلك.

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	عوامل تصفية بيانات التعريف لمصدر بيانات السجلات.	لا
النوع	enum	نوع مصدر البيانات. دائمًا logs. القيم المحتملة: logs	‏‏نعم‬

OpenAI.CreateEvalResponsesRunDataSource

كائن ResponsesRunDataSource يصف تكوين أخذ عينات نموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_messages	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate أو OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	يستخدم عند أخذ العينات من نموذج. تملي بنية الرسائل التي تم تمريرها إلى النموذج. يمكن أن يكون إما مرجعا لمسار تم إنشاؤه مسبقا (أي)، item.input_trajectoryأو قالب مع مراجع متغيرة item لمساحة الاسم.	لا
نموذج	string	اسم النموذج المستخدم لتوليد الإكمال (مثل "o3-mini").	لا
sampling_params	AzureResponsesSamplingParams	معايير أخذ عينات للتحكم في سلوك الاستجابات.	لا
المصدر	OpenAI.EvalJsonlFileContentSource أو OpenAI.EvalJsonlFileIdSource أو OpenAI.EvalResponsesSource	تحديد ما يملأ item مساحة الاسم في مصدر بيانات هذا التشغيل.	‏‏نعم‬
النوع	enum	نوع مصدر بيانات التشغيل. دائمًا responses. القيم المحتملة: responses	‏‏نعم‬

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_reference	string		‏‏نعم‬
النوع	enum	القيم المحتملة: item_reference	‏‏نعم‬

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

الاسم	النوع	وصف	مطلوب	الإفتراضي
template	صفيف الكائن أو OpenAI.EvalItem		‏‏نعم‬
النوع	enum	القيم المحتملة: template	‏‏نعم‬

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

الاسم	النوع	وصف	مطلوب	الإفتراضي
reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
seed	integer	قيمة البذرة تهيئ العشوائية أثناء أخذ العينة.	لا	42
درجة الحرارة	رقم	تزيد درجة الحرارة الأعلى من العشوائية في المخرجات.	لا	1
نص	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		لا
الأدوات	صفيف OpenAI.Tool		لا
top_p	رقم	بديل لدرجة الحرارة لأخذ عينات النواة؛ يتضمن 1.0 جميع الرموز المميزة.	لا	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

الاسم	النوع	وصف	مطلوب	الإفتراضي
format	OpenAI.TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين { "type": "json_schema" } المخرجات المنظمة ، مما يضمن أن النموذج سوف يتطابق مع مخطط JSON المرفق. تعرف على المزيد في التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية. *غير مستحسن لنماذج gpt-4o والأحدث:** إعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. استخدام json_schema يفضل للنماذج التي تدعمه.	لا

OpenAI.CreateEvalRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_source	OpenAI.CreateEvalJsonlRunDataSource أو OpenAI.CreateEvalCompletionsRunDataSource أو OpenAI.CreateEvalResponsesRunDataSource	تفاصيل حول مصدر بيانات التشغيل.	‏‏نعم‬
metadata	OpenAI.Metadata أو null		لا
الاسم	string	اسم التشغيل.	لا

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

تم إهمالها لصالح LogsDataSourceConfig.

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	عوامل تصفية بيانات التعريف لمصدر بيانات الاكتمال المخزنة.	لا
النوع	enum	نوع مصدر البيانات. دائمًا stored_completions. القيم المحتملة: stored_completions	‏‏نعم‬

OpenAI.CreateFileRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_after	object		‏‏نعم‬
└─ مرساة	AzureFileExpiryAnchor		‏‏نعم‬
└─ ثواني	integer		‏‏نعم‬
ملف		كائن الملف (وليس اسم الملف) الذي يجب رفعه.	‏‏نعم‬
قصد	enum	الغرض المقصود من الملف الذي تم تحميله. واحد من: - assistants: يستخدم في واجهة برمجة تطبيقات المساعدين - batch: يستخدم في واجهة برمجة التطبيقات الدفعية - fine-tune: يستخدم للضبط الدقيق - evals: يستخدم لمجموعات بيانات التقييم القيم المحتملة: assistants، batch، ، fine-tuneevals	‏‏نعم‬

OpenAI.CreateFineTuningCheckpointPermissionRequest

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

OpenAI.CreateFineTuningJobRequest

موديلات صالحة:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعلمات الفائقة	OpenAI.CreateFineTuningJobRequestHyperparameters		لا
└─ batch_size	سلسلة أو عدد صحيح		لا	تلقائي
└─ learning_rate_multiplier	السلسلة أو الرقم		لا
└─ n_epochs	سلسلة أو عدد صحيح		لا	تلقائي
التكامل	مصفوفة من OpenAI.CreateFineTuningJobRequestIntegrations أو null	قائمة عمليات التكامل لتمكينها من مهمة الضبط الدقيق.	لا
metadata	OpenAI.Metadata أو null		لا
method	OpenAI.FineTuneMethod	الطريقة المستخدمة للضبط الدقيق.	لا
نموذج	سلسلة (راجع النماذج الصالحة أدناه)	اسم النموذج المراد ضبطه. يمكنك تحديد أحد الرموز النماذج المدعومة.	‏‏نعم‬
seed	عدد صحيح أو صفري	تتحكم البيانات الأولية في إمكانية إعادة إنتاج الوظيفة. يجب أن يؤدي في نفس البيانات الأولية ونفس معلمات الوظيفة أن ينتج نفس النتائج، لكن قد يحدث اختلاف في حالات نادرة. إذا لم يتم تحديد البذور، إنشاء واحد لك.	لا
لاحقه	سلسلة أو قيمة خالية	سلسلة تصل إلى 64 حرفا ستتم إضافتها إلى اسم الطراز المضبوط بدقة. على سبيل المثال ، سينتج عن suffix "custom-model-name" اسم نموذج مثل ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	لا
training_file	string	معرف الملف الذي تم تحميله والذي يحتوي على بيانات التدريب. راجع تحميل ملف لمعرفة كيفية تحميل ملف. يجب تنسيق مجموعة البيانات الخاصة بك كملف JSONL. بالإضافة إلى ذلك ، يجب عليك تحميل ملفك لهذا الغرض fine-tune. يجب أن تختلف محتويات الملف بناء على ما إذا كان النموذج يستخدم الدردشة أو تنسيق الإكمال أو إذا كان أسلوب الضبط يستخدم تنسيق التفضيل . راجع دليل الضبط الدقيق لمزيد من التفاصيل.	‏‏نعم‬
validation_file	سلسلة أو قيمة خالية	معرف الملف الذي تم تحميله والذي يحتوي على بيانات التحقق من الصحة. إذا قمت بتوفير هذا الملف، استخدام البيانات لإنشاء التحقق من الصحة المقاييس بشكل دوري أثناء الضبط الدقيق. يمكن الاطلاع على هذه المقاييس في ملف نتائج الضبط الدقيق. يجب ألا تكون نفس البيانات موجودة في كل من ملفات التدريب والتحقق من الصحة. يجب تنسيق مجموعة البيانات الخاصة بك كملف JSONL. يجب عليك تحميل ملفك لهذا الغرض fine-tune. راجع دليل الضبط الدقيق لمزيد من التفاصيل.	لا

OpenAI.CreateFineTuningJobRequestHyperparameters

الاسم	النوع	وصف	مطلوب	الإفتراضي
batch_size	سلسلة أو عدد صحيح		لا
learning_rate_multiplier	السلسلة أو الرقم		لا
n_epochs	سلسلة أو عدد صحيح		لا

OpenAI.CreateFineTuningJobRequestIntegrations

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: wandb	‏‏نعم‬
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		‏‏نعم‬

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

الاسم	النوع	وصف	مطلوب	الإفتراضي
الكيان	سلسلة أو قيمة خالية		لا
الاسم	سلسلة أو قيمة خالية		لا
المشروع	string		‏‏نعم‬
العلامات	صفيف سلسلة		لا

OpenAI.CreateMessageRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
attachments	مصفوفة من OpenAI.CreateMessageRequestAttachments أو null		لا
محتوى	سلسلة أو مصفوفة من OpenAI.MessageContentImageFileObject أو OpenAI.MessageContentImageUrlObject أو OpenAI.MessageRequestContentTextObject		‏‏نعم‬
metadata	OpenAI.Metadata أو null		لا
role	enum	دور الكيان الذي يقوم بإنشاء الرسالة. تتضمن القيم المسموح بها ما يلي: - user: يشير إلى أن الرسالة يتم إرسالها بواسطة مستخدم فعلي ويجب استخدامها في معظم الحالات لتمثيل الرسائل التي أنشأها المستخدم. - assistant: يشير إلى إنشاء الرسالة بواسطة المساعد. استخدم هذه القيمة لإدراج رسائل من المساعد في المحادثة. القيم المحتملة: user، assistant	‏‏نعم‬

OpenAI.CreateMessageRequestAttachments

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	string		لا
الأدوات	مصفوفة من OpenAI.AssistantToolsCode أو OpenAI.AssistantToolsFileSearchTypeOnly		لا

OpenAI.CreateResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
background	بوليان أو نول		لا
حوار	OpenAI.ConversationParam أو null		لا
include	مصفوفة OpenAI.IncludeEnum أو null		لا
الادخال	OpenAI.InputParam	النص أو الصورة أو إدخالات الملفات إلى النموذج، المستخدمة لإنشاء استجابة. اعرف المزيد‬: - مدخلات ومخرجات النص - إدخالات الصور - إدخالات الملفات - حالة المحادثة - استدعاء الدالة	لا
تعليمات	سلسلة أو قيمة خالية		لا
max_output_tokens	عدد صحيح أو صفري		لا
max_tool_calls	عدد صحيح أو صفري		لا
metadata	OpenAI.Metadata أو null		لا
نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	لا
parallel_tool_calls	بوليان أو نول		لا
previous_response_id	سلسلة أو قيمة خالية		لا
فوري	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
prompt_cache_retention	سلسلة أو قيمة خالية		لا
المنطق	OpenAI.Reasoning أو null		لا
safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
store	بوليان أو نول		لا
استدر	بوليان أو نول		لا
stream_options	OpenAI.ResponseStreamOptions أو null		لا
درجة الحرارة	عدد أو صفرا		لا
نص	OpenAI.ResponseTextParam	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
tool_choice	OpenAI.ToolChoiceParam	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
الأدوات	OpenAI.ToolsArray	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . ندعم الفئات التالية من الأدوات: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. معرفة المزيد حول الأدوات المضمنة. - أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو موصلات معرفة مسبقا مثل Google Drive وSharePoint. معرفة المزيد حول أدوات MCP. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك باستخدام وسيطات مكتوبة بقوة والمخرجات. معرفة المزيد حول استدعاء الدالة. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.	لا
top_logprobs	عدد صحيح أو صفري		لا
top_p	عدد أو صفرا		لا
اقتطاع	سلسلة أو قيمة خالية		لا
user	سلسلة (مهملة)	يتم استبدال هذا الحقل ب safety_identifier و prompt_cache_key. استخدم prompt_cache_key بدلا من ذلك للحفاظ على تحسينات التخزين المؤقت. معرف ثابت للمستخدمين النهائيين. يستخدم لزيادة معدلات الوصول إلى ذاكرة التخزين المؤقت عن طريق تجميع الطلبات المماثلة بشكل أفضل ولمساعدة OpenAI في اكتشاف إساءة الاستخدام ومنعها. تعرّف على المزيد.	لا

OpenAI.CreateRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
additional_instructions	سلسلة أو قيمة خالية	إلحاق إرشادات إضافية في نهاية التعليمات الخاصة بالتشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل دون تجاوز إرشادات أخرى.	لا
additional_messages	مصفوفة OpenAI.CreateMessageRequest أو null	إضافة رسائل إضافية إلى مؤشر الترابط قبل إنشاء التشغيل.	لا
assistant_id	string	معرف المساعد الذي سيستخدم لتنفيذ هذه الجولة.	‏‏نعم‬
تعليمات	سلسلة أو قيمة خالية	يتجاوز تعليمات المساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
max_completion_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. ستبذل الجولة قصارى جهدها لاستخدام عدد رموز الإكمال المحددة فقط، عبر عدة أدوار من الجولة. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.	لا
max_prompt_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. ستبذل الجولة أقصى جهد لاستخدام عدد رموز الأوامر المحددة فقط، عبر عدة أدوار من الجولة. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.	لا
metadata	OpenAI.Metadata أو null		لا
نموذج	string	معرف النموذج المستخدم لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	لا
parallel_tool_calls	OpenAI.ParallelToolCalls	ما إذا كنت تريد تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا
reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
response_format	OpenAI.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 الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
استدر	بوليان أو نول	إذا true، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة data: [DONE].	لا
درجة الحرارة	عدد أو صفرا	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا
tool_choice	OpenAI.AssistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. auto هي القيمة الافتراضية وتعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. required يعني أن النموذج يجب أن يستدعي أداة أو أكثر قبل الرد على المستخدم. تحديد أداة معينة مثل {"type": "file_search"} أو {"type": "function", "function": {"name": "my_function"}} يجبر النموذج على استدعاء تلك الأداة.	لا
الأدوات	مصفوفة من OpenAI.AssistantTool	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
top_p	عدد أو صفرا	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا
truncation_strategy	OpenAI.CutncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	لا

OpenAI.CreateThreadAndRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
assistant_id	string	معرف المساعد الذي سيستخدم لتنفيذ هذه الجولة.	‏‏نعم‬
تعليمات	سلسلة أو قيمة خالية	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
max_completion_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. ستبذل الجولة قصارى جهدها لاستخدام عدد رموز الإكمال المحددة فقط، عبر عدة أدوار من الجولة. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.	لا
max_prompt_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. ستبذل الجولة أقصى جهد لاستخدام عدد رموز الأوامر المحددة فقط، عبر عدة أدوار من الجولة. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.	لا
metadata	OpenAI.Metadata أو null		لا
نموذج	string	معرف النموذج المستخدم لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	لا
parallel_tool_calls	OpenAI.ParallelToolCalls	ما إذا كنت تريد تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	لا
response_format	OpenAI.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 الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	لا
استدر	بوليان أو نول	إذا true، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة data: [DONE].	لا
درجة الحرارة	عدد أو صفرا	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	لا
thread	OpenAI.CreateThreadRequest	خيارات لإنشاء موضوع جديد. إذا لم يتم توفير خيط عند تشغيل طلب، سيتم إنشاء خيط فارغ.	لا
tool_choice	OpenAI.AssistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. auto هي القيمة الافتراضية وتعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. required يعني أن النموذج يجب أن يستدعي أداة أو أكثر قبل الرد على المستخدم. تحديد أداة معينة مثل {"type": "file_search"} أو {"type": "function", "function": {"name": "my_function"}} يجبر النموذج على استدعاء تلك الأداة.	لا
tool_resources	OpenAI.CreateThreadAndRunRequestToolResources أو null	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة code_interpreter قائمة بمعرفات الملفات، بينما تتطلب أداة file_search قائمة بمعرفات مخزن المتجهات.	لا
الأدوات	مصفوفة من OpenAI.AssistantTool	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	لا
top_p	عدد أو صفرا	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	لا
truncation_strategy	OpenAI.CutncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	لا

OpenAI.CreateThreadAndRunRequestToolResources

الاسم	النوع	وصف	مطلوب	الإفتراضي
code_interpreter	OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter		لا
file_search	OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch		لا

OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_ids	صفيف سلسلة		لا	[]

OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch

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

OpenAI.CreateThreadRequest

خيارات لإنشاء موضوع جديد. إذا لم يتم توفير خيط عند تشغيل طلب، سيتم إنشاء خيط فارغ.

الاسم	النوع	وصف	مطلوب	الإفتراضي
messages	مصفوفة OpenAI.CreateMessageRequest	قائمة بالرسائل لبدء الموضوع.	لا
metadata	OpenAI.Metadata أو null		لا
tool_resources	OpenAI.CreateThreadRequestToolResources أو null		لا

OpenAI.CreateThreadRequestToolResources

الاسم	النوع	وصف	مطلوب	الإفتراضي
code_interpreter	OpenAI.CreateThreadRequestToolResourcesCodeInterpreter		لا
file_search	مفعول أو كائن		لا

OpenAI.CreateThreadRequestToolResourcesCodeInterpreter

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

OpenAI.CreateVectorStoreFileBatchRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		لا
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية auto . ينطبق فقط إذا كان file_ids غير فارغ.	لا
file_ids	صفيف سلسلة	قائمة بمعرفات الملفات التي يجب أن يستخدمها المخزن المتجه. مفيد لأدوات مثل file_search التي يمكنها الوصول إلى الملفات. إذا attributes تم توفيرها أو chunking_strategy تم توفيرها، فسيتم تطبيقها على جميع الملفات في الدفعة. غير متعارضين مع files.	لا
files	مصفوفة OpenAI.CreateVectorStoreFileRequest	قائمة بالكائنات التي تحتوي file_id كل منها على جمع أو اختياري attributes أو chunking_strategy. استخدم هذا عندما تحتاج إلى تجاوز البيانات الوصفية لملفات محددة. سيتم تجاهل الرقم العام (or chunking_strategy العموميattributes) ويجب تحديده لكل ملف. غير متعارضين مع file_ids.	لا

OpenAI.CreateVectorStoreFileRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		لا
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية auto . ينطبق فقط إذا كان file_ids غير فارغ.	لا
file_id	string	معرف ملف يجب أن يستخدمه متجر المتجهات. مفيد لأدوات مثل file_search التي يمكنها الوصول إلى الملفات.	‏‏نعم‬

OpenAI.CreateVectorStoreطلب

الاسم	النوع	وصف	مطلوب	الإفتراضي
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية auto . ينطبق فقط إذا كان file_ids غير فارغ.	لا
الوصف	string	وصف لمتجر المتجهات. يمكن استخدامه لوصف هدف متجر المتجهات.	لا
expires_after	OpenAI.VectorStoreExpirationبعد	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
file_ids	صفيف سلسلة	قائمة بمعرفات الملفات التي يجب أن يستخدمها المخزن المتجه. مفيد لأدوات مثل file_search التي يمكنها الوصول إلى الملفات.	لا
metadata	OpenAI.Metadata أو null		لا
الاسم	string	اسم مخزن المتجهات.	لا

OpenAI.CustomGrammarFormatParam

قواعد نحوية يحددها المستخدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	string	التعريف النحوي (النحو الصحيح).	‏‏نعم‬
بناء الجمله	OpenAI.GrammarSyntax1		‏‏نعم‬
النوع	enum	تنسيق القواعد. دائمًا grammar. القيم المحتملة: grammar	‏‏نعم‬

OpenAI.CustomTextFormatParam

نص حر غير مقيد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	تنسيق النص غير المقيد. دائمًا text. القيم المحتملة: text	‏‏نعم‬

OpenAI.CustomToolChatCompleteions

أداة مخصصة تعالج المدخلات باستخدام تنسيق محدد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تقليد	OpenAI.CustomToolChatCompletionsCustom		‏‏نعم‬
└─ الوصف	string		لا
└─ التنسيق	OpenAI.CustomToolChatCompletionsCustomFormatText أو OpenAI.CustomToolChatCompletionsCustomFormatGrammar		لا
└─ الاسم	string		‏‏نعم‬
النوع	enum	نوع الأداة المخصصة. دائمًا custom. القيم المحتملة: custom	‏‏نعم‬

OpenAI.CustomToolChatCompletionsCustom

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string		لا
format	OpenAI.CustomToolChatCompletionsCustomFormatText أو OpenAI.CustomToolChatCompletionsCustomFormatGrammar		لا
الاسم	string		‏‏نعم‬

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

الاسم	النوع	وصف	مطلوب	الإفتراضي
القواعد	OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar		‏‏نعم‬
└─ تعريف	string		‏‏نعم‬
└─ بناء الجملة	enum	القيم المحتملة: lark، regex	‏‏نعم‬
النوع	enum	القيم المحتملة: grammar	‏‏نعم‬

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	string		‏‏نعم‬
بناء الجمله	enum	القيم المحتملة: lark، regex	‏‏نعم‬

OpenAI.CustomToolChatCompletionsCustomFormatText

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: text	‏‏نعم‬

OpenAI.CustomToolParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف اختياري للأداة المخصصة، يستخدم لتوفير المزيد من السياق.	لا
format	OpenAI.CustomToolParamFormat	تنسيق الإدخال للأداة المخصصة. الافتراضي هو النص غير المقيد.	لا
└─ النوع	OpenAI.CustomToolParamFormatType		‏‏نعم‬
الاسم	string	اسم الأداة المخصصة، المستخدم للتعرف عليها في استدعاءات الأدوات.	‏‏نعم‬
النوع	enum	نوع الأداة المخصصة. دائمًا custom. القيم المحتملة: custom	‏‏نعم‬

OpenAI.CustomToolParamFormat

تنسيق الإدخال للأداة المخصصة. الافتراضي هو النص غير المقيد.

تمييز ل OpenAI.CustomToolParamFormat

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

قيمة النوع	Schema
text	OpenAI.CustomTextFormatParam
grammar	OpenAI.CustomGrammarFormatParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.CustomToolParamFormatType		‏‏نعم‬

OpenAI.CustomToolParamFormatType

الخاصية	قيمة
نوع	string
Values	text grammar

OpenAI.DeleteFileResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean		‏‏نعم‬
المعرف	string		‏‏نعم‬
object	enum	القيم المحتملة: file	‏‏نعم‬

OpenAI.DeleteFineTuningCheckPointPermissionResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean	هل تم حذف إذن نقطة التحقق المعدل بدقة بنجاح.	‏‏نعم‬
المعرف	string	معرف إذن نقطة التحقق المعدل للنموذج الذي تم حذفه.	‏‏نعم‬
object	enum	نوع الكائن، الذي يكون دائما "نقطة تفتيش أو إجازة". القيم المحتملة: checkpoint.permission	‏‏نعم‬

OpenAI.DeleteMessageResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean		‏‏نعم‬
المعرف	string		‏‏نعم‬
object	enum	القيم المحتملة: thread.message.deleted	‏‏نعم‬

OpenAI.DeleteModelResponse

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

OpenAI.DeleteThreadResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean		‏‏نعم‬
المعرف	string		‏‏نعم‬
object	enum	القيم المحتملة: thread.deleted	‏‏نعم‬

OpenAI.DeleteVectorStoreFileResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean		‏‏نعم‬
المعرف	string		‏‏نعم‬
object	enum	القيم المحتملة: vector_store.file.deleted	‏‏نعم‬

OpenAI.DeleteVectorStoreResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean		‏‏نعم‬
المعرف	string		‏‏نعم‬
object	enum	القيم المحتملة: vector_store.deleted	‏‏نعم‬

OpenAI.DeletedConversationResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean		‏‏نعم‬
المعرف	string		‏‏نعم‬
object	enum	القيم المحتملة: conversation.deleted	‏‏نعم‬

OpenAI.DoubleClickAction

إجراء النقر المزدوج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	يحدد نوع الحدث. لإجراء النقر المزدوج، يتم تعيين هذه الخاصية دائما إلى double_click. القيم المحتملة: double_click	‏‏نعم‬
×	integer	الإحداثي س حيث حدث النقر المزدوج.	‏‏نعم‬
y	integer	الإحداثي ص حيث حدث النقر المزدوج.	‏‏نعم‬

OpenAI.Drag

إجراء سحب.

الاسم	النوع	وصف	مطلوب	الإفتراضي
path	صفيف OpenAI.DragPoint	مصفوفة من الإحداثيات تمثل مسار إجراء السحب. ستظهر الإحداثيات كمصفوفة من الكائنات ، على سبيل المثال <br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء السحب، تكون هذه الخاصية هي اضبط دائما على drag. القيم المحتملة: drag	‏‏نعم‬

OpenAI.DragPoint

زوج إحداثيات x/y، على سبيل المثال { x: 100, y: 200 }.

الاسم	النوع	وصف	مطلوب	الإفتراضي
×	integer	إحداثيات x.	‏‏نعم‬
y	integer	إحداثيات y.	‏‏نعم‬

OpenAI.EasyInputMessage

إدخال رسالة إلى النموذج مع دور يشير إلى التعليمات التالية التسلسل الهرمي. الإرشادات المعطاة developer مع الدور أو system لها الأسبقية على الإرشادات المعطاة مع user الدور. يفترض أن الرسائل التي assistant لها الدور قد تم إنشاؤها بواسطة النموذج في التفاعلات السابقة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	سلسلة أو OpenAI.InputMessageContentList	إدخال النص أو الصورة أو الصوت إلى النموذج، المستخدم لإنشاء استجابة. يمكن أن يحتوي أيضا على استجابات المساعد السابقة.	‏‏نعم‬
role	enum	دور إدخال الرسالة. واحد من userأو assistantsystemأو أو developer. القيم المحتملة: user، assistant، ، systemdeveloper	‏‏نعم‬
النوع	enum	نوع إدخال الرسالة. دائمًا message. القيم المحتملة: message	‏‏نعم‬

OpenAI.التضمين

يمثل متجه التضمين الذي يتم إرجاعه بواسطة تضمين نقطة النهاية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تضمين	مصفوفة الأعداد	متجه التضمين، وهو قائمة من العوامات. يعتمد طول المتجه على النموذج كما هو مذكور في دليل التضمين.	‏‏نعم‬
الفهرس	integer	فهرس التضمين في قائمة التضمينات.	‏‏نعم‬
object	enum	نوع الكائن ، والذي يكون دائما "تضمين". القيم المحتملة: embedding	‏‏نعم‬

OpenAI.Eval

كائن Eval مع تكوين مصدر بيانات ومعايير اختبار. يمثل Eval مهمة يجب القيام بها لتكامل LLM الخاص بك. مثل:

• تحسين جودة روبوت الدردشة الخاص بي
• تعرف على مدى تعامل روبوت الدردشة مع دعم العملاء
• تحقق مما إذا كان o4-mini أفضل في حالة الاستخدام الخاصة بي من gpt-4o

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء التقييم.	‏‏نعم‬
data_source_config	OpenAI.EvalCustomDataSourceConfig أو OpenAI.EvalLogsDataSourceConfig أو OpenAI.EvalStoredCompletionsDataSourceConfig	تكوين مصادر البيانات المستخدمة في عمليات تشغيل التقييم.	‏‏نعم‬
المعرف	string	معرف فريد للتقييم.	‏‏نعم‬
metadata	OpenAI.Metadata أو null		‏‏نعم‬
الاسم	string	اسم التقييم.	‏‏نعم‬
object	enum	نوع الكائن. القيم المحتملة: eval	‏‏نعم‬
testing_criteria	مصفوفة من OpenAI.CreateEvalLabelModelGrader أو OpenAI.EvalGraderStringCheck أو OpenAI.EvalGraderTextSimilarity أو OpenAI.EvalGraderPython أو OpenAI.EvalGraderScoreModel أو EvalGraderEndpoint	قائمة بمعايير الاختبار.	‏‏نعم‬

OpenAI.EvalApiError

كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.

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

OpenAI.EvalCustomDataSourceConfig

CustomDataSourceConfig الذي يحدد مخطط item مساحات الأسماء واختياريا sample . يحدد مخطط الاستجابة شكل البيانات التي ستكون:

• تستخدم لتحديد معايير الاختبار الخاصة بك و
• ما هي البيانات المطلوبة عند إنشاء تشغيل

الاسم	النوع	وصف	مطلوب	الإفتراضي
Schema	object	مخطط json لتشغيل عناصر مصدر البيانات. تعرف على كيفية إنشاء مخططات JSON هنا.	‏‏نعم‬
النوع	enum	نوع مصدر البيانات. دائمًا custom. القيم المحتملة: custom	‏‏نعم‬

OpenAI.EvalGraderPython

الاسم	النوع	وصف	مطلوب	الإفتراضي
image_tag	string	علامة الصورة المراد استخدامها لبرنامج python النصي.	لا
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
pass_threshold	رقم	حد النتيجة.	لا
المصدر	string	الكود المصدري لبرنامج python النصي.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم pythonدائما . القيم المحتملة: python	‏‏نعم‬

OpenAI.EvalGraderScoreModel

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	صفيف OpenAI.EvalItem	رسائل الإدخال التي تم تقييمها من قبل متدرج الدرجات. يدعم النص ونص الإخراج وصورة الإدخال وكتل محتوى صوت الإدخال، وقد يتضمن سلاسل القالب.	‏‏نعم‬
نموذج	string	النموذج الذي يجب استخدامه للتقييم.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
pass_threshold	رقم	حد النتيجة.	لا
النطاق	مصفوفة الأعداد	نطاق النتيجة. الإعدادات الافتراضية لـ [0, 1].	لا
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		لا
└─ max_completions_tokens	عدد صحيح أو صفري		لا
└─ reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
└─ البذور	عدد صحيح أو صفري		لا
└─ درجة الحرارة	عدد أو صفرا		لا
└─ top_p	عدد أو صفرا		لا	1
النوع	enum	نوع الكائن، الذي يتم score_modelدائما . القيم المحتملة: score_model	‏‏نعم‬

OpenAI.EvalGraderScoreModelSamplingParams

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_completions_tokens	عدد صحيح أو صفري		لا
reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
seed	عدد صحيح أو صفري		لا
درجة الحرارة	عدد أو صفرا		لا
top_p	عدد أو صفرا		لا

OpenAI.EvalGraderStringCheck

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	string	نص الإدخال. قد يتضمن ذلك سلاسل القالب.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
operation	enum	عملية التحقق من السلسلة التي يجب تنفيذها. واحد من eqأو nelikeأو أو ilike. القيم المحتملة: eq، ne، ، likeilike	‏‏نعم‬
reference	string	النص المرجعي. قد يتضمن ذلك سلاسل القالب.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم string_checkدائما . القيم المحتملة: string_check	‏‏نعم‬

OpenAI.EvalGraderTextSimilarity

الاسم	النوع	وصف	مطلوب	الإفتراضي
evaluation_metric	enum	مقياس التقييم المراد استخدامه. واحد من cosine، fuzzy_match، bleu، ، gleu، meteor، rouge_1، rouge_2، rouge_3، rouge_4، ، rouge_5، أو rouge_l. القيم المحتملة: cosine، fuzzy_match، bleu، gleu، meteor، rouge_1، rouge_2، rouge_3، ، rouge_4، ، rouge_5rouge_l	‏‏نعم‬
الادخال	string	النص الذي يتم تصنيفه.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
pass_threshold	رقم	حد النتيجة.	‏‏نعم‬
reference	string	النص الذي يتم تقييمه مقابله.	‏‏نعم‬
النوع	enum	نوع متدرج الدرجات. القيم المحتملة: text_similarity	‏‏نعم‬

OpenAI.EvalItem

إدخال رسالة إلى النموذج مع دور يشير إلى التعليمات التالية التسلسل الهرمي. الإرشادات المعطاة developer مع الدور أو system لها الأسبقية على الإرشادات المعطاة مع user الدور. يفترض أن الرسائل التي assistant لها الدور قد تم إنشاؤها بواسطة النموذج في التفاعلات السابقة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	OpenAI.EvalItemContent	يمكن أن تحتوي المدخلات إلى النموذج - على سلاسل قالب. يدعم النص ونص الإخراج وصور الإدخال وصوت الإدخال، إما كعنصر واحد أو كمصفوفة من العناصر.	‏‏نعم‬
role	enum	دور إدخال الرسالة. واحد من userأو assistantsystemأو أو developer. القيم المحتملة: user، assistant، ، systemdeveloper	‏‏نعم‬
النوع	enum	نوع إدخال الرسالة. دائمًا message. القيم المحتملة: message	لا

OpenAI.EvalItemContent

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

النوع: OpenAI.EvalItemContentItem أو OpenAI.EvalItemContentArray

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

OpenAI.EvalItemContentArray

قائمة بالمدخلات، قد يكون كل منها إما نص إدخال أو نص إخراج أو صورة إدخال أو كائن صوت إدخال.

صفيف: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

عنصر محتوى واحد: نص الإدخال أو نص الإخراج أو صورة الإدخال أو صوت الإدخال.

النوع: OpenAI.EvalItemContentText أو OpenAI.EvalItemContentItemObject

عنصر محتوى واحد: نص الإدخال أو نص الإخراج أو صورة الإدخال أو صوت الإدخال.

OpenAI.EvalItemContentItemObject

عنصر محتوى واحد: نص الإدخال أو نص الإخراج أو صورة الإدخال أو صوت الإدخال.

تمييز ل OpenAI.EvalItemContentItemObject

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

قيمة النوع	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.EvalItemContentItemObjectType		‏‏نعم‬

OpenAI.EvalItemContentItemObjectInputTextContent

إدخال نص إلى النموذج.

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

OpenAI.EvalItemContentItemObjectType

الخاصية	قيمة
نوع	string
Values	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

إخراج نص من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	إخراج النص من النموذج.	‏‏نعم‬
النوع	enum	نوع النص الناتج. دائمًا output_text. القيم المحتملة: output_text	‏‏نعم‬

OpenAI.EvalItemContentText

إدخال نص إلى النموذج.

النوع: سلسلة

OpenAI.EvalItemInputImage

كتلة إدخال صورة مستخدمة داخل صفائف محتوى EvalItem.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	string	مستوى تفاصيل الصورة التي سيتم إرسالها إلى النموذج. واحد من highأو lowأو auto. الإعدادات الافتراضية لـ auto.	لا
image_url	string	عنوان URL لإدخال الصورة.	‏‏نعم‬
النوع	enum	نوع إدخال الصورة. دائمًا input_image. القيم المحتملة: input_image	‏‏نعم‬

OpenAI.EvalJsonlFileContentSource

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف OpenAI.EvalJsonlFileContentSourceContent	محتوى ملف jsonl.	‏‏نعم‬
النوع	enum	نوع مصدر jsonl. دائمًا file_content. القيم المحتملة: file_content	‏‏نعم‬

OpenAI.EvalJsonlFileContentSourceContent

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

OpenAI.EvalJsonlFileIdSource

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	معرف الملف.	‏‏نعم‬
النوع	enum	نوع مصدر jsonl. دائمًا file_id. القيم المحتملة: file_id	‏‏نعم‬

OpenAI.EvalList

كائن يمثل قائمة التقييمات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.Eval	صفيف من عناصر التقييم.	‏‏نعم‬
first_id	string	معرف التقييم الأول في صفيف البيانات.	‏‏نعم‬
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من التقييمات المتاحة.	‏‏نعم‬
last_id	string	معرف التقييم الأخير في صفيف البيانات.	‏‏نعم‬
object	enum	نوع هذا الكائن. يتم تعيينه دائما على "قائمة". القيم المحتملة: list	‏‏نعم‬

OpenAI.EvalLogsDataSourceConfig

LogsDataSourceConfig الذي يحدد خاصية بيانات التعريف لاستعلام السجلات الخاص بك. عادة ما تكون هذه بيانات تعريف مثل usecase=chatbot أو prompt-version=v2، وما إلى ذلك. يتم استخدام المخطط الذي تم إرجاعه بواسطة تكوين مصدر البيانات هذا لتحديد المتغيرات المتوفرة في التقييمات الخاصة بك. item ويتم تعريف كل من و sample عند استخدام تكوين مصدر البيانات هذا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata أو null		لا
Schema	object	مخطط json لتشغيل عناصر مصدر البيانات. تعرف على كيفية إنشاء مخططات JSON هنا.	‏‏نعم‬
النوع	enum	نوع مصدر البيانات. دائمًا logs. القيم المحتملة: logs	‏‏نعم‬

OpenAI.EvalResponsesSource

كائن EvalResponsesSource يصف تكوين مصدر بيانات تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_after	عدد صحيح أو صفري		لا
created_before	عدد صحيح أو صفري		لا
instructions_search	سلسلة أو قيمة خالية		لا
metadata	مفعول أم صفرا		لا
نموذج	سلسلة أو قيمة خالية		لا
reasoning_effort	OpenAI.ReasoningEffort أو null		لا
درجة الحرارة	عدد أو صفرا		لا
الأدوات	مصفوفة من الوتر أو الصفر		لا
top_p	عدد أو صفرا		لا
النوع	enum	نوع مصدر بيانات التشغيل. دائمًا responses. القيم المحتملة: responses	‏‏نعم‬
users	مصفوفة من الوتر أو الصفر		لا

OpenAI.EvalRun

مخطط يمثل تشغيل تقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) عند إنشاء تشغيل التقييم.	‏‏نعم‬
data_source	OpenAI.CreateEvalJsonlRunDataSource أو OpenAI.CreateEvalCompletionsRunDataSource أو OpenAI.CreateEvalResponsesRunDataSource	معلومات حول مصدر بيانات التشغيل.	‏‏نعم‬
خطأ	OpenAI.EvalApiError	كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.	‏‏نعم‬
eval_id	string	معرف التقييم المقترن.	‏‏نعم‬
المعرف	string	معرف فريد لتشغيل التقييم.	‏‏نعم‬
metadata	OpenAI.Metadata أو null		‏‏نعم‬
نموذج	string	النموذج الذي يتم تقييمه، إن أمكن.	‏‏نعم‬
الاسم	string	اسم تشغيل التقييم.	‏‏نعم‬
object	enum	نوع الكائن. دائما "eval.run". القيم المحتملة: eval.run	‏‏نعم‬
per_model_usage	صفيف OpenAI.EvalRunPerModelUsage	إحصائيات الاستخدام لكل نموذج أثناء تشغيل التقييم.	‏‏نعم‬
per_testing_criteria_results	صفيف OpenAI.EvalRunPerTestingCriteriaResults	النتائج لكل معايير الاختبار المطبقة أثناء تشغيل التقييم.	‏‏نعم‬
report_url	string	عنوان URL الخاص بالتقييم المعروض يقوم بتشغيل التقرير على لوحة معلومات واجهة المستخدم.	‏‏نعم‬
result_counts	OpenAI.EvalRunResultCounts		‏‏نعم‬
└─ خطأ	integer		‏‏نعم‬
└─ فشل	integer		‏‏نعم‬
└─ التي تم تمريرها	integer		‏‏نعم‬
└─ المجموع	integer		‏‏نعم‬
الحالة	string	حالة تشغيل التقييم.	‏‏نعم‬

OpenAI.EvalRunList

كائن يمثل قائمة عمليات التشغيل للتقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.EvalRun	صفيف من كائنات تشغيل التقييم.	‏‏نعم‬
first_id	string	يتم تشغيل معرف التقييم الأول في صفيف البيانات.	‏‏نعم‬
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من التقييمات المتاحة.	‏‏نعم‬
last_id	string	معرف آخر تقييم يتم تشغيله في صفيف البيانات.	‏‏نعم‬
object	enum	نوع هذا الكائن. يتم تعيينه دائما على "قائمة". القيم المحتملة: list	‏‏نعم‬

OpenAI.EvalRunOutputItem

مخطط يمثل عنصر إخراج تشغيل التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) عند إنشاء تشغيل التقييم.	‏‏نعم‬
datasource_item	object	تفاصيل عنصر مصدر بيانات الإدخال.	‏‏نعم‬
datasource_item_id	integer	معرف عنصر مصدر البيانات.	‏‏نعم‬
eval_id	string	معرف مجموعة التقييم.	‏‏نعم‬
المعرف	string	معرف فريد لعنصر إخراج تشغيل التقييم.	‏‏نعم‬
object	enum	نوع الكائن. دائما "eval.run.output_item". القيم المحتملة: eval.run.output_item	‏‏نعم‬
results	مصفوفة من OpenAI.EvalRunOutputItemResult	قائمة بنتائج الدرجات لعنصر الإخراج هذا.	‏‏نعم‬
run_id	string	معرف تشغيل التقييم المقترن بعنصر الإخراج هذا.	‏‏نعم‬
عينة	OpenAI.EvalRunOutputItemSample		‏‏نعم‬
└─ خطأ	OpenAI.EvalApiError	كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.	‏‏نعم‬
└─ finish_reason	string		‏‏نعم‬
└─ المدخلات	مصفوفة من OpenAI.EvalRunOutputItemSampleInput		‏‏نعم‬
└─ max_completion_tokens	integer		‏‏نعم‬
└─ نموذج	string		‏‏نعم‬
└─ الإخراج	مصفوفة من OpenAI.EvalRunOutputItemSampleOutput		‏‏نعم‬
└─ البذور	integer		‏‏نعم‬
└─ درجة الحرارة	رقم		‏‏نعم‬
└─ top_p	رقم		‏‏نعم‬
└─ الاستخدام	OpenAI.EvalRunOutputItemSampleUsage		‏‏نعم‬
الحالة	string	حالة تشغيل التقييم.	‏‏نعم‬

OpenAI.EvalRunOutputItemList

كائن يمثل قائمة بعناصر الإخراج لتشغيل التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.EvalRunOutputItem	صفيف من عناصر إخراج تشغيل التقييم.	‏‏نعم‬
first_id	string	معرف عنصر إخراج تشغيل التقييم الأول في صفيف البيانات.	‏‏نعم‬
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من عناصر إخراج تشغيل التقييم المتوفرة.	‏‏نعم‬
last_id	string	معرف عنصر إخراج تشغيل التقييم الأخير في صفيف البيانات.	‏‏نعم‬
object	enum	نوع هذا الكائن. يتم تعيينه دائما على "قائمة". القيم المحتملة: list	‏‏نعم‬

OpenAI.EvalRunOutputItemResult

نتيجة درجة واحدة لعنصر إخراج تشغيل التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
مرت	boolean	ما إذا كان معلم الصف يعتبر الإخراج تمريرا أم لا.	‏‏نعم‬
عينة	مفعول أم صفرا	عينة اختيارية أو بيانات متوسطة ينتجها الصف.	لا
score	رقم	الدرجة الرقمية التي ينتجها المصحح.	‏‏نعم‬
النوع	string	نوع الصف (على سبيل المثال، "string-check-grader").	لا

OpenAI.EvalRunOutputItemSample

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	OpenAI.EvalApiError	كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.	‏‏نعم‬
finish_reason	string		‏‏نعم‬
الادخال	مصفوفة من OpenAI.EvalRunOutputItemSampleInput		‏‏نعم‬
max_completion_tokens	integer		‏‏نعم‬
نموذج	string		‏‏نعم‬
الناتج	مصفوفة من OpenAI.EvalRunOutputItemSampleOutput		‏‏نعم‬
seed	integer		‏‏نعم‬
درجة الحرارة	رقم		‏‏نعم‬
top_p	رقم		‏‏نعم‬
استخدام	OpenAI.EvalRunOutputItemSampleUsage		‏‏نعم‬

OpenAI.EvalRunOutputItemSampleInput

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	string		‏‏نعم‬
role	string		‏‏نعم‬

OpenAI.EvalRunOutputItemSampleOutput

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	string		لا
role	string		لا

OpenAI.EvalRunOutputItemSampleUsage

الاسم	النوع	وصف	مطلوب	الإفتراضي
cached_tokens	integer		‏‏نعم‬
completion_tokens	integer		‏‏نعم‬
prompt_tokens	integer		‏‏نعم‬
total_tokens	integer		‏‏نعم‬

OpenAI.EvalRunPerModelUsage

الاسم	النوع	وصف	مطلوب	الإفتراضي
cached_tokens	integer		‏‏نعم‬
completion_tokens	integer		‏‏نعم‬
invocation_count	integer		‏‏نعم‬
model_name	string		‏‏نعم‬
prompt_tokens	integer		‏‏نعم‬
total_tokens	integer		‏‏نعم‬

OpenAI.EvalRunPerTestingCriteriaResults

الاسم	النوع	وصف	مطلوب	الإفتراضي
فشل	integer		‏‏نعم‬
مرت	integer		‏‏نعم‬
testing_criteria	string		‏‏نعم‬

OpenAI.EvalRunResultCounts

الاسم	النوع	وصف	مطلوب	الإفتراضي
حدث خطأ	integer		‏‏نعم‬
فشل	integer		‏‏نعم‬
مرت	integer		‏‏نعم‬
مجموع	integer		‏‏نعم‬

OpenAI.EvalStoredCompletionsDataSourceConfig

تم إهمالها لصالح LogsDataSourceConfig.

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata أو null		لا
Schema	object	مخطط json لتشغيل عناصر مصدر البيانات. تعرف على كيفية إنشاء مخططات JSON هنا.	‏‏نعم‬
النوع	enum	نوع مصدر البيانات. دائمًا stored_completions. القيم المحتملة: stored_completions	‏‏نعم‬

OpenAI.EvalStoredCompletionsSource

تكوين StoredCompletionsRunDataSource يصف مجموعة من عوامل التصفية

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_after	عدد صحيح أو صفري		لا
created_before	عدد صحيح أو صفري		لا
الحد	عدد صحيح أو صفري		لا
metadata	OpenAI.Metadata أو null		لا
نموذج	سلسلة أو قيمة خالية		لا
النوع	enum	نوع المصدر. دائمًا stored_completions. القيم المحتملة: stored_completions	‏‏نعم‬

OpenAI.FileCitationBody

اقتباس إلى ملف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	string	معرف الملف.	‏‏نعم‬
filename	string	اسم ملف الملف المذكور.	‏‏نعم‬
الفهرس	integer	فهرس الملف في قائمة الملفات.	‏‏نعم‬
النوع	enum	نوع الاقتباس من الملف. دائمًا file_citation. القيم المحتملة: file_citation	‏‏نعم‬

OpenAI.FilePath

مسار إلى ملف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	string	معرف الملف.	‏‏نعم‬
الفهرس	integer	فهرس الملف في قائمة الملفات.	‏‏نعم‬
النوع	enum	نوع مسار الملف. دائمًا file_path. القيم المحتملة: file_path	‏‏نعم‬

OpenAI.FileSearchRanker

المصنف الذي يجب استخدامه للبحث عن الملفات. إذا لم يتم تحديد سيستخدم auto ranker.

الخاصية	قيمة
نوع	string
Values	auto default_2024_08_21

OpenAI.FileSearchRankingOptions

خيارات الترتيب للبحث عن الملفات. إذا لم يتم تحديده، ستستخدم أداة البحث عن الملفات الرتبة auto score_threshold 0. راجع توثيق أداة البحث عن الملفات لمزيد من المعلومات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
ranker	OpenAI.FileSearchRanker	المصنف الذي يجب استخدامه للبحث عن الملفات. إذا لم يتم تحديد سيستخدم auto ranker.	لا
score_threshold	رقم	عتبة الدرجة في البحث عن الملف. يجب أن تكون كافة القيم رقم فاصلة عائمة بين 0 و1. القيود: الحد الأدنى: 0، الحد الأقصى: 1	‏‏نعم‬

OpenAI.FileSearchTool

أداة تبحث عن محتوى ذي صلة من الملفات التي تم تحميلها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	OpenAI.Filters أو null		لا
max_num_results	integer	الحد الأقصى لعدد النتائج التي سيتم إرجاعها. يجب أن يتراوح هذا الرقم بين 1 و50 ضمنا.	لا
ranking_options	OpenAI.RankingOptions		لا
└─ hybrid_search	OpenAI.HybridSearchOptions	أوزان تتحكم في كيفية توازن دمج الترتيب المتبادل بين مطابقات التضمين الدلالي ومطابقات الكلمات المفتاحية المتفرقة عند تفعيل البحث الهجين.	لا
└─ المرتبة	OpenAI.RankerVersionType	المصنف الذي يجب استخدامه للبحث عن الملفات.	لا
└─ score_threshold	رقم	حد الدرجة للبحث في الملف، رقم بين 0 و1. ستحاول الأرقام الأقرب إلى 1 إرجاع النتائج الأكثر صلة فقط، ولكنها قد ترجع نتائج أقل.	لا
النوع	enum	نوع أداة البحث عن الملفات. دائمًا file_search. القيم المحتملة: file_search	‏‏نعم‬
vector_store_ids	صفيف سلسلة	تخزن معرفات المتجهات للبحث.	‏‏نعم‬

OpenAI.FileSearchToolCallResults

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		لا
file_id	string		لا
filename	string		لا
score	رقم		لا
نص	string		لا

OpenAI.Filters

النوع: OpenAI.ComparisonFilter أو OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperالمعلمات

المعلمات الفائقة المستخدمة لوظيفة الضبط الدقيق ل DPO.

الاسم	النوع	وصف	مطلوب	الإفتراضي
batch_size	سلسلة أو عدد صحيح	عدد الأمثلة في كل دفعة. يعني حجم الدفعة الأكبر أن معلمات النموذج يتم تحديثها بشكل أقل تكرارا، ولكن مع تباين أقل.	لا
بيتا	السلسلة أو الرقم	قيمة بيتا لأسلوب DPO. ستؤدي قيمة بيتا أعلى إلى زيادة وزن العقوبة بين النهج والنموذج المرجعي.	لا
learning_rate_multiplier	السلسلة أو الرقم	عامل التحجيم لمعدل التعلم. قد يكون معدل التعلم الأصغر مفيدًا لتجنب الإفراط في ضبط الملاءمة.	لا
n_epochs	سلسلة أو عدد صحيح	عدد العهود لتدريب النموذج لها. تشير الفترة إلى دورة كاملة واحدة من خلال مجموعة بيانات التدريب.	لا

OpenAI.FineTuneDPOMethod

تكوين طريقة الضبط الدقيق ل DPO.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعلمات الفائقة	OpenAI.FineTuneDPOHyperالمعلمات	المعلمات الفائقة المستخدمة لوظيفة الضبط الدقيق ل DPO.	لا

OpenAI.FineTuneMethod

الطريقة المستخدمة للضبط الدقيق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
دبو	OpenAI.FineTuneDPOMethod	تكوين طريقة الضبط الدقيق ل DPO.	لا
تعزيز	AzureFineTuneReinforcementMethod		لا
تم الإشراف عليه	OpenAI.FineTuneSupervisedMethod	تكوين طريقة الضبط الدقيق الخاضعة للإشراف.	لا
النوع	enum	نوع الطريقة. إما supervised، dpoأو reinforcement. القيم المحتملة: supervised، ، dporeinforcement	‏‏نعم‬

OpenAI.FineTuneReinforcementHyperparameters

المعلمات الفائقة المستخدمة في وظيفة الضبط الدقيق للتعزيز.

الاسم	النوع	وصف	مطلوب	الإفتراضي
batch_size	سلسلة أو عدد صحيح	عدد الأمثلة في كل دفعة. يعني حجم الدفعة الأكبر أن معلمات النموذج يتم تحديثها بشكل أقل تكرارا، ولكن مع تباين أقل.	لا
compute_multiplier	السلسلة أو الرقم	مضاعف على مقدار الحوسبة المستخدمة لاستكشاف مساحة البحث أثناء التدريب.	لا
eval_interval	سلسلة أو عدد صحيح	عدد خطوات التدريب بين جولات التقييم.	لا
eval_samples	سلسلة أو عدد صحيح	عدد عينات التقييم التي يجب إنشاؤها لكل خطوة تدريب.	لا
learning_rate_multiplier	السلسلة أو الرقم	عامل التحجيم لمعدل التعلم. قد يكون معدل التعلم الأصغر مفيدًا لتجنب الإفراط في ضبط الملاءمة.	لا
n_epochs	سلسلة أو عدد صحيح	عدد العهود لتدريب النموذج لها. تشير الفترة إلى دورة كاملة واحدة من خلال مجموعة بيانات التدريب.	لا
reasoning_effort	enum	مستوى جهد التفكير. القيم المحتملة: default، low، ، mediumhigh	لا

OpenAI.FineTuneSupervisedHyperparameters

المعلمات الفائقة المستخدمة لمهمة الضبط الدقيق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
batch_size	سلسلة أو عدد صحيح	عدد الأمثلة في كل دفعة. يعني حجم الدفعة الأكبر أن معلمات النموذج يتم تحديثها بشكل أقل تكرارا، ولكن مع تباين أقل.	لا
learning_rate_multiplier	السلسلة أو الرقم	عامل التحجيم لمعدل التعلم. قد يكون معدل التعلم الأصغر مفيدًا لتجنب الإفراط في ضبط الملاءمة.	لا
n_epochs	سلسلة أو عدد صحيح	عدد العهود لتدريب النموذج لها. تشير الفترة إلى دورة كاملة واحدة من خلال مجموعة بيانات التدريب.	لا

OpenAI.FineTuneSupervisedMethod

تكوين طريقة الضبط الدقيق الخاضعة للإشراف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعلمات الفائقة	OpenAI.FineTuneSupervisedHyperparameters	المعلمات الفائقة المستخدمة لمهمة الضبط الدقيق.	لا

OpenAI.FineTuningCheckpointPermission

يمثل الكائن checkpoint.permission إذنا لنقطة تفتيش نموذج مضبوطة بدقة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	طابع الوقت في يونكس (بالثواني) لوقت إنشاء الإذن.	‏‏نعم‬
المعرف	string	معرف الأذون، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
object	enum	نوع الكائن، الذي يكون دائما "نقطة تفتيش أو إجازة". القيم المحتملة: checkpoint.permission	‏‏نعم‬
project_id	string	معرف المشروع الذي يخص الإمراء.	‏‏نعم‬

OpenAI.FineTuningIntegration

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع التكامل الذي يتم تمكينه لمهمة الضبط الدقيق القيم المحتملة: wandb	‏‏نعم‬
wandb	OpenAI.FineTuningIntegrationWandb		‏‏نعم‬
└─ الكيان	سلسلة أو قيمة خالية		لا
└─ الاسم	سلسلة أو قيمة خالية		لا
└─ المشروع	string		‏‏نعم‬
└─ العلامات	صفيف سلسلة		لا

OpenAI.FineTuningIntegrationWandb

الاسم	النوع	وصف	مطلوب	الإفتراضي
الكيان	سلسلة أو قيمة خالية		لا
الاسم	سلسلة أو قيمة خالية		لا
المشروع	string		‏‏نعم‬
العلامات	صفيف سلسلة		لا

OpenAI.FineTuningJob

يمثل الكائن fine_tuning.job مهمة ضبط دقيقة تم إنشاؤها من خلال واجهة برمجة التطبيقات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني ل Unix (بالثواني) لوقت إنشاء مهمة الضبط الدقيق.	‏‏نعم‬
خطأ	OpenAI.FineTuningJobError أو null		‏‏نعم‬
estimated_finish	سلسلة أو قيمة خالية		لا
fine_tuned_model	سلسلة أو قيمة خالية		‏‏نعم‬
finished_at	سلسلة أو قيمة خالية		‏‏نعم‬
المعلمات الفائقة	OpenAI.FineTuningJobHyperparameters		‏‏نعم‬
└─ batch_size	السلسلة أو العدد الصحيح أو الصفراء		لا	تلقائي
└─ learning_rate_multiplier	السلسلة أو الرقم		لا
└─ n_epochs	سلسلة أو عدد صحيح		لا	تلقائي
المعرف	string	معرف الكائن، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
التكامل	مصفوفة OpenAI.FineTuningIntegration أو null		لا
metadata	OpenAI.Metadata أو null		لا
method	OpenAI.FineTuneMethod	الطريقة المستخدمة للضبط الدقيق.	لا
نموذج	string	النموذج الأساسي الذي يتم ضبطه بدقة.	‏‏نعم‬
object	enum	نوع الكائن، والذي يكون دائما "fine_tuning.job". القيم المحتملة: fine_tuning.job	‏‏نعم‬
organization_id	string	المنظمة التي تمتلك وظيفة الضبط الدقيق.	‏‏نعم‬
result_files	صفيف سلسلة	معرف (معرفات) ملف النتائج المترجم لمهمة الضبط الدقيق. يمكنك استرداد النتائج باستخدام واجهة برمجة تطبيقات الملفات.	‏‏نعم‬
seed	integer	البذور المستخدمة لوظيفة الضبط الدقيق.	‏‏نعم‬
الحالة	enum	الحالة الحالية لوظيفة الضبط الدقيق ، والتي يمكن أن تكون إما validating_files، أو ، queuedأو runningsucceededfailed. cancelled القيم المحتملة: validating_files، queued، running، succeeded، ، failedcancelled	‏‏نعم‬
trained_tokens	عدد صحيح أو صفري		‏‏نعم‬
training_file	string	معرف الملف المستخدم للتدريب. يمكنك استرداد بيانات التدريب باستخدام واجهة برمجة تطبيقات الملفات.	‏‏نعم‬
validation_file	سلسلة أو قيمة خالية		‏‏نعم‬

OpenAI.FineTuningJobCheckpoint

يمثل الكائن fine_tuning.job.checkpoint نقطة تفتيش نموذجية لمهمة ضبط دقيقة جاهزة للاستخدام.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء نقطة التحقق.	‏‏نعم‬
fine_tuned_model_checkpoint	string	اسم نموذج نقطة التحقق المضبط الذي تم إنشاؤه.	‏‏نعم‬
fine_tuning_job_id	string	اسم مهمة الضبط الدقيقة التي تم إنشاء نقطة التحقق هذه منها.	‏‏نعم‬
المعرف	string	معرف نقطة التفتيش، والذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
المقاييس	OpenAI.FineTuningJobCheckpointMetrics		‏‏نعم‬
└─ full_valid_loss	رقم		لا
└─ full_valid_mean_token_accuracy	رقم		لا
└─ الخطوة	رقم		لا
└─ train_loss	رقم		لا
└─ train_mean_token_accuracy	رقم		لا
└─ valid_loss	رقم		لا
└─ valid_mean_token_accuracy	رقم		لا
object	enum	نوع الكائن، وهو دائما "fine_tuning.job.checkpoint". القيم المحتملة: fine_tuning.job.checkpoint	‏‏نعم‬
step_number	integer	رقم الخطوة التي تم إنشاء نقطة التحقق فيها.	‏‏نعم‬

OpenAI.FineTuningJobCheckpointMetrics

الاسم	النوع	وصف	مطلوب	الإفتراضي
full_valid_loss	رقم		لا
full_valid_mean_token_accuracy	رقم		لا
درج	رقم		لا
train_loss	رقم		لا
train_mean_token_accuracy	رقم		لا
valid_loss	رقم		لا
valid_mean_token_accuracy	رقم		لا

OpenAI.FineTuningJobError

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

OpenAI.FineTuningJobEvent

ضبط كائن حدث الوظيفة

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني ل Unix (بالثواني) لوقت إنشاء مهمة الضبط الدقيق.	‏‏نعم‬
البيانات	OpenAI.FineTuningJobEventData		لا
المعرف	string	معرف الكائن.	‏‏نعم‬
المستوى	enum	مستوى سجل الحدث. القيم المحتملة: info، ، warnerror	‏‏نعم‬
رسالة	string	رسالة الحدث.	‏‏نعم‬
object	enum	نوع الكائن، وهو دائما "fine_tuning.job.event". القيم المحتملة: fine_tuning.job.event	‏‏نعم‬
النوع	enum	نوع الحدث. القيم المحتملة: message، metrics	لا

OpenAI.FineTuningJobEventData

النوع: كائن

OpenAI.FineTuningJobHyperparameters

الاسم	النوع	وصف	مطلوب	الإفتراضي
batch_size	السلسلة أو العدد الصحيح أو الصفراء		لا
learning_rate_multiplier	السلسلة أو الرقم		لا
n_epochs	سلسلة أو عدد صحيح		لا

OpenAI.FunctionAndCustomToolCallOutput

تمييز ل OpenAI.FunctionAndCustomToolCallOutput

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

قيمة النوع	Schema
input_text	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
input_image	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
input_file	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.FunctionAndCustomToolCallOutputType		‏‏نعم‬

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

إدخال ملف إلى النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_data	string	محتوى الملف الذي سيتم إرساله إلى النموذج.	لا
file_id	سلسلة أو قيمة خالية		لا
file_url	string	عنوان URL للملف الذي سيتم إرساله إلى النموذج.	لا
filename	string	اسم الملف الذي سيتم إرساله إلى النموذج.	لا
النوع	enum	نوع عنصر الإدخال. دائمًا input_file. القيم المحتملة: input_file	‏‏نعم‬

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

إدخال صورة إلى النموذج. تعرف على مدخلات الصور.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	OpenAI.ImageDetail		‏‏نعم‬
file_id	سلسلة أو قيمة خالية		لا
image_url	سلسلة أو قيمة خالية		لا
النوع	enum	نوع عنصر الإدخال. دائمًا input_image. القيم المحتملة: input_image	‏‏نعم‬

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

إدخال نص إلى النموذج.

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

OpenAI.FunctionAndCustomToolCallOutputType

الخاصية	قيمة
نوع	string
Values	input_text input_image input_file

OpenAI.FunctionObject

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

OpenAI.FunctionParameters

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

النوع: كائن

OpenAI.FunctionShellAction

تنفيذ أمر shell.

الاسم	النوع	وصف	مطلوب	الإفتراضي
commands	صفيف سلسلة		‏‏نعم‬
max_output_length	عدد صحيح أو صفري		‏‏نعم‬
timeout_ms	عدد صحيح أو صفري		‏‏نعم‬

OpenAI.FunctionShellCallOutputContent

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_by	string	معرف الممثل الذي أنشأ العنصر.	لا
نتائج	OpenAI.FunctionShellCallOutputOutcome	يمثل إما نتيجة خروج (مع رمز خروج) أو نتيجة مهلة لمجموعة إخراج استدعاء shell.	‏‏نعم‬
└─ النوع	OpenAI.FunctionShellCallOutputOutcomeType		‏‏نعم‬
Stderr	string	إخراج الخطأ القياسي الذي تم التقاطه.	‏‏نعم‬
Stdout	string	الإخراج القياسي الذي تم التقاطه.	‏‏نعم‬

OpenAI.FunctionShellCallOutputExitOutcome

يشير إلى أن أوامر الshell قد انتهت وأعادت رمز خروج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
exit_code	integer	كود الخروج من عملية الشيل.	‏‏نعم‬
النوع	enum	نوع النتيجة. دائمًا exit. القيم المحتملة: exit	‏‏نعم‬

OpenAI.FunctionShellCallOutputOutcome

يمثل إما نتيجة خروج (مع رمز خروج) أو نتيجة مهلة لمجموعة إخراج استدعاء shell.

تمييز ل OpenAI.FunctionShellCallOutputOutcome

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

قيمة النوع	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcome
exit	OpenAI.FunctionShellCallOutputExitOutcome

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.FunctionShellCallOutputOutcomeType		‏‏نعم‬

OpenAI.FunctionShellCallOutputOutcomeType

الخاصية	قيمة
نوع	string
Values	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

يشير إلى أن استدعاء الshell تجاوز الحد الزمني المخصص لديه.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع النتيجة. دائمًا timeout. القيم المحتملة: timeout	‏‏نعم‬

OpenAI.FunctionShellToolParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع أداة القشرة. دائمًا shell. القيم المحتملة: shell	‏‏نعم‬

OpenAI.FunctionTool

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	سلسلة أو قيمة خالية		لا
الاسم	string	اسم الدالة التي يجب استدعاها.	‏‏نعم‬
المعلمات	مفعول أم صفرا		‏‏نعم‬
صارم	بوليان أو نول		‏‏نعم‬
النوع	enum	نوع أداة الدالة. دائمًا function. القيم المحتملة: function	‏‏نعم‬

OpenAI.GraderMulti

يجمع كائن MultiGrader بين مخرجات مصنفي التقديرات المتعددة لإنتاج درجة واحدة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
calculate_output	string	صيغة لحساب المخرجات استنادا إلى نتائج مصنف التقديرات.	‏‏نعم‬
طلاب الصف	OpenAI.GraderStringCheck أو OpenAI.GraderTextSimilarity أو OpenAI.GraderScoreModel أو GraderEndpoint		‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم multiدائما . القيم المحتملة: multi	‏‏نعم‬

OpenAI.GraderPython

كائن PythonGrader يقوم بتشغيل برنامج نصي python على الإدخال.

الاسم	النوع	وصف	مطلوب	الإفتراضي
image_tag	string	علامة الصورة المراد استخدامها لبرنامج python النصي.	لا
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
المصدر	string	الكود المصدري لبرنامج python النصي.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم pythonدائما . القيم المحتملة: python	‏‏نعم‬

OpenAI.GraderScoreModel

عنصر ScoreModelGrader الذي يستخدم نموذجا لتعيين درجة إلى الإدخال.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	صفيف OpenAI.EvalItem	رسائل الإدخال التي تم تقييمها من قبل متدرج الدرجات. يدعم النص ونص الإخراج وصورة الإدخال وكتل محتوى صوت الإدخال، وقد يتضمن سلاسل القالب.	‏‏نعم‬
نموذج	string	النموذج الذي يجب استخدامه للتقييم.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
النطاق	مصفوفة الأعداد	نطاق النتيجة. الإعدادات الافتراضية لـ [0, 1].	لا
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		لا
└─ max_completions_tokens	عدد صحيح أو صفري		لا
└─ reasoning_effort	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
└─ البذور	عدد صحيح أو صفري		لا
└─ درجة الحرارة	عدد أو صفرا		لا
└─ top_p	عدد أو صفرا		لا	1
النوع	enum	نوع الكائن، الذي يتم score_modelدائما . القيم المحتملة: score_model	‏‏نعم‬

OpenAI.GraderStringCheck

كائن StringCheckGrader الذي يقوم بإجراء مقارنة سلسلة بين الإدخال والمرجع باستخدام عملية محددة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	string	نص الإدخال. قد يتضمن ذلك سلاسل القالب.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
operation	enum	عملية التحقق من السلسلة التي يجب تنفيذها. واحد من eqأو nelikeأو أو ilike. القيم المحتملة: eq، ne، ، likeilike	‏‏نعم‬
reference	string	النص المرجعي. قد يتضمن ذلك سلاسل القالب.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم string_checkدائما . القيم المحتملة: string_check	‏‏نعم‬

OpenAI.GraderTextSimilarity

عنصر TextSimilarityGrader الذي يقوم بتقييم النص استنادا إلى مقاييس التشابه.

الاسم	النوع	وصف	مطلوب	الإفتراضي
evaluation_metric	enum	مقياس التقييم المراد استخدامه. واحد من cosine، fuzzy_match، bleu، ، gleu، meteor، rouge_1، rouge_2، rouge_3، rouge_4، ، rouge_5، أو rouge_l. القيم المحتملة: cosine، fuzzy_match، bleu، gleu، meteor، rouge_1، rouge_2، rouge_3، ، rouge_4، ، rouge_5rouge_l	‏‏نعم‬
الادخال	string	النص الذي يتم تصنيفه.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
reference	string	النص الذي يتم تقييمه مقابله.	‏‏نعم‬
النوع	enum	نوع متدرج الدرجات. القيم المحتملة: text_similarity	‏‏نعم‬

OpenAI.GrammarSyntax1

الخاصية	قيمة
نوع	string
Values	lark regex

OpenAI.HybridSearchOptions

الاسم	النوع	وصف	مطلوب	الإفتراضي
embedding_weight	رقم	وزن التضمين في دمج الترتيب المتبادل.	‏‏نعم‬
text_weight	رقم	وزن النص في دمج الترتيب التبادلي.	‏‏نعم‬

OpenAI.ImageDetail

الخاصية	قيمة
نوع	string
Values	low high auto

OpenAI.ImageGenTool

أداة تولد صورا باستخدام نماذج صور GPT.

موديلات صالحة:

gpt-image-1
gpt-image-1-mini

الاسم	النوع	وصف	مطلوب	الإفتراضي
background	enum	نوع الخلفية للصورة التي تم إنشاؤها. واحد من transparent، opaque، أو auto. افتراضي: auto. القيم المحتملة: transparent، ، opaqueauto	لا
input_fidelity	OpenAI.InputFidelity أو null		لا
input_image_mask	OpenAI.ImageGenToolInputImageMask		لا
└─ file_id	string		لا
└─ image_url	string		لا
نموذج	سلسلة (راجع النماذج الصالحة أدناه)		لا
moderation	enum	مستوى الإشراف للصورة التي تم إنشاؤها. افتراضي: auto. القيم المحتملة: auto، low	لا
output_compression	integer	مستوى الضغط لصورة الإخراج. الافتراضي: 100. القيود: الحد الأدنى: 0، الحد الأقصى: 100	لا	100
output_format	enum	تنسيق الإخراج للصورة التي تم إنشاؤها. واحد من pngأو webpأو jpeg. افتراضي: png. القيم المحتملة: png، ، webpjpeg	لا
partial_images	integer	عدد الصور الجزئية التي سيتم إنشاؤها في وضع الدفق، من 0 (القيمة الافتراضية) إلى 3. القيود: الحد الأدنى: 0، الحد الأقصى: 3	لا
جودة	enum	جودة الصورة التي تم إنشاؤها. واحد من low، medium، high، ، أو auto. افتراضي: auto. القيم المحتملة: low، medium، ، highauto	لا
size	enum	حجم الصورة التي تم إنشاؤها. واحد من 1024x1024، 1024x1536، 1536x1024، أو auto. افتراضي: auto. القيم المحتملة: 1024x1024، 1024x1536، ، 1536x1024auto	لا
النوع	enum	نوع أداة إنشاء الصور. دائمًا image_generation. القيم المحتملة: image_generation	‏‏نعم‬

OpenAI.ImageGenToolInputImageMask

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

OpenAI.IncludeEnum

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

• web_search_call.action.sources: قم بتضمين مصادر استدعاء أداة البحث على الويب.
• code_interpreter_call.outputsيتضمن مخرجات تنفيذ كود python في عناصر استدعاء أداة مترجم التعليمات البرمجية.:
• computer_call_output.output.image_urlقم بتضمين عناوين URL للصور من إخراج استدعاء الكمبيوتر.:
• file_search_call.resultsقم بتضمين نتائج البحث لاستدعاء أداة البحث عن الملفات.:
• message.input_image.image_urlقم بتضمين عناوين URL للصور من رسالة الإدخال.:
• message.output_text.logprobsتضمين logprobs مع رسائل المساعد.:
• reasoning.encrypted_contentيتضمن إصدارا مشفرا من الرموز المميزة للاستدلال في مخرجات عنصر التفكير.: يتيح ذلك استخدام عناصر الاستدلال في المحادثات متعددة الأدوار عند استخدام واجهة برمجة تطبيقات الاستجابات بدون حالة (مثل عند تعيين المعلمة store على false، أو عند تسجيل مؤسسة في برنامج الاحتفاظ بالبيانات الصفرية).

الخاصية	قيمة
الوصف	حدد بيانات إخراج إضافية لتضمينها في استجابة النموذج. القيم المدعومة حاليا هي:

• web_search_call.action.sources: قم بتضمين مصادر استدعاء أداة البحث على الويب.
• code_interpreter_call.outputsيتضمن مخرجات تنفيذ كود python في عناصر استدعاء أداة مترجم التعليمات البرمجية.:
• computer_call_output.output.image_urlقم بتضمين عناوين URL للصور من إخراج استدعاء الكمبيوتر.:
• file_search_call.resultsقم بتضمين نتائج البحث لاستدعاء أداة البحث عن الملفات.:
• message.input_image.image_urlقم بتضمين عناوين URL للصور من رسالة الإدخال.:
• message.output_text.logprobsتضمين logprobs مع رسائل المساعد.:
• reasoning.encrypted_contentيتضمن إصدارا مشفرا من الرموز المميزة للاستدلال في مخرجات عنصر التفكير.: يتيح ذلك استخدام عناصر الاستدلال في المحادثات متعددة الأدوار عند استخدام واجهة برمجة تطبيقات الاستجابات بدون حالة (مثل عند تعيين المعلمة store على false، أو عند تسجيل مؤسسة في برنامج الاحتفاظ بالبيانات الصفرية). | | النوع | سلسلة | | القيم | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs |

OpenAI.InputAudio

إدخال صوتي للنموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_audio	OpenAI.InputAudioInputAudio		‏‏نعم‬
النوع	enum	نوع عنصر الإدخال. دائمًا input_audio. القيم المحتملة: input_audio	‏‏نعم‬

OpenAI.InputAudioInputAudio

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	string		‏‏نعم‬
format	enum	القيم المحتملة: mp3، wav	‏‏نعم‬

OpenAI.InputContent

تمييز ل OpenAI.InputContent

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

قيمة النوع	Schema
input_text	OpenAI.InputContentInputTextContent
input_image	OpenAI.InputContentInputImageContent
input_file	OpenAI.InputContentInputFileContent

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.InputContentType		‏‏نعم‬

OpenAI.InputContentInputFileContent

إدخال ملف إلى النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_data	string	محتوى الملف الذي سيتم إرساله إلى النموذج.	لا
file_id	سلسلة أو قيمة خالية		لا
file_url	string	عنوان URL للملف الذي سيتم إرساله إلى النموذج.	لا
filename	string	اسم الملف الذي سيتم إرساله إلى النموذج.	لا
النوع	enum	نوع عنصر الإدخال. دائمًا input_file. القيم المحتملة: input_file	‏‏نعم‬

OpenAI.InputContentInputImageContent

إدخال صورة إلى النموذج. تعرف على مدخلات الصور.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	OpenAI.ImageDetail		‏‏نعم‬
file_id	سلسلة أو قيمة خالية		لا
image_url	سلسلة أو قيمة خالية		لا
النوع	enum	نوع عنصر الإدخال. دائمًا input_image. القيم المحتملة: input_image	‏‏نعم‬

OpenAI.InputContentInputTextContent

إدخال نص إلى النموذج.

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

OpenAI.InputContentType

الخاصية	قيمة
نوع	string
Values	input_text input_image input_file

OpenAI.InputFidelity

تحكم في مقدار الجهد الذي سيبذله النموذج لمطابقة نمط وميزات الصور المدخلة ، وخاصة ملامح الوجه. هذه المعلمة مدعومة فقط ل gpt-image-1. غير مدعوم ل gpt-image-1-mini. يدعم high و low. الإعدادات الافتراضية لـ low.

الخاصية	قيمة
نوع	string
Values	high low

OpenAI.InputFileContent

إدخال ملف إلى النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_data	string	محتوى الملف الذي سيتم إرساله إلى النموذج.	لا
file_id	سلسلة أو قيمة خالية		لا
file_url	string	عنوان URL للملف الذي سيتم إرساله إلى النموذج.	لا
filename	string	اسم الملف الذي سيتم إرساله إلى النموذج.	لا
النوع	enum	نوع عنصر الإدخال. دائمًا input_file. القيم المحتملة: input_file	‏‏نعم‬

OpenAI.InputImageContent

إدخال صورة إلى النموذج. تعرف على مدخلات الصور.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	OpenAI.ImageDetail		‏‏نعم‬
file_id	سلسلة أو قيمة خالية		لا
image_url	سلسلة أو قيمة خالية		لا
النوع	enum	نوع عنصر الإدخال. دائمًا input_image. القيم المحتملة: input_image	‏‏نعم‬

OpenAI.InputItem

تمييز ل OpenAI.InputItem

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

قيمة النوع	Schema
message	OpenAI.EasyInputMessage
item_reference	OpenAI.ItemReferenceParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.InputItemType		‏‏نعم‬

OpenAI.InputItemType

الخاصية	قيمة
نوع	string
Values	message item_reference

OpenAI.InputMessageContentList

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

صفيف: OpenAI.InputContent

OpenAI.InputMessageResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	OpenAI.InputMessageContentList	قائمة بعناصر إدخال واحدة أو العديد من عناصر الإدخال إلى النموذج، تحتوي على محتوى مختلف types.	‏‏نعم‬
المعرف	string	المعرف الفريد لإدخال الرسالة.	‏‏نعم‬
role	enum	دور إدخال الرسالة. واحد من userأو systemأو developer. القيم المحتملة: user، ، systemdeveloper	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
النوع	enum	نوع إدخال الرسالة. عيّنها بشل دائم إلى message. القيم المحتملة: message	‏‏نعم‬

OpenAI.InputParam

النص أو الصورة أو إدخالات الملفات إلى النموذج، المستخدمة لإنشاء استجابة. اعرف المزيد‬:

• مدخلات ومخرجات النص
• إدخالات الصور
• إدخالات الملفات
• حالة المحادثة
• استدعاء الوظيفة

النوع: سلسلة أو صفيف OpenAI.InputItem

النص أو الصورة أو إدخالات الملفات إلى النموذج، المستخدمة لإنشاء استجابة. اعرف المزيد‬:

• مدخلات ومخرجات النص
• إدخالات الصور
• إدخالات الملفات
• حالة المحادثة
• استدعاء الوظيفة

OpenAI.InputTextContent

إدخال نص إلى النموذج.

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

OpenAI.ItemReferenceParam

معرف داخلي لعنصر للرجوع إليه.

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

OpenAI.ItemResource

عنصر المحتوى المستخدم لإنشاء استجابة.

Discriminator ل OpenAI.ItemResource

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

قيمة النوع	Schema
message	OpenAI.InputMessageResource
output_message	OpenAI.ItemResourceOutputMessage
file_search_call	OpenAI.ItemResourceFileSearchToolCall
computer_call	OpenAI.ItemResourceComputerToolCall
computer_call_output	OpenAI.ItemResourceComputerToolCallOutputResource
web_search_call	OpenAI.ItemResourceWebSearchToolCall
function_call	OpenAI.ItemResourceFunctionToolCallResource
function_call_output	OpenAI.ItemResourceFunctionToolCallOutputResource
image_generation_call	OpenAI.ItemResourceImageGenToolCall
code_interpreter_call	OpenAI.ItemResourceCodeInterpreterToolCall
local_shell_call	OpenAI.ItemResourceLocalShellToolCall
local_shell_call_output	OpenAI.ItemResourceLocalShellToolCallOutput
shell_call	OpenAI.ItemResourceFunctionShellCall
shell_call_output	OpenAI.ItemResourceFunctionShellCallOutput
apply_patch_call	OpenAI.ItemResourceApplyPatchToolCall
apply_patch_call_output	OpenAI.ItemResourceApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ItemResourceMcpListTools
mcp_approval_request	OpenAI.ItemResourceMcpApprovalRequest
mcp_approval_response	OpenAI.ItemResourceMcpApprovalResponseResource
mcp_call	OpenAI.ItemResourceMcpToolCall

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ItemResourceType		‏‏نعم‬

OpenAI.ItemResourceApplyPatchToolCall

استدعاء أداة يطبق تلميحات الملفات عن طريق إنشاء الملفات أو حذفها أو تحديثها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة تطبيق التصحيح الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لاستدعاء أداة تطبيق التصحيح. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
operation	OpenAI.ApplyPatchFileOperation	إحدى العمليات create_file أو delete_file أو update_file المطبقة عبر apply_patch.	‏‏نعم‬
└─ النوع	OpenAI.ApplyPatchFileOperationType		‏‏نعم‬
الحالة	OpenAI.ApplyPatchCallStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا apply_patch_call. القيم المحتملة: apply_patch_call	‏‏نعم‬

OpenAI.ItemResourceApplyPatchToolCallOutput

الإخراج المنبعثة من استدعاء تطبيق أداة التصحيح.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة تطبيق التصحيح الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ إخراج استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لتطبيق إخراج استدعاء أداة التصحيح. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
الناتج	سلسلة أو قيمة خالية		لا
الحالة	OpenAI.ApplyPatchCallOutputStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا apply_patch_call_output. القيم المحتملة: apply_patch_call_output	‏‏نعم‬

OpenAI.ItemResourceCodeInterpreterToolCall

استدعاء أداة لتشغيل التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	سلسلة أو قيمة خالية		‏‏نعم‬
container_id	string	معرف الحاوية المستخدمة لتشغيل التعليمات البرمجية.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
outputs	مصفوفة من OpenAI.CodeInterpreterOutputLogs أو OpenAI.CodeInterpreterOutputImage أو null		‏‏نعم‬
الحالة	enum	حالة استدعاء أداة مترجم التعليمات البرمجية. القيم الصالحة هي in_progressوcompletedincompleteinterpreting.failed القيم المحتملة: in_progress، completed، incomplete، ، interpretingfailed	‏‏نعم‬
النوع	enum	نوع استدعاء أداة مترجم التعليمات البرمجية. دائمًا code_interpreter_call. القيم المحتملة: code_interpreter_call	‏‏نعم‬

OpenAI.ItemResourceComputerToolCall

استدعاء أداة إلى أداة استخدام الكمبيوتر. انظر دليل استخدام الكمبيوتر للحصول على مزيد من المعلومات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.ComputerAction		‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء الكمبيوتر.	‏‏نعم‬
pending_safety_checks	صفيف OpenAI.ComputerCallSafetyCheckParam	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع مكالمة الكمبيوتر. دائمًا computer_call. القيم المحتملة: computer_call	‏‏نعم‬

OpenAI.ItemResourceComputerToolCallOutputResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
acknowledged_safety_checks	صفيف OpenAI.ComputerCallSafetyCheckParam	فحوصات السلامة التي أبلغت عنها واجهة برمجة التطبيقات والتي تم الاعتراف بها من قبل المطور.	لا
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج الإخراج.	‏‏نعم‬
المعرف	string	معرف إخراج استدعاء أداة الكمبيوتر.	لا
الناتج	OpenAI.ComputerScreenshotImage	صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من in_progressأو completedأو incomplete. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
النوع	enum	نوع إخراج استدعاء أداة الكمبيوتر. دائمًا computer_call_output. القيم المحتملة: computer_call_output	‏‏نعم‬

OpenAI.ItemResourceFileSearchToolCall

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الفريد لاستدعاء أداة البحث عن الملفات.	‏‏نعم‬
queries	صفيف سلسلة	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
results	مصفوفة من OpenAI.FileSearchToolCallResults أو null		لا
الحالة	enum	حالة استدعاء أداة البحث عن الملفات. واحد من in_progress، searching، incomplete أو failed، القيم المحتملة: in_progress، searching، completed، ، incompletefailed	‏‏نعم‬
النوع	enum	نوع استدعاء أداة البحث عن الملفات. دائمًا file_search_call. القيم المحتملة: file_search_call	‏‏نعم‬

OpenAI.ItemResourceFunctionShellCall

استدعاء أداة ينفذ أمر shell واحد أو أكثر في بيئة مدارة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.FunctionShellAction	تنفيذ أمر shell.	‏‏نعم‬
└─ الأوامر	صفيف سلسلة		‏‏نعم‬
└─ max_output_length	عدد صحيح أو صفري		‏‏نعم‬
└─ timeout_ms	عدد صحيح أو صفري		‏‏نعم‬
call_id	string	معرف فريد لاستدعاء أداة الشل الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لاستدعاء أداة shell. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
الحالة	OpenAI.LocalShellCallStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا shell_call. القيم المحتملة: shell_call	‏‏نعم‬

OpenAI.ItemResourceFunctionShellCallOutput

إخراج استدعاء أداة shell التي تم إصدارها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة الشل الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الممثل الذي أنشأ العنصر.	لا
المعرف	string	المعرف الفريد لإخراج استدعاء shell. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
max_output_length	عدد صحيح أو صفري		‏‏نعم‬
الناتج	صفيف OpenAI.FunctionShellCallOutputContent	صفيف من محتويات إخراج استدعاء shell	‏‏نعم‬
النوع	enum	نوع إخراج استدعاء shell. دائمًا shell_call_output. القيم المحتملة: shell_call_output	‏‏نعم‬

OpenAI.ItemResourceFunctionToolCallOutputResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
المعرف	string	المعرف الفريد لإخراج استدعاء أداة الدالة. يتم ملؤه عند هذا العنصر يتم إرجاعها عبر واجهة برمجة التطبيقات.	لا
الناتج	سلسلة أو صفيف OpenAI.FunctionAndCustomToolCallOutput	الإخراج من استدعاء الدالة الذي تم إنشاؤه بواسطة التعليمات البرمجية الخاصة بك. يمكن أن تكون سلسلة أو قائمة بمحتوى الإخراج.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
النوع	enum	نوع إخراج استدعاء أداة الدالة. دائمًا function_call_output. القيم المحتملة: function_call_output	‏‏نعم‬

OpenAI.ItemResourceFunctionToolCallResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء أداة الدالة.	لا
الاسم	string	اسم الدالة المراد تشغيلها.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
النوع	enum	نوع استدعاء أداة الدالة. دائمًا function_call. القيم المحتملة: function_call	‏‏نعم‬

OpenAI.ItemResourceImageGenToolCall

طلب إنشاء صورة قام به النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	معرف فريد لنداء توليد الصورة.	‏‏نعم‬
نتيجة	سلسلة أو قيمة خالية		‏‏نعم‬
الحالة	enum	حالة مكالمة توليد الصور. القيم المحتملة: in_progress، completed، ، generatingfailed	‏‏نعم‬
النوع	enum	نوع مكالمة توليد الصور. دائمًا image_generation_call. القيم المحتملة: image_generation_call	‏‏نعم‬

OpenAI.ItemResourceLocalShellToolCall

استدعاء أداة لتشغيل أمر على الغلاف المحلي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.LocalShellExecAction	قم بتنفيذ أمر shell على الخادم.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة shell المحلية التي تم إنشاؤها بواسطة النموذج.	‏‏نعم‬
المعرف	string	معرف فريد لنداء الشل المحلي.	‏‏نعم‬
الحالة	enum	حالة نداء القذائف المحلي. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع نداء القذائف المحلي. دائمًا local_shell_call. القيم المحتملة: local_shell_call	‏‏نعم‬

OpenAI.ItemResourceLocalShellToolCallOutput

إخراج استدعاء أداة shell محلية.

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

OpenAI.ItemResourceMcpApprovalRequest

طلب موافقة بشرية على استدعاء أداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات للأداة.	‏‏نعم‬
المعرف	string	المعرف الفريد لطلب الموافقة.	‏‏نعم‬
الاسم	string	اسم الأداة المراد تشغيلها.	‏‏نعم‬
server_label	string	تسمية خادم MCP الذي يقدم الطلب.	‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا mcp_approval_request. القيم المحتملة: mcp_approval_request	‏‏نعم‬

OpenAI.ItemResourceMcpApprovalResponseResource

استجابة لطلب موافقة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
approval_request_id	string	معرف طلب الموافقة الذي يتم الرد عليه.	‏‏نعم‬
approve	boolean	ما إذا كان قد تمت الموافقة على الطلب.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستجابة الموافقة	‏‏نعم‬
السبب	سلسلة أو قيمة خالية		لا
النوع	enum	نوع العنصر. دائمًا mcp_approval_response. القيم المحتملة: mcp_approval_response	‏‏نعم‬

OpenAI.ItemResourceMcpListTools

قائمة بالأدوات المتوفرة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	سلسلة أو قيمة خالية		لا
المعرف	string	معرف القائمة.	‏‏نعم‬
server_label	string	تسمية خادم MCP.	‏‏نعم‬
الأدوات	صفيف OpenAI.MCPListToolsTool	الأدوات المتوفرة على الخادم.	‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا mcp_list_tools. القيم المحتملة: mcp_list_tools	‏‏نعم‬

OpenAI.ItemResourceMcpToolCall

استدعاء أداة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
approval_request_id	سلسلة أو قيمة خالية		لا
الحجج	string	سلسلة JSON من الوسيطات التي تم تمريرها إلى الأداة.	‏‏نعم‬
خطأ	سلسلة أو قيمة خالية		لا
المعرف	string	معرف فريد لاستدعاء الأداة.	‏‏نعم‬
الاسم	string	اسم الأداة التي تم تشغيلها.	‏‏نعم‬
الناتج	سلسلة أو قيمة خالية		لا
server_label	string	تسمية خادم MCP الذي يقوم بتشغيل الأداة.	‏‏نعم‬
الحالة	OpenAI.MCPToolCallStatus		لا
النوع	enum	نوع العنصر. دائمًا mcp_call. القيم المحتملة: mcp_call	‏‏نعم‬

OpenAI.ItemResourceOutputMessage

رسالة إخراج من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف OpenAI.OutputMessageContent	محتوى رسالة الإخراج.	‏‏نعم‬
المعرف	string	المعرف الفريد لرسالة الإخراج.	‏‏نعم‬
role	enum	دور رسالة الإخراج. دائمًا assistant. القيم المحتملة: assistant	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من in_progressأو completedأو incomplete. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع رسالة الإخراج. دائمًا message. القيم المحتملة: output_message	‏‏نعم‬

OpenAI.ItemResourceType

الخاصية	قيمة
نوع	string
Values	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output image_generation_call code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call

OpenAI.ItemResourceWebSearchToolCall

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.WebSearchActionSearch أو OpenAI.WebSearchActionOpenPage أو OpenAI.WebSearchActionFind	كائن يصف الإجراء المحدد الذي تم اتخاذه في استدعاء بحث الويب هذا. يتضمن تفاصيل حول كيفية استخدام النموذج للويب (البحث ، open_page ، البحث).	‏‏نعم‬
المعرف	string	المعرف الفريد لأداة البحث على الويب.	‏‏نعم‬
الحالة	enum	حالة استدعاء أداة البحث على الويب. القيم المحتملة: in_progress، searching، ، completedfailed	‏‏نعم‬
النوع	enum	نوع مكالمة أداة البحث على الويب. دائمًا web_search_call. القيم المحتملة: web_search_call	‏‏نعم‬

OpenAI.KeyPressAction

مجموعة من ضغطات المفاتيح التي يرغب النموذج في تنفيذها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
keys	صفيف سلسلة	مجموعة المفاتيح التي يطلب النموذج الضغط عليها. هذا صفيف من السلاسل، يمثل كل منها مفتاحا.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. لإجراء keypress، يتم تعيين هذه الخاصية دائما إلى keypress. القيم المحتملة: keypress	‏‏نعم‬

OpenAI.ListBatchesResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.Batch		‏‏نعم‬
first_id	string		لا
has_more	boolean		‏‏نعم‬
last_id	string		لا
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ListFilesResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.OpenAIFile		‏‏نعم‬
first_id	string		‏‏نعم‬
has_more	boolean		‏‏نعم‬
last_id	string		‏‏نعم‬
object	string		‏‏نعم‬

OpenAI.ListFineTuningCheckpointPermissionResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة من OpenAI.FineTuningCheckpointPermission		‏‏نعم‬
first_id	سلسلة أو قيمة خالية		لا
has_more	boolean		‏‏نعم‬
last_id	سلسلة أو قيمة خالية		لا
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ListFineTuningJobCheckpointsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	صفيف OpenAI.FineTuningJobCheckpoint		‏‏نعم‬
first_id	سلسلة أو قيمة خالية		لا
has_more	boolean		‏‏نعم‬
last_id	سلسلة أو قيمة خالية		لا
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ListFineTuningJobEventsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	صفيف OpenAI.FineTuningJobEvent		‏‏نعم‬
has_more	boolean		‏‏نعم‬
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ListMessagesResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة من OpenAI.MessageObject		‏‏نعم‬
first_id	string		‏‏نعم‬
has_more	boolean		‏‏نعم‬
last_id	string		‏‏نعم‬
object	string		‏‏نعم‬

OpenAI.ListModelsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.Model		‏‏نعم‬
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ListPaginatedFineTuningJobsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	صفيف OpenAI.FineTuningJob		‏‏نعم‬
has_more	boolean		‏‏نعم‬
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ListRunStepsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.RunStepObject		‏‏نعم‬
first_id	string		‏‏نعم‬
has_more	boolean		‏‏نعم‬
last_id	string		‏‏نعم‬
object	string		‏‏نعم‬

OpenAI.ListRunsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.RunObject		‏‏نعم‬
first_id	string		‏‏نعم‬
has_more	boolean		‏‏نعم‬
last_id	string		‏‏نعم‬
object	string		‏‏نعم‬

OpenAI.ListVectorStoreFilesResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.VectorStoreFileObject		‏‏نعم‬
first_id	string		‏‏نعم‬
has_more	boolean		‏‏نعم‬
last_id	string		‏‏نعم‬
object	string		‏‏نعم‬

OpenAI.ListVectorStoresResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة OpenAI.VectorStoreObject		‏‏نعم‬
first_id	string		‏‏نعم‬
has_more	boolean		‏‏نعم‬
last_id	string		‏‏نعم‬
object	string		‏‏نعم‬

OpenAI.LocalShellCallStatus

الخاصية	قيمة
نوع	string
Values	in_progress completed incomplete

OpenAI.LocalShellExecAction

قم بتنفيذ أمر shell على الخادم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
أمر	صفيف سلسلة	الأمر الذي يجب تشغيله.	‏‏نعم‬
الحياه الفطريه	object	متغيرات البيئة المراد تعيينها للأمر.	‏‏نعم‬
timeout_ms	عدد صحيح أو صفري		لا
النوع	enum	نوع عمل الغلاف المحلي. دائمًا exec. القيم المحتملة: exec	‏‏نعم‬
user	سلسلة أو قيمة خالية		لا
working_directory	سلسلة أو قيمة خالية		لا

OpenAI.LocalShellToolParam

أداة تسمح للنموذج بتنفيذ أوامر shell في بيئة محلية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع أداة shell المحلية. دائمًا local_shell. القيم المحتملة: local_shell	‏‏نعم‬

OpenAI.LogProb

احتمال السجل للرمز المميز.

الاسم	النوع	وصف	مطلوب	الإفتراضي
بايت	صفيف من الأعداد الصحيحة		‏‏نعم‬
لوغاربوب	رقم		‏‏نعم‬
الرمز المميز	string		‏‏نعم‬
top_logprobs	صفيف OpenAI.TopLogProb		‏‏نعم‬

أداة OpenAI.MCPListToolsTool

أداة متوفرة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotations	OpenAI.MCPListToolsToolAnnotations أو null		لا
الوصف	سلسلة أو قيمة خالية		لا
input_schema	OpenAI.MCPListToolsToolInputSchema		‏‏نعم‬
الاسم	string	اسم الأداة.	‏‏نعم‬

OpenAI.MCPListToolsToolAnnotations

النوع: كائن

OpenAI.MCPListToolsToolInputSchema

النوع: كائن

OpenAI.MCPTool

منح النموذج حق الوصول إلى أدوات إضافية عبر خوادم بروتوكول سياق النموذج البعيد (MCP). تعرف على مزيد من المعلومات عن MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
allowed_tools	مصفوفة من النص أو OpenAI.MCPToolFilter أو null		لا
authorization	string	رمز وصول OAuth الذي يمكن استخدامه مع خادم MCP بعيد، إما مع عنوان URL مخصص لخادم MCP أو موصل خدمة. تطبيقك يجب معالجة تدفق تخويل OAuth وتوفير الرمز المميز هنا.	لا
connector_id	enum	معرف لموصلات الخدمة، مثل تلك المتوفرة في ChatGPT. واحد من server_url أو connector_id يجب توفيرها. تعرف على المزيد حول الخدمة الموصلات هنا. القيم المدعومة connector_id حاليا هي: -Dropbox: connector_dropbox -Gmail: connector_gmail - تقويم Google: connector_googlecalendar - Google Drive: connector_googledrive - مايكروسوفت تيمز: connector_microsoftteams - تقويم Outlook: connector_outlookcalendar - البريد الإلكتروني في Outlook: connector_outlookemail -Sharepoint: connector_sharepoint القيم المحتملة: connector_dropbox، connector_gmail، connector_googlecalendar، connector_googledrive، connector_microsoftteams، connector_outlookcalendar، ، connector_outlookemailconnector_sharepoint	لا
headers	مفعول أم صفرا		لا
require_approval	OpenAI.MCPToolRequireApproval أو السلسلة أو null		لا
server_description	string	وصف اختياري لخادم MCP، يستخدم لتوفير المزيد من السياق.	لا
server_label	string	تسمية لخادم MCP هذا، تستخدم لتعريفه في استدعاءات الأدوات.	‏‏نعم‬
server_url	string	عنوان URL لخادم MCP. واحد من server_url أو connector_id يجب أن يكون المقدمة.	لا
النوع	enum	نوع أداة MCP. دائمًا mcp. القيم المحتملة: mcp	‏‏نعم‬

OpenAI.MCPToolCallStatus

الخاصية	قيمة
نوع	string
Values	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

كائن مرشح لتحديد الأدوات المسموح بها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
read_only	boolean	يشير إلى ما إذا كانت الأداة تعدل البيانات أم أنها للقراءة فقط. إذا كان يتم إضافة تعليق توضيحي إلى خادم MCP باستخدام readOnlyHint، سيتطابق مع عامل التصفية هذا.	لا
tool_names	صفيف سلسلة	قائمة بأسماء الأدوات المسموح بها.	لا

OpenAI.MCPToolRequireApproval

الاسم	النوع	وصف	مطلوب	الإفتراضي
دائمًا	OpenAI.MCPToolFilter	كائن مرشح لتحديد الأدوات المسموح بها.	لا
أبدا	OpenAI.MCPToolFilter	كائن مرشح لتحديد الأدوات المسموح بها.	لا

OpenAI.MessageContent

تمييز ل OpenAI.MessageContent

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

قيمة النوع	Schema
image_url	OpenAI.MessageContentImageUrlObject
text	OpenAI.MessageContentTextObject
refusal	OpenAI.MessageContentRefusalObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.MessageContentType		‏‏نعم‬

OpenAI.MessageContentImageFileObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
image_file	OpenAI.MessageContentImageFileObjectImageFile		‏‏نعم‬
النوع	enum	دائمًا image_file. القيم المحتملة: image_file	‏‏نعم‬

OpenAI.MessageContentImageFileObjectImageFile

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	enum	القيم المحتملة: auto، ، lowhigh	لا
file_id	string		‏‏نعم‬

OpenAI.MessageContentImageUrlObject

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

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

OpenAI.MessageContentImageUrlObjectImageUrl

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	enum	القيم المحتملة: auto، ، lowhigh	لا
عنوان URL	string		‏‏نعم‬

OpenAI.MessageContentRefusalObject

محتوى الرفض الذي يولده المساعد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رفض	string		‏‏نعم‬
النوع	enum	دائمًا refusal. القيم المحتملة: refusal	‏‏نعم‬

OpenAI.MessageContentTextAnnotationsFileCitationObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
end_index	integer	القيود: الحد الأدنى: 0	‏‏نعم‬
file_citation	OpenAI.MessageContentTextAnnotationsFileCitationObjectFileFileCitation		‏‏نعم‬
start_index	integer	القيود: الحد الأدنى: 0	‏‏نعم‬
نص	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	‏‏نعم‬
النوع	enum	دائمًا file_citation. القيم المحتملة: file_citation	‏‏نعم‬

OpenAI.MessageContentTextAnnotationsFileCitationObjectFileFileCitation

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

OpenAI.MessageContentTextAnnotationsFilePathObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
end_index	integer	القيود: الحد الأدنى: 0	‏‏نعم‬
file_path	OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath		‏‏نعم‬
start_index	integer	القيود: الحد الأدنى: 0	‏‏نعم‬
نص	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	‏‏نعم‬
النوع	enum	دائمًا file_path. القيم المحتملة: file_path	‏‏نعم‬

OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath

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

OpenAI.MessageContentTextObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	OpenAI.MessageContentTextObjectText		‏‏نعم‬
النوع	enum	دائمًا text. القيم المحتملة: text	‏‏نعم‬

OpenAI.MessageContentTextObjectText

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotations	مصفوفة من OpenAI.TextAnnotation		‏‏نعم‬
القيمة	string		‏‏نعم‬

OpenAI.MessageContentType

الخاصية	قيمة
نوع	string
Values	image_file image_url text refusal

OpenAI.MessageObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
assistant_id	سلسلة أو قيمة خالية		‏‏نعم‬
attachments	مصفوفة من OpenAI.MessageObjectAttachments أو null		‏‏نعم‬
completed_at	سلسلة أو قيمة خالية		‏‏نعم‬
محتوى	صفيف OpenAI.MessageContent	محتوى الرسالة في صفيف من النص و/أو الصور.	‏‏نعم‬
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء الرسالة.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
incomplete_at	سلسلة أو قيمة خالية		‏‏نعم‬
incomplete_details	OpenAI.MessageObjectIncompleteDetails أو null		‏‏نعم‬
metadata	OpenAI.Metadata أو null		‏‏نعم‬
object	enum	نوع الكائن، الذي يتم thread.messageدائما . القيم المحتملة: thread.message	‏‏نعم‬
role	enum	الكيان الذي أنتج الرسالة. أحد user أو assistant. القيم المحتملة: user، assistant	‏‏نعم‬
run_id	سلسلة أو قيمة خالية		‏‏نعم‬
الحالة	enum	حالة الرسالة، والتي يمكن أن تكون إما in_progressأو incompleteأو completed. القيم المحتملة: in_progress، ، incompletecompleted	‏‏نعم‬
thread_id	string	معرف الخيط الذي تنتمي إليه هذه الرسالة.	‏‏نعم‬

OpenAI.MessageObjectAttachments

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	string		لا
الأدوات	مصفوفة من OpenAI.AssistantToolsCode أو OpenAI.AssistantToolsFileSearchTypeOnly		لا

OpenAI.MessageObjectIncompleteDetails

الاسم	النوع	وصف	مطلوب	الإفتراضي
السبب	enum	القيم المحتملة: content_filter، max_tokens، run_cancelled، ، run_expiredrun_failed	‏‏نعم‬

OpenAI.MessageRequestContentTextObject

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

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

OpenAI.MessageRole

الخاصية	قيمة
نوع	string
Values	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

الخاصية	قيمة
نوع	string
Values	in_progress completed incomplete

OpenAI.Metadata

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

النوع: كائن

نموذج OpenAI.

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
created	integer	الطابع الزمني ل Unix (بالثواني) عند إنشاء النموذج.	‏‏نعم‬
المعرف	string	معرف النموذج، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
object	enum	نوع الكائن ، وهو دائما "نموذج". القيم المحتملة: model	‏‏نعم‬
owned_by	string	المنظمة التي تمتلك النموذج.	‏‏نعم‬

OpenAI.ModifyMessageRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata أو null		لا

OpenAI.ModifyRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata أو null		لا

OpenAI.ModifyThreadRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata أو null		لا
tool_resources	OpenAI.ModifyThreadRequestToolResources أو null		لا

OpenAI.ModifyThreadRequestToolResources

الاسم	النوع	وصف	مطلوب	الإفتراضي
code_interpreter	OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter		لا
file_search	OpenAI.ModifyThreadRequestToolResourcesFileSearch		لا

OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter

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

OpenAI.ModifyThreadRequestToolResourcesFileSearch

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

OpenAI.Move

إجراء تحريك الماوس.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء النقل، تكون هذه الخاصية هي اضبط دائما على move. القيم المحتملة: move	‏‏نعم‬
×	integer	الإحداثي س للانتقال إليه.	‏‏نعم‬
y	integer	الإحداثي ص للانتقال إليه.	‏‏نعم‬

OpenAI.NoiseReductionType

نوع الحد من الضوضاء. near_field للميكروفونات القريبة مثل سماعات الرأس، far_field مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات.

الخاصية	قيمة
نوع	string
Values	near_field far_field

OpenAI.OpenAIFile

يمثل الكائن File وثيقة تم رفعها إلى OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
بايت	integer	حجم الملف، بالبايت.	‏‏نعم‬
created_at	integer	الطابع الزمني ل Unix (بالثواني) لوقت إنشاء الملف.	‏‏نعم‬
expires_at	integer	الطابع الزمني ل Unix (بالثواني) لوقت انتهاء صلاحية الملف.	لا
filename	string	اسم الملف.	‏‏نعم‬
المعرف	string	معرف الملف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
object	enum	نوع الكائن، الذي يتم fileدائما . القيم المحتملة: file	‏‏نعم‬
قصد	enum	الغرض المقصود من الملف. القيم المدعومة هي assistants، assistants_output، batch، batch_outputو fine-tunefine-tune-results . القيم المحتملة: assistants، assistants_output، ، batchbatch_outputfine-tunefine-tune-resultsevals	‏‏نعم‬
الحالة	enum	القيم المحتملة: uploaded، pending، ، runningprocessederrordeletingdeleted	‏‏نعم‬
status_details	سلسلة (مهملة)	مهملة. للحصول على تفاصيل حول سبب فشل التحقق من صحة ملف تدريب الضبط الدقيق، راجع error الحقل الموجود في fine_tuning.job.	لا

OpenAI.OtherChunkingStrategyResponseParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	دائمًا other. القيم المحتملة: other	‏‏نعم‬

OpenAI.OutputContent

تمييز ل OpenAI.OutputContent

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

قيمة النوع	Schema
output_text	OpenAI.OutputContentOutputTextContent
refusal	OpenAI.OutputContentRefusalContent

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.OutputContentType		‏‏نعم‬

OpenAI.OutputContentOutputTextContent

إخراج نص من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotations	صفيف OpenAI.Annotation	التعليقات التوضيحية لإخراج النص.	‏‏نعم‬
سجلات الحماية	صفيف OpenAI.LogProb		لا
نص	string	إخراج النص من النموذج.	‏‏نعم‬
النوع	enum	نوع النص الناتج. دائمًا output_text. القيم المحتملة: output_text	‏‏نعم‬

OpenAI.OutputContentRefusalContent

رفض من النموذج.

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

OpenAI.OutputContentType

الخاصية	قيمة
نوع	string
Values	output_text refusal reasoning_text

OpenAI.OutputItem

تمييز ل OpenAI.OutputItem

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

قيمة النوع	Schema
output_message	OpenAI.OutputItemOutputMessage
file_search_call	OpenAI.OutputItemFileSearchToolCall
function_call	OpenAI.OutputItemFunctionToolCall
web_search_call	OpenAI.OutputItemWebSearchToolCall
computer_call	OpenAI.OutputItemComputerToolCall
reasoning	OpenAI.OutputItemReasoningItem
compaction	OpenAI.OutputItemCompactionBody
image_generation_call	OpenAI.OutputItemImageGenToolCall
code_interpreter_call	OpenAI.OutputItemCodeInterpreterToolCall
local_shell_call	OpenAI.OutputItemLocalShellToolCall
shell_call	OpenAI.OutputItemFunctionShellCall
shell_call_output	OpenAI.OutputItemFunctionShellCallOutput
apply_patch_call	OpenAI.OutputItemApplyPatchToolCall
apply_patch_call_output	OpenAI.OutputItemApplyPatchToolCallOutput
mcp_call	OpenAI.OutputItemMcpToolCall
mcp_list_tools	OpenAI.OutputItemMcpListTools
mcp_approval_request	OpenAI.OutputItemMcpApprovalRequest
custom_tool_call	OpenAI.OutputItemCustomToolCall

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.OutputItemType		‏‏نعم‬

OpenAI.OutputItemApplyPatchToolCall

استدعاء أداة يطبق تلميحات الملفات عن طريق إنشاء الملفات أو حذفها أو تحديثها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة تطبيق التصحيح الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لاستدعاء أداة تطبيق التصحيح. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
operation	OpenAI.ApplyPatchFileOperation	إحدى العمليات create_file أو delete_file أو update_file المطبقة عبر apply_patch.	‏‏نعم‬
└─ النوع	OpenAI.ApplyPatchFileOperationType		‏‏نعم‬
الحالة	OpenAI.ApplyPatchCallStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا apply_patch_call. القيم المحتملة: apply_patch_call	‏‏نعم‬

OpenAI.OutputItemApplyPatchToolCallOutput

الإخراج المنبعثة من استدعاء تطبيق أداة التصحيح.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة تطبيق التصحيح الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ إخراج استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لتطبيق إخراج استدعاء أداة التصحيح. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
الناتج	سلسلة أو قيمة خالية		لا
الحالة	OpenAI.ApplyPatchCallOutputStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا apply_patch_call_output. القيم المحتملة: apply_patch_call_output	‏‏نعم‬

OpenAI.OutputItemCodeInterpreterToolCall

استدعاء أداة لتشغيل التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	سلسلة أو قيمة خالية		‏‏نعم‬
container_id	string	معرف الحاوية المستخدمة لتشغيل التعليمات البرمجية.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
outputs	مصفوفة من OpenAI.CodeInterpreterOutputLogs أو OpenAI.CodeInterpreterOutputImage أو null		‏‏نعم‬
الحالة	enum	حالة استدعاء أداة مترجم التعليمات البرمجية. القيم الصالحة هي in_progressوcompletedincompleteinterpreting.failed القيم المحتملة: in_progress، completed، incomplete، ، interpretingfailed	‏‏نعم‬
النوع	enum	نوع استدعاء أداة مترجم التعليمات البرمجية. دائمًا code_interpreter_call. القيم المحتملة: code_interpreter_call	‏‏نعم‬

OpenAI.OutputItemCompactionBody

عنصر ضغط يتم تولده واجهةv1/responses/compact برمجة التطبيقات (API).

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_by	string	معرف الممثل الذي أنشأ العنصر.	لا
encrypted_content	string	المحتوى المشفر الذي تم إنتاجه بواسطة الضغط.	‏‏نعم‬
المعرف	string	المعرف الفريد لعنصر الضغط.	‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا compaction. القيم المحتملة: compaction	‏‏نعم‬

OpenAI.OutputItemComputerToolCall

استدعاء أداة إلى أداة استخدام الكمبيوتر. انظر دليل استخدام الكمبيوتر للحصول على مزيد من المعلومات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.ComputerAction		‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء الكمبيوتر.	‏‏نعم‬
pending_safety_checks	صفيف OpenAI.ComputerCallSafetyCheckParam	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع مكالمة الكمبيوتر. دائمًا computer_call. القيم المحتملة: computer_call	‏‏نعم‬

OpenAI.OutputItemCustomToolCall

استدعاء لأداة مخصصة أنشأها النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف يستخدم لربط استدعاء الأداة المخصص هذا بمخرج استدعاء أداة.	‏‏نعم‬
المعرف	string	المعرف الفريد لنداء الأداة المخصصة في منصة OpenAI.	لا
الادخال	string	المدخلات لاستدعاء الأداة المخصصة التي يولدها النموذج.	‏‏نعم‬
الاسم	string	اسم الأداة المخصصة التي يتم استدعاؤها.	‏‏نعم‬
النوع	enum	نوع استدعاء الأداة المخصصة. دائمًا custom_tool_call. القيم المحتملة: custom_tool_call	‏‏نعم‬

OpenAI.OutputItemFileSearchToolCall

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الفريد لاستدعاء أداة البحث عن الملفات.	‏‏نعم‬
queries	صفيف سلسلة	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
results	مصفوفة من OpenAI.FileSearchToolCallResults أو null		لا
الحالة	enum	حالة استدعاء أداة البحث عن الملفات. واحد من in_progress، searching، incomplete أو failed، القيم المحتملة: in_progress، searching، completed، ، incompletefailed	‏‏نعم‬
النوع	enum	نوع استدعاء أداة البحث عن الملفات. دائمًا file_search_call. القيم المحتملة: file_search_call	‏‏نعم‬

OpenAI.OutputItemFunctionShellCall

استدعاء أداة ينفذ أمر shell واحد أو أكثر في بيئة مدارة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.FunctionShellAction	تنفيذ أمر shell.	‏‏نعم‬
└─ الأوامر	صفيف سلسلة		‏‏نعم‬
└─ max_output_length	عدد صحيح أو صفري		‏‏نعم‬
└─ timeout_ms	عدد صحيح أو صفري		‏‏نعم‬
call_id	string	معرف فريد لاستدعاء أداة الشل الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الكيان الذي أنشأ استدعاء الأداة هذه.	لا
المعرف	string	المعرف الفريد لاستدعاء أداة shell. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
الحالة	OpenAI.LocalShellCallStatus		‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا shell_call. القيم المحتملة: shell_call	‏‏نعم‬

OpenAI.OutputItemFunctionShellCallOutput

إخراج استدعاء أداة shell التي تم إصدارها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	معرف فريد لاستدعاء أداة الشل الذي يولده النموذج.	‏‏نعم‬
created_by	string	معرف الممثل الذي أنشأ العنصر.	لا
المعرف	string	المعرف الفريد لإخراج استدعاء shell. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	‏‏نعم‬
max_output_length	عدد صحيح أو صفري		‏‏نعم‬
الناتج	صفيف OpenAI.FunctionShellCallOutputContent	صفيف من محتويات إخراج استدعاء shell	‏‏نعم‬
النوع	enum	نوع إخراج استدعاء shell. دائمًا shell_call_output. القيم المحتملة: shell_call_output	‏‏نعم‬

OpenAI.OutputItemFunctionToolCall

استدعاء أداة لتشغيل دالة. راجع دليل استدعاء الوظائف لمزيد من المعلومات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
المعرف	string	المعرف الفريد لاستدعاء أداة الدالة.	لا
الاسم	string	اسم الدالة المراد تشغيلها.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
النوع	enum	نوع استدعاء أداة الدالة. دائمًا function_call. القيم المحتملة: function_call	‏‏نعم‬

OpenAI.OutputItemImageGenToolCall

طلب إنشاء صورة قام به النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	معرف فريد لنداء توليد الصورة.	‏‏نعم‬
نتيجة	سلسلة أو قيمة خالية		‏‏نعم‬
الحالة	enum	حالة مكالمة توليد الصور. القيم المحتملة: in_progress، completed، ، generatingfailed	‏‏نعم‬
النوع	enum	نوع مكالمة توليد الصور. دائمًا image_generation_call. القيم المحتملة: image_generation_call	‏‏نعم‬

OpenAI.OutputItemLocalShellToolCall

استدعاء أداة لتشغيل أمر على الغلاف المحلي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.LocalShellExecAction	قم بتنفيذ أمر shell على الخادم.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة shell المحلية التي تم إنشاؤها بواسطة النموذج.	‏‏نعم‬
المعرف	string	معرف فريد لنداء الشل المحلي.	‏‏نعم‬
الحالة	enum	حالة نداء القذائف المحلي. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع نداء القذائف المحلي. دائمًا local_shell_call. القيم المحتملة: local_shell_call	‏‏نعم‬

OpenAI.OutputItemMcpApprovalRequest

طلب موافقة بشرية على استدعاء أداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات للأداة.	‏‏نعم‬
المعرف	string	المعرف الفريد لطلب الموافقة.	‏‏نعم‬
الاسم	string	اسم الأداة المراد تشغيلها.	‏‏نعم‬
server_label	string	تسمية خادم MCP الذي يقدم الطلب.	‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا mcp_approval_request. القيم المحتملة: mcp_approval_request	‏‏نعم‬

OpenAI.OutputItemMcpListTools

قائمة بالأدوات المتوفرة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	سلسلة أو قيمة خالية		لا
المعرف	string	معرف القائمة.	‏‏نعم‬
server_label	string	تسمية خادم MCP.	‏‏نعم‬
الأدوات	صفيف OpenAI.MCPListToolsTool	الأدوات المتوفرة على الخادم.	‏‏نعم‬
النوع	enum	نوع العنصر. دائمًا mcp_list_tools. القيم المحتملة: mcp_list_tools	‏‏نعم‬

OpenAI.OutputItemMcpToolCall

استدعاء أداة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
approval_request_id	سلسلة أو قيمة خالية		لا
الحجج	string	سلسلة JSON من الوسيطات التي تم تمريرها إلى الأداة.	‏‏نعم‬
خطأ	سلسلة أو قيمة خالية		لا
المعرف	string	معرف فريد لاستدعاء الأداة.	‏‏نعم‬
الاسم	string	اسم الأداة التي تم تشغيلها.	‏‏نعم‬
الناتج	سلسلة أو قيمة خالية		لا
server_label	string	تسمية خادم MCP الذي يقوم بتشغيل الأداة.	‏‏نعم‬
الحالة	OpenAI.MCPToolCallStatus		لا
النوع	enum	نوع العنصر. دائمًا mcp_call. القيم المحتملة: mcp_call	‏‏نعم‬

OpenAI.OutputItemOutputMessage

رسالة إخراج من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف OpenAI.OutputMessageContent	محتوى رسالة الإخراج.	‏‏نعم‬
المعرف	string	المعرف الفريد لرسالة الإخراج.	‏‏نعم‬
role	enum	دور رسالة الإخراج. دائمًا assistant. القيم المحتملة: assistant	‏‏نعم‬
الحالة	enum	حالة إدخال الرسالة. واحد من in_progressأو completedأو incomplete. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع رسالة الإخراج. دائمًا message. القيم المحتملة: output_message	‏‏نعم‬

OpenAI.OutputItemReasoningItem

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف OpenAI.ReasoningTextContent	محتوى نص منطقي.	لا
encrypted_content	سلسلة أو قيمة خالية		لا
المعرف	string	المعرف الفريد لمحتوى المنطق.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	لا
الملخص.	صفيف OpenAI.Summary	ملخص المنطق والمحتوى.	‏‏نعم‬
النوع	enum	نوع الكائن. دائمًا reasoning. القيم المحتملة: reasoning	‏‏نعم‬

OpenAI.OutputItemType

الخاصية	قيمة
نوع	string
Values	output_message file_search_call function_call web_search_call computer_call reasoning compaction image_generation_call code_interpreter_call local_shell_call shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_call mcp_list_tools mcp_approval_request custom_tool_call

OpenAI.OutputItemWebSearchToolCall

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.WebSearchActionSearch أو OpenAI.WebSearchActionOpenPage أو OpenAI.WebSearchActionFind	كائن يصف الإجراء المحدد الذي تم اتخاذه في استدعاء بحث الويب هذا. يتضمن تفاصيل حول كيفية استخدام النموذج للويب (البحث ، open_page ، البحث).	‏‏نعم‬
المعرف	string	المعرف الفريد لأداة البحث على الويب.	‏‏نعم‬
الحالة	enum	حالة استدعاء أداة البحث على الويب. القيم المحتملة: in_progress، searching، ، completedfailed	‏‏نعم‬
النوع	enum	نوع مكالمة أداة البحث على الويب. دائمًا web_search_call. القيم المحتملة: web_search_call	‏‏نعم‬

OpenAI.OutputMessageContent

تمييز ل OpenAI.OutputMessageContent

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

قيمة النوع	Schema
output_text	OpenAI.OutputMessageContentOutputTextContent
refusal	OpenAI.OutputMessageContentRefusalContent

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.OutputMessageContentType		‏‏نعم‬

OpenAI.OutputMessageContentOutputTextContent

إخراج نص من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotations	صفيف OpenAI.Annotation	التعليقات التوضيحية لإخراج النص.	‏‏نعم‬
سجلات الحماية	صفيف OpenAI.LogProb		لا
نص	string	إخراج النص من النموذج.	‏‏نعم‬
النوع	enum	نوع النص الناتج. دائمًا output_text. القيم المحتملة: output_text	‏‏نعم‬

OpenAI.OutputMessageContentRefusalContent

رفض من النموذج.

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

OpenAI.OutputMessageContentType

الخاصية	قيمة
نوع	string
Values	output_text refusal

OpenAI.OutputTextContent

إخراج نص من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotations	صفيف OpenAI.Annotation	التعليقات التوضيحية لإخراج النص.	‏‏نعم‬
سجلات الحماية	صفيف OpenAI.LogProb		لا
نص	string	إخراج النص من النموذج.	‏‏نعم‬
النوع	enum	نوع النص الناتج. دائمًا output_text. القيم المحتملة: output_text	‏‏نعم‬

OpenAI.ParallelToolCalls

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

النوع: منطقي

OpenAI.PredictionContent

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

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

OpenAI.Prompt

الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الفريد لقالب المطالبة المراد استخدامه.	‏‏نعم‬
متغيرات	OpenAI.ResponsePromptVariables أو null		لا
إصدار	سلسلة أو قيمة خالية		لا

OpenAI.RankerVersionType

الخاصية	قيمة
نوع	string
Values	auto default-2024-11-15

OpenAI.RankingOptions

الاسم	النوع	وصف	مطلوب	الإفتراضي
hybrid_search	OpenAI.HybridSearchOptions		لا
└─ embedding_weight	رقم	وزن التضمين في دمج الترتيب المتبادل.	‏‏نعم‬
└─ text_weight	رقم	وزن النص في دمج الترتيب التبادلي.	‏‏نعم‬
ranker	OpenAI.RankerVersionType		لا
score_threshold	رقم	حد الدرجة للبحث في الملف، رقم بين 0 و1. ستحاول الأرقام الأقرب إلى 1 إرجاع النتائج الأكثر صلة فقط، ولكنها قد ترجع نتائج أقل.	لا

OpenAI.RealtimeAudioFormats

المميز لصيغ OpenAI.RealtimeAudioFormats

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

قيمة النوع	Schema
audio/pcm	OpenAI.RealtimeAudioFormatsAudioPcm
audio/pcmu	OpenAI.RealtimeAudioFormatsAudioPcmu
audio/pcma	OpenAI.RealtimeAudioFormatsAudioPcma

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.RealtimeAudioFormatsType		‏‏نعم‬

OpenAI.RealtimeAudioFormatsAudioPcm

الاسم	النوع	وصف	مطلوب	الإفتراضي
معدل	enum	القيم المحتملة: 24000	لا
النوع	enum	القيم المحتملة: audio/pcm	‏‏نعم‬

OpenAI.RealtimeAudioFormatsAudioPcma

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: audio/pcma	‏‏نعم‬

OpenAI.RealtimeAudioFormatsAudioPcmu

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: audio/pcmu	‏‏نعم‬

OpenAI.RealtimeAudioFormatsType

الخاصية	قيمة
نوع	string
Values	audio/pcm audio/pcmu audio/pcma

OpenAI.RealtimeCallCreateRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
SDP	string	بروتوكول وصف جلسة WebRTC (SDP) الذي يولده المتصل.	‏‏نعم‬
جلسة	OpenAI.RealtimeSessionCreateRequestGA	تكوين كائن جلسة العمل في الوقت الحقيقي.	لا
└─ الصوت	OpenAI.RealtimeSessionCreateRequestGAAudio	تكوين الصوت المدخل والإخراج.	لا
└─ تشمل	صفيف سلسلة	حقول إضافية يجب تضمينها في مخرجات الخادم. item.input_audio_transcription.logprobs: تضمين logprobs لنقل الصوت المدخل.	لا
└─ تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وصيغتها، (مثل "كن موجزا للغاية"، "تصرف وديا"، "إليك أمثلة على الردود الجيدة") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر في صوتك"، "ضحك كثيرا"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.	لا
└─ max_output_tokens	عدد صحيح (انظر النماذج الصحيحة أدناه)	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحدة، بما في ذلك استدعاءات الأدوات. قدم عددا صحيحا بين 1 و 4096 إلى تحديد رموز الإخراج، أو inf الحد الأقصى المتاح للرموز ل النموذج المعطى. الإعدادات الافتراضية لـ inf.	لا
└─ نموذج	string	النموذج الزمني المستخدم لهذه الجلسة.	لا
└─ output_modalities	صفيف سلسلة	مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. يتم تلقائيا إلى ["audio"]، مما يشير إلى وأن النموذج سيرد بالصوت بالإضافة إلى نص مكتوب. ["text"] يمكن استخدامها لصنع يرد النموذج بالنص فقط. لا يمكن طلب الاثنين textaudio معا في نفس الوقت.	لا	['صوت']
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
└─ tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceFunction أو OpenAI.ToolChoiceMCP	كيف يختار النموذج الأدوات. قدم أحد أوضاع الوتر أو فرض على وضع معين أداة الدالة/MCP.	لا	تلقائي
└─ الأدوات	مصفوفة من OpenAI.RealtimeFunctionTool أو OpenAI.MCPTool	الأدوات المتاحة للنموذج.	لا
└─ التتبع	string أو OpenAI.RealtimeSessionCreateRequestGATracing أو null	"" ضبطه على الصفر لتعطيل التتبع. مرة واحدة يتم تفعيل التتبع للجلسة، ولا يمكن تعديل التكوين. auto سيقوم بإنشاء تتبع للجلسة مع قيم افتراضية ل اسم سير العمل، معرف المجموعة، والبيانات الوصفية.	لا	تلقائي
└─ الاقتطاع	OpenAI.RealtimeCutncation	عندما يتجاوز عدد الرموز في المحادثة حد رموز الإدخال في النموذج، يتم اختصار المحادثة، مما يعني أن الرسائل (التي تبدأ من الأقدم) لن تدرج في سياق النموذج. نموذج السياق 32k مع 4,096 رمز إخراج أقصى يمكنه فقط تضمين 28,224 رمزا في السياق قبل حدوث القطع. يمكن للعملاء تكوين سلوك القطع بحيث يتم القطع بحد أقصى أقل للرمز، وهو طريقة فعالة للتحكم في استخدام الرموز وتكلفتها. القطع سيقلل عدد الرموز المخزنة في الدور التالي (مما يؤدي إلى تدمير الكاش)، لأن الرسائل تسقط من بداية السياق. ومع ذلك، يمكن للعملاء أيضا تكوين القطع للاحتفاظ بالرسائل حتى جزء بسيط من الحد الأقصى لحجم السياق، مما يقلل الحاجة إلى القطع المستقبلي وبالتالي يحسن معدل الكاش. يمكن تعطيل القطع تماما، مما يعني أن الخادم لن يقطع أبدا بل سيعيد خطأ إذا تجاوزت المحادثة حد رموز الإدخال في النموذج.	لا
└─ النوع	enum	نوع الجلسة التي يجب إنشاؤها. دائما realtime لواجهة برمجة التطبيقات في الوقت الحقيقي. القيم المحتملة: realtime	‏‏نعم‬

OpenAI.RealtimeCallReferRequest

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
target_uri	string	URI الذي يجب أن يظهر في رأس SIP Refer-To. يدعم القيم مثل tel:+14155550123 أو sip:agent\@example.com.	‏‏نعم‬

OpenAI.RealtimeCallRejectRequest

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
status_code	integer	رمز استجابة SIP لإرسالها إلى المتصل. الإعدادات الافتراضية إلى 603 (تراجع) عندما يتم حذفها.	لا

OpenAI.RealtimeCreateClientSecretRequest

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_after	OpenAI.RealtimeCreateClientSecretRequestexpiresAfter		لا
└─ مرساة	enum	القيم المحتملة: created_at	لا
└─ ثواني	integer	القيود: الحد الأدنى: 10، الحد الأقصى: 7200	لا	600
جلسة	OpenAI.RealtimeSessionCreateRequestUnion		لا
└─ النوع	OpenAI.RealtimeSessionCreateRequestUnionType		‏‏نعم‬

OpenAI.RealtimeCreateClientSecretRequestexpiresAfter

الاسم	النوع	وصف	مطلوب	الإفتراضي
anchor	enum	القيم المحتملة: created_at	لا
الثواني	integer	القيود: الحد الأدنى: 10، الحد الأقصى: 7200	لا	600

OpenAI.RealtimeCreateClientSecretResponse

استجابة من إنشاء سر جلسة وعميل لواجهة برمجة التطبيقات في الوقت الحقيقي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_at	integer	ختم انتهاء الصلاحية لسر العميل، في ثوان منذ فترة الحق.	‏‏نعم‬
جلسة	OpenAI.RealtimeSessionCreateResponseUnion		‏‏نعم‬
└─ النوع	OpenAI.RealtimeSessionCreateResponseUnionType		‏‏نعم‬
القيمة	string	القيمة السرية المولدة للعميل.	‏‏نعم‬

OpenAI.RealtimeFunctionTool

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف الدالة، بما في ذلك الإرشادات حول متى وكيف لتحديد الموضوع، وإرشادات حول ما يجب قوله للمستخدم عند الاتصال (إن كان هناك شيء).	لا
الاسم	string	اسم الدالة	لا
المعلمات	OpenAI.RealtimeFunctionToolParameters		لا
النوع	enum	نوع الأداة، أي function. القيم المحتملة: function	لا

OpenAI.RealtimeFunctionToolParameters

النوع: كائن

OpenAI.RealtimeSessionCreateRequest

تكوين جلسة عمل في الوقت الحقيقي جديد، مع مفتاح سريع الزوال. TTL الافتراضي للمفاتيح هو دقيقة واحدة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
client_secret	OpenAI.RealtimeSessionCreateRequestClientSecret		‏‏نعم‬
└─ expires_at	integer		‏‏نعم‬
└─ القيمة	string		‏‏نعم‬
input_audio_format	string	تنسيق صوت الإدخال. الخيارات هي pcm16أو g711_ulawأو g711_alaw.	لا
input_audio_transcription	OpenAI.RealtimeSessionCreateRequestInputAudioTranscription		لا
└─ نموذج	string		لا
تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وصيغتها، (مثل "كن موجزا للغاية"، "تصرف وديا"، "إليك أمثلة على الردود الجيدة") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر في صوتك"، "ضحك كثيرا"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.	لا
max_response_output_tokens	عدد صحيح (انظر النماذج الصحيحة أدناه)	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحدة، بما في ذلك استدعاءات الأدوات. قدم عددا صحيحا بين 1 و 4096 إلى تحديد رموز الإخراج، أو inf الحد الأقصى المتاح للرموز ل النموذج المعطى. الإعدادات الافتراضية لـ inf.	لا
طرائق	صفيف سلسلة	مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، اضبط هذا على ["نص"].	لا	['نص'، 'صوت']
output_audio_format	string	تنسيق صوت الإخراج. الخيارات هي pcm16أو g711_ulawأو g711_alaw.	لا
فوري	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
speed	رقم	سرعة استجابة النموذج المنطوقة. 1.0 هي السرعة الافتراضية. 0.25 هو السرعة الدنيا فقط. 1.5 هي السرعة القصوى. يمكن تغيير هذه القيمة فقط بين أدوار النموذج، ليس أثناء حدوث الرد. القيود: الحد الأدنى: 0.25، الحد الأقصى: 1.5	لا	1
درجة الحرارة	رقم	درجة حرارة أخذ العينات للنموذج، تقتصر على [0.6، 1.2]. الإعدادات الافتراضية إلى 0.8.	لا
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي auto، none، required، أو حدد دالة.	لا
الأدوات	مصفوفة من OpenAI.RealtimeSessionCreateRequestTools	الأدوات (الوظائف) المتوفرة للنموذج.	لا
tracing	سلسلة أو كائن	خيارات التكوين للتتبع. ضبطه على الصفر لتعطيل التتبع. مرة واحدة يتم تفعيل التتبع للجلسة، ولا يمكن تعديل التكوين. auto سيقوم بإنشاء تتبع للجلسة مع قيم افتراضية ل اسم سير العمل، معرف المجموعة، والبيانات الوصفية.	لا
اقتطاع	OpenAI.RealtimeCutncation	عندما يتجاوز عدد الرموز في المحادثة حد رموز الإدخال في النموذج، يتم اختصار المحادثة، مما يعني أن الرسائل (التي تبدأ من الأقدم) لن تدرج في سياق النموذج. نموذج السياق 32k مع 4,096 رمز إخراج أقصى يمكنه فقط تضمين 28,224 رمزا في السياق قبل حدوث القطع. يمكن للعملاء تكوين سلوك القطع بحيث يتم القطع بحد أقصى أقل للرمز، وهو طريقة فعالة للتحكم في استخدام الرموز وتكلفتها. القطع سيقلل عدد الرموز المخزنة في الدور التالي (مما يؤدي إلى تدمير الكاش)، لأن الرسائل تسقط من بداية السياق. ومع ذلك، يمكن للعملاء أيضا تكوين القطع للاحتفاظ بالرسائل حتى جزء بسيط من الحد الأقصى لحجم السياق، مما يقلل الحاجة إلى القطع المستقبلي وبالتالي يحسن معدل الكاش. يمكن تعطيل القطع تماما، مما يعني أن الخادم لن يقطع أبدا بل سيعيد خطأ إذا تجاوزت المحادثة حد رموز الإدخال في النموذج.	لا
turn_detection	OpenAI.RealtimeSessionCreateRequestTurnDetection		لا
└─ prefix_padding_ms	integer		لا
└─ silence_duration_ms	integer		لا
└─ عتبة	رقم		لا
└─ النوع	string		لا
النوع	enum	القيم المحتملة: realtime	‏‏نعم‬
صوت	OpenAI.VoiceIdsShared		لا

OpenAI.RealtimeSessionCreateRequestClientSecret

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_at	integer		‏‏نعم‬
القيمة	string		‏‏نعم‬

OpenAI.RealtimeSessionCreateRequestGA

تكوين كائن جلسة العمل في الوقت الحقيقي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
صوتي	OpenAI.RealtimeSessionCreateRequestGAAudio		لا
└─ المدخلات	OpenAI.RealtimeSessionCreateRequestGAAudioInput		لا
└─ الإخراج	OpenAI.RealtimeSessionCreateRequestGAAudioOutput		لا
include	صفيف سلسلة	حقول إضافية يجب تضمينها في مخرجات الخادم. item.input_audio_transcription.logprobs: تضمين logprobs لنقل الصوت المدخل.	لا
تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وصيغتها، (مثل "كن موجزا للغاية"، "تصرف وديا"، "إليك أمثلة على الردود الجيدة") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر في صوتك"، "ضحك كثيرا"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.	لا
max_output_tokens	عدد صحيح (انظر النماذج الصحيحة أدناه)	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحدة، بما في ذلك استدعاءات الأدوات. قدم عددا صحيحا بين 1 و 4096 إلى تحديد رموز الإخراج، أو inf الحد الأقصى المتاح للرموز ل النموذج المعطى. الإعدادات الافتراضية لـ inf.	لا
نموذج	string	النموذج الزمني المستخدم لهذه الجلسة.	لا
output_modalities	صفيف سلسلة	مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. يتم تلقائيا إلى ["audio"]، مما يشير إلى وأن النموذج سيرد بالصوت بالإضافة إلى نص مكتوب. ["text"] يمكن استخدامها لصنع يرد النموذج بالنص فقط. لا يمكن طلب الاثنين textaudio معا في نفس الوقت.	لا	['صوت']
فوري	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceFunction أو OpenAI.ToolChoiceMCP	كيف يختار النموذج الأدوات. قدم أحد أوضاع الوتر أو فرض على وضع معين أداة الدالة/MCP.	لا
الأدوات	مصفوفة من OpenAI.RealtimeFunctionTool أو OpenAI.MCPTool	الأدوات المتاحة للنموذج.	لا
tracing	string أو OpenAI.RealtimeSessionCreateRequestGATracing أو null	"" ضبطه على الصفر لتعطيل التتبع. مرة واحدة يتم تفعيل التتبع للجلسة، ولا يمكن تعديل التكوين. auto سيقوم بإنشاء تتبع للجلسة مع قيم افتراضية ل اسم سير العمل، معرف المجموعة، والبيانات الوصفية.	لا
اقتطاع	OpenAI.RealtimeCutncation	عندما يتجاوز عدد الرموز في المحادثة حد رموز الإدخال في النموذج، يتم اختصار المحادثة، مما يعني أن الرسائل (التي تبدأ من الأقدم) لن تدرج في سياق النموذج. نموذج السياق 32k مع 4,096 رمز إخراج أقصى يمكنه فقط تضمين 28,224 رمزا في السياق قبل حدوث القطع. يمكن للعملاء تكوين سلوك القطع بحيث يتم القطع بحد أقصى أقل للرمز، وهو طريقة فعالة للتحكم في استخدام الرموز وتكلفتها. القطع سيقلل عدد الرموز المخزنة في الدور التالي (مما يؤدي إلى تدمير الكاش)، لأن الرسائل تسقط من بداية السياق. ومع ذلك، يمكن للعملاء أيضا تكوين القطع للاحتفاظ بالرسائل حتى جزء بسيط من الحد الأقصى لحجم السياق، مما يقلل الحاجة إلى القطع المستقبلي وبالتالي يحسن معدل الكاش. يمكن تعطيل القطع تماما، مما يعني أن الخادم لن يقطع أبدا بل سيعيد خطأ إذا تجاوزت المحادثة حد رموز الإدخال في النموذج.	لا
النوع	enum	نوع الجلسة التي يجب إنشاؤها. دائما realtime لواجهة برمجة التطبيقات في الوقت الحقيقي. القيم المحتملة: realtime	‏‏نعم‬

OpenAI.RealtimeSessionCreateRequestGAAudio

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	OpenAI.RealtimeSessionCreateRequestGAAudioInput		لا
الناتج	OpenAI.RealtimeSessionCreateRequestGAAudioOutput		لا

OpenAI.RealtimeSessionCreateRequestGAAudioInput

الاسم	النوع	وصف	مطلوب	الإفتراضي
format	OpenAI.RealtimeAudioFormats		لا
noise_reduction	OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction		لا
النسخ	OpenAI.AudioTranscription		لا
turn_detection	OpenAI.RealtimeTurnDetection		لا

OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.NoiseReductionType	نوع الحد من الضوضاء. near_field للميكروفونات القريبة مثل سماعات الرأس، far_field مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات.	لا

OpenAI.RealtimeSessionCreateRequestGAAudioOutput

الاسم	النوع	وصف	مطلوب	الإفتراضي
format	OpenAI.RealtimeAudioFormats		لا
speed	رقم	القيود: الحد الأدنى: 0.25، الحد الأقصى: 1.5	لا	1
صوت	OpenAI.VoiceIdsShared		لا

OpenAI.RealtimeSessionCreateRequestGATracing

الاسم	النوع	وصف	مطلوب	الإفتراضي
group_id	string		لا
metadata	object		لا
workflow_name	string		لا

OpenAI.RealtimeSessionCreateRequestInputAudioTranscription

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

OpenAI.RealtimeSessionCreateRequestTools

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string		لا
الاسم	string		لا
المعلمات	OpenAI.RealtimeSessionCreateRequestToolsParameters		لا
النوع	enum	القيم المحتملة: function	لا

OpenAI.RealtimeSessionCreateRequestToolsParameters

النوع: كائن

OpenAI.RealtimeSessionCreateRequestTurnDetection

الاسم	النوع	وصف	مطلوب	الإفتراضي
prefix_padding_ms	integer		لا
silence_duration_ms	integer		لا
عتبة	رقم		لا
النوع	string		لا

OpenAI.RealtimeSessionCreateRequestUnion

Discriminator for OpenAI.RealtimeSessionCreateRequestUnion

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

قيمة النوع	Schema
realtime	OpenAI.RealtimeSessionCreateRequest
transcription	OpenAI.RealtimeTranscriptionSessionCreateRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.RealtimeSessionCreateRequestUnionType		‏‏نعم‬

OpenAI.RealtimeSessionCreateRequestUnionType

الخاصية	قيمة
نوع	string
Values	realtime transcription

OpenAI.RealtimeSessionCreateResponse

كائن تكوين جلسة في الوقت الحقيقي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
صوتي	OpenAI.RealtimeSessionCreateResponseAudio		لا
└─ المدخلات	OpenAI.RealtimeSessionإنشاء استجابة صوتية		لا
└─ الإخراج	OpenAI.RealtimeSessionCreateResponseAudioOutput		لا
expires_at	integer	ختم انتهاء الصلاحية للجلسة، بثوان منذ الحقبة.	لا
المعرف	string	معرف فريد للجلسة يبدو ك sess_1234567890abcdef.	لا
include	صفيف سلسلة	حقول إضافية يجب تضمينها في مخرجات الخادم. - item.input_audio_transcription.logprobs: تضمين logprobs لنقل الصوت المدخل.	لا
تعليمات	string	تعليمات النظام الافتراضية (أي رسالة النظام) كانت تسبق النموذج الاتصالات. يتيح هذا الحقل للعميل توجيه النموذج إلى المطلوب ردود. يمكن توجيه النموذج حول محتوى الاستجابة وصيغتها، (مثل "كن موجززا للغاية"، "تصرف ودودا"، "إليك أمثلة على الخير الردود") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر" إلى صوتك"، "تضحك كثيرا"). التعليمات غير مضمونة يتبعها النموذج، لكنها تقدم إرشادات للنموذج على السلوك المرغوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا كان هذا الحقل غير محدد وتكون مرئية في session.created الحدث عند بداية الجلسة.	لا
max_output_tokens	عدد صحيح (انظر النماذج الصحيحة أدناه)	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحدة، بما في ذلك استدعاءات الأدوات. قدم عددا صحيحا بين 1 و 4096 إلى تحديد رموز الإخراج، أو inf الحد الأقصى المتاح للرموز ل النموذج المعطى. الإعدادات الافتراضية لـ inf.	لا
نموذج	string	النموذج الزمني المستخدم لهذه الجلسة.	لا
object	string	نوع الكائن. دائمًا realtime.session.	لا
output_modalities	صفيف سلسلة	مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، اضبط هذا على ["نص"].	لا
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي auto، none، required، أو حدد دالة.	لا
الأدوات	مصفوفة OpenAI.RealtimeFunctionTool	الأدوات (الوظائف) المتوفرة للنموذج.	لا
tracing	سلسلة أو كائن	خيارات التكوين للتتبع. ضبطه على الصفر لتعطيل التتبع. مرة واحدة يتم تفعيل التتبع للجلسة، ولا يمكن تعديل التكوين. auto سيقوم بإنشاء تتبع للجلسة مع قيم افتراضية ل اسم سير العمل، معرف المجموعة، والبيانات الوصفية.	لا
turn_detection	OpenAI.RealtimeSessionCreateResponseTurnDetection		لا
└─ prefix_padding_ms	integer		لا
└─ silence_duration_ms	integer		لا
└─ عتبة	رقم		لا
└─ النوع	string		لا
النوع	enum	القيم المحتملة: realtime	‏‏نعم‬

OpenAI.RealtimeSessionCreateResponseAudio

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	OpenAI.RealtimeSessionإنشاء استجابة صوتية		لا
الناتج	OpenAI.RealtimeSessionCreateResponseAudioOutput		لا

OpenAI.RealtimeSessionإنشاء استجابة صوتية

الاسم	النوع	وصف	مطلوب	الإفتراضي
format	OpenAI.RealtimeAudioFormats		لا
noise_reduction	OpenAI.RealtimeSessionCreateResponseSoundInput Noise Reduction		لا
النسخ	OpenAI.AudioTranscription		لا
turn_detection	OpenAI.RealtimeSessionإنشاء استجابة صوتInput TurnDetection		لا

OpenAI.RealtimeSessionCreateResponseSoundInput Noise Reduction

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.NoiseReductionType	نوع الحد من الضوضاء. near_field للميكروفونات القريبة مثل سماعات الرأس، far_field مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات.	لا

OpenAI.RealtimeSessionإنشاء استجابة صوتInput TurnDetection

الاسم	النوع	وصف	مطلوب	الإفتراضي
prefix_padding_ms	integer		لا
silence_duration_ms	integer		لا
عتبة	رقم		لا
النوع	string		لا

OpenAI.RealtimeSessionCreateResponseAudioOutput

الاسم	النوع	وصف	مطلوب	الإفتراضي
format	OpenAI.RealtimeAudioFormats		لا
speed	رقم		لا
صوت	OpenAI.VoiceIdsShared		لا

OpenAI.RealtimeSessionCreateResponseTurnDetection

الاسم	النوع	وصف	مطلوب	الإفتراضي
prefix_padding_ms	integer		لا
silence_duration_ms	integer		لا
عتبة	رقم		لا
النوع	string		لا

OpenAI.RealtimeSessionCreateResponseUnion

مميز ل OpenAI.RealtimeSessionCreateResponseUnion

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

قيمة النوع	Schema
realtime	OpenAI.RealtimeSessionCreateResponse
transcription	OpenAI.RealtimeTranscriptionSessionCreateResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.RealtimeSessionCreateResponseUnionType		‏‏نعم‬

OpenAI.RealtimeSessionCreateResponseUnionType

الخاصية	قيمة
نوع	string
Values	realtime transcription

OpenAI.RealtimeTranscriptionSessionCreateRequest

تكوين كائن جلسة عمل النسخ في الوقت الحقيقي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
include	صفيف سلسلة	مجموعة العناصر المراد تضمينها في النسخ. العناصر المتوفرة الحالية هي: item.input_audio_transcription.logprobs	لا
input_audio_format	enum	تنسيق صوت الإدخال. الخيارات هي pcm16أو g711_ulawأو g711_alaw. بالنسبة ل pcm16، يجب أن يكون الصوت المدخل PCM 16-بت بمعدل عينة 24 كيلوهرتز، وترتيب بايت القناة الواحدة (أحادي)، وترتيب بايت النهاية الصغيرة. القيم المحتملة: pcm16، ، g711_ulawg711_alaw	لا
input_audio_noise_reduction	OpenAI.RealtimeTranscriptionSessionCreateRequestInput AudioNoiseReduction		لا
└─ النوع	OpenAI.NoiseReductionType	نوع الحد من الضوضاء. near_field للميكروفونات القريبة مثل سماعات الرأس، far_field مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات.	لا
input_audio_transcription	OpenAI.AudioTranscription		لا
└─ اللغة	string	لغة صوت الإدخال. توفير لغة الإدخال في تنسيق ISO-639-1 (مثل en) سيحسن الدقة والتأخير.	لا
└─ نموذج	string	النموذج الذي يجب استخدامه للنسخ. الخيارات الحالية هي whisper-1، gpt-4o-mini-transcribe، gpt-4o-mini-transcribe-2025-12-15، gpt-4o-transcribe، و gpt-4o-transcribe-diarize. استخدمها gpt-4o-transcribe-diarize عندما تحتاج إلى توثيق مع تسميات السماعات.	لا
└─ موجه	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار صوت سابق القطاع. ل whisper-1، الموضوع هو قائمة بالكلمات المفتاحية. بالنسبة للنماذج gpt-4o-transcribe (باستثناء gpt-4o-transcribe-diarizeالنماذج )، فإن التوجيه هو سلسلة نصية حرة، مثل "توقع كلمات متعلقة بالتكنولوجيا".	لا
turn_detection	OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection		لا
└─ prefix_padding_ms	integer		لا
└─ silence_duration_ms	integer		لا
└─ عتبة	رقم		لا
└─ النوع	enum	القيم المحتملة: server_vad	لا
النوع	enum	القيم المحتملة: transcription	‏‏نعم‬

OpenAI.RealtimeTranscriptionSessionCreateRequestInput AudioNoiseReduction

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.NoiseReductionType	نوع الحد من الضوضاء. near_field للميكروفونات القريبة مثل سماعات الرأس، far_field مخصصة للميكروفونات البعيدة الحقول مثل الكمبيوتر المحمول أو ميكروفونات غرفة المؤتمرات.	لا

OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection

الاسم	النوع	وصف	مطلوب	الإفتراضي
prefix_padding_ms	integer		لا
silence_duration_ms	integer		لا
عتبة	رقم		لا
النوع	enum	القيم المحتملة: server_vad	لا

OpenAI.RealtimeTranscriptionSessionCreateResponse

تكوين جديد لجلسة عمل النسخ في الوقت الحقيقي. عند إنشاء جلسة عمل على الخادم عبر واجهة برمجة تطبيقات REST، يحتوي كائن جلسة العمل أيضا على مفتاح سريع الزوال. مدة TTL الافتراضية للمفاتيح هي 10 دقائق. هذه الخاصية غير موجودة عند تحديث الجلسة عبر واجهة برمجة تطبيقات WebSocket.

الاسم	النوع	وصف	مطلوب	الإفتراضي
client_secret	OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret		‏‏نعم‬
└─ expires_at	integer		‏‏نعم‬
└─ القيمة	string		‏‏نعم‬
input_audio_format	string	تنسيق صوت الإدخال. الخيارات هي pcm16أو g711_ulawأو g711_alaw.	لا
input_audio_transcription	OpenAI.AudioTranscription		لا
└─ اللغة	string	لغة صوت الإدخال. توفير لغة الإدخال في تنسيق ISO-639-1 (مثل en) سيحسن الدقة والتأخير.	لا
└─ نموذج	string	النموذج الذي يجب استخدامه للنسخ. الخيارات الحالية هي whisper-1، gpt-4o-mini-transcribe، gpt-4o-mini-transcribe-2025-12-15، gpt-4o-transcribe، و gpt-4o-transcribe-diarize. استخدمها gpt-4o-transcribe-diarize عندما تحتاج إلى توثيق مع تسميات السماعات.	لا
└─ موجه	string	نص اختياري لتوجيه أسلوب النموذج أو استمرار صوت سابق القطاع. ل whisper-1، الموضوع هو قائمة بالكلمات المفتاحية. بالنسبة للنماذج gpt-4o-transcribe (باستثناء gpt-4o-transcribe-diarizeالنماذج )، فإن التوجيه هو سلسلة نصية حرة، مثل "توقع كلمات متعلقة بالتكنولوجيا".	لا
طرائق	صفيف سلسلة	مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، اضبط هذا على ["نص"].	لا
turn_detection	OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection		لا
└─ prefix_padding_ms	integer		لا
└─ silence_duration_ms	integer		لا
└─ عتبة	رقم		لا
└─ النوع	string		لا
النوع	enum	القيم المحتملة: transcription	‏‏نعم‬

OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_at	integer		‏‏نعم‬
القيمة	string		‏‏نعم‬

OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection

الاسم	النوع	وصف	مطلوب	الإفتراضي
prefix_padding_ms	integer		لا
silence_duration_ms	integer		لا
عتبة	رقم		لا
النوع	string		لا

OpenAI.RealtimeCutncation

عندما يتجاوز عدد الرموز في المحادثة حد رموز الإدخال في النموذج، يتم اختصار المحادثة، مما يعني أن الرسائل (التي تبدأ من الأقدم) لن تدرج في سياق النموذج. نموذج السياق 32k مع 4,096 رمز إخراج أقصى يمكنه فقط تضمين 28,224 رمزا في السياق قبل حدوث القطع. يمكن للعملاء تكوين سلوك القطع بحيث يتم القطع بحد أقصى أقل للرمز، وهو طريقة فعالة للتحكم في استخدام الرموز وتكلفتها. القطع سيقلل عدد الرموز المخزنة في الدور التالي (مما يؤدي إلى تدمير الكاش)، لأن الرسائل تسقط من بداية السياق. ومع ذلك، يمكن للعملاء أيضا تكوين القطع للاحتفاظ بالرسائل حتى جزء بسيط من الحد الأقصى لحجم السياق، مما يقلل الحاجة إلى القطع المستقبلي وبالتالي يحسن معدل الكاش. يمكن تعطيل القطع تماما، مما يعني أن الخادم لن يقطع أبدا بل سيعيد خطأ إذا تجاوزت المحادثة حد رموز الإدخال في النموذج.

الخاصية	قيمة
نوع	string
Values	auto disabled

OpenAI.RealtimeTurnDetection

المميز ل OpenAI.RealtimeTurnDetection

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

قيمة النوع	Schema

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.RealtimeTurnDetectionType		‏‏نعم‬

OpenAI.RealtimeTurnDetectionType

النوع: سلسلة

OpenAI.المنطق

نماذج GPT-5 وO-Series فقط خيارات التكوين لنماذج التفكير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
جهد	OpenAI.ReasoningEffort	تقييد الجهود المبذولة في التفكير نماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. الحد يمكن أن يؤدي جهد المنطق إلى استجابات أسرع والرموز المميزة المستخدمة أقل على المنطق في استجابة. - gpt-5.1 افتراضيات إلى none، والتي لا تقوم بإجراء المنطق. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. - جميع النماذج قبل gpt-5.1 الافتراضية للجهد medium المنطقي، ولا تدعم none. gpt-5-pro- يتم تعيين النموذج افتراضيا إلى (ويدعم فقط) high الجهد المنطقي. - xhigh معتمد لجميع النماذج بعد gpt-5.1-codex-max.	لا
generate_summary	سلسلة أو قيمة خالية		لا
الملخص.	سلسلة أو قيمة خالية		لا

OpenAI.ReasoningEffort

تقييد الجهد المبذول في التفكير لنماذج التفكير. القيم المدعومة حاليا هي none، minimal، low، medium، high، و xhigh. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة.

• gpt-5.1 يقيم افتراضيا على none، وهو لا يؤدي التفكير. قيم الاستدلالية المدعومة ل gpt-5.1 هي none، low، medium، و high. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1.
• جميع النماذج سابقا gpt-5.1 تعتمد medium بشكل افتراضي على جهد التفكير، ولا تدعم none.
• gpt-5-pro النموذج يعتمد بشكل افتراضي (ويدعم فقط) high جهد التفكير المنطقي.
• xhigh مدعوم لجميع النماذج بعد gpt-5.1-codex-max.

الخاصية	قيمة
نوع	string
Values	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

نص استدلالي من النموذج.

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

OpenAI.RefusalContent

رفض من النموذج.

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

OpenAI.الاستجابة

الاسم	النوع	وصف	مطلوب	الإفتراضي
background	بوليان أو نول		لا
completed_at	سلسلة أو قيمة خالية		لا
content_filters	مصفوفة من AzureContentFilterForResponsesAPI	تصفية المحتوى تنتج عن RAI.	‏‏نعم‬
حوار	OpenAI.ConversationReference أو null		لا
created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	‏‏نعم‬
خطأ	OpenAI.ResponseError أو null		‏‏نعم‬
المعرف	string	معرف فريد لهذه الاستجابة.	‏‏نعم‬
incomplete_details	OpenAI.ResponseIncompleteDetails أو null		‏‏نعم‬
تعليمات	نص أو مصفوفة من OpenAI.InputItem أو null		‏‏نعم‬
max_output_tokens	عدد صحيح أو صفري		لا
max_tool_calls	عدد صحيح أو صفري		لا
metadata	OpenAI.Metadata أو null		لا
نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	لا
object	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	‏‏نعم‬
الناتج	صفيف OpenAI.OutputItem	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	‏‏نعم‬
output_text	سلسلة أو قيمة خالية		لا
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	‏‏نعم‬	صحيح
previous_response_id	سلسلة أو قيمة خالية		لا
فوري	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
prompt_cache_retention	سلسلة أو قيمة خالية		لا
المنطق	OpenAI.Reasoning أو null		لا
safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
درجة الحرارة	عدد أو صفرا		لا
نص	OpenAI.ResponseTextParam	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
tool_choice	OpenAI.ToolChoiceParam	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
الأدوات	OpenAI.ToolsArray	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . ندعم الفئات التالية من الأدوات: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. معرفة المزيد حول الأدوات المضمنة. - أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو موصلات معرفة مسبقا مثل Google Drive وSharePoint. معرفة المزيد حول أدوات MCP. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك باستخدام وسيطات مكتوبة بقوة والمخرجات. معرفة المزيد حول استدعاء الدالة. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.	لا
top_logprobs	عدد صحيح أو صفري		لا
top_p	عدد أو صفرا		لا
اقتطاع	سلسلة أو قيمة خالية		لا
استخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
user	سلسلة (مهملة)	يتم استبدال هذا الحقل ب safety_identifier و prompt_cache_key. استخدم prompt_cache_key بدلا من ذلك للحفاظ على تحسينات التخزين المؤقت. معرف ثابت للمستخدمين النهائيين. يستخدم لزيادة معدلات الوصول إلى ذاكرة التخزين المؤقت عن طريق تجميع الطلبات المماثلة بشكل أفضل ولمساعدة OpenAI في اكتشاف إساءة الاستخدام ومنعها. تعرّف على المزيد.	لا

OpenAI.ResponseAudioDeltaEvent

يتم إصداره عند وجود استجابة صوتية جزئية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	مجموعة من وحدات البايت الصوتية للاستجابة المرمزة Base64.	‏‏نعم‬
sequence_number	integer	رقم تسلسل لهذا الجزء من استجابة التدفق.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.audio.delta. القيم المحتملة: response.audio.delta	‏‏نعم‬

OpenAI.ResponseAudioTranscriptDeltaEvent

يصدر عندما يكون هناك نسخة جزئية من الصوت.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	النسخة الجزئية للاستجابة الصوتية.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.audio.transcript.delta. القيم المحتملة: response.audio.transcript.delta	‏‏نعم‬

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

يتم انبعاثه عند دفق مقتطف رمز جزئي بواسطة مترجم التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	مقتطف التعليمات البرمجية الجزئي الذي يتم دفقه بواسطة مترجم التعليمات البرمجية.	‏‏نعم‬
item_id	string	المعرف الفريد لعنصر استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في الاستجابة التي يتم دفق التعليمات البرمجية لها.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث يستخدم لترتيب أحداث البث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.code_interpreter_call_code.delta. القيم المحتملة: response.code_interpreter_call_code.delta	‏‏نعم‬

OpenAI.ResponseCodeInterpreterCallInProgressEvent

تنبعث عندما تكون استدعاء مترجم التعليمات البرمجية قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في الاستجابة التي يكون استدعاء مترجم التعليمات البرمجية قيد التقدم.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث يستخدم لترتيب أحداث البث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.code_interpreter_call.in_progress. القيم المحتملة: response.code_interpreter_call.in_progress	‏‏نعم‬

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

ينبعث عندما يقوم مترجم التعليمات البرمجية بتفسير مقتطف التعليمات البرمجية بنشاط.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في الاستجابة التي يقوم مترجم التعليمات البرمجية بتفسير التعليمات البرمجية لها.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث يستخدم لترتيب أحداث البث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.code_interpreter_call.interpreting. القيم المحتملة: response.code_interpreter_call.interpreting	‏‏نعم‬

OpenAI.ResponseContentPartAddedEvent

تنبعث عند إضافة جزء محتوى جديد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
جزء	OpenAI.OutputContent		‏‏نعم‬
└─ النوع	OpenAI.OutputContentType		‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.content_part.added. القيم المحتملة: response.content_part.added	‏‏نعم‬

OpenAI.ResponseCreatedEvent

حدث ينبعث عند إنشاء استجابة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	OpenAI.Response		‏‏نعم‬
└─ خلفية	بوليان أو نول		لا
└─ completed_at	سلسلة أو قيمة خالية		لا
└─ content_filters	مصفوفة من AzureContentFilterForResponsesAPI	تصفية المحتوى تنتج عن RAI.	‏‏نعم‬
└─ محادثة	OpenAI.ConversationReference أو null		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	‏‏نعم‬
└─ خطأ	OpenAI.ResponseError أو null		‏‏نعم‬
└─ الهوية	string	معرف فريد لهذه الاستجابة.	‏‏نعم‬
└─ incomplete_details	OpenAI.ResponseIncompleteDetails أو null		‏‏نعم‬
└─ تعليمات	نص أو مصفوفة من OpenAI.InputItem أو null		‏‏نعم‬
└─ max_output_tokens	عدد صحيح أو صفري		لا
└─ max_tool_calls	عدد صحيح أو صفري		لا
└─ البيانات الوصفية	OpenAI.Metadata أو null		لا
└─ نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	‏‏نعم‬
└─ الإخراج	صفيف OpenAI.OutputItem	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	‏‏نعم‬
└─ output_text	سلسلة أو قيمة خالية		لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	‏‏نعم‬	صحيح
└─ previous_response_id	سلسلة أو قيمة خالية		لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
└─ prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
└─ prompt_cache_retention	سلسلة أو قيمة خالية		لا
└─ التفكير	OpenAI.Reasoning أو null		لا
└─ safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ درجة الحرارة	عدد أو صفرا		لا	1
└─ نص	OpenAI.ResponseTextParam	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ tool_choice	OpenAI.ToolChoiceParam	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	OpenAI.ToolsArray	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . ندعم الفئات التالية من الأدوات: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. معرفة المزيد حول الأدوات المضمنة. - أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو موصلات معرفة مسبقا مثل Google Drive وSharePoint. معرفة المزيد حول أدوات MCP. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك باستخدام وسيطات مكتوبة بقوة والمخرجات. معرفة المزيد حول استدعاء الدالة. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.	لا
└─ top_logprobs	عدد صحيح أو صفري		لا
└─ top_p	عدد أو صفرا		لا	1
└─ الاقتطاع	سلسلة أو قيمة خالية		لا	معطل
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	سلسلة (مهملة)	يتم استبدال هذا الحقل ب safety_identifier و prompt_cache_key. استخدم prompt_cache_key بدلا من ذلك للحفاظ على تحسينات التخزين المؤقت. معرف ثابت للمستخدمين النهائيين. يستخدم لزيادة معدلات الوصول إلى ذاكرة التخزين المؤقت عن طريق تجميع الطلبات المماثلة بشكل أفضل ولمساعدة OpenAI في اكتشاف إساءة الاستخدام ومنعها. تعرّف على المزيد.	لا
sequence_number	integer	رقم التسلسل لهذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.created. القيم المحتملة: response.created	‏‏نعم‬

OpenAI.ResponseCustomToolCallInputDeltaEvent

حدث يمثل دلتا (تحديث جزئي) لإدخال استدعاء أداة مخصصة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	بيانات الإدخال التزايدية (delta) لاستدعاء الأداة المخصصة.	‏‏نعم‬
item_id	string	معرف فريد لعنصر واجهة برمجة التطبيقات المقترن بهذا الحدث.	‏‏نعم‬
output_index	integer	مؤشر الناتج الذي تنطبق عليه هذه الدلتا.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	معرف نوع الحدث. القيم المحتملة: response.custom_tool_call_input.delta	‏‏نعم‬

OpenAI.ResponseError

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	OpenAI.ResponseErrorCode	رمز الخطأ للاستجابة.	‏‏نعم‬
رسالة	string	وصف يمكن للإنسان قراءته للخطأ.	‏‏نعم‬

OpenAI.ResponseErrorCode

رمز الخطأ للاستجابة.

الخاصية	قيمة
نوع	string
Values	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

OpenAI.ResponseErrorEvent

تنبعث عند حدوث خطأ.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	سلسلة أو قيمة خالية		‏‏نعم‬
رسالة	string	رسالة الخطأ.	‏‏نعم‬
بارام	سلسلة أو قيمة خالية		‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا error. القيم المحتملة: error	‏‏نعم‬

OpenAI.ResponseFailedEvent

حدث ينبعث عند فشل الاستجابة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	OpenAI.Response		‏‏نعم‬
└─ خلفية	بوليان أو نول		لا
└─ completed_at	سلسلة أو قيمة خالية		لا
└─ content_filters	مصفوفة من AzureContentFilterForResponsesAPI	تصفية المحتوى تنتج عن RAI.	‏‏نعم‬
└─ محادثة	OpenAI.ConversationReference أو null		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	‏‏نعم‬
└─ خطأ	OpenAI.ResponseError أو null		‏‏نعم‬
└─ الهوية	string	معرف فريد لهذه الاستجابة.	‏‏نعم‬
└─ incomplete_details	OpenAI.ResponseIncompleteDetails أو null		‏‏نعم‬
└─ تعليمات	نص أو مصفوفة من OpenAI.InputItem أو null		‏‏نعم‬
└─ max_output_tokens	عدد صحيح أو صفري		لا
└─ max_tool_calls	عدد صحيح أو صفري		لا
└─ البيانات الوصفية	OpenAI.Metadata أو null		لا
└─ نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	‏‏نعم‬
└─ الإخراج	صفيف OpenAI.OutputItem	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	‏‏نعم‬
└─ output_text	سلسلة أو قيمة خالية		لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	‏‏نعم‬	صحيح
└─ previous_response_id	سلسلة أو قيمة خالية		لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
└─ prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
└─ prompt_cache_retention	سلسلة أو قيمة خالية		لا
└─ التفكير	OpenAI.Reasoning أو null		لا
└─ safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ درجة الحرارة	عدد أو صفرا		لا	1
└─ نص	OpenAI.ResponseTextParam	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ tool_choice	OpenAI.ToolChoiceParam	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	OpenAI.ToolsArray	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . ندعم الفئات التالية من الأدوات: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. معرفة المزيد حول الأدوات المضمنة. - أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو موصلات معرفة مسبقا مثل Google Drive وSharePoint. معرفة المزيد حول أدوات MCP. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك باستخدام وسيطات مكتوبة بقوة والمخرجات. معرفة المزيد حول استدعاء الدالة. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.	لا
└─ top_logprobs	عدد صحيح أو صفري		لا
└─ top_p	عدد أو صفرا		لا	1
└─ الاقتطاع	سلسلة أو قيمة خالية		لا	معطل
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	سلسلة (مهملة)	يتم استبدال هذا الحقل ب safety_identifier و prompt_cache_key. استخدم prompt_cache_key بدلا من ذلك للحفاظ على تحسينات التخزين المؤقت. معرف ثابت للمستخدمين النهائيين. يستخدم لزيادة معدلات الوصول إلى ذاكرة التخزين المؤقت عن طريق تجميع الطلبات المماثلة بشكل أفضل ولمساعدة OpenAI في اكتشاف إساءة الاستخدام ومنعها. تعرّف على المزيد.	لا
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.failed. القيم المحتملة: response.failed	‏‏نعم‬

OpenAI.ResponseFileSearchCallInProgressEvent

تنبعث عند بدء استدعاء البحث عن ملف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يتم بدء استدعاء البحث في الملف.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.file_search_call.in_progress. القيم المحتملة: response.file_search_call.in_progress	‏‏نعم‬

OpenAI.ResponseFileSearchCallSearchingEvent

ينبعث عند البحث عن ملف حاليا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تبحث عنه مكالمة البحث في الملف.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.file_search_call.searching. القيم المحتملة: response.file_search_call.searching	‏‏نعم‬

OpenAI.ResponseFormatJsonObject

تنسيق استجابة كائن JSON. طريقة قديمة لإنشاء استجابات JSON. يوصى باستخدام json_schema للنماذج التي تدعمه. لاحظ أن النموذج لن ينشئ JSON بدون رسالة نظام أو مستخدم ترشده إلى القيام بذلك.

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

OpenAI.ResponseFormatJsonSchema

تنسيق استجابة مخطط JSON. يستخدم لإنشاء استجابات JSON منظمة. تعرف على مزيد من المعلومات عن المخرجات المنظمة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		‏‏نعم‬
└─ الوصف	string		لا
└─ الاسم	string		‏‏نعم‬
└─ مخطط	OpenAI.ResponseFormatJsonSchemaSchema	مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON. تعرف على كيفية إنشاء مخططات JSON هنا.	لا
└─ صارم	بوليان أو نول		لا
النوع	enum	نوع تنسيق الاستجابة الذي يتم تعريفه. دائمًا json_schema. القيم المحتملة: json_schema	‏‏نعم‬

OpenAI.ResponseFormatJsonSchemaJsonSchema

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string		لا
الاسم	string		‏‏نعم‬
Schema	OpenAI.ResponseFormatJsonSchemaSchema	مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON. تعرف على كيفية إنشاء مخططات JSON هنا.	لا
صارم	بوليان أو نول		لا

OpenAI.ResponseFormatJsonSchemaSchema

مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON. تعرف على كيفية إنشاء مخططات JSON هنا.

النوع: كائن

OpenAI.ResponseFormatText

تنسيق الاستجابة الافتراضي. يستخدم لإنشاء استجابات نصية.

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

تنبعث عندما يكون هناك دلتا جزئية لاستدعاء الدالة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	وسيطات استدعاء الدالة دلتا التي تمت إضافتها.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة دلتا وسيطات استدعاء الدالة إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تتم إضافة وسيطات استدعاء الدالة إليه.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.function_call_arguments.delta. القيم المحتملة: response.function_call_arguments.delta	‏‏نعم‬

OpenAI.ResponseImageGenCallGeneratingEvent

تنبعث عندما يقوم استدعاء أداة إنشاء صورة بإنشاء صورة بنشاط (الحالة الوسيطة).

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر إنشاء الصورة الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
sequence_number	integer	رقم التسلسل لعنصر توليد الصورة الذي يتم معالجته.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.image_generation_call.generating". القيم المحتملة: response.image_generation_call.generating	‏‏نعم‬

OpenAI.ResponseImageGenCallInProgressEvent

تنبعث عندما يكون استدعاء أداة إنشاء الصور قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر إنشاء الصورة الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
sequence_number	integer	رقم التسلسل لعنصر توليد الصورة الذي يتم معالجته.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.image_generation_call.in_progress". القيم المحتملة: response.image_generation_call.in_progress	‏‏نعم‬

OpenAI.ResponseImageGenCallPartialImageEvent

تنبعث عند توفر صورة جزئية أثناء دفق إنشاء الصور.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر إنشاء الصورة الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
partial_image_b64	string	بيانات الصورة الجزئية المشفرة Base64 ، مناسبة للعرض كصورة.	‏‏نعم‬
partial_image_index	integer	فهرس يستند إلى 0 للصورة الجزئية (تستند الواجهة الخلفية إلى 1، ولكن هذا يستند إلى 0 للمستخدم).	‏‏نعم‬
sequence_number	integer	رقم التسلسل لعنصر توليد الصورة الذي يتم معالجته.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.image_generation_call.partial_image". القيم المحتملة: response.image_generation_call.partial_image	‏‏نعم‬

OpenAI.ResponseInProgressEvent

تنبعث عندما تكون الاستجابة قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	OpenAI.Response		‏‏نعم‬
└─ خلفية	بوليان أو نول		لا
└─ completed_at	سلسلة أو قيمة خالية		لا
└─ content_filters	مصفوفة من AzureContentFilterForResponsesAPI	تصفية المحتوى تنتج عن RAI.	‏‏نعم‬
└─ محادثة	OpenAI.ConversationReference أو null		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	‏‏نعم‬
└─ خطأ	OpenAI.ResponseError أو null		‏‏نعم‬
└─ الهوية	string	معرف فريد لهذه الاستجابة.	‏‏نعم‬
└─ incomplete_details	OpenAI.ResponseIncompleteDetails أو null		‏‏نعم‬
└─ تعليمات	نص أو مصفوفة من OpenAI.InputItem أو null		‏‏نعم‬
└─ max_output_tokens	عدد صحيح أو صفري		لا
└─ max_tool_calls	عدد صحيح أو صفري		لا
└─ البيانات الوصفية	OpenAI.Metadata أو null		لا
└─ نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	‏‏نعم‬
└─ الإخراج	صفيف OpenAI.OutputItem	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	‏‏نعم‬
└─ output_text	سلسلة أو قيمة خالية		لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	‏‏نعم‬	صحيح
└─ previous_response_id	سلسلة أو قيمة خالية		لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
└─ prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
└─ prompt_cache_retention	سلسلة أو قيمة خالية		لا
└─ التفكير	OpenAI.Reasoning أو null		لا
└─ safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ درجة الحرارة	عدد أو صفرا		لا	1
└─ نص	OpenAI.ResponseTextParam	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ tool_choice	OpenAI.ToolChoiceParam	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	OpenAI.ToolsArray	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . ندعم الفئات التالية من الأدوات: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. معرفة المزيد حول الأدوات المضمنة. - أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو موصلات معرفة مسبقا مثل Google Drive وSharePoint. معرفة المزيد حول أدوات MCP. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك باستخدام وسيطات مكتوبة بقوة والمخرجات. معرفة المزيد حول استدعاء الدالة. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.	لا
└─ top_logprobs	عدد صحيح أو صفري		لا
└─ top_p	عدد أو صفرا		لا	1
└─ الاقتطاع	سلسلة أو قيمة خالية		لا	معطل
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	سلسلة (مهملة)	يتم استبدال هذا الحقل ب safety_identifier و prompt_cache_key. استخدم prompt_cache_key بدلا من ذلك للحفاظ على تحسينات التخزين المؤقت. معرف ثابت للمستخدمين النهائيين. يستخدم لزيادة معدلات الوصول إلى ذاكرة التخزين المؤقت عن طريق تجميع الطلبات المماثلة بشكل أفضل ولمساعدة OpenAI في اكتشاف إساءة الاستخدام ومنعها. تعرّف على المزيد.	لا
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.in_progress. القيم المحتملة: response.in_progress	‏‏نعم‬

OpenAI.ResponseIncompleteDetails

الاسم	النوع	وصف	مطلوب	الإفتراضي
السبب	enum	القيم المحتملة: max_output_tokens، content_filter	لا

OpenAI.ResponseIncompleteEvent

حدث ينبعث عند انتهاء الاستجابة على أنها غير مكتملة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	OpenAI.Response		‏‏نعم‬
└─ خلفية	بوليان أو نول		لا
└─ completed_at	سلسلة أو قيمة خالية		لا
└─ content_filters	مصفوفة من AzureContentFilterForResponsesAPI	تصفية المحتوى تنتج عن RAI.	‏‏نعم‬
└─ محادثة	OpenAI.ConversationReference أو null		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	‏‏نعم‬
└─ خطأ	OpenAI.ResponseError أو null		‏‏نعم‬
└─ الهوية	string	معرف فريد لهذه الاستجابة.	‏‏نعم‬
└─ incomplete_details	OpenAI.ResponseIncompleteDetails أو null		‏‏نعم‬
└─ تعليمات	نص أو مصفوفة من OpenAI.InputItem أو null		‏‏نعم‬
└─ max_output_tokens	عدد صحيح أو صفري		لا
└─ max_tool_calls	عدد صحيح أو صفري		لا
└─ البيانات الوصفية	OpenAI.Metadata أو null		لا
└─ نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	‏‏نعم‬
└─ الإخراج	صفيف OpenAI.OutputItem	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	‏‏نعم‬
└─ output_text	سلسلة أو قيمة خالية		لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	‏‏نعم‬	صحيح
└─ previous_response_id	سلسلة أو قيمة خالية		لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
└─ prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
└─ prompt_cache_retention	سلسلة أو قيمة خالية		لا
└─ التفكير	OpenAI.Reasoning أو null		لا
└─ safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ درجة الحرارة	عدد أو صفرا		لا	1
└─ نص	OpenAI.ResponseTextParam	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ tool_choice	OpenAI.ToolChoiceParam	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	OpenAI.ToolsArray	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . ندعم الفئات التالية من الأدوات: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. معرفة المزيد حول الأدوات المضمنة. - أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو موصلات معرفة مسبقا مثل Google Drive وSharePoint. معرفة المزيد حول أدوات MCP. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك باستخدام وسيطات مكتوبة بقوة والمخرجات. معرفة المزيد حول استدعاء الدالة. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.	لا
└─ top_logprobs	عدد صحيح أو صفري		لا
└─ top_p	عدد أو صفرا		لا	1
└─ الاقتطاع	سلسلة أو قيمة خالية		لا	معطل
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	سلسلة (مهملة)	يتم استبدال هذا الحقل ب safety_identifier و prompt_cache_key. استخدم prompt_cache_key بدلا من ذلك للحفاظ على تحسينات التخزين المؤقت. معرف ثابت للمستخدمين النهائيين. يستخدم لزيادة معدلات الوصول إلى ذاكرة التخزين المؤقت عن طريق تجميع الطلبات المماثلة بشكل أفضل ولمساعدة OpenAI في اكتشاف إساءة الاستخدام ومنعها. تعرّف على المزيد.	لا
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.incomplete. القيم المحتملة: response.incomplete	‏‏نعم‬

OpenAI.ResponseItemList

قائمة بعناصر الاستجابة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة من OpenAI.ItemResource	قائمة بالعناصر المستخدمة لإنشاء هذه الاستجابة.	‏‏نعم‬
first_id	string	معرف العنصر الأول في القائمة.	‏‏نعم‬
has_more	boolean	ما إذا كان هناك المزيد من العناصر المتاحة.	‏‏نعم‬
last_id	string	معرف العنصر الأخير في القائمة.	‏‏نعم‬
object	enum	يجب أن يكون listنوع الكائن الذي تم إرجاعه . القيم المحتملة: list	‏‏نعم‬

OpenAI.ResponseLogProb

logprob هو الاحتمال اللوغاريتمي الذي يعينه النموذج لإنتاج رمز مميز معين في موضع معين في التسلسل. تشير قيم logprob الأقل سلبية (أعلى) إلى ثقة أكبر في النموذج في اختيار الرمز المميز هذا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
لوغاربوب	رقم	احتمال السجل لهذا الرمز المميز.	‏‏نعم‬
الرمز المميز	string	رمز نصي محتمل.	‏‏نعم‬
top_logprobs	صفيف OpenAI.ResponseLogProbTopLogprobs	احتمال السجل لأعلى 20 رمزا مميزا على الأرجح.	لا

OpenAI.ResponseLogProbTopLogprobs

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

OpenAI.ResponseMCPCallArgumentsDeltaEvent

تنبعث عند وجود دلتا (تحديث جزئي) لوسيطات استدعاء أداة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	سلسلة JSON تحتوي على التحديث الجزئي للوسيطات لاستدعاء أداة MCP.	‏‏نعم‬
item_id	string	المعرف الفريد لعنصر استدعاء أداة MCP الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما 'response.mcp_call_arguments.delta'. القيم المحتملة: response.mcp_call_arguments.delta	‏‏نعم‬

OpenAI.ResponseMCPCallFailedEvent

تنبعث عند فشل استدعاء أداة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف عنصر استدعاء أداة MCP الذي فشل.	‏‏نعم‬
output_index	integer	فهرس العنصر الناتج الذي فشل.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.mcp_call.failed". القيم المحتملة: response.mcp_call.failed	‏‏نعم‬

OpenAI.ResponseMCPCallInProgressEvent

تنبعث عندما يكون استدعاء أداة MCP قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر استدعاء أداة MCP الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.mcp_call.in_progress". القيم المحتملة: response.mcp_call.in_progress	‏‏نعم‬

OpenAI.ResponseMCPListToolsFailedEvent

تنبعث عند فشل محاولة إدراج أدوات MCP المتاحة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف عنصر استدعاء أداة MCP الذي فشل.	‏‏نعم‬
output_index	integer	فهرس العنصر الناتج الذي فشل.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.mcp_list_tools.failed". القيم المحتملة: response.mcp_list_tools.failed	‏‏نعم‬

OpenAI.ResponseMCPListToolsInProgressEvent

تنبعث عندما يكون النظام بصدد استرداد قائمة أدوات MCP المتاحة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف عنصر استدعاء أداة MCP الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس العنصر الناتج الذي يتم معالجته.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.mcp_list_tools.in_progress". القيم المحتملة: response.mcp_list_tools.in_progress	‏‏نعم‬

OpenAI.ResponseModalities

أنواع الإخراج التي ترغب في أن ينشئها النموذج. معظم النماذج قادرة على توليد نص، وهو الوضع الافتراضي: ["text"] يمكن أيضا استخدام النموذج gpt-4o-audio-previewلتوليد الصوت. لطلب أن يولد هذا النموذج ردودا نصية وصوتية، يمكنك استخدام: ["text", "audio"]

يقبل هذا المخطط أحد الأنواع التالية:

• صفيف
• null

OpenAI.ResponseOutputItemAddedEvent

تنبعث عند إضافة عنصر إخراج جديد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
عنصر	OpenAI.OutputItem		‏‏نعم‬
└─ النوع	OpenAI.OutputItemType		‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافته.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.output_item.added. القيم المحتملة: response.output_item.added	‏‏نعم‬

OpenAI.ResponseOutputTextAnnotationAddedEvent

يتم إصداره عند إضافة تعليق توضيحي إلى محتوى نص الإخراج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotation	OpenAI.Annotation	تعليق توضيحي ينطبق على نطاق من نص الإخراج.	‏‏نعم‬
└─ النوع	OpenAI.AnnotationType		‏‏نعم‬
annotation_index	integer	فهرس التعليق داخل جزء المحتوى.	‏‏نعم‬
content_index	integer	فهرس جزء المحتوى داخل عنصر الإخراج.	‏‏نعم‬
item_id	string	المعرف الفريد للعنصر الذي تتم إضافة التعليق التوضيحي إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما 'response.output_text.annotation.added'. القيم المحتملة: response.output_text.annotation.added	‏‏نعم‬

OpenAI.ResponsePromptVariables

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

النوع: كائن

OpenAI.ResponseQueuedEvent

تنبعث عند وضع استجابة في قائمة الانتظار وتنتظر المعالجة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	OpenAI.Response		‏‏نعم‬
└─ خلفية	بوليان أو نول		لا
└─ completed_at	سلسلة أو قيمة خالية		لا
└─ content_filters	مصفوفة من AzureContentFilterForResponsesAPI	تصفية المحتوى تنتج عن RAI.	‏‏نعم‬
└─ محادثة	OpenAI.ConversationReference أو null		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	‏‏نعم‬
└─ خطأ	OpenAI.ResponseError أو null		‏‏نعم‬
└─ الهوية	string	معرف فريد لهذه الاستجابة.	‏‏نعم‬
└─ incomplete_details	OpenAI.ResponseIncompleteDetails أو null		‏‏نعم‬
└─ تعليمات	نص أو مصفوفة من OpenAI.InputItem أو null		‏‏نعم‬
└─ max_output_tokens	عدد صحيح أو صفري		لا
└─ max_tool_calls	عدد صحيح أو صفري		لا
└─ البيانات الوصفية	OpenAI.Metadata أو null		لا
└─ نموذج	string	معرف النموذج المستخدم لإنشاء الاستجابة، مثل gpt-4o أو o3. OpenAI يقدم مجموعة واسعة من النماذج بقدرات وأداء مختلفة الخصائص ونقاط الأسعار. راجع دليل النماذج لتصفح ومقارنة النماذج المتاحة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	‏‏نعم‬
└─ الإخراج	صفيف OpenAI.OutputItem	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	‏‏نعم‬
└─ output_text	سلسلة أو قيمة خالية		لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	‏‏نعم‬	صحيح
└─ previous_response_id	سلسلة أو قيمة خالية		لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرّف على المزيد.	لا
└─ prompt_cache_key	string	يستخدمه OpenAI لتخزين الاستجابات مؤقتا لطلبات مماثلة لتحسين معدلات الوصول إلى ذاكرة التخزين المؤقت. استبدال user الحقل. تعرّف على المزيد.	لا
└─ prompt_cache_retention	سلسلة أو قيمة خالية		لا
└─ التفكير	OpenAI.Reasoning أو null		لا
└─ safety_identifier	string	معرف ثابت يستخدم للمساعدة في اكتشاف مستخدمي التطبيق الخاص بك الذين قد ينتهكون نهج استخدام OpenAI. يجب أن تكون المعرفات سلسلة تعرف كل مستخدم بشكل فريد. نوصي بتجزئة اسم المستخدم أو عنوان البريد الإلكتروني الخاص بهم، لتجنب إرسال أي معلومات تعريف إلينا. تعرّف على المزيد.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ درجة الحرارة	عدد أو صفرا		لا	1
└─ نص	OpenAI.ResponseTextParam	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. اعرف المزيد‬: - مدخلات ومخرجات النص - المخرجات المنظمة	لا
└─ tool_choice	OpenAI.ToolChoiceParam	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	OpenAI.ToolsArray	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . ندعم الفئات التالية من الأدوات: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. معرفة المزيد حول الأدوات المضمنة. - أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو موصلات معرفة مسبقا مثل Google Drive وSharePoint. معرفة المزيد حول أدوات MCP. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك باستخدام وسيطات مكتوبة بقوة والمخرجات. معرفة المزيد حول استدعاء الدالة. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.	لا
└─ top_logprobs	عدد صحيح أو صفري		لا
└─ top_p	عدد أو صفرا		لا	1
└─ الاقتطاع	سلسلة أو قيمة خالية		لا	معطل
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	سلسلة (مهملة)	يتم استبدال هذا الحقل ب safety_identifier و prompt_cache_key. استخدم prompt_cache_key بدلا من ذلك للحفاظ على تحسينات التخزين المؤقت. معرف ثابت للمستخدمين النهائيين. يستخدم لزيادة معدلات الوصول إلى ذاكرة التخزين المؤقت عن طريق تجميع الطلبات المماثلة بشكل أفضل ولمساعدة OpenAI في اكتشاف إساءة الاستخدام ومنعها. تعرّف على المزيد.	لا
sequence_number	integer	رقم التسلسل لهذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.queued". القيم المحتملة: response.queued	‏‏نعم‬

OpenAI.ResponseReasoningSummaryPartAddedEvent

تنبعث عند إضافة جزء جديد من ملخص التفكير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف العنصر الذي يقترن به جزء الملخص هذا.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يرتبط به جزء الملخص هذا.	‏‏نعم‬
جزء	OpenAI.ResponseReasoningSummaryPartaddedEventPart		‏‏نعم‬
└─ نص	string		‏‏نعم‬
└─ النوع	enum	القيم المحتملة: summary_text	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
summary_index	integer	فهرس جزء الملخص ضمن ملخص المنطق.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.reasoning_summary_part.added. القيم المحتملة: response.reasoning_summary_part.added	‏‏نعم‬

OpenAI.ResponseReasoningSummaryPartaddedEventPart

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string		‏‏نعم‬
النوع	enum	القيم المحتملة: summary_text	‏‏نعم‬

OpenAI.ResponseReasoningSummaryTextDeltaEvent

تنبعث عند إضافة دلتا إلى نص ملخص التفكير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	دلتا النص الذي تمت إضافته إلى الملخص.	‏‏نعم‬
item_id	string	معرف العنصر الذي يقترن به دلتا نص الملخص هذا.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي ترتبط به دلتا نص الملخص هذا.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
summary_index	integer	فهرس جزء الملخص ضمن ملخص المنطق.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.reasoning_summary_text.delta. القيم المحتملة: response.reasoning_summary_text.delta	‏‏نعم‬

OpenAI.ResponseReasoningTextDeltaEvent

يتم إصداره عند إضافة دلتا إلى نص المنطق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء محتوى الاستدلال الذي ترتبط به هذه الدلتا.	‏‏نعم‬
الدلتا	string	دلتا النص التي تمت إضافتها إلى محتوى المنطق.	‏‏نعم‬
item_id	string	معرف العنصر المقترن به دلتا النص المنطقي هذا.	‏‏نعم‬
output_index	integer	فهرس عنصر الناتج يرتبط به هذا النص الاستدلالي.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.reasoning_text.delta. القيم المحتملة: response.reasoning_text.delta	‏‏نعم‬

OpenAI.ResponseRefusalDeltaEvent

تنبعث عندما يكون هناك نص رفض جزئي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تتم إضافة نص الرفض إليه.	‏‏نعم‬
الدلتا	string	نص الرفض الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة نص الرفض إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة نص الرفض إليه.	‏‏نعم‬
sequence_number	integer	رقم تسلسل هذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.refusal.delta. القيم المحتملة: response.refusal.delta	‏‏نعم‬

OpenAI.ResponseStreamOptions

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
include_obfuscation	boolean	عندما يكون هذا صحيحا، سيتم تمكين تشويش الدفق. إضافة تعتيم الدفق أحرف عشوائية obfuscation إلى حقل في دفق أحداث دلتا إلى تطبيع أحجام الحمولة كتخفيف لبعض هجمات القناة الجانبية. يتم تضمين حقول التعتيم هذه بشكل افتراضي، ولكنها تضيف كمية صغيرة من الحمل إلى دفق البيانات. يمكنك التعيين include_obfuscation إلى خطأ لتحسين النطاق الترددي إذا كنت تثق في ارتباطات الشبكة بين تطبيقك وواجهة برمجة تطبيقات OpenAI.	لا

OpenAI.ResponseTextDeltaEvent

تنبعث عندما يكون هناك دلتا نصية إضافية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
الدلتا	string	دلتا النص الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
سجلات الحماية	صفيف OpenAI.ResponseLogProb	احتمالات سجل الرموز المميزة في دلتا.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
sequence_number	integer	رقم التسلسل لهذا الحدث.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.output_text.delta. القيم المحتملة: response.output_text.delta	‏‏نعم‬

OpenAI.ResponseTextParam

خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. اعرف المزيد‬:

• مدخلات ومخرجات النص
• المخرجات المنظمة

الاسم	النوع	وصف	مطلوب	الإفتراضي
format	OpenAI.TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين { "type": "json_schema" } المخرجات المنظمة ، مما يضمن أن النموذج سوف يتطابق مع مخطط JSON المرفق. تعرف على المزيد في التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية. *غير موصى به للنماذج الأحدث GPT-4O: إعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. استخدام json_schema يفضل للنماذج التي تدعمه.	لا
الاسهاب	OpenAI.Verbosity	يحد من كثرة استجابة النموذج. ستؤدي القيم الأقل إلى استجابات أكثر إيجازا، بينما ستؤدي القيم الأعلى إلى المزيد من الاستجابات المطولة. القيم المدعومة حاليا هي lowو mediumو.high	لا

OpenAI.ResponseUsage

يمثل تفاصيل استخدام الرمز المميز بما في ذلك الرموز المميزة للإدخال والرموز المميزة للإخراج وتفصيل الرموز المميزة للإخراج وإجمالي الرموز المميزة المستخدمة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_tokens	integer	عدد رموز الإدخال.	‏‏نعم‬
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		‏‏نعم‬
└─ cached_tokens	integer		‏‏نعم‬
output_tokens	integer	عدد الرموز المميزة للإخراج.	‏‏نعم‬
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		‏‏نعم‬
└─ reasoning_tokens	integer		‏‏نعم‬
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة.	‏‏نعم‬

OpenAI.ResponseUsageInputTokensDetails

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

OpenAI.ResponseUsageOutputTokensDetails

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

OpenAI.ResponseWebSearchCallInProgressEvent

ملاحظة: web_search غير متوفرة بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف فريد لعنصر الإخراج المرتبط بمكالمة بحث الويب.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي ترتبط به استدعاء بحث الويب.	‏‏نعم‬
sequence_number	integer	رقم التسلسل لاستدعاء البحث على الويب الذي يتم معالجته.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.web_search_call.in_progress. القيم المحتملة: response.web_search_call.in_progress	‏‏نعم‬

OpenAI.ResponseWebSearchCallSearchingEvent

ملاحظة: web_search غير متوفرة بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف فريد لعنصر الإخراج المرتبط بمكالمة بحث الويب.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي ترتبط به استدعاء بحث الويب.	‏‏نعم‬
sequence_number	integer	رقم التسلسل لاستدعاء البحث على الويب الذي يتم معالجته.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.web_search_call.searching. القيم المحتملة: response.web_search_call.searching	‏‏نعم‬

OpenAI.RunCompletionUsage

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

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

OpenAI.RunGraderRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
الصف	OpenAI.GraderStringCheck أو OpenAI.GraderTextSimilarity أو OpenAI.GraderPython أو OpenAI.GraderScoreModel أو OpenAI.GraderMulti أو GraderEndpoint	الصف المستخدم لوظيفة الضبط الدقيق.	‏‏نعم‬
عنصر	OpenAI.RunGraderRequestItem		لا
model_sample	string	عينة النموذج المراد تقييمها. سيتم استخدام هذه القيمة لتعبئة مساحة sample الاسم. انظر الدليل لمزيد من التفاصيل. سيتم ملء المتغير output_json إذا كان عينة النموذج هي سلسلة JSON صالحة.	‏‏نعم‬

OpenAI.RunGraderRequestItem

النوع: كائن

OpenAI.RunGraderResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.RunGraderResponseMetadata		‏‏نعم‬
model_grader_token_usage_per_model	object		‏‏نعم‬
ثواب	رقم		‏‏نعم‬
sub_rewards	object		‏‏نعم‬

OpenAI.RunGraderResponseMetadata

الاسم	النوع	وصف	مطلوب	الإفتراضي
اخطاء	OpenAI.RunGraderResponseMetadataErrors		‏‏نعم‬
execution_time	رقم		‏‏نعم‬
الاسم	string		‏‏نعم‬
sampled_model_name	سلسلة أو قيمة خالية		‏‏نعم‬
الموسيقى التصويرية	object		‏‏نعم‬
token_usage	عدد صحيح أو صفري		‏‏نعم‬
النوع	string		‏‏نعم‬

OpenAI.RunGraderResponseMetadataErrors

الاسم	النوع	وصف	مطلوب	الإفتراضي
formula_parse_error	boolean		‏‏نعم‬
invalid_variable_error	boolean		‏‏نعم‬
model_grader_parse_error	boolean		‏‏نعم‬
model_grader_refusal_error	boolean		‏‏نعم‬
model_grader_server_error	boolean		‏‏نعم‬
model_grader_server_error_details	سلسلة أو قيمة خالية		‏‏نعم‬
other_error	boolean		‏‏نعم‬
python_grader_runtime_error	boolean		‏‏نعم‬
python_grader_runtime_error_details	سلسلة أو قيمة خالية		‏‏نعم‬
python_grader_server_error	boolean		‏‏نعم‬
python_grader_server_error_type	سلسلة أو قيمة خالية		‏‏نعم‬
sample_parse_error	boolean		‏‏نعم‬
truncated_observation_error	boolean		‏‏نعم‬
unresponsive_reward_error	boolean		‏‏نعم‬

OpenAI.RunObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
assistant_id	string	معرف المساعد المستخدم لتنفيذ هذه الجولة.	‏‏نعم‬
cancelled_at	سلسلة أو قيمة خالية	الطابع الزمني Unix (بالثوان) لوقت إلغاء التشغيل.	‏‏نعم‬
completed_at	سلسلة أو قيمة خالية	الطابع الزمني Unix (بالثوان) لوقت اكتمال التشغيل.	‏‏نعم‬
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء التشغيل.	‏‏نعم‬
expires_at	سلسلة أو قيمة خالية	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية التشغيل.	‏‏نعم‬
failed_at	سلسلة أو قيمة خالية	الطابع الزمني Unix (بالثوان) لوقت فشل التشغيل.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
incomplete_details	OpenAI.RunObjectIncompleteDetails أو null	تفاصيل حول سبب عدم اكتمال التشغيل. سيتم null إذا لم يكن التشغيل غير مكتمل.	‏‏نعم‬
تعليمات	string	التعليمات التي استخدمها المساعد في هذه الجولة.	‏‏نعم‬
last_error	OpenAI.RunObjectLastError أو null	الخطأ الأخير المقترن بهذا التشغيل. سيتم null إذا لم تكن هناك أخطاء.	‏‏نعم‬
max_completion_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد رموز الإكمال المميزة المحددة لاستخدامها على مدار التشغيل.	‏‏نعم‬
max_prompt_tokens	عدد صحيح أو صفري	الحد الأقصى لعدد الرموز المميزة للمطالبة المحددة لاستخدامها على مدار التشغيل.	‏‏نعم‬
metadata	OpenAI.Metadata أو null		‏‏نعم‬
نموذج	string	النموذج الذي استخدمه المساعد في هذه الجولة.	‏‏نعم‬
object	enum	نوع الكائن، الذي يتم thread.runدائما . القيم المحتملة: thread.run	‏‏نعم‬
parallel_tool_calls	OpenAI.ParallelToolCalls	ما إذا كنت تريد تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	‏‏نعم‬
required_action	OpenAI.RunObjectRequiredAction أو null	تفاصيل حول الإجراء المطلوب لمتابعة التشغيل. سيكون null إذا لم يكن هناك أي إجراء مطلوب.	‏‏نعم‬
response_format	OpenAI.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	سلسلة أو قيمة خالية	الطابع الزمني Unix (بالثوان) لوقت بدء التشغيل.	‏‏نعم‬
الحالة	OpenAI.RunStatus	حالة الجري، والتي يمكن أن تكون إما queued، in_progress، requires_action، cancelling، completedincompletecancelledfailedأو .expired	‏‏نعم‬
درجة الحرارة	عدد أو صفرا	درجة حرارة أخذ العينات المستخدمة لهذا التشغيل. إذا لم يتم تعيينه، تعيينه افتراضيا إلى 1.	لا
thread_id	string	معرف الخيط الذي تم تنفيذه كجزء من هذه الجولة.	‏‏نعم‬
tool_choice	OpenAI.AssistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. auto هي القيمة الافتراضية وتعني أن النموذج يمكنه الاختيار بين توليد رسالة أو استدعاء أداة أو أكثر. required يعني أن النموذج يجب أن يستدعي أداة أو أكثر قبل الرد على المستخدم. تحديد أداة معينة مثل {"type": "file_search"} أو {"type": "function", "function": {"name": "my_function"}} يجبر النموذج على استدعاء تلك الأداة.	‏‏نعم‬
الأدوات	مصفوفة من OpenAI.AssistantTool	قائمة الأدوات التي استخدمها المساعد في هذه الجولة.	‏‏نعم‬	[]
top_p	عدد أو صفرا	قيمة أخذ عينات النواة المستخدمة لهذا التشغيل. إذا لم يتم تعيينه، تعيينه افتراضيا إلى 1.	لا
truncation_strategy	OpenAI.CutncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	‏‏نعم‬
استخدام	OpenAI.RunCompletionUsage أو null		‏‏نعم‬

OpenAI.RunObjectIncompleteDetails

الاسم	النوع	وصف	مطلوب	الإفتراضي
السبب	enum	القيم المحتملة: max_completion_tokens، max_prompt_tokens	لا

OpenAI.RunObjectLastError

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	enum	القيم المحتملة: server_error، ، rate_limit_exceededinvalid_prompt	‏‏نعم‬
رسالة	string		‏‏نعم‬

OpenAI.RunObjectRequiredAction

الاسم	النوع	وصف	مطلوب	الإفتراضي
submit_tool_outputs	OpenAI.RunObjectRequiredActionSubmitToolOutputs		‏‏نعم‬
النوع	enum	القيم المحتملة: submit_tool_outputs	‏‏نعم‬

OpenAI.RunObjectRequiredActionSubmitToolOutputs

الاسم	النوع	وصف	مطلوب	الإفتراضي
tool_calls	مصفوفة OpenAI.RunToolCallObject		‏‏نعم‬

OpenAI.RunStatus

حالة الجري، والتي يمكن أن تكون إما queued، in_progress، requires_action، cancelling، completedincompletecancelledfailedأو .expired

الخاصية	قيمة
نوع	string
Values	queued in_progress requires_action cancelling cancelled failed completed incomplete expired

OpenAI.RunStepCompletionUsage

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

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

OpenAI.RunStepDetailsMessageCreationObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
message_creation	OpenAI.RunStepDetailsMessageCreationObjectMessageCreation		‏‏نعم‬
النوع	enum	دائمًا message_creation. القيم المحتملة: message_creation	‏‏نعم‬

OpenAI.RunStepDetailsMessageCreationObjectMessageCreation

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

OpenAI.RunStepToolCall

المميز ل OpenAI.RunStepDetailsToolCall

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

قيمة النوع	Schema
code_interpreter	OpenAI.RunStepDetailsToolCallsCodeObject
file_search	OpenAI.RunStepDetailsToolCallsFileSearchObject
function	OpenAI.RunStepDetailsToolCallsFunctionObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.RunStepDetailsToolCallType		‏‏نعم‬

OpenAI.RunStepDetailsToolCallType

الخاصية	قيمة
نوع	string
Values	code_interpreter file_search function

OpenAI.RunStepDetailsToolCallsCodeObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
code_interpreter	OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter		‏‏نعم‬
└─ المدخلات	string		‏‏نعم‬
└─ المخرجات	مصفوفة من OpenAI.RunStepDetailsToolcallsCodeOutputLogsObject أو OpenAI.RunStepDetailsToolcallsCodeOutputImageObject		‏‏نعم‬
المعرف	string	معرف استدعاء الأداة.	‏‏نعم‬
النوع	enum	نوع استدعاء الأداة. سيكون هذا دائما code_interpreter لهذا النوع من استدعاء الأدوات. القيم المحتملة: code_interpreter	‏‏نعم‬

OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	string		‏‏نعم‬
outputs	مصفوفة من OpenAI.RunStepDetailsToolcallsCodeOutputLogsObject أو OpenAI.RunStepDetailsToolcallsCodeOutputImageObject		‏‏نعم‬

OpenAI.RunStepDetailsToolCallsCodeOutputImageObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
صورة	OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage		‏‏نعم‬
النوع	enum	دائمًا image. القيم المحتملة: image	‏‏نعم‬

OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage

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

OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject

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

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

OpenAI.RunStepDetailsToolCallsFileSearchObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_search	OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearch		‏‏نعم‬
└─ ranking_options	OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject	خيارات الترتيب للبحث عن الملفات.	لا
└─ النتائج	مصفوفة من OpenAI.RunStepDetailsToolCallsFileSearchResultObject		لا
المعرف	string	معرف كائن استدعاء الأداة.	‏‏نعم‬
النوع	enum	نوع استدعاء الأداة. سيكون هذا دائما file_search لهذا النوع من استدعاء الأدوات. القيم المحتملة: file_search	‏‏نعم‬

OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearch

الاسم	النوع	وصف	مطلوب	الإفتراضي
ranking_options	OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject	خيارات الترتيب للبحث عن الملفات.	لا
results	مصفوفة من OpenAI.RunStepDetailsToolCallsFileSearchResultObject		لا

OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject

خيارات الترتيب للبحث عن الملفات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
ranker	OpenAI.FileSearchRanker	المصنف الذي يجب استخدامه للبحث عن الملفات. إذا لم يتم تحديد سيستخدم auto ranker.	‏‏نعم‬
score_threshold	رقم	عتبة الدرجة في البحث عن الملف. يجب أن تكون كافة القيم رقم فاصلة عائمة بين 0 و1. القيود: الحد الأدنى: 0، الحد الأقصى: 1	‏‏نعم‬

OpenAI.RunStepDetailsToolCallsFileSearchResultObject

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

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

OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string		لا
النوع	enum	القيم المحتملة: text	لا

OpenAI.RunStepDetailsToolCallsFunctionObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
دالة	OpenAI.RunStepDetailsToolCallsFunctionObjectFunction		‏‏نعم‬
└─ الحجج	string		‏‏نعم‬
└─ الاسم	string		‏‏نعم‬
└─ الإخراج	سلسلة أو قيمة خالية		‏‏نعم‬
المعرف	string	معرف كائن استدعاء الأداة.	‏‏نعم‬
النوع	enum	نوع استدعاء الأداة. سيكون هذا دائما function لهذا النوع من استدعاء الأدوات. القيم المحتملة: function	‏‏نعم‬

OpenAI.RunStepDetailsToolCallsFunctionObjectFunction

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

OpenAI.RunStepDetailsToolCallsObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
tool_calls	مصفوفة من OpenAI.RunStepDetailsToolCall	مجموعة من الأدوات تستدعي خطوة التشغيل التي شاركت فيها. يمكن ربط هذه الأنواع بأحد ثلاثة أنواع من الأدوات: code_interpreter، file_search، أو function.	‏‏نعم‬
النوع	enum	دائمًا tool_calls. القيم المحتملة: tool_calls	‏‏نعم‬

OpenAI.RunStepObject

يمثل خطوة في تنفيذ تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
assistant_id	string	معرف المساعد المرتبط بخطوة التشغيل.	‏‏نعم‬
cancelled_at	سلسلة أو قيمة خالية		‏‏نعم‬
completed_at	سلسلة أو قيمة خالية		‏‏نعم‬
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء خطوة التشغيل.	‏‏نعم‬
expired_at	سلسلة أو قيمة خالية		‏‏نعم‬
failed_at	سلسلة أو قيمة خالية		‏‏نعم‬
المعرف	string	معرف خطوة التشغيل، والتي يمكن الرجوع إليها في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
last_error	OpenAI.RunStepObjectLastError أو null		‏‏نعم‬
metadata	OpenAI.Metadata أو null		‏‏نعم‬
object	enum	نوع الكائن، الذي يتم thread.run.stepدائما . القيم المحتملة: thread.run.step	‏‏نعم‬
run_id	string	معرف الجولة التي تنتمي إليها خطوة الجري.	‏‏نعم‬
الحالة	enum	حالة خطوة الجري، والتي يمكن أن تكون إما in_progress، cancelled، failed، completed، أو expired. القيم المحتملة: in_progress، cancelled، failed، ، completedexpired	‏‏نعم‬
step_details	OpenAI.RunStepDetailsMessageCreationObject أو OpenAI.RunStepDetailsToolCallsObject	تفاصيل خطوة التشغيل.	‏‏نعم‬
thread_id	string	معرف الموضوع الذي تم تشغيله.	‏‏نعم‬
النوع	enum	نوع خطوة التشغيل، والتي يمكن أن تكون إما message_creation أو tool_calls. القيم المحتملة: message_creation، tool_calls	‏‏نعم‬
استخدام	OpenAI.RunStepCompletionUsage	إحصائيات الاستخدام المتعلقة بخطوة التشغيل. سيتم null هذه القيمة بينما تكون حالة خطوة التشغيل in_progress.	‏‏نعم‬

OpenAI.RunStepObjectLastError

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	enum	القيم المحتملة: server_error، rate_limit_exceeded	‏‏نعم‬
رسالة	string		‏‏نعم‬

OpenAI.RunToolCallObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
دالة	OpenAI.RunToolCallObjectFunction		‏‏نعم‬
└─ الحجج	string		‏‏نعم‬
└─ الاسم	string		‏‏نعم‬
المعرف	string	معرف استدعاء الأداة. يجب الإشارة إلى هذا المعرف عند إرسال مخرجات الأدوات باستخدام مخرجات أداة الإرسال لتشغيل نقطة النهاية.	‏‏نعم‬
النوع	enum	نوع استدعاء الأداة مطلوب للإخراج. في الوقت الحالي، هذا هو دائما function. القيم المحتملة: function	‏‏نعم‬

OpenAI.RunToolCallObjectFunction

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

OpenAI.لقطة شاشة

إجراء لقطة شاشة.

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

OpenAI.Scroll

إجراء تمرير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
scroll_x	integer	مسافة التمرير الأفقية.	‏‏نعم‬
scroll_y	integer	مسافة التمرير العمودية.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء التمرير، تكون هذه الخاصية هي اضبط دائما على scroll. القيم المحتملة: scroll	‏‏نعم‬
×	integer	الإحداثي س حيث حدث التمرير.	‏‏نعم‬
y	integer	الإحداثي ص حيث حدث التمرير.	‏‏نعم‬

OpenAI.SearchContextSize

الخاصية	قيمة
نوع	string
Values	low medium high

OpenAI.SpecificApplyPatchParam

يفرض على النموذج استدعاء أداة apply_patch عند تنفيذ استدعاء أداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	الأداة التي يجب الاتصال بها. دائمًا apply_patch. القيم المحتملة: apply_patch	‏‏نعم‬

OpenAI.SpecificFunctionShellParam

يفرض على النموذج استدعاء أداة shell عند الحاجة إلى استدعاء أداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	الأداة التي يجب الاتصال بها. دائمًا shell. القيم المحتملة: shell	‏‏نعم‬

OpenAI.StaticChunkingStrategy

الاسم	النوع	وصف	مطلوب	الإفتراضي
chunk_overlap_tokens	integer	عدد الرموز المميزة التي تتداخل بين المجموعات. القيمة الافتراضية هي 400. لاحظ أن التداخل يجب ألا يتجاوز نصف max_chunk_size_tokens.	‏‏نعم‬
max_chunk_size_tokens	integer	الحد الأقصى لعدد الرموز المميزة في كل مجموعة. القيمة الافتراضية هي 800. الحد الأدنى للقيمة هو 100 والحد الأقصى للقيمة هو 4096. القيود: الحد الأدنى: 100، الحد الأقصى: 4096	‏‏نعم‬

OpenAI.StaticChunkingStrategyRequestParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
ثابت	OpenAI.StaticChunkingStrategy		‏‏نعم‬
النوع	enum	دائمًا static. القيم المحتملة: static	‏‏نعم‬

OpenAI.StaticChunkingStrategyResponseParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
ثابت	OpenAI.StaticChunkingStrategy		‏‏نعم‬
النوع	enum	دائمًا static. القيم المحتملة: static	‏‏نعم‬

OpenAI.StopConfiguration

غير مدعوم بأحدث نماذج o3 التفكير و o4-mini. ما يصل إلى أربعة تسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف.

يقبل هذا المخطط أحد الأنواع التالية:

• صفيف
• null

OpenAI.SubmitToolOutputsRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
استدر	بوليان أو نول		لا
tool_outputs	مصفوفة من OpenAI.SubmitToolOutputsRunRequestToolOutputs	قائمة بالأدوات التي يتم إرسال المخرجات لها.	‏‏نعم‬

OpenAI.SubmitToolOutputsRunRequestToolOutputs

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

OpenAI.Summary

نص ملخص من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	ملخص للاستدلال الناتج عن النموذج حتى الآن.	‏‏نعم‬
النوع	enum	نوع الكائن. دائمًا summary_text. القيم المحتملة: summary_text	‏‏نعم‬

OpenAI.SummaryTextContent

نص ملخص من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	ملخص للاستدلال الناتج عن النموذج حتى الآن.	‏‏نعم‬
النوع	enum	نوع الكائن. دائمًا summary_text. القيم المحتملة: summary_text	‏‏نعم‬

OpenAI.TextAnnotation

المميز ل OpenAI.TextAnnotation

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

قيمة النوع	Schema
file_citation	OpenAI.MessageContentTextAnnotationsFileCitationObject
file_path	OpenAI.MessageContentTextAnnotationsFilePathObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.TextAnnotationType		‏‏نعم‬

OpenAI.TextAnnotationType

الخاصية	قيمة
نوع	string
Values	file_citation file_path

OpenAI.TextContent

محتوى نصي.

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

OpenAI.TextResponseFormatConfiguration

كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين { "type": "json_schema" } المخرجات المنظمة، ما يضمن تطابق النموذج مع مخطط JSON المتوفر. تعرف على المزيد في

التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية. غير موصى به في gpt-4o والنماذج الأحدث:* إعداد تفعيل { "type": "json_object" } وضع JSON الأقدم، مما يضمن أن الرسالة التي يولدها النموذج صحيحة JSON. يفضل استخدام json_schema للنماذج التي تدعمه.

تمييز ل OpenAI.TextResponseFormatConfiguration

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

قيمة النوع	Schema
json_schema	OpenAI.TextResponseFormatJsonSchema
text	OpenAI.TextResponseFormatConfigurationResponseFormatText
json_object	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.TextResponseFormatConfigurationType		‏‏نعم‬

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

تنسيق استجابة كائن JSON. طريقة قديمة لإنشاء استجابات JSON. يوصى باستخدام json_schema للنماذج التي تدعمه. لاحظ أن النموذج لن ينشئ JSON بدون رسالة نظام أو مستخدم ترشده إلى القيام بذلك.

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

OpenAI.TextResponseFormatConfigurationResponseFormatText

تنسيق الاستجابة الافتراضي. يستخدم لإنشاء استجابات نصية.

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

OpenAI.TextResponseFormatConfigurationType

الخاصية	قيمة
نوع	string
Values	text json_schema json_object

OpenAI.TextResponseFormatJsonSchema

تنسيق استجابة مخطط JSON. يستخدم لإنشاء استجابات JSON منظمة. تعرف على مزيد من المعلومات عن المخرجات المنظمة.

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

OpenAI.ThreadObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء مؤشر الترابط.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
metadata	OpenAI.Metadata أو null		‏‏نعم‬
object	enum	نوع الكائن، الذي يتم threadدائما . القيم المحتملة: thread	‏‏نعم‬
tool_resources	OpenAI.ThreadObjectToolResources أو null		‏‏نعم‬

OpenAI.ThreadObjectToolResources

الاسم	النوع	وصف	مطلوب	الإفتراضي
code_interpreter	OpenAI.ThreadObjectToolResourcesCodeInterpreter		لا
file_search	OpenAI.ThreadObjectToolResourcesFileSearch		لا

OpenAI.ThreadObjectToolResourcesCodeInterpreter

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

OpenAI.ThreadObjectToolResourcesFileSearch

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

OpenAI.TokenLimits

الاسم	النوع	وصف	مطلوب	الإفتراضي
post_instructions	integer	القيود: الحد الأدنى: 0	لا

OpenAI.Tool

أداة يمكن استخدامها لإنشاء استجابة.

تمييزي ل OpenAI.Tool

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

قيمة النوع	Schema
code_interpreter	OpenAI.CodeInterpreterTool
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search	OpenAI.WebSearchTool
mcp	OpenAI.MCPTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellToolParam
shell	OpenAI.FunctionShellToolParam
custom	OpenAI.CustomToolParam
web_search_preview	OpenAI.WebSearchPreviewTool
apply_patch	OpenAI.ApplyPatchToolParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ToolType		‏‏نعم‬

OpenAI.ToolChoiceAllowed

يقيد الأدوات المتاحة للنموذج على مجموعة محددة مسبقا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوضع	enum	يقيد الأدوات المتاحة للنموذج على مجموعة محددة مسبقا. auto يسمح للنموذج بالاختيار من بين الأدوات المسموح بها وإنشاء رسالة. required يتطلب النموذج استدعاء واحد أو أكثر من الأدوات المسموح بها. القيم المحتملة: auto، required	‏‏نعم‬
الأدوات	صفيف من العناصر	قائمة بتعريفات الأدوات التي يجب السماح للنموذج باستدعاءها. بالنسبة لواجهة برمجة تطبيقات الاستجابات، قد تبدو قائمة تعريفات الأدوات كما يلي: json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>	‏‏نعم‬
النوع	enum	نوع تكوين الأداة المسموح به. دائمًا allowed_tools. القيم المحتملة: allowed_tools	‏‏نعم‬

OpenAI.ToolChoiceCodeInterpreter

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: code_interpreter	‏‏نعم‬

OpenAI.ToolChoiceComputerUsePreview

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: computer_use_preview	‏‏نعم‬

OpenAI.ToolChoiceCustom

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

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

OpenAI.ToolChoiceFileSearch

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: file_search	‏‏نعم‬

OpenAI.ToolChoiceFunction

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

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

OpenAI.ToolChoiceImageGeneration

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: image_generation	‏‏نعم‬

OpenAI.ToolChoiceMCP

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاسم	سلسلة أو قيمة خالية		لا
server_label	string	تسمية خادم MCP المراد استخدامه.	‏‏نعم‬
النوع	enum	بالنسبة لأدوات MCP ، يكون النوع دائما mcp. القيم المحتملة: mcp	‏‏نعم‬

OpenAI.ToolChoiceOptions

يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. auto يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر. required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر.

الخاصية	قيمة
نوع	string
Values	none auto required

OpenAI.ToolChoiceParam

كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.

تمييز ل OpenAI.ToolChoiceParam

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

قيمة النوع	Schema
allowed_tools	OpenAI.ToolChoiceAllowed
mcp	OpenAI.ToolChoiceMCP
custom	OpenAI.ToolChoiceCustom
apply_patch	OpenAI.SpecificApplyPatchParam
shell	OpenAI.SpecificFunctionShellParam
file_search	OpenAI.ToolChoiceFileSearch
web_search_preview	OpenAI.ToolChoiceWebSearchPreview
computer_use_preview	OpenAI.ToolChoiceComputerUsePreview
web_search_preview_2025_03_11	OpenAI.ToolChoiceWebSearchPreview20250311
image_generation	OpenAI.ToolChoiceImageGeneration
code_interpreter	OpenAI.ToolChoiceCodeInterpreter

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ToolChoiceParamType		‏‏نعم‬

OpenAI.ToolChoiceParamType

الخاصية	قيمة
نوع	string
Values	allowed_tools function mcp custom apply_patch shell file_search web_search_preview computer_use_preview web_search_preview_2025_03_11 image_generation code_interpreter

OpenAI.ToolChoiceWebSearchPreview

ملاحظة: web_search غير متوفرة بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: web_search_preview	‏‏نعم‬

OpenAI.ToolChoiceWebSearchPreview20250311

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: web_search_preview_2025_03_11	‏‏نعم‬

OpenAI.ToolType

الخاصية	قيمة
نوع	string
Values	function file_search computer_use_preview web_search mcp code_interpreter image_generation local_shell shell custom web_search_preview apply_patch

OpenAI.ToolsArray

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

• الأدوات المضمنة: الأدوات التي يوفرها OpenAI التي توسع قدرات النموذج، مثل البحث على الويب أو البحث في الملفات. تعرف على المزيد حول الأدوات المضمنة.
• أدوات MCP: عمليات التكامل مع أنظمة الجهات الخارجية عبر خوادم MCP المخصصة أو الموصلات المعرفة مسبقا مثل Google Drive وSharePoint. تعرف على المزيد حول أدوات MCP.
• استدعاءات الدالة (أدوات مخصصة): الوظائف التي تحددها، ما يتيح للنموذج استدعاء التعليمات البرمجية الخاصة بك مع وسيطات ومخرجات مكتوبة بقوة. تعرف على المزيد حول استدعاء الوظائف. يمكنك أيضا استخدام أدوات مخصصة لاستدعاء التعليمات البرمجية الخاصة بك.

صفيف: OpenAI.Tool

OpenAI.TopLogProb

أعلى احتمال سجل للرمز المميز.

الاسم	النوع	وصف	مطلوب	الإفتراضي
بايت	صفيف من الأعداد الصحيحة		‏‏نعم‬
لوغاربوب	رقم		‏‏نعم‬
الرمز المميز	string		‏‏نعم‬

OpenAI.TranscriptionSegment

الاسم	النوع	وصف	مطلوب	الإفتراضي
avg_logprob	رقم	متوسط logprob للجزء. إذا كانت القيمة أقل من -1، ففكر في فشل logprobs.	‏‏نعم‬
compression_ratio	رقم	نسبة الضغط للجزء. إذا كانت القيمة أكبر من 2.4، ففكر في فشل الضغط.	‏‏نعم‬
انتهاء	رقم	وقت انتهاء المقطع بالثوان.	‏‏نعم‬
المعرف	integer	المعرف الفريد للجزء.	‏‏نعم‬
no_speech_prob	رقم	احتمال عدم وجود كلام في المقطع. إذا كانت القيمة أعلى من 1.0 وكانت avg_logprob أقل من -1، ففكر في هذا الجزء الصامت.	‏‏نعم‬
seek	integer	البحث عن إزاحة المقطع.	‏‏نعم‬
بدء	رقم	وقت بدء المقطع بالثوان.	‏‏نعم‬
درجة الحرارة	رقم	معلمة درجة الحرارة المستخدمة لإنشاء المقطع.	‏‏نعم‬
نص	string	محتوى نص المقطع.	‏‏نعم‬
tokens	صفيف من الأعداد الصحيحة	صفيف معرفات الرمز المميز لمحتوى النص.	‏‏نعم‬

OpenAI.TranscriptionWord

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

OpenAI.CutncationObject

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

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

OpenAI.Type

إجراء لكتابة نص.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	النص المراد كتابته.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء نوع، تكون هذه الخاصية هي اضبط دائما على type. القيم المحتملة: type	‏‏نعم‬

OpenAI.UpdateConversationBody

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

OpenAI.UpdateVectorStoreFileAttributesRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		‏‏نعم‬

OpenAI.UpdateVectorStoreRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
expires_after	OpenAI.VectorStoreExpirationبعد	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
metadata	OpenAI.Metadata أو null		لا
الاسم	سلسلة أو قيمة خالية	اسم مخزن المتجهات.	لا

OpenAI.UrlCitationBody

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
end_index	integer	فهرس الحرف الأخير من اقتباس عنوان URL في الرسالة.	‏‏نعم‬
start_index	integer	فهرس الحرف الأول من اقتباس عنوان URL في الرسالة.	‏‏نعم‬
العنوان	string	عنوان مورد الويب.	‏‏نعم‬
النوع	enum	نوع اقتباس عنوان URL. دائمًا url_citation. القيم المحتملة: url_citation	‏‏نعم‬
عنوان URL	string	عنوان URL لمورد الويب.	‏‏نعم‬

OpenAI.ValidateGraderResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
الصف	OpenAI.GraderStringCheck أو OpenAI.GraderTextSimilarity أو OpenAI.GraderPython أو OpenAI.GraderScoreModel أو OpenAI.GraderMulti أو GraderEndpoint	الصف المستخدم لوظيفة الضبط الدقيق.	لا

OpenAI.VectorStoreExpirationبعد

نهج انتهاء الصلاحية لمخزن المتجهات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
anchor	enum	الطابع الزمني للارتساء الذي يتم بعده تطبيق نهج انتهاء الصلاحية. نقاط الارتساء المدعومة: last_active_at. القيم المحتملة: last_active_at	‏‏نعم‬
days	integer	عدد الأيام بعد وقت الارتساء الذي ستنتهي فيه صلاحية مخزن المتجهات. القيود: الحد الأدنى: 1، الحد الأقصى: 365	‏‏نعم‬

OpenAI.VectorStoreFileAttributes

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

النوع: كائن

OpenAI.VectorStoreFileBatchObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء دفعة ملفات مخزن المتجهات.	‏‏نعم‬
file_counts	OpenAI.VectorStoreFileBatchObjectFileCounts		‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
object	enum	نوع الكائن، الذي يتم vector_store.file_batchدائما . القيم المحتملة: vector_store.files_batch	‏‏نعم‬
الحالة	enum	حالة دفعة ملفات مخزن المتجهات، والتي يمكن أن تكون إما in_progressأو completedأو cancelled أو failed. القيم المحتملة: in_progress، completed، ، cancelledfailed	‏‏نعم‬
vector_store_id	string	معرف مخزن المتجهات الذي يرفق به الملف .	‏‏نعم‬

OpenAI.VectorStoreFileBatchObjectFileCounts

الاسم	النوع	وصف	مطلوب	الإفتراضي
cancelled	integer		‏‏نعم‬
مكتمل	integer		‏‏نعم‬
فشل	integer		‏‏نعم‬
in_progress	integer		‏‏نعم‬
مجموع	integer		‏‏نعم‬

OpenAI.VectorStoreFileObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		لا
chunking_strategy	OpenAI.ChunkingStrategyResponse	الاستراتيجية المستخدمة لتقسيم الملف.	لا
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء ملف مخزن المتجهات.	‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
last_error	OpenAI.VectorStoreFileObjectLastError أو null		‏‏نعم‬
object	enum	نوع الكائن، الذي يتم vector_store.fileدائما . القيم المحتملة: vector_store.file	‏‏نعم‬
الحالة	enum	حالة ملف مخزن المتجهات، والتي يمكن أن تكون إما in_progressأو completedأو cancelledأو failed. تشير الحالة completed إلى أن ملف مخزن المتجهات جاهز للاستخدام. القيم المحتملة: in_progress، completed، ، cancelledfailed	‏‏نعم‬
usage_bytes	integer	إجمالي استخدام مخزن المتجهات بالبايت. لاحظ أن هذا قد يكون مختلفا عن حجم الملف الأصلي.	‏‏نعم‬
vector_store_id	string	معرف مخزن المتجهات الذي يرفق به الملف .	‏‏نعم‬

OpenAI.VectorStoreFileObjectLastError

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	enum	القيم المحتملة: server_error، ، unsupported_fileinvalid_file	‏‏نعم‬
رسالة	string		‏‏نعم‬

OpenAI.VectorStoreObject

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء مخزن المتجهات.	‏‏نعم‬
expires_after	OpenAI.VectorStoreExpirationبعد	نهج انتهاء الصلاحية لمخزن المتجهات.	لا
expires_at	سلسلة أو قيمة خالية		لا
file_counts	OpenAI.VectorStoreObjectFileCounts		‏‏نعم‬
المعرف	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
last_active_at	سلسلة أو قيمة خالية		‏‏نعم‬
metadata	OpenAI.Metadata أو null		‏‏نعم‬
الاسم	string	اسم مخزن المتجهات.	‏‏نعم‬
object	enum	نوع الكائن، الذي يتم vector_storeدائما . القيم المحتملة: vector_store	‏‏نعم‬
الحالة	enum	حالة مخزن المتجهات، والتي يمكن أن تكون إما expiredأو in_progressأو completed. تشير حالة completed إلى أن مخزن المتجهات جاهز للاستخدام. القيم المحتملة: expired، ، in_progresscompleted	‏‏نعم‬
usage_bytes	integer	إجمالي عدد وحدات البايت المستخدمة من قبل الملفات في مخزن المتجهات.	‏‏نعم‬

OpenAI.VectorStoreObjectFileCounts

الاسم	النوع	وصف	مطلوب	الإفتراضي
cancelled	integer		‏‏نعم‬
مكتمل	integer		‏‏نعم‬
فشل	integer		‏‏نعم‬
in_progress	integer		‏‏نعم‬
مجموع	integer		‏‏نعم‬

OpenAI.VectorStoreSearchRequest

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

OpenAI.VectorStoreSearchRequestRankingOptions

الاسم	النوع	وصف	مطلوب	الإفتراضي
ranker	enum	القيم المحتملة: none، ، autodefault-2024-11-15	لا
score_threshold	رقم	القيود: الحد الأدنى: 0، الحد الأقصى: 1	لا

OpenAI.VectorStoreSearchResultContentObject

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

OpenAI.VectorStoreSearchResultItem

الاسم	النوع	وصف	مطلوب	الإفتراضي
attributes	OpenAI.VectorStoreFileAttributes أو null		‏‏نعم‬
محتوى	مصفوفة من OpenAI.VectorStoreSearchResultContentObject	مجموعات المحتوى من الملف.	‏‏نعم‬
file_id	string	معرف ملف مخزن المتجهات.	‏‏نعم‬
filename	string	اسم ملف مخزن المتجهات.	‏‏نعم‬
score	رقم	درجة التشابه للنتيجة. القيود: الحد الأدنى: 0، الحد الأقصى: 1	‏‏نعم‬

OpenAI.VectorStoreSearchResultsPage

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة من OpenAI.VectorStoreSearchResultItem	قائمة عناصر نتائج البحث.	‏‏نعم‬
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من النتائج لجلبها.	‏‏نعم‬
next_page	سلسلة أو قيمة خالية		‏‏نعم‬
object	enum	نوع الكائن، الذي يكون دائما vector_store.search_results.page القيم المحتملة: vector_store.search_results.page	‏‏نعم‬
search_query	صفيف سلسلة		‏‏نعم‬

OpenAI.Verbosity

يحد من كثرة استجابة النموذج. القيم الأقل ستؤدي إلى ردود أكثر إيجازا، بينما القيم الأعلى ستؤدي إلى ردود أكثر تفصيلا. القيم المدعومة حاليا هي lowو mediumو.high

الخاصية	قيمة
نوع	string
Values	low medium high

OpenAI.VoiceIdsShared

الخاصية	قيمة
نوع	string
Values	alloy ash ballad coral echo sage shimmer verse marin cedar

OpenAI.Wait

إجراء انتظار.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	يحدد نوع الحدث. بالنسبة إلى إجراء الانتظار، تكون هذه الخاصية هي اضبط دائما على wait. القيم المحتملة: wait	‏‏نعم‬

OpenAI.WebSearchActionFind

نوع الإجراء "بحث": يبحث عن نمط داخل صفحة محملة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
pattern	string	النمط أو النص المطلوب البحث عنه داخل الصفحة.	‏‏نعم‬
النوع	enum	نوع الإجراء. القيم المحتملة: find_in_page	‏‏نعم‬
عنوان URL	string	عنوان URL للصفحة التي تم البحث عنها عن النمط.	‏‏نعم‬

OpenAI.WebSearchActionOpenPage

نوع الإجراء "open_page" - يفتح عنوان URL محددا من نتائج البحث.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الإجراء. القيم المحتملة: open_page	‏‏نعم‬
عنوان URL	string	عنوان URL الذي فتحه النموذج.	‏‏نعم‬

OpenAI.WebSearchActionSearch

نوع الإجراء "بحث" - لإجراء استعلام بحث على الويب.

الاسم	النوع	وصف	مطلوب	الإفتراضي
queries	صفيف سلسلة	استعلامات البحث.	لا
استعلام	سلسلة (مهملة)	[مهمل] استعلام البحث.	‏‏نعم‬
المصادر	صفيف OpenAI.WebSearchActionSearchSources	المصادر المستخدمة في البحث.	لا
النوع	enum	نوع الإجراء. القيم المحتملة: search	‏‏نعم‬

OpenAI.WebSearchActionSearchSources

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: url	‏‏نعم‬
عنوان URL	string		‏‏نعم‬

OpenAI.WebSearchApproximateLocation

الموقع التقريبي للمستخدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
مدينة	سلسلة أو قيمة خالية		لا
country	سلسلة أو قيمة خالية		لا
region	سلسلة أو قيمة خالية		لا
المنطقة الزمنية	سلسلة أو قيمة خالية		لا
النوع	enum	نوع تقريب الموقع. دائمًا approximate. القيم المحتملة: approximate	لا

OpenAI.WebSearchPreviewTool

ملاحظة: web_search غير متوفرة بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
search_context_size	OpenAI.SearchContextSize		لا
النوع	enum	نوع أداة البحث على الويب. أحد web_search_preview أو web_search_preview_2025_03_11. القيم المحتملة: web_search_preview	‏‏نعم‬
user_location	OpenAI.ApproximateLocation أو null		لا

OpenAI.WebSearchTool

ملاحظة: web_search غير متوفرة بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	OpenAI.WebSearchToolFilters أو null		لا
search_context_size	enum	إرشادات عالية المستوى لمقدار مساحة نافذة السياق لاستخدامها في البحث. واحد من lowأو mediumأو high. medium هو الافتراضي. القيم المحتملة: low، ، mediumhigh	لا
النوع	enum	نوع أداة البحث على الويب. أحد web_search أو web_search_2025_08_26. القيم المحتملة: web_search	‏‏نعم‬
user_location	OpenAI.WebSearchApproximateLocation أو null		لا

OpenAI.WebSearchToolFilters

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

الأمر

الخاصية	قيمة
نوع	string
Values	asc desc

ResponseFormatJSONSchemaRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
json_schema	object	مخطط JSON لتنسيق الاستجابة	‏‏نعم‬
النوع	enum	نوع تنسيق الاستجابة القيم المحتملة: json_schema	‏‏نعم‬

استجابة توليد الكلام

تمثيل للاستجابة لعملية تحويل نص إلى كلام.

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

SpeechGenerationResponseFormat

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

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

• سلسلة
• السلسلة: mp3، opus، ، aacflac، wav،pcm

صوت الكلام

الأصوات المتاحة لتحويل النص إلى كلام.

الخاصية	قيمة
الوصف	الأصوات المتاحة لتحويل النص إلى كلام.
نوع	string
Values	alloy echo fable onyx nova shimmer

محتوى الفيديو

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

VideoContentVariant

نسخ أصول قابلة للاختيار للمحتوى المحمل.

الخاصية	قيمة
الوصف	نسخ أصول قابلة للاختيار للمحتوى المحمل.
نوع	string
Values	video thumbnail spritesheet

VideoIdParameter

الاسم	النوع	وصف	مطلوب	الإفتراضي
فيديو-آيد	string	معرف الفيديو المستخدم لطلب Azure OpenAI.	‏‏نعم‬

فيديوليست

قائمة بوظائف إنشاء الفيديو.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	مصفوفة VideoResource	قائمة وظائف إنشاء الفيديو.	‏‏نعم‬
first_id	string	معرف الفيديو الأول في الصفحة الحالية، إذا كان متاحا.	لا
has_more	boolean	علامة تشير إلى ما إذا كان هناك المزيد من الوظائف المتاحة بعد القائمة.	‏‏نعم‬
last_id	string	معرف آخر فيديو في الصفحة الحالية، إذا كان متاحا.	لا
object	enum	القيم المحتملة: list	‏‏نعم‬

VideoResource

معلومات منظمة تصف وظيفة فيديو مولدة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
completed_at	integer	طابع زمني (ثواني) ليونكس عند اكتمال المهمة، إذا تم الانتهاء.	لا
created_at	integer	طابع يونكس الزمني (ثواني) لوقت إنشاء الوظيفة.	‏‏نعم‬
خطأ	خطأ		لا
└─ كود	string		‏‏نعم‬
└─ رسالة	string		‏‏نعم‬
expires_at	integer	طابع الزمني (الثواني) ليونكس لانتهاء صلاحية إنتاج الفيديو (وسيتم حذفه).	لا
المعرف	string	معرف فريد لوظيفة الفيديو.	‏‏نعم‬
نموذج	string	نشر نموذج توليد الفيديو الذي أنتج المهمة.	‏‏نعم‬
object	string	نوع الكائن، الذي يتم videoدائما .	‏‏نعم‬
ترقى	integer	نسبة الإكمال التقريبية لمهمة التوليد.	‏‏نعم‬
remixed_from_video_id	string	معرف الفيديو الأصلي إذا كان هذا الفيديو ريمكس.	لا
الثواني	فيديوثونز	تم دعم مدة المقطع، تقاس بالثواني.	‏‏نعم‬
size	حجم الفيديو	أبعاد الإخراج منسقة ك {width}x{height}.	‏‏نعم‬
الحالة	حالة الفيديو	حالة دورة حياة الفيديو المولد.	‏‏نعم‬

فيديوثونز

تم دعم مدة المقطع، تقاس بالثواني.

الخاصية	قيمة
الوصف	تم دعم مدة المقطع، تقاس بالثواني.
نوع	string
Values	4 8 12

حجم الفيديو

أبعاد الإخراج منسقة ك {width}x{height}.

الخاصية	قيمة
الوصف	أبعاد الإخراج منسقة ك {width}x{height}.
نوع	string
Values	720x1280 1280x720 1024x1792 1792x1024

حالة الفيديو

حالة دورة حياة الفيديو المولد.

الخاصية	قيمة
الوصف	حالة دورة حياة الفيديو المولد.
نوع	string
Values	queued in_progress completed failed