ResponseCreateParams interface

الحزمة:

@azure/ai-voicelive

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

الخصائص

appendInputItems	أدخل عناصر لإضافتها إلى سياق المحادثة قبل توليد الرد.
cancelPrevious	هل يجب إلغاء أي جيل مستمر قبل بدء هذا الإصدار. الإعدادات الافتراضية إلى true.
commit	هل يجب الالتزام بالرد على المحادثة. الإعدادات الافتراضية إلى true.
inputItems	عناصر إدخال تستخدم كسياق لهذا الرد. المصفوفة الفارغة تمسح السياق السابق.
instructions	تعليمات النظام الافتراضية (أي رسالة النظام) المثبتة مسبقا على استدعاءات النموذج. يسمح هذا الحقل للعميل بتوجيه النموذج على الاستجابات المطلوبة. يمكن توجيه النموذج حول محتوى الاستجابة وتنسيقها، (على سبيل المثال، "كن مختصرا للغاية"، و"تصرف ودودا"، و"فيما يلي أمثلة للاستجابات الجيدة") وعلى السلوك الصوتي (على سبيل المثال، "التحدث بسرعة"، و"إدخال العاطفة في صوتك"، و"الضحك بشكل متكرر"). لا تضمن التعليمات أن يتبعها النموذج، ولكنها توفر إرشادات للنموذج حول السلوك المطلوب. لاحظ أن الخادم يحدد التعليمات الافتراضية التي ستستخدم إذا لم يكن هذا الحقل مضبوطا وكانت مرئية في session.created الحدث عند بداية الجلسة.
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

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