Topik ini menjelaskan tipe data yang digunakan oleh Web SDK.
Ikhtisar Struktur Data
Versi SDK sebelumnya berisi parameter dan metode yang sudah tidak digunakan lagi. Tingkatkan SDK ke versi terbaru. Untuk informasi lebih lanjut, lihat Panduan Pengguna Web SDK.
Tipe struktur | Tipe data | Deskripsi |
Enum | Tipe agen | |
Status agen | ||
Alasan mengapa agen terganggu saat berbicara | ||
Hasil feedback VAD | ||
Kode kesalahan | ||
Class | Informasi runtime agen | |
Permintaan untuk mengonfigurasi penangkapan frame kustom untuk agen pemahaman visual | ||
Permintaan untuk mengirim pesan teks ke agen | ||
Konfigurasi untuk memulai panggilan agen | ||
Parameter konfigurasi template untuk memulai panggilan | ||
Konfigurasi untuk sesi agen obrolan terkait | ||
Konfigurasi berbagi agen | ||
Konfigurasi untuk memulai dan menjalankan agen panggilan | ||
Konfigurasi pengenalan suara | ||
Konfigurasi sintesis suara | ||
Konfigurasi model bahasa besar | ||
Konfigurasi manusia digital | ||
Konfigurasi interupsi | ||
Konfigurasi peredam bising voiceprint | ||
Konfigurasi deteksi giliran | ||
Hasil deteksi VCR | ||
Konfigurasi VCR | ||
Konfigurasi dasar deteksi VCR | ||
Konfigurasi deteksi gerakan frame VCR |
Rincian Struktur Data
Enum
AICallAgentType
Tipe agen.
Nilai enumerasi | Nilai | Deskripsi |
VoiceAgent | 0 | Hanya mendukung tanggapan suara interaktif dan tidak memiliki avatar visual. |
AvatarAgent | 1 | Memiliki avatar virtual dan mendukung interaksi suara dan visual. |
VisionAgent | 2 | Bertanggung jawab utama untuk memahami dan menganalisis informasi visual. |
VideoAgent | 3 | Panggilan video. Mendukung panggilan video dua arah antara pengguna dan agen. |
AICallAgentState
Status agen.
Nilai enumerasi | Nilai | Deskripsi |
Listening | 1 | Mendengarkan |
Thinking | 2 | Berpikir |
Speaking | 3 | Berbicara |
AICallSpeakingInterruptedReason
Alasan agen terganggu saat berbicara.
Nilai enumerasi | Nilai | Deskripsi |
unknown | 0 | Alasan tidak diketahui |
byWords | 1 | Diganggu karena kata tertentu terdeteksi. |
byVoice | 2 | Diganggu oleh suara. |
byInterruptSpeaking | 3 | Diganggu oleh pemanggilan API interruptSpeaking. |
bySpeechBroadCast | 4 | Diganggu oleh siaran suara aktif. |
byLlmQuery | 5 | Diganggu oleh query LLM aktif. |
AICallVoiceprintResult
Hasil feedback Deteksi Aktivitas Suara (VAD).
Nilai enumerasi | Nilai | Deskripsi |
Off | 0 | Voiceprint noise reduction VAD dinonaktifkan, dan AI VAD dinonaktifkan. |
Unregister | 1 | Voiceprint noise reduction VAD diaktifkan, tetapi pendaftaran voiceprint belum selesai. |
DetectedSpeaker | 2 | Voiceprint noise reduction VAD diaktifkan, dan pembicara utama terdeteksi. |
UndetectedSpeaker | 3 | Voiceprint noise reduction VAD diaktifkan, tetapi pembicara utama tidak terdeteksi. |
DetectedSpeakerWithAIVad | 4 | AI VAD diaktifkan, dan pembicara utama terdeteksi. |
UndetectedSpeakerWithAIVad | 5 | AI VAD diaktifkan, tetapi pembicara utama tidak terdeteksi. |
Unknown | 100 | Tidak diketahui |
AICallErrorCode
Kode kesalahan.
Nilai enumerasi | Nilai | Deskripsi |
None | 0 | Berhasil |
InvalidAction | -1 | Operasi tidak valid |
InvalidParames | -2 | Parameter tidak valid |
NetworkError | -3 | Kesalahan jaringan |
InternalError | -4 | Kesalahan internal |
BeginCallFailed | -10000 | Gagal memulai panggilan. |
ConnectionFailed | -10001 | Masalah koneksi terjadi. |
PublishFailed | -10002 | Gagal mengirim aliran. |
SubscribeFailed | -10003 | Gagal menarik aliran. |
TokenExpired | -10004 | Otentikasi panggilan kedaluwarsa. |
KickedByUserReplace | -10005 | Panggilan tidak dapat dilanjutkan karena pengguna lain masuk dengan nama yang sama. |
KickedBySystem | -10006 | Panggilan tidak dapat dilanjutkan karena pengguna ditendang oleh sistem. |
KickedByChannelTerminated | -10007 | Panggilan tidak dapat dilanjutkan karena saluran dihapus. |
LocalDeviceException | -10008 | Panggilan tidak dapat dilanjutkan karena masalah perangkat lokal. |
AgentLeaveChannel | -10101 | Agen meninggalkan saluran (agen mengakhiri panggilan). |
AgentPullFailed | -10102 | Agen gagal menarik aliran. |
AgentASRFailed | -10103 | ASR agen gagal. |
AvatarServiceFailed | -10201 | Gagal memulai layanan agen digital. |
AvatarRoutesExhausted | -10202 | Jumlah titik akhir ingest agen digital bersamaan terlampaui. |
AgentSubscriptionRequired | -10203 | Panggilan tidak dapat dimulai karena kuota percobaan gratis harian terlampaui. |
AgentNotFound | -10204 | Agen tidak ditemukan (ID agen tidak ada). |
ChatTextMessageSendFailed | -10301 | Gagal mengirim pesan teks. |
ChatTextMessageReceiveFailed | -10302 | Gagal menerima pesan teks. |
ChatVoiceRecordFailed | -10310 | Gagal merekam pesan suara. |
ChatVoiceMessageSendFailed | -10311 | Gagal mengirim pesan suara. |
ChatVoiceMessageReceiveFailed | -10312 | Gagal menerima pesan suara. |
ChatPlayMessageReceiveFailed | -10321 | Gagal menerima pesan pemutaran. |
ChatLogNotFound | -10331 | Riwayat obrolan tidak ditemukan. |
ChatAttachmentUploading | -10332 | Lampiran masih diunggah. Pesan hanya dapat dikirim setelah unggahan selesai. |
UnknowError | -40000 | Kesalahan tidak diketahui |
Class
AICallAgentInfo
Informasi runtime agen.
Properti | Tipe | Deskripsi |
agentType | Tipe agen. | |
channelId | string | ID saluran RTC tempat agen berada. |
userId | string | Pengenal unik untuk agen masuk ke saluran RTC. |
instanceId | string | ID instans tempat agen berjalan. |
reqId | string | ID permintaan untuk memulai agen saat ini. |
AICallVisionCustomCaptureRequest
Model permintaan untuk mengonfigurasi penangkapan frame kustom untuk agen pemahaman visual.
Properti | Tipe | Deskripsi |
text | string | Parameter teks untuk meminta model besar multimodal. |
isSingle | boolean | Menentukan apakah akan menangkap satu frame. |
eachDuration | number | Interval antara penangkapan frame, dalam detik. |
num | number | Jumlah gambar yang ditangkap setiap kali. |
duration | number | Durasi penangkapan frame kontinu, dalam detik. Parameter ini efektif hanya untuk penangkapan frame kontinu. |
userData (Opsional) | string | String JSON yang berisi informasi bisnis khusus. |
AICallSendTextToAgentRequest
Model permintaan untuk mengirim pesan teks ke agen.
Properti | Tipe | Deskripsi |
text | string | Pesan teks untuk menanyakan agen, misalnya, "Apa ini?". |
AICallConfig
Konfigurasi untuk memulai panggilan agen.
Properti | Tipe | Deskripsi |
agentId | string | ID agen. |
agentType | Tipe agen. | |
agentUserId (Opsional) | string | UID agen. Jika ini dibiarkan kosong, layanan memberikan UID. |
region | string | Wilayah tempat layanan agen berada. |
userId | string | ID pengguna saat ini. |
userJoinToken | string | Token untuk pengguna saat ini bergabung dalam rapat. |
userData (Opsional) | string | Informasi pengguna khusus yang dilewatkan ke agen. Kami sarankan menggunakan string JSON. |
chatSyncConfig (Opsional) | Konfigurasi untuk agen obrolan terkait. | |
agentConfig (Opsional) | Parameter agentConfig yang digunakan untuk memulai panggilan. | |
templateConfig (Opsional) | Tidak digunakan lagi. Gunakan |
AICallTemplateConfig (Tidak digunakan lagi)
Parameter TemplateConfig untuk memulai panggilan.
Metode ini tidak digunakan lagi di versi 2.5 dan yang lebih baru. Di versi terbaru, gunakan AICallAgentConfig.
Properti | Tipe | Deskripsi |
agentGreeting (Opsional) | string | Pesan selamat datang agen. Jika ini dibiarkan kosong, nilai yang dikonfigurasikan untuk agen digunakan. |
userOnlineTimeout | number | Jangka waktu timeout bagi agen untuk menutup tugas jika pengguna tidak bergabung dalam rapat. Jika nilainya kurang dari 0, nilai default sisi server sebesar 60 detik digunakan. |
userOfflineTimeout | number | Jangka waktu timeout bagi agen untuk menutup tugas setelah pengguna meninggalkan rapat. Jika nilainya kurang dari 0, nilai default sisi server sebesar 5 detik digunakan. |
workflowOverrideParams (Opsional) | object | Parameter penimpaan alur kerja. |
bailianAppParams (Opsional) | object | Parameter Pusat Aplikasi Studio Model |
asrMaxSilence | number | Ambang batas untuk deteksi aktivitas suara. Nilai kurang dari 0 menunjukkan bahwa nilai default sisi server sebesar 400 ms digunakan. Nilai valid: 200 ms hingga 1200 ms. |
volume | number | Volume suara agen. Nilai valid: 0 hingga 400. Volume output = Volume output suara dalam alur kerja × volume / 100. Nilai kurang dari 0 menunjukkan bahwa nilai default sisi server sebesar 100 digunakan. |
vadLevel | number | Parameter sensitivitas untuk VAD AI. Nilai default: 11. Nilai valid: [0, 11].
|
enableVoiceInterrupt | boolean | Menentukan apakah akan mengaktifkan interupsi cerdas. |
agentVoiceId (Opsional) | string | ID nada suara agen. Jika ini dibiarkan kosong, nilai yang dikonfigurasikan untuk agen digunakan. |
enableIntelligentSegment | boolean | Menentukan apakah akan mengaktifkan penggabungan kalimat cerdas. |
useVoiceprint | boolean | Menentukan apakah akan menggunakan peredam bising voiceprint untuk kalimat saat ini. |
voiceprintId (Opsional) | string | ID voiceprint. Jika ini tidak kosong, peredam bising voiceprint diaktifkan untuk panggilan saat ini. |
agentMaxIdleTime | number | Waktu idle maksimum untuk agen, dalam detik. Nilai kurang dari 0 menunjukkan bahwa nilai default sisi server sebesar 600 detik digunakan. |
llmHistoryLimit | number | Jumlah maksimum putaran percakapan historis yang disimpan untuk LLM atau Multimodal LLM. Nilai kurang dari 0 menunjukkan bahwa nilai default sisi server sebesar 10 digunakan. |
enablePushToTalk | boolean | Menentukan apakah akan mengaktifkan mode push-to-talk. |
agentGracefulShutdown | boolean | Menentukan apakah akan mengaktifkan shutdown yang mulus. Jika diaktifkan, agen berhenti setelah menyiarkan kalimat saat ini. |
agentAvatarId (Opsional) | string | ID model manusia digital. Jika ini dibiarkan kosong, nilai yang dikonfigurasikan untuk agen digunakan. |
asrLanguageId (Opsional) | string | ID bahasa ASR. Jika ini dibiarkan kosong, nilai yang dikonfigurasikan untuk agen digunakan. |
wakeUpQuery (Opsional) | string | Instruksi pengguna sebelum panggilan dimulai. Agen langsung merespons setelah panggilan dimulai. |
llmSystemPrompt (Opsional) | string | Prompt sistem untuk LLM, misalnya, "Anda adalah asisten yang ramah dan membantu...". Catatan: Ini tidak didukung jika node LLM adalah alur kerja Studio Model. |
asrHotWords (Opsional) | Array<string> | Daftar kata panas ASR. |
interruptWords (Opsional) | Array<string> | Kata-kata atau frasa spesifik yang memicu interupsi percakapan, seperti "Permisi" atau "Saya mengerti". |
AICallAgentConfig
Konfigurasi untuk memulai dan menjalankan agen panggilan.
Properti | Tipe | Deskripsi |
agentGreeting (Opsional) | string | Pesan selamat datang agen. Jika ini dibiarkan kosong, nilai yang dikonfigurasikan untuk agen digunakan. Pesan dapat mencapai hingga 100 karakter. |
wakeUpQuery (Opsional) | string | Instruksi pengguna sebelum panggilan dimulai. Agen langsung merespons setelah panggilan dimulai. |
agentMaxIdleTime | number | Waktu idle maksimum untuk agen, dalam detik. Agen secara otomatis offline jika waktu terlampaui. Nilai default: 600 detik. |
userOnlineTimeout | number | Jangka waktu timeout bagi agen untuk menutup tugas jika pengguna tidak bergabung dalam rapat. Nilai default: 60 detik. |
userOfflineTimeout | number | Jangka waktu timeout bagi agen untuk menutup tugas setelah pengguna meninggalkan rapat. Nilai default: 5 detik. |
enablePushToTalk | boolean | Menentukan apakah akan mengaktifkan mode push-to-talk. |
agentGracefulShutdown | boolean | Menentukan apakah akan mengaktifkan shutdown yang mulus. Jika diaktifkan, agen berhenti setelah menyiarkan kalimat saat ini. |
volume | number | Volume suara agen. Nilai valid: 0 hingga 400. Nilai default: 100. |
workflowOverrideParams | JSONObject | Parameter penimpaan alur kerja. |
enableIntelligentSegment | boolean | Saklar untuk segmentasi kalimat cerdas. |
asrConfig | Konfigurasi pengenalan suara. | |
ttsConfig | Konfigurasi sintesis suara. | |
llmConfig | Konfigurasi model bahasa besar. | |
avatarConfig | Konfigurasi manusia digital. | |
interruptConfig | Konfigurasi interupsi. | |
voiceprintConfig | Konfigurasi peredam bising voiceprint. | |
turnDetectionConfig | Konfigurasi deteksi giliran. | |
experimentalConfig | JSONObject | Konfigurasi kustom non-produk. |
vcrConfig | Konfigurasi VCR. |
AICallChatSyncConfig
Parameter konfigurasi untuk sesi agen obrolan terkait.
Properti | Tipe | Deskripsi |
sessionId | string | ID sesi agen obrolan terkait. |
agentId | string | ID agen obrolan terkait (harus berada dalam akun dan wilayah yang sama). |
receiverId | string | ID pengguna untuk sesi agen obrolan terkait. |
AICallAgentShareConfig
Konfigurasi berbagi agen.
Properti | Tipe | Deskripsi |
shareId (Opsional) | string | ID berbagi agen. |
agentType | Tipe beban kerja agen. | |
expireTime (Opsional) | Date | Waktu kedaluwarsa. |
region (Opsional) | string | Wilayah tempat agen berada. |
templateConfig (Opsional) | string | Konfigurasi template (string JSON). |
userData (Opsional) | string | Informasi pengguna khusus yang dilewatkan ke agen. |
AICallAgentAsrConfig
Konfigurasi Pengenalan Suara Otomatis (ASR).
Properti | Tipe | Deskripsi |
asrLanguageId (Opsional) | string | ID bahasa ASR. Jika ini dibiarkan kosong, nilai yang dikonfigurasikan untuk agen digunakan. Nilai valid:
|
asrMaxSilence | number | Ambang batas untuk deteksi aktivitas suara. Jika durasi keheningan melebihi ambang ini, jeda kalimat terdeteksi. Nilai default: 400 ms. Nilai valid: 200 ms hingga 1200 ms. |
asrHotWords (Opsional) | string[] | Daftar kata panas ASR. Batasan: hingga 500 kata, dengan setiap kata tidak lebih dari 10 karakter. |
vadLevel | number | Parameter sensitivitas untuk VAD AI. Nilai default: 11. Nilai valid: [0, 11].
|
customParams | string | Saat menggunakan ASR mandiri, lewatkan parameter runtime dalam format parameter URL, misalnya, "mode=fast&sample=16000&format=wav". |
vadDuration | number | Ambang batas durasi minimum untuk deteksi aktivitas suara, digunakan untuk mengontrol sensitivitas interupsi. Nilai 0 (default) menonaktifkan fitur ini. Nilai valid: 200 hingga 2000 milidetik. Rentang umum adalah [200, 500], yang sesuai dengan 1 hingga 4 karakter. Jika Anda mengatur ini ke nilai kurang dari 0, nilai tersebut tidak dikirim ke server (fitur ini dinonaktifkan secara default oleh server). |
AICallAgentTtsConfig
Konfigurasi Text-to-Speech (TTS).
Properti | Tipe | Deskripsi |
agentVoiceId (Opsional) | string | ID nada suara agen. Jika ini dibiarkan kosong, nilai yang dikonfigurasikan untuk agen digunakan. |
pronunciationRules | JSONObject[] | Array aturan pelafalan. Hingga 20 aturan didukung. Jika ini tidak ditentukan atau array kosong, tidak ada aturan yang digunakan. Contoh: |
speechRate | number | Kecepatan pemutaran TTS. Semua tipe TTS didukung. Nilai valid: [0.5, 2.0]. Nilai default: 1.0. Jika Anda mengatur ini ke nilai kurang dari 0, nilai tersebut tidak dikirim ke server (nilai yang dikonfigurasikan di Konsol digunakan). |
languageId | string | Kode bahasa TTS. Ini valid hanya jika tipe TTS adalah MiniMax. |
emotion | string | Tipe emosi TTS. Ini valid hanya jika tipe TTS adalah MiniMax. |
modelId | string | ID model TTS. Saat ini, hanya MiniMax yang didukung. Nilai valid: speech-01-turbo, speech-02-turbo. |
AICallAgentLlmConfig
Konfigurasi Model Bahasa Besar (LLM).
Properti | Tipe | Deskripsi |
llmHistoryLimit | number | Jumlah maksimum putaran percakapan historis yang disimpan. Nilai default: 10. |
llmSystemPrompt (Opsional) | string | Prompt sistem untuk LLM. |
bailianAppParams | JSONObject | Parameter untuk Pusat Aplikasi Model Studio |
llmCompleteReply | boolean | Menentukan apakah akan mengirim hasil LLM lengkap. Catatan Jika ini diaktifkan, hasil LLM lengkap dikembalikan melalui callback event llmReplyCompleted setelah hasil dihasilkan. |
openAIExtraQuery (Opsional) | string | Parameter query tambahan untuk LLM berbasis protokol OpenAI. Catatan Parameter harus dalam format key=value. Gunakan ampersand (&) untuk memisahkan beberapa parameter. Semua nilai harus berupa string. |
AICallAgentAvatarConfig
Konfigurasi manusia digital.
Properti | Tipe | Deskripsi |
agentAvatarId (Opsional) | string | ID model manusia digital. Jika ini dibiarkan kosong, nilai yang dikonfigurasikan untuk agen digunakan. |
AICallAgentInterruptConfig
Konfigurasi interupsi.
Properti | Tipe | Deskripsi |
enableVoiceInterrupt | boolean | Menentukan apakah akan mengaktifkan interupsi cerdas. |
interruptWords (Opsional) | string[] | Kata-kata atau frasa spesifik yang memicu interupsi percakapan. |
AICallAgentVoiceprintConfig
Konfigurasi peredam bising voiceprint.
Properti | Tipe | Deskripsi |
useVoiceprint | boolean | Menentukan apakah akan menggunakan peredam bising voiceprint untuk kalimat saat ini. |
voiceprintId (Opsional) | string | ID voiceprint. Jika ini tidak kosong, peredam bising voiceprint diaktifkan untuk panggilan saat ini. |
AICallAgentTurnDetectionConfig
Konfigurasi deteksi giliran.
Properti | Tipe | Deskripsi |
turnEndWords (Opsional) | string[] | Kata-kata spesifik untuk pemutusan kalimat, misalnya, "Selesai" atau "Saya sudah selesai." |
mode | AICallTurnDetectionMode | Mode untuk menentukan apakah pengguna telah selesai berbicara. Defaultnya adalah Semantic, yang menggunakan AI untuk menentukan apakah pengguna telah selesai berbicara berdasarkan semantik. |
semanticWaitDuration | number | Waktu tunggu kustom untuk pemutusan kalimat berbasis semantik, dalam milidetik. Nilai valid: [0, 10000]. Jika Anda mengatur ini ke nilai kurang dari 0, nilai tersebut tidak dikirim ke server (nilai default sisi server -1 digunakan, dan AI secara otomatis menentukan waktu tunggu yang sesuai). Catatan Jika AICallTurnDetectionMode disetel ke Normal, bidang semanticWaitDuration tidak valid. |
AICallAgentVcrResult
Hasil deteksi VCR.
Properti | Tipe | Deskripsi |
data | JSONObject | Semua hasil deteksi VCR yang dikembalikan oleh agen. |
stillFrameMotion | FrameMotionResult | Hasil deteksi frame diam. |
invalidFrameMotion | FrameMotionResult | Hasil deteksi frame tidak valid. |
peopleCount | PeopleCountResult | Hasil deteksi jumlah orang. |
equipment | EquipmentResult | Hasil deteksi perangkat elektronik. |
headMotion | HeadMotionResult | Hasil deteksi gerakan kepala. |
AICallAgentVcrConfig
Konfigurasi VCR.
Properti | Tipe | Deskripsi |
data | JSONObject | Saat pengguna melewati objek JSON, itu disimpan dalam cache. Objek tersebut kemudian digunakan untuk menghasilkan string JSON, yang memungkinkan ekstensi kustom. |
stillFrameMotion | Konfigurasi deteksi gerakan frame diam VCR. | |
invalidFrameMotion | Konfigurasi deteksi gerakan frame tidak valid VCR. | |
peopleCount | Konfigurasi deteksi jumlah orang real-time VCR. | |
equipment | Konfigurasi deteksi perangkat elektronik VCR. | |
headMotion | Konfigurasi deteksi gerakan kepala VCR. |
AICallAgentVcrBaseConfig
Konfigurasi dasar deteksi VCR.
Properti | Tipe | Deskripsi |
enable | boolean | Menentukan apakah akan mengaktifkan fitur ini. |
AICallAgentVcrFrameMotionConfig
Konfigurasi deteksi gerakan frame VCR.
Properti | Tipe | Deskripsi |
callbackDelay | number | Waktu tunda sebelum callback dipicu, dalam milidetik. Nilai default: 3000 ms. |