مرجع REST Project Microsoft Foundry

إصدار واجهة برمجة التطبيقات: 2025-11-15-preview

العوامل - إنشاء عامل

POST {endpoint}/agents?api-version=2025-11-15-preview

إنشاء العامل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	object		‏‏نعم‬
└─ نوع	AgentKind		لا
└─ rai_config	RaiConfig	تكوين فلترة محتوى الذكاء الاصطناعي المسؤول (RAI) وميزات الأمان.	لا
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string	الاسم الفريد الذي يعرف العامل. يمكن استخدام الاسم لاسترداد/تحديث/حذف العامل. - يجب أن تبدأ وتنتهي بأحرف أبجدية رقمية، - يمكن أن تحتوي على واصلات في المنتصف - يجب ألا يتجاوز 63 حرفا.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - وكلاء القائمة

GET {endpoint}/agents?api-version=2025-11-15-preview

ترجع قائمة كافة الوكلاء.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	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 لجلب الصفحة السابقة من القائمة.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

العوامل - الحصول على وكيل

GET {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

يسترجع العامل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم العامل المراد استرداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - عامل التحديث

POST {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم العامل المراد استرداده.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	object		‏‏نعم‬
└─ نوع	AgentKind		لا
└─ rai_config	RaiConfig	تكوين فلترة محتوى الذكاء الاصطناعي المسؤول (RAI) وميزات الأمان.	لا
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - حذف عامل

DELETE {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

حذف عامل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم العامل المراد حذفه.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - تحديث العامل من البيان

POST {endpoint}/agents/{agent_name}/import?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم العامل المراد تحديثه.

رأس الطلب

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - سرد عمليات حاوية العامل

GET {endpoint}/agents/{agent_name}/operations?api-version=2025-11-15-preview

سرد عمليات الحاوية لعامل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	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 لجلب الصفحة السابقة من القائمة.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

العوامل - الحصول على عملية حاوية العامل

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=2025-11-15-preview

احصل على حالة عملية حاوية لعامل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم الوكيل.
operation_id	path	‏‏نعم‬	string	معرف العملية.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	ApiErrorResponse أو ApiErrorResponse

العوامل - إنشاء إصدار عامل

POST {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

إنشاء إصدار عامل جديد.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	الاسم الفريد الذي يعرف العامل. يمكن استخدام الاسم لاسترداد/تحديث/حذف العامل. - يجب أن تبدأ وتنتهي بأحرف أبجدية رقمية، - يمكن أن تحتوي على واصلات في المنتصف - يجب ألا يتجاوز 63 حرفا.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	object		‏‏نعم‬
└─ نوع	AgentKind		لا
└─ rai_config	RaiConfig	تكوين فلترة محتوى الذكاء الاصطناعي المسؤول (RAI) وميزات الأمان.	لا
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - إصدارات عامل القائمة

GET {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

إرجاع قائمة إصدارات العامل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	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 لجلب الصفحة السابقة من القائمة.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

العوامل - الحصول على إصدار العامل

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

استرداد إصدار معين من وكيل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم العامل المراد استرداده.
agent_version	path	‏‏نعم‬	string	إصدار العامل المراد استرداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - حذف إصدار العامل

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

حذف إصدار معين من وكيل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم العامل المراد حذفه.
agent_version	path	‏‏نعم‬	string	إصدار العامل المراد حذفه

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - الحصول على حاوية الوكيل

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=2025-11-15-preview

الحصول على حاوية لإصدار معين من عامل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم الوكيل.
agent_version	path	‏‏نعم‬	string	إصدار العامل.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	عاملContainerObject

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

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

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

العوامل - سرد عمليات حاوية إصدار عامل

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=2025-11-15-preview

سرد عمليات الحاوية لإصدار معين من عامل.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم الوكيل.
agent_version	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 لجلب الصفحة السابقة من القائمة.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

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

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=2025-11-15-preview

حذف حاوية لإصدار معين من عامل. إذا لم تكن الحاوية موجودة، no-opالعملية . العملية هي عملية طويلة الأمد. اتباع إرشادات التصميم للعمليات طويلة الأمد في واجهات برمجة تطبيقات REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم الوكيل.
agent_version	path	‏‏نعم‬	string	إصدار العامل.

رأس الطلب

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

الاستجابات

رمز الحالة: 202

الوصف: تم قبول الطلب للمعالجة، ولكن لم تكتمل المعالجة بعد.

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

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

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

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

العوامل - بدء حاوية العامل

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=2025-11-15-preview

بدء تشغيل حاوية لإصدار معين من عامل. إذا كانت الحاوية قيد التشغيل بالفعل، no-opالعملية . العملية هي عملية طويلة الأمد. اتباع إرشادات التصميم للعمليات طويلة الأمد في واجهات برمجة تطبيقات REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم الوكيل.
agent_version	path	‏‏نعم‬	string	إصدار العامل.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_replicas	integer	الحد الأقصى لعدد النسخ المتماثلة. الإعدادات الافتراضية إلى 1.	لا	1
min_replicas	integer	الحد الأدنى لعدد النسخ المتماثلة. الإعدادات الافتراضية إلى 1.	لا	1

الاستجابات

رمز الحالة: 202

الوصف: تم قبول الطلب للمعالجة، ولكن لم تكتمل المعالجة بعد.

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

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

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

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

العوامل - إيقاف حاوية العامل

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=2025-11-15-preview

إيقاف حاوية لإصدار معين من عامل. إذا لم تكن الحاوية قيد التشغيل، أو تم إيقافها بالفعل، no-opالعملية . العملية هي عملية طويلة الأمد. اتباع إرشادات التصميم للعمليات طويلة الأمد في واجهات برمجة تطبيقات REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم الوكيل.
agent_version	path	‏‏نعم‬	string	إصدار العامل.

رأس الطلب

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

الاستجابات

رمز الحالة: 202

الوصف: تم قبول الطلب للمعالجة، ولكن لم تكتمل المعالجة بعد.

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

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

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

Content-Type	Type	الوصف
application/json	ApiErrorResponse أو ApiErrorResponse

العوامل - تحديث حاوية العامل

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=2025-11-15-preview

تحديث حاوية لإصدار معين من عامل. إذا لم تكن الحاوية قيد التشغيل، no-opالعملية . العملية هي عملية طويلة الأمد. اتباع إرشادات التصميم للعمليات طويلة الأمد في واجهات برمجة تطبيقات REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	اسم الوكيل.
agent_version	path	‏‏نعم‬	string	إصدار العامل.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_replicas	integer	الحد الأقصى لعدد النسخ المتماثلة.	لا
min_replicas	integer	الحد الأدنى لعدد النسخ المتماثلة.	لا

الاستجابات

رمز الحالة: 202

الوصف: تم قبول الطلب للمعالجة، ولكن لم تكتمل المعالجة بعد.

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

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

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

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

العوامل - إنشاء إصدار عامل من البيان

POST {endpoint}/agents/{agent_name}/versions:import?api-version=2025-11-15-preview

قم بإنشاء إصدار وكيل جديد من بيان.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
agent_name	path	‏‏نعم‬	string	الاسم الفريد الذي يعرف العامل. يمكن استخدام الاسم لاسترداد/تحديث/حذف العامل. - يجب أن تبدأ وتنتهي بأحرف أبجدية رقمية، - يمكن أن تحتوي على واصلات في المنتصف - يجب ألا يتجاوز 63 حرفا.

رأس الطلب

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

العوامل - إنشاء عامل من البيان

POST {endpoint}/agents:import?api-version=2025-11-15-preview

ينشئ وكيلا من بيان.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
manifest_id	string	معرف البيان لاستيراد إصدار العامل منه.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string	الاسم الفريد الذي يعرف العامل. يمكن استخدام الاسم لاسترداد/تحديث/حذف العامل. - يجب أن تبدأ وتنتهي بأحرف أبجدية رقمية، - يمكن أن تحتوي على واصلات في المنتصف - يجب ألا يتجاوز 63 حرفا.	‏‏نعم‬
parameter_values	object	المدخلات إلى البيان التي ستؤدي إلى عامل مجسد بالكامل.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

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

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

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

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

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

الاتصالات - قائمة

GET {endpoint}/connections?api-version=2025-11-15-preview

سرد كافة الاتصالات في project، دون ملء بيانات اعتماد الاتصال

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
connectionType	استعلام	لا		سرد الاتصالات من هذا النوع المحدد
التوصيل الافتراضي	استعلام	لا	boolean	سرد الاتصالات التي تعد اتصالات افتراضية
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الاتصالات - الحصول على

GET {endpoint}/connections/{name}?api-version=2025-11-15-preview

الحصول على اتصال بالاسم، دون ملء بيانات اعتماد الاتصال

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	الاسم المألوف للاتصال، الذي يوفره المستخدم.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الاتصالات - الحصول على بيانات الاعتماد

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=2025-11-15-preview

الحصول على اتصال بالاسم، مع بيانات اعتماد الاتصال الخاصة به

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	الاسم المألوف للاتصال، الذي يوفره المستخدم.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

مجموعات البيانات - أحدث قائمة

GET {endpoint}/datasets?api-version=2025-11-15-preview

سرد أحدث إصدار من كل DatasetVersion

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

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

GET {endpoint}/datasets/{name}/versions?api-version=2025-11-15-preview

سرد جميع إصدارات DatasetVersion المحددة

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

مجموعات البيانات - الحصول على الإصدار

GET {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	معرف الإصدار المحدد من DatasetVersion لاسترداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	إصدار مجموعة البيانات

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

مجموعات البيانات - حذف الإصدار

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

احذف الإصدار المحدد من DatasetVersion. ترجع الخدمة 204 لا يوجد محتوى إذا تم حذف DatasetVersion بنجاح أو إذا لم يكن DatasetVersion موجودا.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	إصدار DatasetVersion المراد حذفه.

رأس الطلب

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

الاستجابات

رمز الحالة: 204

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

مجموعات البيانات - إنشاء إصدار أو تحديثه

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

إنشاء DatasetVersion جديد أو تحديث DatasetVersion موجود باستخدام معرف الإصدار المحدد

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	معرف الإصدار المحدد من DatasetVersion للإنشاء أو التحديث.

رأس الطلب

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

نص الطلب

Content-Type: application/merge-patch+json

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	إصدار مجموعة البيانات

رمز الحالة: 201

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

Content-Type	Type	الوصف
application/json	إصدار مجموعة البيانات

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

مجموعات البيانات - الحصول على بيانات الاعتماد

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=2025-11-15-preview

احصل على بيانات اعتماد SAS access حساب storage المقترن بإصدار مجموعة بيانات.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	معرف الإصدار المحدد من DatasetVersion للعمل عليه.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

مجموعات البيانات - بدء إصدار التحميل المعلق

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=2025-11-15-preview

ابدأ جديدا أو احصل على تحميل معلق حالي لمجموعة بيانات لإصدار معين.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	معرف الإصدار المحدد من DatasetVersion للعمل عليه.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
اسم الاتصال	string	اسم اتصال حساب Azure Storage لاستخدامه لإنشاء رمز SAS المميز المؤقت	لا
pendingUploadId	string	إذا لم يتم توفير PendingUploadId، استخدام GUID عشوائي.	لا
pendingUploadType	enum	BlobReference هو النوع الوحيد المدعوم. القيم المحتملة: BlobReference	‏‏نعم‬

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

عمليات التوزيع - قائمة

GET {endpoint}/deployments?api-version=2025-11-15-preview

سرد جميع النماذج المنشورة في project

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
modelPublisher	استعلام	لا	string	publisher النموذج لتصفية النماذج حسب
modelName	استعلام	لا	string	اسم النموذج (اسم publisher المحدد) لتصفية النماذج حسب
deploymentType	استعلام	لا		نوع التوزيع لتصفية القائمة حسب
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

عمليات التوزيع - الحصول على

GET {endpoint}/deployments/{name}?api-version=2025-11-15-preview

الحصول على نموذج منشور.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم النشر
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	نشر

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

قواعد التقييم - قائمة

GET {endpoint}/evaluationrules?api-version=2025-11-15-preview

ضع قائمة بجميع قواعد التقييم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
نوع الإجراء	استعلام	لا		التصفية حسب نوع قاعدة التقييم.
اسم العامل	استعلام	لا	string	التصفية حسب اسم الوكيل.
مُمكَّن	استعلام	لا	boolean	التصفية حسب الحالة المفعلة.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

قواعد التقييم - الحصول على

GET {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

احصل على قاعدة تقييم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
المعرف	path	‏‏نعم‬	string	معرف فريد لقاعدة التقييم.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	قاعدة التقييم

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

قواعد التقييم - حذف

DELETE {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

حذف قاعدة تقييم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
المعرف	path	‏‏نعم‬	string	معرف فريد لقاعدة التقييم.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 204

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

قواعد التقييم - إنشاء أو تحديث

PUT {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

إنشاء قاعدة تقييم أو تحديثها.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
المعرف	path	‏‏نعم‬	string	معرف فريد لقاعدة التقييم.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	object	نموذج عمل التقييم.	‏‏نعم‬
└─ النوع	نوع تقييمRuleActionType	نوع إجراء التقييم.	لا
الوصف	string	وصف قاعدة التقييم.	لا
displayName	string	اسم العرض لقاعدة التقييم.	لا
مُمكَّن	boolean	يشير إلى ما إذا كانت قاعدة التقييم ممكنة أم لا. الافتراضي صحيح.	‏‏نعم‬
eventType	object	نوع حدث قاعدة التقييم.	‏‏نعم‬
filter	object	نموذج مرشح التقييم.	لا
└─ agentName	string	التصفية حسب اسم الوكيل.	لا
المعرف	string	معرف فريد لقاعدة التقييم.	‏‏نعم‬
بيانات النظام	object	بيانات تعريف النظام لقاعدة التقييم.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	قاعدة التقييم

رمز الحالة: 201

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

Content-Type	Type	الوصف
application/json	قاعدة التقييم

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

تصنيفات التقييم - قائمة

GET {endpoint}/evaluationtaxonomies?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
اسم الإدخال	استعلام	لا	string	قم بالفلترة حسب اسم إدخال التقييم.
نوع الإدخال	استعلام	لا	string	تصفية حسب نوع إدخال التصنيف.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

تصنيفات التقييم - الحصول على

GET {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

احصل على تقييم يتم تشغيله بالاسم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	تقييم الxonomy

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

تصنيفات التقييم - حذف

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

حذف تصنيف تقييم حسب الاسم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 204

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

تصنيفات التقييم - إنشاء

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

إنشاء تصنيف تقييم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم تصنيف التقييم.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	نص وصف الأصل.	لا
خصائص	object	خصائص إضافية لتصنيف التقييم.	لا
العلامات	object	قاموس العلامات. يمكن إضافة العلامات وإزالتها وتحديثها.	لا
فئات التصنيف	صفيف	قائمة فئات التصنيف.	لا
معدل التصنيف	object	تكوين الإدخال لتصنيف التقييم.	‏‏نعم‬
└─ النوع	نوع بيانات التقييم	نوع الإدخال لتصنيف التقييم.	لا

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	تقييم الxonomy

رمز الحالة: 201

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

Content-Type	Type	الوصف
application/json	تقييم الxonomy

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

تصنيفات التقييم - تحديث

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم تصنيف التقييم.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	نص وصف الأصل.	لا
خصائص	object	خصائص إضافية لتصنيف التقييم.	لا
العلامات	object	قاموس العلامات. يمكن إضافة العلامات وإزالتها وتحديثها.	لا
فئات التصنيف	صفيف	قائمة فئات التصنيف.	لا
معدل التصنيف	object	تكوين الإدخال لتصنيف التقييم.	لا
└─ النوع	نوع بيانات التقييم	نوع الإدخال لتصنيف التقييم.	لا

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	تقييم الxonomy

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

المقيمون - سرد أحدث الإصدارات

GET {endpoint}/evaluators?api-version=2025-11-15-preview

سرد أحدث إصدار من كل مقيم

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
النوع	استعلام	لا		تصفية المقيمين حسب النوع. القيم المحتملة: "الكل" ، "المخصص" ، "المضمن".
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

المقيمون - إصدارات القائمة

GET {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

سرد جميع إصدارات المقيم المحدد

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
النوع	استعلام	لا		تصفية المقيمين حسب النوع. القيم المحتملة: "الكل" ، "المخصص" ، "المضمن".
الحد	استعلام	لا	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

المقيمون - إنشاء إصدار

POST {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

إنشاء EvaluatorVersion جديد باستخدام معرف الإصدار المتزايد تلقائيا

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
فئات	صفيف	فئات المقيم	‏‏نعم‬
تعريف	object	تكوين المقيم الأساسي مع المميز	‏‏نعم‬
└─ data_schema		مخطط JSON (مسودة 2020-12) لبيانات إدخال المقيم. يتضمن ذلك معلمات مثل النوع والخصائص المطلوبة.	لا
└─ init_parameters		مخطط JSON (مسودة 2020-12) لمعلمات إدخال المقيم. يتضمن ذلك معلمات مثل النوع والخصائص المطلوبة.	لا
└─ المقاييس	object	قائمة مقاييس المخرجات التي أنتجها هذا المقيم	لا
└─ النوع	نوع تعريف التقييم	نوع تعريف المقيم	لا
الوصف	string	نص وصف الأصل.	لا
display_name	string	اسم العرض للمقيم. يساعد على العثور على المقيم بسهولة في Foundry. لا يجب أن تكون فريدة من نوعها.	لا
evaluator_type	object	نوع المقيم	‏‏نعم‬
metadata	object	بيانات التعريف حول المقيم	لا
العلامات	object	قاموس العلامات. يمكن إضافة العلامات وإزالتها وتحديثها.	لا

الاستجابات

رمز الحالة: 201

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

Content-Type	Type	الوصف
application/json	إصدار المقيم

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

المقيمون - الحصول على الإصدار

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

احصل على الإصدار المحدد من EvaluatorVersion. ترجع الخدمة خطأ 404 لم يتم العثور عليه إذا لم يكن EvaluatorVersion موجودا.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	معرف الإصدار المحدد من مقيمVersion لاسترداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	إصدار المقيم

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

المقيمون - حذف الإصدار

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

احذف الإصدار المحدد من EvaluatorVersion. تقوم الخدمة بإرجاع 204 لا يوجد محتوى إذا تم حذف EvaluatorVersion بنجاح أو إذا لم يكن EvaluatorVersion موجودا.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	إصدار التقييم المراد حذفه.

رأس الطلب

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

الاستجابات

رمز الحالة: 204

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

المقيمون - تحديث الإصدار

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

قم بتحديث EvaluatorVersion موجود بمعرف الإصدار المحدد

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	إصدار التقييم للتحديث.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
فئات	صفيف	فئات المقيم	لا
الوصف	string	نص وصف الأصل.	لا
display_name	string	اسم العرض للمقيم. يساعد على العثور على المقيم بسهولة في Foundry. لا يجب أن تكون فريدة من نوعها.	لا
metadata	object	بيانات التعريف حول المقيم	لا
العلامات	object	قاموس العلامات. يمكن إضافة العلامات وإزالتها وتحديثها.	لا

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	إصدار المقيم

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الفهارس - أحدث قائمة

GET {endpoint}/indexes?api-version=2025-11-15-preview

سرد أحدث إصدار من كل فهرس

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الفهارس - إصدارات القائمة

GET {endpoint}/indexes/{name}/versions?api-version=2025-11-15-preview

سرد جميع إصدارات الفهرس المحدد

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الفهارس - الحصول على الإصدار

GET {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	معرف الإصدار المحدد من الفهرس المراد استرداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	الفهرس

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الفهارس - حذف الإصدار

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	إصدار الفهرس المراد حذفه.

رأس الطلب

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

الاستجابات

رمز الحالة: 204

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الفهارس - إنشاء إصدار أو تحديثه

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

إنشاء فهرس جديد أو تحديث فهرس موجود باستخدام معرف الإصدار المحدد

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم المورد
إصدار	path	‏‏نعم‬	string	معرف الإصدار المحدد من الفهرس المراد إنشاؤه أو تحديثه.

رأس الطلب

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

نص الطلب

Content-Type: application/merge-patch+json

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	الفهرس

رمز الحالة: 201

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

Content-Type	Type	الوصف
application/json	الفهرس

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

نتائج التحليلات - إنشاء

POST {endpoint}/insights?api-version=2025-11-15-preview

توليد رؤى

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
إمكانية التكرار -Request-ID	header	لا	string	معرف فريد من نوعه تم إنشاؤه بواسطة العميل لضمان هوية الطلب. استخدم المعرف نفسه لعمليات إعادة المحاولة لمنع التقييمات المكررة.
إمكانية التكرار -First-Sent	header	لا	string	الطابع الزمني الذي يشير إلى وقت بدء هذا الطلب لأول مرة. يستخدم بالاقتران مع معرف طلب التكرار للتحكم في القدرة المساعدة.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
displayName	string	اسم عرض سهل الاستخدام للبصيرة.	‏‏نعم‬
المعرف	string	المعرف الفريد لتقرير الإحصاءات.	‏‏نعم‬
metadata	object	البيانات الوصفية حول الرؤى.	‏‏نعم‬
└─ completedAt	string	الطابع الزمني عند اكتمال الرؤى.	لا
└─ createdAt	string	الطابع الزمني عند إنشاء الرؤى.	لا
طلب	object	طلب تقرير الإحصاءات.	‏‏نعم‬
└─ النوع	InsightType	نوع الطلب.	لا
نتيجة	object	نتيجة الرؤى.	لا
└─ النوع	InsightType	نوع نتيجة الرؤى.	لا
حالة	object	Enum يصف حالات التشغيل المسموح بها.	‏‏نعم‬

الاستجابات

رمز الحالة: 201

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

Content-Type	Type	الوصف
application/json	البصيره

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

نتائج التحليلات - القائمة

GET {endpoint}/insights?api-version=2025-11-15-preview

ضع قائمة بجميع الرؤى بترتيب زمني عكسي (الأحدث أولا).

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
النوع	استعلام	لا		التصفية حسب نوع التحليل.
معرف التقييم	استعلام	لا	string	التصفية حسب معرف التقييم.
runId	استعلام	لا	string	قم بالتصفية حسب معرف تشغيل التقييم.
اسم العامل	استعلام	لا	string	التصفية حسب اسم الوكيل.
تضمين التبعيات	استعلام	لا	boolean	ما إذا كان يجب تضمين إحداثيات للتصور في الاستجابة. الإعدادات الافتراضية إلى false.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

نتائج التحليلات - الحصول على

GET {endpoint}/insights/{id}?api-version=2025-11-15-preview

احصل على نظرة ثاقبة محددة عن طريق المعرف.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
المعرف	path	‏‏نعم‬	string	المعرف الفريد لتقرير الإحصاءات.
تضمين التبعيات	استعلام	لا	boolean	ما إذا كان يجب تضمين إحداثيات للتصور في الاستجابة. الإعدادات الافتراضية إلى false.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	البصيره

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

إنشاء مخزن ذاكرة

POST {endpoint}/memory_stores?api-version=2025-11-15-preview

قم بإنشاء مخزن ذاكرة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	object	التعريف الأساسي لتكوينات مخزن الذاكرة.	‏‏نعم‬
└─ نوع	MemoryStoreKind	نوع مخزن الذاكرة.	لا
الوصف	string	وصف يمكن للإنسان قراءته لمخزن الذاكرة.	لا
metadata	object	بيانات تعريف قيمة المفتاح العشوائية لإقرانها بمخزن الذاكرة.	لا
الاسم	string	اسم مخزن الذاكرة.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

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

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

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

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

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

قائمة مخازن الذاكرة

GET {endpoint}/memory_stores?api-version=2025-11-15-preview

ضع قائمة بجميع مخازن الذاكرة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	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 لجلب الصفحة السابقة من القائمة.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

تحديث مخزن الذاكرة

POST {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

قم بتحديث مخزن ذاكرة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم مخزن الذاكرة المراد تحديثه.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف يمكن للإنسان قراءته لمخزن الذاكرة.	لا
metadata	object	بيانات تعريف قيمة المفتاح العشوائية لإقرانها بمخزن الذاكرة.	لا

الاستجابات

رمز الحالة: 200

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

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

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

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

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

الحصول على مخزن الذاكرة

GET {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

استرداد مخزن ذاكرة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم مخزن الذاكرة المراد استرداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

حذف مخزن الذاكرة

DELETE {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

حذف مخزن ذاكرة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم مخزن الذاكرة المراد حذفه.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

الحصول على نتيجة التحديث

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=2025-11-15-preview

احصل على نتيجة تحديث مخزن الذاكرة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم مخزن الذاكرة.
update_id	path	‏‏نعم‬	string	معرف عملية تحديث الذاكرة.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

حذف ذكريات النطاق

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=2025-11-15-preview

حذف جميع الذكريات المرتبطة بنطاق معين من مخزن ذاكرة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم مخزن الذاكرة.

رأس الطلب

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

ذكريات البحث

POST {endpoint}/memory_stores/{name}:search_memories?api-version=2025-11-15-preview

ابحث عن الذكريات ذات الصلة من مخزن الذاكرة بناء على سياق المحادثة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم مخزن الذاكرة للبحث.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
items	صفيف	العناصر التي يمكن البحث عنها عن الذكريات ذات الصلة.	لا
options	object	خيارات البحث عن الذاكرة.	لا
└─ max_memories	integer	الحد الأقصى لعدد عناصر الذاكرة المراد إرجاعها.	لا
previous_search_id	string	المعرف الفريد لطلب البحث السابق، مما يتيح البحث عن الذاكرة المتزايدة من حيث توقفت العملية الأخيرة.	لا
نطاق	string	مساحة الاسم التي تجمع الذكريات وتعزلها منطقيا، مثل معرف المستخدم.	‏‏نعم‬

الاستجابات

رمز الحالة: 200

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

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

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

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

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

تحديث الذكريات

POST {endpoint}/memory_stores/{name}:update_memories?api-version=2025-11-15-preview

قم بتحديث مخزن الذاكرة بذكريات المحادثة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	اسم مخزن الذاكرة المراد تحديثه.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
items	صفيف	عناصر المحادثة التي يمكن استخراج الذكريات منها.	لا
previous_update_id	string	المعرف الفريد لطلب التحديث السابق، مما يتيح تحديثات الذاكرة المتزايدة من حيث توقفت العملية الأخيرة.	لا
نطاق	string	مساحة الاسم التي تجمع الذكريات وتعزلها منطقيا، مثل معرف المستخدم.	‏‏نعم‬
update_delay	integer	فترة المهلة قبل معالجة تحديث الذاكرة في ثوان. إذا تم تلقي طلب تحديث جديد خلال هذه الفترة، إلغاء الطلب الحالي وإعادة تعيين المهلة. اضبط على 0 لتشغيل التحديث على الفور دون تأخير. الإعداد الافتراضي إلى 300 (5 دقائق).	لا	300

الاستجابات

رمز الحالة: 202

الوصف: تم قبول الطلب للمعالجة، ولكن لم تكتمل المعالجة بعد.

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

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

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

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

إنشاء محادثة

POST {endpoint}/openai/conversations?api-version=2025-11-15-preview

إنشاء محادثة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

سرد المحادثات

GET {endpoint}/openai/conversations?api-version=2025-11-15-preview

إرجاع قائمة بجميع المحادثات.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	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 لجلب الصفحة السابقة من القائمة.
agent_name	استعلام	لا	string	التصفية حسب اسم الوكيل. إذا تم توفيرها، سيتم إرجاع العناصر المقترنة بالعامل المحدد فقط.
agent_id	استعلام	لا	string	تصفية حسب معرف العامل بالتنسيق name:version. إذا تم توفيرها، إرجاع العناصر المقترنة بمعرف العامل المحدد فقط.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

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

POST {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
conversation_id	path	‏‏نعم‬	string	معرف المحادثة المراد تحديثها.

رأس الطلب

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

الحصول على محادثة

GET {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

استرداد محادثة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
conversation_id	path	‏‏نعم‬	string	معرف المحادثة المراد استردادها.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

حذف المحادثة

DELETE {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

حذف محادثة.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
conversation_id	path	‏‏نعم‬	string	معرف المحادثة المراد حذفها.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

POST {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

إنشاء عناصر في محادثة باستخدام المعرف المحدد.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
conversation_id	path	‏‏نعم‬	string	معرف المحادثة التي يجب إنشاء العنصر عليها.
include	استعلام	لا	صفيف	حقول إضافية لتضمينها في الاستجابة. راجع المعلمة include لإدراج عناصر المحادثة للحصول على مزيد من المعلومات.

رأس الطلب

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

GET {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

سرد كافة العناصر لمحادثة بالمعرف المحدد.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
conversation_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 لجلب الصفحة السابقة من القائمة.
item_type	استعلام	لا		التصفية حسب نوع العنصر. إذا تم توفيرها، سيتم إرجاع العناصر من النوع المحدد فقط.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

الحصول على عنصر المحادثة

GET {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

احصل على عنصر واحد من محادثة مع المعرف المحدد.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
conversation_id	path	‏‏نعم‬	string	معرف المحادثة التي تحتوي على العنصر.
item_id	path	‏‏نعم‬	string	معرف عنصر المحادثة المراد استرداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	OpenAI.ItemResource

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

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

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

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

DELETE {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
conversation_id	path	‏‏نعم‬	string	معرف المحادثة التي يجب حذف العنصر منها.
item_id	path	‏‏نعم‬	string	معرف عنصر المحادثة المراد حذفه.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

OpenAI evals - قائمة التقييمات

GET {endpoint}/openai/evals?api-version=2025-11-15-preview

سرد كافة التقييمات سرد التقييمات project.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
after	استعلام	لا	string	معرف آخر تشغيل من طلب ترقيم الصفحات السابق.
الحد	استعلام	لا		عدد عمليات التشغيل المراد استردادها.
order	استعلام	لا	string القيم المحتملة: asc، desc	ترتيب الفرز للتشدير حسب الطابع الزمني. استخدم asc للترتيب التصاعدي أو desc لترتيب تنازلي. الإعدادات الافتراضية لـ asc.
order_by	استعلام	لا	string القيم المحتملة: created_at، updated_at	يمكن ترتيب التقييمات حسب وقت الإنشاء أو وقت التحديث الأخير. استخدام created_at لوقت الإنشاء أو updated_at لآخر وقت تم تحديثه.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

تقييم OpenAI - إنشاء تقييم

POST {endpoint}/openai/evals?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_source_config	object	كائن CustomDataSourceConfig الذي يعرف مخطط مصدر البيانات المستخدم في عمليات تشغيل التقييم. يستخدم هذا المخطط لتحديد شكل البيانات التي ستكون: - يستخدم لتحديد معايير الاختبار الخاصة بك و - ما هي البيانات المطلوبة عند إنشاء تشغيل	‏‏نعم‬
└─ include_sample_schema	boolean	ما إذا كان يجب أن يتوقع التقييم ملء مساحة الاسم النموذجية (أي عن طريق إنشاء استجابات من مصدر البيانات الخاص بك)	لا
└─ item_schema	object	مخطط json لكل صف في مصدر البيانات.	لا
└─ البيانات الوصفية	object	عوامل تصفية بيانات التعريف لمصدر بيانات الاكتمال المخزنة.	لا
└─ السيناريو	enum	سيناريو مخطط البيانات. القيم المحتملة: red_team، ، responsestraces	لا
└─ النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: azure_ai_source	لا
metadata	OpenAI.Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string	اسم التقييم.	لا
خصائص	object	مجموعة من أزواج قيم المفاتيح غير القابلة للتغيير والتي يمكن إرفاقها بعنصر لتخزين معلومات إضافية. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
testing_criteria	صفيف	يتم تشغيل قائمة بالدرجات لجميع التقييمات في هذه المجموعة. يمكن لمصنفي التقديرات الرجوع إلى المتغيرات في مصدر البيانات باستخدام تدوين الأقواس المتعرجة المزدوجة، مثل {{item.variable_name}}. للإشارة إلى إخراج النموذج ، استخدم sample مساحة الاسم (على سبيل المثال ، {{sample.output_text}}).	‏‏نعم‬

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	تقييم

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

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

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

تقييم OpenAI - حذف التقييم

DELETE {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم المراد حذفه.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

تقييم OpenAI - الحصول على تقييم

GET {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

الحصول على تقييم احصل على تقييم حسب المعرف.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم المراد استرداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	تقييم

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

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

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

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

POST {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

تحديث تقييم تحديث خصائص معينة للتقييم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم المراد تحديثه.

رأس الطلب

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	تقييم

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

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

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

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

GET {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

احصل على قائمة عمليات التشغيل للتقييم احصل على قائمة عمليات التشغيل للتقييم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم لاسترداد عمليات التشغيل.
after	استعلام	لا	string	معرف آخر تشغيل من طلب ترقيم الصفحات السابق.
الحد	استعلام	لا		عدد عمليات التشغيل المراد استردادها.
order	استعلام	لا	string القيم المحتملة: asc، desc	ترتيب الفرز للتشدير حسب الطابع الزمني. استخدم asc للترتيب التصاعدي أو desc لترتيب تنازلي. الإعدادات الافتراضية لـ asc.
الحالة	استعلام	لا	string القيم المحتملة: queued، in_progress، completed، canceled، . failed يتم تشغيل عامل التصفية حسب الحالة. واحد من queued، in_progress، failed، completed، . canceled

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

تقييم OpenAI - إنشاء تشغيل التقييم

POST {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم لإنشاء تشغيل له.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_source	object	كائن JsonlRunDataSource مع الذي يحدد ملف JSONL الذي يطابق التقييم	‏‏نعم‬
└─ input_messages	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate أو OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	يستخدم عند أخذ العينات من نموذج. تملي بنية الرسائل التي تم تمريرها إلى النموذج. يمكن أن يكون إما مرجعا لمسار تم إنشاؤه مسبقا (أي)، item.input_trajectoryأو قالب مع مراجع متغيرة item لمساحة الاسم.	لا
└─ item_generation_params	RedTeamItemGenerationParams	معلمات إنشاء العنصر.	لا
└─ نموذج	string	اسم النموذج المراد استخدامه لإنشاء عمليات الإكمال (على سبيل المثال "o3-mini").	لا
└─ sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		لا
└─ المصدر	OpenAI.EvalJsonlFileContentSource أو OpenAI.EvalJsonlFileIdSource أو OpenAI.EvalResponsesSource	تحديد ما يملأ item مساحة الاسم في مصدر بيانات هذا التشغيل.	لا
└─ الهدف	الهدف	التكوين الهدف للتقييم.	لا
└─ النوع	string	نوع مصدر البيانات تمييزي.	لا
metadata	OpenAI.Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string	اسم التشغيل.	لا
خصائص	object	مجموعة من أزواج قيم المفاتيح غير القابلة للتغيير والتي يمكن إرفاقها بعنصر لتخزين معلومات إضافية. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا

الاستجابات

رمز الحالة: 200

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

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

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

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

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

OpenAI evals - حذف تشغيل التقييم

DELETE {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

حذف تشغيل التقييم حذف عملية تقييم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم لحذف التشغيل منه.
run_id	path	‏‏نعم‬	string	معرف التشغيل المراد حذفه.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	حذفEvalRunResponse

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

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

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

OpenAI evals - الحصول على تقييم التشغيل

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم لاسترداد عمليات التشغيل.
run_id	path	‏‏نعم‬	string	معرف التشغيل المراد استرداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

POST {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

إلغاء تشغيل التقييم إلغاء تشغيل تقييم مستمر.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم الذي تريد إلغاء تشغيله.
run_id	path	‏‏نعم‬	string	معرف التشغيل لإلغاء الأمر.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

OpenAI evals - الحصول على عناصر إخراج تشغيل التقييم

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string
run_id	path	‏‏نعم‬	string	معرف التشغيل لاسترداد عناصر الإخراج له.
after	استعلام	لا	string	معرف آخر تشغيل من طلب ترقيم الصفحات السابق.
الحد	استعلام	لا		عدد عمليات التشغيل المراد استردادها.
order	استعلام	لا	string القيم المحتملة: asc، desc	ترتيب الفرز للتشدير حسب الطابع الزمني. استخدم asc للترتيب التصاعدي أو desc لترتيب تنازلي. الإعدادات الافتراضية لـ asc.
الحالة	استعلام	لا	string القيم المحتملة: fail، pass	تصفية عناصر الإخراج حسب الحالة. استخدم failed للتصفية حسب الإخراج الفاشل العناصر أو pass للتصفية حسب عناصر الإخراج التي تم تمريرها.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

OpenAI evals - الحصول على عنصر إخراج تشغيل التقييم

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
eval_id	path	‏‏نعم‬	string	معرف التقييم لاسترداد عمليات التشغيل.
run_id	path	‏‏نعم‬	string	معرف التشغيل المراد استرداده.
output_item_id	path	‏‏نعم‬	string	معرف عنصر الإخراج المراد استرداده.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

POST {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

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

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

تعرف على المزيد حول الضبط الدقيق

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

نص الطلب

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

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

GET {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
after	استعلام	لا	string	معرف الوظيفة الأخيرة من طلب ترقيم الصفحات السابق.
الحد	استعلام	لا	integer	عدد مهام الضبط الدقيق المطلوب استردادها.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}?api-version=2025-11-15-preview

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

تعرف على المزيد حول الضبط الدقيق

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
fine_tuning_job_id	path	‏‏نعم‬	string	معرف مهمة الضبط الدقيق.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/cancel?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
fine_tuning_job_id	path	‏‏نعم‬	string	معرف مهمة الضبط الدقيق المراد إلغاؤها.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
fine_tuning_job_id	path	‏‏نعم‬	string	معرف وظيفة الضبط الدقيق للحصول على نقاط تفتيش.
after	استعلام	لا	string	معرف معرف نقطة التحقق الأخير من طلب ترقيم الصفحات السابق.
الحد	استعلام	لا	integer	عدد نقاط التحقق المراد استردادها.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/events?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
fine_tuning_job_id	path	‏‏نعم‬	string	معرف مهمة الضبط الدقيق للحصول على الأحداث الخاصة بها.
after	استعلام	لا	string	معرف الحدث الأخير من طلب ترقيم الصفحات السابق.
الحد	استعلام	لا	integer	عدد الأحداث المراد استردادها.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/pause?api-version=2025-11-15-preview

إيقاف مهمة ضبط قيد التشغيل مؤقتا.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
fine_tuning_job_id	path	‏‏نعم‬	string	معرف مهمة الضبط الدقيق للإيقاف المؤقت.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

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

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/resume?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
fine_tuning_job_id	path	‏‏نعم‬	string	معرف مهمة الضبط الدقيق المراد استئنافها.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

إنشاء استجابة - إنشاء تدفق استجابة

POST {endpoint}/openai/responses?api-version=2025-11-15-preview

ينشئ استجابة نموذجية. إنشاء استجابة نموذج (استجابة دفق).

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
agent	مرجع العامل	العامل المراد استخدامه لإنشاء الاستجابة.	لا
background	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
حوار	سلسلة أو كائن		لا
include	صفيف	حدد بيانات إخراج إضافية لتضمينها في استجابة النموذج. حاليا القيم المدعومة هي: - 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، أو عندما تكون المؤسسة مسجل في برنامج الاحتفاظ بالبيانات الصفرية).	لا
الادخال	سلسلة أو مجموعة	النص أو الصورة أو إدخالات الملفات إلى النموذج، المستخدمة لإنشاء استجابة. اعرف المزيد‬: مدخلات ومخرجات - Text إدخالات - Image إدخالات - File - إدارة حالة المحادثة - الاتصال الوظيفي	لا
تعليمات	string	رسالة نظام (أو مطور) مدرجة في سياق النموذج. عند الاستخدام جنبا إلى جنب مع previous_response_id، التعليمات من السابق لن يتم ترحيل الرد إلى الرد التالي. هذا يجعل الأمر بسيطا لتبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
فوري	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
المنطق	OpenAI.المنطق	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
service_tier	OpenAI.ServiceTier	ملاحظة: لا ينطبق service_tier على Azure OpenAI.	لا
store	boolean	ما إذا كان سيتم تخزين استجابة النموذج التي تم إنشاؤها لاستردادها لاحقا عبر واجهة برمجة التطبيقات.	لا	صحيح
استدر	boolean	إذا تم تعيينه إلى صواب، دفق بيانات استجابة النموذج إلى العميل حيث يتم إنشاؤه باستخدام الأحداث المرسلة من الخادم. للمزيد من المعلومات.	لا	خطأ
structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا	1
نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceObject	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق إمكانات النموذج، مثل البحث عن الملفات. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك.	لا
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا	1
اقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
user	string	تعرف على المزيد حول أفضل ممارسات السلامة.	لا

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	OpenAI.Response
نص/دفق الأحداث	OpenAI.ResponseStreamEvent

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

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

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

سرد الاستجابات

GET {endpoint}/openai/responses?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	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 لجلب الصفحة السابقة من القائمة.
agent_name	استعلام	لا	string	التصفية حسب اسم الوكيل. إذا تم توفيرها، سيتم إرجاع العناصر المقترنة بالعامل المحدد فقط.
agent_id	استعلام	لا	string	تصفية حسب معرف العامل بالتنسيق name:version. إذا تم توفيرها، إرجاع العناصر المقترنة بمعرف العامل المحدد فقط.
conversation_id	استعلام	لا	string	تصفية حسب معرف المحادثة. إذا تم توفيرها، إرجاع الاستجابات المقترنة بالمحادثة المحددة فقط.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

الحصول على الاستجابة - الحصول على تدفق الاستجابة

GET {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	لا	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
response_id	path	‏‏نعم‬	string
تشمل []	استعلام	لا	صفيف
استدر	استعلام	لا	boolean
starting_after	استعلام	لا	integer
تقبل	header	لا	string القيم المحتملة: text/event-stream

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	OpenAI.Response
نص/دفق الأحداث	OpenAI.ResponseStreamEvent

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

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

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

حذف الرد

DELETE {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

حذف استجابة نموذج.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
response_id	path	‏‏نعم‬	string	معرف الاستجابة للحذف.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

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

إلغاء الاستجابة

POST {endpoint}/openai/responses/{response_id}/cancel?api-version=2025-11-15-preview

إلغاء استجابة نموذج.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
response_id	path	‏‏نعم‬	string	معرف الاستجابة للإلغاء.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	OpenAI.Response

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

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

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

سرد عناصر الإدخال

GET {endpoint}/openai/responses/{response_id}/input_items?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
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 لجلب الصفحة السابقة من القائمة.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	object	بيانات الاستجابة لقائمة العناصر المطلوبة.

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

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

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

Redteams - قائمة

GET {endpoint}/redTeams/runs?api-version=2025-11-15-preview

سرد مجموعة إعادة حسب الاسم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

Redteams - الحصول على

GET {endpoint}/redTeams/runs/{name}?api-version=2025-11-15-preview

احصل على redteam بالاسم.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
الاسم	path	‏‏نعم‬	string	معرف تشغيل الفريق الأحمر.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

Redteams - إنشاء

POST {endpoint}/redTeams/runs:run?api-version=2025-11-15-preview

إنشاء تشغيل redteam.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
applicationScenario	string	سيناريو التطبيق لعملية الفريق الأحمر، لإنشاء هجمات محددة للسيناريو.	لا
حالات الهجوم	صفيف	قائمة استراتيجيات الهجوم أو القوائم المتداخلة لاستراتيجيات الهجوم.	لا
displayName	string	اسم تشغيل الفريق الأحمر.	لا
المعرف	string	معرف تشغيل الفريق الأحمر.	‏‏نعم‬
numTurns	integer	عدد جولات المحاكاة.	لا
خصائص	object	خصائص الفريق الأحمر. على عكس العلامات، تكون الخصائص مضافة فقط. بمجرد إضافته، لا يمكن إزالة الخاصية.	لا
فئات المخاطر	صفيف	قائمة بفئات المخاطر التي يجب إنشاء أهداف الهجوم لها.	لا
المحاكاة فقط	boolean	المحاكاة فقط أو المحاكاة + التقييم. خطأ افتراضي، إذا كان صحيحا، فإن المسح الضوئي يؤدي إلى إخراج المحادثة وليس نتيجة التقييم.	لا	خطأ
الحالة	string	حالة الفريق الأحمر. يتم تعيينه حسب الخدمة وهو للقراءة فقط.	لا
العلامات	object	علامات الفريق الأحمر. على عكس الخصائص ، تكون العلامات قابلة للتغيير بالكامل.	لا
target	object	فئة مجردة للتكوين المستهدف.	‏‏نعم‬
└─ النوع	string	نوع تكوين النموذج.	لا

الاستجابات

رمز الحالة: 201

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الجداول الزمنية - قائمة

GET {endpoint}/schedules?api-version=2025-11-15-preview

سرد جميع الجداول.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	جدول الصفحات

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الجداول الزمنية - حذف

DELETE {endpoint}/schedules/{id}?api-version=2025-11-15-preview

حذف جدول.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
المعرف	path	‏‏نعم‬	string	معرف الجدول الزمني.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 204

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الجداول الزمنية - الحصول على

GET {endpoint}/schedules/{id}?api-version=2025-11-15-preview

احصل على جدول زمني حسب الهوية.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
المعرف	path	‏‏نعم‬	string	معرف الجدول الزمني.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الجداول الزمنية - إنشاء أو تحديث

PUT {endpoint}/schedules/{id}?api-version=2025-11-15-preview

إنشاء جدول زمني أو تحديثه حسب المعرف.

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
المعرف	path	‏‏نعم‬	string	معرف الجدول الزمني.

رأس الطلب

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

نص الطلب

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف الجدول.	لا
displayName	string	اسم الجدول الزمني.	لا
مُمكَّن	boolean	حالة تمكين الجدول الزمني.	‏‏نعم‬
المعرف	string	معرف الجدول الزمني.	‏‏نعم‬
خصائص	object	خصائص الجدولة. على عكس العلامات، تكون الخصائص مضافة فقط. بمجرد إضافته، لا يمكن إزالة الخاصية.	لا
حالة التزويد	object	جدولة حالة التوفير.	لا
بيانات النظام	object	بيانات تعريف النظام للمورد.	‏‏نعم‬
العلامات	object	علامات الجدول. على عكس الخصائص ، تكون العلامات قابلة للتغيير بالكامل.	لا
مهمة	object	جدولة نموذج المهمة.	‏‏نعم‬
└─ التكوين	object	تكوين المهمة.	لا
└─ النوع	نوع جدولة المهام	نوع المهمة.	لا
trigger	object	النموذج الأساسي لمشغل الجدول.	‏‏نعم‬
└─ النوع	نوع الزناد	نوع الزناد.	لا

الاستجابات

رمز الحالة: 200

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

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

رمز الحالة: 201

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الجداول الزمنية - تشغيل القائمة

GET {endpoint}/schedules/{id}/runs?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
المعرف	path	‏‏نعم‬	string	معرف الجدول الزمني.
x-ms-client-request-id	header	لا		معرف سلسلة غير شفاف وفريد عالميا تم إنشاؤه بواسطة العميل للطلب.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

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

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

الجداول الزمنية - الحصول على التشغيل

GET {endpoint}/schedules/{scheduleId}/runs/{runId}?api-version=2025-11-15-preview

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

معلمات URI

الاسم	في	مطلوب	النوع	وصف
نقطه النهايه	path	‏‏نعم‬	string عنوان URL	نقطة نهاية Project في النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. إذا كان لديك Project واحد فقط في مركز Foundry، أو لاستهداف Project الافتراضي في Hub، فاستخدم النموذج https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
نسخة واجهة برمجة التطبيقات	استعلام	‏‏نعم‬	string	إصدار واجهة برمجة التطبيقات لاستخدامه لهذه العملية.
معرف الجدولة	path	‏‏نعم‬	string	معرف الجدول الزمني.
runId	path	‏‏نعم‬	string	معرف تشغيل الجدول الزمني.

رأس الطلب

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

الاستجابات

رمز الحالة: 200

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

Content-Type	Type	الوصف
application/json	جدولة تشغيل

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

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

Content-Type	Type	الوصف
application/json	Azure. Core.Foundations.ErrorResponse

مكونات

A2ATool

وكيل ينفذ بروتوكول A2A.

الاسم	النوع	وصف	مطلوب	الإفتراضي
agent_card_path	string	المسار إلى بطاقة الوكيل بالنسبة إلى نطاق base_url. إذا لم يتم توفيره، يتم توفيره افتراضيا إلى /.well-known/agent-card.json	لا
base_url	string	عنوان URL الأساسي للوكيل.	لا
project_connection_id	string	معرف الاتصال في project لخادم A2A. يخزن الاتصال المصادقة وتفاصيل الاتصال الأخرى اللازمة للاتصال بخادم A2A.	لا
النوع	enum	نوع الأداة. دائمًا a2a. القيم المحتملة: a2a_preview	‏‏نعم‬

AISearchIndexResource

مورد فهرس بحث الذكاء الاصطناعي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
filter	string	سلسلة التصفية لمورد البحث. تعرف على المزيد هنا.	لا
index_asset_id	string	معرف أصل الفهرس لمورد البحث.	لا
index_name	string	اسم فهرس في IndexResource مرفق بهذا العامل.	لا
project_connection_id	string	معرف اتصال فهرس في IndexResource مرفق بهذا العامل.	لا
query_type	object	أنواع الاستعلام المتوفرة لأداة Azure AI Search.	لا
top_k	integer	عدد المستندات المراد استردادها من البحث وتقديمها إلى النموذج.	لا

عاملClusterInsightResult

نتائج تحليلات من تحليل نظام مجموعة الوكيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
clusterInsight	ClusterInsightResult	نتائج تحليلات من تحليل نظام المجموعة.	‏‏نعم‬
النوع	enum	نوع نتيجة الرؤى. القيم المحتملة: AgentClusterInsight	‏‏نعم‬

طلب طلب العميلClusterInsights

رؤى حول مجموعة نتائج تقييم الوكيل

الاسم	النوع	وصف	مطلوب	الإفتراضي
اسم العامل	string	معرف الوكيل.	‏‏نعم‬
تكوين النموذج	object	تكوين النموذج المستخدم في إنشاء الرؤى.	لا
└─ modelDeploymentName	string	نشر النموذج المراد تقييمه. يقبل إما اسم النشر وحده أو باسم الاتصال ك {connectionName}/<modelDeploymentName>.	لا
النوع	enum	نوع الطلب. القيم المحتملة: AgentClusterInsight	‏‏نعم‬

عاملContainerObject

تفاصيل حاوية إصدار معين من عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	string	وقت إنشاء الحاوية.	‏‏نعم‬
error_message	string	رسالة الخطأ إذا فشلت الحاوية في العمل، إن وجدت.	لا
max_replicas	integer	الحد الأقصى لعدد النسخ المتماثلة للحاوية. القيمة الافتراضية هي 1.	لا
min_replicas	integer	الحد الأدنى لعدد النسخ المتماثلة للحاوية. القيمة الافتراضية هي 1.	لا
object	enum	نوع الكائن، وهو دائما "agent.container". القيم المحتملة: agent.container	‏‏نعم‬
الحالة	object	حالة الحاوية لإصدار معين من عامل.	‏‏نعم‬
updated_at	string	آخر وقت تحديث للحاوية.	‏‏نعم‬

عاملContainerOperationError

تفاصيل الخطأ لعملية الحاوية، إن وجدت.

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

AgentContainerOperationObject

عملية الحاوية لإصدار معين من عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
agent_id	string	هوية الْعامِلُ.	‏‏نعم‬
agent_version_id	string	معرف إصدار العامل.	‏‏نعم‬
container	object	تفاصيل حاوية إصدار معين من عامل.	لا
└─ created_at	string	وقت إنشاء الحاوية.	لا
└─ error_message	string	رسالة الخطأ إذا فشلت الحاوية في العمل، إن وجدت.	لا
└─ max_replicas	integer	الحد الأقصى لعدد النسخ المتماثلة للحاوية. القيمة الافتراضية هي 1.	لا
└─ min_replicas	integer	الحد الأدنى لعدد النسخ المتماثلة للحاوية. القيمة الافتراضية هي 1.	لا
└─ كائن	enum	نوع الكائن، وهو دائما "agent.container". القيم المحتملة: agent.container	لا
└─ الحالة	عاملContainerStatus	حالة الحاوية لإصدار معين من عامل.	لا
└─ updated_at	string	آخر وقت تحديث للحاوية.	لا
خطأ	object	تفاصيل الخطأ لعملية الحاوية، إن وجدت.	لا
└─ كود	string	رمز الخطأ لعملية الحاوية، إن وجدت.	لا
└─ رسالة	string	رسالة الخطأ لعملية الحاوية، إن وجدت.	لا
└─ النوع	string	نوع الخطأ لعملية الحاوية، إن وجدت.	لا
المعرف	string	معرف عملية الحاوية. هذا المعرف هو معرف فريد عبر النظام.	‏‏نعم‬
الحالة	object	حالة عملية الحاوية لإصدار معين من عامل.	‏‏نعم‬

عاملContainerOperationStatus

حالة عملية الحاوية لإصدار معين من عامل.

الخاصية	قيمة
الوصف	حالة عملية الحاوية لإصدار معين من عامل.
Type	string
Values	NotStarted InProgress Succeeded Failed

عاملContainerStatus

حالة الحاوية لإصدار معين من عامل.

الخاصية	قيمة
الوصف	حالة الحاوية لإصدار معين من عامل.
Type	string
Values	Starting Running Stopping Stopped Failed Deleting Deleted Updating

تعريف العامل

تمييزي ل AgentDefinition

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

قيمة النوع	Schema
workflow	تعريف WorkflowAgentDefinition
hosted	معرف HostedAgentDefinition
container_app	ContainerAppAgentDefinition
prompt	تعريف PromptAgentDefinition

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	AgentKind		‏‏نعم‬
rai_config	object	تكوين فلترة محتوى الذكاء الاصطناعي المسؤول (RAI) وميزات الأمان.	لا
└─ rai_policy_name	string	اسم سياسة RAI المراد تطبيقها.	لا

معرف العامل

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاسم	string	اسم الوكيل.	‏‏نعم‬
النوع	enum	القيم المحتملة: agent_id	‏‏نعم‬
إصدار	string	معرف إصدار الوكيل.	‏‏نعم‬

AgentKind

الخاصية	قيمة
Type	string
Values	prompt hosted container_app workflow

AgentObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الفريد للوكيل.	‏‏نعم‬
الاسم	string	اسم الوكيل.	‏‏نعم‬
object	enum	نوع الكائن ، والذي يكون دائما "وكيل". القيم المحتملة: agent	‏‏نعم‬
versions	object	أحدث إصدار من الوكيل.	‏‏نعم‬
└─ الأحدث	AgentVersionObject		لا

وكيل البروتوكول

الخاصية	قيمة
Type	string
Values	activity_protocol responses

الوكيل المرجعي

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاسم	string	اسم الوكيل.	‏‏نعم‬
النوع	enum	القيم المحتملة: agent_reference	‏‏نعم‬
إصدار	string	معرف إصدار الوكيل.	لا

AgentTaxonomyInput

تكوين الإدخال لتصنيف التقييم عندما يكون نوع الإدخال وكيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
فئات المخاطر	صفيف	قائمة فئات المخاطر التي يجب تقييمها.	‏‏نعم‬
target	object	يمثل هدفا يحدد عامل الذكاء الاصطناعي Azure.	‏‏نعم‬
└─ الاسم	string	المعرف الفريد لعامل الذكاء الاصطناعي Azure.	لا
└─ tool_descriptions	صفيف	المعلمات المستخدمة للتحكم في سلوك أخذ العينات للعامل أثناء إنشاء النص.	لا
└─ النوع	enum	نوع الهدف ، دائما azure_ai_agent. القيم المحتملة: azure_ai_agent	لا
└─ الإصدار	string	إصدار عامل الذكاء الاصطناعي Azure.	لا
النوع	enum	نوع الإدخال لتصنيف التقييم. القيم المحتملة: agent	‏‏نعم‬

AgentTaxonomyInputUpdate

تكوين الإدخال لتصنيف التقييم عندما يكون نوع الإدخال وكيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
فئات المخاطر	صفيف	قائمة فئات المخاطر التي يجب تقييمها.	لا
target	object	يمثل هدفا يحدد عامل الذكاء الاصطناعي Azure.	لا
└─ الاسم	string	المعرف الفريد لعامل الذكاء الاصطناعي Azure.	لا
└─ tool_descriptions	صفيف	المعلمات المستخدمة للتحكم في سلوك أخذ العينات للعامل أثناء إنشاء النص.	لا
└─ النوع	enum	نوع الهدف ، دائما azure_ai_agent. القيم المحتملة: azure_ai_agent	لا
└─ الإصدار	string	إصدار عامل الذكاء الاصطناعي Azure.	لا
النوع	enum	نوع الإدخال لتصنيف التقييم. القيم المحتملة: agent	لا

AgentVersionObject

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني ليونكس (بالثواني) عند إنشاء العامل.	‏‏نعم‬
تعريف	تعريف العامل		‏‏نعم‬
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
المعرف	string	المعرف الفريد لإصدار الوكيل.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	‏‏نعم‬
الاسم	string	اسم الوكيل. يمكن استخدام الاسم لاسترداد/تحديث/حذف العامل.	‏‏نعم‬
object	enum	نوع الكائن ، وهو دائما "agent.version". القيم المحتملة: agent.version	‏‏نعم‬
إصدار	string	معرف إصدار الوكيل. الوكلاء غير قابلين للتغيير وكل تحديث ينشئ إصدارا جديدا مع الحفاظ على الاسم نفسه.	‏‏نعم‬

بيانات اعتماد معرف العامل

تعريف بيانات اعتماد الهوية الوكيل

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع بيانات الاعتماد القيم المحتملة: AgenticIdentityToken	‏‏نعم‬

ApiErrorResponse

استجابة خطأ لحالات فشل واجهة برمجة التطبيقات.

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

ApiKeyCredentials

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
مفتاح	string	مفتاح API	لا
النوع	enum	نوع بيانات الاعتماد القيم المحتملة: ApiKey	‏‏نعم‬

AssetCredentialResponse

يمثل مرجعا إلى كائن ثنائي كبير الحجم للاستهلاك

الاسم	النوع	وصف	مطلوب	الإفتراضي
مرجع الكائن الثنائي كبير الحجم	object	تفاصيل مرجع كائن ثنائي كبير الحجم.	‏‏نعم‬
└─ blobUri	string	مسار Blob URI للعميل لتحميل البيانات. مثال: https://blob.windows.core.net/Container/Path	لا
└─ بيانات الاعتماد	SasCredential	معلومات بيانات الاعتماد access حساب storage.	لا
└─ storageAccountArmId	string	معرف ARM لحساب storage المراد استخدامه.	لا

معرف الأصل

معرف أصل محفوظ.

النوع: سلسلة

هجومالهجومالهجومي

استراتيجيات الهجمات.

الخاصية	قيمة
الوصف	استراتيجيات الهجمات.
Type	string
Values	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansii_attack character_swap suffix_append string_join unicode_confusable unicode_substitution diacritic flip leetspeak rot13 morse url baseline indirect_jailbreak tense multi_turn crescendo

Azure. Core.Foundations.Error

كائن الخطأ.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	string	إحدى مجموعات رموز الخطأ المعرفة من قبل الخادم.	‏‏نعم‬
details	صفيف	صفيف من التفاصيل حول أخطاء معينة أدت إلى هذا الخطأ الذي تم الإبلاغ عنه.	لا
خطأ داخلي	object	كائن يحتوي على معلومات أكثر تحديدا حول الخطأ. وفقا لإرشادات واجهة برمجة تطبيقات REST Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.	لا
└─ كود	string	إحدى مجموعات رموز الخطأ المعرفة من قبل الخادم.	لا
└─ innererror	Azure. Core.Foundations.InnerError	خطأ داخلي.	لا
رسالة	string	تمثيل يمكن للبشر قراءته للخطأ.	‏‏نعم‬
target	string	الهدف من الخطأ.	لا

Azure. Core.Foundations.ErrorResponse

استجابة تحتوي على تفاصيل الخطأ.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	object	كائن الخطأ.	‏‏نعم‬
└─ كود	string	إحدى مجموعات رموز الخطأ المعرفة من قبل الخادم.	لا
└─ التفاصيل	صفيف	صفيف من التفاصيل حول أخطاء معينة أدت إلى هذا الخطأ الذي تم الإبلاغ عنه.	لا
└─ innererror	Azure. Core.Foundations.InnerError	كائن يحتوي على معلومات أكثر تحديدا من الكائن الحالي حول الخطأ.	لا
└─ رسالة	string	تمثيل يمكن للبشر قراءته للخطأ.	لا
└─ الهدف	string	الهدف من الخطأ.	لا

Azure. Core.Foundations.InnerError

كائن يحتوي على معلومات أكثر تحديدا حول الخطأ. وفقا لإرشادات واجهة برمجة تطبيقات REST Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	string	إحدى مجموعات رموز الخطأ المعرفة من قبل الخادم.	لا
خطأ داخلي	object	كائن يحتوي على معلومات أكثر تحديدا حول الخطأ. وفقا لإرشادات واجهة برمجة تطبيقات REST Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.	لا
└─ كود	string	إحدى مجموعات رموز الخطأ المعرفة من قبل الخادم.	لا
└─ innererror	Azure. Core.Foundations.InnerError	خطأ داخلي.	لا

Azure. Core.Foundations.OperationState

Enum يصف حالات التشغيل المسموح بها.

الخاصية	قيمة
Type	string
Values	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

معرف فريد عالميا

النوع: سلسلة

التنسيق: uuid

AzureAIAgentTarget

يمثل هدفا يحدد عامل الذكاء الاصطناعي Azure.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاسم	string	المعرف الفريد لعامل الذكاء الاصطناعي Azure.	‏‏نعم‬
tool_descriptions	صفيف	المعلمات المستخدمة للتحكم في سلوك أخذ العينات للعامل أثناء إنشاء النص.	لا
النوع	enum	نوع الهدف ، دائما azure_ai_agent. القيم المحتملة: azure_ai_agent	‏‏نعم‬
إصدار	string	إصدار عامل الذكاء الاصطناعي Azure.	لا

AzureAIAgentTargetUpdate

يمثل هدفا يحدد عامل الذكاء الاصطناعي Azure.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاسم	string	المعرف الفريد لعامل الذكاء الاصطناعي Azure.	لا
tool_descriptions	صفيف	المعلمات المستخدمة للتحكم في سلوك أخذ العينات للعامل أثناء إنشاء النص.	لا
النوع	enum	نوع الهدف ، دائما azure_ai_agent. القيم المحتملة: azure_ai_agent	لا
إصدار	string	إصدار عامل الذكاء الاصطناعي Azure.	لا

AzureAIAssistantTarget

يمثل هدفا يحدد نقطة نهاية مساعد الذكاء الاصطناعي Azure (العامل V1)، بما في ذلك معرفه.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الفريد لمساعد الذكاء الاصطناعي Azure.	لا
tool_descriptions	صفيف	أوصاف الأدوات المتاحة للمساعد.	‏‏نعم‬
النوع	enum	نوع الهدف ، دائما azure_ai_assistant. القيم المحتملة: azure_ai_assistant	‏‏نعم‬

AzureAIAssistantTargetUpdate

يمثل هدفا يحدد نقطة نهاية مساعد الذكاء الاصطناعي Azure (العامل V1)، بما في ذلك معرفه.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الفريد لمساعد الذكاء الاصطناعي Azure.	لا
tool_descriptions	صفيف	أوصاف الأدوات المتاحة للمساعد.	لا
النوع	enum	نوع الهدف ، دائما azure_ai_assistant. القيم المحتملة: azure_ai_assistant	لا

AzureAIEvaluator

Azure تعريف مقيم الذكاء الاصطناعي لمقيمي المكتشف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_mapping	object	النموذج الذي يجب استخدامه للتقييم. يجب أن يدعم المخرجات المنظمة.	لا
evaluator_name	string	اسم المقيم.	‏‏نعم‬
evaluator_version	string	إصدار المقيم.	لا
initialization_parameters	object	معلمات التهيئة للتقييم. يجب أن يدعم المخرجات المنظمة.	لا
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: azure_ai_evaluator	‏‏نعم‬

AzureAIModelTarget

يمثل هدفا يحدد نموذج الذكاء الاصطناعي Azure للعمليات التي تتطلب تحديد النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نموذج	string	المعرف الفريد لنموذج الذكاء الاصطناعي Azure.	لا
sampling_params	object	يمثل مجموعة من المعلمات المستخدمة للتحكم في سلوك أخذ العينات لنموذج لغة أثناء إنشاء النص.	لا
└─ max_completion_tokens	integer	الحد الأقصى لعدد الرموز المميزة المسموح بها في الاكتمال.	لا
└─ البذور	integer	البذور العشوائية ل القابلية للتكرار.	لا
└─ درجة الحرارة	رقم	معلمة درجة الحرارة لأخذ العينات.	لا
└─ top_p	رقم	المعلمة top-p لأخذ عينات النواة.	لا
النوع	enum	نوع الهدف ، دائما azure_ai_model. القيم المحتملة: azure_ai_model	‏‏نعم‬

AzureAIModelTargetUpdate

يمثل هدفا يحدد نموذج الذكاء الاصطناعي Azure للعمليات التي تتطلب تحديد النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نموذج	string	المعرف الفريد لنموذج الذكاء الاصطناعي Azure.	لا
sampling_params	object	يمثل مجموعة من المعلمات المستخدمة للتحكم في سلوك أخذ العينات لنموذج لغة أثناء إنشاء النص.	لا
└─ max_completion_tokens	integer	الحد الأقصى لعدد الرموز المميزة المسموح بها في الاكتمال.	لا
└─ البذور	integer	البذور العشوائية ل القابلية للتكرار.	لا
└─ درجة الحرارة	رقم	معلمة درجة الحرارة لأخذ العينات.	لا
└─ top_p	رقم	المعلمة top-p لأخذ عينات النواة.	لا
النوع	enum	نوع الهدف ، دائما azure_ai_model. القيم المحتملة: azure_ai_model	لا

AzureAIRedTeam

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_generation_params	object	يمثل معلمات إنشاء عنصر الفريق الأحمر.	‏‏نعم‬
└─ attack_strategies	صفيف	مجموعة استراتيجيات الهجوم التي سيتم استخدامها.	لا
└─ num_turns	integer	عدد الأدوار المسموح بها في اللعبة.	لا
└─ النوع	enum	نوع معلمات إنشاء العنصر، دائما red_team. القيم المحتملة: red_team	لا
target	object	الفئة الأساسية للأهداف ذات دعم المميز.	‏‏نعم‬
└─ النوع	string	نوع الهدف.	لا
النوع	enum	نوع مصدر البيانات. دائمًا azure_ai_red_team. القيم المحتملة: azure_ai_red_team	‏‏نعم‬

AzureAIResponses

يمثل مصدر بيانات لإجراءات التقييم الخاصة بسيناريوهات التقييم المستمر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
event_configuration_id	string	اسم تكوين الحدث المقترن بتشغيل التقييم هذا.	‏‏نعم‬
item_generation_params	object	يمثل معلمات إنشاء عنصر التقييم المستمر.	‏‏نعم‬
└─ data_mapping	object	التعيين من الحقول المصدر إلى حقل response_id، مطلوب لاسترداد محفوظات الدردشة.	لا
└─ max_num_turns	integer	الحد الأقصى لعدد دورات محفوظات الدردشة المراد تقييمها.	لا
└─ المصدر	OpenAI.EvalJsonlFileContentSource أو OpenAI.EvalJsonlFileIdSource	المصدر الذي تتم قراءة محتوى JSONL منه.	لا
└─ النوع	enum	نوع معلمات إنشاء العنصر، دائما ResponseRetrieval. القيم المحتملة: response_retrieval	لا
max_runs_hourly	integer	الحد الأقصى لعدد عمليات تشغيل التقييم المسموح بها في الساعة.	‏‏نعم‬
النوع	enum	نوع مصدر البيانات، دائما AzureAIResponses. القيم المحتملة: azure_ai_responses	‏‏نعم‬

AzureAISearchAgentTool

معلومات تعريف الإدخال لأداة Azure AI search كما هو مستخدم لتكوين عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
azure_ai_search	object	مجموعة من موارد الفهرس المستخدمة من قبل أداة azure_ai_search.	‏‏نعم‬
└─ فهارس	صفيف	المؤشرات المرفقة بهذا الوكيل. يمكن أن يكون هناك فهرس 1 كحد أقصى المورد المرفق بالعامل.	لا
النوع	enum	نوع الكائن ، والذي يكون دائما "azure_ai_search". القيم المحتملة: azure_ai_search	‏‏نعم‬

AzureAISearchIndex

تعريف فهرس Azure AI Search

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

AzureAISearchIndexUpdate

تعريف فهرس Azure AI Search

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

نوع AzureAISearchQueryType

أنواع الاستعلام المتوفرة لأداة Azure AI Search.

الخاصية	قيمة
الوصف	أنواع الاستعلام المتوفرة لأداة Azure AI Search.
Type	string
Values	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchToolResource

مجموعة من موارد الفهرس المستخدمة من قبل أداة azure_ai_search.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الفهارس	صفيف	المؤشرات المرفقة بهذا الوكيل. يمكن أن يكون هناك فهرس 1 كحد أقصى المورد المرفق بالعامل.	‏‏نعم‬

AzureAISource

الاسم	النوع	وصف	مطلوب	الإفتراضي
السيناريو	enum	سيناريو مخطط البيانات. القيم المحتملة: red_team، ، responsestraces	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: azure_ai_source	‏‏نعم‬

AzureFunctionAgentTool

معلومات تعريف الإدخال لأداة وظيفة Azure، كما هو مستخدم لتكوين عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
azure_function	object	تعريف الدالة Azure.	‏‏نعم‬
└─ الدالة	object	تعريف الدالة azure ومعلماتها.	لا
└─ الوصف	string	وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة.	لا
└─ الاسم	string	اسم الدالة التي سيتم استدعاؤها.	لا
└─ المعلمات		المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON.	لا
└─ input_binding	AzureFunctionBinding	قائمة انتظار storage الإدخال. يشغل مشغل storage قائمة الانتظار دالة حيث تتم إضافة الرسائل إليها.	لا
└─ output_binding	AzureFunctionBinding	قائمة انتظار storage الإخراج. تكتب الدالة الإخراج إلى قائمة الانتظار هذه عند معالجة عناصر الإدخال.	لا
النوع	enum	نوع الكائن ، والذي يكون دائما "browser_automation". القيم المحتملة: azure_function	‏‏نعم‬

AzureFunctionBinding

بنية الاحتفاظ باسم قائمة الانتظار storage وURI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
storage_queue	object	بنية الاحتفاظ باسم قائمة الانتظار storage وURI.	‏‏نعم‬
└─ queue_name	string	اسم دالة Azure storage قائمة الانتظار.	لا
└─ queue_service_endpoint	string	URI إلى خدمة قائمة انتظار Azure Storage مما يسمح لك بمعالجة قائمة انتظار.	لا
النوع	enum	نوع الربط، والذي يكون دائما "storage_queue". القيم المحتملة: storage_queue	‏‏نعم‬

تعريف AzureFunctionDefinition

تعريف الدالة Azure.

الاسم	النوع	وصف	مطلوب	الإفتراضي
دالة	object	تعريف الدالة azure ومعلماتها.	‏‏نعم‬
└─ الوصف	string	وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة.	لا
└─ الاسم	string	اسم الدالة التي سيتم استدعاؤها.	لا
└─ المعلمات		المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON.	لا
input_binding	object	بنية الاحتفاظ باسم قائمة الانتظار storage وURI.	‏‏نعم‬
└─ storage_queue	AzureFunctionStorageQueue	قائمة انتظار Storage.	لا
└─ النوع	enum	نوع الربط، والذي يكون دائما "storage_queue". القيم المحتملة: storage_queue	لا
output_binding	object	بنية الاحتفاظ باسم قائمة الانتظار storage وURI.	‏‏نعم‬
└─ storage_queue	AzureFunctionStorageQueue	قائمة انتظار Storage.	لا
└─ النوع	enum	نوع الربط، والذي يكون دائما "storage_queue". القيم المحتملة: storage_queue	لا

AzureFunctionStorageQueue

بنية الاحتفاظ باسم قائمة الانتظار storage وURI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
queue_name	string	اسم دالة Azure storage قائمة الانتظار.	‏‏نعم‬
queue_service_endpoint	string	URI إلى خدمة قائمة انتظار Azure Storage مما يسمح لك بمعالجة قائمة انتظار.	‏‏نعم‬

تكوين AzureOpenAIModel

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
modelDeploymentName	string	اسم النشر لنموذج AOAI. مثال: gpt-4o إذا كان في AIServices أو قائم على connection_name/deployment_name الاتصال (على سبيل المثال). my-aoai-connection/gpt-4o	‏‏نعم‬
النوع	enum	القيم المحتملة: AzureOpenAIModel	‏‏نعم‬

BaseCredentials

فئة أساسية لبيانات اعتماد الاتصال

تمييزي ل BaseCredentials

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

قيمة النوع	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken	بيانات اعتماد معرف العامل

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	نوع بيانات الاعتماد المستخدمة من قبل الاتصال	‏‏نعم‬

BingCustomSearchAgentTool

معلومات تعريف الإدخال لأداة بحث مخصصة Bing كما هو مستخدم لتكوين عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
bing_custom_search_preview	object	bing معلمات أداة البحث المخصصة.	‏‏نعم‬
└─ search_configurations	صفيف	project الاتصالات المرفقة بهذه الأداة. يمكن أن يكون هناك اتصال 1 كحد أقصى المورد المرفق بالأداة.	لا
النوع	enum	نوع الكائن ، والذي يكون دائما "bing_custom_search". القيم المحتملة: bing_custom_search_preview	‏‏نعم‬

تكوين BingCustomSearch

تكوين بحث مخصص bing.

الاسم	النوع	وصف	مطلوب	الإفتراضي
count	integer	عدد نتائج البحث التي سيتم إرجاعها في استجابة واجهة برمجة التطبيقات bing	لا
freshness	string	فلترة نتائج البحث حسب نطاق زمني محدد. راجع القيم accepted هنا.	لا
instance_name	string	اسم مثيل التكوين المخصص المعطى للتكوين.	‏‏نعم‬
سوق	string	السوق الذي تأتي منه النتائج.	لا
project_connection_id	string	معرف اتصال Project للأرضية مع البحث bing	‏‏نعم‬
set_lang	string	اللغة التي يجب استخدامها لسلاسل واجهة المستخدم عند استدعاء Bing API.	لا

BingCustomSearchToolParameters

bing معلمات أداة البحث المخصصة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
search_configurations	صفيف	project الاتصالات المرفقة بهذه الأداة. يمكن أن يكون هناك اتصال 1 كحد أقصى المورد المرفق بالأداة.	‏‏نعم‬

BingGroundingAgentTool

معلومات تعريف الإدخال لأداة بحث bing الأرضية كما هو مستخدم لتكوين عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
bing_grounding	object	bing معلمات أداة البحث الأساسية.	‏‏نعم‬
└─ search_configurations	صفيف	تكوينات البحث المرفقة بهذه الأداة. يمكن أن يكون هناك حد أقصى 1 مورد تكوين البحث المرفق بالأداة.	لا
النوع	enum	نوع الكائن، وهو دائما "bing_grounding". القيم المحتملة: bing_grounding	‏‏نعم‬

تكوين البحث في BingGrounding

تكوين البحث عن Bing الأرضية

الاسم	النوع	وصف	مطلوب	الإفتراضي
count	integer	عدد نتائج البحث التي سيتم إرجاعها في استجابة واجهة برمجة التطبيقات bing	لا
freshness	string	فلترة نتائج البحث حسب نطاق زمني محدد. راجع القيم accepted هنا.	لا
سوق	string	السوق الذي تأتي منه النتائج.	لا
project_connection_id	string	معرف اتصال Project للأرضية مع البحث bing	‏‏نعم‬
set_lang	string	اللغة التي يجب استخدامها لسلاسل واجهة المستخدم عند استدعاء Bing API.	لا

BingGroundingSearchToolParameters

bing معلمات أداة البحث الأساسية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
search_configurations	صفيف	تكوينات البحث المرفقة بهذه الأداة. يمكن أن يكون هناك حد أقصى 1 مورد تكوين البحث المرفق بالأداة.	‏‏نعم‬

مرجع كائن ثنائي كبير الحجم

تفاصيل مرجع كائن ثنائي كبير الحجم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
blobUri	string	مسار Blob URI للعميل لتحميل البيانات. مثال: https://blob.windows.core.net/Container/Path	‏‏نعم‬
credential	object	تعريف بيانات اعتماد SAS	‏‏نعم‬
└─ sasUri	string	SAS uri	لا
└─ النوع	enum	نوع بيانات الاعتماد القيم المحتملة: SAS	لا
storageAccountArmId	string	معرف ARM لحساب storage المراد استخدامه.	‏‏نعم‬

BrowserAutomationAgentTool

معلومات تعريف الإدخال لأداة أتمتة المستعرض، كما تستخدم لتكوين عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
browser_automation_preview	object	تعريف معلمات الإدخال لأداة أتمتة المستعرض.	‏‏نعم‬
└─ الاتصال	BrowserAutomationToolConnectionParameters	project معلمات الاتصال المقترنة بأداة أتمتة المستعرض.	لا
النوع	enum	نوع الكائن ، والذي يكون دائما "browser_automation". القيم المحتملة: browser_automation_preview	‏‏نعم‬

BrowserAutomationToolConnectionParameters

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
project_connection_id	string	معرف الاتصال project بمورد Azure Playwright.	‏‏نعم‬

BrowserAutomationToolParameters

تعريف معلمات الإدخال لأداة أتمتة المستعرض.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاتصال	object	تعريف معلمات الإدخال للاتصال المستخدم بواسطة أداة أتمتة المستعرض.	‏‏نعم‬
└─ project_connection_id	string	معرف الاتصال project بمورد Azure Playwright.	لا

CaptureStructuredOutputsTool

أداة لالتقاط المخرجات المنظمة

الاسم	النوع	وصف	مطلوب	الإفتراضي
outputs	object	إخراج منظم يمكن أن ينتجه العامل.	‏‏نعم‬
└─ الوصف	string	وصف للإخراج المراد إنذاعه. يستخدمه النموذج لتحديد وقت إصدار الإخراج.	لا
└─ الاسم	string	اسم الإخراج المنظم.	لا
└─ مخطط		مخطط JSON للإخراج المنظم.	لا
└─ صارم	boolean	ما إذا كان سيتم فرض التحقق الصارم من الصحة أم لا. الافتراضي true.	لا
النوع	enum	نوع الأداة. دائمًا capture_structured_outputs. القيم المحتملة: capture_structured_outputs	‏‏نعم‬

تباين المخططات

إحداثيات مخطط التحليل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
size	integer	حجم عنصر الرسم البياني.	‏‏نعم‬
×	integer	إحداثيات المحور X.	‏‏نعم‬
y	integer	إحداثيات المحور Y.	‏‏نعم‬

ChatSummaryMemoryItem

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع عنصر الذاكرة. القيم المحتملة: chat_summary	‏‏نعم‬

ClusterInsightResult

نتائج تحليلات من تحليل نظام المجموعة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
clusters	صفيف	قائمة المجموعات المحددة في الرؤى.	‏‏نعم‬
احداثيات	object	تعيين اختياري للمعرفات إلى إحداثيات ثنائية الأبعاد التي تستخدمها تجربة المستخدم للتصور. مفاتيح الخريطة هي معرفات سلسلة (على سبيل المثال، معرف نظام المجموعة أو معرف عينة) والقيم هي الإحداثيات والحجم المرئي للعرض على مخطط ثنائي الأبعاد. يتم حذف هذه الخاصية ما لم يطلب العميل إحداثيات (على سبيل المثال، عن طريق تمرير includeCoordinates=true كمعلمة استعلام). مثال: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> الإحداثيات مخصصة فقط للتصور من جانب العميل ولا تعديل نتائج الرؤى المتعارف عليها.	لا
الملخص.	object	ملخص تحليل مجموعة الخطأ.	‏‏نعم‬
└─ الأسلوب	string	الطريقة المستخدمة للتجميع.	لا
└─ sampleCount	integer	إجمالي عدد العينات التي تم تحليلها.	لا
└─ uniqueClusterCount	integer	إجمالي عدد المجموعات الفريدة.	لا
└─ uniqueSubclusterCount	integer	إجمالي عدد تسميات نظام المجموعة الفرعي الفريدة.	لا
└─ الاستخدام	ClusterTokenUsage	استخدام الرمز المميز أثناء إجراء تحليل نظام التجميع	لا

ClusterTokenUsage

استخدام الرمز المميز لتحليل نظام المجموعة

الاسم	النوع	وصف	مطلوب	الإفتراضي
inputTokenUsage	integer	إدخال استخدام الرمز المميز	‏‏نعم‬
outputTokenUsage	integer	استخدام الرمز المميز الناتج	‏‏نعم‬
totalTokenUsage	integer	إجمالي استخدام الرمز المميز	‏‏نعم‬

CodeBasedEvaluatorDefinition

تعريف المقيم المستند إلى التعليمات البرمجية باستخدام كود Python

الاسم	النوع	وصف	مطلوب	الإفتراضي
code_text	string	نص التعليمات البرمجية المضمنة للمقيم	‏‏نعم‬
النوع	enum	القيم المحتملة: code	‏‏نعم‬

الاتصال

الاستجابة من القائمة والحصول على عمليات الاتصالات

الاسم	النوع	وصف	مطلوب	الإفتراضي
credentials	object	فئة أساسية لبيانات اعتماد الاتصال	‏‏نعم‬
└─ النوع	نوع بيانات الاعتماد	نوع بيانات الاعتماد المستخدمة من قبل الاتصال	لا
المعرف	string	معرف فريد للاتصال، تم إنشاؤه بواسطة الخدمة	‏‏نعم‬
isDefault	boolean	ما إذا كان الاتصال معلما على أنه الاتصال الافتراضي من نوعه	‏‏نعم‬
metadata	object	بيانات التعريف للاتصال	‏‏نعم‬
الاسم	string	الاسم المألوف للاتصال، الذي يوفره المستخدم.	‏‏نعم‬
target	string	عنوان URL للاتصال الذي سيتم استخدامه لهذه الخدمة	‏‏نعم‬
النوع	object	نوع (أو فئة) الاتصال	‏‏نعم‬

نوع الاتصال

نوع (أو فئة) الاتصال

الخاصية	قيمة
الوصف	نوع (أو فئة) الاتصال
Type	string
Values	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool

ContainerAppAgentDefinition

تعريف وكيل تطبيق الحاوية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
container_app_resource_id	string	معرف المورد Azure Container App الذي يستضيف هذا العامل. غير قابل للتغيير عبر الإصدارات.	‏‏نعم‬
container_protocol_versions	صفيف	البروتوكولات التي يدعمها العامل لاتصال دخول الحاويات.	‏‏نعم‬
ingress_subdomain_suffix	string	اللاحقة التي يجب تطبيقها على النطاق الفرعي للتطبيق عند إرسال دخول إلى الوكيل. يمكن أن يكون هذا تصنيفا (على سبيل المثال، "---current") أو مراجعة معينة (على سبيل المثال، "-0000001") أو فارغا لاستخدام نقطة النهاية التلقائية لتطبيق الحاوية.	‏‏نعم‬
النوع	enum	القيم المحتملة: container_app	‏‏نعم‬

ContinuousEvalItemGenerationParams

يمثل معلمات إنشاء عنصر التقييم المستمر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_mapping	object	التعيين من الحقول المصدر إلى حقل response_id، مطلوب لاسترداد محفوظات الدردشة.	‏‏نعم‬
max_num_turns	integer	الحد الأقصى لعدد دورات محفوظات الدردشة المراد تقييمها.	‏‏نعم‬
المصدر	object		‏‏نعم‬
└─ المحتوى	صفيف	محتوى ملف jsonl.	لا
└─ الهوية	string	معرف الملف.	لا
└─ النوع	enum	نوع مصدر jsonl. دائمًا file_id. القيم المحتملة: file_id	لا
النوع	enum	نوع معلمات إنشاء العنصر، دائما ResponseRetrieval. القيم المحتملة: response_retrieval	‏‏نعم‬

ContinuousEvaluationRuleAction

إجراء قاعدة التقييم للتقييم المستمر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
معرف التقييم	string	معرف Eval لإضافة عمليات تشغيل التقييم المستمر إلى.	‏‏نعم‬
maxHourlyRuns	integer	الحد الأقصى لعدد عمليات تشغيل التقييم المسموح بها في الساعة.	لا
النوع	enum	القيم المحتملة: continuousEvaluation	‏‏نعم‬

كوزموس دي بيإندكس

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

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

CosmosDBIndexUpdate

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

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

CreateAgentFromManifestRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
manifest_id	string	معرف البيان لاستيراد إصدار العامل منه.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string	الاسم الفريد الذي يعرف العامل. يمكن استخدام الاسم لاسترداد/تحديث/حذف العامل. - يجب أن تبدأ وتنتهي بأحرف أبجدية رقمية، - يمكن أن تحتوي على واصلات في المنتصف - يجب ألا يتجاوز 63 حرفا.	‏‏نعم‬
parameter_values	object	المدخلات إلى البيان التي ستؤدي إلى عامل مجسد بالكامل.	‏‏نعم‬

CreateAgentRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	object		‏‏نعم‬
└─ نوع	AgentKind		لا
└─ rai_config	RaiConfig	تكوين فلترة محتوى الذكاء الاصطناعي المسؤول (RAI) وميزات الأمان.	لا
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string	الاسم الفريد الذي يعرف العامل. يمكن استخدام الاسم لاسترداد/تحديث/حذف العامل. - يجب أن تبدأ وتنتهي بأحرف أبجدية رقمية، - يمكن أن تحتوي على واصلات في المنتصف - يجب ألا يتجاوز 63 حرفا.	‏‏نعم‬

CreateAgentVersionFromManifestRequest

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

CreateAgentVersionRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	object		‏‏نعم‬
└─ نوع	AgentKind		لا
└─ rai_config	RaiConfig	تكوين فلترة محتوى الذكاء الاصطناعي المسؤول (RAI) وميزات الأمان.	لا
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا

CreateEvalRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_source_config	object	كائن CustomDataSourceConfig الذي يعرف مخطط مصدر البيانات المستخدم في عمليات تشغيل التقييم. يستخدم هذا المخطط لتحديد شكل البيانات التي ستكون: - يستخدم لتحديد معايير الاختبار الخاصة بك و - ما هي البيانات المطلوبة عند إنشاء تشغيل	‏‏نعم‬
└─ include_sample_schema	boolean	ما إذا كان يجب أن يتوقع التقييم ملء مساحة الاسم النموذجية (أي عن طريق إنشاء استجابات من مصدر البيانات الخاص بك)	لا
└─ item_schema	object	مخطط json لكل صف في مصدر البيانات.	لا
└─ البيانات الوصفية	object	عوامل تصفية بيانات التعريف لمصدر بيانات الاكتمال المخزنة.	لا
└─ السيناريو	enum	سيناريو مخطط البيانات. القيم المحتملة: red_team، ، responsestraces	لا
└─ النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: azure_ai_source	لا
metadata	OpenAI.Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string	اسم التقييم.	لا
خصائص	object	مجموعة من أزواج قيم المفاتيح غير القابلة للتغيير والتي يمكن إرفاقها بعنصر لتخزين معلومات إضافية. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
testing_criteria	صفيف	يتم تشغيل قائمة بالدرجات لجميع التقييمات في هذه المجموعة. يمكن لمصنفي التقديرات الرجوع إلى المتغيرات في مصدر البيانات باستخدام تدوين الأقواس المتعرجة المزدوجة، مثل {{item.variable_name}}. للإشارة إلى إخراج النموذج ، استخدم sample مساحة الاسم (على سبيل المثال ، {{sample.output_text}}).	‏‏نعم‬

إنشاءEvalRunRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_source	object	كائن JsonlRunDataSource مع الذي يحدد ملف JSONL الذي يطابق التقييم	‏‏نعم‬
└─ input_messages	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate أو OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	يستخدم عند أخذ العينات من نموذج. تملي بنية الرسائل التي تم تمريرها إلى النموذج. يمكن أن يكون إما مرجعا لمسار تم إنشاؤه مسبقا (أي)، item.input_trajectoryأو قالب مع مراجع متغيرة item لمساحة الاسم.	لا
└─ item_generation_params	RedTeamItemGenerationParams	معلمات إنشاء العنصر.	لا
└─ نموذج	string	اسم النموذج المراد استخدامه لإنشاء عمليات الإكمال (على سبيل المثال "o3-mini").	لا
└─ sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		لا
└─ المصدر	OpenAI.EvalJsonlFileContentSource أو OpenAI.EvalJsonlFileIdSource أو OpenAI.EvalResponsesSource	تحديد ما يملأ item مساحة الاسم في مصدر بيانات هذا التشغيل.	لا
└─ الهدف	الهدف	التكوين الهدف للتقييم.	لا
└─ النوع	string	نوع مصدر البيانات تمييزي.	لا
metadata	OpenAI.Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string	اسم التشغيل.	لا
خصائص	object	مجموعة من أزواج قيم المفاتيح غير القابلة للتغيير والتي يمكن إرفاقها بعنصر لتخزين معلومات إضافية. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا

تم إنشاؤه بواسطة

الاسم	النوع	وصف	مطلوب	الإفتراضي
agent	object		لا
└─ الاسم	string	اسم الوكيل.	لا
└─ النوع	enum	القيم المحتملة: agent_id	لا
└─ الإصدار	string	معرف إصدار الوكيل.	لا
response_id	string	الاستجابة التي يتم إنشاء العنصر عليها.	لا

نوع بيانات الاعتماد

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

الخاصية	قيمة
الوصف	نوع بيانات الاعتماد المستخدمة من قبل الاتصال
Type	string
Values	ApiKey AAD SAS CustomKeys None AgenticIdentityToken

CronTrigger

الزناد القائم على Cron.

الاسم	النوع	وصف	مطلوب	الإفتراضي
endTime	string	وقت الانتهاء لجدول cron بتنسيق ISO 8601.	لا
تعبير	string	تعبير Cron الذي يحدد تردد الجدولة.	‏‏نعم‬
وقت البدء	string	وقت بدء جدول cron بتنسيق ISO 8601.	لا
timeZone	string	المنطقة الزمنية لجدول المحصل.	لا	التوقيت العالمي المتفق عليه
النوع	enum	القيم المحتملة: Cron	‏‏نعم‬

CustomCredential

تعريف بيانات الاعتماد المخصصة

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع بيانات الاعتماد القيم المحتملة: CustomKeys	‏‏نعم‬

جدول يوميا للتكتم

جدول التكرار اليومي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الساعات	صفيف	ساعات لجدول التكرار.	‏‏نعم‬
النوع	enum	نوع التكرار اليومي. القيم المحتملة: Daily	‏‏نعم‬

نوع مجموعة البيانات

تعداد لتحديد نوع البيانات.

الخاصية	قيمة
الوصف	تعداد لتحديد نوع البيانات.
Type	string
Values	uri_file uri_folder

إصدار مجموعة البيانات

Datasetتعريف الإصدار

تمييزي ل DatasetVersion

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

قيمة النوع	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

الاسم	النوع	وصف	مطلوب	الإفتراضي
اسم الاتصال	string	اسم اتصال حساب Azure Storage. مطلوب إذا لم يتم استدعاء startPendingUploadVersion قبل إنشاء مجموعة البيانات	لا
dataUri	string	URI للبيانات (مثال)	‏‏نعم‬
المعرف	string	رقم تعريف مادة العرض ، وهو معرف فريد لمادة العرض	لا
مرجع is	boolean	يشير إلى ما إذا كانت مجموعة البيانات تحتوي على مرجع إلى storage، أو أن مجموعة البيانات تدير storage نفسها. إذا كان هذا صحيحا، فلن يتم حذف البيانات الأساسية عند حذف إصدار مجموعة البيانات	لا
الاسم	string	اسم المورد	‏‏نعم‬
النوع	object	تعداد لتحديد نوع البيانات.	‏‏نعم‬
إصدار	string	إصدار المورد	‏‏نعم‬

تحديث إصدار مجموعة البيانات

Datasetتعريف الإصدار

تمييزي ل DatasetVersionUpdate

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

قيمة النوع	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	تحديث إصدار FolderDataset

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

يوم الأسبوع

أيام الأسبوع لجدول التكرار.

الخاصية	قيمة
الوصف	أيام الأسبوع لجدول التكرار.
Type	string
Values	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

كائن عامل محذوف

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean	ما إذا كان العامل قد تم حذفه بنجاح.	‏‏نعم‬
الاسم	string	اسم الوكيل.	‏‏نعم‬
object	enum	نوع الكائن. دائما "agent.deleted". القيم المحتملة: agent.deleted	‏‏نعم‬

DeleteAgentVersionResponse

كائن إصدار عامل محذوف

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean	ما إذا كان العامل قد تم حذفه بنجاح.	‏‏نعم‬
الاسم	string	اسم الوكيل.	‏‏نعم‬
object	enum	نوع الكائن. دائما "agent.deleted". القيم المحتملة: agent.version.deleted	‏‏نعم‬
إصدار	string	معرف إصدار الوكيل.	‏‏نعم‬

DeleteEvalResponse

عنصر تقييم محذوف

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean	ما إذا تم حذف التقييم بنجاح.	‏‏نعم‬
eval_id	string	معرف التقييم.	‏‏نعم‬
object	enum	نوع الكائن. دائما 'eval.deleted'. القيم المحتملة: eval.deleted	‏‏نعم‬

حذفEvalRunResponse

تقييم محذوف يقوم بتشغيل الكائن.

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean	ما إذا تم حذف التقييم بنجاح.	لا
object	enum	نوع الكائن. دائما 'eval.deleted'. القيم المحتملة: eval.deleted	لا
run_id	string	معرف التقييم.	لا

DeleteMemoryStoreResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean	ما إذا كان مخزن الذاكرة قد تم حذفه بنجاح.	‏‏نعم‬
الاسم	string	اسم مخزن الذاكرة.	‏‏نعم‬
object	enum	نوع الكائن. دائما "memory_store.deleted". القيم المحتملة: memory_store.deleted	‏‏نعم‬

DeleteResponseResult

نتيجة عملية استجابة الحذف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	enum	إرجاع صحيح دائما القيم المحتملة: True	‏‏نعم‬
المعرف	string	معرف العملية.	‏‏نعم‬
object	enum	إرجاع "الاستجابة" دائما. القيم المحتملة: response	‏‏نعم‬

نشر

تعريف نشر النموذج

تمييزي للنشر

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

قيمة النوع	Schema
ModelDeployment	توزيع النموذج

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

نوع التوزيع

الخاصية	قيمة
Type	string
Values	ModelDeployment

EntraIDCredentials

تعريف بيانات اعتماد معرف Entra

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع بيانات الاعتماد القيم المحتملة: AAD	‏‏نعم‬

تقييم

كائن Eval مع تكوين مصدر بيانات ومعايير اختبار. يمثل Eval مهمة يجب القيام بها لتكامل LLM الخاص بك. مثل:

• تحسين جودة روبوت الدردشة الخاص بي
• تعرف على مدى تعامل روبوت الدردشة مع دعم العملاء
• تحقق مما إذا كان o4-mini أفضل في حالة الاستخدام الخاصة بي من gpt-4o

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	object		‏‏نعم‬
created_by	string	اسم الشخص الذي أنشأ التشغيل.	لا
data_source_config	object	كائن CustomDataSourceConfig الذي يعرف مخطط مصدر البيانات المستخدم في عمليات تشغيل التقييم. يستخدم هذا المخطط لتحديد شكل البيانات التي ستكون: - يستخدم لتحديد معايير الاختبار الخاصة بك و - ما هي البيانات المطلوبة عند إنشاء تشغيل	‏‏نعم‬
└─ include_sample_schema	boolean	ما إذا كان يجب أن يتوقع التقييم ملء مساحة الاسم النموذجية (أي عن طريق إنشاء استجابات من مصدر البيانات الخاص بك)	لا
└─ item_schema	object	مخطط json لكل صف في مصدر البيانات.	لا
└─ البيانات الوصفية	object	عوامل تصفية بيانات التعريف لمصدر بيانات الاكتمال المخزنة.	لا
└─ السيناريو	enum	سيناريو مخطط البيانات. القيم المحتملة: red_team، ، responsestraces	لا
└─ النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: azure_ai_source	لا
المعرف	string	معرف فريد للتقييم.	‏‏نعم‬
metadata	OpenAI.Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	‏‏نعم‬
modified_at	object		لا
الاسم	string	اسم التقييم.	‏‏نعم‬
object	enum	نوع الكائن. القيم المحتملة: eval	‏‏نعم‬
خصائص	object	مجموعة من أزواج قيم المفاتيح غير القابلة للتغيير والتي يمكن إرفاقها بعنصر لتخزين معلومات إضافية. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
testing_criteria	صفيف	قائمة بمعايير الاختبار.	‏‏نعم‬

EvalCompareReport

رؤى من مقارنة التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المقارنات	صفيف	نتائج المقارنة لكل علاج تتعارض مع خط الأساس.	‏‏نعم‬
method	string	الطريقة الإحصائية المستخدمة للمقارنة.	‏‏نعم‬
النوع	enum	نوع نتيجة الرؤى. القيم المحتملة: EvaluationComparison	‏‏نعم‬

EvalResult

نتيجة التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاسم	string	اسم الشيك	‏‏نعم‬
مرت	boolean	يشير إلى ما إذا كان الفحص قد اجتاز أو فشل	‏‏نعم‬
score	رقم	score	‏‏نعم‬
النوع	string	نوع الشيك	‏‏نعم‬

EvalRun

مخطط يمثل تشغيل تقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	object		‏‏نعم‬
created_by	string	اسم الشخص الذي أنشأ التشغيل.	لا
data_source	object	كائن JsonlRunDataSource مع الذي يحدد ملف JSONL الذي يطابق التقييم	‏‏نعم‬
└─ input_messages	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate أو OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	يستخدم عند أخذ العينات من نموذج. تملي بنية الرسائل التي تم تمريرها إلى النموذج. يمكن أن يكون إما مرجعا لمسار تم إنشاؤه مسبقا (أي)، item.input_trajectoryأو قالب مع مراجع متغيرة item لمساحة الاسم.	لا
└─ item_generation_params	RedTeamItemGenerationParams	معلمات إنشاء العنصر.	لا
└─ نموذج	string	اسم النموذج المراد استخدامه لإنشاء عمليات الإكمال (على سبيل المثال "o3-mini").	لا
└─ sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		لا
└─ المصدر	OpenAI.EvalJsonlFileContentSource أو OpenAI.EvalJsonlFileIdSource أو OpenAI.EvalResponsesSource	تحديد ما يملأ item مساحة الاسم في مصدر بيانات هذا التشغيل.	لا
└─ الهدف	الهدف	التكوين الهدف للتقييم.	لا
└─ النوع	string	نوع مصدر البيانات تمييزي.	لا
خطأ	OpenAI.EvalApiError	كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.	‏‏نعم‬
eval_id	string	معرف التقييم المقترن.	‏‏نعم‬
المعرف	string	معرف فريد لتشغيل التقييم.	‏‏نعم‬
metadata	OpenAI.Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	‏‏نعم‬
نموذج	string	النموذج الذي يتم تقييمه، إن أمكن.	‏‏نعم‬
modified_at	object		لا
الاسم	string	اسم تشغيل التقييم.	‏‏نعم‬
object	enum	نوع الكائن. دائما "eval.run". القيم المحتملة: eval.run	‏‏نعم‬
per_model_usage	صفيف	إحصائيات الاستخدام لكل نموذج أثناء تشغيل التقييم.	‏‏نعم‬
per_testing_criteria_results	صفيف	النتائج لكل معايير الاختبار المطبقة أثناء تشغيل التقييم.	‏‏نعم‬
خصائص	object	مجموعة من أزواج قيم المفاتيح غير القابلة للتغيير والتي يمكن إرفاقها بعنصر لتخزين معلومات إضافية. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
report_url	string	عنوان URL الخاص بالتقييم المعروض يقوم بتشغيل التقرير على لوحة معلومات واجهة المستخدم.	‏‏نعم‬
result_counts	object		‏‏نعم‬
└─ خطأ	OpenAI.integer		لا
└─ فشل	OpenAI.integer		لا
└─ التي تم تمريرها	OpenAI.integer		لا
└─ المجموع	OpenAI.integer		لا
الحالة	string	حالة تشغيل التقييم.	‏‏نعم‬

EvalRunDataSource

الفئة الأساسية لتشغيل مصادر البيانات بدعم تمييزي.

تمييز ل EvalRunDataSource

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

قيمة النوع	Schema
azure_ai_traces	TracesEvalRunDataSource
azure_ai_responses	AzureAIResponses
azure_ai_target_completions	الإكمالات الهدف

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

EvalRunOutputItem

مخطط يمثل عنصر إخراج تشغيل التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	object		‏‏نعم‬
datasource_item	object	تفاصيل عنصر مصدر بيانات الإدخال.	‏‏نعم‬
datasource_item_id	object		‏‏نعم‬
eval_id	string	معرف مجموعة التقييم.	‏‏نعم‬
المعرف	string	معرف فريد لعنصر إخراج تشغيل التقييم.	‏‏نعم‬
object	enum	نوع الكائن. دائما "eval.run.output_item". القيم المحتملة: eval.run.output_item	‏‏نعم‬
results	صفيف	قائمة بنتائج الدرجات لعنصر الإخراج هذا.	‏‏نعم‬
run_id	string	معرف تشغيل التقييم المقترن بعنصر الإخراج هذا.	‏‏نعم‬
عينة	object		‏‏نعم‬
└─ خطأ	OpenAI.EvalApiError	كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.	لا
└─ finish_reason	string		لا
└─ المدخلات	صفيف		لا
└─ max_completion_tokens	OpenAI.integer		لا
└─ نموذج	string		لا
└─ الإخراج	صفيف		لا
└─ البذور	OpenAI.integer		لا
└─ درجة الحرارة	OpenAI.numeric		لا
└─ top_p	OpenAI.numeric		لا
└─ الاستخدام	OpenAI.EvalRunOutputItemSampleUsage		لا
الحالة	string	حالة تشغيل التقييم.	‏‏نعم‬

EvalRunOutputItemResult

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
تسميه	string	التسمية المقترنة بمقياس معايير الاختبار (على سبيل المثال، "pass"، "fail"، "good"، "bad").	لا
metric	string	اسم المقياس (على سبيل المثال، "الطلاقة"، "f1_score").	لا
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
مرت	boolean	ما إذا كان معلم الصف يعتبر الإخراج تمريرا أم لا.	‏‏نعم‬
خصائص	object	تفاصيل إضافية حول مقياس معايير الاختبار.	لا
السبب	string	سبب مقياس معايير الاختبار.	لا
عينة	object	عينة اختيارية أو بيانات متوسطة ينتجها الصف.	لا
score	object		‏‏نعم‬
عتبة	رقم	الحد المستخدم لتحديد النجاح/الفشل لمعايير الاختبار هذه، إذا كان رقميا.	لا
النوع	string	نوع الصف (على سبيل المثال، "string-check-grader").	لا

EvalRunResultCompareItem

مقارنة مترية للعلاج مقابل خط الأساس.

الاسم	النوع	وصف	مطلوب	الإفتراضي
deltaEstimate	رقم	الفرق المقدر بين العلاج وخط الأساس.	‏‏نعم‬
قيمة pValue	رقم	قيمة P لتأثير العلاج.	‏‏نعم‬
معالجة	object	نوع تأثير العلاج.	‏‏نعم‬
معرف المعالجة	string	معرف تشغيل العلاج.	‏‏نعم‬
علاجRunSummary	object	إحصائيات ملخصة لمقياس في تشغيل التقييم.	‏‏نعم‬
└─ المتوسط	رقم	متوسط قيمة المقياس في تشغيل التقييم.	لا
└─ runId	string	معرف تشغيل التقييم.	لا
└─ sampleCount	integer	عدد العينات في تشغيل التقييم.	لا
└─ standardDeviation	رقم	الانحراف المعياري للمقياس في تشغيل التقييم.	لا

EvalRunResultComparison

نتائج المقارنة للعلاج تتعارض مع خط الأساس.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خط الأساسRunSummary	object	إحصائيات ملخصة لمقياس في تشغيل التقييم.	‏‏نعم‬
└─ المتوسط	رقم	متوسط قيمة المقياس في تشغيل التقييم.	لا
└─ runId	string	معرف تشغيل التقييم.	لا
└─ sampleCount	integer	عدد العينات في تشغيل التقييم.	لا
└─ standardDeviation	رقم	الانحراف المعياري للمقياس في تشغيل التقييم.	لا
مقارنة العناصر	صفيف	قائمة بنتائج المقارنة لكل جولة علاجية.	‏‏نعم‬
مقيم	string	اسم المقيم لمعايير الاختبار هذه.	‏‏نعم‬
metric	string	يتم تقييم المقياس.	‏‏نعم‬
اختبارCriteria	string	اسم معايير الاختبار.	‏‏نعم‬

EvalRunResultSummary

إحصائيات ملخصة لمقياس في تشغيل التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
متوسط	رقم	متوسط قيمة المقياس في تشغيل التقييم.	‏‏نعم‬
runId	string	معرف تشغيل التقييم.	‏‏نعم‬
عدد العينات	integer	عدد العينات في تشغيل التقييم.	‏‏نعم‬
الجهاز القياسي	رقم	الانحراف المعياري للمقياس في تشغيل التقييم.	‏‏نعم‬

طلب تقييمComparison

طلب مقارنة التقييم

الاسم	النوع	وصف	مطلوب	الإفتراضي
معرف الأساس	string	معرف تشغيل خط الأساس للمقارنة.	‏‏نعم‬
معرف التقييم	string	معرف التقييم.	‏‏نعم‬
معرفات المعالجة	صفيف	قائمة بمعالجات تشغيل المعرفات للمقارنة.	‏‏نعم‬
النوع	enum	نوع الطلب. القيم المحتملة: EvaluationComparison	‏‏نعم‬

EvaluationResultSample

عينة من نتيجة التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تقييم النتائج	object	نتيجة التقييم.	‏‏نعم‬
└─ الاسم	string	اسم الشيك	لا
└─ التي تم تمريرها	boolean	يشير إلى ما إذا كان الفحص قد اجتاز أو فشل	لا
└─ درجة	رقم	score	لا
└─ النوع	string	نوع الشيك	لا
النوع	enum	نوع عينة نتيجة التقييم القيم المحتملة: EvaluationResultSample	‏‏نعم‬

قاعدة التقييم

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	object	نموذج عمل التقييم.	‏‏نعم‬
└─ النوع	نوع تقييمRuleActionType	نوع إجراء التقييم.	لا
الوصف	string	وصف قاعدة التقييم.	لا
displayName	string	اسم العرض لقاعدة التقييم.	لا
مُمكَّن	boolean	يشير إلى ما إذا كانت قاعدة التقييم ممكنة أم لا. الافتراضي صحيح.	‏‏نعم‬
eventType	object	نوع حدث قاعدة التقييم.	‏‏نعم‬
filter	object	نموذج مرشح التقييم.	لا
└─ agentName	string	التصفية حسب اسم الوكيل.	لا
المعرف	string	معرف فريد لقاعدة التقييم.	‏‏نعم‬
بيانات النظام	object	بيانات تعريف النظام لقاعدة التقييم.	‏‏نعم‬

EvaluationRuleAction

نموذج عمل التقييم.

تمييزي ل EvaluationRuleAction

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

قيمة النوع	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluation	HumanEvaluationRuleAction

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	نوع إجراء التقييم.	‏‏نعم‬

نوع تقييمRuleActionType

نوع إجراء التقييم.

الخاصية	قيمة
الوصف	نوع إجراء التقييم.
Type	string
Values	continuousEvaluation humanEvaluation

نوع حدث التقييم

نوع حدث قاعدة التقييم.

الخاصية	قيمة
الوصف	نوع حدث قاعدة التقييم.
Type	string
Values	responseCompleted manual

EvaluationRuleFilter

نموذج مرشح التقييم.

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

EvaluationRunClusterInsightResult

تقوم الرؤى من التقييم بتشغيل تحليل نظام المجموعة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
clusterInsight	ClusterInsightResult	نتائج تحليلات من تحليل نظام المجموعة.	‏‏نعم‬
النوع	enum	نوع نتيجة الرؤى. القيم المحتملة: EvaluationRunClusterInsight	‏‏نعم‬

EvaluationRunClusterInsightsRequest

رؤى حول مجموعة نتائج التقييم

الاسم	النوع	وصف	مطلوب	الإفتراضي
معرف التقييم	string	معرف التقييم للرؤى.	‏‏نعم‬
تكوين النموذج	object	تكوين النموذج المستخدم في إنشاء الرؤى.	لا
└─ modelDeploymentName	string	نشر النموذج المراد تقييمه. يقبل إما اسم النشر وحده أو باسم الاتصال ك {connectionName}/<modelDeploymentName>.	لا
معرفات التشغيل	صفيف	قائمة معرفات تشغيل التقييم للرؤى.	‏‏نعم‬
النوع	enum	نوع طلب الإحصاءات. القيم المحتملة: EvaluationRunClusterInsight	‏‏نعم‬

مهام جدول التقييم

مهمة تقييم الجدول الزمني.

الاسم	النوع	وصف	مطلوب	الإفتراضي
معرف التقييم	string	معرف مجموعة التقييم.	‏‏نعم‬
evalRun	object	حمولة تشغيل التقييم.	‏‏نعم‬
النوع	enum	القيم المحتملة: Evaluation	‏‏نعم‬

تقييم الxonomy

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	رقم تعريف مادة العرض ، وهو معرف فريد لمادة العرض	لا
الاسم	string	اسم المورد	‏‏نعم‬
خصائص	object	خصائص إضافية لتصنيف التقييم.	لا
فئات التصنيف	صفيف	قائمة فئات التصنيف.	لا
معدل التصنيف	object	تكوين الإدخال لتصنيف التقييم.	‏‏نعم‬
└─ النوع	نوع بيانات التقييم	نوع الإدخال لتصنيف التقييم.	لا
إصدار	string	إصدار المورد	‏‏نعم‬

EvaluationTaxonomyCreateOrUpdate

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	نص وصف الأصل.	لا
خصائص	object	خصائص إضافية لتصنيف التقييم.	لا
العلامات	object	قاموس العلامات. يمكن إضافة العلامات وإزالتها وتحديثها.	لا
فئات التصنيف	صفيف	قائمة فئات التصنيف.	لا
معدل التصنيف	object	تكوين الإدخال لتصنيف التقييم.	‏‏نعم‬
└─ النوع	نوع بيانات التقييم	نوع الإدخال لتصنيف التقييم.	لا

EvaluationTaxonomyInput

تكوين الإدخال لتصنيف التقييم.

تمييزي ل EvaluationTaxonomyInput

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

قيمة النوع	Schema
agent	AgentTaxonomyInput

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	نوع مدخلات تصنيف التقييم.	‏‏نعم‬

نوع بيانات التقييم

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

الخاصية	قيمة
الوصف	نوع مدخلات تصنيف التقييم.
Type	string
Values	agent policy

EvaluationTaxonomyInputUpdate

تكوين الإدخال لتصنيف التقييم.

تمييزي ل EvaluationTaxonomyInputUpdate

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

قيمة النوع	Schema
agent	AgentTaxonomyInputUpdate

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	نوع مدخلات تصنيف التقييم.	‏‏نعم‬

EvaluationTaxonomyUpdate

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	نص وصف الأصل.	لا
خصائص	object	خصائص إضافية لتصنيف التقييم.	لا
العلامات	object	قاموس العلامات. يمكن إضافة العلامات وإزالتها وتحديثها.	لا
فئات التصنيف	صفيف	قائمة فئات التصنيف.	لا
معدل التصنيف	object	تكوين الإدخال لتصنيف التقييم.	لا
└─ النوع	نوع بيانات التقييم	نوع الإدخال لتصنيف التقييم.	لا

فئة المقيم

فئة المقيم

الخاصية	قيمة
الوصف	فئة المقيم
Type	string
Values	quality safety agents

تعريف التقييم

تكوين المقيم الأساسي مع المميز

تمييزي للمقيم تعريف

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

قيمة النوع	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

الاسم	النوع	وصف	مطلوب	الإفتراضي
data_schema		مخطط JSON (مسودة 2020-12) لبيانات إدخال المقيم. يتضمن ذلك معلمات مثل النوع والخصائص المطلوبة.	لا
init_parameters		مخطط JSON (مسودة 2020-12) لمعلمات إدخال المقيم. يتضمن ذلك معلمات مثل النوع والخصائص المطلوبة.	لا
المقاييس	object	قائمة مقاييس المخرجات التي أنتجها هذا المقيم	لا
النوع	object	نوع تعريف المقيم	‏‏نعم‬

نوع تعريف التقييم

نوع تعريف المقيم

الخاصية	قيمة
الوصف	نوع تعريف المقيم
Type	string
Values	prompt code prompt_and_code service openai_graders

مقياس التقييم

مقياس المقيم

الاسم	النوع	وصف	مطلوب	الإفتراضي
desirable_direction	object	اتجاه المقياس يشير إلى ما إذا كانت القيمة الأعلى أفضل أو قيمة أقل أفضل أو محايدة	لا
is_primary	boolean	يشير هذا الإعداد إلى ما إذا كان هذا المقياس أساسيا عندما تكون هناك مقاييس متعددة.	لا
max_value	رقم	الحد الأقصى لقيمة المقياس. إذا لم يتم تحديده ، فمن المفترض أنه غير محدود.	لا
min_value	رقم	الحد الأدنى لقيمة المقياس	لا
النوع	object	نوع المقيم	لا

المقيمالمعرف المتماثل

اتجاه المقياس يشير إلى ما إذا كانت القيمة الأعلى أفضل أو قيمة أقل أفضل أو محايدة

الخاصية	قيمة
الوصف	اتجاه المقياس يشير إلى ما إذا كانت القيمة الأعلى أفضل أو قيمة أقل أفضل أو محايدة
Type	string
Values	increase decrease neutral

نوع مقياس التقييم

نوع المقيم

الخاصية	قيمة
الوصف	نوع المقيم
Type	string
Values	ordinal continuous boolean

نوع التقييم

نوع المقيم

الخاصية	قيمة
الوصف	نوع المقيم
Type	string
Values	builtin custom

إصدار المقيم

تعريف المقيم

الاسم	النوع	وصف	مطلوب	الإفتراضي
فئات	صفيف	فئات المقيم	‏‏نعم‬
created_at	integer	تاريخ / وقت إنشاء المقيم	‏‏نعم‬
created_by	string	منشئ المقيم	‏‏نعم‬
تعريف	object	تكوين المقيم الأساسي مع المميز	‏‏نعم‬
└─ data_schema		مخطط JSON (مسودة 2020-12) لبيانات إدخال المقيم. يتضمن ذلك معلمات مثل النوع والخصائص المطلوبة.	لا
└─ init_parameters		مخطط JSON (مسودة 2020-12) لمعلمات إدخال المقيم. يتضمن ذلك معلمات مثل النوع والخصائص المطلوبة.	لا
└─ المقاييس	object	قائمة مقاييس المخرجات التي أنتجها هذا المقيم	لا
└─ النوع	نوع تعريف التقييم	نوع تعريف المقيم	لا
display_name	string	اسم العرض للمقيم. يساعد على العثور على المقيم بسهولة في Foundry. لا يجب أن تكون فريدة من نوعها.	لا
evaluator_type	object	نوع المقيم	‏‏نعم‬
المعرف	string	رقم تعريف مادة العرض ، وهو معرف فريد لمادة العرض	لا
metadata	object	بيانات التعريف حول المقيم	لا
modified_at	integer	تاريخ / وقت آخر تعديل للمقيم	‏‏نعم‬
الاسم	string	اسم المورد	‏‏نعم‬
إصدار	string	إصدار المورد	‏‏نعم‬

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

تعريف المقيم

الاسم	النوع	وصف	مطلوب	الإفتراضي
فئات	صفيف	فئات المقيم	‏‏نعم‬
تعريف	object	تكوين المقيم الأساسي مع المميز	‏‏نعم‬
└─ data_schema		مخطط JSON (مسودة 2020-12) لبيانات إدخال المقيم. يتضمن ذلك معلمات مثل النوع والخصائص المطلوبة.	لا
└─ init_parameters		مخطط JSON (مسودة 2020-12) لمعلمات إدخال المقيم. يتضمن ذلك معلمات مثل النوع والخصائص المطلوبة.	لا
└─ المقاييس	object	قائمة مقاييس المخرجات التي أنتجها هذا المقيم	لا
└─ النوع	نوع تعريف التقييم	نوع تعريف المقيم	لا
الوصف	string	نص وصف الأصل.	لا
display_name	string	اسم العرض للمقيم. يساعد على العثور على المقيم بسهولة في Foundry. لا يجب أن تكون فريدة من نوعها.	لا
evaluator_type	object	نوع المقيم	‏‏نعم‬
metadata	object	بيانات التعريف حول المقيم	لا
العلامات	object	قاموس العلامات. يمكن إضافة العلامات وإزالتها وتحديثها.	لا

تحديث إصدار المقيم

تعريف المقيم

الاسم	النوع	وصف	مطلوب	الإفتراضي
فئات	صفيف	فئات المقيم	لا
الوصف	string	نص وصف الأصل.	لا
display_name	string	اسم العرض للمقيم. يساعد على العثور على المقيم بسهولة في Foundry. لا يجب أن تكون فريدة من نوعها.	لا
metadata	object	بيانات التعريف حول المقيم	لا
العلامات	object	قاموس العلامات. يمكن إضافة العلامات وإزالتها وتحديثها.	لا

FabricDataAgentToolParameters

معلمات أداة عامل بيانات البنية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
project_connections	صفيف	project الاتصالات المرفقة بهذه الأداة. يمكن أن يكون هناك اتصال 1 كحد أقصى المورد المرفق بالأداة.	لا

FileDatasetVersion

FileDatasetتعريف الإصدار

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

FileDatasetVersionUpdate

FileDatasetتعريف الإصدار

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

FolderDatasetVersion

FileDatasetتعريف الإصدار

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

تحديث إصدار FolderDataset

FileDatasetتعريف الإصدار

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

معرف HostedAgentDefinition

تعريف الوكيل المستضاف.

تمييز ل HostedAgentDefinition

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

قيمة النوع	Schema
hosted	ImageBasedHostedAgentDefinition

الاسم	النوع	وصف	مطلوب	الإفتراضي
container_protocol_versions	صفيف	البروتوكولات التي يدعمها العامل لاتصال دخول الحاويات.	‏‏نعم‬
وحده المعالجه المركزيه	string	تكوين وحدة المعالجة المركزية للعامل المستضاف.	‏‏نعم‬
environment_variables	object	متغيرات البيئة المطلوب تعيينها في حاوية العامل المستضافة.	لا
النوع	enum	القيم المحتملة: hosted	‏‏نعم‬
ذاكرة	string	تكوين الذاكرة للعامل المستضاف.	‏‏نعم‬
الأدوات	صفيف	مجموعة من الأدوات التي قد يستدعيها نموذج الوكيل المستضاف أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice .	لا

جدول التكرار كل ساعة

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: Hourly	‏‏نعم‬

HumanEvaluationRuleAction

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
معرف القالب	object	معرف أصل محفوظ.	‏‏نعم‬
النوع	enum	القيم المحتملة: humanEvaluation	‏‏نعم‬

ImageBasedHostedAgentDefinition

تعريف النشر المستند إلى الصورة لعامل مستضاف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
صورة	string	صورة الوكيل المستضاف.	‏‏نعم‬
النوع	enum	القيم المحتملة: hosted	‏‏نعم‬

الفهرس

تعريف مورد الفهرس

تمييزي للفهرس

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

قيمة النوع	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

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

نوع الفهرس

الخاصية	قيمة
Type	string
Values	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

تحديث الفهرس

تعريف مورد الفهرس

تمييزي ل IndexUpdate

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

قيمة النوع	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

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

رؤية

نص الاستجابة لنتائج تحليلات نظام المجموعة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
displayName	string	اسم عرض سهل الاستخدام للبصيرة.	‏‏نعم‬
المعرف	string	المعرف الفريد لتقرير الإحصاءات.	‏‏نعم‬
metadata	object	البيانات الوصفية حول الرؤى.	‏‏نعم‬
└─ completedAt	string	الطابع الزمني عند اكتمال الرؤى.	لا
└─ createdAt	string	الطابع الزمني عند إنشاء الرؤى.	لا
طلب	object	طلب تقرير الإحصاءات.	‏‏نعم‬
└─ النوع	InsightType	نوع الطلب.	لا
نتيجة	object	نتيجة الرؤى.	لا
└─ النوع	InsightType	نوع نتيجة الرؤى.	لا
حالة	object	Enum يصف حالات التشغيل المسموح بها.	‏‏نعم‬

InsightCluster

مجموعة من عينات التحليل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف مجموعة التحليل.	‏‏نعم‬
المعرف	string	معرف مجموعة التحليل.	‏‏نعم‬
تسميه	string	تسمية نظام المجموعة	‏‏نعم‬
العينات	صفيف	قائمة العينات التي تنتمي إلى هذه المجموعة. فارغة إذا كانت العينات جزءا من مجموعات فرعية.	لا
المجموعات الفرعية	صفيف	قائمة المجموعات الفرعية داخل هذه المجموعة. فارغة في حالة عدم وجود مجموعات فرعية.	لا
اقتراح	string	اقتراح للمجموعة	‏‏نعم‬
suggestionTitle	string	عنوان الاقتراح المتعلق بالمجموعة	‏‏نعم‬
weight	integer	وزن مجموعة التحليل. يشير هذا إلى عدد العينات في المجموعة.	‏‏نعم‬

تكوين InsightModel

تكوين النموذج المستخدم في إنشاء الرؤى.

الاسم	النوع	وصف	مطلوب	الإفتراضي
modelDeploymentName	string	نشر النموذج المراد تقييمه. يقبل إما اسم النشر وحده أو باسم الاتصال ك {connectionName}/<modelDeploymentName>.	‏‏نعم‬

طلب نتائج التحليلات

طلب تقرير الإحصاءات.

تمييزي ل InsightRequest

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

قيمة النوع	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightsRequest
AgentClusterInsight	طلب طلب العميلClusterInsights
EvaluationComparison	طلب تقييمComparison

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	طلب الرؤى.	‏‏نعم‬

نتائج التحليلات

نتيجة الرؤى.

تمييزي ل InsightResult

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

قيمة النوع	Schema
EvaluationComparison	EvalCompareReport
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	عاملClusterInsightResult

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	طلب الرؤى.	‏‏نعم‬

InsightSample

عينة من التحليل.

تمييزي ل InsightSample

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

قيمة النوع	Schema
EvaluationResultSample	EvaluationResultSample

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

InsightScheduleTask

مهمة الرؤية للجدول الزمني.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نتيجة تحليلات	object	نص الاستجابة لنتائج تحليلات نظام المجموعة.	‏‏نعم‬
└─ displayName	string	اسم عرض سهل الاستخدام للبصيرة.	لا
└─ الهوية	string	المعرف الفريد لتقرير الإحصاءات.	لا
└─ البيانات الوصفية	InsightsMetadata	البيانات الوصفية حول تقرير الإحصاءات.	لا
└─ طلب	طلب نتائج التحليلات	طلب تحليل الرؤى.	لا
└─ نتيجة	نتائج التحليلات	نتيجة تقرير الإحصاءات.	لا
└─ الحالة	Azure. Core.Foundations.OperationState	الوضع الحالي للرؤى.	لا
النوع	enum	القيم المحتملة: Insight	‏‏نعم‬

InsightSummary

ملخص تحليل مجموعة الخطأ.

الاسم	النوع	وصف	مطلوب	الإفتراضي
method	string	الطريقة المستخدمة للتجميع.	‏‏نعم‬
عدد العينات	integer	إجمالي عدد العينات التي تم تحليلها.	‏‏نعم‬
عدد المجموعات الفريدة	integer	إجمالي عدد المجموعات الفريدة.	‏‏نعم‬
uniqueSubclusterCount	integer	إجمالي عدد تسميات نظام المجموعة الفرعي الفريدة.	‏‏نعم‬
استخدام	object	استخدام الرمز المميز لتحليل نظام المجموعة	‏‏نعم‬
└─ inputTokenUsage	integer	إدخال استخدام الرمز المميز	لا
└─ outputTokenUsage	integer	استخدام الرمز المميز الناتج	لا
└─ totalTokenUsage	integer	إجمالي استخدام الرمز المميز	لا

InsightType

طلب الرؤى.

الخاصية	قيمة
Type	string
Values	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

البيانات الوصفية حول الرؤى.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تاريخ الاكتمال	string	الطابع الزمني عند اكتمال الرؤى.	لا
إنشاء قاعدة بيانات	string	الطابع الزمني عند إنشاء الرؤى.	‏‏نعم‬

ItemGenerationParams

يمثل مجموعة المعلمات المستخدمة للتحكم في عمليات إنشاء العناصر.

تمييزي ل ItemGenerationParams

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

قيمة النوع	Schema

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

ManagedAzureAISearchIndex

تعريف فهرس Azure AI Search المدار

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

ManagedAzureAISearchIndexUpdate

تعريف فهرس Azure AI Search المدار

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

عنصر الذاكرة

عنصر ذاكرة واحد مخزن في مخزن الذاكرة، يحتوي على المحتوى والبيانات الوصفية.

تمييزي ل MemoryItem

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

قيمة النوع	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

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

MemoryItemKind

نوع عنصر الذاكرة.

الخاصية	قيمة
الوصف	نوع عنصر الذاكرة.
Type	string
Values	user_profile chat_summary

MemoryOperation

يمثل عملية ذاكرة واحدة (إنشاء أو تحديث أو حذف) يتم إجراؤها على عنصر ذاكرة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	نوع تشغيل الذاكرة.	‏‏نعم‬
memory_item	object	عنصر ذاكرة واحد مخزن في مخزن الذاكرة، يحتوي على المحتوى والبيانات الوصفية.	‏‏نعم‬
└─ المحتوى	string	محتوى الذاكرة.	لا
└─ نوع	MemoryItemKind	نوع عنصر الذاكرة.	لا
└─ memory_id	string	المعرف الفريد لعنصر الذاكرة.	لا
└─ النطاق	string	مساحة الاسم التي تجمع الذكريات وتعزلها منطقيا، مثل معرف المستخدم.	لا
└─ updated_at	integer	آخر وقت تحديث لعنصر الذاكرة.	لا

MemoryOperationKind

نوع تشغيل الذاكرة.

الخاصية	قيمة
الوصف	نوع تشغيل الذاكرة.
Type	string
Values	create update delete

MemorySearchItem

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
memory_item	object	عنصر ذاكرة واحد مخزن في مخزن الذاكرة، يحتوي على المحتوى والبيانات الوصفية.	‏‏نعم‬
└─ المحتوى	string	محتوى الذاكرة.	لا
└─ نوع	MemoryItemKind	نوع عنصر الذاكرة.	لا
└─ memory_id	string	المعرف الفريد لعنصر الذاكرة.	لا
└─ النطاق	string	مساحة الاسم التي تجمع الذكريات وتعزلها منطقيا، مثل معرف المستخدم.	لا
└─ updated_at	integer	آخر وقت تحديث لعنصر الذاكرة.	لا

عمليات البحث عن الذاكرة

خيارات البحث عن الذاكرة.

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

MemorySearchTool

أداة لدمج الذكريات في الوكيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
memory_store_name	string	اسم مخزن الذاكرة المراد استخدامه.	‏‏نعم‬
نطاق	string	مساحة الاسم المستخدمة لتجميع الذكريات وعزلها، مثل رقم تعريف المستخدم. يحد من الذكريات التي يمكن استردادها أو تحديثها. استخدم متغيرا {{$userId}} خاصا لتحديد نطاق الذكريات للمستخدم الحالي الذي قام بتسجيل الدخول.	‏‏نعم‬
search_options	object	خيارات البحث عن الذاكرة.	لا
└─ max_memories	integer	الحد الأقصى لعدد عناصر الذاكرة المراد إرجاعها.	لا
النوع	enum	نوع الأداة. دائمًا memory_search. القيم المحتملة: memory_search	‏‏نعم‬
update_delay	integer	وقت الانتظار قبل تحديث الذكريات بعد عدم النشاط (ثوان). الافتراضي 300.	لا	300

MemorySearchToolCallItemParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
results	صفيف	تم إرجاع النتائج من البحث في الذاكرة.	لا
النوع	enum	القيم المحتملة: memory_search_call	‏‏نعم‬

MemorySearchToolCallItemResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
results	صفيف	تم إرجاع النتائج من البحث في الذاكرة.	لا
الحالة	enum	حالة استدعاء أداة البحث في الذاكرة. واحد من in_progress، searchingأو completedأو incomplete أو failed القيم المحتملة: in_progress، searching، completed، ، incompletefailed	‏‏نعم‬
النوع	enum	القيم المحتملة: memory_search_call	‏‏نعم‬

MemoryStoreDefaultDefinition

تنفيذ مخزن الذاكرة الافتراضي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
chat_model	string	اسم أو معرف نشر نموذج إكمال الدردشة المستخدم لمعالجة الذاكرة.	‏‏نعم‬
embedding_model	string	اسم أو معرف نشر نموذج التضمين المستخدم لمعالجة الذاكرة.	‏‏نعم‬
النوع	enum	نوع مخزن الذاكرة. القيم المحتملة: default	‏‏نعم‬
options	object	تكوينات مخزن الذاكرة الافتراضية.	لا
└─ chat_summary_enabled	boolean	ما إذا كان يجب تمكين استخراج ملخص الدردشة storage. الافتراضي صحيح.	لا	صحيح
└─ user_profile_details	string	فئات أو أنواع محددة من معلومات ملف تعريف المستخدم لاستخراجها وتخزينها.	لا
└─ user_profile_enabled	boolean	ما إذا كان يجب تمكين استخراج ملف تعريف المستخدم storage. الافتراضي صحيح.	لا	صحيح

MemoryStoreDefaultOptions

تكوينات مخزن الذاكرة الافتراضية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
chat_summary_enabled	boolean	ما إذا كان يجب تمكين استخراج ملخص الدردشة storage. الافتراضي صحيح.	‏‏نعم‬	صحيح
user_profile_details	string	فئات أو أنواع محددة من معلومات ملف تعريف المستخدم لاستخراجها وتخزينها.	لا
user_profile_enabled	boolean	ما إذا كان يجب تمكين استخراج ملف تعريف المستخدم storage. الافتراضي صحيح.	‏‏نعم‬	صحيح

معرف مخزن الذاكرة

التعريف الأساسي لتكوينات مخزن الذاكرة.

تمييز ل MemoryStoreDefinition

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

قيمة النوع	Schema
default	MemoryStoreDefaultDefinition

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	نوع تنفيذ مخزن الذاكرة المراد استخدامه.	‏‏نعم‬

MemoryStoreDeleteScopeResponse

استجابة لحذف الذكريات من النطاق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean	ما إذا كانت عملية الحذف ناجحة أم لا.	‏‏نعم‬
الاسم	string	اسم مخزن الذاكرة.	‏‏نعم‬
object	enum	نوع الكائن. دائما "memory_store.scope.deleted". القيم المحتملة: memory_store.scope.deleted	‏‏نعم‬
نطاق	string	النطاق الذي تم حذف الذكريات منه.	‏‏نعم‬

MemoryStoreKind

نوع تنفيذ مخزن الذاكرة المراد استخدامه.

الخاصية	قيمة
الوصف	نوع تنفيذ مخزن الذاكرة المراد استخدامه.
Type	string
Values	default

MemoryStoreObject

مخزن ذاكرة يمكنه تخزين ذكريات المستخدم واستردادها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني ليونكس (بالثواني) عند إنشاء مخزن الذاكرة.	‏‏نعم‬
تعريف	object	التعريف الأساسي لتكوينات مخزن الذاكرة.	‏‏نعم‬
└─ نوع	MemoryStoreKind	نوع مخزن الذاكرة.	لا
الوصف	string	وصف يمكن للإنسان قراءته لمخزن الذاكرة.	لا
المعرف	string	المعرف الفريد لمخزن الذاكرة.	‏‏نعم‬
metadata	object	بيانات تعريف قيمة المفتاح العشوائية لإقرانها بمخزن الذاكرة.	لا
الاسم	string	اسم مخزن الذاكرة.	‏‏نعم‬
object	enum	نوع الكائن ، والذي يكون دائما "memory_store". القيم المحتملة: memory_store	‏‏نعم‬
updated_at	integer	الطابع الزمني ليونكس (بالثواني) عند آخر تحديث لمخزن الذاكرة.	‏‏نعم‬

MemoryStoreOperationUsage

إحصائيات الاستخدام لعملية مخزن الذاكرة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
embedding_tokens	integer	عدد الرموز المميزة المضمنة.	‏‏نعم‬
input_tokens	integer	عدد رموز الإدخال.	‏‏نعم‬
input_tokens_details	object	تحليل مفصل للرموز المميزة للإدخال.	‏‏نعم‬
└─ cached_tokens	integer	عدد الرموز المميزة التي تم استردادها من ذاكرة التخزين المؤقت. التخزين المؤقت للمطالبة.	لا
output_tokens	integer	عدد الرموز المميزة للإخراج.	‏‏نعم‬
output_tokens_details	object	تحليل مفصل للرموز المميزة للإخراج.	‏‏نعم‬
└─ reasoning_tokens	integer	عدد الرموز المميزة المنطقية.	لا
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة.	‏‏نعم‬

MemoryStoreSearchResponse

استجابة البحث عن الذاكرة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
ذكريات	صفيف	عناصر الذاكرة ذات الصلة التي تم العثور عليها أثناء عملية البحث.	‏‏نعم‬
search_id	string	المعرف الفريد لطلب البحث هذا. استخدم هذه القيمة previous_search_id في الطلبات اللاحقة لإجراء عمليات بحث متزايدة.	‏‏نعم‬
استخدام	object	إحصائيات الاستخدام لعملية مخزن الذاكرة.	‏‏نعم‬
└─ embedding_tokens	integer	عدد الرموز المميزة المضمنة.	لا
└─ input_tokens	integer	عدد رموز الإدخال.	لا
└─ input_tokens_details	object	تحليل مفصل للرموز المميزة للإدخال.	لا
└─ cached_tokens	integer	عدد الرموز المميزة التي تم استردادها من ذاكرة التخزين المؤقت. التخزين المؤقت للمطالبة.	لا
└─ output_tokens	integer	عدد الرموز المميزة للإخراج.	لا
└─ output_tokens_details	object	تحليل مفصل للرموز المميزة للإخراج.	لا
└─ reasoning_tokens	integer	عدد الرموز المميزة المنطقية.	لا
└─ total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة.	لا

MemoryStoreUpdateCompletedResult

نتيجة تحديث الذاكرة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
memory_operations	صفيف	قائمة بعمليات الذاكرة الفردية التي تم إجراؤها أثناء التحديث.	‏‏نعم‬
استخدام	object	إحصائيات الاستخدام لعملية مخزن الذاكرة.	‏‏نعم‬
└─ embedding_tokens	integer	عدد الرموز المميزة المضمنة.	لا
└─ input_tokens	integer	عدد رموز الإدخال.	لا
└─ input_tokens_details	object	تحليل مفصل للرموز المميزة للإدخال.	لا
└─ cached_tokens	integer	عدد الرموز المميزة التي تم استردادها من ذاكرة التخزين المؤقت. التخزين المؤقت للمطالبة.	لا
└─ output_tokens	integer	عدد الرموز المميزة للإخراج.	لا
└─ output_tokens_details	object	تحليل مفصل للرموز المميزة للإخراج.	لا
└─ reasoning_tokens	integer	عدد الرموز المميزة المنطقية.	لا
└─ total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة.	لا

MemoryStoreUpdateResponse

يوفر حالة عملية تحديث مخزن الذاكرة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	object		لا
└─ معلومات إضافية	object		لا
└─ كود	string		لا
└─ debugInfo	object		لا
└─ التفاصيل	صفيف		لا
└─ رسالة	string		لا
└─ معلمة	string		لا
└─ النوع	string		لا
نتيجة	object	نتيجة تحديث الذاكرة.	لا
└─ memory_operations	صفيف	قائمة بعمليات الذاكرة الفردية التي تم إجراؤها أثناء التحديث.	لا
└─ الاستخدام	MemoryStoreOperationUsage	إحصائيات الاستخدام المرتبطة بعملية تحديث الذاكرة.	لا
الحالة	object	حالة عملية تحديث مخزن الذاكرة.	‏‏نعم‬
superseded_by	string	تم استبدال update_id العملية ب "استبدال" الحالة.	لا
update_id	string	المعرف الفريد لطلب التحديث هذا. استخدم هذه القيمة previous_update_id في الطلبات اللاحقة لإجراء تحديثات تزايدية.	‏‏نعم‬

MemoryStoreUpdateStatus

حالة عملية تحديث مخزن الذاكرة.

الخاصية	قيمة
الوصف	حالة عملية تحديث مخزن الذاكرة.
Type	string
Values	queued in_progress completed failed superseded

MicrosoftFabricAgentTool

معلومات تعريف الإدخال لأداة Microsoft Fabric كما هو مستخدم لتكوين عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
fabric_dataagent_preview	object	معلمات أداة عامل بيانات البنية.	‏‏نعم‬
└─ project_connections	صفيف	project الاتصالات المرفقة بهذه الأداة. يمكن أن يكون هناك اتصال 1 كحد أقصى المورد المرفق بالأداة.	لا
النوع	enum	نوع الكائن، وهو دائما "fabric_dataagent". القيم المحتملة: fabric_dataagent_preview	‏‏نعم‬

توزيع النموذج

تعريف نشر النموذج

الاسم	النوع	وصف	مطلوب	الإفتراضي
capabilities	object	قدرات النموذج المنشور	‏‏نعم‬
اسم الاتصال	string	اسم الاتصال الذي يأتي منه التوزيع	لا
modelName	string	Publisher اسم خاص بالنموذج المنشور	‏‏نعم‬
modelPublisher	string	اسم publisher النموذج المنشور	‏‏نعم‬
إصدار النموذج	string	Publisher إصدار خاص بالنموذج المنشور	‏‏نعم‬
sku	object	معلومات Sku	‏‏نعم‬
└─ السعة	integer	سعة Sku	لا
└─ العائلة	string	عائلة SKU	لا
└─ الاسم	string	اسم Sku	لا
└─ الحجم	string	حجم رمز المنتج:	لا
└─ المستوى	string	مستوى Sku	لا
النوع	enum	نوع التوزيع القيم المحتملة: ModelDeployment	‏‏نعم‬

ModelSamplingParams

يمثل مجموعة من المعلمات المستخدمة للتحكم في سلوك أخذ العينات لنموذج لغة أثناء إنشاء النص.

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_completion_tokens	integer	الحد الأقصى لعدد الرموز المميزة المسموح بها في الاكتمال.	‏‏نعم‬
seed	integer	البذور العشوائية ل القابلية للتكرار.	‏‏نعم‬
درجة الحرارة	رقم	معلمة درجة الحرارة لأخذ العينات.	‏‏نعم‬
top_p	رقم	المعلمة top-p لأخذ عينات النواة.	‏‏نعم‬

ModelSamplingParamsUpdate

يمثل مجموعة من المعلمات المستخدمة للتحكم في سلوك أخذ العينات لنموذج لغة أثناء إنشاء النص.

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_completion_tokens	integer	الحد الأقصى لعدد الرموز المميزة المسموح بها في الاكتمال.	لا
seed	integer	البذور العشوائية ل القابلية للتكرار.	لا
درجة الحرارة	رقم	معلمة درجة الحرارة لأخذ العينات.	لا
top_p	رقم	المعلمة top-p لأخذ عينات النواة.	لا

جدول التكرار الشهري

جدول التكرار الشهري.

الاسم	النوع	وصف	مطلوب	الإفتراضي
daysOfMonth	صفيف	أيام الشهر لجدول التكرار.	‏‏نعم‬
النوع	enum	نوع التكرار الشهري. القيم المحتملة: Monthly	‏‏نعم‬

NoAuthenticationCredentials

بيانات الاعتماد التي لا تتطلب المصادقة

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع بيانات الاعتماد القيم المحتملة: None	‏‏نعم‬

OAuthConsentRequestItemResource

طلب من الخدمة للمستخدم لتنفيذ موافقة OAuth.

الاسم	النوع	وصف	مطلوب	الإفتراضي
consent_link	string	الارتباط الذي يمكن للمستخدم استخدامه لتنفيذ موافقة OAuth.	‏‏نعم‬
المعرف	string		‏‏نعم‬
server_label	string	تسمية الخادم لطلب موافقة OAuth.	‏‏نعم‬
النوع	enum	القيم المحتملة: oauth_consent_request	‏‏نعم‬

OneTimeTrigger

مشغل لمرة واحدة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
timeZone	string	المنطقة الزمنية للمشغل لمرة واحدة.	لا	التوقيت العالمي المتفق عليه
triggerAt	string	تاريخ ووقت المشغل لمرة واحدة بتنسيق ISO 8601.	‏‏نعم‬
النوع	enum	القيم المحتملة: OneTime	‏‏نعم‬

OpenAI.التعليق التوضيحي

المميز ل OpenAI.Annotation

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

قيمة النوع	Schema
file_citation	OpenAI.AnnotationFileCitation
url_citation	OpenAI.AnnotationUrlCitation
file_path	OpenAI.AnnotationFilePath

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

OpenAI.AnnotationFileCitation

اقتباس إلى ملف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	string	معرف الملف.	‏‏نعم‬
filename	string	اسم ملف الملف المذكور.	‏‏نعم‬
الفهرس	integer	فهرس الملف في قائمة الملفات.	‏‏نعم‬
النوع	enum	نوع الاقتباس من الملف. دائمًا file_citation. القيم المحتملة: file_citation	‏‏نعم‬

OpenAI.AnnotationFilePath

مسار إلى ملف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	string	معرف الملف.	‏‏نعم‬
الفهرس	integer	فهرس الملف في قائمة الملفات.	‏‏نعم‬
النوع	enum	نوع مسار الملف. دائمًا file_path. القيم المحتملة: file_path	‏‏نعم‬

OpenAI.AnnotationType

الخاصية	قيمة
Type	string
Values	file_citation url_citation file_path container_file_citation

OpenAI.AnnotationUrlCitation

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
end_index	integer	فهرس الحرف الأخير من اقتباس عنوان URL في الرسالة.	‏‏نعم‬
start_index	integer	فهرس الحرف الأول من اقتباس عنوان URL في الرسالة.	‏‏نعم‬
العنوان	string	عنوان مورد الويب.	‏‏نعم‬
النوع	enum	نوع اقتباس عنوان URL. دائمًا url_citation. القيم المحتملة: url_citation	‏‏نعم‬
عنوان URL	string	عنوان URL لمورد الويب.	‏‏نعم‬

OpenAI.ApproximateLocation

الاسم	النوع	وصف	مطلوب	الإفتراضي
مدينة	string		لا
country	string		لا
region	string		لا
المنطقة الزمنية	string		لا
النوع	enum	القيم المحتملة: approximate	‏‏نعم‬

OpenAI.ChatCompletionTool

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

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

OpenAI.CodeInterpreterOutput

المميز ل OpenAI.CodeInterpreterOutput

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

قيمة النوع	Schema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

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

OpenAI.CodeInterpreterOutputImage

إخراج الصورة من مترجم الكود.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الإخراج. دائما "صورة". القيم المحتملة: image	‏‏نعم‬
عنوان URL	string	عنوان URL لإخراج الصورة من مترجم التعليمات البرمجية.	‏‏نعم‬

OpenAI.CodeInterpreterOutputLogs

إخراج السجلات من مترجم التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
logs	string	إخراج السجلات من مترجم التعليمات البرمجية.	‏‏نعم‬
النوع	enum	نوع الإخراج. دائما "سجلات". القيم المحتملة: logs	‏‏نعم‬

OpenAI.CodeInterpreterOutputType

الخاصية	قيمة
Type	string
Values	logs image

OpenAI.CodeInterpreterTool

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
container	object	تكوين حاوية مترجم التعليمات البرمجية. تحديد المعرف اختياريا من الملفات لتشغيل التعليمات البرمجية عليها.	‏‏نعم‬
└─ file_ids	صفيف	قائمة اختيارية بالملفات التي تم تحميلها لتوفيرها للتعليمات البرمجية الخاصة بك.	لا
└─ النوع	enum	دائمًا auto. القيم المحتملة: auto	لا
النوع	enum	نوع أداة مترجم التعليمات البرمجية. دائمًا code_interpreter. القيم المحتملة: code_interpreter	‏‏نعم‬

OpenAI.CodeInterpreterToolAuto

تكوين حاوية مترجم التعليمات البرمجية. حدد معرفات الملفات لتشغيل التعليمات البرمجية عليها اختياريا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_ids	صفيف	قائمة اختيارية بالملفات التي تم تحميلها لتوفيرها للتعليمات البرمجية الخاصة بك.	لا
النوع	enum	دائمًا auto. القيم المحتملة: auto	‏‏نعم‬

OpenAI.CodeInterpreterToolCallItemParam

استدعاء أداة لتشغيل التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	string	الرمز المراد تشغيله ، أو فارغ إذا لم يكن متاحا.	‏‏نعم‬
container_id	string	معرف الحاوية المستخدمة لتشغيل التعليمات البرمجية.	‏‏نعم‬
outputs	صفيف	المخرجات التي تم إنشاؤها بواسطة مترجم التعليمات البرمجية، مثل السجلات أو الصور. يمكن أن تكون فارغة إذا لم تتوفر مخرجات.	‏‏نعم‬
النوع	enum	القيم المحتملة: code_interpreter_call	‏‏نعم‬

OpenAI.CodeInterpreterToolCallItemResource

استدعاء أداة لتشغيل التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	string	الرمز المراد تشغيله ، أو فارغ إذا لم يكن متاحا.	‏‏نعم‬
container_id	string	معرف الحاوية المستخدمة لتشغيل التعليمات البرمجية.	‏‏نعم‬
outputs	صفيف	المخرجات التي تم إنشاؤها بواسطة مترجم التعليمات البرمجية، مثل السجلات أو الصور. يمكن أن تكون فارغة إذا لم تتوفر مخرجات.	‏‏نعم‬
الحالة	enum	القيم المحتملة: in_progress، completed، incomplete، ، interpretingfailed	‏‏نعم‬
النوع	enum	القيم المحتملة: code_interpreter_call	‏‏نعم‬

OpenAI.ComparisonFilter

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
مفتاح	string	المفتاح للمقارنة مقابل القيمة.	‏‏نعم‬
النوع	enum	تحديد عامل المقارنة: eq (يساوي)، ne (لا يساوي)، gt (أكبر من)، gte (أكبر من أو يساوي)، lt (أقل من)، lte (أقل من أو يساوي). القيم المحتملة: eq، ne، gt، gte، ، ltlte	‏‏نعم‬
القيمة	سلسلة أو رقم أو قيمة منطقية		‏‏نعم‬

OpenAI.CompoundFilter

دمج عوامل تصفية متعددة باستخدام and أو or.

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	صفيف	صفيف عوامل التصفية المراد دمجها. يمكن أن تكون ComparisonFilter العناصر أو CompoundFilter.	‏‏نعم‬
النوع	enum	نوع العملية: and أو or. القيم المحتملة: and، or	‏‏نعم‬

OpenAI.ComputerAction

المميز ل OpenAI.ComputerAction

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

قيمة النوع	Schema
click	OpenAI.ComputerActionانقر
double_click	OpenAI.ComputerActionDoubleClick
drag	OpenAI.ComputerActionDrag
move	OpenAI.ComputerActionMove
screenshot	OpenAI.ComputerActionScreenshot
scroll	OpenAI.ComputerActionالتمرير
type	OpenAI.ComputerActionTypeKeys
wait	OpenAI.ComputerActionانتظر
keypress	OpenAI.ComputerActionKeyPress

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

OpenAI.ComputerActionانقر

إجراء النقر.

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

OpenAI.ComputerActionDoubleClick

إجراء النقر المزدوج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء النقر المزدوج، تكون هذه الخاصية هي اضبط دائما على double_click. القيم المحتملة: double_click	‏‏نعم‬
×	integer	الإحداثي س حيث حدث النقر المزدوج.	‏‏نعم‬
y	integer	الإحداثي ص حيث حدث النقر المزدوج.	‏‏نعم‬

OpenAI.ComputerActionDrag

إجراء سحب.

الاسم	النوع	وصف	مطلوب	الإفتراضي
path	صفيف	مصفوفة من الإحداثيات تمثل مسار إجراء السحب. ستظهر الإحداثيات كمصفوفة من الكائنات ، على سبيل المثال <br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء السحب، تكون هذه الخاصية هي اضبط دائما على drag. القيم المحتملة: drag	‏‏نعم‬

OpenAI.ComputerActionKeyPress

مجموعة من ضغطات المفاتيح التي يرغب النموذج في تنفيذها.

الاسم	النوع	وصف	مطلوب	الإفتراضي
keys	صفيف	مجموعة المفاتيح التي يطلب النموذج الضغط عليها. هذا هو مجموعة من السلاسل ، كل منها يمثل مفتاحا.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء الضغط على المفتاح، تكون هذه الخاصية هي اضبط دائما على keypress. القيم المحتملة: keypress	‏‏نعم‬

OpenAI.ComputerActionMove

إجراء تحريك الماوس.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء النقل، تكون هذه الخاصية هي اضبط دائما على move. القيم المحتملة: move	‏‏نعم‬
×	integer	الإحداثي س للانتقال إليه.	‏‏نعم‬
y	integer	الإحداثي ص للانتقال إليه.	‏‏نعم‬

OpenAI.ComputerActionScreenshot

إجراء لقطة شاشة.

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

OpenAI.ComputerActionالتمرير

إجراء تمرير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
scroll_x	integer	مسافة التمرير الأفقية.	‏‏نعم‬
scroll_y	integer	مسافة التمرير العمودية.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء التمرير، تكون هذه الخاصية هي اضبط دائما على scroll. القيم المحتملة: scroll	‏‏نعم‬
×	integer	الإحداثي س حيث حدث التمرير.	‏‏نعم‬
y	integer	الإحداثي ص حيث حدث التمرير.	‏‏نعم‬

OpenAI.ComputerActionType

الخاصية	قيمة
Type	string
Values	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

إجراء لكتابة نص.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string	النص المراد كتابته.	‏‏نعم‬
النوع	enum	يحدد نوع الحدث. بالنسبة لإجراء نوع، تكون هذه الخاصية هي اضبط دائما على type. القيم المحتملة: type	‏‏نعم‬

OpenAI.ComputerActionانتظر

إجراء انتظار.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	يحدد نوع الحدث. بالنسبة إلى إجراء الانتظار، تكون هذه الخاصية هي اضبط دائما على wait. القيم المحتملة: wait	‏‏نعم‬

OpenAI.ComputerToolCallItemParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.ComputerAction		‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	‏‏نعم‬
pending_safety_checks	صفيف	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
النوع	enum	القيم المحتملة: computer_call	‏‏نعم‬

OpenAI.ComputerToolCallItemResource

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.ComputerAction		‏‏نعم‬
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	‏‏نعم‬
pending_safety_checks	صفيف	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	القيم المحتملة: computer_call	‏‏نعم‬

OpenAI.ComputerToolCallOutputItemOutput

المميز ل OpenAI.ComputerToolCallOutputItemOutput

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

قيمة النوع	Schema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

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

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_id	string		لا
image_url	string		لا
النوع	enum	القيم المحتملة: computer_screenshot	‏‏نعم‬

OpenAI.ComputerToolCallOutputItemOutputType

صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.

الخاصية	قيمة
الوصف	صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.
Type	string
Values	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

إخراج استدعاء أداة الكمبيوتر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
acknowledged_safety_checks	صفيف	فحوصات السلامة التي أبلغت عنها واجهة برمجة التطبيقات والتي تم الاعتراف بها من قبل المطور.	لا
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج الإخراج.	‏‏نعم‬
الناتج	OpenAI.ComputerToolCallOutputItemOutput		‏‏نعم‬
النوع	enum	القيم المحتملة: computer_call_output	‏‏نعم‬

OpenAI.ComputerToolCallOutputItemResource

إخراج استدعاء أداة الكمبيوتر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
acknowledged_safety_checks	صفيف	فحوصات السلامة التي أبلغت عنها واجهة برمجة التطبيقات والتي تم الاعتراف بها من قبل المطور.	لا
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج الإخراج.	‏‏نعم‬
الناتج	OpenAI.ComputerToolCallOutputItemOutput		‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	القيم المحتملة: computer_call_output	‏‏نعم‬

OpenAI.ComputerToolCallSafetyCheck

فحص أمان معلق لمكالمة الكمبيوتر.

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

OpenAI.ComputerUsePreviewTool

أداة تتحكم في جهاز كمبيوتر ظاهري.

الاسم	النوع	وصف	مطلوب	الإفتراضي
display_height	integer	ارتفاع جهاز عرض الكمبيوتر.	‏‏نعم‬
display_width	integer	عرض جهاز عرض الكمبيوتر.	‏‏نعم‬
environment	enum	نوع بيئة الكمبيوتر التي يجب التحكم فيها. القيم المحتملة: windows، mac، linux، ، ubuntubrowser	‏‏نعم‬
النوع	enum	نوع أداة استخدام الكمبيوتر. دائمًا computer_use_preview. القيم المحتملة: computer_use_preview	‏‏نعم‬

OpenAI.ConversationItemList

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	صفيف		‏‏نعم‬
first_id	string		‏‏نعم‬
has_more	boolean		‏‏نعم‬
last_id	string		‏‏نعم‬
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ConversationResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer		‏‏نعم‬
المعرف	string	المعرف الفريد للمحادثة.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	‏‏نعم‬
object	enum	نوع الكائن، وهو دائما "محادثة". القيم المحتملة: conversation	‏‏نعم‬

OpenAI.Coordinate

زوج إحداثيات x/y، على سبيل المثال { x: 100, y: 200 }.

الاسم	النوع	وصف	مطلوب	الإفتراضي
×	integer	إحداثيات x.	‏‏نعم‬
y	integer	إحداثيات y.	‏‏نعم‬

OpenAI.CreateConversationRequest

إنشاء محادثة

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

OpenAI.CreateEvalCompletionsRunDataSource

كائن CompletionsRunDataSource يصف تكوين أخذ عينات نموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_messages	object		لا
└─ item_reference	string		لا
└─ قالب	صفيف		لا
└─ النوع	enum	القيم المحتملة: item_reference	لا
نموذج	string	اسم النموذج المراد استخدامه لإنشاء عمليات الإكمال (على سبيل المثال "o3-mini").	لا
sampling_params	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		لا
المصدر	object		‏‏نعم‬
└─ المحتوى	صفيف	محتوى ملف jsonl.	لا
└─ created_after	OpenAI.integer		لا
└─ created_before	OpenAI.integer		لا
└─ الهوية	string	معرف الملف.	لا
└─ الحد	OpenAI.integer		لا
└─ البيانات الوصفية	OpenAI.Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
└─ نموذج	string		لا
└─ النوع	enum	نوع المصدر. دائمًا stored_completions. القيم المحتملة: stored_completions	لا
النوع	enum	نوع مصدر بيانات التشغيل. دائمًا completions. القيم المحتملة: completions	‏‏نعم‬

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_reference	string		‏‏نعم‬
النوع	enum	القيم المحتملة: item_reference	‏‏نعم‬

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

الاسم	النوع	وصف	مطلوب	الإفتراضي
قالب	صفيف		‏‏نعم‬
النوع	enum	القيم المحتملة: template	‏‏نعم‬

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_completion_tokens	OpenAI.integer		لا
reasoning_effort	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
response_format	object	تنسيق الاستجابة الافتراضي. يستخدم لإنشاء استجابات نصية.	لا
└─ json_schema	object	خيارات تكوين المخرجات المنظمة، بما في ذلك مخطط JSON.	لا
└─ الوصف	string	وصف لما يستخدمه تنسيق الاستجابة من قبل النموذج تحديد كيفية الاستجابة بالتنسيق.	لا
└─ الاسم	string	اسم تنسيق الاستجابة. يجب أن يكون a-z أو A-Z أو 0-9 أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64.	لا
└─ مخطط	object		لا
└─ صارم	boolean	ما إذا كان سيتم تمكين الالتزام الصارم بالمخطط عند إنشاء الإخراج. إذا تم تعيينه إلى صحيح، فسيتبع النموذج دائما المخطط المحدد بالضبط في schema الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما strict عبارة عن true. لمعرفة المزيد، اقرأ مخرجات منظمة البنية دليل.	لا	خطأ
└─ النوع	enum	نوع تنسيق الاستجابة الذي يتم تعريفه. دائمًا json_object. القيم المحتملة: json_object	لا
seed	object		لا
درجة الحرارة	object		لا
الأدوات	صفيف		لا
top_p	object		لا

OpenAI.CreateEvalCustomDataSourceConfig

كائن CustomDataSourceConfig الذي يعرف مخطط مصدر البيانات المستخدم في عمليات تشغيل التقييم. يستخدم هذا المخطط لتحديد شكل البيانات التي ستكون:

• تستخدم لتحديد معايير الاختبار الخاصة بك و
• ما هي البيانات المطلوبة عند إنشاء تشغيل

الاسم	النوع	وصف	مطلوب	الإفتراضي
include_sample_schema	boolean	ما إذا كان يجب أن يتوقع التقييم ملء مساحة الاسم النموذجية (أي عن طريق إنشاء استجابات من مصدر البيانات الخاص بك)	لا
item_schema	object	مخطط json لكل صف في مصدر البيانات.	‏‏نعم‬
النوع	enum	نوع مصدر البيانات. دائمًا custom. القيم المحتملة: custom	‏‏نعم‬

OpenAI.CreateEvalJsonlRunDataSource

كائن JsonlRunDataSource مع الذي يحدد ملف JSONL الذي يطابق التقييم

الاسم	النوع	وصف	مطلوب	الإفتراضي
المصدر	object		‏‏نعم‬
└─ المحتوى	صفيف	محتوى ملف jsonl.	لا
└─ الهوية	string	معرف الملف.	لا
└─ النوع	enum	نوع مصدر jsonl. دائمًا file_id. القيم المحتملة: file_id	لا
النوع	enum	نوع مصدر البيانات. دائمًا jsonl. القيم المحتملة: jsonl	‏‏نعم‬

OpenAI.CreateEvalLogsDataSourceConfig

تكوين مصدر البيانات الذي يحدد خاصية بيانات التعريف لاستعلام السجلات. عادة ما تكون هذه بيانات تعريف مثل usecase=chatbot أو prompt-version=v2، وما إلى ذلك.

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	عوامل تصفية بيانات التعريف لمصدر بيانات السجلات.	لا
النوع	enum	نوع مصدر البيانات. دائمًا logs. القيم المحتملة: logs	‏‏نعم‬

OpenAI.CreateEvalResponsesRunDataSource

كائن ResponsesRunDataSource يصف تكوين أخذ عينات نموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_messages	object		لا
└─ item_reference	string		لا
└─ قالب	صفيف		لا
└─ النوع	enum	القيم المحتملة: item_reference	لا
نموذج	string	اسم النموذج المراد استخدامه لإنشاء عمليات الإكمال (على سبيل المثال "o3-mini").	لا
sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		لا
المصدر	object		‏‏نعم‬
└─ المحتوى	صفيف	محتوى ملف jsonl.	لا
└─ created_after	OpenAI.integer		لا
└─ created_before	OpenAI.integer		لا
└─ الهوية	string	معرف الملف.	لا
└─ instructions_search	string		لا
└─ البيانات الوصفية	object		لا
└─ نموذج	string		لا
└─ reasoning_effort	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
└─ درجة الحرارة	OpenAI.numeric		لا
└─ الأدوات	صفيف		لا
└─ top_p	OpenAI.numeric		لا
└─ النوع	enum	نوع مصدر بيانات التشغيل. دائمًا responses. القيم المحتملة: responses	لا
└─ المستخدمون	صفيف		لا
النوع	enum	نوع مصدر بيانات التشغيل. دائمًا responses. القيم المحتملة: responses	‏‏نعم‬

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_reference	string		‏‏نعم‬
النوع	enum	القيم المحتملة: item_reference	‏‏نعم‬

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

الاسم	النوع	وصف	مطلوب	الإفتراضي
قالب	صفيف		‏‏نعم‬
النوع	enum	القيم المحتملة: template	‏‏نعم‬

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_completion_tokens	OpenAI.integer		لا
reasoning_effort	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
seed	object		لا
درجة الحرارة	object		لا
نص	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		لا
الأدوات	صفيف		لا
top_p	object		لا

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

الاسم	النوع	وصف	مطلوب	الإفتراضي
format	OpenAI.TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين { "type": "json_schema" } المخرجات المنظمة ، مما يضمن أن النموذج سوف يتطابق مع مخطط JSON المرفق. تعرف على المزيد في التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية. *غير مستحسن لنماذج gpt-4o والأحدث:** إعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. استخدام json_schema يفضل للنماذج التي تدعمه.	لا

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

تم إهمالها لصالح LogsDataSourceConfig.

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	object	عوامل تصفية بيانات التعريف لمصدر بيانات الاكتمال المخزنة.	لا
النوع	enum	نوع مصدر البيانات. دائمًا stored_completions. القيم المحتملة: stored_completions	‏‏نعم‬

OpenAI.CreateFineTuningJobRequest

موديلات صالحة:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

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

OpenAI.CreateFineTuningJobRequestIntegration

Discriminator ل OpenAI.CreateFineTuningJobRequestIntegration

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

قيمة النوع	Schema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	سلسلة (راجع النماذج الصالحة أدناه)		‏‏نعم‬

OpenAI.CreateFineTuningJobRequestWandbIntegration

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: wandb	‏‏نعم‬
wandb	object		‏‏نعم‬
└─ الكيان	string		لا
└─ الاسم	string		لا
└─ project	string		لا
└─ العلامات	صفيف		لا

OpenAI.CreateResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
agent	object		لا
└─ الاسم	string	اسم الوكيل.	لا
└─ النوع	enum	القيم المحتملة: agent_reference	لا
└─ الإصدار	string	معرف إصدار الوكيل.	لا
background	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
حوار	object		لا
└─ الهوية	string		لا
include	صفيف	حدد بيانات إخراج إضافية لتضمينها في استجابة النموذج. حاليا القيم المدعومة هي: - 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، أو عندما تكون المؤسسة مسجل في برنامج الاحتفاظ بالبيانات الصفرية).	لا
الادخال	سلسلة أو مجموعة		لا
تعليمات	string	رسالة نظام (أو مطور) مدرجة في سياق النموذج. عند الاستخدام جنبا إلى جنب مع previous_response_id، التعليمات من السابق لن يتم ترحيل الرد إلى الرد التالي. هذا يجعل الأمر بسيطا لتبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
فوري	object	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
└─ الهوية	string	المعرف الفريد لقالب المطالبة المراد استخدامه.	لا
└─ المتغيرات	OpenAI.ResponsePromptVariables	خريطة اختيارية للقيم لاستبدالها بالمتغيرات في فوري. يمكن أن تكون قيم الاستبدال إما سلاسل أو غيرها أنواع إدخال الاستجابة مثل الصور أو الملفات.	لا
└─ الإصدار	string	إصدار اختياري من قالب المطالبة.	لا
المنطق	object	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ الجهد	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
└─ generate_summary	enum	مهمل: استخدم summary بدلا من ذلك. ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيدا لتصحيح أخطاء عملية التفكير في النموذج وفهمها. واحد من autoأو conciseأو detailed. القيم المحتملة: auto، ، concisedetailed	لا
└─ ملخص	enum	ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيد لتصحيح الأخطاء وفهم عملية التفكير في النموذج. واحد من autoأو conciseأو detailed. القيم المحتملة: auto، ، concisedetailed	لا
service_tier	object	يحدد نوع المعالجة المستخدم لخدمة الطلب. * إذا تم تعيينه إلى "تلقائي"، فستتم معالجة الطلب مع مستوى الخدمة تم تكوينه في إعدادات Project. ما لم يتم تكوين خلاف ذلك، سيستخدم Project "افتراضي". * إذا تم تعيينه إلى "افتراضي"، فستتم معالجة الطلب مع المعيار التسعير والأداء للنموذج المحدد. * إذا تم تعيينه إلى "flex" أو "الأولوية"، ثم ستتم معالجة الطلب مع الخدمة المقابلة المستوي. اتصل بالمبيعات لمعرفة المزيد حول معالجة الأولوية. * عند عدم التعيين، يكون السلوك الافتراضي هو "تلقائي". عند تعيين المعلمة service_tier ، سيتضمن نص الاستجابة service_tier استنادا إلى وضع المعالجة المستخدم فعليا لخدمة الطلب. قيمة الاستجابة هذه قد تختلف عن القيمة التي تم تعيينها في المعلمة .	لا
store	boolean	ما إذا كان سيتم تخزين استجابة النموذج التي تم إنشاؤها لاستردادها لاحقا عبر واجهة برمجة التطبيقات.	لا	صحيح
استدر	boolean	إذا تم تعيينه إلى صواب، دفق بيانات استجابة النموذج إلى العميل حيث يتم إنشاؤه باستخدام الأحداث المرسلة من الخادم. للمزيد من المعلومات.	لا	خطأ
structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا	1
نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
tool_choice	object	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. auto يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء رسالة أو المزيد من الأدوات. required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر.	لا
└─ النوع	OpenAI.ToolChoiceObjectType	يشير إلى أن النموذج يجب أن يستخدم أداة مضمنة لإنشاء استجابة. تعرف على المزيد حول الأدوات المضمنة.	لا
الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق إمكانات النموذج، مثل البحث عن الملفات. - استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك.	لا
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا	1
اقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
user	string	تعرف على المزيد حول أفضل ممارسات السلامة.	لا

OpenAI.DeletedConversationResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
deleted	boolean		‏‏نعم‬
المعرف	string		‏‏نعم‬
object	enum	القيم المحتملة: conversation.deleted	‏‏نعم‬

OpenAI.EasyInputMessage

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	سلسلة أو مجموعة		‏‏نعم‬
role	string		‏‏نعم‬

OpenAI.Error

الاسم	النوع	وصف	مطلوب	الإفتراضي
additionalInfo	object		لا
رمز	string		‏‏نعم‬
معلومات تتبع الأخطاء	object		لا
details	صفيف		لا
رسالة	string		‏‏نعم‬
بارام	string		‏‏نعم‬
النوع	string		‏‏نعم‬

OpenAI.EvalApiError

كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.

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

OpenAI.EvalGraderLabelModel

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	صفيف		‏‏نعم‬
labels	صفيف	التسميات التي يجب تعيينها لكل عنصر في التقييم.	‏‏نعم‬
نموذج	string	النموذج الذي يجب استخدامه للتقييم. يجب أن يدعم المخرجات المنظمة.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
passing_labels	صفيف	التسميات التي تشير إلى نتيجة تمرير. يجب أن تكون مجموعة فرعية من التسميات.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: label_model	‏‏نعم‬

OpenAI.EvalGraderPython

الاسم	النوع	وصف	مطلوب	الإفتراضي
image_tag	string	علامة الصورة المراد استخدامها لبرنامج python النصي.	لا
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
pass_threshold	object		لا
المصدر	string	الكود المصدري لبرنامج python النصي.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم pythonدائما . القيم المحتملة: python	‏‏نعم‬

OpenAI.EvalGraderScoreModel

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	صفيف	نص الإدخال. قد يتضمن ذلك سلاسل القالب.	‏‏نعم‬
نموذج	string	النموذج الذي يجب استخدامه للتقييم.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
pass_threshold	object		لا
النطاق	صفيف	نطاق النتيجة. الإعدادات الافتراضية لـ [0, 1].	لا
sampling_params	object		لا
└─ max_completions_tokens	OpenAI.integer		لا
└─ reasoning_effort	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
└─ البذور	OpenAI.integer		لا
└─ درجة الحرارة	OpenAI.numeric		لا
└─ top_p	OpenAI.numeric		لا
النوع	enum	نوع الكائن، الذي يتم score_modelدائما . القيم المحتملة: score_model	‏‏نعم‬

OpenAI.EvalGraderScoreModelSamplingParams

الاسم	النوع	وصف	مطلوب	الإفتراضي
max_completions_tokens	object		لا
reasoning_effort	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
seed	object		لا
درجة الحرارة	object		لا
top_p	object		لا

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	object		‏‏نعم‬
reference	string	النص الذي يتم تقييمه مقابله.	‏‏نعم‬
النوع	enum	نوع متدرج الدرجات. القيم المحتملة: text_similarity	‏‏نعم‬

OpenAI.EvalItem

إدخال رسالة إلى النموذج مع دور يشير إلى التعليمات التالية التسلسل الهرمي. الإرشادات المعطاة developer مع الدور أو system لها الأسبقية على الإرشادات المعطاة مع user الدور. يفترض أن الرسائل التي assistant لها الدور قد تم إنشاؤها بواسطة النموذج في التفاعلات السابقة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	object	إدخال نص إلى النموذج.	‏‏نعم‬
└─ البيانات	string	بيانات صوتية مرمزة ب Base64.	لا
└─ التفاصيل	string		لا
└─ التنسيق	enum	تنسيق البيانات الصوتية. التنسيقات المدعومة حاليا هي mp3 و wav. القيم المحتملة: mp3، wav	لا
└─ image_url	string		لا
└─ نص	string		لا
└─ النوع	enum	نوع عنصر الإدخال. دائمًا input_audio. القيم المحتملة: input_audio	لا
role	enum	دور إدخال الرسالة. واحد من userأو assistantsystemأو أو developer. القيم المحتملة: user، assistant، ، systemdeveloper	‏‏نعم‬
النوع	enum	نوع إدخال الرسالة. دائمًا message. القيم المحتملة: message	لا

OpenAI.EvalItemContentInputImage

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	string		لا
image_url	string		‏‏نعم‬
النوع	enum	القيم المحتملة: input_image	‏‏نعم‬

OpenAI.EvalItemContentOutputText

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string		‏‏نعم‬
النوع	enum	القيم المحتملة: output_text	‏‏نعم‬

OpenAI.EvalJsonlFileContentSource

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف	محتوى ملف jsonl.	‏‏نعم‬
النوع	enum	نوع مصدر jsonl. دائمًا file_content. القيم المحتملة: file_content	‏‏نعم‬

OpenAI.EvalJsonlFileContentSourceContent

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

OpenAI.EvalJsonlFileIdSource

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	معرف الملف.	‏‏نعم‬
النوع	enum	نوع مصدر jsonl. دائمًا file_id. القيم المحتملة: file_id	‏‏نعم‬

OpenAI.EvalResponsesSource

كائن EvalResponsesSource يصف تكوين مصدر بيانات تشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_after	object		لا
created_before	object		لا
instructions_search	string		لا
metadata	object		لا
نموذج	string		لا
reasoning_effort	object	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
درجة الحرارة	object		لا
الأدوات	صفيف		لا
top_p	object		لا
النوع	enum	نوع مصدر بيانات التشغيل. دائمًا responses. القيم المحتملة: responses	‏‏نعم‬
users	صفيف		لا

OpenAI.EvalRunOutputItemSample

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	OpenAI.EvalApiError	كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.	‏‏نعم‬
finish_reason	string		‏‏نعم‬
الادخال	صفيف		‏‏نعم‬
max_completion_tokens	OpenAI.integer		‏‏نعم‬
نموذج	string		‏‏نعم‬
الناتج	صفيف		‏‏نعم‬
seed	OpenAI.integer		‏‏نعم‬
درجة الحرارة	OpenAI.numeric		‏‏نعم‬
top_p	OpenAI.numeric		‏‏نعم‬
استخدام	OpenAI.EvalRunOutputItemSampleUsage		‏‏نعم‬

OpenAI.EvalRunOutputItemSampleInput

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	string		‏‏نعم‬
role	string		‏‏نعم‬

OpenAI.EvalRunOutputItemSampleOutput

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	string		لا
role	string		لا

OpenAI.EvalRunOutputItemSampleUsage

الاسم	النوع	وصف	مطلوب	الإفتراضي
cached_tokens	OpenAI.integer		‏‏نعم‬
completion_tokens	OpenAI.integer		‏‏نعم‬
prompt_tokens	OpenAI.integer		‏‏نعم‬
total_tokens	OpenAI.integer		‏‏نعم‬

OpenAI.EvalRunPerModelUsage

الاسم	النوع	وصف	مطلوب	الإفتراضي
cached_tokens	OpenAI.integer		‏‏نعم‬
completion_tokens	OpenAI.integer		‏‏نعم‬
invocation_count	OpenAI.integer		‏‏نعم‬
model_name	string		‏‏نعم‬
prompt_tokens	OpenAI.integer		‏‏نعم‬
total_tokens	OpenAI.integer		‏‏نعم‬

OpenAI.EvalRunPerTestingCriteriaResults

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

OpenAI.EvalRunResultCounts

الاسم	النوع	وصف	مطلوب	الإفتراضي
حدث خطأ	OpenAI.integer		‏‏نعم‬
failed	OpenAI.integer		‏‏نعم‬
مرت	OpenAI.integer		‏‏نعم‬
مجموع	OpenAI.integer		‏‏نعم‬

OpenAI.EvalStoredCompletionsSource

تكوين StoredCompletionsRunDataSource يصف مجموعة من عوامل التصفية

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

OpenAI.FileSearchTool

أداة تبحث عن محتوى ذي صلة من الملفات التي تم تحميلها.

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

OpenAI.FileSearchToolCallItemParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
queries	صفيف	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
results	صفيف	نتائج استدعاء أداة البحث عن الملفات.	لا
النوع	enum	القيم المحتملة: file_search_call	‏‏نعم‬

OpenAI.FileSearchToolCallItemResource

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
queries	صفيف	الاستعلامات المستخدمة للبحث عن الملفات.	‏‏نعم‬
results	صفيف	نتائج استدعاء أداة البحث عن الملفات.	لا
الحالة	enum	حالة استدعاء أداة البحث عن الملفات. واحد من in_progress، searching، incomplete أو failed، القيم المحتملة: in_progress، searching، completed، ، incompletefailed	‏‏نعم‬
النوع	enum	القيم المحتملة: file_search_call	‏‏نعم‬

OpenAI.Filters

الاسم	النوع	وصف	مطلوب	الإفتراضي
filters	صفيف	صفيف عوامل التصفية المراد دمجها. يمكن أن تكون ComparisonFilter العناصر أو CompoundFilter.	‏‏نعم‬
مفتاح	string	المفتاح للمقارنة مقابل القيمة.	‏‏نعم‬
النوع	enum	نوع العملية: and أو or. القيم المحتملة: and، or	‏‏نعم‬
القيمة	سلسلة أو رقم أو قيمة منطقية	القيمة المراد مقارنتها بمفتاح السمة؛ يدعم أنواع السلسلة أو الرقم أو القيم المنطقية.	‏‏نعم‬

OpenAI.FineTuneDPOHyperالمعلمات

المعلمات الفائقة المستخدمة لوظيفة الضبط الدقيق ل DPO.

الاسم	النوع	وصف	مطلوب	الإفتراضي
batch_size	enum	القيم المحتملة: auto	لا
بيتا	enum	القيم المحتملة: auto	لا
learning_rate_multiplier	enum	القيم المحتملة: auto	لا
n_epochs	enum	القيم المحتملة: auto	لا

OpenAI.FineTuneDPOMethod

تكوين طريقة الضبط الدقيق ل DPO.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعلمات الفائقة	OpenAI.FineTuneDPOHyperالمعلمات	المعلمات الفائقة المستخدمة لوظيفة الضبط الدقيق ل DPO.	لا

OpenAI.FineTuneMethod

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
دبو	OpenAI.FineTuneDPOMethod	تكوين طريقة الضبط الدقيق ل DPO.	لا
تعزيز	OpenAI.FineTuneReinforcementMethod	تكوين أسلوب الضبط الدقيق للتعزيز.	لا
تم الإشراف عليه	OpenAI.FineTuneSupervisedMethod	تكوين طريقة الضبط الدقيق الخاضعة للإشراف.	لا
النوع	enum	نوع الطريقة. إما supervised، dpoأو reinforcement. القيم المحتملة: supervised، ، dporeinforcement	‏‏نعم‬

OpenAI.FineTuneReinforcementHyperparameters

المعلمات الفائقة المستخدمة في وظيفة الضبط الدقيق للتعزيز.

الاسم	النوع	وصف	مطلوب	الإفتراضي
batch_size	enum	القيم المحتملة: auto	لا
compute_multiplier	enum	القيم المحتملة: auto	لا
eval_interval	enum	القيم المحتملة: auto	لا
eval_samples	enum	القيم المحتملة: auto	لا
learning_rate_multiplier	enum	القيم المحتملة: auto	لا
n_epochs	enum	القيم المحتملة: auto	لا
reasoning_effort	enum	مستوى جهد التفكير. القيم المحتملة: default، low، ، mediumhigh	لا

OpenAI.FineTuneReinforcementMethod

تكوين أسلوب الضبط الدقيق للتعزيز.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الصف	object	كائن StringCheckGrader الذي يقوم بإجراء مقارنة سلسلة بين الإدخال والمرجع باستخدام عملية محددة.	‏‏نعم‬
└─ calculate_output	string	صيغة لحساب المخرجات استنادا إلى نتائج مصنف التقديرات.	لا
└─ 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	لا
└─ مصنفو الدرجات	OpenAI.GraderStringCheck أو OpenAI.GraderTextSimilarity أو OpenAI.GraderPython أو OpenAI.GraderScoreModel أو OpenAI.GraderLabelModel	كائن StringCheckGrader الذي يقوم بإجراء مقارنة سلسلة بين الإدخال والمرجع باستخدام عملية محددة.	لا
└─ image_tag	string	علامة الصورة المراد استخدامها لبرنامج python النصي.	لا
└─ المدخلات	صفيف	نص الإدخال. قد يتضمن ذلك سلاسل القالب.	لا
└─ نموذج	string	النموذج الذي يجب استخدامه للتقييم.	لا
└─ الاسم	string	اسم رئيس الدرجات.	لا
└─ عملية	enum	عملية التحقق من السلسلة التي يجب تنفيذها. واحد من eqأو nelikeأو أو ilike. القيم المحتملة: eq، ne، ، likeilike	لا
└─ النطاق	صفيف	نطاق النتيجة. الإعدادات الافتراضية لـ [0, 1].	لا
└─ المرجع	string	النص الذي يتم تقييمه مقابله.	لا
└─ sampling_params	OpenAI.EvalGraderScoreModelSamplingParams	معلمات أخذ العينات للنموذج.	لا
└─ المصدر	string	الكود المصدري لبرنامج python النصي.	لا
└─ النوع	enum	نوع الكائن، الذي يتم multiدائما . القيم المحتملة: multi	لا
المعلمات الفائقة	OpenAI.FineTuneReinforcementHyperparameters	المعلمات الفائقة المستخدمة في وظيفة الضبط الدقيق للتعزيز.	لا

OpenAI.FineTuneSupervisedHyperparameters

المعلمات الفائقة المستخدمة لمهمة الضبط الدقيق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
batch_size	enum	القيم المحتملة: auto	لا
learning_rate_multiplier	enum	القيم المحتملة: auto	لا
n_epochs	enum	القيم المحتملة: auto	لا

OpenAI.FineTuneSupervisedMethod

تكوين طريقة الضبط الدقيق الخاضعة للإشراف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعلمات الفائقة	OpenAI.FineTuneSupervisedHyperparameters	المعلمات الفائقة المستخدمة لمهمة الضبط الدقيق.	لا

OpenAI.FineTuningIntegration

المميز ل OpenAI.FineTuningIntegration

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

قيمة النوع	Schema
wandb	OpenAI.FineTuningIntegrationWandb

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	سلسلة (راجع النماذج الصالحة أدناه)		‏‏نعم‬

OpenAI.FineTuningIntegrationWandb

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع التكامل الذي يتم تمكينه لمهمة الضبط الدقيق القيم المحتملة: wandb	‏‏نعم‬
wandb	object	إعدادات التكامل مع الأوزان والتحيزات. تحدد هذه الحمولة project سيتم إرسال المقاييس إلى. اختياريا، يمكنك تعيين اسم عرض صريح للتشغيل وإضافة علامات لتشغيلك، وقم بتعيين كيان افتراضي (فريق، اسم مستخدم، وما إلى ذلك) ليتم ربطه بتشغيلك.	‏‏نعم‬
└─ الكيان	string	الكيان المراد استخدامه للتشغيل. يتيح لك ذلك تعيين اسم الفريق أو المستخدم لمستخدم WandB الذي تريد مثل المرتبطة بالجري. إذا لم يتم تعيينه، يتم استخدام الكيان الافتراضي لمفتاح واجهة برمجة تطبيقات WandB المسجل.	لا
└─ الاسم	string	اسم عرض لتعيينه للتشغيل. إذا لم يتم تعيينه ، فسنستخدم معرف الوظيفة كاسم.	لا
└─ project	string	اسم project التي سيتم إنشاء التشغيل الجديد ضمنها.	لا
└─ العلامات	صفيف	قائمة بالعلامات التي سيتم إرفاقها بالتشغيل الذي تم إنشاؤه حديثا. يتم تمرير هذه العلامات مباشرة إلى WandB. بعض يتم إنشاء العلامات الافتراضية بواسطة OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	لا

OpenAI.FineTuningJob

يمثل الكائن fine_tuning.job مهمة ضبط دقيقة تم إنشاؤها من خلال واجهة برمجة التطبيقات.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني ل Unix (بالثواني) لوقت إنشاء مهمة الضبط الدقيق.	‏‏نعم‬
خطأ	object	بالنسبة لوظائف الضبط الدقيق التي تحتوي failedعلى ، سيحتوي هذا على مزيد من المعلومات حول سبب الفشل.	‏‏نعم‬
└─ كود	string	رمز خطأ يمكن قراءته آليا.	لا
└─ رسالة	string	رسالة خطأ يمكن للبشر قراءتها.	لا
└─ معلمة	string	المعلمة التي كانت غير صالحة ، عادة training_file أو validation_file. سيكون هذا الحقل فارغا إذا لم يكن الفشل خاصا بالمعلمات.	لا
estimated_finish	integer	الطابع الزمني Unix (بالثوان) عند تقدير انتهاء مهمة الضبط الدقيقة. ستكون القيمة فارغة إذا لم تكن مهمة الضبط الدقيق قيد التشغيل.	لا
fine_tuned_model	string	اسم النموذج الدقيق الذي يتم إنشاؤه. ستكون القيمة فارغة إذا كانت مهمة الضبط الدقيق لا تزال قيد التشغيل.	‏‏نعم‬
finished_at	integer	الطابع الزمني ل Unix (بالثواني) عند الانتهاء من مهمة الضبط الدقيق. ستكون القيمة فارغة إذا كانت مهمة الضبط الدقيق لا تزال قيد التشغيل.	‏‏نعم‬
المعلمات الفائقة	object	المعلمات الفائقة المستخدمة لمهمة الضبط الدقيق. سيتم إرجاع هذه القيمة فقط عند تشغيل supervised المهام.	‏‏نعم‬
└─ batch_size	enum	القيم المحتملة: auto	لا
└─ learning_rate_multiplier	enum	القيم المحتملة: auto	لا
└─ n_epochs	enum	القيم المحتملة: auto	لا
المعرف	string	معرف الكائن، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
التكامل	صفيف	قائمة عمليات التكامل لتمكين مهمة الضبط الدقيقة هذه.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	‏‏نعم‬
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	integer	العدد الإجمالي للرموز المميزة القابلة للفوترة التي تتم معالجتها بواسطة مهمة الضبط الدقيق هذه. ستكون القيمة فارغة إذا كانت مهمة الضبط الدقيق لا تزال قيد التشغيل.	‏‏نعم‬
training_file	string	معرف الملف المستخدم للتدريب. يمكنك استرداد بيانات التدريب باستخدام واجهة برمجة تطبيقات الملفات.	‏‏نعم‬
user_provided_suffix	string	اللاحقة الوصفية المطبقة على الوظيفة، كما هو محدد في طلب إنشاء الوظيفة.	لا
validation_file	string	معرف الملف المستخدم للتحقق من الصحة. يمكنك استرداد نتائج التحقق من الصحة باستخدام واجهة برمجة تطبيقات الملفات.	‏‏نعم‬

OpenAI.FineTuningJobCheckpoint

يمثل الكائن fine_tuning.job.checkpoint نقطة تفتيش نموذجية لمهمة ضبط دقيقة جاهزة للاستخدام.

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء نقطة التحقق.	‏‏نعم‬
fine_tuned_model_checkpoint	string	اسم نموذج نقطة التحقق المضبط الذي تم إنشاؤه.	‏‏نعم‬
fine_tuning_job_id	string	اسم مهمة الضبط الدقيقة التي تم إنشاء نقطة التحقق هذه منها.	‏‏نعم‬
المعرف	string	معرف نقطة التفتيش، والذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	‏‏نعم‬
المقاييس	object	المقاييس في رقم الخطوة أثناء مهمة الضبط الدقيق.	‏‏نعم‬
└─ 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.FineTuningJobEvent

ضبط كائن حدث الوظيفة

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_at	integer	الطابع الزمني ل Unix (بالثواني) لوقت إنشاء مهمة الضبط الدقيق.	‏‏نعم‬
البيانات		البيانات المرتبطة بالحدث.	لا
المعرف	string	معرف الكائن.	‏‏نعم‬
المستوى	enum	مستوى سجل الحدث. القيم المحتملة: info، ، warnerror	‏‏نعم‬
رسالة	string	رسالة الحدث.	‏‏نعم‬
object	enum	نوع الكائن، وهو دائما "fine_tuning.job.event". القيم المحتملة: fine_tuning.job.event	‏‏نعم‬
النوع	enum	نوع الحدث. القيم المحتملة: message، metrics	لا

OpenAI.FunctionObject

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

OpenAI.FunctionTool

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف للدالة. يستخدم من قبل النموذج لتحديد ما إذا كان يجب استدعاء الدالة أم لا.	لا
الاسم	string	اسم الدالة التي يجب استدعاها.	‏‏نعم‬
المعلمات		كائن مخطط JSON يصف معلمات الدالة.	‏‏نعم‬
صارم	boolean	ما إذا كان يجب فرض التحقق الصارم من صحة المعلمة. الافتراضي true.	‏‏نعم‬
النوع	enum	نوع أداة الدالة. دائمًا function. القيم المحتملة: function	‏‏نعم‬

OpenAI.FunctionToolCallItemParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
الاسم	string	اسم الدالة المراد تشغيلها.	‏‏نعم‬
النوع	enum	القيم المحتملة: function_call	‏‏نعم‬

OpenAI.FunctionToolCallItemResource

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
الاسم	string	اسم الدالة المراد تشغيلها.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	القيم المحتملة: function_call	‏‏نعم‬

OpenAI.FunctionToolCallOutputItemParam

إخراج استدعاء أداة دالة.

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

OpenAI.FunctionToolCallOutputItemResource

إخراج استدعاء أداة دالة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	‏‏نعم‬
الناتج	string	سلسلة JSON من إخراج استدعاء أداة الدالة.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	القيم المحتملة: function_call_output	‏‏نعم‬

OpenAI.GraderLabelModel

عنصر LabelModelGrader الذي يستخدم نموذجا لتعيين تسميات لكل عنصر في التقييم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	صفيف		‏‏نعم‬
labels	صفيف	التسميات التي يجب تعيينها لكل عنصر في التقييم.	‏‏نعم‬
نموذج	string	النموذج الذي يجب استخدامه للتقييم. يجب أن يدعم المخرجات المنظمة.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
passing_labels	صفيف	التسميات التي تشير إلى نتيجة تمرير. يجب أن تكون مجموعة فرعية من التسميات.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: label_model	‏‏نعم‬

OpenAI.GraderMulti

يجمع كائن MultiGrader بين مخرجات مصنفي التقديرات المتعددة لإنتاج درجة واحدة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
calculate_output	string	صيغة لحساب المخرجات استنادا إلى نتائج مصنف التقديرات.	‏‏نعم‬
طلاب الصف	object	كائن StringCheckGrader الذي يقوم بإجراء مقارنة سلسلة بين الإدخال والمرجع باستخدام عملية محددة.	‏‏نعم‬
└─ 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	لا
└─ image_tag	string	علامة الصورة المراد استخدامها لبرنامج python النصي.	لا
└─ المدخلات	صفيف		لا
└─ التسميات	صفيف	التسميات التي يجب تعيينها لكل عنصر في التقييم.	لا
└─ نموذج	string	النموذج الذي يجب استخدامه للتقييم. يجب أن يدعم المخرجات المنظمة.	لا
└─ الاسم	string	اسم رئيس الدرجات.	لا
└─ عملية	enum	عملية التحقق من السلسلة التي يجب تنفيذها. واحد من eqأو nelikeأو أو ilike. القيم المحتملة: eq، ne، ، likeilike	لا
└─ passing_labels	صفيف	التسميات التي تشير إلى نتيجة تمرير. يجب أن تكون مجموعة فرعية من التسميات.	لا
└─ النطاق	صفيف	نطاق النتيجة. الإعدادات الافتراضية لـ [0, 1].	لا
└─ المرجع	string	النص الذي يتم تقييمه مقابله.	لا
└─ sampling_params	OpenAI.EvalGraderScoreModelSamplingParams	معلمات أخذ العينات للنموذج.	لا
└─ المصدر	string	الكود المصدري لبرنامج python النصي.	لا
└─ النوع	enum	نوع الكائن، الذي يتم label_modelدائما . القيم المحتملة: label_model	لا
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم multiدائما . القيم المحتملة: multi	‏‏نعم‬

OpenAI.GraderPython

كائن PythonGrader يقوم بتشغيل برنامج نصي python على الإدخال.

الاسم	النوع	وصف	مطلوب	الإفتراضي
image_tag	string	علامة الصورة المراد استخدامها لبرنامج python النصي.	لا
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
المصدر	string	الكود المصدري لبرنامج python النصي.	‏‏نعم‬
النوع	enum	نوع الكائن، الذي يتم pythonدائما . القيم المحتملة: python	‏‏نعم‬

OpenAI.GraderScoreModel

عنصر ScoreModelGrader الذي يستخدم نموذجا لتعيين درجة إلى الإدخال.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الادخال	صفيف	نص الإدخال. قد يتضمن ذلك سلاسل القالب.	‏‏نعم‬
نموذج	string	النموذج الذي يجب استخدامه للتقييم.	‏‏نعم‬
الاسم	string	اسم رئيس الدرجات.	‏‏نعم‬
النطاق	صفيف	نطاق النتيجة. الإعدادات الافتراضية لـ [0, 1].	لا
sampling_params	object		لا
└─ max_completions_tokens	OpenAI.integer		لا
└─ reasoning_effort	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
└─ البذور	OpenAI.integer		لا
└─ درجة الحرارة	OpenAI.numeric		لا
└─ top_p	OpenAI.numeric		لا
النوع	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.ImageGenTool

أداة تنشئ الصور باستخدام نموذج مثل gpt-image-1.

الاسم	النوع	وصف	مطلوب	الإفتراضي
background	enum	نوع الخلفية للصورة التي تم إنشاؤها. واحد من transparent، opaque، أو auto. افتراضي: auto. القيم المحتملة: transparent، ، opaqueauto	لا
input_image_mask	object	قناع اختياري للمسح. يحتوي image_url (سلسلة، اختيارية) و file_id (سلسلة، اختيارية).	لا
└─ file_id	string	معرف الملف لصورة القناع.	لا
└─ image_url	string	صورة قناع مرمز ب Base64.	لا
نموذج	enum	نموذج إنشاء الصور المراد استخدامه. افتراضي: gpt-image-1. القيم المحتملة: gpt-image-1	لا
moderation	enum	مستوى الإشراف للصورة التي تم إنشاؤها. افتراضي: auto. القيم المحتملة: auto، low	لا
output_compression	integer	مستوى الضغط لصورة الإخراج. الافتراضي: 100.	لا	100
output_format	enum	تنسيق الإخراج للصورة التي تم إنشاؤها. واحد من pngأو webpأو jpeg. افتراضي: png. القيم المحتملة: png، ، webpjpeg	لا
partial_images	integer	عدد الصور الجزئية التي سيتم إنشاؤها في وضع الدفق، من 0 (القيمة الافتراضية) إلى 3.	لا	0
جودة	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.ImageGenToolCallItemParam

طلب إنشاء صورة قام به النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نتيجة	string	الصورة التي تم إنشاؤها مشفرة في base64.	‏‏نعم‬
النوع	enum	القيم المحتملة: image_generation_call	‏‏نعم‬

OpenAI.ImageGenToolCallItemResource

طلب إنشاء صورة قام به النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
نتيجة	string	الصورة التي تم إنشاؤها مشفرة في base64.	‏‏نعم‬
الحالة	enum	القيم المحتملة: in_progress، completed، ، generatingfailed	‏‏نعم‬
النوع	enum	القيم المحتملة: image_generation_call	‏‏نعم‬

OpenAI.Includable

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

• 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، أو عند تسجيل مؤسسة في برنامج الاحتفاظ بالبيانات الصفرية).

الخاصية	قيمة
الوصف	حدد بيانات إخراج إضافية لتضمينها في استجابة النموذج. حاليا القيم المدعومة هي: - 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، أو عندما تكون المؤسسة مسجل في برنامج الاحتفاظ بالبيانات الصفرية).
Type	string
Values	code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content web_search_call.results web_search_call.action.sources memory_search_call.results

OpenAI.ItemContent

المميز ل OpenAI.ItemContent

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

قيمة النوع	Schema
input_audio	OpenAI.ItemContentInputAudio
output_audio	OpenAI.ItemContentOutputAudio
refusal	OpenAI.ItemContentRefusal
input_text	OpenAI.ItemContentInputText
input_image	OpenAI.ItemContentInputImage
input_file	OpenAI.ItemContentInputFile
output_text	OpenAI.ItemContentOutputText

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ItemContentType	محتويات الإدخال والإخراج متعددة الوسائط.	‏‏نعم‬

OpenAI.ItemContentInputAudio

إدخال صوتي للنموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	string	بيانات صوتية مرمزة ب Base64.	‏‏نعم‬
format	enum	تنسيق البيانات الصوتية. التنسيقات المدعومة حاليا هي mp3 و wav. القيم المحتملة: mp3، wav	‏‏نعم‬
النوع	enum	نوع عنصر الإدخال. دائمًا input_audio. القيم المحتملة: input_audio	‏‏نعم‬

OpenAI.ItemContentInputFile

إدخال ملف إلى النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
file_data	string	محتوى الملف الذي سيتم إرساله إلى النموذج.	لا
file_id	string	معرف الملف الذي سيتم إرساله إلى النموذج.	لا
filename	string	اسم الملف الذي سيتم إرساله إلى النموذج.	لا
النوع	enum	نوع عنصر الإدخال. دائمًا input_file. القيم المحتملة: input_file	‏‏نعم‬

OpenAI.ItemContentInputImage

إدخال صورة إلى النموذج. تعرف على مدخلات image.

الاسم	النوع	وصف	مطلوب	الإفتراضي
تفصيل	enum	مستوى تفاصيل الصورة التي سيتم إرسالها إلى النموذج. واحد من highأو lowأو auto. الإعدادات الافتراضية لـ auto. القيم المحتملة: low، ، highauto	لا
file_id	string	معرف الملف الذي سيتم إرساله إلى النموذج.	لا
image_url	string	عنوان URL للصورة التي سيتم إرسالها إلى النموذج. عنوان URL مؤهل بالكامل أو صورة مشفرة base64 في عنوان URL للبيانات.	لا
النوع	enum	نوع عنصر الإدخال. دائمًا input_image. القيم المحتملة: input_image	‏‏نعم‬

OpenAI.ItemContentInputText

إدخال نص إلى النموذج.

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

OpenAI.ItemContentOutputAudio

إخراج صوت من النموذج.

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

OpenAI.ItemContentOutputText

إخراج نص من النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotations	صفيف	التعليقات التوضيحية لإخراج النص.	‏‏نعم‬
سجلات الحماية	صفيف		لا
نص	string	إخراج النص من النموذج.	‏‏نعم‬
النوع	enum	نوع النص الناتج. دائمًا output_text. القيم المحتملة: output_text	‏‏نعم‬

OpenAI.ItemContentRefusal

رفض من النموذج.

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

OpenAI.ItemContentType

محتويات الإدخال والإخراج متعددة الوسائط.

الخاصية	قيمة
الوصف	محتويات الإدخال والإخراج متعددة الوسائط.
Type	string
Values	input_text input_audio input_image input_file output_text output_audio refusal

OpenAI.ItemParam

عنصر المحتوى المستخدم لإنشاء استجابة.

المميز ل OpenAI.ItemParam

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

قيمة النوع	Schema
message	OpenAI.ResponsesMessageItemParam
function_call_output	OpenAI.FunctionToolCallOutputItemParam
file_search_call	OpenAI.FileSearchToolCallItemParam
computer_call	OpenAI.ComputerToolCallItemParam
computer_call_output	OpenAI.ComputerToolCallOutputItemParam
web_search_call	OpenAI.WebSearchToolCallItemParam
function_call	OpenAI.FunctionToolCallItemParam
reasoning	OpenAI.ReasoningItemParam
item_reference	OpenAI.ItemReferenceItemParam
image_generation_call	OpenAI.ImageGenToolCallItemParam
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemParam
local_shell_call	OpenAI.LocalShellToolCallItemParam
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools	OpenAI.MCPListToolsItemParam
mcp_approval_request	OpenAI.MCPApprovalRequestItemParam
mcp_approval_response	OpenAI.MCPApprovalResponseItemParam
mcp_call	OpenAI.MCPCallItemParam
memory_search_call	MemorySearchToolCallItemParam

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

OpenAI.ItemReferenceItemParam

معرف داخلي لعنصر للرجوع إليه.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الذي تم إنشاؤه بواسطة الخدمة لعنصر الاستجابة الذي تم إنشاؤه مسبقا والذي تتم الإشارة إليه.	‏‏نعم‬
النوع	enum	القيم المحتملة: item_reference	‏‏نعم‬

OpenAI.ItemResource

عنصر المحتوى المستخدم لإنشاء استجابة.

Discriminator ل OpenAI.ItemResource

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

قيمة النوع	Schema
structured_outputs	StructuredOutputsItemResource
workflow_action	WorkflowActionOutputItemResource
oauth_consent_request	OAuthConsentRequestItemResource
message	OpenAI.ResponsesMessageItemResource
computer_call_output	OpenAI.ComputerToolCallOutputItemResource
function_call	OpenAI.FunctionToolCallItemResource
function_call_output	OpenAI.FunctionToolCallOutputItemResource
mcp_approval_response	OpenAI.MCPApprovalResponseItemResource
file_search_call	OpenAI.FileSearchToolCallItemResource
computer_call	OpenAI.ComputerToolCallItemResource
web_search_call	OpenAI.WebSearchToolCallItemResource
reasoning	OpenAI.ReasoningItemResource
image_generation_call	OpenAI.ImageGenToolCallItemResource
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource
local_shell_call	OpenAI.LocalShellToolCallItemResource
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools	OpenAI.MCPListToolsItemResource
mcp_approval_request	OpenAI.MCPApprovalRequestItemResource
mcp_call	OpenAI.MCPCallItemResource
memory_search_call	MemorySearchToolCallItemResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
created_by	object		لا
└─ عامل	معرف العامل	العامل الذي أنشأ العنصر.	لا
└─ response_id	string	الاستجابة التي يتم إنشاء العنصر عليها.	لا
المعرف	string		‏‏نعم‬
النوع	OpenAI.ItemType		‏‏نعم‬

OpenAI.ItemType

الخاصية	قيمة
Type	string
Values	message file_search_call function_call function_call_output computer_call computer_call_output web_search_call reasoning item_reference image_generation_call code_interpreter_call local_shell_call local_shell_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call structured_outputs workflow_action memory_search_call oauth_consent_request

OpenAI.ListFineTuningJobCheckpointsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	صفيف		‏‏نعم‬
first_id	string		لا
has_more	boolean		‏‏نعم‬
last_id	string		لا
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ListFineTuningJobEventsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	صفيف		‏‏نعم‬
has_more	boolean		‏‏نعم‬
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.ListPaginatedFineTuningJobsResponse

الاسم	النوع	وصف	مطلوب	الإفتراضي
البيانات	صفيف		‏‏نعم‬
has_more	boolean		‏‏نعم‬
object	enum	القيم المحتملة: list	‏‏نعم‬

OpenAI.LocalShellExecAction

قم بتنفيذ أمر shell على الخادم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
أمر	صفيف	الأمر الذي يجب تشغيله.	‏‏نعم‬
الحياه الفطريه	object	متغيرات البيئة المراد تعيينها للأمر.	‏‏نعم‬
timeout_ms	integer	مهلة اختيارية بالمللي ثانية للأمر.	لا
النوع	enum	نوع عمل الغلاف المحلي. دائمًا exec. القيم المحتملة: exec	‏‏نعم‬
user	string	مستخدم اختياري لتشغيل الأمر باسم.	لا
working_directory	string	دليل عمل اختياري لتشغيل الأمر فيه.	لا

OpenAI.LocalShellTool

أداة تسمح للنموذج بتنفيذ أوامر shell في بيئة محلية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع أداة shell المحلية. دائمًا local_shell. القيم المحتملة: local_shell	‏‏نعم‬

OpenAI.LocalShellToolCallItemParam

استدعاء أداة لتشغيل أمر على الغلاف المحلي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.LocalShellExecAction	قم بتنفيذ أمر shell على الخادم.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة shell المحلية التي تم إنشاؤها بواسطة النموذج.	‏‏نعم‬
النوع	enum	القيم المحتملة: local_shell_call	‏‏نعم‬

OpenAI.LocalShellToolCallItemResource

استدعاء أداة لتشغيل أمر على الغلاف المحلي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	OpenAI.LocalShellExecAction	قم بتنفيذ أمر shell على الخادم.	‏‏نعم‬
call_id	string	المعرف الفريد لاستدعاء أداة shell المحلية التي تم إنشاؤها بواسطة النموذج.	‏‏نعم‬
الحالة	enum	القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	القيم المحتملة: local_shell_call	‏‏نعم‬

OpenAI.LocalShellToolCallOutputItemParam

إخراج استدعاء أداة shell محلية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الناتج	string	سلسلة JSON لإخراج استدعاء أداة shell المحلية.	‏‏نعم‬
النوع	enum	القيم المحتملة: local_shell_call_output	‏‏نعم‬

OpenAI.LocalShellToolCallOutputItemResource

إخراج استدعاء أداة shell محلية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الناتج	string	سلسلة JSON لإخراج استدعاء أداة shell المحلية.	‏‏نعم‬
الحالة	enum	القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	القيم المحتملة: local_shell_call_output	‏‏نعم‬

OpenAI.Location

تمييز ل OpenAI.Location

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

قيمة النوع	Schema
approximate	OpenAI.ApproximateLocation

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

OpenAI.LocationType

الخاصية	قيمة
Type	string
Values	approximate

OpenAI.LogProb

احتمال السجل للرمز المميز.

الاسم	النوع	وصف	مطلوب	الإفتراضي
بايت	صفيف		‏‏نعم‬
لوغاربوب	رقم		‏‏نعم‬
الرمز المميز	string		‏‏نعم‬
top_logprobs	صفيف		‏‏نعم‬

OpenAI.MCPApprovalRequestItemParam

طلب موافقة بشرية على استدعاء أداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات للأداة.	‏‏نعم‬
الاسم	string	اسم الأداة المراد تشغيلها.	‏‏نعم‬
server_label	string	تسمية خادم MCP الذي يقدم الطلب.	‏‏نعم‬
النوع	enum	القيم المحتملة: mcp_approval_request	‏‏نعم‬

OpenAI.MCPApprovalRequestItemResource

طلب موافقة بشرية على استدعاء أداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات للأداة.	‏‏نعم‬
الاسم	string	اسم الأداة المراد تشغيلها.	‏‏نعم‬
server_label	string	تسمية خادم MCP الذي يقدم الطلب.	‏‏نعم‬
النوع	enum	القيم المحتملة: mcp_approval_request	‏‏نعم‬

OpenAI.MCPApprovalResponseItemParam

استجابة لطلب موافقة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
approval_request_id	string	معرف طلب الموافقة الذي يتم الرد عليه.	‏‏نعم‬
approve	boolean	ما إذا كان قد تمت الموافقة على الطلب.	‏‏نعم‬
السبب	string	سبب اختياري للقرار.	لا
النوع	enum	القيم المحتملة: mcp_approval_response	‏‏نعم‬

OpenAI.MCPApprovalResponseItemResource

استجابة لطلب موافقة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
approval_request_id	string	معرف طلب الموافقة الذي يتم الرد عليه.	‏‏نعم‬
approve	boolean	ما إذا كان قد تمت الموافقة على الطلب.	‏‏نعم‬
السبب	string	سبب اختياري للقرار.	لا
النوع	enum	القيم المحتملة: mcp_approval_response	‏‏نعم‬

OpenAI.MCPCallItemParam

استدعاء أداة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات التي تم تمريرها إلى الأداة.	‏‏نعم‬
خطأ	string	الخطأ من استدعاء الأداة، إن وجد.	لا
الاسم	string	اسم الأداة التي تم تشغيلها.	‏‏نعم‬
الناتج	string	الإخراج من استدعاء الأداة.	لا
server_label	string	تسمية خادم MCP الذي يقوم بتشغيل الأداة.	‏‏نعم‬
النوع	enum	القيم المحتملة: mcp_call	‏‏نعم‬

OpenAI.MCPCallItemResource

استدعاء أداة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	سلسلة JSON من الوسيطات التي تم تمريرها إلى الأداة.	‏‏نعم‬
خطأ	string	الخطأ من استدعاء الأداة، إن وجد.	لا
الاسم	string	اسم الأداة التي تم تشغيلها.	‏‏نعم‬
الناتج	string	الإخراج من استدعاء الأداة.	لا
server_label	string	تسمية خادم MCP الذي يقوم بتشغيل الأداة.	‏‏نعم‬
النوع	enum	القيم المحتملة: mcp_call	‏‏نعم‬

OpenAI.MCPListToolsItemParam

قائمة بالأدوات المتوفرة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	string	رسالة خطأ إذا تعذر على الخادم سرد الأدوات.	لا
server_label	string	تسمية خادم MCP.	‏‏نعم‬
الأدوات	صفيف	الأدوات المتوفرة على الخادم.	‏‏نعم‬
النوع	enum	القيم المحتملة: mcp_list_tools	‏‏نعم‬

OpenAI.MCPListToolsItemResource

قائمة بالأدوات المتوفرة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	string	رسالة خطأ إذا تعذر على الخادم سرد الأدوات.	لا
server_label	string	تسمية خادم MCP.	‏‏نعم‬
الأدوات	صفيف	الأدوات المتوفرة على الخادم.	‏‏نعم‬
النوع	enum	القيم المحتملة: mcp_list_tools	‏‏نعم‬

أداة OpenAI.MCPListToolsTool

أداة متوفرة على خادم MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
annotations		تعليقات توضيحية إضافية حول الأداة.	لا
الوصف	string	وصف الأداة.	لا
input_schema		مخطط JSON الذي يصف إدخال الأداة.	‏‏نعم‬
الاسم	string	اسم الأداة.	‏‏نعم‬

OpenAI.MCPTool

امنح النموذج access إلى أدوات إضافية عبر خوادم بروتوكول سياق النموذج البعيد (MCP). تعرف على المزيد حول MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
allowed_tools	object		لا
└─ tool_names	صفيف	قائمة بأسماء الأدوات المسموح بها.	لا
headers	object	عناوين HTTP الاختيارية لإرسالها إلى خادم MCP. استخدام للمصادقة أو أغراض أخرى.	لا
project_connection_id	string	معرف الاتصال في project لخادم MCP. يخزن الاتصال المصادقة وتفاصيل الاتصال الأخرى اللازمة للاتصال بخادم MCP.	لا
require_approval	الكائن (راجع النماذج الصالحة أدناه)	حدد أي من أدوات خادم MCP تتطلب الموافقة.	لا
server_label	string	تسمية لخادم MCP هذا، تستخدم لتعريفه في استدعاءات الأدوات.	‏‏نعم‬
server_url	string	عنوان URL لخادم MCP.	‏‏نعم‬
النوع	enum	نوع أداة MCP. دائمًا mcp. القيم المحتملة: mcp	‏‏نعم‬

OpenAI.Metadata

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

المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.

النوع: كائن

OpenAI.Prompt

الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
المعرف	string	المعرف الفريد لقالب المطالبة المراد استخدامه.	‏‏نعم‬
متغيرات	object	خريطة اختيارية للقيم لاستبدالها بالمتغيرات في فوري. يمكن أن تكون قيم الاستبدال إما سلاسل أو غيرها أنواع إدخال الاستجابة مثل الصور أو الملفات.	لا
إصدار	string	إصدار اختياري من قالب المطالبة.	لا

OpenAI.RankingOptions

الاسم	النوع	وصف	مطلوب	الإفتراضي
ranker	enum	المصنف الذي يجب استخدامه للبحث عن الملفات. القيم المحتملة: auto، default-2024-11-15	لا
score_threshold	رقم	حد الدرجة للبحث في الملف، رقم بين 0 و1. ستحاول الأرقام الأقرب إلى 1 إرجاع النتائج الأكثر صلة فقط، ولكنها قد ترجع نتائج أقل.	لا

OpenAI.المنطق

نماذج السلسلة o فقط

خيارات التكوين لنماذج المنطق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
جهد	object	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
generate_summary	enum	مهمل: استخدم summary بدلا من ذلك. ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيدا لتصحيح أخطاء عملية التفكير في النموذج وفهمها. واحد من autoأو conciseأو detailed. القيم المحتملة: auto، ، concisedetailed	لا
الملخص.	enum	ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيد لتصحيح الأخطاء وفهم عملية التفكير في النموذج. واحد من autoأو conciseأو detailed. القيم المحتملة: auto، ، concisedetailed	لا

OpenAI.ReasoningEffort

يقيد الجهد المبذول في التفكير في نماذج المنطق.

القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي.

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

يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1.

جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها.

نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.

الخاصية	قيمة
الوصف	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.
Type	string
Values	none minimal low medium high

OpenAI.ReasoningItemParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
encrypted_content	string	المحتوى المشفر لعنصر الاستدلال - يتم ملؤه عندما تكون الاستجابة تم إنشاؤه باستخدام reasoning.encrypted_content في المعلمة include .	لا
الملخص.	صفيف	تحليل محتويات النص.	‏‏نعم‬
النوع	enum	القيم المحتملة: reasoning	‏‏نعم‬

OpenAI.ReasoningItemResource

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
encrypted_content	string	المحتوى المشفر لعنصر الاستدلال - يتم ملؤه عندما تكون الاستجابة تم إنشاؤه باستخدام reasoning.encrypted_content في المعلمة include .	لا
الملخص.	صفيف	تحليل محتويات النص.	‏‏نعم‬
النوع	enum	القيم المحتملة: reasoning	‏‏نعم‬

OpenAI.ReasoningItemSummarizepart

المميز ل OpenAI.ReasoningItemSummaryPart

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

قيمة النوع	Schema
summary_text	OpenAI.ReasoningItemSummaryTextPart

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

OpenAI.ReasoningItemSummmaryPartType

الخاصية	قيمة
Type	string
Values	summary_text

OpenAI.ReasoningItemSummaryTextPart

الاسم	النوع	وصف	مطلوب	الإفتراضي
نص	string		‏‏نعم‬
النوع	enum	القيم المحتملة: summary_text	‏‏نعم‬

OpenAI.الاستجابة

الاسم	النوع	وصف	مطلوب	الإفتراضي
agent	object		لا
└─ الاسم	string	اسم الوكيل.	لا
└─ النوع	enum	القيم المحتملة: agent_id	لا
└─ الإصدار	string	معرف إصدار الوكيل.	لا
background	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
حوار	object		‏‏نعم‬
└─ الهوية	string		لا
created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	‏‏نعم‬
خطأ	object	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	‏‏نعم‬
└─ كود	OpenAI.ResponseErrorCode	رمز الخطأ للاستجابة.	لا
└─ رسالة	string	وصف يمكن للإنسان قراءته للخطأ.	لا
المعرف	string	معرف فريد لهذه الاستجابة.	‏‏نعم‬
incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	‏‏نعم‬
└─ السبب	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: max_output_tokens، content_filter	لا
تعليمات	سلسلة أو مجموعة		‏‏نعم‬
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	‏‏نعم‬
نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
object	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	‏‏نعم‬
الناتج	صفيف	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	‏‏نعم‬
output_text	string	خاصية الراحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع output_text العناصر الموجودة في المصفوفة output ، إن وجدت. مدعوم في Python وJavaScript SDKs.	لا
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	‏‏نعم‬	صحيح
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
فوري	object	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
└─ الهوية	string	المعرف الفريد لقالب المطالبة المراد استخدامه.	لا
└─ المتغيرات	OpenAI.ResponsePromptVariables	خريطة اختيارية للقيم لاستبدالها بالمتغيرات في فوري. يمكن أن تكون قيم الاستبدال إما سلاسل أو غيرها أنواع إدخال الاستجابة مثل الصور أو الملفات.	لا
└─ الإصدار	string	إصدار اختياري من قالب المطالبة.	لا
المنطق	object	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ الجهد	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
└─ generate_summary	enum	مهمل: استخدم summary بدلا من ذلك. ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيدا لتصحيح أخطاء عملية التفكير في النموذج وفهمها. واحد من autoأو conciseأو detailed. القيم المحتملة: auto، ، concisedetailed	لا
└─ ملخص	enum	ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيد لتصحيح الأخطاء وفهم عملية التفكير في النموذج. واحد من autoأو conciseأو detailed. القيم المحتملة: auto، ، concisedetailed	لا
service_tier	object	يحدد نوع المعالجة المستخدم لخدمة الطلب. * إذا تم تعيينه إلى "تلقائي"، فستتم معالجة الطلب مع مستوى الخدمة تم تكوينه في إعدادات Project. ما لم يتم تكوين خلاف ذلك، سيستخدم Project "افتراضي". * إذا تم تعيينه إلى "افتراضي"، فستتم معالجة الطلب مع المعيار التسعير والأداء للنموذج المحدد. * إذا تم تعيينه إلى "flex" أو "الأولوية"، ثم ستتم معالجة الطلب مع الخدمة المقابلة المستوي. اتصل بالمبيعات لمعرفة المزيد حول معالجة الأولوية. * عند عدم التعيين، يكون السلوك الافتراضي هو "تلقائي". عند تعيين المعلمة service_tier ، سيتضمن نص الاستجابة service_tier استنادا إلى وضع المعالجة المستخدم فعليا لخدمة الطلب. قيمة الاستجابة هذه قد تختلف عن القيمة التي تم تعيينها في المعلمة .	لا
الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	‏‏نعم‬
نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
tool_choice	object	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. auto يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء رسالة أو المزيد من الأدوات. required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر.	لا
└─ النوع	OpenAI.ToolChoiceObjectType	يشير إلى أن النموذج يجب أن يستخدم أداة مضمنة لإنشاء استجابة. تعرف على المزيد حول الأدوات المضمنة.	لا
الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: * الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث web أو ملف البحث. معرفة المزيد حول . * استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك. معرفة المزيد حول الاتصال الوظيفي.	لا
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	‏‏نعم‬
اقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
استخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
user	string	تعرف على المزيد حول أفضل ممارسات السلامة.	‏‏نعم‬

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

يتم انبعاثه عند دفق مقتطف رمز جزئي بواسطة مترجم التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	مقتطف التعليمات البرمجية الجزئي الذي يتم دفقه بواسطة مترجم التعليمات البرمجية.	‏‏نعم‬
item_id	string	المعرف الفريد لعنصر استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في الاستجابة التي يتم دفق التعليمات البرمجية لها.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.code_interpreter_call_code.delta. القيم المحتملة: response.code_interpreter_call_code.delta	‏‏نعم‬

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

يتم انبعاثها عند إنهاء قصاصة التعليمات البرمجية بواسطة مترجم التعليمات البرمجية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	string	إخراج مقتطف التعليمات البرمجية النهائي بواسطة مترجم التعليمات البرمجية.	‏‏نعم‬
item_id	string	المعرف الفريد لعنصر استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في الاستجابة التي تم وضع اللمسات الأخيرة على التعليمات البرمجية لها.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.code_interpreter_call_code.done. القيم المحتملة: response.code_interpreter_call_code.done	‏‏نعم‬

OpenAI.ResponseCodeInterpreterCallCompletedEvent

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في الاستجابة التي اكتملت استدعاء مترجم التعليمات البرمجية لها.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.code_interpreter_call.completed. القيم المحتملة: response.code_interpreter_call.completed	‏‏نعم‬

OpenAI.ResponseCodeInterpreterCallInProgressEvent

تنبعث عندما تكون استدعاء مترجم التعليمات البرمجية قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في الاستجابة التي يكون استدعاء مترجم التعليمات البرمجية قيد التقدم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.code_interpreter_call.in_progress. القيم المحتملة: response.code_interpreter_call.in_progress	‏‏نعم‬

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر استدعاء أداة مترجم التعليمات البرمجية.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في الاستجابة التي يقوم مترجم التعليمات البرمجية بتفسير التعليمات البرمجية لها.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.code_interpreter_call.interpreting. القيم المحتملة: response.code_interpreter_call.interpreting	‏‏نعم‬

OpenAI.ResponseCompletedEvent

تنبعث عند اكتمال استجابة النموذج.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	object		‏‏نعم‬
└─ عامل	معرف العامل	العامل المستخدم لهذه الاستجابة	لا
└─ خلفية	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
└─ محادثة	object		لا
└─ الهوية	string		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	لا
└─ خطأ	OpenAI.ResponseError	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	لا
└─ الهوية	string	معرف فريد لهذه الاستجابة.	لا
└─ incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	لا
└─ السبب	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: max_output_tokens، content_filter	لا
└─ تعليمات	سلسلة أو مجموعة	رسالة نظام (أو مطور) مدرجة في سياق النموذج. عند الاستخدام جنبا إلى جنب مع previous_response_id، التعليمات من السابق لن يتم ترحيل الرد إلى الرد التالي. هذا يجعل الأمر بسيطا لتبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
└─ max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
└─ max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
└─ البيانات الوصفية	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
└─ نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	لا
└─ الإخراج	صفيف	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	لا
└─ output_text	string	خاصية الراحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع output_text العناصر الموجودة في المصفوفة output ، إن وجدت. مدعوم في Python وJavaScript SDKs.	لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
└─ previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
└─ التفكير	OpenAI.المنطق	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ service_tier	OpenAI.ServiceTier	ملاحظة: لا ينطبق service_tier على Azure OpenAI.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
└─ درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا
└─ نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
└─ tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceObject	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: * الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث web أو ملف البحث. معرفة المزيد حول . * استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك. معرفة المزيد حول الاتصال الوظيفي.	لا
└─ top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
└─ top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا
└─ الاقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	string	تعرف على المزيد حول أفضل ممارسات السلامة.	لا
النوع	enum	نوع الحدث. دائمًا response.completed. القيم المحتملة: response.completed	‏‏نعم‬

OpenAI.ResponseContentPartAddedEvent

تنبعث عند إضافة جزء محتوى جديد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
جزء	object		‏‏نعم‬
└─ النوع	OpenAI.ItemContentType	محتويات الإدخال والإخراج متعددة الوسائط.	لا
النوع	enum	نوع الحدث. دائمًا response.content_part.added. القيم المحتملة: response.content_part.added	‏‏نعم‬

OpenAI.ResponseContentPartDoneEvent

تنبعث عند الانتهاء من جزء المحتوى.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تم القيام به.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	‏‏نعم‬
جزء	object		‏‏نعم‬
└─ النوع	OpenAI.ItemContentType	محتويات الإدخال والإخراج متعددة الوسائط.	لا
النوع	enum	نوع الحدث. دائمًا response.content_part.done. القيم المحتملة: response.content_part.done	‏‏نعم‬

OpenAI.ResponseCreatedEvent

حدث ينبعث عند إنشاء استجابة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	object		‏‏نعم‬
└─ عامل	معرف العامل	العامل المستخدم لهذه الاستجابة	لا
└─ خلفية	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
└─ محادثة	object		لا
└─ الهوية	string		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	لا
└─ خطأ	OpenAI.ResponseError	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	لا
└─ الهوية	string	معرف فريد لهذه الاستجابة.	لا
└─ incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	لا
└─ السبب	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: max_output_tokens، content_filter	لا
└─ تعليمات	سلسلة أو مجموعة	رسالة نظام (أو مطور) مدرجة في سياق النموذج. عند الاستخدام جنبا إلى جنب مع previous_response_id، التعليمات من السابق لن يتم ترحيل الرد إلى الرد التالي. هذا يجعل الأمر بسيطا لتبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
└─ max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
└─ max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
└─ البيانات الوصفية	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
└─ نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	لا
└─ الإخراج	صفيف	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	لا
└─ output_text	string	خاصية الراحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع output_text العناصر الموجودة في المصفوفة output ، إن وجدت. مدعوم في Python وJavaScript SDKs.	لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
└─ previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
└─ التفكير	OpenAI.المنطق	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ service_tier	OpenAI.ServiceTier	ملاحظة: لا ينطبق service_tier على Azure OpenAI.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
└─ درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا
└─ نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
└─ tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceObject	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: * الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث web أو ملف البحث. معرفة المزيد حول . * استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك. معرفة المزيد حول الاتصال الوظيفي.	لا
└─ top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
└─ top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا
└─ الاقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	string	تعرف على المزيد حول أفضل ممارسات السلامة.	لا
النوع	enum	نوع الحدث. دائمًا response.created. القيم المحتملة: response.created	‏‏نعم‬

OpenAI.ResponseError

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	OpenAI.ResponseErrorCode	رمز الخطأ للاستجابة.	‏‏نعم‬
رسالة	string	وصف يمكن للإنسان قراءته للخطأ.	‏‏نعم‬

OpenAI.ResponseErrorCode

رمز الخطأ للاستجابة.

الخاصية	قيمة
الوصف	رمز الخطأ للاستجابة.
Type	string
Values	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

OpenAI.ResponseErrorEvent

تنبعث عند حدوث خطأ.

الاسم	النوع	وصف	مطلوب	الإفتراضي
رمز	string	رمز الخطأ.	‏‏نعم‬
رسالة	string	رسالة الخطأ.	‏‏نعم‬
بارام	string	معلمة الخطأ.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا error. القيم المحتملة: error	‏‏نعم‬

OpenAI.ResponseFailedEvent

حدث ينبعث عند فشل الاستجابة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	object		‏‏نعم‬
└─ عامل	معرف العامل	العامل المستخدم لهذه الاستجابة	لا
└─ خلفية	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
└─ محادثة	object		لا
└─ الهوية	string		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	لا
└─ خطأ	OpenAI.ResponseError	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	لا
└─ الهوية	string	معرف فريد لهذه الاستجابة.	لا
└─ incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	لا
└─ السبب	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: max_output_tokens، content_filter	لا
└─ تعليمات	سلسلة أو مجموعة	رسالة نظام (أو مطور) مدرجة في سياق النموذج. عند الاستخدام جنبا إلى جنب مع previous_response_id، التعليمات من السابق لن يتم ترحيل الرد إلى الرد التالي. هذا يجعل الأمر بسيطا لتبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
└─ max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
└─ max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
└─ البيانات الوصفية	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
└─ نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	لا
└─ الإخراج	صفيف	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	لا
└─ output_text	string	خاصية الراحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع output_text العناصر الموجودة في المصفوفة output ، إن وجدت. مدعوم في Python وJavaScript SDKs.	لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
└─ previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
└─ التفكير	OpenAI.المنطق	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ service_tier	OpenAI.ServiceTier	ملاحظة: لا ينطبق service_tier على Azure OpenAI.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
└─ درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا
└─ نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
└─ tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceObject	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: * الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث web أو ملف البحث. معرفة المزيد حول . * استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك. معرفة المزيد حول الاتصال الوظيفي.	لا
└─ top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
└─ top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا
└─ الاقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	string	تعرف على المزيد حول أفضل ممارسات السلامة.	لا
النوع	enum	نوع الحدث. دائمًا response.failed. القيم المحتملة: response.failed	‏‏نعم‬

OpenAI.ResponseFileSearchCallCompletedEvent

تنبعث عند اكتمال استدعاء البحث عن الملف (تم العثور على النتائج).

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يتم بدء استدعاء البحث في الملف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.file_search_call.completed. القيم المحتملة: response.file_search_call.completed	‏‏نعم‬

OpenAI.ResponseFileSearchCallInProgressEvent

تنبعث عند بدء استدعاء البحث عن ملف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يتم بدء استدعاء البحث في الملف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.file_search_call.in_progress. القيم المحتملة: response.file_search_call.in_progress	‏‏نعم‬

OpenAI.ResponseFileSearchCallSearchingEvent

ينبعث عند البحث عن ملف حاليا.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تبحث عنه مكالمة البحث في الملف.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.file_search_call.searching. القيم المحتملة: response.file_search_call.searching	‏‏نعم‬

OpenAI.ResponseFormat

المميز ل OpenAI.ResponseFormat

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

قيمة النوع	Schema
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: text، ، json_objectjson_schema	‏‏نعم‬

OpenAI.ResponseFormatJsonObject

تنسيق استجابة كائن JSON. طريقة قديمة لإنشاء استجابات JSON. يوصى باستخدام json_schema للنماذج التي تدعمه. لاحظ أن النموذج لن ينشئ JSON بدون رسالة نظام أو مستخدم ترشده to do ذلك.

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

OpenAI.ResponseFormatJsonSchema

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

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

OpenAI.ResponseFormatText

تنسيق الاستجابة الافتراضي. يستخدم لإنشاء استجابات نصية.

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

تنبعث عندما يكون هناك دلتا جزئية لاستدعاء الدالة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	وسيطات استدعاء الدالة دلتا التي تمت إضافتها.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة دلتا وسيطات استدعاء الدالة إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تتم إضافة وسيطات استدعاء الدالة إليه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.function_call_arguments.delta. القيم المحتملة: response.function_call_arguments.delta	‏‏نعم‬

OpenAI.ResponseFunctionCallArgumentsDoneEvent

تنبعث عند الانتهاء من وسيطات استدعاء الدالة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج	string	وسيطات استدعاء الدالة.	‏‏نعم‬
item_id	string	معرف العنصر.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج.	‏‏نعم‬
النوع	enum	القيم المحتملة: response.function_call_arguments.done	‏‏نعم‬

OpenAI.ResponseImageGenCallCompletedEvent

تنبعث عند اكتمال استدعاء أداة إنشاء الصور وتوفر الصورة النهائية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر إنشاء الصورة الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.image_generation_call.completed". القيم المحتملة: response.image_generation_call.completed	‏‏نعم‬

OpenAI.ResponseImageGenCallGeneratingEvent

تنبعث عندما يقوم استدعاء أداة إنشاء صورة بإنشاء صورة بنشاط (الحالة الوسيطة).

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر إنشاء الصورة الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.image_generation_call.generating". القيم المحتملة: response.image_generation_call.generating	‏‏نعم‬

OpenAI.ResponseImageGenCallInProgressEvent

تنبعث عندما يكون استدعاء أداة إنشاء الصور قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر إنشاء الصورة الذي تتم معالجته.	‏‏نعم‬
output_index	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 للمستخدم).	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.image_generation_call.partial_image". القيم المحتملة: response.image_generation_call.partial_image	‏‏نعم‬

OpenAI.ResponseInProgressEvent

تنبعث عندما تكون الاستجابة قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	object		‏‏نعم‬
└─ عامل	معرف العامل	العامل المستخدم لهذه الاستجابة	لا
└─ خلفية	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
└─ محادثة	object		لا
└─ الهوية	string		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	لا
└─ خطأ	OpenAI.ResponseError	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	لا
└─ الهوية	string	معرف فريد لهذه الاستجابة.	لا
└─ incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	لا
└─ السبب	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: max_output_tokens، content_filter	لا
└─ تعليمات	سلسلة أو مجموعة	رسالة نظام (أو مطور) مدرجة في سياق النموذج. عند الاستخدام جنبا إلى جنب مع previous_response_id، التعليمات من السابق لن يتم ترحيل الرد إلى الرد التالي. هذا يجعل الأمر بسيطا لتبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
└─ max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
└─ max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
└─ البيانات الوصفية	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
└─ نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	لا
└─ الإخراج	صفيف	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	لا
└─ output_text	string	خاصية الراحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع output_text العناصر الموجودة في المصفوفة output ، إن وجدت. مدعوم في Python وJavaScript SDKs.	لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
└─ previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
└─ التفكير	OpenAI.المنطق	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ service_tier	OpenAI.ServiceTier	ملاحظة: لا ينطبق service_tier على Azure OpenAI.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
└─ درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا
└─ نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
└─ tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceObject	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: * الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث web أو ملف البحث. معرفة المزيد حول . * استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك. معرفة المزيد حول الاتصال الوظيفي.	لا
└─ top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
└─ top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا
└─ الاقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	string	تعرف على المزيد حول أفضل ممارسات السلامة.	لا
النوع	enum	نوع الحدث. دائمًا response.in_progress. القيم المحتملة: response.in_progress	‏‏نعم‬

OpenAI.ResponseIncompleteEvent

حدث ينبعث عند انتهاء الاستجابة على أنها غير مكتملة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	object		‏‏نعم‬
└─ عامل	معرف العامل	العامل المستخدم لهذه الاستجابة	لا
└─ خلفية	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
└─ محادثة	object		لا
└─ الهوية	string		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	لا
└─ خطأ	OpenAI.ResponseError	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	لا
└─ الهوية	string	معرف فريد لهذه الاستجابة.	لا
└─ incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	لا
└─ السبب	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: max_output_tokens، content_filter	لا
└─ تعليمات	سلسلة أو مجموعة	رسالة نظام (أو مطور) مدرجة في سياق النموذج. عند الاستخدام جنبا إلى جنب مع previous_response_id، التعليمات من السابق لن يتم ترحيل الرد إلى الرد التالي. هذا يجعل الأمر بسيطا لتبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
└─ max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
└─ max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
└─ البيانات الوصفية	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
└─ نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	لا
└─ الإخراج	صفيف	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	لا
└─ output_text	string	خاصية الراحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع output_text العناصر الموجودة في المصفوفة output ، إن وجدت. مدعوم في Python وJavaScript SDKs.	لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
└─ previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
└─ التفكير	OpenAI.المنطق	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ service_tier	OpenAI.ServiceTier	ملاحظة: لا ينطبق service_tier على Azure OpenAI.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
└─ درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا
└─ نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
└─ tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceObject	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: * الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث web أو ملف البحث. معرفة المزيد حول . * استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك. معرفة المزيد حول الاتصال الوظيفي.	لا
└─ top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
└─ top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا
└─ الاقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	string	تعرف على المزيد حول أفضل ممارسات السلامة.	لا
النوع	enum	نوع الحدث. دائمًا response.incomplete. القيم المحتملة: response.incomplete	‏‏نعم‬

OpenAI.ResponseMCPCallArgumentsDeltaEvent

تنبعث عند وجود دلتا (تحديث جزئي) لوسيطات استدعاء أداة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا		التحديث الجزئي للوسيطات الخاصة باستدعاء أداة MCP.	‏‏نعم‬
item_id	string	المعرف الفريد لعنصر استدعاء أداة MCP الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.mcp_call.arguments_delta". القيم المحتملة: response.mcp_call.arguments_delta	‏‏نعم‬

OpenAI.ResponseMCPCallArgumentsDoneEvent

تنبعث عند الانتهاء من الوسيطات الخاصة باستدعاء أداة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الحجج		الوسيطات النهائية لاستدعاء أداة MCP.	‏‏نعم‬
item_id	string	المعرف الفريد لعنصر استدعاء أداة MCP الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.mcp_call.arguments_done". القيم المحتملة: response.mcp_call.arguments_done	‏‏نعم‬

OpenAI.ResponseMCPCallCompletedEvent

يتم إرسالها عند اكتمال استدعاء أداة MCP بنجاح.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الحدث. دائما "response.mcp_call.completed". القيم المحتملة: response.mcp_call.completed	‏‏نعم‬

OpenAI.ResponseMCPCallFailedEvent

تنبعث عند فشل استدعاء أداة MCP.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الحدث. دائما "response.mcp_call.failed". القيم المحتملة: response.mcp_call.failed	‏‏نعم‬

OpenAI.ResponseMCPCallInProgressEvent

تنبعث عندما يكون استدعاء أداة MCP قيد التقدم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد لعنصر استدعاء أداة MCP الذي تتم معالجته.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.mcp_call.in_progress". القيم المحتملة: response.mcp_call.in_progress	‏‏نعم‬

OpenAI.ResponseMCPListToolsCompletedEvent

تنبعث عند استرداد قائمة أدوات MCP المتوفرة بنجاح.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الحدث. دائما "response.mcp_list_tools.completed". القيم المحتملة: response.mcp_list_tools.completed	‏‏نعم‬

OpenAI.ResponseMCPListToolsFailedEvent

تنبعث عند فشل محاولة إدراج أدوات MCP المتاحة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الحدث. دائما "response.mcp_list_tools.failed". القيم المحتملة: response.mcp_list_tools.failed	‏‏نعم‬

OpenAI.ResponseMCPListToolsInProgressEvent

تنبعث عندما يكون النظام بصدد استرداد قائمة أدوات MCP المتاحة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الحدث. دائما "response.mcp_list_tools.in_progress". القيم المحتملة: response.mcp_list_tools.in_progress	‏‏نعم‬

OpenAI.ResponseOutputItemAddedEvent

تنبعث عند إضافة عنصر إخراج جديد.

الاسم	النوع	وصف	مطلوب	الإفتراضي
عنصر	object	عنصر المحتوى المستخدم لإنشاء استجابة.	‏‏نعم‬
└─ created_by	تم إنشاؤه بواسطة	معلومات حول منشئ العنصر	لا
└─ الهوية	string		لا
└─ النوع	OpenAI.ItemType		لا
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافته.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.output_item.added. القيم المحتملة: response.output_item.added	‏‏نعم‬

OpenAI.ResponseOutputItemDoneEvent

ينبعث عند وضع علامة على عنصر الإخراج تم.

الاسم	النوع	وصف	مطلوب	الإفتراضي
عنصر	object	عنصر المحتوى المستخدم لإنشاء استجابة.	‏‏نعم‬
└─ created_by	تم إنشاؤه بواسطة	معلومات حول منشئ العنصر	لا
└─ الهوية	string		لا
└─ النوع	OpenAI.ItemType		لا
output_index	integer	فهرس عنصر الإخراج الذي تم وضع علامة عليه تم.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.output_item.done. القيم المحتملة: response.output_item.done	‏‏نعم‬

OpenAI.ResponsePromptVariables

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

النوع: كائن

OpenAI.ResponseQueuedEvent

تنبعث عند وضع استجابة في قائمة الانتظار وتنتظر المعالجة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استجابه	object		‏‏نعم‬
└─ عامل	معرف العامل	العامل المستخدم لهذه الاستجابة	لا
└─ خلفية	boolean	ما إذا كنت تريد تشغيل استجابة النموذج في الخلفية. تعرف على المزيد حول استجابات الخلفية.	لا	خطأ
└─ محادثة	object		لا
└─ الهوية	string		لا
└─ created_at	integer	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	لا
└─ خطأ	OpenAI.ResponseError	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	لا
└─ الهوية	string	معرف فريد لهذه الاستجابة.	لا
└─ incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	لا
└─ السبب	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: max_output_tokens، content_filter	لا
└─ تعليمات	سلسلة أو مجموعة	رسالة نظام (أو مطور) مدرجة في سياق النموذج. عند الاستخدام جنبا إلى جنب مع previous_response_id، التعليمات من السابق لن يتم ترحيل الرد إلى الرد التالي. هذا يجعل الأمر بسيطا لتبديل رسائل النظام (أو المطور) في استجابات جديدة.	لا
└─ max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية والرموز المميزة reasoning.	لا
└─ max_tool_calls	integer	الحد الأقصى لعدد المكالمات الإجمالية للأدوات المضمنة التي يمكن معالجتها في الاستجابة. ينطبق هذا الحد الأقصى للرقم على جميع استدعاءات الأدوات المضمنة، وليس لكل أداة فردية. سيتم تجاهل أي محاولات أخرى لاستدعاء أداة بواسطة النموذج.	لا
└─ البيانات الوصفية	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
└─ نموذج	string	توزيع النموذج الذي يجب استخدامه لإنشاء هذه الاستجابة.	لا
└─ كائن	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى response. القيم المحتملة: response	لا
└─ الإخراج	صفيف	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول وترتيب العناصر في output المصفوفة على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في المصفوفة output و بافتراض أنها assistant رسالة تحتوي على المحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية output_text حيث مدعومة في مجموعات SDK.	لا
└─ output_text	string	خاصية الراحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع output_text العناصر الموجودة في المصفوفة output ، إن وجدت. مدعوم في Python وJavaScript SDKs.	لا
└─ parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	لا	صحيح
└─ previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا من أجل قم بإنشاء محادثات متعددة الأدوار. معرفة المزيد حول إدارة حالة المحادثة.	لا
└─ موجه	OpenAI.Prompt	الإشارة إلى قالب موجه ومتغيراته. تعرف على المزيد.	لا
└─ التفكير	OpenAI.المنطق	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ service_tier	OpenAI.ServiceTier	ملاحظة: لا ينطبق service_tier على Azure OpenAI.	لا
└─ الحالة	enum	حالة توليد الاستجابة. واحد من completed، failed، in_progressأو cancelledأو queuedأو incomplete. القيم المحتملة: completed، failed، in_progress، cancelled، ، queuedincomplete	لا
└─ structured_inputs	object	المدخلات المنظمة للاستجابة التي يمكن أن تشارك في استبدال قالب المطالبة أو روابط وسيطة الأداة.	لا
└─ درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا
└─ نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن تكون عادية نص أو بيانات JSON منظمة. راجع إدخالات ومخرجات Text ومخرجات Structured	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
└─ tool_choice	OpenAI.ToolChoiceOptions أو OpenAI.ToolChoiceObject	كيف يجب أن يختار النموذج الأداة (أو الأدوات) التي يجب استخدامها عند الإنشاء رد. راجع المعلمة tools لمعرفة كيفية تحديد الأدوات يمكن للنموذج الاتصال.	لا
└─ الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice . فئتا الأدوات التي يمكنك توفير النموذج هما: * الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق قدرات النموذج، مثل البحث web أو ملف البحث. معرفة المزيد حول . * استدعاءات الدالة (الأدوات المخصصة): الدوال التي تحددها أنت ، تمكين النموذج من استدعاء التعليمات البرمجية الخاصة بك. معرفة المزيد حول الاتصال الوظيفي.	لا
└─ top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن.	لا
└─ top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا
└─ الاقتطاع	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - autoإذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج ، سيقوم النموذج باقتطاع لملاءمة نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - disabled (افتراضي): إذا كانت استجابة النموذج ستتجاوز نافذة السياق لنموذج ، سيفشل الطلب مع وجود خطأ 400. القيم المحتملة: auto، disabled	لا
└─ الاستخدام	OpenAI.ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك رموز الإدخال والرموز المميزة للإخراج ، تفصيل الرموز المميزة للإخراج ، وإجمالي الرموز المميزة المستخدمة.	لا
└─ المستخدم	string	تعرف على المزيد حول أفضل ممارسات السلامة.	لا
النوع	enum	نوع الحدث. دائما "response.queued". القيم المحتملة: response.queued	‏‏نعم‬

OpenAI.ResponseReasoningDeltaEvent

تنبعث عندما يكون هناك دلتا (تحديث جزئي) لمحتوى المنطق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء محتوى الاستدلال داخل عنصر الإخراج.	‏‏نعم‬
الدلتا		التحديث الجزئي لمحتوى المنطق.	‏‏نعم‬
item_id	string	المعرف الفريد للعنصر الذي يتم تحديث المنطق من أجله.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.reasoning.delta". القيم المحتملة: response.reasoning.delta	‏‏نعم‬

OpenAI.ResponseReasoningDoneEvent

تنبعث عند الانتهاء من محتوى المنطق لعنصر ما.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء محتوى الاستدلال داخل عنصر الإخراج.	‏‏نعم‬
item_id	string	المعرف الفريد للعنصر الذي تم الانتهاء من التفكير فيه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
نص	string	نص المنطق النهائي.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.reasoning.done". القيم المحتملة: response.reasoning.done	‏‏نعم‬

OpenAI.ResponseReasoningملخصDeltaEvent

تنبعث عندما يكون هناك دلتا (تحديث جزئي) لمحتوى ملخص المنطق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا		التحديث الجزئي لمحتوى ملخص المنطق.	‏‏نعم‬
item_id	string	المعرف الفريد للعنصر الذي يتم تحديث ملخص الاستدلال له.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
summary_index	integer	فهرس جزء الملخص داخل عنصر الإخراج.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.reasoning_summary.delta". القيم المحتملة: response.reasoning_summary.delta	‏‏نعم‬

OpenAI.ResponseReasoningملخصDoneEvent

يتم إرساله عند الانتهاء من محتوى ملخص التفكير لعنصر ما.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	المعرف الفريد للعنصر الذي تم الانتهاء من ملخص التفكير له.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج في مصفوفة إخراج الاستجابة.	‏‏نعم‬
summary_index	integer	فهرس جزء الملخص داخل عنصر الإخراج.	‏‏نعم‬
نص	string	النص النهائي لملخص المنطق.	‏‏نعم‬
النوع	enum	نوع الحدث. دائما "response.reasoning_summary.done". القيم المحتملة: response.reasoning_summary.done	‏‏نعم‬

OpenAI.ResponseReasoningSummaryPartAddedEvent

تنبعث عند إضافة جزء جديد من ملخص التفكير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف العنصر الذي يقترن به جزء الملخص هذا.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يرتبط به جزء الملخص هذا.	‏‏نعم‬
جزء	object		‏‏نعم‬
└─ النوع	OpenAI.ReasoningItemSummmaryPartType		لا
summary_index	integer	فهرس جزء الملخص ضمن ملخص المنطق.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.reasoning_summary_part.added. القيم المحتملة: response.reasoning_summary_part.added	‏‏نعم‬

OpenAI.ResponseReasoningSummaryPartDoneEvent

ينبعث عند اكتمال جزء ملخص التفكير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف العنصر الذي يقترن به جزء الملخص هذا.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يرتبط به جزء الملخص هذا.	‏‏نعم‬
جزء	object		‏‏نعم‬
└─ النوع	OpenAI.ReasoningItemSummmaryPartType		لا
summary_index	integer	فهرس جزء الملخص ضمن ملخص المنطق.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.reasoning_summary_part.done. القيم المحتملة: response.reasoning_summary_part.done	‏‏نعم‬

OpenAI.ResponseReasoningSummaryTextDeltaEvent

تنبعث عند إضافة دلتا إلى نص ملخص التفكير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الدلتا	string	دلتا النص الذي تمت إضافته إلى الملخص.	‏‏نعم‬
item_id	string	معرف العنصر الذي يقترن به دلتا نص الملخص هذا.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي ترتبط به دلتا نص الملخص هذا.	‏‏نعم‬
summary_index	integer	فهرس جزء الملخص ضمن ملخص المنطق.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.reasoning_summary_text.delta. القيم المحتملة: response.reasoning_summary_text.delta	‏‏نعم‬

OpenAI.ResponseReasoningSummaryTextDoneEvent

ينبعث عند اكتمال نص ملخص التفكير.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف العنصر الذي يقترن به نص الملخص هذا.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي يرتبط به نص الملخص هذا.	‏‏نعم‬
summary_index	integer	فهرس جزء الملخص ضمن ملخص المنطق.	‏‏نعم‬
نص	string	النص الكامل لملخص الاستدلال المكتمل.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.reasoning_summary_text.done. القيم المحتملة: response.reasoning_summary_text.done	‏‏نعم‬

OpenAI.ResponseRefusalDeltaEvent

تنبعث عندما يكون هناك نص رفض جزئي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تتم إضافة نص الرفض إليه.	‏‏نعم‬
الدلتا	string	نص الرفض الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة نص الرفض إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة نص الرفض إليه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.refusal.delta. القيم المحتملة: response.refusal.delta	‏‏نعم‬

OpenAI.ResponseRefusalDoneEvent

تنبعث عند الانتهاء من نص الرفض.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تم فيه إنهاء نص الرفض.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تم الانتهاء منه من نص الرفض.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تم الانتهاء من نص الرفض.	‏‏نعم‬
رفض	string	نص الرفض الذي تم الانتهاء منه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.refusal.done. القيم المحتملة: response.refusal.done	‏‏نعم‬

OpenAI.ResponseStreamEvent

المميز ل OpenAI.ResponseStreamEvent

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

قيمة النوع	Schema
response.completed	OpenAI.ResponseCompletedEvent
response.content_part.added	OpenAI.ResponseContentPartAddedEvent
response.content_part.done	OpenAI.ResponseContentPartDoneEvent
response.created	OpenAI.ResponseCreatedEvent
error	OpenAI.ResponseErrorEvent
response.file_search_call.completed	OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress	OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching	OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done	OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress	OpenAI.ResponseInProgressEvent
response.failed	OpenAI.ResponseFailedEvent
response.incomplete	OpenAI.ResponseIncompleteEvent
response.output_item.added	OpenAI.ResponseOutputItemAddedEvent
response.output_item.done	OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta	OpenAI.ResponseRefusalDeltaEvent
response.refusal.done	OpenAI.ResponseRefusalDoneEvent
response.output_text.delta	OpenAI.ResponseTextDeltaEvent
response.output_text.done	OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added	OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done	OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta	OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done	OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed	OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress	OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching	OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed	OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating	OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress	OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image	OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta	OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done	OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed	OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed	OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress	OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed	OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed	OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress	OpenAI.ResponseMCPListToolsInProgressEvent
response.queued	OpenAI.ResponseQueuedEvent
response.reasoning.delta	OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done	OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta	OpenAI.ResponseReasoningملخصDeltaEvent
response.reasoning_summary.done	OpenAI.ResponseReasoningملخصDoneEvent
response.code_interpreter_call_code.delta	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed	OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress	OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

الاسم	النوع	وصف	مطلوب	الإفتراضي
sequence_number	integer	رقم التسلسل لهذا الحدث.	‏‏نعم‬
النوع	OpenAI.ResponseStreamEventType		‏‏نعم‬

OpenAI.ResponseStreamEventType

الخاصية	قيمة
Type	string
Values	response.audio.delta response.audio.done response.audio_transcript.delta response.audio_transcript.done response.code_interpreter_call_code.delta response.code_interpreter_call_code.done response.code_interpreter_call.completed response.code_interpreter_call.in_progress response.code_interpreter_call.interpreting response.completed response.content_part.added response.content_part.done response.created error response.file_search_call.completed response.file_search_call.in_progress response.file_search_call.searching response.function_call_arguments.delta response.function_call_arguments.done response.in_progress response.failed response.incomplete response.output_item.added response.output_item.done response.refusal.delta response.refusal.done response.output_text.annotation.added response.output_text.delta response.output_text.done response.reasoning_summary_part.added response.reasoning_summary_part.done response.reasoning_summary_text.delta response.reasoning_summary_text.done response.web_search_call.completed response.web_search_call.in_progress response.web_search_call.searching response.image_generation_call.completed response.image_generation_call.generating response.image_generation_call.in_progress response.image_generation_call.partial_image response.mcp_call.arguments_delta response.mcp_call.arguments_done response.mcp_call.completed response.mcp_call.failed response.mcp_call.in_progress response.mcp_list_tools.completed response.mcp_list_tools.failed response.mcp_list_tools.in_progress response.queued response.reasoning.delta response.reasoning.done response.reasoning_summary.delta response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

تنبعث عندما يكون هناك دلتا نصية إضافية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
الدلتا	string	دلتا النص الذي تمت إضافته.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة دلتا النص إليه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.output_text.delta. القيم المحتملة: response.output_text.delta	‏‏نعم‬

OpenAI.ResponseTextDoneEvent

تنبعث عند الانتهاء من محتوى النص.

الاسم	النوع	وصف	مطلوب	الإفتراضي
content_index	integer	فهرس جزء المحتوى الذي تم إنهاء محتوى النص فيه.	‏‏نعم‬
item_id	string	معرف عنصر الإخراج الذي تم الانتهاء منه من محتوى النص.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي تم إنهاء محتوى النص به.	‏‏نعم‬
نص	string	محتوى النص الذي تم الانتهاء منه.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.output_text.done. القيم المحتملة: response.output_text.done	‏‏نعم‬

OpenAI.ResponseTextFormatConfiguration

تمييز ل OpenAI.ResponseTextFormatConfiguration

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

قيمة النوع	Schema
text	OpenAI.ResponseTextFormatConfigurationText
json_object	OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema	OpenAI.ResponseTextFormatConfigurationJsonSchema

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ResponseTextFormatConfigurationType	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين { "type": "json_schema" } المخرجات المنظمة ، مما يضمن أن النموذج سوف يتطابق مع مخطط JSON المرفق. تعرف على المزيد في التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: إعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. استخدام json_schema يفضل للنماذج التي تدعمه.	‏‏نعم‬

OpenAI.ResponseTextFormatConfigurationJsonObject

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

OpenAI.ResponseTextFormatConfigurationJsonSchema

تنسيق استجابة مخطط JSON. يستخدم لإنشاء استجابات JSON منظمة. تعرف على المزيد حول مخرجات منظمة.

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

OpenAI.ResponseTextFormatConfigurationText

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: text	‏‏نعم‬

OpenAI.ResponseTextFormatConfigurationType

كائن يحدد التنسيق الذي يجب على النموذج إخراجه.

يتيح التكوين { "type": "json_schema" } المخرجات المنظمة، ما يضمن تطابق النموذج مع مخطط JSON المتوفر. تعرف على المزيد في

التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية.

غير مستحسن لنماذج gpt-4o والأحدث:

الإعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام json_schema للنماذج التي تدعمه.

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

يتيح التكوين { "type": "json_schema" } المخرجات المنظمة، ما يضمن تطابق النموذج مع مخطط JSON المتوفر. تعرف على المزيد في

التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية.

غير مستحسن لنماذج gpt-4o والأحدث:

الإعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام json_schema للنماذج التي تدعمه. | | النوع | سلسلة | | القيم | text
json_schema
json_object |

OpenAI.ResponseUsage

يمثل تفاصيل استخدام الرمز المميز بما في ذلك الرموز المميزة للإدخال والرموز المميزة للإخراج وتفصيل الرموز المميزة للإخراج وإجمالي الرموز المميزة المستخدمة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_tokens	integer	عدد رموز الإدخال.	‏‏نعم‬
input_tokens_details	object	تحليل مفصل للرموز المميزة للإدخال.	‏‏نعم‬
└─ cached_tokens	integer	عدد الرموز المميزة التي تم استردادها من ذاكرة التخزين المؤقت. التخزين المؤقت للمطالبة.	لا
output_tokens	integer	عدد الرموز المميزة للإخراج.	‏‏نعم‬
output_tokens_details	object	تحليل مفصل للرموز المميزة للإخراج.	‏‏نعم‬
└─ reasoning_tokens	integer	عدد الرموز المميزة المنطقية.	لا
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة.	‏‏نعم‬

OpenAI.ResponseWebSearchCallCompletedEvent

ملاحظة: web_search غير متوفر بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف فريد لعنصر الإخراج المرتبط بمكالمة بحث الويب.	‏‏نعم‬
output_index	integer	فهرس عنصر الإخراج الذي ترتبط به استدعاء بحث الويب.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.web_search_call.completed. القيم المحتملة: response.web_search_call.completed	‏‏نعم‬

OpenAI.ResponseWebSearchCallInProgressEvent

ملاحظة: web_search غير متوفر بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
item_id	string	معرف فريد لعنصر الإخراج المرتبط بمكالمة بحث الويب.	‏‏نعم‬
output_index	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	فهرس عنصر الإخراج الذي ترتبط به استدعاء بحث الويب.	‏‏نعم‬
النوع	enum	نوع الحدث. دائمًا response.web_search_call.searching. القيم المحتملة: response.web_search_call.searching	‏‏نعم‬

OpenAI.ResponsesAssistantMessageItemParam

عنصر معلمة رسالة يحتوي على الدور assistant .

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	سلسلة أو مجموعة		‏‏نعم‬
role	enum	دور الرسالة ، وهو دائما assistant. القيم المحتملة: assistant	‏‏نعم‬

OpenAI.ResponsesAssistantMessageItemResource

عنصر مورد رسالة يحتوي على الدور assistant .

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف	المحتوى المرتبط بالرسالة.	‏‏نعم‬
role	enum	دور الرسالة ، وهو دائما assistant. القيم المحتملة: assistant	‏‏نعم‬

OpenAI.ResponsesDeveloperMessageItemParam

عنصر معلمة رسالة يحتوي على الدور developer .

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	سلسلة أو مجموعة		‏‏نعم‬
role	enum	دور الرسالة ، وهو دائما developer. القيم المحتملة: developer	‏‏نعم‬

OpenAI.ResponsesDeveloperMessageItemResource

عنصر مورد رسالة يحتوي على الدور developer .

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف	المحتوى المرتبط بالرسالة.	‏‏نعم‬
role	enum	دور الرسالة ، وهو دائما developer. القيم المحتملة: developer	‏‏نعم‬

OpenAI.ResponsesMessageItemParam

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

المميز ل OpenAI.ResponsesMessageItemParam

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

قيمة النوع	Schema
user	OpenAI.ResponsesUserMessageItemParam
system	OpenAI.ResponsesSystemMessageItemParam
developer	OpenAI.ResponsesDeveloperMessageItemParam
assistant	OpenAI.ResponsesAssistantMessageItemParam

الاسم	النوع	وصف	مطلوب	الإفتراضي
role	object	مجموعة الأدوار الصالحة لعناصر رسالة الاستجابات.	‏‏نعم‬
النوع	enum	نوع عنصر الاستجابات، والذي يكون دائما "رسالة". القيم المحتملة: message	‏‏نعم‬

OpenAI.ResponsesMessageItemResource

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

المميز ل OpenAI.ResponsesMessageItemResource

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

قيمة النوع	Schema
user	OpenAI.ResponsesUserMessageItemResource
system	OpenAI.ResponsesSystemMessageItemResource
developer	OpenAI.ResponsesDeveloperMessageItemResource
assistant	OpenAI.ResponsesAssistantMessageItemResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
role	object	مجموعة الأدوار الصالحة لعناصر رسالة الاستجابات.	‏‏نعم‬
الحالة	enum	حالة العنصر. واحد من in_progressأو completedأو incomplete. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: in_progress، ، completedincomplete	‏‏نعم‬
النوع	enum	نوع عنصر الاستجابات، والذي يكون دائما "رسالة". القيم المحتملة: message	‏‏نعم‬

OpenAI.ResponsesMessageRole

مجموعة الأدوار الصالحة لعناصر رسالة الاستجابات.

الخاصية	قيمة
الوصف	مجموعة الأدوار الصالحة لعناصر رسالة الاستجابات.
Type	string
Values	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

عنصر معلمة رسالة يحتوي على الدور system .

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	سلسلة أو مجموعة		‏‏نعم‬
role	enum	دور الرسالة ، وهو دائما system. القيم المحتملة: system	‏‏نعم‬

OpenAI.ResponsesSystemMessageItemResource

عنصر مورد رسالة يحتوي على الدور system .

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف	المحتوى المرتبط بالرسالة.	‏‏نعم‬
role	enum	دور الرسالة ، وهو دائما system. القيم المحتملة: system	‏‏نعم‬

OpenAI.ResponsesUserMessageItemParam

عنصر معلمة رسالة يحتوي على الدور user .

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	سلسلة أو مجموعة		‏‏نعم‬
role	enum	دور الرسالة ، وهو دائما user. القيم المحتملة: user	‏‏نعم‬

OpenAI.ResponsesUserMessageItemResource

عنصر مورد رسالة يحتوي على الدور user .

الاسم	النوع	وصف	مطلوب	الإفتراضي
محتوى	صفيف	المحتوى المرتبط بالرسالة.	‏‏نعم‬
role	enum	دور الرسالة ، وهو دائما user. القيم المحتملة: user	‏‏نعم‬

OpenAI.ServiceTier

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

• إذا تم تعيينه إلى "تلقائي"، فستتم معالجة الطلب مع طبقة الخدمة المكونة في إعدادات Project. ما لم يتم تكوين خلاف ذلك، سيستخدم Project "افتراضي".
• إذا تم تعيينه إلى "افتراضي"، فستتم معالجة الطلب مع التسعير والأداء القياسيين للنموذج المحدد.
• إذا تم تعيينه إلى "flex" أو "الأولوية"، فستتم معالجة الطلب مع مستوى الخدمة المقابل. اتصل بالمبيعات لمعرفة المزيد حول معالجة الأولوية.
• عند عدم التعيين، يكون السلوك الافتراضي هو "تلقائي".

عند تعيين المعلمة service_tier ، سيتضمن نص الاستجابة service_tier القيمة استنادا إلى وضع المعالجة المستخدم فعليا لخدمة الطلب. قد تختلف قيمة الاستجابة هذه عن القيمة التي تم تعيينها في المعلمة .

الخاصية	قيمة
الوصف	يحدد نوع المعالجة المستخدم لخدمة الطلب. * إذا تم تعيينه إلى "تلقائي"، فستتم معالجة الطلب مع مستوى الخدمة تم تكوينه في إعدادات Project. ما لم يتم تكوين خلاف ذلك، سيستخدم Project "افتراضي". * إذا تم تعيينه إلى "افتراضي"، فستتم معالجة الطلب مع المعيار التسعير والأداء للنموذج المحدد. * إذا تم تعيينه إلى "flex" أو "الأولوية"، ثم ستتم معالجة الطلب مع الخدمة المقابلة المستوي. اتصل بالمبيعات لمعرفة المزيد حول معالجة الأولوية. * عند عدم التعيين، يكون السلوك الافتراضي هو "تلقائي". عند تعيين المعلمة service_tier ، سيتضمن نص الاستجابة service_tier استنادا إلى وضع المعالجة المستخدم فعليا لخدمة الطلب. قيمة الاستجابة هذه قد تختلف عن القيمة التي تم تعيينها في المعلمة .
Type	string
Values	auto default flex scale priority

OpenAI.TextResponseFormatConfiguration

كائن يحدد التنسيق الذي يجب على النموذج إخراجه.

يتيح التكوين { "type": "json_schema" } المخرجات المنظمة، ما يضمن تطابق النموذج مع مخطط JSON المتوفر. تعرف على المزيد في

التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية.

غير مستحسن لنماذج gpt-4o والأحدث:*

الإعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام json_schema للنماذج التي تدعمه.

تمييز ل OpenAI.TextResponseFormatConfiguration

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

قيمة النوع	Schema

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

OpenAI.Tool

تمييزي ل OpenAI.Tool

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

قيمة النوع	Schema
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search_preview	OpenAI.WebSearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellTool
mcp	OpenAI.MCPTool
bing_grounding	BingGroundingAgentTool
fabric_dataagent_preview	MicrosoftFabricAgentTool
sharepoint_grounding_preview	SharepointAgentTool
azure_ai_search	AzureAISearchAgentTool
openapi	OpenApiAgentTool
bing_custom_search_preview	BingCustomSearchAgentTool
browser_automation_preview	BrowserAutomationAgentTool
azure_function	AzureFunctionAgentTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2ATool
memory_search	MemorySearchTool

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ToolType	أداة يمكن استخدامها لإنشاء استجابة.	‏‏نعم‬

OpenAI.ToolChoiceObject

المميز ل OpenAI.ToolChoiceObject

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

قيمة النوع	Schema
file_search	OpenAI.ToolChoiceObjectFileSearch
computer_use_preview	OpenAI.ToolChoiceObjectComputer
web_search_preview	OpenAI.ToolChoiceObjectWebSearch
image_generation	OpenAI.ToolChoiceObjectImageGen
code_interpreter	OpenAI.ToolChoiceObjectCodeInterpreter
function	OpenAI.ToolChoiceObjectFunction
mcp	OpenAI.ToolChoiceObjectMCP

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	OpenAI.ToolChoiceObjectType	يشير إلى أن النموذج يجب أن يستخدم أداة مضمنة لإنشاء استجابة. تعرف على المزيد حول الأدوات المضمنة.	‏‏نعم‬

OpenAI.ToolChoiceObjectCodeInterpreter

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: code_interpreter	‏‏نعم‬

OpenAI.ToolChoiceObjectComputer

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: computer_use_preview	‏‏نعم‬

OpenAI.ToolChoiceObjectFileSearch

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: file_search	‏‏نعم‬

OpenAI.ToolChoiceObjectFunction

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

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

OpenAI.ToolChoiceObjectImageGen

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: image_generation	‏‏نعم‬

OpenAI.ToolChoiceObjectMCP

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
الاسم	string	اسم الأداة المراد استدعاؤها على الخادم.	لا
server_label	string	تسمية خادم MCP المراد استخدامه.	‏‏نعم‬
النوع	enum	بالنسبة لأدوات MCP ، يكون النوع دائما mcp. القيم المحتملة: mcp	‏‏نعم‬

OpenAI.ToolChoiceObjectType

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

الخاصية	قيمة
الوصف	يشير إلى أن النموذج يجب أن يستخدم أداة مضمنة لإنشاء استجابة.
تعرف على المزيد حول الأدوات المضمنة.
Type	string
Values	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

ملاحظة: web_search غير متوفر بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: web_search_preview	‏‏نعم‬

OpenAI.ToolChoiceOptions

يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج.

none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة.

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

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

الخاصية	قيمة
الوصف	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. auto يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء رسالة أو المزيد من الأدوات. required يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر.
Type	string
Values	none auto required

OpenAI.ToolType

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

الخاصية	قيمة
الوصف	أداة يمكن استخدامها لإنشاء استجابة.
Type	string
Values	file_search function computer_use_preview web_search_preview mcp code_interpreter image_generation local_shell bing_grounding browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview azure_ai_search openapi bing_custom_search_preview capture_structured_outputs a2a_preview azure_function memory_search

OpenAI.TopLogProb

أعلى احتمال سجل للرمز المميز.

الاسم	النوع	وصف	مطلوب	الإفتراضي
بايت	صفيف		‏‏نعم‬
لوغاربوب	رقم		‏‏نعم‬
الرمز المميز	string		‏‏نعم‬

OpenAI.UpdateConversationRequest

تحديث محادثة

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

OpenAI.VectorStoreFileAttributes

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

النوع: كائن

OpenAI.WebSearchAction

المميز ل OpenAI.WebSearchAction

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

قيمة النوع	Schema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearch

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

OpenAI.WebSearchActionFind

نوع الإجراء "بحث": يبحث عن نمط داخل صفحة محملة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
pattern	string	النمط أو النص المطلوب البحث عنه داخل الصفحة.	‏‏نعم‬
النوع	enum	نوع الإجراء. القيم المحتملة: find	‏‏نعم‬
عنوان URL	string	عنوان URL للصفحة التي تم البحث عنها عن النمط.	‏‏نعم‬

OpenAI.WebSearchActionOpenPage

نوع الإجراء "open_page" - يفتح عنوان URL محددا من نتائج البحث.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الإجراء. القيم المحتملة: open_page	‏‏نعم‬
عنوان URL	string	عنوان URL الذي فتحه النموذج.	‏‏نعم‬

OpenAI.WebSearchActionSearch

نوع الإجراء "بحث" - لإجراء استعلام بحث على الويب.

الاسم	النوع	وصف	مطلوب	الإفتراضي
استعلام	string	استعلام البحث.	‏‏نعم‬
المصادر	صفيف	المصادر المستخدمة في البحث.	لا
النوع	enum	نوع الإجراء. القيم المحتملة: search	‏‏نعم‬

OpenAI.WebSearchActionSearchSources

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: url	‏‏نعم‬
عنوان URL	string		‏‏نعم‬

OpenAI.WebSearchActionType

الخاصية	قيمة
Type	string
Values	search open_page find

OpenAI.WebSearchPreviewTool

ملاحظة: web_search غير متوفر بعد عبر Azure OpenAI.

الاسم	النوع	وصف	مطلوب	الإفتراضي
search_context_size	enum	إرشادات عالية المستوى لمقدار مساحة نافذة السياق لاستخدامها في البحث. واحد من lowأو mediumأو high. medium هو الافتراضي. القيم المحتملة: low، ، mediumhigh	لا
النوع	enum	نوع أداة البحث على الويب. أحد web_search_preview أو web_search_preview_2025_03_11. القيم المحتملة: web_search_preview	‏‏نعم‬
user_location	object		لا
└─ النوع	OpenAI.LocationType		لا

OpenAI.WebSearchToolCallItemParam

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	object		‏‏نعم‬
└─ النوع	OpenAI.WebSearchActionType		لا
النوع	enum	القيم المحتملة: web_search_call	‏‏نعم‬

OpenAI.WebSearchToolCallItemResource

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

الاسم	النوع	وصف	مطلوب	الإفتراضي
إجراء	object		‏‏نعم‬
└─ النوع	OpenAI.WebSearchActionType		لا
الحالة	enum	حالة استدعاء أداة البحث على الويب. القيم المحتملة: in_progress، searching، ، completedfailed	‏‏نعم‬
النوع	enum	القيم المحتملة: web_search_call	‏‏نعم‬

OpenAI.integer

النوع: عدد صحيح

التنسيق: int64

OpenAI.numeric

النوع: رقم

التنسيق: مزدوج

OpenApiAgentTool

معلومات تعريف الإدخال لأداة OpenAPI كما هو مستخدم لتكوين عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
openapi	object	معلومات تعريف الإدخال لدالة openapi.	‏‏نعم‬
└─ auth	OpenApiAuthDetails	فتح تفاصيل مصادقة واجهة برمجة التطبيقات	لا
└─ default_params	صفيف	قائمة معلمات مواصفات OpenAPI التي ستستخدم الإعدادات الافتراضية التي يوفرها المستخدم	لا
└─ الوصف	string	وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة.	لا
└─ الوظائف	صفيف	قائمة تعريفات الوظائف التي تستخدمها أداة OpenApi	لا
└─ الاسم	string	اسم الدالة التي سيتم استدعاؤها.	لا
└─ المواصفات		شكل الدالة openapi، الموصوف كعنصر مخطط JSON.	لا
النوع	enum	نوع الكائن ، والذي يكون دائما "openapi". القيم المحتملة: openapi	‏‏نعم‬

OpenApiAnonymousAuthDetails

تفاصيل الأمان لمصادقة OpenApi المجهولة

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع الكائن، وهو دائما "مجهول". القيم المحتملة: anonymous	‏‏نعم‬

OpenApiAuthDetails

تفاصيل المصادقة ل OpenApiFunctionDefinition

تمييز ل OpenApiAuthDetails

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

قيمة النوع	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	نوع المصادقة لنقطة نهاية OpenApi. الأنواع المسموح بها هي: - مجهول (لا توجد مصادقة مطلوبة) - اتصال Project (يتطلب project_connection_id إلى نقطة النهاية، كإعداد في Foundry) - Managed_Identity (يتطلب جمهورا للمصادقة المستندة إلى الهوية)	‏‏نعم‬

OpenApiAuthType

نوع المصادقة لنقطة نهاية OpenApi. الأنواع المسموح بها هي:

• مجهول (لا يلزم المصادقة)
• Project Connection (يتطلب project_connection_id إلى نقطة النهاية، كإعداد في Foundry)
• Managed_Identity (يتطلب جمهورا للمصادقة المستندة إلى الهوية)

الخاصية	قيمة
Type	string
Values	anonymous project_connection managed_identity

OpenApiFunctionDefinition

معلومات تعريف الإدخال لدالة openapi.

الاسم	النوع	وصف	مطلوب	الإفتراضي
auth	object	تفاصيل المصادقة ل OpenApiFunctionDefinition	‏‏نعم‬
└─ النوع	OpenApiAuthType	يجب أن يكون نوع المصادقة مجهولا/project_connection/managed_identity	لا
default_params	صفيف	قائمة معلمات مواصفات OpenAPI التي ستستخدم الإعدادات الافتراضية التي يوفرها المستخدم	لا
الوصف	string	وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة.	لا
functions	صفيف	قائمة تعريفات الوظائف التي تستخدمها أداة OpenApi	لا
الاسم	string	اسم الدالة التي سيتم استدعاؤها.	‏‏نعم‬
المواصفات		شكل الدالة openapi، الموصوف كعنصر مخطط JSON.	‏‏نعم‬

OpenApiManagedAuthDetails

تفاصيل الأمان لمصادقة OpenApi managed_identity

الاسم	النوع	وصف	مطلوب	الإفتراضي
security_scheme	object	مخطط الأمان لمصادقة OpenApi managed_identity	‏‏نعم‬
└─ الجمهور	string	نطاق المصادقة لنوع المصادقة managed_identity	لا
النوع	enum	نوع الكائن، وهو دائما "managed_identity". القيم المحتملة: managed_identity	‏‏نعم‬

OpenApiManagedSecurityScheme

مخطط الأمان لمصادقة OpenApi managed_identity

الاسم	النوع	وصف	مطلوب	الإفتراضي
audience	string	نطاق المصادقة لنوع المصادقة managed_identity	‏‏نعم‬

OpenApiProjectConnectionAuthDetails

تفاصيل الأمان لمصادقة اتصال OpenApi project

الاسم	النوع	وصف	مطلوب	الإفتراضي
security_scheme	object	مخطط الأمان لمصادقة OpenApi managed_identity	‏‏نعم‬
└─ project_connection_id	string	معرف اتصال Project لنوع مصادقة Project Connection	لا
النوع	enum	نوع الكائن ، والذي يكون دائما "project_connection". القيم المحتملة: project_connection	‏‏نعم‬

OpenApiProjectConnectionSecurityScheme

مخطط الأمان لمصادقة OpenApi managed_identity

الاسم	النوع	وصف	مطلوب	الإفتراضي
project_connection_id	string	معرف اتصال Project لنوع مصادقة Project Connection	‏‏نعم‬

PagedConnection

مجموعة صفحات من عناصر الاتصال

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر الاتصال في هذه الصفحة	‏‏نعم‬

PagedDatasetVersion

مجموعة صفحات من عناصر DatasetVersion

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر DatasetVersion في هذه الصفحة	‏‏نعم‬

PagedDeployment

مجموعة صفحات من عناصر النشر

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر النشر في هذه الصفحة	‏‏نعم‬

PagedEvaluationRule

مجموعة صفحات من عناصر EvaluationRule

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر EvaluationRule في هذه الصفحة	‏‏نعم‬

PagedEvaluationTaxonomy

مجموعة صفحات من عناصر EvaluationTaxonomy

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر EvaluationTaxonomy في هذه الصفحة	‏‏نعم‬

PagedEvaluatorVersion

مجموعة صفحات من عناصر المقيمVersion

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر التقييم في هذه الصفحة	‏‏نعم‬

PagedIndex

مجموعة صفحات من عناصر الفهرس

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر الفهرس في هذه الصفحة	‏‏نعم‬

PagedInsight

مجموعة صفحات من عناصر Insight

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر Insight في هذه الصفحة	‏‏نعم‬

PagedRedTeam

مجموعة صفحات من عناصر RedTeam

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر RedTeam في هذه الصفحة	‏‏نعم‬

جدول الصفحات

مجموعة صفحات من عناصر الجدولة

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	جدولة العناصر في هذه الصفحة	‏‏نعم‬

PagedScheduleRun

مجموعة من عناصر ScheduleRun التي تم ترحيمي صفحتها

الاسم	النوع	وصف	مطلوب	الإفتراضي
NextLink	string	الرابط إلى الصفحة التالية من العناصر	لا
القيمة	صفيف	عناصر ScheduleRun في هذه الصفحة	‏‏نعم‬

PendingUploadRequest

يمثل طلبا لتحميل معلق.

الاسم	النوع	وصف	مطلوب	الإفتراضي
اسم الاتصال	string	اسم اتصال حساب Azure Storage لاستخدامه لإنشاء رمز SAS المميز المؤقت	لا
pendingUploadId	string	إذا لم يتم توفير PendingUploadId، استخدام GUID عشوائي.	لا
pendingUploadType	enum	BlobReference هو النوع الوحيد المدعوم. القيم المحتملة: BlobReference	‏‏نعم‬

PendingUploadResponse

يمثل الاستجابة لطلب تحميل معلق

الاسم	النوع	وصف	مطلوب	الإفتراضي
مرجع الكائن الثنائي كبير الحجم	object	تفاصيل مرجع كائن ثنائي كبير الحجم.	‏‏نعم‬
└─ blobUri	string	مسار Blob URI للعميل لتحميل البيانات. مثال: https://blob.windows.core.net/Container/Path	لا
└─ بيانات الاعتماد	SasCredential	معلومات بيانات الاعتماد access حساب storage.	لا
└─ storageAccountArmId	string	معرف ARM لحساب storage المراد استخدامه.	لا
pendingUploadId	string	معرف طلب التحميل هذا.	‏‏نعم‬
pendingUploadType	enum	BlobReference هو النوع الوحيد المدعوم القيم المحتملة: BlobReference	‏‏نعم‬
إصدار	string	إصدار الأصل الذي سيتم إنشاؤه إذا لم يحدد المستخدم إصدارا عند إنشاء التحميل في البداية	لا

تعريف PromptAgentDefinition

تعريف عامل المطالبة

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعليمات	string	رسالة نظام (أو مطور) مدرجة في سياق النموذج.	لا
النوع	enum	القيم المحتملة: prompt	‏‏نعم‬
نموذج	string	نشر النموذج لاستخدامه لهذا العامل.	‏‏نعم‬
المنطق	object	نماذج السلسلة o فقط خيارات التكوين لنماذج المنطق.	لا
└─ الجهد	OpenAI.ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي لا شيء، الحد الأدنى، منخفض، متوسط، وعالي. يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. يتم تعيين gpt-5.1 افتراضيا إلى none، والذي لا يؤدي المنطق. قيم المنطق المدعومة ل gpt-5.1 هي لا شيء، منخفضة، متوسطة، وعالية. يتم دعم استدعاءات الأداة لجميع قيم المنطق في gpt-5.1. جميع النماذج قبل gpt-5.1 الافتراضي إلى جهد المنطق المتوسط، ولا تدعم أي منها. نموذج gpt-5-pro افتراضيا إلى (ويدعم فقط) جهد المنطق العالي.	لا
└─ generate_summary	enum	مهمل: استخدم summary بدلا من ذلك. ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيدا لتصحيح أخطاء عملية التفكير في النموذج وفهمها. واحد من autoأو conciseأو detailed. القيم المحتملة: auto، ، concisedetailed	لا
└─ ملخص	enum	ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيد لتصحيح الأخطاء وفهم عملية التفكير في النموذج. واحد من autoأو conciseأو detailed. القيم المحتملة: auto، ، concisedetailed	لا
structured_inputs	object	مجموعة من المدخلات المنظمة التي يمكن أن تشارك في الاستبدال الفوري للقالب أو روابط وسيطة الأداة.	لا
درجة الحرارة	رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.	لا	1
نص	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة.	لا
└─ التنسيق	OpenAI.ResponseTextFormatConfiguration		لا
الأدوات	صفيف	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. أنت يمكن تحديد الأداة التي تريد استخدامها عن طريق تعيين المعلمة tool_choice .	لا
top_p	رقم	بديل لأخذ العينات بدرجة الحرارة ، يسمى أخذ عينات النواة ، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة باحتمال top_p قداس. لذا فإن 0.1 تعني فقط الرموز المميزة التي تشتمل على أعلى 10% كتلة احتمالية يعتبر. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.	لا	1

PromptBasedEvaluatorDefinition

المقيم المستند إلى السرعة

الاسم	النوع	وصف	مطلوب	الإفتراضي
prompt_text	string	النص الفوري المستخدم للتقييم	‏‏نعم‬
النوع	enum	القيم المحتملة: prompt	‏‏نعم‬

ProtocolVersionRecord

تعيين سجل لبروتوكول واحد وإصداره.

الاسم	النوع	وصف	مطلوب	الإفتراضي
البروتوكول	object		‏‏نعم‬
إصدار	string	سلسلة الإصدار للبروتوكول ، على سبيل المثال "v0.1.1".	‏‏نعم‬

RaiConfig

تكوين فلترة محتوى الذكاء الاصطناعي المسؤول (RAI) وميزات الأمان.

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

RecurrenceSchedule

نموذج جدول التكرار.

تمييزي على جدول التكرار

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

قيمة النوع	Schema
Hourly	جدول التكرار كل ساعة
Daily	جدول يوميا للتكتم
Weekly	جدول التكرار الأسبوعي
Monthly	جدول التكرار الشهري

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

RecurrenceTrigger

المشغل القائم على التكرار.

الاسم	النوع	وصف	مطلوب	الإفتراضي
endTime	string	وقت انتهاء جدول التكرار بتنسيق ISO 8601.	لا
interval	integer	الفاصل الزمني لجدول التكرار.	‏‏نعم‬
schedule	object	نموذج جدول التكرار.	‏‏نعم‬
└─ النوع	نوع التكرار	نوع التكرار لجدول التكرار.	لا
وقت البدء	string	وقت بدء جدول التكرار بتنسيق ISO 8601.	لا
timeZone	string	المنطقة الزمنية لجدول التكرار.	لا	التوقيت العالمي المتفق عليه
النوع	enum	نوع الزناد. القيم المحتملة: Recurrence	‏‏نعم‬

نوع التكرار

نوع التكرار.

الخاصية	قيمة
الوصف	نوع التكرار.
Type	string
Values	Hourly Daily Weekly Monthly

RedTeam

تفاصيل الفريق الأحمر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
applicationScenario	string	سيناريو التطبيق لعملية الفريق الأحمر، لإنشاء هجمات محددة للسيناريو.	لا
حالات الهجوم	صفيف	قائمة استراتيجيات الهجوم أو القوائم المتداخلة لاستراتيجيات الهجوم.	لا
displayName	string	اسم تشغيل الفريق الأحمر.	لا
المعرف	string	معرف تشغيل الفريق الأحمر.	‏‏نعم‬
numTurns	integer	عدد جولات المحاكاة.	لا
خصائص	object	خصائص الفريق الأحمر. على عكس العلامات، تكون الخصائص مضافة فقط. بمجرد إضافته، لا يمكن إزالة الخاصية.	لا
فئات المخاطر	صفيف	قائمة بفئات المخاطر التي يجب إنشاء أهداف الهجوم لها.	لا
المحاكاة فقط	boolean	المحاكاة فقط أو المحاكاة + التقييم. خطأ افتراضي، إذا كان صحيحا، فإن المسح الضوئي يؤدي إلى إخراج المحادثة وليس نتيجة التقييم.	لا	خطأ
الحالة	string	حالة الفريق الأحمر. يتم تعيينه حسب الخدمة وهو للقراءة فقط.	لا
العلامات	object	علامات الفريق الأحمر. على عكس الخصائص ، تكون العلامات قابلة للتغيير بالكامل.	لا
target	object	فئة مجردة للتكوين المستهدف.	‏‏نعم‬
└─ النوع	string	نوع تكوين النموذج.	لا

RedTeamItemGenerationParams

يمثل معلمات إنشاء عنصر الفريق الأحمر.

الاسم	النوع	وصف	مطلوب	الإفتراضي
attack_strategies	صفيف	مجموعة استراتيجيات الهجوم التي سيتم استخدامها.	‏‏نعم‬
num_turns	integer	عدد الأدوار المسموح بها في اللعبة.	‏‏نعم‬
النوع	enum	نوع معلمات إنشاء العنصر، دائما red_team. القيم المحتملة: red_team	‏‏نعم‬

فئة المخاطرة

فئة المخاطر لهدف الهجوم.

الخاصية	قيمة
الوصف	فئة المخاطر لهدف الهجوم.
Type	string
Values	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

تعريف بيانات اعتماد توقيع Access المشترك (SAS)

الاسم	النوع	وصف	مطلوب	الإفتراضي
ساس	string	رمز SAS المميز	لا
النوع	enum	نوع بيانات الاعتماد القيم المحتملة: SAS	‏‏نعم‬

نموذج النموذج

نوع العينة المستخدمة في التحليل.

الخاصية	قيمة
Type	string
Values	EvaluationResultSample

ساس الشهادة

تعريف بيانات اعتماد SAS

الاسم	النوع	وصف	مطلوب	الإفتراضي
sasUri	string	SAS uri	‏‏نعم‬
النوع	enum	نوع بيانات الاعتماد القيم المحتملة: SAS	‏‏نعم‬

Schedule

نموذج الجدولة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف الجدول.	لا
displayName	string	اسم الجدول الزمني.	لا
مُمكَّن	boolean	حالة تمكين الجدول الزمني.	‏‏نعم‬
المعرف	string	معرف الجدول الزمني.	‏‏نعم‬
خصائص	object	خصائص الجدولة. على عكس العلامات، تكون الخصائص مضافة فقط. بمجرد إضافته، لا يمكن إزالة الخاصية.	لا
حالة التزويد	object	جدولة حالة التوفير.	لا
بيانات النظام	object	بيانات تعريف النظام للمورد.	‏‏نعم‬
العلامات	object	علامات الجدول. على عكس الخصائص ، تكون العلامات قابلة للتغيير بالكامل.	لا
مهمة	object	جدولة نموذج المهمة.	‏‏نعم‬
└─ التكوين	object	تكوين المهمة.	لا
└─ النوع	نوع جدولة المهام	نوع المهمة.	لا
trigger	object	النموذج الأساسي لمشغل الجدول.	‏‏نعم‬
└─ النوع	نوع الزناد	نوع الزناد.	لا

ScheduleProvisioningStatus

جدولة حالة التوفير.

الخاصية	قيمة
الوصف	جدولة حالة التوفير.
Type	string
Values	Creating Updating Deleting Succeeded Failed

جدولة تشغيل

جدولة نموذج التشغيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
خطأ	string	معلومات الخطأ لتشغيل الجدولة.	لا
المعرف	string	معرف تشغيل الجدول الزمني.	‏‏نعم‬
خصائص	object	خصائص تشغيل الجدول.	‏‏نعم‬
معرف الجدولة	string	معرف الجدول الزمني.	‏‏نعم‬
نجاح	boolean	تشغيل حالة نجاح تشغيل الجدول الزمني.	‏‏نعم‬
وقت التشغيل	string	وقت تشغيل تشغيل الجدولة.	لا

جدولة المهام

جدولة نموذج المهمة.

تمييزي ل ScheduleTask

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

قيمة النوع	Schema
Evaluation	مهام جدول التقييم
Insight	InsightScheduleTask

الاسم	النوع	وصف	مطلوب	الإفتراضي
configuration	object	تكوين المهمة.	لا
النوع	object	نوع المهمة.	‏‏نعم‬

نوع جدولة المهام

نوع المهمة.

الخاصية	قيمة
الوصف	نوع المهمة.
Type	string
Values	Evaluation Insight

SeedPromptsRedTeamItemGenerationParams

يمثل معلمات إنشاء عنصر الفريق الأحمر مع مطالبات أولية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
attack_strategies	صفيف	مجموعة استراتيجيات الهجوم التي سيتم استخدامها.	‏‏نعم‬
num_turns	integer	عدد الأدوار المسموح بها في اللعبة.	‏‏نعم‬
المصدر	object		‏‏نعم‬
└─ المحتوى	صفيف	محتوى ملف jsonl.	لا
└─ الهوية	string	معرف الملف.	لا
└─ النوع	enum	نوع مصدر jsonl. دائمًا file_id. القيم المحتملة: file_id	لا
النوع	enum	نوع معلمات إنشاء العنصر، دائما red_team. القيم المحتملة: red_team_seed_prompts	‏‏نعم‬

SharepointAgentTool

معلومات تعريف الإدخال لأداة sharepoint كما هو مستخدم لتكوين عامل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
sharepoint_grounding_preview	object	معلمات أداة تأريض sharepoint.	‏‏نعم‬
└─ project_connections	صفيف	project الاتصالات المرفقة بهذه الأداة. يمكن أن يكون هناك اتصال 1 كحد أقصى المورد المرفق بالأداة.	لا
النوع	enum	نوع الكائن، وهو دائما "sharepoint_grounding". القيم المحتملة: sharepoint_grounding_preview	‏‏نعم‬

SharepointGroundingToolParameters

معلمات أداة تأريض sharepoint.

الاسم	النوع	وصف	مطلوب	الإفتراضي
project_connections	صفيف	project الاتصالات المرفقة بهذه الأداة. يمكن أن يكون هناك اتصال 1 كحد أقصى المورد المرفق بالأداة.	لا

سكو

معلومات Sku

الاسم	النوع	وصف	مطلوب	الإفتراضي
capacity	integer	سعة Sku	‏‏نعم‬
family	string	عائلة SKU	‏‏نعم‬
الاسم	string	اسم Sku	‏‏نعم‬
size	string	حجم رمز المنتج:	‏‏نعم‬
المستوي	string	مستوى Sku	‏‏نعم‬

تعريف منظمInputDefinition

إدخال منظم يمكنه المشاركة في عمليات استبدال القوالب السريعة وربط وسيطة الأداة.

الاسم	النوع	وصف	مطلوب	الإفتراضي
default_value		القيمة الافتراضية للإدخال إذا لم يتم توفير قيمة وقت التشغيل.	لا
الوصف	string	وصف يمكن للبشري قراءته للإدخال.	لا
required	boolean	ما إذا كانت خاصية الإدخال مطلوبة عند استدعاء العامل.	لا	خطأ
Schema		مخطط JSON للإدخال المنظم (اختياري).	لا

تعريف منظمOutputDefinition

إخراج منظم يمكن أن ينتجه العامل.

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

StructuredOutputsItemResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
الناتج		الإخراج المنظم الذي تم التقاطه أثناء الاستجابة.	‏‏نعم‬
النوع	enum	القيم المحتملة: structured_outputs	‏‏نعم‬

استهداف

الفئة الأساسية للأهداف ذات دعم المميز.

تمييزي للهدف

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

قيمة النوع	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget
azure_ai_assistant	AzureAIAssistantTarget

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

الإكمالات الهدف

يمثل مصدر بيانات لتكوين تقييم الإكمال المستند إلى الهدف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
input_messages	object		لا
└─ item_reference	string		لا
└─ النوع	enum	القيم المحتملة: item_reference	لا
المصدر	object		‏‏نعم‬
└─ المحتوى	صفيف	محتوى ملف jsonl.	لا
└─ الهوية	string	معرف الملف.	لا
└─ النوع	enum	نوع مصدر jsonl. دائمًا file_id. القيم المحتملة: file_id	لا
target	object	الفئة الأساسية للأهداف ذات دعم المميز.	‏‏نعم‬
└─ النوع	string	نوع الهدف.	لا
النوع	enum	نوع مصدر البيانات، دائما TargetCompletions. القيم المحتملة: azure_ai_target_completions	‏‏نعم‬

تكوين الهدف

فئة مجردة للتكوين المستهدف.

تمييزي ل TargetConfig

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

قيمة النوع	Schema
AzureOpenAIModel	تكوين AzureOpenAIModel

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

TargetUpdate

الفئة الأساسية للأهداف ذات دعم المميز.

تمييزي ل TargetUpdate

يستخدم هذا المكون الخاصية type للتمييز بين أنواع مختلفة:

قيمة النوع	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_assistant	AzureAIAssistantTargetUpdate

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	string	نوع الهدف.	‏‏نعم‬

فئة التصنيف

تعريف فئة التصنيف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف فئة التصنيف.	لا
المعرف	string	المعرف الفريد لفئة التصنيف.	‏‏نعم‬
الاسم	string	اسم فئة التصنيف.	‏‏نعم‬
خصائص	object	خصائص إضافية لفئة التصنيف.	لا
فئة المخاطر	object	فئة المخاطر لهدف الهجوم.	‏‏نعم‬
الفئات الفرعيه	صفيف	قائمة الفئات الفرعية للتصنيف.	‏‏نعم‬

تصنيفRedTeamItemGenerationParams

يمثل معلمات إنشاء عنصر الفريق الأحمر مع مطالبات أولية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
attack_strategies	صفيف	مجموعة استراتيجيات الهجوم التي سيتم استخدامها.	‏‏نعم‬
num_turns	integer	عدد الأدوار المسموح بها في اللعبة.	‏‏نعم‬
المصدر	object		‏‏نعم‬
└─ المحتوى	صفيف	محتوى ملف jsonl.	لا
└─ الهوية	string	معرف الملف.	لا
└─ النوع	enum	نوع مصدر jsonl. دائمًا file_id. القيم المحتملة: file_id	لا
النوع	enum	نوع معلمات إنشاء العنصر، دائما red_team. القيم المحتملة: red_team_taxonomy	‏‏نعم‬

التصنيفSubCategory

تعريف التصنيف الفرعي للتصنيف.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف الفئة الفرعية للتصنيف.	لا
مُمكَّن	boolean	قائمة بعناصر التصنيف ضمن هذه الفئة الفرعية.	‏‏نعم‬
المعرف	string	المعرف الفريد للفئة الفرعية للتصنيف.	‏‏نعم‬
الاسم	string	اسم الفئة الفرعية للتصنيف.	‏‏نعم‬
خصائص	object	خصائص إضافية للفئة الفرعية للتصنيف.	لا

وصف الأدوات

وصف الأداة التي يمكن استخدامها من قبل وكيل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف موجز للغرض من الأداة.	لا
الاسم	string	اسم الأداة.	لا

ToolProjectConnection

مورد اتصال project.

الاسم	النوع	وصف	مطلوب	الإفتراضي
project_connection_id	string	اتصال project في ToolProjectConnectionList مرفق بهذه الأداة.	‏‏نعم‬

TracesEvalRunDataSource

يمثل مصدر بيانات لإجراءات التقييم التي تعمل عبر تتبعات العامل المخزنة في Application Insights.

الاسم	النوع	وصف	مطلوب	الإفتراضي
lookback_hours	integer	تم تطبيق نافذة Lookback (بالساعات) عند استرداد التتبعات من Application Insights.	لا	168
trace_ids	صفيف	مجموعة معرفات تتبع العامل التي يجب تقييمها.	‏‏نعم‬
النوع	enum	نوع مصدر البيانات، دائما azure_ai_traces. القيم المحتملة: azure_ai_traces	‏‏نعم‬

نوع المعالجة

نوع تأثير العلاج.

الخاصية	قيمة
Type	string
Values	TooFewSamples Inconclusive Changed Improved Degraded

المشغِّل

النموذج الأساسي لمشغل الجدول.

تمييزي للمشغل

يستخدم هذا المكون الخاصية type للتمييز بين أنواع مختلفة:

قيمة النوع	Schema
Cron	CronTrigger
Recurrence	RecurrenceTrigger
OneTime	OneTimeTrigger

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	object	نوع الزناد.	‏‏نعم‬

نوع المشغل

نوع الزناد.

الخاصية	قيمة
الوصف	نوع الزناد.
Type	string
Values	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

الاسم	النوع	وصف	مطلوب	الإفتراضي
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
manifest_id	string	معرف البيان لاستيراد إصدار العامل منه.	‏‏نعم‬
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
parameter_values	object	المدخلات إلى البيان التي ستؤدي إلى عامل مجسد بالكامل.	‏‏نعم‬

طلب التحديث

الاسم	النوع	وصف	مطلوب	الإفتراضي
تعريف	object		‏‏نعم‬
└─ نوع	AgentKind		لا
└─ rai_config	RaiConfig	تكوين فلترة محتوى الذكاء الاصطناعي المسؤول (RAI) وميزات الأمان.	لا
الوصف	string	وصف يمكن للإنسان قراءته للعامل.	لا
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا

UpdateEvalParametersBody

الاسم	النوع	وصف	مطلوب	الإفتراضي
metadata	OpenAI.Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيد لتخزين معلومات إضافية حول الكائن في منظم التنسيق والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا
الاسم	string		لا
خصائص	object	مجموعة من أزواج قيم المفاتيح غير القابلة للتغيير والتي يمكن إرفاقها بعنصر لتخزين معلومات إضافية. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	لا

UserProfileMemoryItem

عنصر ذاكرة يحتوي على معلومات ملف تعريف المستخدم المستخرجة من المحادثات، مثل التفضيلات والاهتمامات والتفاصيل الشخصية.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	نوع عنصر الذاكرة. القيم المحتملة: user_profile	‏‏نعم‬

جدول التكرار الأسبوعي

جدول التكرار الأسبوعي.

الاسم	النوع	وصف	مطلوب	الإفتراضي
daysOfWeek	صفيف	أيام الأسبوع لجدول التكرار.	‏‏نعم‬
النوع	enum	نوع التكرار الأسبوعي. القيم المحتملة: Weekly	‏‏نعم‬

WorkflowActionOutputItemResource

الاسم	النوع	وصف	مطلوب	الإفتراضي
action_id	string	معرف فريد للإجراء.	‏‏نعم‬
النوع	string	نوع إجراء CSDL (على سبيل المثال، 'SetVariable'، 'InvokeAzureAgent').	‏‏نعم‬
parent_action_id	string	معرف الإجراء الأصل إذا كان هذا إجراء متداخلا.	لا
previous_action_id	string	معرف الإجراء السابق إذا كان هذا الإجراء يتبع إجراء آخر.	لا
الحالة	enum	حالة الإجراء (على سبيل المثال، "in_progress"، "مكتمل"، "فشل"، "تم الإلغاء"). القيم المحتملة: completed، failed، ، in_progresscancelled	‏‏نعم‬
النوع	enum	القيم المحتملة: workflow_action	‏‏نعم‬

تعريف WorkflowAgentDefinition

تعريف عامل سير العمل.

الاسم	النوع	وصف	مطلوب	الإفتراضي
النوع	enum	القيم المحتملة: workflow	‏‏نعم‬
workflow	string	تعريف CSDL YAML لسير العمل.	لا

integer

النوع: عدد صحيح

التنسيق: int64