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

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

API specs

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

Control plane
مستوى البيانات - التأليف
مستوى البيانات - الاستدلال

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

Important

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

API	أحدث إصدار معاينة	أحدث إصدار من GA	Specifications	Description
Control plane	`2025-07-01-preview`	`2025-06-01`	Spec files	يتم استخدام واجهة برمجة تطبيقات مستوى التحكم لعمليات مثل إنشاء الموارد ونشر النموذج ومهام إدارة الموارد الأخرى ذات المستوى الأعلى. تحكم وحدة التحكم أيضا ما هو ممكن to do بقدرات مثل Azure Resource Manager وBicep وTerraform Azure CLI.
Data plane	`v1 preview`	`v1`	Spec files	تتحكم واجهة برمجة تطبيقات مستوى البيانات في عمليات الاستدلال والتأليف.

Authentication

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

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

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

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

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	createCompletionResponse

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

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

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

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

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

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

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

التضمينات - إنشاء

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	معرف النشر للنموذج الذي تم نشره.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	object

Examples

Example

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

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

{
 "input": [
  "this is a test"
 ]
}

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

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
audio	object	معلمات لإخراج الصوت. مطلوب عند طلب إخراج الصوت باستخدام `modalities: ["audio"]`.	No
└─ format	enum	تحديد تنسيق صوت الإخراج. يجب أن يكون واحدا من `wav`أو `mp3flac`أو `opus`.`pcm16` القيم المحتملة: `wav`، `mp3`، `flac`، ، `opuspcm16`	No
└─ voice	enum	تحديد نوع الصوت. الأصوات المدعومة هي `alloy`و `echofable`و`onyxnova`.`shimmer` القيم المحتملة: `alloy`، `echo`، `fable`، `onyx`، ، `novashimmer`	No
data_sources	array	إدخالات التكوين Azure ملحقات دردشة OpenAI التي تستخدمها. هذه المواصفات الإضافية متوافقة فقط مع Azure OpenAI.	No
frequency_penalty	number	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي.	No	0
function_call	سلسلة أو chatCompletionFunctionCallOption	مهمل لصالح `tool_choice`. عناصر التحكم التي يتم استدعاء الدالة (إن وجدت) بواسطة النموذج. `none` يعني أن النموذج لن يستدعي دالة وبدلا من ذلك ينشئ رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء دالة. تحديد دالة معينة عبر `{"name": "my_function"}` يفرض على النموذج استدعاء تلك الدالة. `none` هو الافتراضي عندما لا تكون هناك دالات. `auto` هو الافتراضي إذا كانت الدالات موجودة.	No
functions	array	مهمل لصالح `tools`. قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها.	No
logit_bias	object	تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في الرمز المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. يختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو اختيار حصري للرمز المميز ذي الصلة.	No	None
logprobs	boolean	ما إذا كان يجب إرجاع احتمالات السجل للرمز المميزة للإخراج أم لا. إذا كان صحيحا، فترجع احتمالات السجل لكل رمز مميز للإخراج تم إرجاعه في `content` من `message`.	No	False
max_completion_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها لإكمالها، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية.	No
max_tokens	integer	الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها في إكمال الدردشة. يحد طول إجمالي رموز الإدخال المميزة والرموز المميزة التي تم إنشاؤها من خلال طول سياق النموذج.	No
messages	array	قائمة بالرسائل التي تتضمن المحادثة حتى الآن. مثال على تعليمة Python البرمجية.	Yes
metadata	object	العلامات والقيم المعرفة من قبل المطور المستخدمة لتصفية الإكمال في لوحة معلومات الإكمال المخزنة.	No
modalities	ChatCompletionModalities	أنواع الإخراج التي ترغب في أن ينشئها النموذج لهذا الطلب. معظم النماذج قادرة على إنشاء نص، وهو الافتراضي: `["text"]` `gpt-4o-audio-preview` يمكن أيضا استخدام النموذج لإنشاء الصوت. لطلب إنشاء هذا النموذج استجابات نصية وصوتية، يمكنك استخدام: `["text", "audio"]`	No
n	integer	كم عدد خيارات إكمال الدردشة التي يجب إنشاؤها لكل رسالة إدخال. سيتم تحصيل رسوم منك بناء على عدد الرموز المميزة التي تم إنشاؤها عبر جميع الخيارات. احتفظ `n` بأدنى `1` قدر من التكاليف.	No	1
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	No	True
prediction	PredictionContent	تكوين الإخراج المتوقع، والذي يمكن أن يحسن أوقات الاستجابة بشكل كبير عندما تكون أجزاء كبيرة من استجابة النموذج معروفة مسبقا. هذا هو الأكثر شيوعا عند إعادة إنشاء ملف مع تغييرات طفيفة فقط على معظم المحتوى.	No
presence_penalty	number	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج.	No	0
reasoning_effort	enum	نماذج o1 فقط يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي `low`و `medium`و.`high` يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. القيم المحتملة: `low`، ، `mediumhigh`	No
response_format	ResponseFormatText أو ResponseFormatJsonObject أو ResponseFormatJsonSchema	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o، GPT-4o mini، GPT-4 Turbo وجميع GPT-3.5 طرازات Turbo الأحدث من `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة، والتي تضمن تطابق النموذج مع مخطط JSON المقدم. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
seed	integer	هذه الميزة في Beta. إذا تم تحديده ، يبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات `seed` المتكررة بنفس المعلمات والمعلمات نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة `system_fingerprint` لمراقبة التغييرات في الخلفية.	No
stop	سلسلة أو مجموعة	ما يصل إلى 4 تسلسلات حيث تتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة.	No
store	boolean	ما إذا كان يجب تخزين إخراج طلب إكمال الدردشة هذا أم لا للاستخدام في منتجات تقطير النموذج أو التقييم.	No
stream	boolean	إذا تم تعيينه ، يتم إرسال دلتا الرسائل الجزئية ، كما هو الحال في ChatGPT. يتم إرسال الرموز المميزة كأحداث مرسلة من الخادم للبيانات فقط عند توفرها، مع إنهاء الدفق برسالة `data: [DONE]` . مثال على تعليمة Python البرمجية.	No	False
stream_options	chatCompletionStreamOptions	خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين `stream: true`.	No	None
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 تجعل الإخراج أكثر عشوائية ، في حين أن القيم المنخفضة مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	No	1
tool_choice	chatCompletionToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. `auto` يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر. تحديد أداة معينة عبر `{"type": "function", "function": {"name": "my_function"}}` يفرض على النموذج استدعاء تلك الأداة. `none` هو الافتراضي عندما لا تكون هناك أدوات موجودة. `auto` هو الافتراضي إذا كانت الأدوات موجودة.	No
tools	array	قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. يتم دعم 128 وظيفة كحد أقصى.	No
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن. `logprobs` يجب تعيين إلى `true` إذا تم استخدام هذه المعلمة.	No
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	No	1
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	No
user_security_context	userSecurityContext	يحتوي سياق أمان المستخدم على العديد من المعلمات التي تصف تطبيق الذكاء الاصطناعي نفسه، والمستخدم النهائي الذي يتفاعل مع تطبيق الذكاء الاصطناعي. تساعد هذه الحقول فرق عمليات الأمان الخاصة بك على التحقيق في الحوادث الأمنية والتخفيف من حدتها من خلال توفير نهج شامل لحماية تطبيقاتك الذكاء الاصطناعي. تعرف على المزيد حول حماية تطبيقات الذكاء الاصطناعي باستخدام Microsoft Defender for Cloud.	No

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	object

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

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

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

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

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

إنشاء إكمال استنادا إلى بيانات متجهات الصور Azure Search.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

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

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

Example

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

إنشاء إكمال Azure Cosmos DB المتوفرة.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

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

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

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

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

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

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

النسخ - إنشاء

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: multipart/form-data

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

Responses

رمز الحالة: 200

Description: OK

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

Examples

Example

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

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

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

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

Example

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

الترجمات - إنشاء

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
file	string	الملف الصوتي المراد ترجمته.	Yes
prompt	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تكون المطالبة باللغة الإنجليزية.	No
response_format	audioResponseFormat	تعريف تنسيق الإخراج.	No
temperature	number	درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه على 0 ، يستخدم النموذج احتمالية السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى عتبات معينة.	No	0

Responses

رمز الحالة: 200

Description: OK

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

Examples

Example

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

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

Example

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: multipart/form-data

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/octet-stream	string

Examples

Example

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

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

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

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

{
  "body": "101010101"
}

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

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

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

Content-Type	Type	Description
application/json	dalleErrorResponse

Examples

Example

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

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

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

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

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: multipart/form-data

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

Responses

رمز الحالة: 200

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

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

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

Content-Type	Type	Description
application/json	dalleErrorResponse

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

Note

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

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	listAssistantsResponse

Examples

Example

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

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

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

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

إنشاء - مساعد

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
description	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	No
instructions	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 256000 حرف.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	No
model	string		Yes
name	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	No
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	No
└─ code_interpreter	object		No
└─ file_ids	array	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
└─ vector_stores	array	مساعد لإنشاء مخزن متجهات باستخدام file_ids وإرفاقه بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
tools	array	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `retrieval`أو `function`.	No	[]
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

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

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

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

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

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

Get - مساعد

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
assistant_id	path	Yes	string	معرف المساعد المراد استرداده.
api-version	query	Yes	string

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

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

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

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

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

تعديل - مساعد

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

تعديل مساعد.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
assistant_id	path	Yes	string	معرف المساعد المراد تعديله.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
description	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	No
instructions	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 32768 حرفا.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	No
model	string		No
name	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	No
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	No
└─ code_interpreter	object		No
└─ file_ids	array	يتجاوز قائمة معرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	يتجاوز مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
tools	array	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `retrieval`أو `function`.	No	[]
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

تعديل مساعد.

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

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

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

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

حذف - مساعد

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

حذف مساعد.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
assistant_id	path	Yes	string	معرف المساعد المراد حذفه.
api-version	query	Yes	string

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	deleteAssistantResponse

Examples

Example

حذف مساعد.

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

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

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

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

Note

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

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

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

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

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

Get - مؤشر ترابط

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشر الترابط المراد استرداده.
api-version	query	Yes	string

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشر الترابط المراد تعديله. `metadata` يمكن تعديل فقط.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

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

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشر الترابط المراد حذفه.
api-version	query	Yes	string

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	deleteThreadResponse

Examples

Example

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

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

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

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

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

Note

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	listMessagesResponse

Examples

Example

List Messages

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

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

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

إنشاء - رسالة

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

إنشاء رسالة.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشرات الترابط لإنشاء رسالة لها.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

إنشاء رسالة.

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشرات الترابط التي تنتمي إليها هذه الرسالة.
message_id	path	Yes	string	معرف الرسالة المراد استردادها.
api-version	query	Yes	string

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

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

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

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

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

تعديل - رسالة

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

تعديل رسالة.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشر الترابط الذي تنتمي إليه هذه الرسالة.
message_id	path	Yes	string	معرف الرسالة المراد تعديلها.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

تعديل رسالة.

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

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

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

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

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

Note

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
assistant_id	string	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.	Yes
instructions	string	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	No
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد رموز الإكمال المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	No
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد الرموز المميزة السريعة المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	No
model	string	معرف النماذج التي سيتم استخدامها لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	No
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	No	True
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
stream	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	No
stream_options	chatCompletionStreamOptions	خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين `stream: true`.	No	None
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
thread	createThreadRequest		No
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	No
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	No
└─ code_interpreter	object		No
└─ file_ids	array	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	معرف مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
tools	array	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	No
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	No

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

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

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

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

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

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

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	listRunsResponse

Examples

Example

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

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

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

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

إنشاء - تشغيل

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

إنشاء تشغيل.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشر الترابط الذي سيتم تشغيله.
include[]	query	No	array	قائمة بالحقول الإضافية لتضمينها في الاستجابة. القيمة الوحيدة المدعومة حاليا هي `step_details.tool_calls[].file_search.results[].content` إحضار محتوى نتيجة البحث عن الملفات.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
additional_instructions	string	إلحاق إرشادات إضافية في نهاية التعليمات الخاصة بالتشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل دون تجاوز إرشادات أخرى.	No
additional_messages	array	إضافة رسائل إضافية إلى مؤشر الترابط قبل إنشاء التشغيل.	No
assistant_id	string	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.	Yes
instructions	string	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	No
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد رموز الإكمال المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	No
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد الرموز المميزة السريعة المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	No
model	string	معرف النموذج الذي سيتم استخدامه لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	No
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	No	True
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
stream	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	No
tools	array	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	No
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	No

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

إنشاء تشغيل.

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

{
 "assistant_id": "asst_abc123"
}

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشرات الترابط التي تم تشغيلها.
run_id	path	Yes	string	معرف التشغيل المراد استرداده.
api-version	query	Yes	string

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

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

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

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

تعديل - تشغيل

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

تعديل تشغيل.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشرات الترابط التي تم تشغيلها.
run_id	path	Yes	string	معرف التشغيل المراد تعديله.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

تعديل تشغيل.

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشرات الترابط التي ينتمي إليها هذا التشغيل.
run_id	path	Yes	string	معرف التشغيل الذي يتطلب إرسال إخراج الأداة.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
stream	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	No
tool_outputs	array	قائمة بالأدوات التي يتم إرسال المخرجات لها.	Yes

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشر الترابط الذي ينتمي إليه هذا التشغيل.
run_id	path	Yes	string	معرف التشغيل لإلغاء الأمر.
api-version	query	Yes	string

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	listRunStepsResponse

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	معرف مؤشر الترابط الذي تنتمي إليه خطوة التشغيل والتشغيل.
run_id	path	Yes	string	معرف التشغيل الذي تنتمي إليه خطوة التشغيل.
step_id	path	Yes	string	معرف خطوة التشغيل لاسترداده.
include[]	query	No	array	قائمة بالحقول الإضافية لتضمينها في الاستجابة. القيمة الوحيدة المدعومة حاليا هي `step_details.tool_calls[].file_search.results[].content` إحضار محتوى نتيجة البحث عن الملفات.
api-version	query	Yes	string

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	runStepObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	listVectorStoresResponse

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	query	Yes	string	api version

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات المراد استرداده.
api-version	query	Yes	string	api version

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات المراد تعديله.
api-version	query	Yes	string	api version

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

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

{
 "name": "Support FAQ"
}

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات المراد حذفه.
api-version	query	Yes	string	api version

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	deleteVectorStoreResponse

Examples

Example

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

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

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

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

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

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	listVectorStoreFilesResponse

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات الذي سيتم إنشاء ملف له.
api-version	query	Yes	string	api version

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` .	No
file_id	string	معرف ملف يجب أن يستخدمه مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	Yes

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileObject

Examples

Example

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

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

{
 "file_id": "file-abc123"
}

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات الذي ينتمي إليه الملف.
file_id	path	Yes	string	معرف الملف الذي يتم استرداده.
api-version	query	Yes	string	api version

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات الذي ينتمي إليه الملف.
file_id	path	Yes	string	معرف الملف المراد حذفه.
api-version	query	Yes	string	api version

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	deleteVectorStoreFileResponse

Examples

Example

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

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

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

Updatevectorstorefileattributes

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

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

URI Parameters

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

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileObject

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

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	VectorStoreFileContentResponse

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

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

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

URI Parameters

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

Request Header

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	VectorStoreSearchResultsPage

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات الذي سيتم إنشاء File Batch له.
api-version	query	Yes	string	api version

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` .	No
file_ids	array	قائمة بمعرفات الملفات التي يجب أن يستخدمها مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	Yes

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

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

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات الذي تنتمي إليه دفعة الملف.
batch_id	path	Yes	string	معرف دفعة الملفات التي يتم استردادها.
api-version	query	Yes	string	api version

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	معرف مخزن المتجهات الذي تنتمي إليه دفعة الملف.
batch_id	path	Yes	string	معرف دفعة الملف المراد إلغاؤها.
api-version	query	Yes	string	api version

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

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

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

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

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

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

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	listVectorStoreFilesResponse

Examples

Example

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

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

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

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

إنشاء - Realtimesession

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

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

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

Content-Type	Type	Description
application/json	RealtimeSessionCreateResponse

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

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

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

Request Body

Content-Type: application/json

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

Responses

رمز الحالة: 200

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

Content-Type	Type	Description
application/json	RealtimeTranscriptionSessionCreateResponse

Responses

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

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
include	array		No
input	سلسلة أو مجموعة	Model inputs	Yes
instructions	string	إدراج رسالة نظام (أو مطور) كعنصر أول في سياق النموذج. عند استخدام جنبا إلى جنب مع `previous_response_id`، لن يتم نقل الإرشادات من استجابة سابقة إلى الاستجابة التالية. وهذا يجعل من السهل تبديل رسائل النظام (أو المطور) في استجابات جديدة.	No
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية وحالة المحادثة.	No
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	No	True
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار. تعرف على المزيد حول حالة المحادثة.	No
reasoning	Reasoning	خيارات التكوين لنماذج المنطق.	No
store	boolean	ما إذا كنت تريد تخزين استجابة النموذج التي تم إنشاؤها للاسترداد لاحقا عبر واجهة برمجة التطبيقات.	No	True
stream	boolean	إذا تم تعيينها إلى true، دفق بيانات استجابة النموذج إلى العميل كما يتم إنشاؤها باستخدام الأحداث المرسلة من الخادم. راجع قسم Streaming أدناه لمزيد من المعلومات.	No	False
text	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. Learn more: - مدخلات ومخرجات النص - المخرجات المنظمة	No
└─ format	TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين `{ "type": "json_schema" }` المخرجات المنظمة، مما يضمن تطابق النموذج مع مخطط JSON المقدم. التنسيق الافتراضي مع `{ "type": "text" }` عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: الإعداد لتمكين `{ "type": "json_object" }` وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام `json_schema` للنماذج التي تدعمه.	No
tool_choice	ToolChoiceOptions أو ToolChoiceTypes أو ToolChoiceFunction	كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة `tools` لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.	No
tools	array	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. يمكنك تحديد الأداة التي يجب استخدامها عن طريق تعيين المعلمة `tool_choice` . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة: الأدوات التي يوفرها OpenAI والتي توسع نطاق model's capabilities	No
truncation	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - `auto`: إذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج، فسيقتطاع النموذج الاستجابة لاحتواء نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (افتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، فسيفشل الطلب مع حدوث خطأ 400. القيم المحتملة: `auto`، `disabled`	No

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	response
text/event-stream	responseStreamEvent

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

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

Content-Type	Type	Description
application/json	errorResponse

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

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: `https://aoairesource.openai.azure.com`. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
response_id	path	Yes	string	معرف الاستجابة المراد استردادها.
include	query	No	array	حقول إضافية لتضمينها في الاستجابة. راجع المعلمة `include` لإنشاء الاستجابة أعلاه لمزيد من المعلومات.

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	response

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

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

Content-Type	Type	Description
application/json	errorResponse

Delete response

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

رمز الحالة: 404

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

Content-Type	Type	Description
application/json	error

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

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

Content-Type	Type	Description
application/json	errorResponse

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

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

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

URI Parameters

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

Request Header

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

Responses

رمز الحالة: 200

Description: OK

Content-Type	Type	Description
application/json	responseItemList

Components

errorResponse

Name	Type	Description	Required	Default
error	error		No

errorBase

Name	Type	Description	Required	Default
code	string		No
message	string		No

error

Name	Type	Description	Required
inner_error	innerError	خطأ داخلي مع تفاصيل إضافية.	No
param	string		No
type	string		No

innerError

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

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

innerErrorCode

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

Property	Value
Description	رموز الخطأ لكائن الخطأ الداخلي.
Type	string
Values	`ResponsibleAIPolicyViolation`

dalleErrorResponse

Name	Type	Description	Required	Default
error	dalleError		No

dalleError

Name	Type	Description	Required
inner_error	dalleInnerError	خطأ داخلي مع تفاصيل إضافية.	No
param	string		No
type	string		No

dalleInnerError

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

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

contentFilterCompletionTextSpan

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

Name	Type	Description	Required	Default
completion_end_offset	integer	إزاحة نقطة التعليمات البرمجية UTF32 الأولى التي يتم استبعادها من النطاق. هذا الحقل يساوي دائما completion_start_offset للامتدادات الفارغة. هذا الحقل أكبر دائما من completion_start_offset للامتدادات غير الفارغة.	Yes
completion_start_offset	integer	إزاحة نقطة التعليمات البرمجية UTF32 التي تبدأ النطاق.	Yes

contentFilterResultBase

Name	Type	Description	Required	Default
filtered	boolean		Yes

contentFilterSeverityResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
severity	string		No

contentFilterDetectedResult

Name	Type	Description	Required	Default
detected	boolean		No
filtered	boolean		Yes

contentFilterDetectedWithCitationResult

Name	Type	Required
citation	object	No
└─ URL	string	No
└─ license	string	No

contentFilterDetectedWithCompletionTextSpansResult

Name	Type	Description	Required	Default
details	array		No

contentFilterIdResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
id	string		No

contentFilterResultsBase

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

Name	Type	Description	Required
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للشرائح التي تمت تصفيتها.	No
error	errorBase		No
hate	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

contentFilterPromptResults

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

Name	Type	Description	Required
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للشرائح التي تمت تصفيتها.	No
error	errorBase		No
hate	contentFilterSeverityResult		No
indirect_attack	contentFilterDetectedResult		No
jailbreak	contentFilterDetectedResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

contentFilterChoiceResults

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

Name	Type	Description	Required
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للشرائح التي تمت تصفيتها.	No
error	errorBase		No
hate	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
protected_material_code	contentFilterDetectedWithCitationResult		No
protected_material_text	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		No
violence	contentFilterSeverityResult		No

contentFilterDetailedResults

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

Name	Type	Description	Required	Default
details	array		No
filtered	boolean		Yes

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

Name	Type	Required
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No

dalleFilterResults

Name	Type	Description	Required
custom_blocklists	contentFilterDetailedResults	نتائج تصفية المحتوى مع تفاصيل معرفات تصفية المحتوى للشرائح التي تمت تصفيتها.	No
hate	contentFilterSeverityResult		No
jailbreak	contentFilterDetectedResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

chatCompletionsRequestCommon

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

createCompletionRequest

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

createCompletionResponse

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

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

createChatCompletionRequest

Name	Type	Description	Required	Default
audio	object	معلمات لإخراج الصوت. مطلوب عند طلب إخراج الصوت باستخدام `modalities: ["audio"]`.	No
└─ format	enum	تحديد تنسيق صوت الإخراج. يجب أن يكون واحدا من `wav`أو `mp3flac`أو `opus`.`pcm16` القيم المحتملة: `wav`، `mp3`، `flac`، ، `opuspcm16`	No
└─ voice	enum	تحديد نوع الصوت. الأصوات المدعومة هي `alloy`و `echofable`و`onyxnova`.`shimmer` القيم المحتملة: `alloy`، `echo`، `fable`، `onyx`، ، `novashimmer`	No
data_sources	array	إدخالات التكوين Azure ملحقات دردشة OpenAI التي تستخدمها. هذه المواصفات الإضافية متوافقة فقط مع Azure OpenAI.	No
frequency_penalty	number	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي.	No	0
function_call	سلسلة أو chatCompletionFunctionCallOption	مهمل لصالح `tool_choice`. عناصر التحكم التي يتم استدعاء الدالة (إن وجدت) بواسطة النموذج. `none` يعني أن النموذج لن يستدعي دالة وبدلا من ذلك ينشئ رسالة. `auto` يعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء دالة. تحديد دالة معينة عبر `{"name": "my_function"}` يفرض على النموذج استدعاء تلك الدالة. `none` هو الافتراضي عندما لا تكون هناك دالات. `auto` هو الافتراضي إذا كانت الدالات موجودة.	No
functions	array	مهمل لصالح `tools`. قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها.	No
logit_bias	object	تعديل احتمال ظهور الرموز المميزة المحددة في الإكمال. يقبل كائن JSON الذي يعين الرموز المميزة (المحددة بواسطة معرف الرمز المميز في الرمز المميز) إلى قيمة تحيز مقترنة من -100 إلى 100. رياضيًا، تتم إضافة التحيز إلى السجلات التي تم إنشاؤها بواسطة النموذج قبل أخذ العينات. يختلف التأثير الدقيق لكل نموذج، ولكن يجب أن تقل القيم بين -1 و1 أو تزيد من احتمالية الاختيار؛ يجب أن تؤدي قيم مثل -100 أو 100 إلى حظر أو اختيار حصري للرمز المميز ذي الصلة.	No	None
logprobs	boolean	ما إذا كان يجب إرجاع احتمالات السجل للرمز المميزة للإخراج أم لا. إذا كان صحيحا، فترجع احتمالات السجل لكل رمز مميز للإخراج تم إرجاعه في `content` من `message`.	No	False
max_completion_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها لإكمالها، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية.	No
max_tokens	integer	الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها في إكمال الدردشة. يحد طول إجمالي رموز الإدخال المميزة والرموز المميزة التي تم إنشاؤها من خلال طول سياق النموذج.	No
messages	array	قائمة بالرسائل التي تتضمن المحادثة حتى الآن. مثال على تعليمة Python البرمجية.	Yes
metadata	object	العلامات والقيم المعرفة من قبل المطور المستخدمة لتصفية الإكمال في لوحة معلومات الإكمال المخزنة.	No
modalities	ChatCompletionModalities	أنواع الإخراج التي ترغب في أن ينشئها النموذج لهذا الطلب. معظم النماذج قادرة على إنشاء نص، وهو الافتراضي: `["text"]` `gpt-4o-audio-preview` يمكن أيضا استخدام النموذج لإنشاء الصوت. لطلب إنشاء هذا النموذج استجابات نصية وصوتية، يمكنك استخدام: `["text", "audio"]`	No
n	integer	كم عدد خيارات إكمال الدردشة التي يجب إنشاؤها لكل رسالة إدخال. لاحظ أنه سيتم تحصيل رسوم منك استنادا إلى عدد الرموز المميزة التي تم إنشاؤها عبر جميع الخيارات. احتفظ `n` بأدنى `1` قدر من التكاليف.	No	1
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	No	True
prediction	PredictionContent	تكوين الإخراج المتوقع، والذي يمكن أن يحسن أوقات الاستجابة بشكل كبير عندما تكون أجزاء كبيرة من استجابة النموذج معروفة مسبقا. هذا هو الأكثر شيوعا عند إعادة إنشاء ملف مع تغييرات طفيفة فقط على معظم المحتوى.	No
presence_penalty	number	رقم يتراوح بين 2.0 و2.0. تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج.	No	0
reasoning_effort	enum	نماذج o1 فقط يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي `low`و `medium`و.`high` يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة. القيم المحتملة: `low`، ، `mediumhigh`	No
response_format	ResponseFormatText أو ResponseFormatJsonObject أو ResponseFormatJsonSchema	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o، GPT-4o mini، GPT-4 Turbo وجميع GPT-3.5 طرازات Turbo الأحدث من `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
seed	integer	هذه الميزة في Beta. إذا تم تحديده ، يبذل نظامنا قصارى جهده لأخذ عينات بشكل حتمي ، بحيث يجب أن ترجع الطلبات `seed` المتكررة بنفس المعلمات والمعلمات نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة `system_fingerprint` لمراقبة التغييرات في الخلفية.	No
stop	سلسلة أو مجموعة	ما يصل إلى 4 تسلسلات حيث تتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة.	No
store	boolean	ما إذا كان يجب تخزين إخراج طلب إكمال الدردشة هذا أم لا للاستخدام في منتجات تقطير النموذج أو التقييم.	No
stream	boolean	إذا تم تعيينه ، يتم إرسال دلتا الرسائل الجزئية ، كما هو الحال في ChatGPT. يتم إرسال الرموز المميزة كأحداث مرسلة من الخادم للبيانات فقط عند توفرها، مع إنهاء الدفق برسالة `data: [DONE]` . مثال على تعليمة Python البرمجية.	No	False
stream_options	chatCompletionStreamOptions	خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين `stream: true`.	No	None
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	No	1
tool_choice	chatCompletionToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. `auto` يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر. تحديد أداة معينة عبر `{"type": "function", "function": {"name": "my_function"}}` يفرض على النموذج استدعاء تلك الأداة. `none` هو الافتراضي عندما لا تكون هناك أدوات موجودة. `auto` هو الافتراضي إذا كانت الأدوات موجودة.	No
tools	array	قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. يتم دعم 128 وظيفة كحد أقصى.	No
top_logprobs	integer	عدد صحيح بين 0 و20 يحدد عدد الرموز المميزة الأكثر احتمالا لإرجاعها في كل موضع رمز مميز، لكل منها احتمال سجل مقترن. `logprobs` يجب تعيين إلى `true` إذا تم استخدام هذه المعلمة.	No
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	No	1
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	No
user_security_context	userSecurityContext	يحتوي سياق أمان المستخدم على العديد من المعلمات التي تصف تطبيق الذكاء الاصطناعي نفسه، والمستخدم النهائي الذي يتفاعل مع تطبيق الذكاء الاصطناعي. تساعد هذه الحقول فرق عمليات الأمان الخاصة بك على التحقيق في الحوادث الأمنية والتخفيف من حدتها من خلال توفير نهج شامل لحماية تطبيقاتك الذكاء الاصطناعي. تعرف على المزيد حول حماية تطبيقات الذكاء الاصطناعي باستخدام Microsoft Defender for Cloud.	No

userSecurityContext

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

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

chatCompletionFunctions

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

chatCompletionFunctionCallOption

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

Name	Type	Description	Required	Default
name	string	اسم الدالة التي يجب استدعاها.	Yes

chatCompletionFunctionParameters

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

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

chatCompletionRequestMessage

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

ChatCompletionRequestDeveloperMessage
chatCompletionRequestSystemMessage
chatCompletionRequestUserMessage
chatCompletionRequestAssistantMessage
chatCompletionRequestToolMessage
chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

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

Name	Type	Description	Required
content	سلسلة أو مجموعة	محتويات رسالة المطور.	Yes
name	string	اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور.	No
role	enum	دور كاتب الرسائل، في هذه الحالة `developer`. القيم المحتملة: `developer`	Yes

chatCompletionRequestSystemMessage

Name	Type	Description	Required
content	سلسلة أو مجموعة	محتويات رسالة النظام.	Yes
name	string	اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور.	No
role	enum	دور كاتب الرسائل، في هذه الحالة `system`. القيم المحتملة: `system`	Yes

chatCompletionRequestUserMessage

Name	Type	Description	Required
content	سلسلة أو مجموعة	محتويات رسالة المستخدم.	Yes
name	string	اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور.	No
role	enum	دور كاتب الرسائل، في هذه الحالة `user`. القيم المحتملة: `user`	Yes

chatCompletionRequestAssistantMessage

Name	Type	Description	Required
content	سلسلة أو مجموعة	محتويات رسالة المساعد. مطلوب ما لم `tool_calls` يتم تحديد أو `function_call` .	No
function_call	object	مهمل واستبدل ب `tool_calls`. اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج.	No
└─ arguments	string	الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد يهلوس المعلمات التي لم يتم تعريفها بواسطة مخطط الدالة الخاص بك. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة.	No
└─ name	string	اسم الدالة التي يجب استدعاها.	No
name	string	اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور.	No
refusal	string	رسالة الرفض من قبل المساعد.	No
role	enum	دور كاتب الرسائل، في هذه الحالة `assistant`. القيم المحتملة: `assistant`	Yes
tool_calls	chatCompletionMessageToolCalls	تستدعي الأداة التي تم إنشاؤها بواسطة النموذج، مثل استدعاءات الدالة.	No

chatCompletionRequestToolMessage

Name	Type	Description	Required
content	سلسلة أو مجموعة	محتويات رسالة الأداة.	Yes
role	enum	دور كاتب الرسائل، في هذه الحالة `tool`. القيم المحتملة: `tool`	Yes
tool_call_id	string	استدعاء الأداة الذي تستجيب له هذه الرسالة.	Yes

chatCompletionRequestFunctionMessage

Name	Type	Description	Required
content	string	محتويات رسالة الدالة.	Yes
name	string	اسم الدالة التي يجب استدعاها.	Yes
role	enum	دور كاتب الرسائل، في هذه الحالة `function`. القيم المحتملة: `function`	Yes

chatCompletionRequestDeveloperMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestMessageContentPartText
chatCompletionRequestMessageContentPartImage
chatCompletionRequestMessageContentPartAudio

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestMessageContentPartText
chatCompletionRequestMessageContentPartRefusal

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

Name	Type	Description	Required	Default
text	string	محتوى النص.	Yes
type	enum	نوع جزء المحتوى. القيم المحتملة: `text`	Yes

chatCompletionRequestMessageContentPartAudio

Name	Type	Description	Required
input_audio	object		Yes
└─ data	string	بيانات صوتية مشفرة Base64.	No
└─ format	enum	تنسيق البيانات الصوتية المشفرة. يدعم حاليا "wav" و"mp3". القيم المحتملة: `wav`، `mp3`	No
type	enum	نوع جزء المحتوى. دائمًا `input_audio`. القيم المحتملة: `input_audio`	Yes

chatCompletionRequestMessageContentPartImage

Name	Type	Description	Required
image_url	object		Yes
└─ detail	enum	تحديد مستوى تفاصيل الصورة. تعرف على المزيد في دليل Vision. القيم المحتملة: `auto`، ، `lowhigh`	No
└─ url	string	إما عنوان URL للصورة أو بيانات الصورة المشفرة base64.	No
type	enum	نوع جزء المحتوى. القيم المحتملة: `image_url`	Yes

chatCompletionRequestMessageContentPartRefusal

Name	Type	Description	Required	Default
refusal	string	رسالة الرفض التي أنشأها النموذج.	Yes
type	enum	نوع جزء المحتوى. القيم المحتملة: `refusal`	Yes

azureChatExtensionConfiguration

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

###Discriminator ل azureChatExtensionConfiguration

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

Type Value	Schema
`azure_search`	azureSearchChatExtensionConfiguration
`azure_cosmos_db`	azureCosmosDBChatExtensionConfiguration
`elasticsearch`	elasticsearchChatExtensionConfiguration
`mongo_db`	mongoDBChatExtensionConfiguration
`pinecone`	pineconeChatExtensionConfiguration

Name	Type	Description	Required	Default
type	azureChatExtensionType	تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	Yes

azureChatExtensionType

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

azureSearchChatExtensionConfiguration

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

Name	Type	Description	Required	Default
parameters	azureSearchChatExtensionParameters	معلمات Azure Search عند استخدامها كملحق دردشة Azure OpenAI.	No
type	azureChatExtensionType	تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	Yes

azureSearchChatExtensionParameters

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

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

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

azureCosmosDBChatExtensionConfiguration

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

Name	Type	Description	Required	Default
parameters	azureCosmosDBChatExtensionParameters	المعلمات التي يجب استخدامها عند تكوين Azure OpenAI على ملحقات دردشة بياناتك عند استخدام Azure Cosmos DB ل MongoDB vCore.	No
type	azureChatExtensionType	تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	Yes

azureCosmosDBChatExtensionParameters

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

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

azureCosmosDBFieldMappingOptions

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

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

elasticsearchChatExtensionConfiguration

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

Name	Type	Description	Required	Default
parameters	elasticsearchChatExtensionParameters	المعلمات التي يجب استخدامها عند تكوين ElasticsearchÂ® كملحق دردشة Azure OpenAI.	No
type	azureChatExtensionType	تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	Yes

elasticsearchChatExtensionParameters

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

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

elasticsearchIndexFieldMappingOptions

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

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

elasticsearchQueryType

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

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

mongoDBChatExtensionConfiguration

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

Name	Type	Description	Required	Default
parameters	mongoDBChatExtensionParameters	المعلمات التي يجب استخدامها عند تكوين Azure OpenAI على ملحقات دردشة بياناتك عند استخدام Mongo DB.	No
type	azureChatExtensionType	تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	Yes

mongoDBChatExtensionParameters

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

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

mongoDBFieldMappingOptions

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

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

pineconeChatExtensionConfiguration

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

Name	Type	Description	Required	Default
parameters	pineconeChatExtensionParameters	معلمات لتكوين Azure ملحقات دردشة OpenAI Pinecone.	No
type	azureChatExtensionType	تمثيل لبيانات التكوين لملحق دردشة واحد Azure OpenAI. سيتم استخدام هذا من قبل طلب إكمال الدردشة الذي يجب أن يستخدم Azure ملحقات دردشة OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI.	Yes

pineconeChatExtensionParameters

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

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

pineconeFieldMappingOptions

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

Name	Type	Description	Required
content_fields	array	أسماء حقول الفهرس التي يجب التعامل معها كمحتوى.	Yes
content_fields_separator	string	نمط الفاصل الذي يجب أن تستخدمه حقول المحتوى.	No
filepath_field	string	اسم حقل الفهرس لاستخدامه كمسار ملف.	No
title_field	string	اسم حقل الفهرس المراد استخدامه كعنوان.	No
url_field	string	اسم حقل الفهرس لاستخدامه كعنون URL.	No

onYourDataAuthenticationOptions

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

تمييز على onYourDataAuthenticationOptions

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

Type Value	Schema
`api_key`	onYourDataApiKeyAuthenticationOptions
`connection_string`	onYourDataConnectionStringAuthenticationOptions
`key_and_key_id`	onYourDataKeyAndKeyIdAuthenticationOptions
`encoded_api_key`	onYourDataEncodedApiKeyAuthenticationOptions
`access_token`	onYourDataAccessTokenAuthenticationOptions
`system_assigned_managed_identity`	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
`user_assigned_managed_identity`	onYourDataUserAssignedManagedIdentityAuthenticationOptions
`username_and_password`	onYourDataUsernameAndPasswordAuthenticationOptions

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes

onYourDataContextProperty

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

Property	Value
Description	خاصية السياق.
Type	string
Values	`citations` `intent` `all_retrieved_documents`

onYourDataAuthenticationType

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

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

onYourDataApiKeyAuthenticationOptions

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

Name	Type	Description	Required	Default
key	string	مفتاح API لاستخدامه للمصادقة.	No
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes

onYourDataConnectionStringAuthenticationOptions

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

Name	Type	Description	Required	Default
connection_string	string	سلسلة الاتصال لاستخدامه للمصادقة.	No
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes

onYourDataKeyAndKeyIdAuthenticationOptions

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

Name	Type	Description	Required
key	string	مفتاح Elasticsearch لاستخدامه للمصادقة.	No
key_id	string	معرف مفتاح Elasticsearch لاستخدامه للمصادقة.	No
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes

onYourDataEncodedApiKeyAuthenticationOptions

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

Name	Type	Description	Required	Default
encoded_api_key	string	مفتاح واجهة برمجة التطبيقات المرمزة Elasticsearch لاستخدامه للمصادقة.	No
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes

onYourDataAccessTokenAuthenticationOptions

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

Name	Type	Description	Required	Default
access_token	string	الرمز المميز access لاستخدامه للمصادقة.	No
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

Name	Type	Description	Required	Default
managed_identity_resource_id	string	معرف المورد للهوية المدارة المعينة من قبل المستخدم لاستخدامها للمصادقة.	No
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes

onYourDataUsernameAndPasswordAuthenticationOptions

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

Name	Type	Description	Required
password	string	The password. لاستخدامه للمصادقة.	No
type	onYourDataAuthenticationType	أنواع المصادقة المدعومة مع Azure OpenAI على بياناتك.	Yes
username	string	اسم المستخدم المراد استخدامه للمصادقة.	No

onYourDataVectorizationSource

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

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

Type Value	Schema
`endpoint`	onYourDataEndpointVectorizationSource
`deployment_name`	onYourDataDeploymentNameVectorizationSource
`integrated`	onYourDataIntegratedVectorizationSource
`model_id`	onYourDataModelIdVectorizationSource

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	يمثل المصادر المتوفرة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات.	Yes

onYourDataVectorizationSourceType

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

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

onYourDataEndpointVectorizationSource

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

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

onYourDataDeploymentNameVectorizationSource

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

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

onYourDataIntegratedVectorizationSource

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

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	يمثل المصادر المتوفرة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات.	Yes

onYourDataModelIdVectorizationSource

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

Name	Type	Description	Required	Default
model_id	string	تحديد معرف النموذج لاستخدامه في المتجهات. يجب تعريف معرف النموذج هذا في search service.	No
type	onYourDataVectorizationSourceType	يمثل المصادر المتوفرة Azure يمكن استخدام OpenAI على بياناتك لتكوين متجه البيانات للاستخدام مع البحث عن المتجهات.	Yes

azureChatExtensionsMessageContext

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

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

citation

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

Name	Type	Description	Required
chunk_id	string	معرف المجموعة للاقتباس.	No
content	string	محتوى الاقتباس.	Yes
filepath	string	مسار ملف الاقتباس.	No
rerank_score	number	درجة إعادة ترتيب المستند الذي تم استرداده.	No
title	string	عنوان الاقتباس.	No
url	string	عنوان URL للاقتباس.	No

retrievedDocument

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

Name	Type	Description	Required
chunk_id	string	معرف المجموعة للاقتباس.	No
content	string	محتوى الاقتباس.	Yes
data_source_index	integer	فهرس مصدر البيانات.	No
filepath	string	مسار ملف الاقتباس.	No
filter_reason	filterReason	سبب تصفية المستند الذي تم استرداده.	No
original_search_score	number	درجة البحث الأصلية للمستند الذي تم استرداده.	No
rerank_score	number	درجة إعادة ترتيب المستند الذي تم استرداده.	No
search_queries	array	استعلامات البحث المستخدمة لاسترداد المستند.	No
title	string	عنوان الاقتباس.	No
url	string	عنوان URL للاقتباس.	No

filterReason

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

Property	Value
Description	سبب تصفية المستند الذي تم استرداده.
Type	string
Values	`score` `rerank`

chatCompletionMessageToolCall

Name	Type	Description	Required
function	object	الدالة التي استدعاها النموذج.	Yes
└─ arguments	string	الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد يهلوس المعلمات التي لم يتم تعريفها بواسطة مخطط الدالة الخاص بك. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة.	No
└─ name	string	اسم الدالة التي يجب استدعاها.	No
id	string	معرف استدعاء الأداة.	Yes
type	toolCallType	نوع استدعاء الأداة، في هذه الحالة `function`.	Yes

toolCallType

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

Property	Value
Description	نوع استدعاء الأداة، في هذه الحالة `function`.
Type	string
Values	`function`

chatCompletionRequestMessageTool

Name	Type	Description	Required	Default
content	string	محتويات الرسالة.	No
tool_call_id	string	استدعاء الأداة الذي تستجيب له هذه الرسالة.	No

chatCompletionRequestMessageFunction

Name	Type	Description	Required
content	string	محتويات الرسالة.	No
name	string	محتويات الرسالة.	No
role	enum	دور كاتب الرسائل، في هذه الحالة `function`. القيم المحتملة: `function`	No

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

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

chatCompletionMessageToolCallChunk

Name	Type	Description	Required
function	object		No
└─ arguments	string	الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد يهلوس المعلمات التي لم يتم تعريفها بواسطة مخطط الدالة الخاص بك. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة.	No
└─ name	string	اسم الدالة التي يجب استدعاها.	No
id	string	معرف استدعاء الأداة.	No
index	integer		Yes
type	enum	نوع الأداة. حاليا، يتم دعم فقط `function` . القيم المحتملة: `function`	No

chatCompletionStreamOptions

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

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

chatCompletionChoiceLogProbs

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

Name	Type	Description	Required	Default
content	array	قائمة بالرموز المميزة لمحتوى الرسائل مع معلومات احتمال السجل.	Yes
refusal	array	قائمة بالرموز المميزة لرفض الرسائل مع معلومات احتمال السجل.	No

chatCompletionTokenLogprob

Name	Type	Description	Required
bytes	array	قائمة بالأعداد الصحيحة التي تمثل تمثيل UTF-8 بايت للرمز المميز. مفيد في الحالات التي يتم فيها تمثيل الأحرف بواسطة رموز مميزة متعددة وتمثيلات البايت الخاصة بها يجب دمجها لإنشاء تمثيل النص الصحيح. يمكن أن يكون `null` إذا لم يكن هناك تمثيل بايت للرمز المميز.	Yes
logprob	number	احتمال السجل لهذا الرمز المميز.	Yes
token	string	The token.	Yes
top_logprobs	array	قائمة بالرموز المميزة الأكثر احتمالا واحتمال سجلها، في موضع الرمز المميز هذا. في حالات نادرة، قد يكون هناك أقل من عدد الطلبات التي تم `top_logprobs` إرجاعها.	Yes

chatCompletionResponseMessage

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

Name	Type	Description	Required
audio	object	إذا تم طلب أسلوب إخراج الصوت، يحتوي هذا الكائن على بيانات حول الاستجابة الصوتية من النموذج.	No
└─ data	string	وحدات بايت الصوت المرمزة Base64 التي تم إنشاؤها بواسطة النموذج، بالتنسيق المحدد في الطلب.	No
└─ expires_at	integer	لن يعود من الممكن الوصول إلى الطابع الزمني Unix (بالثوان) عندما لا يمكن الوصول إلى استجابة الصوت هذه على الخادم لاستخدامها في المحادثات متعددة الأدوار.	No
└─ id	string	معرف فريد لاستجابة الصوت هذه.	No
└─ transcript	string	نسخة من الصوت الذي تم إنشاؤه بواسطة النموذج.	No
content	string	محتويات الرسالة.	Yes
context	azureChatExtensionsMessageContext	تمثيل لمعلومات السياق الإضافية المتوفرة عند مشاركة Azure ملحقات دردشة OpenAI في إنشاء استجابة إكمال الدردشة المقابلة. يتم ملء معلومات السياق هذه فقط عند استخدام طلب openAI Azure تم تكوينه لاستخدام ملحق مطابق.	No
function_call	chatCompletionFunctionCall	مهمل واستبدل ب `tool_calls`. اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج.	No
refusal	string	رسالة الرفض التي أنشأها النموذج.	Yes
role	chatCompletionResponseMessageRole	دور كاتب رسالة الاستجابة.	Yes
tool_calls	array	تستدعي الأداة التي تم إنشاؤها بواسطة النموذج، مثل استدعاءات الدالة.	No

chatCompletionResponseMessageRole

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

Property	Value
Description	دور كاتب رسالة الاستجابة.
Type	string
Values	`assistant`

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

chatCompletionNamedToolChoice

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

Name	Type	Description	Required
function	object		Yes
└─ name	string	اسم الدالة التي يجب استدعاها.	No
type	enum	نوع الأداة. حاليا، يتم دعم فقط `function` . القيم المحتملة: `function`	Yes

ParallelToolCalls

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

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

PredictionContent

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

Name	Type	Description	Required	Default
content	سلسلة أو مجموعة	المحتوى الذي يجب مطابقته عند إنشاء استجابة نموذج. إذا كانت الرموز المميزة التي تم إنشاؤها تطابق هذا المحتوى، يمكن إرجاع استجابة النموذج بالكامل بسرعة أكبر.	Yes
type	enum	نوع المحتوى المتوقع الذي تريد توفيره. هذا النوع هو دائما حاليا `content`. القيم المحتملة: `content`	Yes

chatCompletionMessageToolCalls

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

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

ChatCompletionModalities

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

["text"]

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

["text", "audio"]

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

chatCompletionFunctionCall

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

Name	Type	Description	Required	Default
arguments	string	الوسيطات التي سيتم استدعاء الدالة بها، كما تم إنشاؤها بواسطة النموذج بتنسيق JSON. لاحظ أن النموذج لا ينشئ دائما JSON صالحا، وقد يهلوس المعلمات التي لم يتم تعريفها بواسطة مخطط الدالة الخاص بك. تحقق من صحة الوسيطات في التعليمات البرمجية قبل استدعاء الدالة.	Yes
name	string	اسم الدالة التي يجب استدعاها.	Yes

completionUsage

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

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

chatCompletionTool

Name	Type	Description	Required	Default
function	FunctionObject		Yes
type	enum	نوع الأداة. حاليا، يتم دعم فقط `function` . القيم المحتملة: `function`	Yes

FunctionParameters

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

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

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

FunctionObject

Name	Type	Description	Required	Default
description	string	وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة.	No
name	string	اسم الدالة التي سيتم استدعاؤها. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64.	Yes
parameters	FunctionParameters	المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON. انظر إلى الدليل على سبيل المثال، ومرجع مخطط JSON للحصول على وثائق حول التنسيق. يحدد الحذف `parameters` دالة بقائمة معلمات فارغة.	No
strict	boolean	ما إذا كان سيتم تمكين الالتزام الصارم بالمخطط عند إنشاء استدعاء الدالة. إذا تم تعيينه إلى صحيح، فسيتبع النموذج المخطط الدقيق المحدد في `parameters` الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما `strict` تكون `true`.	No	False

ResponseFormatText

Name	Type	Description	Required	Default
type	enum	نوع تنسيق الاستجابة الذي يتم تعريفه: `text` القيم المحتملة: `text`	Yes

ResponseFormatJsonObject

Name	Type	Description	Required	Default
type	enum	نوع تنسيق الاستجابة الذي يتم تعريفه: `json_object` القيم المحتملة: `json_object`	Yes

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

Name	Type	Description	Required	Default
json_schema	object		Yes
└─ description	string	وصف لما هو تنسيق الاستجابة، يستخدمه النموذج لتحديد كيفية الاستجابة بالتنسيق.	No
└─ name	string	اسم تنسيق الاستجابة. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64.	No
└─ schema	ResponseFormatJsonSchemaSchema	مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON.	No
└─ strict	boolean	ما إذا كان سيتم تمكين الالتزام الصارم بالمخطط عند إنشاء الإخراج. إذا تم تعيينه إلى true، فسيتبع النموذج دائما المخطط الدقيق المحدد في `schema` الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما `strict` تكون `true`.	No	False
type	enum	نوع تنسيق الاستجابة الذي يتم تعريفه: `json_schema` القيم المحتملة: `json_schema`	Yes

chatCompletionChoiceCommon

Name	Type	Description	Required	Default
finish_reason	string		No
index	integer		No

createTranslationRequest

Translation request.

Name	Type	Description	Required	Default
file	string	الملف الصوتي المراد ترجمته.	Yes
prompt	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تكون المطالبة باللغة الإنجليزية.	No
response_format	audioResponseFormat	تعريف تنسيق الإخراج.	No
temperature	number	درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه على 0 ، يستخدم النموذج احتمالية السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى عتبات معينة.	No	0

audioResponse

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

Name	Type	Description	Required	Default
text	string	نص مترجم أو منسوخ.	Yes

audioVerboseResponse

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

Name	Type	Description	Required
duration	number	Duration.	No
language	string	Language.	No
segments	array		No
task	string	نوع مهمة الصوت.	No
text	string	نص مترجم أو منسوخ.	Yes
words	array		No

audioResponseFormat

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

Property	Value
Description	تعريف تنسيق الإخراج.
Type	string
Values	`json` `text` `srt` `verbose_json` `vtt`

createTranscriptionRequest

Transcription request.

Name	Type	Description	Required	Default
file	string	كائن الملف الصوتي المراد نسخه.	Yes
language	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 إلى تحسين الدقة وزمن الوصول.	No
prompt	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت.	No
response_format	audioResponseFormat	تعريف تنسيق الإخراج.	No
temperature	number	درجة حرارة أخذ العينات، بين 0 و1. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. إذا تم تعيينه على 0 ، يستخدم النموذج احتمالية السجل لزيادة درجة الحرارة تلقائيا حتى يتم الوصول إلى عتبات معينة.	No	0
timestamp_granularities[]	array	نقاوة الطابع الزمني التي يجب ملؤها لهذا النسخ. `response_format` يجب تعيين `verbose_json` لاستخدام نقاوة الطابع الزمني. يتم دعم أي من هذين الخيارين أو كليهما: `word`أو `segment`. ملاحظة: لا يوجد زمن انتقال إضافي للطوابع الزمنية للمقطع، ولكن إنشاء الطوابع الزمنية للكلمة يتطلب زمن انتقال إضافي.	No	['segment']

audioSegment

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

Name	Type	Description	Required
avg_logprob	number	متوسط احتمال السجل.	No
compression_ratio	number	Compression ratio.	No
end	number	إزاحة نهاية المقطع.	No
id	integer	Segment identifier.	No
no_speech_prob	number	احتمال "عدم الكلام".	No
seek	number	إزاحة المقطع.	No
start	number	إزاحة بدء المقطع.	No
temperature	number	Temperature.	No
text	string	Segment text.	No
tokens	array	الرموز المميزة للنص.	No

audioWord

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

Name	Type	Description	Required
end	number	إزاحة نهاية Word.	No
start	number	إزاحة بدء Word.	No
word	string	Word	No

createSpeechRequest

Speech request.

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

imageQuality

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

Property	Value
Description	جودة الصورة التي سيتم إنشاؤها.
Type	string
Default	auto
Values	`auto` `high` `medium` `low` `hd` `standard`

imagesResponseFormat

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

Property	Value
Description	التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها.
Type	string
Default	url
Values	`url` `b64_json`

imagesOutputFormat

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

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

imageSize

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

Property	Value
Description	حجم الصور التي تم إنشاؤها.
Type	string
Default	auto
Values	`auto` `1792x1024` `1024x1792` `1024x1024` `1024x1536` `1536x1024`

imageStyle

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

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

imageBackground

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

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

imageGenerationsRequest

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

imageEditsRequest

Name	Type	Description	Required	Default
image	سلسلة أو مجموعة	الصورة (الصور) المراد تحريرها. يجب أن يكون ملف صورة معتمدا أو صفيفا من الصور. يجب أن تكون كل صورة ملف png أو jpg أقل من 25 ميغابايت.	Yes
mask	string	صورة إضافية تشير مناطقها الشفافة بالكامل (على سبيل المثال، حيث ألفا صفر) إلى المكان الذي يجب تحرير الصورة فيه. إذا تم توفير صور متعددة، تطبيق القناع على الصورة الأولى. يجب أن يكون ملف PNG صالحا، أقل من 4 ميغابايت، وأن يكون له نفس أبعاد الصورة.	No
n	integer	عدد الصور المراد إنشاؤها.	No	1
prompt	string	وصف نصي للصورة (الصور) المطلوبة. الحد الأقصى للطول هو 32000 حرف.	Yes
quality	imageQuality	جودة الصورة التي سيتم إنشاؤها.	No	auto
response_format	imagesResponseFormat	التنسيق الذي يتم فيه إرجاع الصور التي تم إنشاؤها.	No	url
size	imageSize	حجم الصور التي تم إنشاؤها.	No	auto
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد في مراقبة إساءة الاستخدام واكتشافها.	No

generateImagesResponse

Name	Type	Description	Required
created	integer	الطابع الزمني unix عند إنشاء العملية.	Yes
data	array	بيانات نتيجة العملية، إذا نجحت	Yes
usage	imageGenerationsUsage	يمثل تفاصيل استخدام الرمز المميز لطلبات إنشاء الصور. فقط لنماذج سلسلة gpt-image-1.	No

imageResult

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

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

imageGenerationsUsage

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

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

line

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

Name	Type	Description	Required	Default
spans	array	صفيف من الامتدادات التي تمثل العناصر المكتشفة ومعلومات المربع المحيط بها.	Yes
text	string		Yes

span

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

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

runCompletionUsage

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

Name	Type	Description	Required
completion_tokens	integer	عدد رموز الإكمال المميزة المستخدمة على مدار التشغيل.	Yes
prompt_tokens	integer	عدد الرموز المميزة للمطالبة المستخدمة على مدار التشغيل.	Yes
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة (المطالبة + الإكمال).	Yes

runStepCompletionUsage

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

Name	Type	Description	Required
completion_tokens	integer	عدد رموز الإكمال المميزة المستخدمة على مدار خطوة التشغيل.	Yes
prompt_tokens	integer	عدد الرموز المميزة للمطالبة المستخدمة على مدار خطوة التشغيل.	Yes
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة (المطالبة + الإكمال).	Yes

assistantsApiResponseFormatOption

تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ gpt-3.5-turbo-1106.

الإعداد لتمكين { "type": "json_schema", "json_schema": {...} } المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة.

إعداد لتمكين { "type": "json_object" } وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة.

هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، finish_reason="length"مما يشير إلى تجاوز max_tokens الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.

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

ResponseFormatText
ResponseFormatJsonObject
ResponseFormatJsonSchema

assistantsApiResponseFormat

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

Name	Type	Description	Required	Default
type	string	يجب أن يكون أحد `text` أو `json_object`.	No	text

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

Value	Description
text
json_object

assistantObject

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

Name	Type	Description	Required	Default
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء المساعد.	Yes
description	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	Yes
id	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	Yes
instructions	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 256000 حرف.	Yes
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	Yes
model	string	معرف النموذج المراد استخدامه.	Yes
name	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	Yes
object	string	نوع الكائن، الذي يتم `assistant`دائما .	Yes
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	No
└─ code_interpreter	object		No
└─ file_ids	array	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	معرف مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
tools	array	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `file_search`أو `function`.	Yes	[]
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1

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

Value	Description
assistant	نوع الكائن، وهو مساعد دائما

createAssistantRequest

Name	Type	Description	Required	Default
description	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	No
instructions	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 256000 حرف.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	No
model	string		Yes
name	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	No
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	No
└─ code_interpreter	object		No
└─ file_ids	array	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
└─ vector_stores	array	مساعد لإنشاء مخزن متجهات باستخدام file_ids وإرفاقه بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
tools	array	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `retrieval`أو `function`.	No	[]
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1

modifyAssistantRequest

Name	Type	Description	Required	Default
description	string	وصف المساعد. الحد الأقصى للطول هو 512 حرفا.	No
instructions	string	إرشادات النظام التي يستخدمها المساعد. الحد الأقصى للطول هو 32768 حرفا.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	No
model	string		No
name	string	اسم المساعد. الحد الأقصى للطول هو 256 حرفا.	No
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	No
└─ code_interpreter	object		No
└─ file_ids	array	يتجاوز قائمة معرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	يتجاوز مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
tools	array	قائمة بالأدوات الممكنة على المساعد. يمكن أن يكون هناك 128 أداة كحد أقصى لكل مساعد. يمكن أن تكون الأدوات من أنواع `code_interpreter`أو `retrieval`أو `function`.	No	[]
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1

deleteAssistantResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

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

Value	Description
assistant.deleted

listAssistantsResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

assistantToolsCode

Name	Type	Description	Required	Default
type	string	نوع الأداة التي يتم تعريفها: `code_interpreter`	Yes

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

Value	Description
code_interpreter

assistantToolsFileSearch

Name	Type	Description	Required
file_search	object	تجاوز أداة البحث عن الملفات.	No
└─ max_num_results	integer	الحد الأقصى لعدد النتائج التي يجب أن تنتجها أداة البحث عن الملفات. الإعداد الافتراضي هو 20 لنماذج gpt-4* و5 ل gpt-3.5-turbo. يجب أن يتراوح هذا الرقم بين 1 و50 ضمنا. لاحظ أن أداة البحث عن الملفات قد تنتج أقل من `max_num_results` النتائج.	No
type	string	نوع الأداة التي يتم تعريفها: `file_search`	Yes

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

Value	Description
file_search

assistantToolsFileSearchTypeOnly

Name	Type	Description	Required	Default
type	string	نوع الأداة التي يتم تعريفها: `file_search`	Yes

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

Value	Description
file_search

assistantToolsFunction

Name	Type	Description	Required
function	object	تعريف الدالة.	Yes
└─ description	string	وصف لما تقوم به الدالة، يستخدمه النموذج لاختيار وقت وكيفية استدعاء الدالة.	No
└─ name	string	اسم الدالة التي سيتم استدعاؤها. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64.	No
└─ parameters	chatCompletionFunctionParameters	المعلمات التي تقبلها الوظائف، الموضحة كعنصر مخطط JSON. راجع guide/ للحصول على أمثلة، ومرجع مخطط JSON للحصول على وثائق حول التنسيق.	No
type	string	نوع الأداة التي يتم تعريفها: `function`	Yes

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

Value	Description
function

truncationObject

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

Name	Type	Description	Required	Default
last_messages	integer	عدد أحدث الرسائل من مؤشر الترابط عند إنشاء سياق التشغيل.	No
type	string	استراتيجية الاقتطاع لاستخدامها في مؤشر الترابط. الافتراضي هو `auto`. إذا تم تعيينه إلى `last_messages`، اقتطاع مؤشر الترابط إلى الرسائل الأخيرة n في مؤشر الترابط. عند التعيين إلى `auto`، سيتم إسقاط الرسائل الموجودة في منتصف مؤشر الترابط لاحتواء طول سياق النموذج، `max_prompt_tokens`.	Yes

نوع قائمة التعداد: TruncationType

Value	Description
auto
last_messages

assistantsApiToolChoiceOption

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

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

assistantsNamedToolChoice

assistantsNamedToolChoice

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

Name	Type	Description	Required
function	object		No
└─ name	string	اسم الدالة التي يجب استدعاها.	No
type	string	نوع الأداة. إذا كان النوع هو `function`، يجب تعيين اسم الدالة	Yes

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

Value	Description
function
code_interpreter
file_search

runObject

يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.

Name	Type	Description	Required	Default
assistant_id	string	معرف المساعد المستخدم لتنفيذ هذا التشغيل.	Yes
cancelled_at	integer	الطابع الزمني Unix (بالثوان) لوقت إلغاء التشغيل.	Yes
completed_at	integer	الطابع الزمني Unix (بالثوان) لوقت اكتمال التشغيل.	Yes
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء التشغيل.	Yes
expires_at	integer	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية التشغيل.	Yes
failed_at	integer	الطابع الزمني Unix (بالثوان) لوقت فشل التشغيل.	Yes
id	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	Yes
incomplete_details	object	تفاصيل حول سبب عدم اكتمال التشغيل. سيكون `null` إذا لم يكن التشغيل غير مكتمل.	Yes
└─ reason	string	سبب عدم اكتمال التشغيل. سيشير هذا إلى حد الرمز المميز المحدد الذي تم الوصول إليه على مدار التشغيل.	No
instructions	string	الإرشادات التي استخدمها المساعد لهذا التشغيل.	Yes
last_error	object	الخطأ الأخير المقترن بهذا التشغيل. سيتم `null` إذا لم تكن هناك أخطاء.	Yes
└─ code	string	أحد `server_error` أو `rate_limit_exceeded`.	No
└─ message	string	وصف يمكن للإنسان قراءته للخطأ.	No
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة المحددة لاستخدامها على مدار التشغيل.	Yes
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة المحددة لاستخدامها على مدار التشغيل.	Yes
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	Yes
model	string	النموذج الذي استخدمه المساعد لهذا التشغيل.	Yes
object	string	نوع الكائن، الذي يتم `thread.run`دائما .	Yes
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	No	True
required_action	object	تفاصيل حول الإجراء المطلوب لمتابعة التشغيل. سيكون `null` إذا لم يكن هناك أي إجراء مطلوب.	Yes
└─ submit_tool_outputs	object	تفاصيل حول مخرجات الأداة اللازمة لمتابعة هذا التشغيل.	No
└─ tool_calls	array	قائمة باستدعاءات الأدوات ذات الصلة.	No
└─ type	enum	في الوقت الحالي، هذا هو دائما `submit_tool_outputs`. القيم المحتملة: `submit_tool_outputs`	No
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	Yes
started_at	integer	الطابع الزمني Unix (بالثوان) لوقت بدء التشغيل.	Yes
status	string	حالة التشغيل، والتي يمكن أن تكون إما `queued`أو `in_progress`أو `requires_action`أو `cancellingcancelledfailedcompleted`.`expired`	Yes
temperature	number	درجة حرارة أخذ العينات المستخدمة لهذا التشغيل. إذا لم يتم تعيينه، تعيينه افتراضيا إلى 1.	No
thread_id	string	معرف مؤشرات الترابط التي تم تنفيذها كجزء من هذا التشغيل.	Yes
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	Yes
tools	array	قائمة الأدوات التي استخدمها المساعد لهذا التشغيل.	Yes	[]
top_p	number	قيمة أخذ عينات النواة المستخدمة لهذا التشغيل. إذا لم يتم تعيينه، تعيينه افتراضيا إلى 1.	No
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	Yes
usage	runCompletionUsage	إحصائيات الاستخدام المتعلقة بالتشغيل. ستكون `null` هذه القيمة إذا لم يكن التشغيل في حالة طرفية (مثل `in_progress`، ، `queued`وما إلى ذلك).	Yes

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

Value	Description
thread.run	نوع كائن التشغيل الذي يكون دائما thread.run

قائمة تعداد الحالة: RunObjectStatus

Value	Description
queued	الحالة في قائمة الانتظار
in_progress	الحالة in_progress
requires_action	الحالة required_action
cancelling	حالة الإلغاء
cancelled	الحالة الملغاة
failed	الحالة الفاشلة
completed	الحالة المكتملة
expired	الحالة منتهية الصلاحية

createRunRequest

Name	Type	Description	Required	Default
additional_instructions	string	إلحاق إرشادات إضافية في نهاية التعليمات الخاصة بالتشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل دون تجاوز إرشادات أخرى.	No
additional_messages	array	إضافة رسائل إضافية إلى مؤشر الترابط قبل إنشاء التشغيل.	No
assistant_id	string	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.	Yes
instructions	string	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	No
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد رموز الإكمال المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	No
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد الرموز المميزة السريعة المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	No
model	string	معرف النموذج الذي سيتم استخدامه لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	No
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	No	True
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
stream	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	No
tools	array	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	No
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	No

listRunsResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

modifyRunRequest

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

submitToolOutputsRunRequest

Name	Type	Description	Required	Default
stream	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	No
tool_outputs	array	قائمة بالأدوات التي يتم إرسال المخرجات لها.	Yes

runToolCallObject

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

Name	Type	Description	Required
function	object	تعريف الدالة.	Yes
└─ arguments	string	الوسيطات التي يتوقع منك النموذج تمريرها إلى الدالة .	No
└─ name	string	اسم الدالة	No
id	string	معرف استدعاء الأداة. يجب الرجوع إلى هذا المعرف عند إرسال مخرجات الأداة باستخدام مخرجات أداة الإرسال لتشغيل نقطة نهاية نقطة النهاية.	Yes
type	string	نوع استدعاء الأداة مطلوب للإخراج. في الوقت الحالي، هذا هو دائما `function`.	Yes

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

Value	Description
function

createThreadAndRunRequest

Name	Type	Description	Required	Default
assistant_id	string	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.	Yes
instructions	string	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	No
max_completion_tokens	integer	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد رموز الإكمال المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	No
max_prompt_tokens	integer	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. يبذل التشغيل قصارى جهده لاستخدام عدد الرموز المميزة السريعة المحددة فقط، عبر منعطفات متعددة من التشغيل. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة `incomplete`. راجع `incomplete_details` لمزيد من المعلومات.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	No
model	string	معرف النماذج التي سيتم استخدامها لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فستتجاوز النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، استخدام النموذج المقترن بالمساعد.	No
parallel_tool_calls	ParallelToolCalls	ما إذا كان يجب تمكين استدعاء الدالة المتوازية أثناء استخدام الأداة.	No	True
response_format	assistantsApiResponseFormatOption	تحديد التنسيق الذي يجب على النموذج إخراجه. متوافق مع GPT-4o وGPT-4 Turbo وجميع نماذج GPT-3.5 Turbo منذ `gpt-3.5-turbo-1106`. الإعداد لتمكين `{ "type": "json_schema", "json_schema": {...} }` المخرجات المنظمة التي تضمن تطابق النموذج مع مخطط JSON المقدم. تعرف على المزيد في دليل الإخراجات المنظمة. إعداد لتمكين `{ "type": "json_object" }` وضع JSON، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. هام: عند استخدام وضع JSON، يجب عليك أيضا إرشاد النموذج لإنتاج JSON بنفسك عبر نظام أو رسالة مستخدم. بدون ذلك، قد ينشئ النموذج دفقا لا ينتهي من المسافة البيضاء حتى يصل الجيل إلى حد الرمز المميز، ما يؤدي إلى طلب طويل الأمد ويبدو أنه "عالق". لاحظ أيضا أنه قد يتم قطع محتوى الرسالة جزئيا إذا ، `finish_reason="length"`مما يشير إلى تجاوز `max_tokens` الجيل أو تجاوز المحادثة الحد الأقصى لطول السياق.	No
stream	boolean	إذا `true`، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة `data: [DONE]`.	No
stream_options	chatCompletionStreamOptions	خيارات الاستجابة المتدفقة. اضبط هذا فقط عند تعيين `stream: true`.	No	None
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.	No	1
thread	createThreadRequest		No
tool_choice	assistantsApiToolChoiceOption	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.	No
tool_resources	object	مجموعة من الموارد التي تستخدمها أدوات المساعد. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	No
└─ code_interpreter	object		No
└─ file_ids	array	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	معرف مخزن المتجهات المرفق بهذا المساعد. يمكن أن يكون هناك مخزن متجهات مرفق بالمساعد بحد أقصى.	No
tools	array	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.	No
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.	No	1
truncation_strategy	truncationObject	عناصر التحكم في كيفية اقتطاع مؤشر ترابط قبل التشغيل. استخدم هذا للتحكم في نافذة السياق الأولية للتشغيل.	No

threadObject

يمثل مؤشر ترابط يحتوي على رسائل.

Name	Type	Description	Required	Default
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء مؤشر الترابط.	Yes
id	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	Yes
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	Yes
object	string	نوع الكائن، الذي يتم `thread`دائما .	Yes
tool_resources	object	مجموعة من الموارد المتوفرة لأدوات المساعد في مؤشر الترابط هذا. الموارد خاصة بنوع الأداة. على سبيل المثال، تتطلب أداة `code_interpreter` قائمة بمعرفات الملفات، بينما تتطلب أداة `file_search` قائمة بمعرفات مخزن المتجهات.	Yes
└─ code_interpreter	object		No
└─ file_ids	array	قائمة بمعرفات الملفات المتوفرة لأداة `code_interpreter`. يمكن أن يكون هناك بحد أقصى 20 ملفا مقترنا بالأداة.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	مخزن المتجهات المرفق بسلسلة الرسائل هذه. يمكن أن يكون هناك مخزن متجه 1 كحد أقصى مرفق بسلسلة الرسائل.	No

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

Value	Description
thread	نوع كائن مؤشر الترابط الذي يكون دائما `thread`

createThreadRequest

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

modifyThreadRequest

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

deleteThreadResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

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

Value	Description
thread.deleted	حالة كائن استجابة مؤشر الترابط الحذف وهي `thread.deleted`

listThreadsResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

messageObject

يمثل رسالة داخل مؤشرات ترابط.

Name	Type	Description	Required
assistant_id	string	إذا كان ذلك ممكنا، معرف المساعد الذي قام بتأليف هذه الرسالة.	Yes
attachments	array	قائمة بالملفات المرفقة بالرسالة والأدوات التي تمت إضافتها إليها.	Yes
completed_at	integer	الطابع الزمني Unix (بالثوان) لوقت اكتمال الرسالة.	Yes
content	array	محتوى الرسالة في صفيف من النص و/أو الصور.	Yes
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء الرسالة.	Yes
id	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	Yes
incomplete_at	integer	الطابع الزمني Unix (بالثوان) لوقت وضع علامة على الرسالة على أنها غير مكتملة.	Yes
incomplete_details	object	في رسالة غير مكتملة، تفاصيل حول سبب عدم اكتمال الرسالة.	Yes
└─ reason	string	سبب عدم اكتمال الرسالة.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	Yes
object	string	نوع الكائن، الذي يتم `thread.message`دائما .	Yes
role	string	الكيان الذي أنتج الرسالة. أحد `user` أو `assistant`.	Yes
run_id	string	إذا كان ذلك ممكنا، معرف التشغيل المقترن بتأليف هذه الرسالة.	Yes
status	string	حالة الرسالة، والتي يمكن أن تكون إما `in_progress`أو `incomplete`أو `completed`.	Yes
thread_id	string	معرف مؤشرات الترابط التي تنتمي إليها هذه الرسالة.	Yes

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

Value	Description
thread.message	نوع كائن الرسالة الذي هو `thread.message`

قائمة تعداد الحالة: MessageObjectStatus

Value	Description
in_progress
incomplete
completed

قائمة تعداد الدور: MessageObjectRole

Value	Description
user
assistant

messageDeltaObject

يمثل دلتا رسالة، أي أي حقول تم تغييرها في رسالة أثناء البث.

Name	Type	Description	Required
delta	object	دلتا تحتوي على الحقول التي تم تغييرها في الرسالة.	Yes
└─ content	array	محتوى الرسالة في صفيف من النص و/أو الصور.	No
└─ role	string	الكيان الذي أنتج الرسالة. أحد `user` أو `assistant`.	No
id	string	معرف الرسالة، والذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	Yes
object	string	نوع الكائن، الذي يتم `thread.message.delta`دائما .	Yes

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

Value	Description
thread.message.delta

createMessageRequest

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

قائمة تعداد الدور: CreateMessageRequestRole

Value	Description
user
assistant

modifyMessageRequest

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

deleteMessageResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

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

Value	Description
thread.message.deleted	حالة كائن استجابة رسالة الحذف

listMessagesResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

messageContentImageFileObject

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

Name	Type	Description	Required
image_file	object		Yes
└─ file_id	string	معرف الملف للصورة في محتوى الرسالة.	No
type	string	دائمًا `image_file`.	Yes

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

Value	Description
image_file	نوع ملف صورة محتوى الرسالة

messageContentTextObject

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

Name	Type	Description	Required
text	object		Yes
└─ annotations	array		No
└─ value	string	البيانات التي تشكل النص.	No
type	string	دائمًا `text`.	Yes

نوع قائمة تعداد: messageContentTextObjectType

Value	Description
text	نوع كائن نص محتوى الرسالة

messageContentTextAnnotationsFileCitationObject

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

Name	Type	Description	Required
end_index	integer		Yes
file_citation	object		Yes
└─ file_id	string	معرف الملف المحدد الذي يتم الاقتباس منه.	No
start_index	integer		Yes
text	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	Yes
type	string	دائمًا `file_citation`.	Yes

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

Value	Description
file_citation	نوع كائن اقتباس الملف

messageContentTextAnnotationsFilePathObject

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

Name	Type	Description	Required
end_index	integer		Yes
file_path	object		Yes
└─ file_id	string	معرف الملف الذي تم إنشاؤه.	No
start_index	integer		Yes
text	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	Yes
type	string	دائمًا `file_path`.	Yes

نوع قائمة التعداد: FilePathObjectType

Value	Description
file_path	نوع كائن مسار الملف

messageDeltaContentImageFileObject

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

Name	Type	Description	Required
image_file	object		No
└─ file_id	string	معرف الملف للصورة في محتوى الرسالة.	No
index	integer	فهرس جزء المحتوى في الرسالة.	Yes
type	string	دائمًا `image_file`.	Yes

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

Value	Description
image_file

messageDeltaContentTextObject

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

Name	Type	Description	Required
index	integer	فهرس جزء المحتوى في الرسالة.	Yes
text	object		No
└─ annotations	array		No
└─ value	string	البيانات التي تشكل النص.	No
type	string	دائمًا `text`.	Yes

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

Value	Description
text

messageDeltaContentTextAnnotationsFileCitationObject

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

Name	Type	Description	Required
end_index	integer		No
file_citation	object		No
└─ file_id	string	معرف الملف المحدد الذي يتم الاقتباس منه.	No
└─ quote	string	عرض الأسعار المحدد في الملف.	No
index	integer	فهرس التعليق التوضيحي في جزء محتوى النص.	Yes
start_index	integer		No
text	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	No
type	string	دائمًا `file_citation`.	Yes

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

Value	Description
file_citation

messageDeltaContentTextAnnotationsFilePathObject

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

Name	Type	Description	Required
end_index	integer		No
file_path	object		No
└─ file_id	string	معرف الملف الذي تم إنشاؤه.	No
index	integer	فهرس التعليق التوضيحي في جزء محتوى النص.	Yes
start_index	integer		No
text	string	النص الموجود في محتوى الرسالة الذي يجب استبداله.	No
type	string	دائمًا `file_path`.	Yes

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

Value	Description
file_path

runStepObject

يمثل خطوة في تنفيذ تشغيل.

Name	Type	Description	Required
assistant_id	string	معرف المساعد المقترن بخطوة التشغيل.	Yes
cancelled_at	integer	الطابع الزمني Unix (بالثوان) لوقت إلغاء خطوة التشغيل.	Yes
completed_at	integer	الطابع الزمني Unix (بالثوان) عند اكتمال خطوة التشغيل.	Yes
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء خطوة التشغيل.	Yes
expired_at	integer	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية خطوة التشغيل. تعتبر الخطوة منتهية الصلاحية إذا انتهت صلاحية التشغيل الأصل.	Yes
failed_at	integer	الطابع الزمني Unix (بالثوان) لوقت فشل خطوة التشغيل.	Yes
id	string	معرف خطوة التشغيل، والتي يمكن الرجوع إليها في نقاط نهاية واجهة برمجة التطبيقات.	Yes
last_error	object	الخطأ الأخير المقترن بخطوة التشغيل هذه. سيتم `null` إذا لم تكن هناك أخطاء.	Yes
└─ code	string	أحد `server_error` أو `rate_limit_exceeded`.	No
└─ message	string	وصف يمكن للإنسان قراءته للخطأ.	No
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	Yes
object	string	نوع الكائن، الذي يتم `assistant.run.step`دائما .	Yes
run_id	string	معرف التشغيل الذي تعد خطوة التشغيل هذه جزءا منه.	Yes
status	string	حالة التشغيل، والتي يمكن أن تكون إما `in_progress`أو `cancelledfailedcompleted`.`expired`	Yes
step_details	runStepDetailsMessageCreationObject أو runStepDetailsToolCallsObject	تفاصيل خطوة التشغيل.	Yes
thread_id	string	معرف مؤشرات الترابط التي تم تشغيلها.	Yes
type	string	نوع خطوة التشغيل، والتي يمكن أن تكون إما `message_creation` أو `tool_calls`.	Yes

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

Value	Description
assistant.run.step	نوع الكائن، الذي يكون دائما `assistant.run.step`

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

Value	Description
message_creation	خطوة تشغيل message_creation
tool_calls	خطوة تشغيل tool_calls

قائمة تعداد الحالة: RunStepObjectStatus

Value	Description
in_progress	حالة تشغيل in_progress
cancelled	حالة التشغيل الملغاة
failed	حالة التشغيل الملغاة
completed	حالة التشغيل الملغاة
expired	حالة التشغيل الملغاة

runStepDeltaObject

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

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

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

Value	Description
thread.run.step.delta

listRunStepsResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

runStepDetailsMessageCreationObject

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

Name	Type	Description	Required
message_creation	object		Yes
└─ message_id	string	معرف الرسالة التي تم إنشاؤها بواسطة خطوة التشغيل هذه.	No
type	string	دائمًا `message_creation`.	Yes

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

Value	Description
message_creation

runStepDeltaStepDetailsMessageCreationObject

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

Name	Type	Description	Required
message_creation	object		No
└─ message_id	string	معرف الرسالة التي تم إنشاؤها بواسطة خطوة التشغيل هذه.	No
type	string	دائمًا `message_creation`.	Yes

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

Value	Description
message_creation

runStepDetailsToolCallsObject

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

Name	Type	Description	Required	Default
tool_calls	array	مجموعة من الأدوات تستدعي خطوة التشغيل التي شاركت فيها. يمكن إقران هذه بإحدى الأنواع الثلاثة من الأدوات: `code_interpreter`أو `retrieval` .`function`	Yes
type	string	دائمًا `tool_calls`.	Yes

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

Value	Description
tool_calls

runStepDeltaStepDetailsToolCallsObject

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

Name	Type	Description	Required	Default
tool_calls	array	مجموعة من الأدوات تستدعي خطوة التشغيل التي شاركت فيها. يمكن إقران هذه بإحدى الأنواع الثلاثة من الأدوات: `code_interpreter`أو `file_search` .`function`	No
type	string	دائمًا `tool_calls`.	Yes

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

Value	Description
tool_calls

runStepDetailsToolCallsCodeObject

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

Name	Type	Description	Required
code_interpreter	object	تعريف استدعاء أداة مترجم التعليمات البرمجية.	Yes
└─ input	string	الإدخال إلى استدعاء أداة مترجم التعليمات البرمجية.	No
└─ outputs	array	المخرجات من استدعاء أداة مترجم التعليمات البرمجية. يمكن لمترجم التعليمات البرمجية إخراج عنصر واحد أو أكثر، بما في ذلك النص (`logs`) أو الصور (`image`). يتم تمثيل كل من هذه بواسطة نوع كائن مختلف.	No
id	string	معرف استدعاء الأداة.	Yes
type	string	نوع استدعاء الأداة. سيكون هذا دائما `code_interpreter` لهذا النوع من استدعاء الأدوات.	Yes

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

Value	Description
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

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

Name	Type	Description	Required
code_interpreter	object	تعريف استدعاء أداة مترجم التعليمات البرمجية.	No
└─ input	string	الإدخال إلى استدعاء أداة مترجم التعليمات البرمجية.	No
└─ outputs	array	المخرجات من استدعاء أداة مترجم التعليمات البرمجية. يمكن لمترجم التعليمات البرمجية إخراج عنصر واحد أو أكثر، بما في ذلك النص (`logs`) أو الصور (`image`). يتم تمثيل كل من هذه بواسطة نوع كائن مختلف.	No
id	string	معرف استدعاء الأداة.	No
index	integer	يستدعي فهرس استدعاء الأداة في صفيف الأدوات.	Yes
type	string	نوع استدعاء الأداة. سيكون هذا دائما `code_interpreter` لهذا النوع من استدعاء الأدوات.	Yes

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

Value	Description
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

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

Name	Type	Description	Required	Default
logs	string	إخراج النص من استدعاء أداة مترجم التعليمات البرمجية.	Yes
type	string	دائمًا `logs`.	Yes

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

Value	Description
logs

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

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

Name	Type	Description	Required
index	integer	فهرس الإخراج في صفيف المخرجات.	Yes
logs	string	إخراج النص من استدعاء أداة مترجم التعليمات البرمجية.	No
type	string	دائمًا `logs`.	Yes

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

Value	Description
logs

runStepDetailsToolCallsCodeOutputImageObject

Name	Type	Description	Required
image	object		Yes
└─ file_id	string	معرف الملف للصورة.	No
type	string	دائمًا `image`.	Yes

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

Value	Description
image

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Name	Type	Description	Required
image	object		No
└─ file_id	string	معرف الملف للصورة.	No
index	integer	فهرس الإخراج في صفيف المخرجات.	Yes
type	string	دائمًا `image`.	Yes

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

Value	Description
image

runStepDetailsToolCallsFileSearchObject

Name	Type	Description	Required
file_search	object	في الوقت الحالي، سيكون هذا دائما كائنا فارغا.	Yes
└─ results	array	نتائج البحث في الملفات.	No
id	string	معرف كائن استدعاء الأداة.	Yes
type	string	نوع استدعاء الأداة. سيكون هذا دائما `file_search` لهذا النوع من استدعاء الأدوات.	Yes

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

Value	Description
file_search

runStepDetailsToolCallsFileSearchResultObject

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

Name	Type	Description	Required
content	array	محتوى النتيجة التي تم العثور عليها. يتم تضمين المحتوى فقط إذا طلب عبر معلمة تضمين الاستعلام.	No
file_id	string	معرف الملف الذي تم العثور على النتيجة فيه.	Yes
file_name	string	اسم الملف الذي تم العثور على النتيجة فيه.	Yes
score	number	درجة النتيجة. يجب أن تكون كافة القيم رقم فاصلة عائمة بين 0 و1.	Yes

runStepDeltaStepDetailsToolCallsFileSearchObject

Name	Type	Description	Required
file_search	object	في الوقت الحالي، سيكون هذا دائما كائنا فارغا.	Yes
id	string	معرف كائن استدعاء الأداة.	No
index	integer	يستدعي فهرس استدعاء الأداة في صفيف الأدوات.	Yes
type	string	نوع استدعاء الأداة. سيكون هذا دائما `retrieval` لهذا النوع من استدعاء الأدوات.	Yes

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

Value	Description
file_search

runStepDetailsToolCallsFunctionObject

Name	Type	Description	Required
function	object	تعريف الدالة التي تم استدعاؤها.	Yes
└─ arguments	string	الوسيطات التي تم تمريرها إلى الدالة .	No
└─ name	string	اسم الدالة	No
└─ output	string	إخراج الدالة. سيكون `null` هذا إذا لم يتم إرسال المخرجات بعد.	No
id	string	معرف كائن استدعاء الأداة.	Yes
type	string	نوع استدعاء الأداة. سيكون هذا دائما `function` لهذا النوع من استدعاء الأدوات.	Yes

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

Value	Description
function

runStepDeltaStepDetailsToolCallsFunctionObject

Name	Type	Description	Required
function	object	تعريف الدالة التي تم استدعاؤها.	No
└─ arguments	string	الوسيطات التي تم تمريرها إلى الدالة .	No
└─ name	string	اسم الدالة	No
└─ output	string	إخراج الدالة. سيكون `null` هذا إذا لم يتم إرسال المخرجات بعد.	No
id	string	معرف كائن استدعاء الأداة.	No
index	integer	يستدعي فهرس استدعاء الأداة في صفيف الأدوات.	Yes
type	string	نوع استدعاء الأداة. سيكون هذا دائما `function` لهذا النوع من استدعاء الأدوات.	Yes

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

Value	Description
function

vectorStoreExpirationAfter

نهج انتهاء الصلاحية لمخزن المتجهات.

Name	Type	Description	Required	Default
anchor	string	الطابع الزمني للارتساء الذي يتم بعده تطبيق نهج انتهاء الصلاحية. نقاط الارتساء المدعومة: `last_active_at`.	Yes
days	integer	عدد الأيام بعد وقت الارتساء الذي ستنتهي فيه صلاحية مخزن المتجهات.	Yes

قائمة تعداد الارتساء: VectorStoreExpirationAfterAnchor

Value	Description
last_active_at	الطابع الزمني للارتساء الذي يتم بعده تطبيق نهج انتهاء الصلاحية.

vectorStoreObject

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

Name	Type	Description	Required
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء مخزن المتجهات.	Yes
expires_after	vectorStoreExpirationAfter	نهج انتهاء الصلاحية لمخزن المتجهات.	No
expires_at	integer	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية مخزن المتجهات.	No
file_counts	object		Yes
└─ cancelled	integer	عدد الملفات التي تم إلغاؤها.	No
└─ completed	integer	عدد الملفات التي تمت معالجتها بنجاح.	No
└─ failed	integer	عدد الملفات التي فشلت في معالجتها.	No
└─ in_progress	integer	عدد الملفات التي تتم معالجتها حاليا.	No
└─ total	integer	العدد الإجمالي للملفات.	No
id	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	Yes
last_active_at	integer	الطابع الزمني Unix (بالثوان) لوقت آخر نشاط لمخزن المتجهات.	Yes
metadata	object	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.	Yes
name	string	اسم مخزن المتجهات.	Yes
object	enum	نوع الكائن، الذي يتم `vector_store`دائما . القيم المحتملة: `vector_store`	Yes
status	string	حالة مخزن المتجهات، والتي يمكن أن تكون إما `expired`أو `in_progress`أو `completed`. تشير حالة `completed` إلى أن مخزن المتجهات جاهز للاستخدام.	Yes
usage_bytes	integer	إجمالي عدد وحدات البايت المستخدمة من قبل الملفات في مخزن المتجهات.	Yes

قائمة تعداد الحالة: VectorStoreObjectStatus

Value	Description
expired
in_progress
completed

createVectorStoreRequest

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

updateVectorStoreRequest

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

listVectorStoresResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

deleteVectorStoreResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

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

Value	Description
vector_store.deleted	حالة كائن استجابة مخزن متجه الحذف

vectorStoreFileObject

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

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

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

Value	Description
vector_store.file

قائمة تعداد الحالة: VectorStoreFileObjectStatus

Value	Description
in_progress
completed
cancelled
failed

otherChunkingStrategyResponseParam

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

Name	Type	Description	Required	Default
type	string	دائمًا `other`.	Yes

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

Value	Description
other

staticChunkingStrategyResponseParam

Name	Type	Description	Required	Default
static	staticChunkingStrategy		Yes
type	string	دائمًا `static`.	Yes

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

Value	Description
static

staticChunkingStrategy

Name	Type	Description	Required	Default
chunk_overlap_tokens	integer	عدد الرموز المميزة التي تتداخل بين المجموعات. القيمة الافتراضية هي `400`. لاحظ أن التداخل يجب ألا يتجاوز نصف `max_chunk_size_tokens`.	Yes
max_chunk_size_tokens	integer	الحد الأقصى لعدد الرموز المميزة في كل مجموعة. القيمة الافتراضية هي `800`. الحد الأدنى للقيمة هو `100` والحد الأقصى للقيمة هو `4096`.	Yes

autoChunkingStrategyRequestParam

الاستراتيجية الافتراضية. تستخدم هذه الاستراتيجية حاليا من max_chunk_size_tokens800 و chunk_overlap_tokens من 400.

Name	Type	Description	Required	Default
type	enum	دائمًا `auto`. القيم المحتملة: `auto`	Yes

staticChunkingStrategyRequestParam

Name	Type	Description	Required	Default
static	staticChunkingStrategy		Yes
type	enum	دائمًا `static`. القيم المحتملة: `static`	Yes

chunkingStrategyRequestParam

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

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

autoChunkingStrategyRequestParam
staticChunkingStrategyRequestParam

createVectorStoreFileRequest

Name	Type	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` .	No
file_id	string	معرف ملف يجب أن يستخدمه مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	Yes

listVectorStoreFilesResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

deleteVectorStoreFileResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

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

Value	Description
vector_store.file.deleted

vectorStoreFileBatchObject

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

Name	Type	Description	Required
created_at	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء دفعة ملفات مخزن المتجهات.	Yes
file_counts	object		Yes
└─ cancelled	integer	عدد الملفات التي تم إلغاؤها.	No
└─ completed	integer	عدد الملفات التي تمت معالجتها.	No
└─ failed	integer	عدد الملفات التي فشلت في معالجتها.	No
└─ in_progress	integer	عدد الملفات التي تتم معالجتها حاليا.	No
└─ total	integer	العدد الإجمالي للملفات.	No
id	string	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.	Yes
object	string	نوع الكائن، الذي يتم `vector_store.file_batch`دائما .	Yes
status	string	حالة دفعة ملفات مخزن المتجهات، والتي يمكن أن تكون إما `in_progress`أو `completed`أو `cancelled` أو `failed`.	Yes
vector_store_id	string	معرف مخزن المتجهات الذي يتم إرفاق الملف به.	Yes

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

Value	Description
vector_store.files_batch

قائمة تعداد الحالة: VectorStoreFileBatchObjectStatus

Value	Description
in_progress
completed
cancelled
failed

createVectorStoreFileBatchRequest

Name	Type	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	تستخدم استراتيجية التقسيم لتقسيم الملف (الملفات). إذا لم يتم تعيينه، فسيستخدم الاستراتيجية `auto` .	No
file_ids	array	قائمة بمعرفات الملفات التي يجب أن يستخدمها مخزن المتجهات. مفيد لأدوات مثل `file_search` التي يمكنها access الملفات.	Yes

assistantStreamEvent

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

يحتوي كل حدث في دفق الأحداث المرسلة من الخادم على خاصية event وخاصية data:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

نبعث الأحداث كلما تم إنشاء كائن جديد، أو الانتقال إلى حالة جديدة، أو يتم دفقها في أجزاء (دلتا). على سبيل المثال، نبعث thread.run.created عند إنشاء تشغيل جديد، thread.run.completed عند اكتمال التشغيل، وهكذا. عندما يختار مساعد إنشاء رسالة أثناء التشغيل، نبعث حدثا thread.message.created event، وحدثا thread.message.in_progress ، والعديد من thread.message.delta الأحداث، وأخيرا حدثا thread.message.completed .

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

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

threadStreamEvent
runStreamEvent
runStepStreamEvent
messageStreamEvent
errorEvent
doneEvent

threadStreamEvent

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

thread.created

يحدث عند إنشاء مؤشر ترابط جديد.

Name	Type	Description	Required	Default
data	threadObject	يمثل مؤشر ترابط يحتوي على رسائل.	Yes
event	string		Yes

Data: threadObject

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

Value	Description
thread.created	حدث إنشاء مؤشر الترابط

runStreamEvent

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

thread.run.created

يحدث عند إنشاء تشغيل جديد.

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.created

thread.run.queued

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

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.queued

thread.run.in_progress

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

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.in_progress

thread.run.requires_action

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

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.requires_action

thread.run.completed

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

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.completed

thread.run.failed

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

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.failed

thread.run.cancelling

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

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.cancelling

thread.run.cancelled

يحدث عند إلغاء تشغيل.

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.cancelled

thread.run.expired

يحدث عند انتهاء صلاحية تشغيل.

Name	Type	Description	Required	Default
data	runObject	يمثل تنفيذا يتم تشغيله على مؤشرات ترابط.	Yes
event	string		Yes

Data: runObject

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

Value	Description
thread.run.expired

runStepStreamEvent

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

thread.run.step.created

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

Name	Type	Description	Required	Default
data	runStepObject	يمثل خطوة في تنفيذ تشغيل.	Yes
event	string		Yes

Data: runStepObject

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

Value	Description
thread.run.step.created

thread.run.step.in_progress

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

Name	Type	Description	Required	Default
data	runStepObject	يمثل خطوة في تنفيذ تشغيل.	Yes
event	string		Yes

Data: runStepObject

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

Value	Description
thread.run.step.in_progress

thread.run.step.delta

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

Name	Type	Description	Required	Default
data	runStepDeltaObject	يمثل دلتا خطوة تشغيل، أي أي حقول تم تغييرها في خطوة تشغيل أثناء البث.	Yes
event	string		Yes

Data: runStepDeltaObject

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

Value	Description
thread.run.step.delta

thread.run.step.completed

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

Name	Type	Description	Required	Default
data	runStepObject	يمثل خطوة في تنفيذ تشغيل.	Yes
event	string		Yes

Data: runStepObject

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

Value	Description
thread.run.step.completed

thread.run.step.failed

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

Name	Type	Description	Required	Default
data	runStepObject	يمثل خطوة في تنفيذ تشغيل.	Yes
event	string		Yes

Data: runStepObject

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

Value	Description
thread.run.step.failed

thread.run.step.cancelled

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

Name	Type	Description	Required	Default
data	runStepObject	يمثل خطوة في تنفيذ تشغيل.	Yes
event	string		Yes

Data: runStepObject

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

Value	Description
thread.run.step.cancelled

thread.run.step.expired

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

Name	Type	Description	Required	Default
data	runStepObject	يمثل خطوة في تنفيذ تشغيل.	Yes
event	string		Yes

Data: runStepObject

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

Value	Description
thread.run.step.expired

messageStreamEvent

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

thread.message.created

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

Name	Type	Description	Required	Default
data	messageObject	يمثل رسالة داخل مؤشرات ترابط.	Yes
event	string		Yes

Data: messageObject

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

Value	Description
thread.message.created

thread.message.in_progress

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

Name	Type	Description	Required	Default
data	messageObject	يمثل رسالة داخل مؤشرات ترابط.	Yes
event	string		Yes

Data: messageObject

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

Value	Description
thread.message.in_progress

thread.message.delta

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

Name	Type	Description	Required	Default
data	messageDeltaObject	يمثل دلتا رسالة، أي أي حقول تم تغييرها في رسالة أثناء البث.	Yes
event	string		Yes

Data: messageDeltaObject

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

Value	Description
thread.message.delta

thread.message.completed

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

Name	Type	Description	Required	Default
data	messageObject	يمثل رسالة داخل مؤشرات ترابط.	Yes
event	string		Yes

Data: messageObject

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

Value	Description
thread.message.completed

thread.message.incomplete

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

Name	Type	Description	Required	Default
data	messageObject	يمثل رسالة داخل مؤشرات ترابط.	Yes
event	string		Yes

Data: messageObject

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

Value	Description
thread.message.incomplete

Annotation

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

FileCitation
UrlCitation
FilePath

Click

إجراء النقر.

Name	Type	Description	Required
button	enum	يشير إلى زر الماوس الذي تم الضغط عليه أثناء النقر. واحد من `left`أو `rightwheel`أو `back`أو أو `forward`. القيم المحتملة: `left`، `right`، `wheel`، ، `backforward`	Yes
type	enum	يحدد نوع الحدث. لإجراء النقر، يتم تعيين هذه الخاصية دائما إلى `click`. القيم المحتملة: `click`	Yes
x	integer	الإحداثي س حيث حدث النقر.	Yes
y	integer	الإحداثي ص حيث حدث النقر.	Yes

CodeInterpreterFileOutput

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

Name	Type	Description	Required	Default
files	array		Yes
type	enum	نوع إخراج ملف مترجم التعليمات البرمجية. دائمًا `files`. القيم المحتملة: `files`	Yes

CodeInterpreterTextOutput

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

Name	Type	Description	Required	Default
logs	string	سجلات استدعاء أداة مترجم التعليمات البرمجية.	Yes
type	enum	نوع إخراج نص مترجم التعليمات البرمجية. دائمًا `logs`. القيم المحتملة: `logs`	Yes

CodeInterpreterTool

أداة تقوم بتشغيل التعليمات البرمجية.

Name	Type	Description	Required	Default
file_ids	array	معرفات الملفات لتشغيل التعليمات البرمجية عليها.	Yes
type	enum	نوع أداة مترجم التعليمات البرمجية. دائمًا `code_interpreter`. القيم المحتملة: `code_interpreter`	Yes

CodeInterpreterToolCall

استدعاء أداة لتشغيل التعليمات البرمجية.

Name	Type	Description	Required
code	string	التعليمات البرمجية المراد تشغيلها.	Yes
id	string	المعرف الفريد لاستدعاء أداة مترجم التعليمات البرمجية.	Yes
results	array	نتائج استدعاء أداة مترجم التعليمات البرمجية.	Yes
status	enum	حالة استدعاء أداة مترجم التعليمات البرمجية. القيم المحتملة: `in_progress`، ، `interpretingcompleted`	Yes
type	enum	نوع استدعاء أداة مترجم التعليمات البرمجية. دائمًا `code_interpreter_call`. القيم المحتملة: `code_interpreter_call`	Yes

CodeInterpreterToolOutput

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

CodeInterpreterTextOutput
CodeInterpreterFileOutput

ComparisonFilter

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

Name	Type	Description	Required
key	string	المفتاح للمقارنة مقابل القيمة.	Yes
type	enum	يحدد عامل المقارنة: `eq`، `ne`، `gt`، `gte`، `lt`، . `lte` - `eq`:يساوي - `ne`: غير متساوي - `gt`:اكبر - `gte`: أكبر من أو يساوي - `lt`:اقل - `lte`: أقل من أو يساوي القيم المحتملة: `eq`، `ne`، `gt`، `gte`، ، `ltlte`	Yes
value	سلسلة أو رقم أو قيمة منطقية	القيمة المراد مقارنتها بمفتاح السمة؛ يدعم أنواع السلسلة أو الرقم أو القيم المنطقية.	Yes

CompoundFilter

دمج عوامل تصفية متعددة باستخدام and أو or.

Name	Type	Description	Required	Default
filters	array	صفيف عوامل التصفية المراد دمجها. يمكن أن تكون `ComparisonFilter` العناصر أو `CompoundFilter`.	Yes
type	enum	نوع العملية: `and` أو `or`. القيم المحتملة: `and`، `or`	Yes

ComputerAction

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

Click
DoubleClick
Drag
KeyPress
Move
Screenshot
Scroll
Type
Wait

ComputerScreenshotImage

صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.

Name	Type	Description	Required
file_id	string	معرف ملف تم تحميله يحتوي على لقطة الشاشة.	No
image_url	string	عنوان URL لصورة لقطة الشاشة.	No
type	enum	يحدد نوع الحدث. للحصول على لقطة شاشة للكمبيوتر، يتم تعيين هذه الخاصية دائما إلى `computer_screenshot`. القيم المحتملة: `computer_screenshot`	Yes

ComputerTool

أداة تتحكم في جهاز كمبيوتر ظاهري.

Name	Type	Description	Required
display_height	number	ارتفاع جهاز عرض الكمبيوتر.	Yes
display_width	number	عرض جهاز عرض الكمبيوتر.	Yes
environment	enum	نوع بيئة الكمبيوتر التي يجب التحكم فيها. القيم المحتملة: `mac`، `windows`، ، `ubuntubrowser`	Yes
type	enum	نوع أداة استخدام الكمبيوتر. دائمًا `computer_use_preview`. القيم المحتملة: `computer-use-preview`	Yes

ComputerToolCall

استدعاء أداة إلى أداة استخدام الكمبيوتر.

Name	Type	Description	Required
action	ComputerAction		Yes
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	Yes
id	string	المعرف الفريد لاستدعاء الكمبيوتر.	Yes
pending_safety_checks	array	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	Yes
status	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	Yes
type	enum	نوع مكالمة الكمبيوتر. دائمًا `computer_call`. القيم المحتملة: `computer_call`	Yes

ComputerToolCallOutput

إخراج استدعاء أداة الكمبيوتر.

Name	Type	Description	Required
acknowledged_safety_checks	array	عمليات التحقق من السلامة التي تم الإبلاغ عنها بواسطة واجهة برمجة التطبيقات التي أقر بها المطور.	No
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج الإخراج.	Yes
id	string	معرف إخراج استدعاء أداة الكمبيوتر.	No
output	ComputerScreenshotImage	صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.	Yes
status	enum	حالة إدخال الرسالة. واحد من `in_progress`أو `completed`أو `incomplete`. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	No
type	enum	نوع إخراج استدعاء أداة الكمبيوتر. دائمًا `computer_call_output`. القيم المحتملة: `computer_call_output`	Yes

ComputerToolCallOutputResource

Name	Type	Description	Required
acknowledged_safety_checks	array	عمليات التحقق من السلامة التي تم الإبلاغ عنها بواسطة واجهة برمجة التطبيقات التي أقر بها المطور.	No
call_id	string	معرف استدعاء أداة الكمبيوتر الذي أنتج الإخراج.	Yes
id	string	المعرف الفريد لإخراج أداة استدعاء الكمبيوتر.	Yes
output	ComputerScreenshotImage	صورة لقطة شاشة للكمبيوتر تستخدم مع أداة استخدام الكمبيوتر.	Yes
status	enum	حالة إدخال الرسالة. واحد من `in_progress`أو `completed`أو `incomplete`. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	No
type	enum	نوع إخراج استدعاء أداة الكمبيوتر. دائمًا `computer_call_output`. القيم المحتملة: `computer_call_output`	Yes

ComputerToolCallSafetyCheck

فحص أمان معلق لمكالمة الكمبيوتر.

Name	Type	Description	Required
code	string	نوع فحص الأمان المعلق.	Yes
id	string	معرف فحص السلامة المعلق.	Yes
message	string	تفاصيل حول فحص السلامة المعلق.	Yes

Content

محتويات الإدخال والإخراج متعددة الوسائط.

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

InputContent
OutputContent

Coordinate

زوج إحداثيات x/y، على سبيل المثال { x: 100, y: 200 }.

Name	Type	Description	Required	Default
x	integer	The x-coordinate.	Yes
y	integer	The y-coordinate.	Yes

CreateModelResponseProperties

Name	Type	Description	Required	Default
metadata	Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	No
model	string	النموذج المستخدم لإنشاء الاستجابات.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	No	1
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	No	1
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد OpenAI على مراقبة إساءة الاستخدام واكتشافها. .	No

createResponse

Name	Type	Description	Required	Default
include	array	{"$ref": "#/components/schemas/includable/description"}	No
input	سلسلة أو مجموعة	النص أو الصورة أو إدخالات الملفات إلى النموذج، المستخدمة لإنشاء استجابة.	Yes
instructions	string	إدراج رسالة نظام (أو مطور) كعنصر أول في سياق النموذج. عند استخدام جنبا إلى جنب مع `previous_response_id`، لن يتم نقل الإرشادات من استجابة سابقة إلى الاستجابة التالية. وهذا يجعل من السهل تبديل رسائل النظام (أو المطور) في استجابات جديدة.	No
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك رموز الإخراج المميزة المرئية والرموز المميزة المنطقية.	No
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	No	True
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	No
reasoning	Reasoning	خيارات التكوين لنماذج المنطق.	No
store	boolean	ما إذا كنت تريد تخزين استجابة النموذج التي تم إنشاؤها للاسترداد لاحقا عبر واجهة برمجة التطبيقات.	No	True
stream	boolean	إذا تم تعيينها إلى true، دفق بيانات استجابة النموذج إلى العميل كما يتم إنشاؤها باستخدام الأحداث المرسلة من الخادم.	No	False
text	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. Learn more: - مدخلات ومخرجات النص - المخرجات المنظمة	No
└─ format	TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين `{ "type": "json_schema" }` المخرجات المنظمة، مما يضمن تطابق النموذج مع مخطط JSON المقدم. التنسيق الافتراضي مع `{ "type": "text" }` عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: الإعداد لتمكين `{ "type": "json_object" }` وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام `json_schema` للنماذج التي تدعمه.	No
tool_choice	ToolChoiceOptions أو ToolChoiceTypes أو ToolChoiceFunction	كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة `tools` لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.	No
tools	array	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. يمكنك تحديد الأداة التي يجب استخدامها عن طريق تعيين المعلمة `tool_choice` . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة	No
truncation	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - `auto`: إذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج، فسيقتطاع النموذج استجابة لاحتواء نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (افتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، فسيفشل الطلب مع حدوث خطأ 400. القيم المحتملة: `auto`، `disabled`	No

DoubleClick

إجراء النقر المزدوج.

Name	Type	Description	Required
type	enum	يحدد نوع الحدث. لإجراء النقر المزدوج، يتم تعيين هذه الخاصية دائما إلى `double_click`. القيم المحتملة: `double_click`	Yes
x	integer	الإحداثي س حيث حدث النقر المزدوج.	Yes
y	integer	الإحداثي ص حيث حدث النقر المزدوج.	Yes

Drag

إجراء سحب.

Name	Type	Description	Required	Default
path	array	مصفوفة من الإحداثيات تمثل مسار إجراء السحب. ستظهر الإحداثيات كصفيف من العناصر، على سبيل المثال`[{ x: 100, y: 200 }, { x: 200, y: 300 }]`	Yes
type	enum	يحدد نوع الحدث. لإجراء السحب، يتم تعيين هذه الخاصية دائما إلى `drag`. القيم المحتملة: `drag`	Yes

EasyInputMessage

إدخال رسالة إلى النموذج مع دور يشير إلى التعليمات التالية التسلسل الهرمي. الإرشادات المعطاة developer مع الدور أو system لها الأسبقية على الإرشادات المعطاة مع user الدور. يفترض أن الرسائل التي assistant لها الدور قد تم إنشاؤها بواسطة النموذج في التفاعلات السابقة.

Name	Type	Description	Required
content	سلسلة أو InputMessageContentList	إدخال النص أو الصورة أو الصوت إلى النموذج، المستخدم لإنشاء استجابة. يمكن أن يحتوي أيضا على استجابات المساعد السابقة.	Yes
role	enum	دور إدخال الرسالة. واحد من `user`أو `assistantsystem`أو أو `developer`. القيم المحتملة: `user`، `assistant`، ، `systemdeveloper`	Yes
type	enum	نوع إدخال الرسالة. دائمًا `message`. القيم المحتملة: `message`	No

FileCitation

اقتباس إلى ملف.

Name	Type	Description	Required
file_id	string	معرف الملف.	Yes
index	integer	فهرس الملف في قائمة الملفات.	Yes
type	enum	نوع الاقتباس من الملف. دائمًا `file_citation`. القيم المحتملة: `file_citation`	Yes

FilePath

مسار إلى ملف.

Name	Type	Description	Required
file_id	string	معرف الملف.	Yes
index	integer	فهرس الملف في قائمة الملفات.	Yes
type	enum	نوع مسار الملف. دائمًا `file_path`. القيم المحتملة: `file_path`	Yes

FileSearchRanker

المصنف الذي يجب استخدامه للبحث عن الملفات. إذا لم يتم تحديد سيستخدم auto ranker.

Property	Value
Description	المصنف الذي يجب استخدامه للبحث عن الملفات. إذا لم يتم تحديد سيستخدم `auto` ranker.
Type	string
Values	`auto` `default_2024_08_21`

FileSearchTool

أداة تبحث عن محتوى ذي صلة من الملفات التي تم تحميلها.

Name	Type	Description	Required	Default
filters	ComparisonFilter أو CompoundFilter	عامل تصفية لتطبيقه استنادا إلى سمات الملف.	No
max_num_results	integer	الحد الأقصى لعدد النتائج التي سيتم إرجاعها. يجب أن يتراوح هذا الرقم بين 1 و50 ضمنا.	No
ranking_options	object	خيارات تحديد المرتبة للبحث.	No
└─ ranker	enum	المصنف الذي يجب استخدامه للبحث عن الملفات. القيم المحتملة: `auto`، `default-2024-11-15`	No
└─ score_threshold	number	حد الدرجة للبحث في الملف، رقم بين 0 و1. ستحاول الأرقام الأقرب إلى 1 إرجاع النتائج الأكثر صلة فقط، ولكنها قد ترجع نتائج أقل.	No	0
type	enum	نوع أداة البحث عن الملفات. دائمًا `file_search`. القيم المحتملة: `file_search`	Yes
vector_store_ids	array	تخزن معرفات المتجهات للبحث.	Yes

FileSearchToolCall

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

Name	Type	Description	Required
id	string	المعرف الفريد لاستدعاء أداة البحث عن الملفات.	Yes
queries	array	الاستعلامات المستخدمة للبحث عن الملفات.	Yes
results	array	نتائج استدعاء أداة البحث عن الملفات.	No
status	enum	حالة استدعاء أداة البحث عن الملفات. واحد من `in_progress`أو `searchingincomplete` أو أو `failed` القيم المحتملة: `in_progress`، `searching`، `completed`، ، `incompletefailed`	Yes
type	enum	نوع استدعاء أداة البحث عن الملفات. دائمًا `file_search_call`. القيم المحتملة: `file_search_call`	Yes

FunctionTool

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

Name	Type	Description	Required
description	string	وصف للدالة. يستخدم من قبل النموذج لتحديد ما إذا كان يجب استدعاء الدالة أم لا.	No
name	string	اسم الدالة التي يجب استدعاها.	Yes
parameters	object	كائن مخطط JSON يصف معلمات الدالة.	Yes
strict	boolean	ما إذا كان يجب فرض التحقق الصارم من صحة المعلمة. الافتراضي `true`.	Yes
type	enum	نوع أداة الدالة. دائمًا `function`. القيم المحتملة: `function`	Yes

FunctionToolCall

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

Name	Type	Description	Required
arguments	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	Yes
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	Yes
id	string	المعرف الفريد لاستدعاء أداة الدالة.	Yes
name	string	اسم الدالة المراد تشغيلها.	Yes
status	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	No
type	enum	نوع استدعاء أداة الدالة. دائمًا `function_call`. القيم المحتملة: `function_call`	Yes

FunctionToolCallOutput

إخراج استدعاء أداة دالة.

Name	Type	Description	Required
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	Yes
id	string	المعرف الفريد لإخراج استدعاء أداة الدالة. يتم ملؤه عند إرجاع هذا العنصر عبر واجهة برمجة التطبيقات.	No
output	string	سلسلة JSON من إخراج استدعاء أداة الدالة.	Yes
status	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	No
type	enum	نوع إخراج استدعاء أداة الدالة. دائمًا `function_call_output`. القيم المحتملة: `function_call_output`	Yes

FunctionToolCallOutputResource

Name	Type	Description	Required
call_id	string	المعرف الفريد لاستدعاء أداة الدالة الذي تم إنشاؤه بواسطة النموذج.	Yes
id	string	المعرف الفريد لإخراج أداة استدعاء الدالة.	Yes
output	string	سلسلة JSON من إخراج استدعاء أداة الدالة.	Yes
status	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	No
type	enum	نوع إخراج استدعاء أداة الدالة. دائمًا `function_call_output`. القيم المحتملة: `function_call_output`	Yes

includable

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

file_search_call.resultsقم بتضمين نتائج البحث لاستدعاء أداة البحث عن الملفات.:
message.input_image.image_urlقم بتضمين عناوين URL للصور من رسالة الإدخال.:
computer_call_output.output.image_urlقم بتضمين عناوين URL للصور من إخراج استدعاء الكمبيوتر.:

Property	Value
Description	حدد بيانات إخراج إضافية لتضمينها في استجابة النموذج. القيم المدعومة حاليا هي: - `file_search_call.results`: قم بتضمين نتائج البحث لاستدعاء أداة البحث عن الملفات. - `message.input_image.image_url`: قم بتضمين عناوين URL للصور من رسالة الإدخال. - `computer_call_output.output.image_url`: قم بتضمين عناوين URL للصور من إخراج استدعاء الكمبيوتر.
Type	string
Values	`file_search_call.results` `message.input_image.image_url` `computer_call_output.output.image_url`

InputAudio

إدخال صوتي للنموذج.

Name	Type	Description	Required
data	string	بيانات صوتية مرمزة ب Base64.	Yes
format	enum	تنسيق البيانات الصوتية. التنسيقات المدعومة حاليا هي `mp3` و `wav`. القيم المحتملة: `mp3`، `wav`	Yes
type	enum	نوع عنصر الإدخال. دائمًا `input_audio`. القيم المحتملة: `input_audio`	Yes

InputContent

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

InputText
InputImage
InputFile

InputFile

إدخال ملف إلى النموذج.

Name	Type	Description	Required
file_data	string	محتوى الملف الذي سيتم إرساله إلى النموذج.	No
file_id	string	معرف الملف الذي سيتم إرساله إلى النموذج.	No
filename	string	اسم الملف الذي سيتم إرساله إلى النموذج.	No
type	enum	نوع عنصر الإدخال. دائمًا `input_file`. القيم المحتملة: `input_file`	Yes

InputImage

إدخال صورة إلى النموذج.

Name	Type	Description	Required
detail	enum	مستوى تفاصيل الصورة التي سيتم إرسالها إلى النموذج. واحد من `high`أو `low`أو `auto`. الإعدادات الافتراضية لـ `auto`. القيم المحتملة: `high`، ، `lowauto`	Yes
file_id	string	معرف الملف الذي سيتم إرساله إلى النموذج.	No
image_url	string	عنوان URL للصورة التي سيتم إرسالها إلى النموذج. عنوان URL مؤهل بالكامل أو صورة مشفرة base64 في عنوان URL للبيانات.	No
type	enum	نوع عنصر الإدخال. دائمًا `input_image`. القيم المحتملة: `input_image`	Yes

InputItem

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

EasyInputMessage
Item
ItemReference

InputMessage

Name	Type	Description	Required
content	InputMessageContentList	قائمة بعناصر إدخال واحدة أو العديد من عناصر الإدخال إلى النموذج، تحتوي على محتوى مختلف types.	Yes
role	enum	دور إدخال الرسالة. واحد من `user`أو `system`أو `developer`. القيم المحتملة: `user`، ، `systemdeveloper`	Yes
status	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	No
type	enum	نوع إدخال الرسالة. عيّنها بشل دائم إلى `message`. القيم المحتملة: `message`	No

InputMessageContentList

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

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

InputMessageResource

Name	Type	Description	Required
content	InputMessageContentList	قائمة بعناصر إدخال واحدة أو العديد من عناصر الإدخال إلى النموذج، تحتوي على محتوى مختلف types.	Yes
id	string	المعرف الفريد لإدخال الرسالة.	Yes
role	enum	دور إدخال الرسالة. واحد من `user`أو `system`أو `developer`. القيم المحتملة: `user`، ، `systemdeveloper`	Yes
status	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	No
type	enum	نوع إدخال الرسالة. عيّنها بشل دائم إلى `message`. القيم المحتملة: `message`	No

InputText

إدخال نص إلى النموذج.

Name	Type	Description	Required	Default
text	string	إدخال النص إلى النموذج.	Yes
type	enum	نوع عنصر الإدخال. دائمًا `input_text`. القيم المحتملة: `input_text`	Yes

Item

عنصر المحتوى المستخدم لإنشاء استجابة.

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

InputMessage
OutputMessage
FileSearchToolCall
ComputerToolCall
ComputerToolCallOutput
FunctionToolCall
FunctionToolCallOutput
ReasoningItem

ItemReference

معرف داخلي لعنصر للرجوع إليه.

Name	Type	Description	Required	Default
id	string	معرف العنصر المراد الرجوع إليه.	Yes
type	enum	نوع العنصر الذي يجب الرجوع إليه. دائمًا `item_reference`. القيم المحتملة: `item_reference`	Yes

ItemResource

عنصر المحتوى المستخدم لإنشاء استجابة.

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

InputMessageResource
OutputMessage
FileSearchToolCall
ComputerToolCall
ComputerToolCallOutputResource
FunctionToolCall
FunctionToolCallOutputResource

KeyPress

مجموعة من ضغطات المفاتيح التي يرغب النموذج في تنفيذها.

Name	Type	Description	Required	Default
keys	array	مجموعة المفاتيح التي يطلب النموذج الضغط عليها. هذا صفيف من السلاسل، يمثل كل منها مفتاحا.	Yes
type	enum	يحدد نوع الحدث. لإجراء keypress، يتم تعيين هذه الخاصية دائما إلى `keypress`. القيم المحتملة: `keypress`	Yes

Metadata

المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.

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

ModelResponseProperties

Name	Type	Description	Required	Default
metadata	Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	No
model	string	النموذج المستخدم لإنشاء الاستجابات.	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	No	1
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	No	1
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد OpenAI على مراقبة إساءة الاستخدام واكتشافها. .	No

Move

إجراء تحريك الماوس.

Name	Type	Description	Required
type	enum	يحدد نوع الحدث. لإجراء النقل، يتم تعيين هذه الخاصية دائما إلى `move`. القيم المحتملة: `move`	Yes
x	integer	الإحداثي س للانتقال إليه.	Yes
y	integer	الإحداثي ص للانتقال إليه.	Yes

OutputAudio

إخراج صوت من النموذج.

Name	Type	Description	Required
data	string	بيانات صوتية مرمزة ب Base64 من النموذج.	Yes
transcript	string	نسخة البيانات الصوتية من النموذج.	Yes
type	enum	نوع صوت الإخراج. دائمًا `output_audio`. القيم المحتملة: `output_audio`	Yes

OutputContent

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

OutputText
Refusal

OutputItem

Name	Type	Description	Required
action	ComputerAction		Yes
arguments	string	سلسلة JSON من الوسيطات المراد تمريرها إلى الدالة.	Yes
call_id	string	معرف يستخدم عند الاستجابة لاستدعاء الأداة مع الإخراج.	Yes
content	array	تحليل محتويات النص.	Yes
id	string	المعرف الفريد لمحتوى المنطق.	Yes
name	string	اسم الدالة المراد تشغيلها.	Yes
pending_safety_checks	array	فحوصات السلامة المعلقة لمكالمة الكمبيوتر.	Yes
queries	array	الاستعلامات المستخدمة للبحث عن الملفات.	Yes
results	array	نتائج استدعاء أداة البحث عن الملفات.	No
role	enum	دور رسالة الإخراج. دائمًا `assistant`. القيم المحتملة: `assistant`	Yes
status	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	Yes
type	enum	نوع الكائن. دائمًا `reasoning`. القيم المحتملة: `reasoning`	Yes

OutputMessage

رسالة إخراج من النموذج.

Name	Type	Description	Required
content	array	محتوى رسالة الإخراج.	Yes
id	string	المعرف الفريد لرسالة الإخراج.	Yes
role	enum	دور رسالة الإخراج. دائمًا `assistant`. القيم المحتملة: `assistant`	Yes
status	enum	حالة إدخال الرسالة. واحد من `in_progress`أو `completed`أو `incomplete`. يتم ملؤها عند إرجاع عناصر الإدخال عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	Yes
type	enum	نوع رسالة الإخراج. دائمًا `message`. القيم المحتملة: `message`	Yes

OutputText

إخراج نص من النموذج.

Name	Type	Description	Required
annotations	array	التعليقات التوضيحية لإخراج النص.	Yes
text	string	إخراج النص من النموذج.	Yes
type	enum	نوع النص الناتج. دائمًا `output_text`. القيم المحتملة: `output_text`	Yes

RealtimeSessionCreateRequest

تكوين كائن جلسة العمل في الوقت الحقيقي.

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

RealtimeSessionCreateResponse

تكوين جلسة عمل في الوقت الحقيقي جديد، مع مفتاح سريع الزوال. TTL الافتراضي للمفاتيح هو دقيقة واحدة.

Name	Type	Description	Required
client_secret	object	مفتاح سريع الزوال الذي تم إرجاعه بواسطة واجهة برمجة التطبيقات.	Yes
└─ expires_at	integer	الطابع الزمني لوقت انتهاء صلاحية الرمز المميز. حاليا، تنتهي صلاحية جميع الرموز المميزة بعد دقيقة واحدة.	No
└─ value	string	مفتاح سريع الزوال قابل للاستخدام في بيئات العميل لمصادقة الاتصالات بواجهة برمجة التطبيقات في الوقت الحقيقي. استخدم هذا في بيئات من جانب العميل بدلا من رمز مميز قياسي لواجهة برمجة التطبيقات، والذي يجب استخدامه فقط من جانب الخادم.	No
input_audio_format	string	تنسيق صوت الإدخال. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`.	No
input_audio_transcription	object	تكوين النسخ الصوتي للإدخل، الإعدادات الافتراضية إلى إيقاف التشغيل ويمكن تعيينها إلى `null` إيقاف التشغيل مرة واحدة. النسخ الصوتي للإدخال ليس أصليا للنموذج، لأن النموذج يستهلك الصوت مباشرة. يعمل النسخ بشكل غير متزامن من خلال الهمس ويجب التعامل معه على أنه إرشادات تقريبية بدلا من التمثيل الذي يفهمه النموذج.	No
└─ model	string	النموذج الذي يجب استخدامه للنسخ، `whisper-1` هو النموذج الوحيد المدعوم حاليا.	No
instructions	string	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وتنسيقها (على سبيل المثال، "كن مختصرا للغاية"، و"التصرف ودي"، و"فيما يلي أمثلة للاستجابات الجيدة") وعلى السلوك الصوتي (على سبيل المثال، "تحدث بسرعة"، و"حقن العاطفة في صوتك"، و"الضحك بشكل متكرر"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يعين الإرشادات الافتراضية التي سيتم استخدامها إذا لم يتم تعيين هذا الحقل وتكون مرئية `session.created` في الحدث في بداية جلسة العمل.	No
max_response_output_tokens	عدد صحيح أو سلسلة	الحد الأقصى لعدد الرموز المميزة للإخراج لاستجابة مساعد واحد، بما في ذلك استدعاءات الأدوات. توفير عدد صحيح بين 1 و4096 للحد من الرموز المميزة للإخراج، أو `inf` للحد الأقصى من الرموز المميزة المتاحة لنموذج معين. الإعدادات الافتراضية لـ `inf`.	No
modalities		مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا إلى ["نص"].	No
output_audio_format	string	تنسيق صوت الإخراج. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`.	No
temperature	number	درجة حرارة أخذ العينات للنموذج، تقتصر على [0.6، 1.2]. الإعدادات الافتراضية إلى 0.8.	No
tool_choice	string	كيف يختار النموذج الأدوات. الخيارات هي `auto`أو `nonerequired`أو أو تحديد دالة.	No
tools	array	الأدوات (الوظائف) المتوفرة للنموذج.	No
turn_detection	object	تكوين الكشف عن الأدوار. يمكن تعيين إلى `null` لإيقاف التشغيل. يعني خادم VAD أن النموذج سيكشف عن بدء الكلام ونهاته استنادا إلى مستوى الصوت والاستجابة في نهاية كلام المستخدم.	No
└─ prefix_padding_ms	integer	مقدار الصوت المطلوب تضمينه قبل الكشف عن الكلام في VAD (بالمللي ثانية). الافتراضيات إلى 300 مللي ثانية.	No
└─ silence_duration_ms	integer	مدة الصمت للكشف عن توقف الكلام (بالمللي ثانية). الافتراضيات إلى 500 مللي ثانية. مع القيم الأقصر، سيستجيب النموذج بسرعة أكبر، ولكن قد يقفز في الإيقاف المؤقت القصير من المستخدم.	No
└─ threshold	number	حد التنشيط ل VAD (0.0 إلى 1.0)، هذا افتراضيا إلى 0.5. سيتطلب الحد الأعلى صوت أعلى لتنشيط النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات الصاخبة.	No
└─ type	string	نوع الكشف عن الأدوار، معتمد حاليا فقط `server_vad` .	No
voice	VoiceIdsShared		No

RealtimeTranscriptionSessionCreateRequest

تكوين كائن جلسة عمل النسخ في الوقت الحقيقي.

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

RealtimeTranscriptionSessionCreateResponse

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

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

Name	Type	Description	Required
client_secret	object	مفتاح سريع الزوال الذي تم إرجاعه بواسطة واجهة برمجة التطبيقات. موجود فقط عند إنشاء جلسة العمل على الخادم عبر واجهة برمجة تطبيقات REST.	Yes
└─ expires_at	integer	الطابع الزمني لوقت انتهاء صلاحية الرمز المميز. حاليا، تنتهي صلاحية جميع الرموز المميزة بعد دقيقة واحدة.	No
└─ value	string	مفتاح سريع الزوال قابل للاستخدام في بيئات العميل لمصادقة الاتصالات بواجهة برمجة التطبيقات في الوقت الحقيقي. استخدم هذا في بيئات من جانب العميل بدلا من رمز مميز قياسي لواجهة برمجة التطبيقات، والذي يجب استخدامه فقط من جانب الخادم.	No
input_audio_format	string	تنسيق صوت الإدخال. الخيارات هي `pcm16`أو `g711_ulaw`أو `g711_alaw`.	No
input_audio_transcription	object	تكوين نموذج النسخ.	No
└─ language	string	لغة صوت الإدخال. يؤدي توفير لغة الإدخال بتنسيق ISO-639-1 (على سبيل المثال `en`) إلى تحسين الدقة وزمن الوصول.	No
└─ model	enum	النموذج الذي يجب استخدامه للنسخ. يمكن أن يكون `gpt-4o-transcribe` أو `gpt-4o-mini-transcribe` أو `gpt-4o-mini-transcribe-2025-12-15` أو `whisper-1`. القيم المحتملة: `gpt-4o-transcribe`، `gpt-4o-mini-transcribe`، ، `gpt-4o-mini-transcribe-2025-12-15whisper-1`	No
└─ prompt	string	نص اختياري لتوجيه نمط النموذج أو متابعة مقطع صوت سابق. يجب أن تتطابق المطالبة مع لغة الصوت.	No
modalities		مجموعة الطرائق التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا إلى ["نص"].	No
turn_detection	object	تكوين الكشف عن الأدوار. يمكن تعيين إلى `null` لإيقاف التشغيل. يعني خادم VAD أن النموذج سيكشف عن بدء الكلام ونهاته استنادا إلى مستوى الصوت والاستجابة في نهاية كلام المستخدم.	No
└─ prefix_padding_ms	integer	مقدار الصوت المطلوب تضمينه قبل الكشف عن الكلام في VAD (بالمللي ثانية). الافتراضيات إلى 300 مللي ثانية.	No
└─ silence_duration_ms	integer	مدة الصمت للكشف عن توقف الكلام (بالمللي ثانية). الافتراضيات إلى 500 مللي ثانية. مع القيم الأقصر، سيستجيب النموذج بسرعة أكبر، ولكن قد يقفز في الإيقاف المؤقت القصير من المستخدم.	No
└─ threshold	number	حد التنشيط ل VAD (0.0 إلى 1.0)، هذا افتراضيا إلى 0.5. سيتطلب الحد الأعلى صوت أعلى لتنشيط النموذج، وبالتالي قد يؤدي أداء أفضل في البيئات الصاخبة.	No
└─ type	string	نوع الكشف عن الأدوار، معتمد حاليا فقط `server_vad` .	No

Reasoning

خيارات التكوين لنماذج المنطق.

Name	Type	Description	Required	Default
effort	ReasoningEffort	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي `low`و `medium`و.`high` يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة.	Yes	medium
summary	enum	ملخص المنطق الذي يقوم به النموذج. يمكن أن يكون هذا مفيدا لتصحيح أخطاء عملية التفكير في النموذج وفهمها. أحد `concise` أو `detailed`. القيم المحتملة: `concise`، `detailed`	No

ReasoningItem

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

Name	Type	Description	Required
content	array	تحليل محتويات النص.	Yes
id	string	المعرف الفريد لمحتوى المنطق.	Yes
status	enum	حالة العنصر. واحد من `in_progress`أو `completed`أو `incomplete`. يتم تعبئتها عند إرجاع العناصر عبر واجهة برمجة التطبيقات. القيم المحتملة: `in_progress`، ، `completedincomplete`	No
type	enum	نوع الكائن. دائمًا `reasoning`. القيم المحتملة: `reasoning`	Yes

Refusal

رفض من النموذج.

Name	Type	Description	Required	Default
refusal	string	تفسير الرفض من النموذج.	Yes
type	enum	نوع الرفض. دائمًا `refusal`. القيم المحتملة: `refusal`	Yes

response

Name	Type	Description	Required	Default
created_at	number	الطابع الزمني لليونكس (بالثواني) لوقت إنشاء هذه الاستجابة.	Yes
error	ResponseError	تم إرجاع كائن خطأ عندما يفشل النموذج في إنشاء استجابة.	Yes
id	string	معرف فريد لهذه الاستجابة.	Yes
incomplete_details	object	تفاصيل حول سبب عدم اكتمال الاستجابة.	Yes
└─ reason	enum	سبب عدم اكتمال الاستجابة. القيم المحتملة: `max_output_tokens`، `content_filter`	No
instructions	string	إدراج رسالة نظام (أو مطور) كعنصر أول في سياق النموذج. عند استخدام جنبا إلى جنب مع `previous_response_id`، لن يتم نقل الإرشادات من استجابة سابقة إلى الاستجابة التالية. وهذا يجعل من السهل تبديل رسائل النظام (أو المطور) في استجابات جديدة.	Yes
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية وحالة المحادثة.	No
metadata	Metadata	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا.	Yes
model	string	النموذج المستخدم لإنشاء الاستجابات.	Yes
object	enum	نوع الكائن لهذا المورد - يتم تعيينه دائما إلى `response`. القيم المحتملة: `response`	Yes
output	array	مصفوفة من عناصر المحتوى التي تم إنشاؤها بواسطة النموذج. - يعتمد طول العناصر وترتيبها `output` في الصفيف على استجابة النموذج. - بدلا من الوصول إلى العنصر الأول في `output` الصفيف وافتراض أنها رسالة `assistant` بالمحتوى الذي تم إنشاؤه بواسطة النموذج، قد تفكر في استخدام الخاصية `output_text` حيث يتم دعمها في SDKs.	Yes
output_text	string	خاصية راحة SDK فقط التي تحتوي على إخراج النص المجمع من جميع `output_text` العناصر في `output` الصفيف، إن وجدت موجودة. مدعوم في Python وJavaScript SDKs.	No
parallel_tool_calls	boolean	ما إذا كان سيتم السماح للنموذج بتشغيل استدعاءات الأداة بالتوازي.	Yes	True
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	No
reasoning	Reasoning	خيارات التكوين لنماذج المنطق.	No
status	enum	حالة توليد الاستجابة. واحد من `completed`أو `failedin_progress`أو أو `incomplete`. القيم المحتملة: `completed`، `failed`، ، `in_progressincomplete`	No
temperature	number	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو `top_p` ولكن ليس كليهما.	Yes	1
text	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. Learn more: - مدخلات ومخرجات النص - المخرجات المنظمة	No
└─ format	TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين `{ "type": "json_schema" }` المخرجات المنظمة، مما يضمن تطابق النموذج مع مخطط JSON المقدم. التنسيق الافتراضي مع `{ "type": "text" }` عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: الإعداد لتمكين `{ "type": "json_object" }` وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام `json_schema` للنماذج التي تدعمه.	No
tool_choice	ToolChoiceOptions أو ToolChoiceTypes أو ToolChoiceFunction	كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة `tools` لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.	Yes
tools	array	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. يمكنك تحديد الأداة التي يجب استخدامها عن طريق تعيين المعلمة `tool_choice` . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة	Yes
top_p	number	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذا أو `temperature` ولكن ليس كليهما.	Yes	1
truncation	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - `auto`: إذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج، فسيقتطاع النموذج الاستجابة لاحتواء نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (افتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، فسيفشل الطلب مع حدوث خطأ 400. القيم المحتملة: `auto`، `disabled`	No
usage	ResponseUsage	يمثل تفاصيل استخدام الرمز المميز بما في ذلك الرموز المميزة للإدخال والرموز المميزة للإخراج وتفصيل الرموز المميزة للإخراج وإجمالي الرموز المميزة المستخدمة.	No
user	string	معرف فريد يمثل المستخدم النهائي، والذي يمكن أن يساعد OpenAI على مراقبة إساءة الاستخدام واكتشافها. .	No

ResponseAudioDeltaEvent

يتم إصداره عند وجود استجابة صوتية جزئية.

Name	Type	Description	Required	Default
delta	string	مجموعة من وحدات البايت الصوتية للاستجابة المرمزة Base64.	Yes
type	enum	نوع الحدث. دائمًا `response.audio.delta`. القيم المحتملة: `response.audio.delta`	Yes

ResponseAudioDoneEvent

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

Name	Type	Description	Required	Default
type	enum	نوع الحدث. دائمًا `response.audio.done`. القيم المحتملة: `response.audio.done`	Yes

ResponseAudioTranscriptDeltaEvent

يصدر عندما يكون هناك نسخة جزئية من الصوت.

Name	Type	Description	Required	Default
delta	string	النسخة الجزئية للاستجابة الصوتية.	Yes
type	enum	نوع الحدث. دائمًا `response.audio.transcript.delta`. القيم المحتملة: `response.audio.transcript.delta`	Yes

ResponseAudioTranscriptDoneEvent

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

Name	Type	Description	Required	Default
type	enum	نوع الحدث. دائمًا `response.audio.transcript.done`. القيم المحتملة: `response.audio.transcript.done`	Yes

ResponseCodeInterpreterCallCodeDeltaEvent

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

Name	Type	Description	Required
delta	string	مقتطف التعليمات البرمجية الجزئي الذي أضافه مترجم التعليمات البرمجية.	Yes
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	Yes
type	enum	نوع الحدث. دائمًا `response.code_interpreter_call.code.delta`. القيم المحتملة: `response.code_interpreter_call.code.delta`	Yes

ResponseCodeInterpreterCallCodeDoneEvent

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

Name	Type	Description	Required
code	string	إخراج مقتطف التعليمات البرمجية النهائي بواسطة مترجم التعليمات البرمجية.	Yes
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	Yes
type	enum	نوع الحدث. دائمًا `response.code_interpreter_call.code.done`. القيم المحتملة: `response.code_interpreter_call.code.done`	Yes

ResponseCodeInterpreterCallCompletedEvent

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

Name	Type	Description	Required
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل التعليمات البرمجية.	Yes
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	Yes
type	enum	نوع الحدث. دائمًا `response.code_interpreter_call.completed`. القيم المحتملة: `response.code_interpreter_call.completed`	Yes

ResponseCodeInterpreterCallInProgressEvent

تنبعث عندما تكون استدعاء مترجم التعليمات البرمجية قيد التقدم.

Name	Type	Description	Required
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل التعليمات البرمجية.	Yes
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	Yes
type	enum	نوع الحدث. دائمًا `response.code_interpreter_call.in_progress`. القيم المحتملة: `response.code_interpreter_call.in_progress`	Yes

ResponseCodeInterpreterCallInterpretingEvent

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

Name	Type	Description	Required
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل التعليمات البرمجية.	Yes
output_index	integer	فهرس عنصر الإخراج الذي يستدعيه مترجم التعليمات البرمجية قيد التقدم.	Yes
type	enum	نوع الحدث. دائمًا `response.code_interpreter_call.interpreting`. القيم المحتملة: `response.code_interpreter_call.interpreting`	Yes

ResponseCompletedEvent

تنبعث عند اكتمال استجابة النموذج.

Name	Type	Description	Required	Default
response	response		Yes
type	enum	نوع الحدث. دائمًا `response.completed`. القيم المحتملة: `response.completed`	Yes

ResponseContentPartAddedEvent

تنبعث عند إضافة جزء محتوى جديد.

Name	Type	Description	Required
content_index	integer	فهرس جزء المحتوى الذي تمت إضافته.	Yes
item_id	string	معرف عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	Yes
part	OutputContent		Yes
type	enum	نوع الحدث. دائمًا `response.content_part.added`. القيم المحتملة: `response.content_part.added`	Yes

ResponseContentPartDoneEvent

تنبعث عند الانتهاء من جزء المحتوى.

Name	Type	Description	Required
content_index	integer	فهرس جزء المحتوى الذي تم القيام به.	Yes
item_id	string	معرف عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة جزء المحتوى إليه.	Yes
part	OutputContent		Yes
type	enum	نوع الحدث. دائمًا `response.content_part.done`. القيم المحتملة: `response.content_part.done`	Yes

ResponseCreatedEvent

حدث ينبعث عند إنشاء استجابة.

Name	Type	Description	Required	Default
response	response		Yes
type	enum	نوع الحدث. دائمًا `response.created`. القيم المحتملة: `response.created`	Yes

ResponseError

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

Name	Type	Description	Required	Default
code	ResponseErrorCode	رمز الخطأ للاستجابة.	Yes
message	string	وصف يمكن للإنسان قراءته للخطأ.	Yes

ResponseErrorCode

رمز الخطأ للاستجابة.

Property	Value
Description	رمز الخطأ للاستجابة.
Type	string
Values	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

ResponseErrorEvent

تنبعث عند حدوث خطأ.

Name	Type	Description	Required
code	string	رمز الخطأ.	Yes
message	string	رسالة الخطأ.	Yes
param	string	معلمة الخطأ.	Yes
type	enum	نوع الحدث. دائمًا `error`. القيم المحتملة: `error`	Yes

ResponseFailedEvent

حدث ينبعث عند فشل الاستجابة.

Name	Type	Description	Required	Default
response	response		Yes
type	enum	نوع الحدث. دائمًا `response.failed`. القيم المحتملة: `response.failed`	Yes

ResponseFileSearchCallCompletedEvent

تنبعث عند اكتمال استدعاء البحث عن الملف (تم العثور على النتائج).

Name	Type	Description	Required
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	Yes
output_index	integer	فهرس عنصر الإخراج الذي يتم بدء استدعاء البحث في الملف.	Yes
type	enum	نوع الحدث. دائمًا `response.file_search_call.completed`. القيم المحتملة: `response.file_search_call.completed`	Yes

ResponseFileSearchCallInProgressEvent

تنبعث عند بدء استدعاء البحث عن ملف.

Name	Type	Description	Required
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	Yes
output_index	integer	فهرس عنصر الإخراج الذي يتم بدء استدعاء البحث في الملف.	Yes
type	enum	نوع الحدث. دائمًا `response.file_search_call.in_progress`. القيم المحتملة: `response.file_search_call.in_progress`	Yes

ResponseFileSearchCallSearchingEvent

ينبعث عند البحث عن ملف حاليا.

Name	Type	Description	Required
item_id	string	معرف عنصر الإخراج الذي تم بدء استدعاء البحث عن الملف.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تبحث عنه مكالمة البحث في الملف.	Yes
type	enum	نوع الحدث. دائمًا `response.file_search_call.searching`. القيم المحتملة: `response.file_search_call.searching`	Yes

ResponseFunctionCallArgumentsDeltaEvent

تنبعث عندما يكون هناك دلتا جزئية لاستدعاء الدالة.

Name	Type	Description	Required
delta	string	وسيطات استدعاء الدالة دلتا التي تمت إضافتها.	Yes
item_id	string	معرف عنصر الإخراج الذي تمت إضافة دلتا وسيطات استدعاء الدالة إليه.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تتم إضافة وسيطات استدعاء الدالة إليه.	Yes
type	enum	نوع الحدث. دائمًا `response.function_call_arguments.delta`. القيم المحتملة: `response.function_call_arguments.delta`	Yes

ResponseFunctionCallArgumentsDoneEvent

تنبعث عند الانتهاء من وسيطات استدعاء الدالة.

Name	Type	Description	Required
arguments	string	وسيطات استدعاء الدالة.	Yes
item_id	string	معرف العنصر.	Yes
output_index	integer	فهرس عنصر الإخراج.	Yes
type	enum	القيم المحتملة: `response.function_call_arguments.done`	Yes

ResponseInProgressEvent

تنبعث عندما تكون الاستجابة قيد التقدم.

Name	Type	Description	Required	Default
response	response		Yes
type	enum	نوع الحدث. دائمًا `response.in_progress`. القيم المحتملة: `response.in_progress`	Yes

ResponseIncompleteEvent

حدث ينبعث عند انتهاء الاستجابة على أنها غير مكتملة.

Name	Type	Description	Required	Default
response	response		Yes
type	enum	نوع الحدث. دائمًا `response.incomplete`. القيم المحتملة: `response.incomplete`	Yes

responseItemList

قائمة بعناصر الاستجابة.

Name	Type	Description	Required
data	array	قائمة بالعناصر المستخدمة لإنشاء هذه الاستجابة.	Yes
first_id	string	معرف العنصر الأول في القائمة.	Yes
has_more	boolean	ما إذا كان هناك المزيد من العناصر المتاحة.	Yes
last_id	string	معرف العنصر الأخير في القائمة.	Yes
object	enum	يجب أن يكون `list`نوع الكائن الذي تم إرجاعه . القيم المحتملة: `list`	Yes

ResponseModalities

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

["text"]

["text", "audio"]

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

ResponseModalitiesTextOnly

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

["text"]

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

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

ResponseOutputItemAddedEvent

تنبعث عند إضافة عنصر إخراج جديد.

Name	Type	Description	Required
item	OutputItem		Yes
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافته.	Yes
type	enum	نوع الحدث. دائمًا `response.output_item.added`. القيم المحتملة: `response.output_item.added`	Yes

ResponseOutputItemDoneEvent

ينبعث عند وضع علامة على عنصر الإخراج تم.

Name	Type	Description	Required
item	OutputItem		Yes
output_index	integer	فهرس عنصر الإخراج الذي تم وضع علامة عليه تم.	Yes
type	enum	نوع الحدث. دائمًا `response.output_item.done`. القيم المحتملة: `response.output_item.done`	Yes

ResponseProperties

Name	Type	Description	Required
instructions	string	إدراج رسالة نظام (أو مطور) كعنصر أول في سياق النموذج. عند استخدام جنبا إلى جنب مع `previous_response_id`، لن يتم نقل الإرشادات من استجابة سابقة إلى الاستجابة التالية. وهذا يجعل من السهل تبديل رسائل النظام (أو المطور) في استجابات جديدة.	No
max_output_tokens	integer	حد أعلى لعدد الرموز المميزة التي يمكن إنشاؤها للاستجابة، بما في ذلك الرموز المميزة للإخراج المرئية وحالة المحادثة.	No
previous_response_id	string	المعرف الفريد للاستجابة السابقة للنموذج. استخدم هذا لإنشاء محادثات متعددة الأدوار.	No
reasoning	Reasoning	خيارات التكوين لنماذج المنطق.	No
text	object	خيارات التكوين لاستجابة نصية من النموذج. يمكن أن يكون نصا عاديا أو بيانات JSON منظمة. Learn more: - مدخلات ومخرجات النص - المخرجات المنظمة	No
└─ format	TextResponseFormatConfiguration	كائن يحدد التنسيق الذي يجب على النموذج إخراجه. يتيح التكوين `{ "type": "json_schema" }` المخرجات المنظمة، مما يضمن تطابق النموذج مع مخطط JSON المقدم. التنسيق الافتراضي مع `{ "type": "text" }` عدم وجود خيارات إضافية. غير مستحسن لنماذج gpt-4o والأحدث: الإعداد لتمكين `{ "type": "json_object" }` وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام `json_schema` للنماذج التي تدعمه.	No
tool_choice	ToolChoiceOptions أو ToolChoiceTypes أو ToolChoiceFunction	كيف يجب أن يحدد النموذج الأداة (أو الأدوات) التي يجب استخدامها عند إنشاء استجابة. راجع المعلمة `tools` لمعرفة كيفية تحديد الأدوات التي يمكن للنموذج استدعاها.	No
tools	array	صفيف من الأدوات التي قد يستدعيها النموذج أثناء إنشاء استجابة. يمكنك تحديد الأداة التي يجب استخدامها عن طريق تعيين المعلمة `tool_choice` . فئتا الأدوات التي يمكنك توفير النموذج هما: - الأدوات المضمنة	No
truncation	enum	استراتيجية الاقتطاع لاستخدامها في استجابة النموذج. - `auto`: إذا تجاوز سياق هذه الاستجابة والردود السابقة حجم نافذة سياق النموذج، فسيقتطاع النموذج الاستجابة لاحتواء نافذة السياق عن طريق إسقاط عناصر الإدخال في منتصف المحادثة. - `disabled` (افتراضي): إذا تجاوزت استجابة النموذج حجم نافذة السياق لنموذج، فسيفشل الطلب مع حدوث خطأ 400. القيم المحتملة: `auto`، `disabled`	No

ResponseRefusalDeltaEvent

تنبعث عندما يكون هناك نص رفض جزئي.

Name	Type	Description	Required
content_index	integer	فهرس جزء المحتوى الذي تتم إضافة نص الرفض إليه.	Yes
delta	string	نص الرفض الذي تمت إضافته.	Yes
item_id	string	معرف عنصر الإخراج الذي تمت إضافة نص الرفض إليه.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة نص الرفض إليه.	Yes
type	enum	نوع الحدث. دائمًا `response.refusal.delta`. القيم المحتملة: `response.refusal.delta`	Yes

ResponseRefusalDoneEvent

تنبعث عند الانتهاء من نص الرفض.

Name	Type	Description	Required
content_index	integer	فهرس جزء المحتوى الذي تم فيه إنهاء نص الرفض.	Yes
item_id	string	معرف عنصر الإخراج الذي تم الانتهاء منه من نص الرفض.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تم الانتهاء من نص الرفض.	Yes
refusal	string	نص الرفض الذي تم الانتهاء منه.	Yes
type	enum	نوع الحدث. دائمًا `response.refusal.done`. القيم المحتملة: `response.refusal.done`	Yes

responseStreamEvent

Name	Type	Description	Required
annotation	Annotation		Yes
annotation_index	integer	فهرس التعليق التوضيحي الذي تمت إضافته.	Yes
arguments	string	وسيطات استدعاء الدالة.	Yes
code	string	رمز الخطأ.	Yes
code_interpreter_call	CodeInterpreterToolCall	استدعاء أداة لتشغيل التعليمات البرمجية.	Yes
content_index	integer	فهرس جزء المحتوى الذي تم إنهاء محتوى النص فيه.	Yes
delta	string	دلتا النص الذي تمت إضافته.	Yes
item	OutputItem	عنصر الإخراج الذي تم وضع علامة عليه تم.	Yes
item_id	string	معرف عنصر الإخراج الذي تم الانتهاء منه من محتوى النص.	Yes
message	string	رسالة الخطأ.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تم إنهاء محتوى النص به.	Yes
param	string	معلمة الخطأ.	Yes
part	OutputContent	جزء المحتوى الذي تم.	Yes
refusal	string	نص الرفض الذي تم الانتهاء منه.	Yes
response	response	الاستجابة غير المكتملة.	Yes
text	string	محتوى النص الذي تم الانتهاء منه.	Yes
type	enum	نوع الحدث. دائمًا `response.output_text.done`. القيم المحتملة: `response.output_text.done`	Yes

ResponseTextAnnotationDeltaEvent

يتم إصداره عند إضافة تعليق توضيحي نصي.

Name	Type	Description	Required
annotation	Annotation		Yes
annotation_index	integer	فهرس التعليق التوضيحي الذي تمت إضافته.	Yes
content_index	integer	فهرس جزء المحتوى الذي تمت إضافة التعليق التوضيحي للنص إليه.	Yes
item_id	string	معرف عنصر الإخراج الذي تمت إضافة التعليق التوضيحي للنص إليه.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة التعليق التوضيحي للنص إليه.	Yes
type	enum	نوع الحدث. دائمًا `response.output_text.annotation.added`. القيم المحتملة: `response.output_text.annotation.added`	Yes

ResponseTextDeltaEvent

تنبعث عندما يكون هناك دلتا نصية إضافية.

Name	Type	Description	Required
content_index	integer	فهرس جزء المحتوى الذي تمت إضافة دلتا النص إليه.	Yes
delta	string	دلتا النص الذي تمت إضافته.	Yes
item_id	string	معرف عنصر الإخراج الذي تمت إضافة دلتا النص إليه.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تمت إضافة دلتا النص إليه.	Yes
type	enum	نوع الحدث. دائمًا `response.output_text.delta`. القيم المحتملة: `response.output_text.delta`	Yes

ResponseTextDoneEvent

تنبعث عند الانتهاء من محتوى النص.

Name	Type	Description	Required
content_index	integer	فهرس جزء المحتوى الذي تم إنهاء محتوى النص فيه.	Yes
item_id	string	معرف عنصر الإخراج الذي تم الانتهاء منه من محتوى النص.	Yes
output_index	integer	فهرس عنصر الإخراج الذي تم إنهاء محتوى النص به.	Yes
text	string	محتوى النص الذي تم الانتهاء منه.	Yes
type	enum	نوع الحدث. دائمًا `response.output_text.done`. القيم المحتملة: `response.output_text.done`	Yes

ResponseUsage

يمثل تفاصيل استخدام الرمز المميز بما في ذلك الرموز المميزة للإدخال والرموز المميزة للإخراج وتفصيل الرموز المميزة للإخراج وإجمالي الرموز المميزة المستخدمة.

Name	Type	Description	Required
input_tokens	integer	عدد رموز الإدخال.	Yes
output_tokens	integer	عدد الرموز المميزة للإخراج.	Yes
output_tokens_details	object	تحليل مفصل للرموز المميزة للإخراج.	Yes
└─ reasoning_tokens	integer	عدد الرموز المميزة المنطقية.	No
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة.	Yes

Screenshot

إجراء لقطة شاشة.

Name	Type	Description	Required	Default
type	enum	يحدد نوع الحدث. لإجراء لقطة شاشة، يتم تعيين هذه الخاصية دائما إلى `screenshot`. القيم المحتملة: `screenshot`	Yes

Scroll

إجراء تمرير.

Name	Type	Description	Required
scroll_x	integer	مسافة التمرير الأفقية.	Yes
scroll_y	integer	مسافة التمرير العمودية.	Yes
type	enum	يحدد نوع الحدث. لإجراء التمرير، يتم تعيين هذه الخاصية دائما إلى `scroll`. القيم المحتملة: `scroll`	Yes
x	integer	الإحداثي س حيث حدث التمرير.	Yes
y	integer	الإحداثي ص حيث حدث التمرير.	Yes

StopConfiguration

ما يصل إلى 4 تسلسلات حيث تتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف.

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

TextResponseFormatConfiguration

كائن يحدد التنسيق الذي يجب على النموذج إخراجه.

يتيح التكوين { "type": "json_schema" } المخرجات المنظمة، والتي تضمن تطابق النموذج مع مخطط JSON المقدم.

التنسيق الافتراضي مع { "type": "text" } عدم وجود خيارات إضافية.

غير مستحسن لنماذج gpt-4o والأحدث:

الإعداد لتمكين { "type": "json_object" } وضع JSON الأقدم، والذي يضمن أن الرسالة التي ينشئها النموذج هي JSON صالحة. يفضل استخدام json_schema للنماذج التي تدعمه.

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

ResponseFormatText
TextResponseFormatJsonSchema
ResponseFormatJsonObject

TextResponseFormatJsonSchema

تنسيق استجابة مخطط JSON. يستخدم لإنشاء استجابات JSON منظمة. تعرف على المزيد حول المخرجات المنظمة.

Name	Type	Description	Required	Default
description	string	وصف لما هو تنسيق الاستجابة، يستخدمه النموذج لتحديد كيفية الاستجابة بالتنسيق.	No
name	string	اسم تنسيق الاستجابة. يجب أن يكون a-z، A-Z، 0-9، أو يحتوي على تسطير أسفل السطر والشرطات، بحد أقصى 64.	No
schema	ResponseFormatJsonSchemaSchema	مخطط تنسيق الاستجابة، الموصوف ككائن مخطط JSON.	Yes
strict	boolean	ما إذا كان سيتم تمكين الالتزام الصارم بالمخطط عند إنشاء الإخراج. إذا تم تعيينه إلى true، فسيتبع النموذج دائما المخطط الدقيق المحدد في `schema` الحقل. يتم دعم مجموعة فرعية فقط من مخطط JSON عندما `strict` تكون `true`.	No	False
type	enum	نوع تنسيق الاستجابة الذي يتم تعريفه. دائمًا `json_schema`. القيم المحتملة: `json_schema`	Yes

Tool

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

FileSearchTool
FunctionTool
ComputerTool

ToolChoiceFunction

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

Name	Type	Description	Required	Default
name	string	اسم الدالة التي يجب استدعاها.	Yes
type	enum	لاستدعاء الدالة ، يكون النوع دائما `function`. القيم المحتملة: `function`	Yes

ToolChoiceOptions

يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج.

none يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة.

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

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

Property	Value
Description	يتحكم في الأداة (إن وجدت) التي يستدعيها النموذج. `none` يعني أن النموذج لن يستدعي أي أداة وبدلا من ذلك ينشئ رسالة. `auto` يعني أنه يمكن للنموذج الاختيار بين إنشاء رسالة أو استدعاء أداة واحدة أو أكثر. `required` يعني أن النموذج يجب أن يستدعي أداة واحدة أو أكثر.
Type	string
Values	`none` `auto` `required`

ToolChoiceTypes

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

Name	Type	Description	Required	Default
type	enum	نوع الأداة المستضافة التي يجب أن يستخدمها النموذج. القيم المسموح بها هي: - `file_search` - `computer_use_preview` القيم المحتملة: `file_search`، `computer_use_preview`	Yes

Type

إجراء لكتابة نص.

Name	Type	Description	Required	Default
text	string	النص المراد كتابته.	Yes
type	enum	يحدد نوع الحدث. بالنسبة لإجراء النوع، يتم تعيين هذه الخاصية دائما إلى `type`. القيم المحتملة: `type`	Yes

UpdateVectorStoreFileAttributesRequest

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

UrlCitation

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

Name	Type	Description	Required
end_index	integer	فهرس الحرف الأخير من اقتباس عنوان URL في الرسالة.	Yes
start_index	integer	فهرس الحرف الأول من اقتباس عنوان URL في الرسالة.	Yes
title	string	عنوان مورد الويب.	Yes
type	enum	نوع اقتباس عنوان URL. دائمًا `url_citation`. القيم المحتملة: `url_citation`	Yes
url	string	عنوان URL لمورد الويب.	Yes

VectorStoreFileAttributes

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

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

VectorStoreFileContentResponse

يمثل المحتوى الذي تم تحليله لملف مخزن متجه.

Name	Type	Description	Required
data	array	محتوى تم تحليله للملف.	Yes
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من صفحات المحتوى لإحضارها.	Yes
next_page	string	الرمز المميز للصفحة التالية، إن وجدت.	Yes
object	enum	نوع الكائن، الذي يكون دائما `vector_store.file_content.page` القيم المحتملة: `vector_store.file_content.page`	Yes

VectorStoreSearchRequest

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

VectorStoreSearchResultContentObject

Name	Type	Description	Required	Default
text	string	المحتوى النصي الذي تم إرجاعه من البحث.	Yes
type	enum	نوع المحتوى. القيم المحتملة: `text`	Yes

VectorStoreSearchResultItem

Name	Type	Description	Required
attributes	VectorStoreFileAttributes	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول العنصر بتنسيق منظم، والاستعلام عن العناصر عبر واجهة برمجة التطبيقات أو لوحة المعلومات. المفاتيح هي سلاسل بحد أقصى 64 حرفا. القيم هي سلاسل بحد أقصى 512 حرفا أو قيمة منطقية أو أرقام.	Yes
content	array	مجموعات المحتوى من الملف.	Yes
file_id	string	معرف ملف مخزن المتجهات.	Yes
filename	string	اسم ملف مخزن المتجهات.	Yes
score	number	درجة التشابه للنتيجة.	Yes

VectorStoreSearchResultsPage

Name	Type	Description	Required
data	array	قائمة عناصر نتائج البحث.	Yes
has_more	boolean	يشير إلى ما إذا كان هناك المزيد من النتائج لجلبها.	Yes
next_page	string	الرمز المميز للصفحة التالية، إن وجدت.	Yes
object	enum	نوع الكائن، الذي يكون دائما `vector_store.search_results.page` القيم المحتملة: `vector_store.search_results.page`	Yes
search_query	array		Yes

VoiceIdsShared

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

Wait

إجراء انتظار.

Name	Type	Description	Required	Default
type	enum	يحدد نوع الحدث. لإجراء الانتظار، يتم تعيين هذه الخاصية دائما إلى `wait`. القيم المحتملة: `wait`	Yes

ReasoningEffort

يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي lowو mediumو.high يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة.

Property	Value
Description	يقيد الجهد المبذول في التفكير في نماذج المنطق. القيم المدعومة حاليا هي `low`و `medium`و.`high` يمكن أن يؤدي تقليل جهد المنطق إلى استجابات أسرع والرموز المميزة الأقل المستخدمة في التفكير في الاستجابة.
Type	string
Default	medium
Values	`low` `medium` `high`

errorEvent

يحدث عند حدوث خطأ. يمكن أن يحدث هذا بسبب خطأ خادم داخلي أو مهلة.

Name	Type	Description	Required	Default
data	error		Yes
event	string		Yes

تعداد الحدث: ErrorEventEnum

Value	Description
error

doneEvent

يحدث عند انتهاء الدفق.

Name	Type	Description	Required	Default
data	string		Yes
event	string		Yes

تعداد الحدث: DoneEventEnum

Value	Description
done

تعداد البيانات: DoneEventDataEnum

Value	Description
[DONE]

Next steps

تعرف على النماذج، والضبط الدقيق مع واجهة برمجة تطبيقات REST. تعرف على المزيد حول النماذج underlying التي تعمل Azure OpenAI.

الملاحظات

هل كانت هذه الصفحة مفيدة؟

Last updated on 2026-04-30