RunsCreateRunOptionalParams interface

الحزمة:

@azure/ai-agents

المعلمات الاختيارية.

يمتد

OperationOptions,PollingOptionsParams

الخصائص

additionalInstructions	إرشادات إضافية لإلحاقها في نهاية التعليمات الخاصة بالتشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل دون تجاوز إرشادات أخرى.
additionalMessages	إضافة رسائل إضافية إلى مؤشر الترابط قبل إنشاء التشغيل.
include	قائمة بالحقول الإضافية لتضمينها في الاستجابة. القيمة الوحيدة المدعومة حاليا هي step_details.tool_calls[*].file_search.results[*].content إحضار محتوى نتيجة البحث عن الملفات.
instructions	إرشادات النظام التي تم تجاوزها التي يجب أن يستخدمها العامل لتشغيل مؤشر الترابط.
maxCompletionTokens	الحد الأقصى لعدد رموز الإكمال المميزة التي يمكن استخدامها على مدار التشغيل. سيبذل التشغيل أفضل جهد لاستخدام عدد رموز الإكمال المميزة المحددة فقط، عبر عدة عمليات تشغيل. إذا تجاوز التشغيل عدد رموز الإكمال المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.
maxPromptTokens	الحد الأقصى لعدد الرموز المميزة للمطالبة التي يمكن استخدامها على مدار التشغيل. سيبذل التشغيل أفضل جهد لاستخدام عدد الرموز المميزة للمطالبة المحددة فقط، عبر عمليات تشغيل متعددة. إذا تجاوز التشغيل عدد الرموز المميزة للمطالبة المحددة، فسينتهي التشغيل بالحالة incomplete. راجع incomplete_details لمزيد من المعلومات.
metadata	مجموعة تصل إلى 16 زوج مفتاح/قيمة يمكن إرفاقها بكائن، وتستخدم لتخزين معلومات إضافية حول هذا الكائن بتنسيق منظم. قد يصل طول المفاتيح إلى 64 حرفا وقد يصل طول القيم إلى 512 حرفا.
model	اسم النموذج الذي تم تجاوزه الذي يجب أن يستخدمه العامل لتشغيل مؤشر الترابط.
parallelToolCalls	إذا كان سيتم تشغيل وظائف true بالتوازي أثناء استخدام الأداة.
responseFormat	تحديد التنسيق الذي يجب على النموذج إخراجه.
stream	إذا true، فترجع دفق الأحداث التي تحدث أثناء الأحداث تشغيل كأحداث مرسلة بواسطة الخادم، تنتهي عند إدخال تشغيل حالة طرفية برسالة data: [DONE].
temperature	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.
toolChoice	يتحكم في ما إذا كان أو لا وأي أداة يتم استدعاؤها بواسطة النموذج.
toolResources	موارد الأداة الممكنة التي تم تجاوزها والتي يجب على العامل استخدامها لتشغيل مؤشر الترابط.
tools	قائمة الأدوات الممكنة التي يجب أن يستخدمها العامل لتشغيل مؤشر الترابط.
topP	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.
truncationStrategy	الاستراتيجية التي يجب استخدامها لإسقاط الرسائل مع انتقال نوافذ السياق إلى الأمام.

الخصائص الموروثة

abortSignal	الإشارة التي يمكن استخدامها لإجهاض الطلبات.
onResponse	دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات.
pollingOptions	خيارات لتكوين سلوك الاستقصاء.
requestOptions	الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.
tracingOptions	الخيارات المستخدمة عند تمكين التتبع.

تفاصيل الخاصية

additionalInstructions

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

additionalInstructions?: string | null

قيمة الخاصية

string | null

additionalMessages

إضافة رسائل إضافية إلى مؤشر الترابط قبل إنشاء التشغيل.

additionalMessages?: ThreadMessageOptions[] | null

قيمة الخاصية

ThreadMessageOptions[] | null

include

قائمة بالحقول الإضافية لتضمينها في الاستجابة. القيمة الوحيدة المدعومة حاليا هي step_details.tool_calls[*].file_search.results[*].content إحضار محتوى نتيجة البحث عن الملفات.

include?: "step_details.tool_calls[*].file_search.results[*].content"[]

قيمة الخاصية

"step_details.tool_calls[].file_search.results[].content"[]

instructions

إرشادات النظام التي تم تجاوزها التي يجب أن يستخدمها العامل لتشغيل مؤشر الترابط.

instructions?: string | null

قيمة الخاصية

string | null

maxCompletionTokens

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

maxCompletionTokens?: number | null

قيمة الخاصية

number | null

maxPromptTokens

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

maxPromptTokens?: number | null

قيمة الخاصية

number | null

metadata

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

metadata?: Record<string, string> | null

قيمة الخاصية

Record<string, string> | null

model

اسم النموذج الذي تم تجاوزه الذي يجب أن يستخدمه العامل لتشغيل مؤشر الترابط.

model?: string | null

قيمة الخاصية

string | null

parallelToolCalls

إذا كان سيتم تشغيل وظائف true بالتوازي أثناء استخدام الأداة.

parallelToolCalls?: boolean

قيمة الخاصية

boolean

responseFormat

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

responseFormat?: AgentsResponseFormatOption | null

قيمة الخاصية

AgentsResponseFormatOption | null

stream

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

stream?: boolean

قيمة الخاصية

boolean

temperature

ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما.

temperature?: number | null

قيمة الخاصية

number | null

toolChoice

يتحكم في ما إذا كان أو لا وأي أداة يتم استدعاؤها بواسطة النموذج.

toolChoice?: AgentsToolChoiceOption | null

قيمة الخاصية

AgentsToolChoiceOption | null

toolResources

موارد الأداة الممكنة التي تم تجاوزها والتي يجب على العامل استخدامها لتشغيل مؤشر الترابط.

toolResources?: ToolResources | null

قيمة الخاصية

ToolResources | null

tools

قائمة الأدوات الممكنة التي يجب أن يستخدمها العامل لتشغيل مؤشر الترابط.

tools?: ToolDefinitionUnion[] | null

قيمة الخاصية

ToolDefinitionUnion[] | null

topP

بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة احتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر.

نوصي عموما بتغيير هذه أو درجة الحرارة ولكن ليس كليهما.

topP?: number | null

قيمة الخاصية

number | null

truncationStrategy

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

truncationStrategy?: TruncationObject | null

قيمة الخاصية

TruncationObject | null

تفاصيل الخاصية الموروثة

abortSignal

الإشارة التي يمكن استخدامها لإجهاض الطلبات.

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

موروث من OperationOptions.abortSignal

onResponse

دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات.

onResponse?: RawResponseCallback

قيمة الخاصية

RawResponseCallback

موروث من OperationOptions.onResponse

pollingOptions

خيارات لتكوين سلوك الاستقصاء.

pollingOptions?: PollingOptions

قيمة الخاصية

PollingOptions

موروث منPollingOptionsParams.pollingOptions

requestOptions

الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.

requestOptions?: OperationRequestOptions

قيمة الخاصية

OperationRequestOptions

موروثة من OperationOptions.requestOptions

tracingOptions

الخيارات المستخدمة عند تمكين التتبع.

tracingOptions?: OperationTracingOptions

قيمة الخاصية

OperationTracingOptions

موروث من OperationOptions.tracingOptions