ResponseCreateParams interface

الحزمة:

@azure/ai-voicelive

أنشئ استجابة جديدة ل VoiceLive باستخدام هذه المعايير

الخصائص

appendInputItems	أدخل عناصر لإضافتها إلى سياق المحادثة قبل توليد الرد.
cancelPrevious	هل يجب إلغاء أي جيل مستمر قبل بدء هذا الإصدار. الإعدادات الافتراضية إلى true.
commit	هل يجب الالتزام بالرد على المحادثة. الإعدادات الافتراضية إلى true.
inputItems	عناصر إدخال تستخدم كسياق لهذا الرد. المصفوفة الفارغة تمسح السياق السابق.
instructions	كانت تعليمات النظام الافتراضية (أي رسالة النظام) تسبق استدعاءات النماذج. يتيح هذا المجال للعميل توجيه النموذج نحو الاستجابات المرغوبة. يمكن توجيه النموذج حول محتوى الاستجابة وصيغته، (مثل "كن موجزة للغاية"، "تصرف ودودا"، "إليك أمثلة على الردود الجيدة") وعلى سلوك الصوت (مثل "تحدث بسرعة"، "حقن المشاعر في صوتك"، "الضحك كثيرا"). التعليمات ليست مضمونة أن يتبعها النموذج، لكنها تقدم إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.
interimResponse	تكوين توليد الاستجابة المؤقتة أثناء زمن الاستجابة أو استدعاءات الأدوات.
maxOutputTokens	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحد، بما في ذلك استدعاءات الأدوات. توفير عدد صحيح بين 1 و4096 لتحديد رموز الإخراج، أو inf لأقصى رموز متاحة لنموذج معين. تتغير افتراضيا إلى inf.
metadata	مجموعة من ما يصل إلى 16 زوجا من مفاتيح-قيمة يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة. يمكن أن تكون المفاتيح بحد أقصى 64 حرفا وحتى 512 حرفا.
modalities	مجموعة الأنماط التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا على ["نص"].
outputAudioFormat	صيغة الصوت المخرج. الخيارات هي pcm16، g711_ulaw، أو g711_alaw.
preGeneratedAssistantMessage	أنشئ الرد برسالة مساعد مولدة مسبقا. يتم إضافة عنصر الرسالة إلى سجل المحادثة ويعاد مع إخراج صوتي مركب في الرد الذي تم إنشاؤه.
reasoningEffort	يقيد الجهد في التفكير في نماذج الاستدلال. تحقق من توثيق النموذج للقيم المدعومة لكل نموذج. تقليل جهد التفكير يمكن أن يؤدي إلى استجابة أسرع واستخدام رموز أقل في الاستدلال.
temperature	درجة حرارة أخذ العينة للنموذج، محدودة ب [0.6، 1.2]. الوضع الافتراضي هو 0.8.
toolChoice	كيف يختار النموذج الأدوات. الخيارات هي auto، none، required، أو تحديد دالة مثل {"type": "function", "function": {"name": "my_function"}}.
tools	الأدوات (الدوال) المتاحة للنموذج.
voice	يدعم معرفات الصوت والتكوينات.

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

appendInputItems

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

appendInputItems?: ConversationRequestItemUnion[]

قيمة الخاصية

ConversationRequestItemUnion[]

cancelPrevious

هل يجب إلغاء أي جيل مستمر قبل بدء هذا الإصدار. الإعدادات الافتراضية إلى true.

cancelPrevious?: boolean

قيمة الخاصية

boolean

commit

هل يجب الالتزام بالرد على المحادثة. الإعدادات الافتراضية إلى true.

commit?: boolean

قيمة الخاصية

boolean

inputItems

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

inputItems?: ConversationRequestItemUnion[]

قيمة الخاصية

ConversationRequestItemUnion[]

instructions

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

لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.

instructions?: string

قيمة الخاصية

string

interimResponse

تكوين توليد الاستجابة المؤقتة أثناء زمن الاستجابة أو استدعاءات الأدوات.

interimResponse?: InterimResponseConfig

قيمة الخاصية

InterimResponseConfig

maxOutputTokens

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

maxOutputTokens?: number | "inf"

قيمة الخاصية

number | "inf"

metadata

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

metadata?: Record<string, string>

قيمة الخاصية

Record<string, string>

modalities

مجموعة الأنماط التي يمكن للنموذج الاستجابة بها. لتعطيل الصوت، قم بتعيين هذا على ["نص"].

modalities?: string[]

قيمة الخاصية

string[]

outputAudioFormat

صيغة الصوت المخرج. الخيارات هي pcm16، g711_ulaw، أو g711_alaw.

outputAudioFormat?: string

قيمة الخاصية

string

preGeneratedAssistantMessage

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

preGeneratedAssistantMessage?: AssistantMessageItem

قيمة الخاصية

AssistantMessageItem

reasoningEffort

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

reasoningEffort?: string

قيمة الخاصية

string

temperature

درجة حرارة أخذ العينة للنموذج، محدودة ب [0.6، 1.2]. الوضع الافتراضي هو 0.8.

temperature?: number

قيمة الخاصية

number

toolChoice

كيف يختار النموذج الأدوات. الخيارات هي auto، none، required، أو تحديد دالة مثل {"type": "function", "function": {"name": "my_function"}}.

toolChoice?: string

قيمة الخاصية

string

tools

الأدوات (الدوال) المتاحة للنموذج.

tools?: ToolUnion[]

قيمة الخاصية

ToolUnion[]

voice

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

voice?: Voice

قيمة الخاصية

Voice