Response interface

الحزمة:

@azure/ai-voicelive

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

الخصائص

conversationId	أي محادثة تضاف إليها الرد، وذلك conversation حسب response.create الحقل في الحدث. إذا auto، سيتم إضافة الرد إلى المحادثة الافتراضية وستكون قيمة id conversation_id مثل conv_1234. إذا noneكان ، فلن تضاف الرد إلى أي محادثة وستكون conversation_idقيمة .null إذا كانت الردود تفعل بواسطة VAD الخاص بالخادم، إضافة الرد إلى المحادثة الافتراضية، وبالتالي conversation_id سيكون هناك id مثل conv_1234.
id	المعرف الفريد للاستجابة.
maxOutputTokens	الحد الأقصى لعدد رموز الإخراج لاستجابة مساعد واحدة، بما في ذلك استدعاءات الأدوات، التي تم استخدامها في هذا الاستجابة.
metadata	قم بتعيين ما يصل إلى 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.
modalities	مجموعة الأنماط التي استخدمها النموذج للرد. إذا كانت هناك عدة أوضايع، سيختار النموذج واحدة، على سبيل المثال إذا modalities كان ، ["text", "audio"]فقد يستجيب النموذج إما نصيا أو صوتيا.
object	يجب أن يكون نوع الكائن، .realtime.response
output	قائمة العناصر الناتجة التي تولدها الرد.
outputAudioFormat	تنسيق صوت الإخراج. الخيارات هي pcm16أو g711_ulawأو g711_alaw.
status	الحالة النهائية للرد. واحد من: completed، cancelled، failed، incomplete، أو in_progress.
statusDetails	تفاصيل إضافية حول الحالة.
temperature	درجة حرارة أخذ العينات للنموذج، تقتصر على [0.6، 1.2]. الإعدادات الافتراضية إلى 0.8.
usage	إحصائيات الاستخدام للرد، ستتوافق مع الفوترة. ستحتفظ جلسة واجهة برمجة تطبيقات VoiceLive بسياق المحادثة وتضيف عناصر جديدة إلى المحادثة، وبالتالي ستصبح المخرجات من الأدوار السابقة (رموز النص والصوت) هي المدخل للأدوار اللاحقة.
voice	يدعم معرفات الصوت والتكوينات.

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

conversationId

أي محادثة تضاف إليها الرد، وذلك conversation حسب response.create الحقل في الحدث. إذا auto، سيتم إضافة الرد إلى المحادثة الافتراضية وستكون قيمة id conversation_id مثل conv_1234. إذا noneكان ، فلن تضاف الرد إلى أي محادثة وستكون conversation_idقيمة .null إذا كانت الردود تفعل بواسطة VAD الخاص بالخادم، إضافة الرد إلى المحادثة الافتراضية، وبالتالي conversation_id سيكون هناك id مثل conv_1234.

conversationId?: string

قيمة الخاصية

string

id

المعرف الفريد للاستجابة.

id?: string

قيمة الخاصية

string

maxOutputTokens

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

maxOutputTokens?: number | "inf"

قيمة الخاصية

number | "inf"

metadata

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

metadata?: Record<string, string>

قيمة الخاصية

Record<string, string>

modalities

مجموعة الأنماط التي استخدمها النموذج للرد. إذا كانت هناك عدة أوضايع، سيختار النموذج واحدة، على سبيل المثال إذا modalities كان ، ["text", "audio"]فقد يستجيب النموذج إما نصيا أو صوتيا.

modalities?: string[]

قيمة الخاصية

string[]

object

يجب أن يكون نوع الكائن، .realtime.response

object?: "realtime.response"

قيمة الخاصية

"realtime.response"

output

قائمة العناصر الناتجة التي تولدها الرد.

output?: ResponseItemUnion[]

قيمة الخاصية

ResponseItemUnion[]

outputAudioFormat

تنسيق صوت الإخراج. الخيارات هي pcm16أو g711_ulawأو g711_alaw.

outputAudioFormat?: string

قيمة الخاصية

string

status

الحالة النهائية للرد.

واحد من: completed، cancelled، failed، incomplete، أو in_progress.

status?: string

قيمة الخاصية

string

statusDetails

تفاصيل إضافية حول الحالة.

statusDetails?: ResponseStatusDetailsUnion

قيمة الخاصية

ResponseStatusDetailsUnion

temperature

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

temperature?: number

قيمة الخاصية

number

usage

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

usage?: TokenUsage

قيمة الخاصية

TokenUsage

voice

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

voice?: Voice

قيمة الخاصية

Voice