VoiceLiveSession class
يمثل جلسة تعتمد على WebSocket للتواصل الصوتي في الوقت الحقيقي مع خدمة Azure VoiceLive.
تدير هذه الفئة الاتصال، وتتعامل مع التواصل في الوقت الحقيقي، وتوفر الوصول إلى جميع الميزات التفاعلية بما في ذلك بث الصوت، وإدارة المحادثات، والتحكم في الأفاتار.
المنشئون
| Voice |
ينشئ نسخة من جلسة VoiceLiveSession للجلسات التي تركز على الوكلاء. |
| Voice |
ينشئ نسخة من VoiceLiveSession للجلسات التي تركز على النماذج. |
الخصائص
| active |
يحصل على معرف الدوران الصوتي النشط الحالي. |
| connection |
يحصل على حالة الاتصال الحالية للجلسة. |
| is |
يشير ما إذا كانت الجلسة متصلة حاليا بخدمة الصوت المباشر. |
| session |
يحصل على معرف الجلسة الحالي. |
الأساليب
| add |
يضيف عنصر محادثة (رسالة) إلى المحادثة. |
| connect(Connect |
يؤسس الاتصال بخدمة Voice Live من خلال المصادقة. |
| disconnect() | يفصل الاتصال بخدمة Voice Live وينظف الموارد. |
| dispose() | يتخلص من الجلسة وينظف الموارد. |
| end |
ينهي الدور الصوتي الحالي. |
| send |
يرسل بيانات الصوت إلى الخدمة باستخدام نهج الأدوار أو المخزن المؤقت. |
| send |
يرسل حدث عميل مخصص إلى الخدمة. |
| start |
يبدأ دوران صوتي جديد لإدخال الصوت بنظام الأدوار. |
| subscribe(Voice |
اشترك في فعاليات جلسة VoiceLive باستخدام معالجات قوية التصنيف. |
| update |
يقوم بتحديث تكوين الجلسة مع الخدمة. |
تفاصيل المنشئ
VoiceLiveSession(string, TokenCredential | KeyCredential, AgentSessionConfig, VoiceLiveSessionOptions)
ينشئ نسخة من جلسة VoiceLiveSession للجلسات التي تركز على الوكلاء.
new VoiceLiveSession(endpoint: string, credential: TokenCredential | KeyCredential, agentConfig: AgentSessionConfig, options?: VoiceLiveSessionOptions)المعلمات
- endpoint
-
string
رابط نقطة نهاية خدمة Voice Live
- credential
Azure TokenCredential أو KeyCredential للمصادقة
- agentConfig
- AgentSessionConfig
تكوين الوكيل للجلسة
- options
- VoiceLiveSessionOptions
التكوين الاختياري للجلسة، بما في ذلك apiVersion
VoiceLiveSession(string, TokenCredential | KeyCredential, string, VoiceLiveSessionOptions)
ينشئ نسخة من VoiceLiveSession للجلسات التي تركز على النماذج.
new VoiceLiveSession(endpoint: string, credential: TokenCredential | KeyCredential, model: string, options?: VoiceLiveSessionOptions)المعلمات
- endpoint
-
string
رابط نقطة نهاية خدمة Voice Live
- credential
Azure TokenCredential أو KeyCredential للمصادقة
- model
-
string
اسم النموذج المستخدم في الجلسة
- options
- VoiceLiveSessionOptions
التكوين الاختياري للجلسة، بما في ذلك apiVersion
تفاصيل الخاصية
activeTurnId
يحصل على معرف الدوران الصوتي النشط الحالي.
undefined | string activeTurnIdقيمة الخاصية
undefined | string
connectionState
isConnected
يشير ما إذا كانت الجلسة متصلة حاليا بخدمة الصوت المباشر.
boolean isConnectedقيمة الخاصية
boolean
sessionId
يحصل على معرف الجلسة الحالي.
undefined | string sessionIdقيمة الخاصية
undefined | string
تفاصيل الأسلوب
addConversationItem(ConversationRequestItemUnion, SendEventOptions)
يضيف عنصر محادثة (رسالة) إلى المحادثة.
function addConversationItem(item: ConversationRequestItemUnion, options?: SendEventOptions): Promise<void>المعلمات
- options
- SendEventOptions
المرتجعات
Promise<void>
connect(ConnectOptions)
يؤسس الاتصال بخدمة Voice Live من خلال المصادقة.
function connect(options?: ConnectOptions): Promise<void>المعلمات
- options
- ConnectOptions
المرتجعات
Promise<void>
disconnect()
يفصل الاتصال بخدمة Voice Live وينظف الموارد.
function disconnect(): Promise<void>المرتجعات
Promise<void>
dispose()
يتخلص من الجلسة وينظف الموارد.
function dispose(): Promise<void>المرتجعات
Promise<void>
endAudioTurn(string, SendEventOptions)
ينهي الدور الصوتي الحالي.
function endAudioTurn(turnId?: string, options?: SendEventOptions): Promise<void>المعلمات
- turnId
-
string
- options
- SendEventOptions
المرتجعات
Promise<void>
sendAudio(Uint8Array | ArrayBuffer, AudioStreamOptions)
يرسل بيانات الصوت إلى الخدمة باستخدام نهج الأدوار أو المخزن المؤقت.
function sendAudio(audioData: Uint8Array | ArrayBuffer, options?: AudioStreamOptions): Promise<void>المعلمات
- audioData
-
Uint8Array | ArrayBuffer
- options
- AudioStreamOptions
المرتجعات
Promise<void>
sendEvent(ClientEventUnion, SendEventOptions)
يرسل حدث عميل مخصص إلى الخدمة.
function sendEvent(event: ClientEventUnion, options?: SendEventOptions): Promise<void>المعلمات
- event
- ClientEventUnion
- options
- SendEventOptions
المرتجعات
Promise<void>
startAudioTurn(TurnOptions)
يبدأ دوران صوتي جديد لإدخال الصوت بنظام الأدوار.
function startAudioTurn(options?: TurnOptions): Promise<string>المعلمات
- options
- TurnOptions
المرتجعات
Promise<string>
subscribe(VoiceLiveSessionHandlers)
اشترك في فعاليات جلسة VoiceLive باستخدام معالجات قوية التصنيف.
function subscribe(handlers: VoiceLiveSessionHandlers): VoiceLiveSubscriptionالمعلمات
- handlers
- VoiceLiveSessionHandlers
دوال المعالج لأنواع مختلفة من الأحداث
المرتجعات
كائن اشتراك يمكن استخدامه لإيقاف استقبال الأحداث
updateSession(RequestSession, SendEventOptions)
يقوم بتحديث تكوين الجلسة مع الخدمة.
function updateSession(session: RequestSession, options?: SendEventOptions): Promise<void>المعلمات
- session
- RequestSession
- options
- SendEventOptions
المرتجعات
Promise<void>