translator: openai refactor and docs update

Author: Netdex

Cargo.lock

@@ -12,7 +12,7 @@ imgui-winit-glow-renderer-viewports = { git = "https://github.com/Netdex/imgui-r
 # hudhook = { git = "https://github.com/veeenu/hudhook.git" }
 
 [workspace]
-members = ["niinii", "ichiran", "openai-chat"]
+members = ["niinii", "ichiran", "openai"]
 exclude = ["third-party"]
 resolver = "2"
 

Cargo.toml

@@ -5,26 +5,33 @@
 
 [Demonstration](https://www.youtube.com/watch?v=Ap2jXEkhURM)
 
-niinii (knee-knee) is a graphical frontend for glossing Japanese text. Useful
-for assisted reading of text for language learning purposes. A primary use case
-is glossing visual novels, which is shown in the demonstration above. I made
-this tool with the express intent to read a single *specific* visual novel,
-which is also where the name comes from. If someone else finds it useful that's
-cool too.
+niinii (knee-knee) is a graphical frontend for glossing and translating Japanese
+text. Useful for assisted reading of text for language learning purposes. A
+primary use case is glossing visual novels, which is shown in the demonstration
+above. I made this tool with the express intent to read a single *specific*
+visual novel, which is also where the name comes from. If someone else finds it
+useful that's cool too.
 
 For example, in the demonstration above, I use niinii along with a text hooker
 to gloss the dialogue in a visual novel. The segmented phrase along with ruby
 text (i.e. furigana) is displayed. Hovering over a segment will show dictionary
 definitions and inflections from JMDict. You can pop open a separate window by
 clicking on a segment. Hovering over kanji will show kanji information from
-KANJIDIC2. I would write a more detailed user manual but I think you can
-probably figure it out.
+KANJIDIC2. Behold the LLM-based live translation. I would write a more detailed
+user manual but I think you can probably figure it out.
 
-Japanese language support is implemented using
+Segmentation is implemented using
 [Ichiran](https://github.com/tshatrov/ichiran) by
 [tshatrov](https://github.com/tshatrov). Ichiran is pretty amazing at text 
 segmentation compared to other tools I've tried.
 
+As of late, niinii incorporates translation features via LLM offerings from
+OpenAI. Since I started working on this project, the state of LLM-based
+translation has drastically improved both in quality and latency. I won't
+comment on the state of the art here since it changes on a monthly cadence.
+Again, I would write a more detailed user manual but you'll figure it out.
+Bring your own API key.
+
 ## Why not use...
 This is a tool created to service a personal need, and may not be useful to you.
 Below, I laid out my personal justification for investing time into creating
@@ -36,8 +43,10 @@ much better at segmentation, provides more metadata, and makes fewer mistakes.
 **Why not use rikai(kun|chan), JGlossator?**: They don't do segmentation.
 
 **Why not use DeepL, Google Translate, etc.?**: I want a gloss, not a
-translation tool. If I ever integrate translation features, I'd like to do so in
-a way that supplements the gloss rather than dumping text.
+translation tool. ~~If I ever integrate translation features, I'd like to do so in
+a way that supplements the gloss rather than dumping text.~~ I have finally
+incorporated translation features into niinii. Of course, the purpose here is
+still to supplement the gloss.
 
 **Why not use the web frontend [ichi.moe](https://ichi.moe)?**: 
 There are some features I'd like to experiment with to improve the glossing
@@ -46,7 +55,7 @@ experience.
 ## Build
 Prepackaged builds are available in the
 [Releases](https://github.com/Netdex/niinii/releases) section of this
-repository.
+repository. These releases are seldom published and may be missing many unstable features. You may download bleeding-edge builds from [GitHub Actions](https://github.com/Netdex/niinii/actions).
 
 The only target that is properly maintained is `x86_64-pc-windows-msvc`. There's
 nothing stopping it from working on other targets (e.g. Linux), but additional

README.md

@@ -71,7 +71,7 @@ nu-ansi-term = "0.50.1"
 
 # interned
 ichiran = { path = "../ichiran" }
-openai-chat = { path = "../openai-chat" }
+openai = { path = "../openai" }
 
 [target.'cfg(windows)'.dependencies]
 imgui-dx11-renderer = { path = "../third-party/imgui-dx11-renderer" }

niinii/Cargo.toml

@@ -76,8 +76,8 @@ impl App {
         let parser = Parser::new(&settings).await;
         let translator: Arc<dyn Translator> = match settings.translator_type {
             TranslatorType::DeepL => Arc::new(DeepLTranslator),
-            TranslatorType::Chat => Arc::new(ChatTranslator::new(&settings)),
-            TranslatorType::Realtime => Arc::new(RealtimeTranslator::new(&settings)),
+            TranslatorType::Chat => Arc::new(ChatTranslator::new(&settings).await),
+            TranslatorType::Realtime => Arc::new(RealtimeTranslator::new(&settings).await),
         };
         let tts = TtsEngine::new(&settings);
         App {
@@ -213,22 +213,25 @@ impl App {
             }
         }
 
-        if let State::Completed = &self.state {
-            if let Some(request_gloss_text) = self.request_gloss_text.clone() {
-                self.request_gloss_text = None;
-                self.request_parse(ui, &request_gloss_text);
-            }
-        };
-
         if self.settings.watch_clipboard {
             if let Some(clipboard) = ui.clipboard_text() {
                 if clipboard != self.last_clipboard {
                     self.input_text.clone_from(&clipboard);
                     self.last_clipboard.clone_from(&clipboard);
-                    self.request_gloss_text = Some(clipboard);
+                    // Ignore clipboard contents if they are unreasonably large
+                    if clipboard.len() < 1000 {
+                        self.request_gloss_text = Some(clipboard);
+                    }
                 }
             }
         }
+
+        if let State::Completed = &self.state {
+            if let Some(request_gloss_text) = self.request_gloss_text.clone() {
+                self.request_gloss_text = None;
+                self.request_parse(ui, &request_gloss_text);
+            }
+        };
     }
 
     fn show_menu(&mut self, ctx: &mut Context, ui: &Ui) {
@@ -267,8 +270,6 @@ impl App {
             ui.separator();
             let _disable_state = ui.begin_disabled(matches!(self.state, State::Processing));
             {
-                let mut _disable_tl =
-                    ui.begin_disabled(self.gloss.ast().is_none_or(|ast| ast.empty()));
                 if ui.menu_item("Translate") {
                     if let Some(gloss) = self.gloss.ast() {
                         self.request_translation(ui, gloss.original_text.clone());

niinii/src/app.rs

@@ -5,14 +5,10 @@ use thiserror::Error;
 
 use crate::settings::Settings;
 
-const MAX_TEXT_LENGTH: usize = 512;
-
 #[derive(Error, Debug)]
 pub enum Error {
     #[error(transparent)]
     Ichiran(#[from] IchiranError),
-    #[error("Text too long ({length}/{MAX_TEXT_LENGTH} chars)")]
-    TextTooLong { length: usize },
     #[error(transparent)]
     RegexError(#[from] fancy_regex::Error),
 }
@@ -64,9 +60,6 @@ impl Parser {
         }
     }
     pub async fn parse(&self, text: &str, variants: u32) -> Result<SyntaxTree, Error> {
-        if text.len() > MAX_TEXT_LENGTH {
-            return Err(Error::TextTooLong { length: text.len() });
-        }
         let ichiran = &self.shared.ichiran;
 
         let (root, kanji_info, jmdict_data) = tokio::try_join!(

niinii/src/parser.rs

@@ -2,21 +2,32 @@ use num_derive::FromPrimitive;
 use serde::{Deserialize, Serialize};
 use strum_macros::{EnumIter, IntoStaticStr};
 
-#[derive(Debug, Clone, Copy, Deserialize, Serialize, FromPrimitive, IntoStaticStr, EnumIter)]
+#[derive(
+    Debug,
+    Clone,
+    Copy,
+    PartialEq,
+    Eq,
+    Deserialize,
+    Serialize,
+    FromPrimitive,
+    IntoStaticStr,
+    EnumIter,
+)]
 pub enum RendererType {
     Glow,
     #[cfg(windows)]
     Direct3D11,
 }
 
-#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, IntoStaticStr, EnumIter)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, IntoStaticStr, EnumIter)]
 pub enum RubyTextType {
     None,
     Furigana,
     Romaji,
 }
 
-#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, IntoStaticStr, EnumIter)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, IntoStaticStr, EnumIter)]
 pub enum TranslatorType {
     DeepL,
     Chat,
@@ -27,7 +38,7 @@ pub enum TranslatorType {
 #[serde(default)]
 pub struct ChatSettings {
     pub api_endpoint: String,
-    pub model: openai_chat::chat::Model,
+    pub model: openai::ModelId,
     pub system_prompt: String,
     pub max_context_tokens: u32,
     pub temperature: Option<f32>,
@@ -37,6 +48,9 @@ pub struct ChatSettings {
     pub connection_timeout: u64,
     pub timeout: u64,
     pub stream: bool,
+    pub service_tier: Option<openai::chat::ServiceTier>,
+    pub reasoning_effort: Option<openai::chat::ReasoningEffort>,
+    pub verbosity: Option<openai::chat::Verbosity>,
 }
 impl Default for ChatSettings {
     fn default() -> Self {
@@ -53,14 +67,17 @@ impl Default for ChatSettings {
             connection_timeout: 3000,
             timeout: 10000,
             stream: true,
+            service_tier: Some(openai::chat::ServiceTier::Priority),
+            reasoning_effort: None,
+            verbosity: None,
         }
     }
 }
 
 #[derive(Clone, Deserialize, Serialize)]
 #[serde(default)]
 pub struct RealtimeSettings {
-    pub model: openai_chat::realtime::Model,
+    pub model: openai::ModelId,
     pub system_prompt: String,
     pub temperature: Option<f32>,
 }