GetChatCompletionsOptions interface

الحزمة:

@azure/openai

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

Extends

OperationOptions

الخصائص

azureExtensionOptions	إدخالات التكوين لملحقات دردشة Azure OpenAI التي تستخدمها. هذه المواصفات الإضافية متوافقة فقط مع Azure OpenAI.
frequencyPenalty	قيمة تؤثر على احتمال ظهور الرموز المميزة التي تم إنشاؤها استنادا إلى تكرارها التراكمي في النص الذي تم إنشاؤه. ستجعل القيم الموجبة الرموز المميزة أقل عرضة للظهور مع زيادة تكرارها وتقليل احتمال تكرار النموذج لنفس العبارات حرفيا.
functionCall	يتحكم في كيفية استجابة النموذج لاستدعاءات الوظائف. تعني كلمة "لا شيء" أن النموذج لا يستدعي دالة، ويستجيب للمستخدم النهائي. تعني "تلقائية" أن النموذج يمكنه الاختيار بين مستخدم أو استدعاء دالة. يؤدي تحديد دالة معينة عبر {"name": "my_function"} إلى إجبار النموذج على استدعاء تلك الدالة. "لا شيء" هو الافتراضي عندما لا تكون هناك دالات. "auto" هو الافتراضي إذا كانت الدالات موجودة.
functions	قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها.
logitBias	خريطة بين معرفات الرمز المميز GPT ودرجات التحيز التي تؤثر على احتمال ظهور رموز مميزة محددة في استجابة الإكمال. يتم حساب معرفات الرمز المميز عبر أدوات الرمز المميز الخارجية، بينما توجد درجات التحيز في نطاق -100 إلى 100 مع القيم الدنيا والحد الأقصى المقابلة للحظر الكامل أو التحديد الحصري للرمز المميز، على التوالي. يختلف السلوك الدقيق لدرجة تحيز معينة حسب النموذج.
maxTokens	الحد الأقصى لعدد الرموز المميزة المراد إنشاؤها.
n	عدد خيارات إكمال الدردشة التي يجب إنشاؤها لاستجابة إكمال الدردشة. نظرا لأن هذا الإعداد يمكن أن ينشئ العديد من عمليات الإكمال، فقد يستهلك بسرعة حصة الرمز المميز الخاصة بك. استخدم بعناية وتأكد من وجود إعدادات معقولة ل maxTokens وإيقافها.
presencePenalty	قيمة تؤثر على احتمال ظهور الرموز المميزة التي تم إنشاؤها استنادا إلى وجودها الحالي في النص الذي تم إنشاؤه. ستجعل القيم الموجبة الرموز المميزة أقل عرضة للظهور عندما تكون موجودة بالفعل وتزيد من احتمالية إخراج النموذج لمواضيع جديدة.
responseFormat	كائن يحدد التنسيق الذي يجب أن يخرجه النموذج. يستخدم لتمكين وضع JSON.
seed	إذا تم تحديده، فسيبذل النظام أفضل جهد لأخذ عينات بشكل محدد بحيث يجب أن ترجع الطلبات المتكررة بنفس البذور والمعلمات نفس النتيجة. الحتمية غير مضمونة، ويجب أن تشير إلى معلمة استجابة system_fingerprint لمراقبة التغييرات في الخلفية."
stop	مجموعة من التسلسلات النصية التي ستنهي إنشاء الإكمال.
temperature	درجة حرارة أخذ العينات لاستخدامها تتحكم في الإبداع الواضح للإكمالات التي تم إنشاؤها. القيم الأعلى ستجعل الإخراج أكثر عشوائية بينما القيم الأقل ستجعل النتائج أكثر تركيزا وحتمية. لا يوصى بتعديل درجة الحرارة و topP لنفس طلب الإكمال حيث يصعب التنبؤ بتفاعل هذين الإعدادين.
toolChoice	إذا تم تحديده، سيقوم النموذج بتكوين أي من الأدوات المتوفرة يمكنه استخدامها لاستجابة إكمال الدردشة.
tools	تعريفات الأدوات المتوفرة التي يمكن أن يستخدمها طلب إكمال الدردشة، بما في ذلك الوظائف المعرفة من قبل المتصل.
topP	بديل لأخذ العينات بدرجة حرارة تسمى أخذ عينات النواة. تتسبب هذه القيمة في أن يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة الاحتمال المتوفرة. على سبيل المثال، ستؤدي قيمة 0.15 إلى النظر فقط في الرموز المميزة التي تتألف من أعلى 15٪ من كتلة الاحتمال. لا يوصى بتعديل درجة الحرارة و topP لنفس طلب الإكمال حيث يصعب التنبؤ بتفاعل هذين الإعدادين.
user	معرف للمتصل أو المستخدم النهائي للعملية. يمكن استخدام هذا لأغراض التعقب أو تحديد المعدل.

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

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

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

azureExtensionOptions

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

azureExtensionOptions?: AzureExtensionsOptions

قيمة الخاصية

AzureExtensionsOptions

frequencyPenalty

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

frequencyPenalty?: number

قيمة الخاصية

number

functionCall

يتحكم في كيفية استجابة النموذج لاستدعاءات الوظائف. تعني كلمة "لا شيء" أن النموذج لا يستدعي دالة، ويستجيب للمستخدم النهائي. تعني "تلقائية" أن النموذج يمكنه الاختيار بين مستخدم أو استدعاء دالة. يؤدي تحديد دالة معينة عبر {"name": "my_function"} إلى إجبار النموذج على استدعاء تلك الدالة. "لا شيء" هو الافتراضي عندما لا تكون هناك دالات. "auto" هو الافتراضي إذا كانت الدالات موجودة.

functionCall?: string | FunctionName

قيمة الخاصية

string | FunctionName

functions

قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها.

functions?: FunctionDefinition[]

قيمة الخاصية

FunctionDefinition[]

logitBias

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

logitBias?: Record<string, number>

قيمة الخاصية

Record<string, number>

maxTokens

الحد الأقصى لعدد الرموز المميزة المراد إنشاؤها.

maxTokens?: number

قيمة الخاصية

number

n

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

n?: number

قيمة الخاصية

number

presencePenalty

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

presencePenalty?: number

قيمة الخاصية

number

responseFormat

كائن يحدد التنسيق الذي يجب أن يخرجه النموذج. يستخدم لتمكين وضع JSON.

responseFormat?: ChatCompletionsResponseFormat

قيمة الخاصية

ChatCompletionsResponseFormat

seed

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

seed?: number

قيمة الخاصية

number

stop

مجموعة من التسلسلات النصية التي ستنهي إنشاء الإكمال.

stop?: string[]

قيمة الخاصية

string[]

temperature

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

temperature?: number

قيمة الخاصية

number

toolChoice

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

toolChoice?: ChatCompletionsNamedToolSelectionUnion

قيمة الخاصية

ChatCompletionsNamedToolSelectionUnion

tools

تعريفات الأدوات المتوفرة التي يمكن أن يستخدمها طلب إكمال الدردشة، بما في ذلك الوظائف المعرفة من قبل المتصل.

tools?: ChatCompletionsToolDefinitionUnion[]

قيمة الخاصية

ChatCompletionsToolDefinitionUnion[]

topP

بديل لأخذ العينات بدرجة حرارة تسمى أخذ عينات النواة. تتسبب هذه القيمة في أن يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة الاحتمال المتوفرة. على سبيل المثال، ستؤدي قيمة 0.15 إلى النظر فقط في الرموز المميزة التي تتألف من أعلى 15٪ من كتلة الاحتمال. لا يوصى بتعديل درجة الحرارة و topP لنفس طلب الإكمال حيث يصعب التنبؤ بتفاعل هذين الإعدادين.

topP?: number

قيمة الخاصية

number

user

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

user?: string

قيمة الخاصية

string

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

abortSignal

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

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

موروث من OperationOptions.abortSignal

onResponse

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

onResponse?: RawResponseCallback

قيمة الخاصية

RawResponseCallback

موروث من OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

قيمة الخاصية

OperationRequestOptions

موروث من OperationOptions.requestOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

قيمة الخاصية

OperationTracingOptions

موروث من OperationOptions.tracingOptions