diff --git a/README.md b/README.md index 6422e44..b90e97d 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ - **빠른 음성 대화**: 말하는 도중에 전사하고 답은 문장 단위로 바로 읽어서, 말이 끝난 뒤 첫 소리까지 약 1~1.5초를 목표로 합니다. - **최대 10명 동시 대화**: 화자별로 따로 받아 전사합니다. 여러 명이 동시에 부를 때 어떻게 답할지(처음 대화만 / 들어온 순서대로 / 마지막 대화만 / 제일 중요한 대화만)는 GUI에서 고릅니다. - **호출어와 지정한 사람**: - - 호출어는 GUI에서 여러 개 등록합니다. + - 호출어는 GUI에서 여러 개 등록합니다. 기본값은 "비서", "비서야", "비서님", "김비서", "김비서야", "김비서님"입니다. - "지정한 사람만 응답"과 "지정한 사람은 호출어 없이 대답"을 각각 켜고 끕니다. - **AI 채팅 채널**: 등록한 디스코드 채팅 채널을 자비스가 읽고, 메시지를 보내고, 자기 메시지를 고칩니다. 채널 ID, 이름, 설명은 GUI에서 편집하고, 고친 이름·설명은 실제 디스코드 채널 이름·주제에도 반영합니다(끌 수 있음). - **예약 알림과 정기 작업**: "10분 뒤에 알려 줘", "내일 7시에 회의 알려 줘", "평일 아침 9시에 날씨 알려 줘"처럼 말이나 채팅으로 맡깁니다. 맡긴 사람이 자비스와 같은 음성 채널에 있으면 음성으로, 아니면 채팅 채널에 글로 전합니다. 정기 작업은 날씨, 웹 검색처럼 찾아보는 기능만 쓰고, 관리 앱 "예약" 화면에서 목록을 보고 지울 수 있습니다. diff --git a/app/src/calls.rs b/app/src/calls.rs index 980b492..cb80278 100644 --- a/app/src/calls.rs +++ b/app/src/calls.rs @@ -38,7 +38,7 @@ pub struct CallSettings { impl Default for CallSettings { fn default() -> Self { Self { - wake_words: vec!["자비스".into()], + wake_words: crate::settings::default_wake_words(), similarity: 0.2, mode: CallMode::WakeWord, designated: HashSet::new(), @@ -70,9 +70,9 @@ pub fn normalise(text: &str) -> Vec { text.nfkd().flat_map(char::to_lowercase).filter(|c| c.is_alphanumeric()).collect() } -/// The stretch `[start, end)` of `text` closest to `word`, if within `max_edits` edits -/// (approximate substring matching: the match may start and end anywhere in `text`). -fn find(text: &[char], word: &[char], max_edits: usize) -> Option<(usize, usize)> { +/// The stretch `[start, end)` of `text` closest to `word` and its edits, if within `max_edits` +/// edits (approximate substring matching: the match may start and end anywhere in `text`). +fn find(text: &[char], word: &[char], max_edits: usize) -> Option<(usize, usize, usize)> { if word.is_empty() || text.is_empty() { return None; } @@ -104,7 +104,7 @@ fn find(text: &[char], word: &[char], max_edits: usize) -> Option<(usize, usize) (1..=n) .filter(|&j| d[m][j] <= max_edits) .min_by_key(|&j| (d[m][j], j)) - .map(|j| (start[m][j], j)) + .map(|j| (start[m][j], j, d[m][j])) } impl CallSettings { @@ -114,13 +114,15 @@ impl CallSettings { /// The text with the first heard wake word removed, if one is heard. fn without_wake_word(&self, text: &[char]) -> Option> { - // The earliest heard wake word is the one used to address Jarvis. - let (s, e) = self + // The earliest heard wake word is the one used to address Jarvis; where several start + // there, the closest, then the longest ("비서야" over "비서"), so no part of the call is + // left over and a near match does not eat into what follows. + let (s, e, _) = self .wake_words .iter() .map(|w| normalise(w)) .filter_map(|word| find(text, &word, self.allowed_edits(&word))) - .min()?; + .min_by_key(|&(s, e, edits)| (s, edits, std::cmp::Reverse(e)))?; Some(text[..s].iter().chain(&text[e..]).copied().collect()) } @@ -169,8 +171,9 @@ mod tests { const A: u64 = 1; const B: u64 = 2; + /// The mechanism tests use one wake word of their own, whatever the default is. fn s() -> CallSettings { - CallSettings::default() + CallSettings { wake_words: vec!["자비스".into()], ..CallSettings::default() } } #[test] @@ -264,4 +267,25 @@ mod tests { assert_eq!(c.judge(A, "javis 날씨"), Call::Request { direct: true }); assert_eq!(c.judge(A, "javis stop"), Call::Stop); } + + #[test] + fn the_longest_wake_word_where_the_call_starts_is_the_one_removed() { + let c = CallSettings { wake_words: vec!["비서".into(), "비서야".into(), "김비서".into()], ..s() }; + assert!(c.wake_word_only("비서야,"), "the call form is the whole wake word, not 비서 and a 야 left over"); + assert!(c.wake_word_only("김비서?")); + assert_eq!(c.judge(A, "비서야 멈춰"), Call::Stop); + assert_eq!(c.judge(A, "김비서 그만해"), Call::Stop); + } + + #[test] + fn by_default_jarvis_is_called_like_a_secretary() { + let c = CallSettings::default(); + for call in ["비서", "비서야", "비서님", "김비서", "김비서야", "김비서님"] { + assert!(c.wake_word_only(&format!("{call},")), "{call}"); + assert_eq!(c.judge(A, &format!("{call} 오늘 날씨 어때?")), Call::Request { direct: true }, "{call}"); + assert_eq!(c.judge(A, &format!("{call} 멈춰")), Call::Stop, "{call}"); + } + assert_eq!(c.judge(A, "오늘 날씨 어때?"), Call::Ignore); + assert_eq!(c.judge(A, "자비스 날씨"), Call::Ignore, "the old name no longer calls"); + } } diff --git a/app/src/conversation.rs b/app/src/conversation.rs index ecd3c63..be62e8b 100644 --- a/app/src/conversation.rs +++ b/app/src/conversation.rs @@ -502,6 +502,11 @@ pub async fn run(mut conv: Conversation, mut events: mpsc::Unbounde #[cfg(test)] mod tests { use super::*; + + /// The tests call Jarvis by one wake word of their own, whatever the default is. + fn test_calls() -> CallSettings { + CallSettings { wake_words: vec!["자비스".into()], ..CallSettings::default() } + } use crate::discord::{Heard, HeardFinal}; use crate::playback::PlaybackEnd; use crate::policy::PolicyKind; @@ -588,7 +593,7 @@ mod tests { fn conv(kind: PolicyKind, mode: CallMode) -> (Conversation, Fake, Instant) { let f = Fake::default(); - let calls = CallSettings { mode, earcon: false, ..CallSettings::default() }; + let calls = CallSettings { mode, earcon: false, ..test_calls() }; let policy = PolicySettings { kind, collect: Duration::ZERO, ..PolicySettings::default() }; *f.people.borrow_mut() = vec![A, B]; (Conversation::new(f.clone(), calls, policy), f, Instant::now()) @@ -596,7 +601,7 @@ mod tests { fn conv_earcon(kind: PolicyKind) -> (Conversation, Fake, Instant) { let f = Fake::default(); let policy = PolicySettings { kind, collect: Duration::ZERO, ..PolicySettings::default() }; - (Conversation::new(f.clone(), CallSettings::default(), policy), f, Instant::now()) + (Conversation::new(f.clone(), test_calls(), policy), f, Instant::now()) } #[test] @@ -624,7 +629,7 @@ mod tests { // Nothing followed the next one: it is answered alone, still with one earcon. c.on_event(&end("s1", false), ms(t, 5000)); c.on_event(&fin_utt(A, 3, "자비스"), ms(t, 6000)); - c.tick(ms(t, 6000) + CallSettings::default().follow_up); + c.tick(ms(t, 6000) + test_calls().follow_up); assert_eq!(f.take(), vec![Did::Earcon, Did::Answer(A, "자비스".into())]); } @@ -708,7 +713,7 @@ mod tests { c.on_event(&start(A, 1), ms(t, 0)); c.on_event(&start(A, 2), ms(t, 600)); // the final of utterance 1 comes after 2 started c.on_event(&fin_utt(A, 1, "자비스"), ms(t, 900)); - c.tick(ms(t, 900) + CallSettings::default().follow_up + Duration::from_millis(1)); + c.tick(ms(t, 900) + test_calls().follow_up + Duration::from_millis(1)); assert!(f.take().is_empty()); c.on_event(&fin_utt(A, 2, "멈춰"), ms(t, 3000)); assert_eq!(f.take(), vec![Did::StopAll], "joined, it is a stop"); @@ -719,7 +724,7 @@ mod tests { let (mut c, f, t) = conv(PolicyKind::First, CallMode::WakeWord); c.on_event(&start(A, 1), ms(t, 0)); c.on_event(&fin_utt(A, 1, "자비스"), ms(t, 900)); - let wait = CallSettings::default().follow_up; + let wait = test_calls().follow_up; assert_eq!(c.next_deadline(), Some(ms(t, 900) + wait)); c.tick(ms(t, 900) + wait - Duration::from_millis(1)); assert!(f.take().is_empty()); @@ -748,7 +753,7 @@ mod tests { assert!(f.take().is_empty(), "no wake word: not a call"); c.on_event(&start(A, 2), ms(t, 62_000)); c.on_event(&fin_utt(A, 2, "자비스"), ms(t, 63_000)); - let wait = CallSettings::default().follow_up; + let wait = test_calls().follow_up; assert_eq!(c.next_deadline(), Some(ms(t, 63_000) + wait)); c.tick(ms(t, 63_000) + wait); assert_eq!(f.take(), vec![Did::Answer(A, "자비스".into())]); @@ -759,7 +764,7 @@ mod tests { let (mut c, f, t) = conv(PolicyKind::First, CallMode::WakeWord); c.on_event(&fin_utt(A, 1, "자비스"), ms(t, 900)); c.on_event(&CoreEvent::Stopped, ms(t, 1000)); - c.tick(ms(t, 900) + CallSettings::default().follow_up); + c.tick(ms(t, 900) + test_calls().follow_up); assert!(f.take().is_empty()); assert_eq!(c.next_deadline(), None); } @@ -826,7 +831,7 @@ mod tests { let f = Fake::default(); *f.people.borrow_mut() = vec![A, B, 33]; let calls = CallSettings { mode: CallMode::Addressed, earcon: false, designated: [A].into(), designated_only: true, - ..CallSettings::default() }; + ..test_calls() }; let mut c = Conversation::new(f.clone(), calls, PolicySettings { kind: PolicyKind::InOrder, ..PolicySettings::default() }); c.on_event(&fin(A, "불 좀 꺼 줄래", 100), ms(t, 0)); assert!(matches!(f.take()[..], [Did::Addressed(_, A)])); @@ -930,7 +935,7 @@ mod tests { (CH_ALL, ChatChannelCall { everything: true, send: true }), (CH_MUTE, ChatChannelCall { everything: true, send: false }), ].into() }; - let voice = CallSettings { earcon: false, ..CallSettings::default() }; + let voice = CallSettings { earcon: false, ..test_calls() }; let c = Conversation::new(f.clone(), voice, PolicySettings::default()).with_chat(chat); (c, f, Instant::now()) } @@ -942,7 +947,7 @@ mod tests { #[test] fn a_chat_call_is_answered_as_a_reply_to_its_message() { - let (mut c, f, t) = chat_conv(CallSettings::default()); + let (mut c, f, t) = chat_conv(test_calls()); c.on_event(&chat(CH_WAKE, 5, A, false, "자비스 내일 일정 알려 줘"), t); let Did::ChatAnswer(id, user, text) = f.take().remove(0) else { panic!() }; assert_eq!((user, text.as_str()), (A, "자비스 내일 일정 알려 줘")); @@ -956,7 +961,7 @@ mod tests { #[test] fn chat_answers_follow_each_channels_switch_and_never_answer_bots() { - let (mut c, f, t) = chat_conv(CallSettings::default()); + let (mut c, f, t) = chat_conv(test_calls()); c.on_event(&chat(CH_WAKE, 1, A, false, "오늘 뭐 먹지"), t); assert!(f.take().is_empty(), "wake word only"); c.on_event(&chat(CH_ALL, 2, A, false, "오늘 뭐 먹지"), t); @@ -974,7 +979,7 @@ mod tests { #[test] fn chat_uses_its_own_wake_words_and_the_designated_people() { let calls = CallSettings { wake_words: vec!["봇".into()], designated: [A].into(), designated_only: true, - ..CallSettings::default() }; + ..test_calls() }; let (mut c, f, t) = chat_conv(calls); c.on_event(&chat(CH_WAKE, 1, A, false, "봇 안녕"), t); assert_eq!(f.take().len(), 1); @@ -986,7 +991,7 @@ mod tests { #[test] fn a_failed_chat_answer_posts_nothing_and_chat_leaves_voice_alone() { - let (mut c, f, t) = chat_conv(CallSettings::default()); + let (mut c, f, t) = chat_conv(test_calls()); c.on_event(&fin(A, "자비스 날씨", 100), t); c.on_event(&chat(CH_ALL, 9, B, false, "안녕"), t); let did = f.take(); @@ -999,7 +1004,7 @@ mod tests { #[test] fn a_chat_answer_after_its_keep_time_is_not_posted() { - let (mut c, f, t) = chat_conv(CallSettings::default()); + let (mut c, f, t) = chat_conv(test_calls()); c.on_event(&chat(CH_WAKE, 5, A, false, "자비스 안녕"), t); let Did::ChatAnswer(id, ..) = f.take().remove(0) else { panic!() }; c.on_event(&CoreEvent::ReplyText { id: id.clone(), text: "안녕하세요.".into(), failed: false }, t + CHAT_ANSWER_KEPT); diff --git a/app/src/conversation.spec.md b/app/src/conversation.spec.md index 0293dcb..7799cde 100644 --- a/app/src/conversation.spec.md +++ b/app/src/conversation.spec.md @@ -24,7 +24,7 @@ Settings (`settings.json`, section `call`; wake words stay in `voice.wakeWords`) | Key | Default | Meaning | |---|---|---| -| `voice.wakeWords` | `["자비스"]` | Wake words for voice (also the STT hint). | +| `voice.wakeWords` | `["비서", "비서야", "비서님", "김비서", "김비서야", "김비서님"]` | Wake words for voice (also the STT hint). The default calls Jarvis like a secretary, by the word and its usual call forms (user request, 2026-11-19; before it was `["자비스"]`). | | `call.chatWakeWords` | `null` | Wake words for chat; `null` uses `voice.wakeWords`. | | `call.similarity` | `0.2` | How far a heard word may be from a wake word, as a share of the wake word's normalised letters (0-0.5). `0` needs an exact match. | | `call.mode` | `"wakeWord"` | `wakeWord`: answer only when called by a wake word. `addressed`: also answer what is judged to be said to Jarvis. `everything`: answer every utterance. | @@ -42,6 +42,9 @@ away from "자비스" (of six) while "서비스" is two away. A wake word is heard when some stretch of the normalised text is at most `floor(similarity × letters of the wake word)` edits (insert, delete, substitute) from it. With the default 0.2, "자비스" (six letters) allows one edit. A wake word anywhere in the utterance counts. +The earliest heard wake word is the call; where several are heard starting there, the one with the +fewest edits, then the longest, so a call form ("비서야") is removed whole and leaves nothing over +("비서야 멈춰" is a stop), and a near match of a longer word does not eat into what follows. Decision for one utterance (`judge(speaker, text)`), in order: @@ -208,7 +211,7 @@ each to the chat model, the heard text fenced as data. Eval: `evals/test_voice_j ## Tests `cargo test` covers call detection (exact and near wake words in Hangul and Latin, a different word -two letters away, wake word anywhere, stop with and without a wake word, designated combinations, +two letters away, wake word anywhere, the longest call form where several start (the default secretary call forms), stop with and without a wake word, designated combinations, modes) and every policy rule above with fake times (settling, ordering by end time, busy, queue limit, interruption and `response.interrupt` off, ranking tie, ranking timeout, stop dropping the queue), and the conversation loop with a fake voice side (answering and queueing, a busy drop recorded without text, voice stop, addressed alone diff --git a/app/src/settings.rs b/app/src/settings.rs index 242506e..9992eee 100644 --- a/app/src/settings.rs +++ b/app/src/settings.rs @@ -254,6 +254,12 @@ impl std::error::Error for SettingsError {} pub const DEFAULT_JOIN_NOTICE: &str = "자비스가 이 음성 채널에 들어왔습니다. 이 채널의 대화는 자비스가 받아 적습니다."; +/// The default wake words: Jarvis is called like a secretary, by the word and its usual call forms +/// (the longest one heard is the call, `calls.rs`). +pub fn default_wake_words() -> Vec { + ["비서", "비서야", "비서님", "김비서", "김비서야", "김비서님"].map(String::from).to_vec() +} + impl Default for Settings { fn default() -> Self { Self { @@ -268,7 +274,7 @@ impl Default for Settings { listen_to_bots: false, record: false, join_notice: DEFAULT_JOIN_NOTICE.into(), - wake_words: vec!["자비스".into()], + wake_words: default_wake_words(), stt: Map::new(), tts_speed: 1.5, }, diff --git a/app/src/settings_edit.rs b/app/src/settings_edit.rs index b858ba3..a3194b5 100644 --- a/app/src/settings_edit.rs +++ b/app/src/settings_edit.rs @@ -82,7 +82,7 @@ pub fn fields() -> Vec { f("discord.voiceChannelId", Channels, Id, Value::Null, "자동으로 들어갈 음성 채널"), f("voice.maxSpeakers", Channels, Int { min: 1, max: 10 }, json!(10), "동시에 받아 적을 최대 인원"), f("voice.listenToBots", Channels, Bool, json!(false), "다른 봇의 말도 받아 적기"), - f("voice.wakeWords", Channels, TextList { max_items: 20, nullable: false }, json!(["자비스"]), "호출어"), + f("voice.wakeWords", Channels, TextList { max_items: 20, nullable: false }, json!(crate::settings::default_wake_words()), "호출어"), f("call.mode", Channels, Choice { values: &["wakeWord", "addressed", "everything"] }, json!("wakeWord"), "호출 방식"), f("call.similarity", Channels, Number { min: 0.0, max: 0.5 }, json!(0.2), "비슷한 발음 허용 정도"), diff --git a/app/tests/live_round_trip.rs b/app/tests/live_round_trip.rs index fa61b1a..0bf12be 100644 --- a/app/tests/live_round_trip.rs +++ b/app/tests/live_round_trip.rs @@ -210,8 +210,8 @@ async fn conversation_round_trip_on_real_discord() { } std::fs::write(data.join("config").join("settings.json"), serde_json::to_string_pretty(&json!({ "discord": {"guildId": guild.to_string(), "voiceChannelId": voice.to_string()}, - // The "person" here is a bot, so bots must be heard. - "voice": {"listenToBots": true}, + // The "person" here is a bot, so bots must be heard; the recorded questions call "자비스". + "voice": {"listenToBots": true, "wakeWords": ["자비스"]}, "voiceWorker": {"python": env("JARVIS_VOICE_PYTHON"), "cwd": root.join("../src"), "args": args}, "llm": {"url": env("JARVIS_LIVE_LLM_URL")}, })).unwrap()).unwrap(); diff --git a/docs/v2/conversation.md b/docs/v2/conversation.md index 21165b0..b7df6eb 100644 --- a/docs/v2/conversation.md +++ b/docs/v2/conversation.md @@ -18,7 +18,7 @@ | 설정 | 내용 | |---|---| -| 호출어(prefix) | GUI에서 여러 개 등록·수정·삭제 (예: "자비스", "야 자비스", "javis"). 음성과 채팅에 같이 쓰고, 채팅용은 따로 지정할 수도 있습니다. 비슷한 발음 허용 정도(예: "자비즈")도 조절합니다. | +| 호출어(prefix) | GUI에서 여러 개 등록·수정·삭제. 기본값은 비서를 부르듯 "비서", "비서야", "비서님", "김비서", "김비서야", "김비서님"입니다(사용자 요청, 2026-11-19, 그 전에는 "자비스"). 한 자리에서 여러 호출어가 들리면 가장 가깝고 긴 것을 부른 말로 보므로 "비서야, 멈춰"의 "야"가 남지 않습니다. 음성과 채팅에 같이 쓰고, 채팅용은 따로 지정할 수도 있습니다. 비슷한 발음 허용 정도(예: "자비즈")도 조절합니다. "비서"는 흔한 낱말이라 "우리 회사 비서가"처럼 대화 중에 나와도 부른 것으로 봅니다. | | 호출 방식 | (1) 호출어로 부를 때만 응답 **(기본값)** / (2) 봇에게 하는 말로 판단되면 응답 / (3) 모든 말에 응답 | | 호출어 뒤 쉼 | "자비스, … 지금 몇 시야?"처럼 이름 뒤에 쉬어서 "자비스"만 따로 들리면, 같은 사람이 이어서 하는 말(기본 1.5초 안에 시작)과 합쳐 한 질문으로 받습니다. 아무 말도 이어지지 않으면 "자비스"에만 대답합니다. 채팅은 합치지 않습니다. | | 지정한 사람 | GUI에서 서버 멤버 목록으로 고릅니다. 아래 두 설정을 **각각 켜고 끕니다**. |