diff options
Diffstat (limited to 'doc/Specifications.md')
| -rw-r--r-- | doc/Specifications.md | 391 |
1 files changed, 391 insertions, 0 deletions
diff --git a/doc/Specifications.md b/doc/Specifications.md new file mode 100644 index 0000000..ac6600d --- /dev/null +++ b/doc/Specifications.md @@ -0,0 +1,391 @@ +# Specifications.md + +## 1. 概要 + +### 1.1 目的 +Firefox上でユーザーがWebページ内の文字列を選択した際、選択範囲付近に小さな翻訳アイコンを表示し、ユーザーがそのアイコンを押すとOllama経由のLLMで翻訳を実行し、ページ上の小型ポップオーバーにストリーミング表示するFirefox WebExtensionを実装する。 + +### 1.2 基本方針 +- Firefox WebExtensions APIを使用する。 +- Manifest V3を採用する。 +- Firefox向け実装を優先し、Chromium互換性は必須要件としない。 +- Ollamaとの通信は公式Ollama REST APIをFetch APIで直接呼び出すことにより行う（`ollama-js`等のサードパーティライブラリは使用しない）。 +- Ollama呼び出しは `POST /api/chat` + `stream: true`（NDJSON streaming）のみを使用する。 +- 会話履歴は保持せず、翻訳要求ごとに独立した1-shotリクエストとする。 +- Webページ上の翻訳UIはチャットUIではなく、選択箇所付近の軽量なポップオーバーとする。 +- ページ本文およびLLM出力は常にプレーンテキストとして扱い、HTMLとして評価しない。 + +--- + +## 2. 対象環境 + +| 項目 | 要件 | +|---|---| +| ブラウザ | Firefox 最新安定版を主対象 | +| 拡張方式 | WebExtensions / Manifest V3 | +| バックエンド | Ollama | +| 既定Ollama Host | `http://localhost:11434` | +| 初期版接続先制限 | `http://localhost:<port>` / `http://127.0.0.1:<port>` のみ許可（validatorで強制） | +| 通信方式 | Fetch API + NDJSON Streaming only | +| LLM API | `POST /api/chat`（REST API） | +| 保存先 | `browser.storage.local` | + +--- + +## 3. ユーザーフロー + +1. ユーザーがWebページ上の文字列をドラッグ等で選択する。 +2. 選択範囲の近くに小型の翻訳アイコンを表示する。 +3. ユーザーが翻訳アイコンを押す。 +4. Content Scriptが選択文字列をBackgroundへ送信する。 +5. BackgroundがOllamaへストリーミング翻訳を要求する。 +6. 翻訳結果をContent Scriptへ逐次転送する。 +7. 選択範囲付近の翻訳ポップオーバーに結果を逐次表示する。 +8. ユーザーはコピー、再生成、閉じる操作を行える。 +9. 新しい翻訳要求が開始された場合、進行中の旧リクエストはキャンセルする。 + +--- + +## 4. 機能要件 + +### 4.1 選択文字列検出 + +| ID | 要件 | +|---|---| +| SEL-01 | Webページ上のユーザー選択文字列を取得できること | +| SEL-02 | 空文字・空白のみの選択は無視すること | +| SEL-03 | 選択解除時は翻訳アイコンを非表示にすること | +| SEL-04 | 選択範囲の位置を取得し、その近傍に翻訳アイコンを表示すること | +| SEL-05 | 初期版ではトップレベル文書のみ対象とし、iframe内は対象外とすること | +| SEL-06 | Firefox内部ページ、Reader View、view-source、内蔵PDF Viewer等、Content Scriptを利用できないページは対象外とすること | + +### 4.2 翻訳アイコン + +| ID | 要件 | +|---|---| +| ACT-01 | 文字列選択後に小型の翻訳アイコンを表示すること | +| ACT-02 | アイコン押下前にLLM呼び出しを開始しないこと | +| ACT-03 | アイコンは選択文字列を著しく隠さない位置に表示すること | +| ACT-04 | ページCSSの影響を極力受けないこと | +| ACT-05 | 選択変更時は最新の選択位置へ追従すること | + +### 4.3 翻訳実行 + +| ID | 要件 | +|---|---| +| TRN-01 | Ollama REST API `POST /api/chat` を使用すること | +| TRN-02 | `stream: true` 固定（NDJSON streaming）とすること | +| TRN-03 | 会話履歴を持たないこと | +| TRN-04 | アプリ固定システムプロンプトとユーザー設定システムプロンプトを結合して使用すること | +| TRN-05 | 翻訳対象文字列はuser messageとして送信すること | +| TRN-06 | ページ内に含まれる命令文は翻訳対象データとして扱い、指示として実行しないよう固定システムプロンプトで明示すること | +| TRN-07 | 新規翻訳要求開始時に旧ストリームをキャンセルできること | +| TRN-08 | Ollama通信失敗時にUI上へ簡潔なエラーを表示すること | +| TRN-09 | 翻訳要求ごとに一意のrequestIdを使用すること | + +### 4.4 翻訳ポップオーバー + +| ID | 要件 | +|---|---| +| UI-01 | 翻訳結果はページ上の小型ポップオーバーへ表示すること | +| UI-02 | サイドバーやチャット履歴UIは使用しないこと | +| UI-03 | ストリーム受信中の翻訳文字列を逐次描画すること | +| UI-04 | 翻訳結果本文をプレーンテキストとして描画すること | +| UI-05 | コピーボタンを提供すること | +| UI-06 | 再生成ボタンを提供すること | +| UI-07 | 閉じるボタンを提供すること | +| UI-08 | 使用モデル名を控えめに表示できること | +| UI-09 | 読み込み中、完了、エラー状態を視覚的に区別できること | + +### 4.5 拡張機能の有効/無効 + +| ID | 要件 | +|---|---| +| EN-01 | 拡張機能の翻訳機能を設定画面から有効/無効に切り替えられること | +| EN-02 | 無効時は選択文字列に対して翻訳アイコンを表示しないこと | + +--- + +## 5. 設定要件 + +### 5.1 基本設定 + +| 項目 | UI | 初期/参考値 | 備考 | +|---|---|---|---| +| 有効 / 無効 | Toggle | ON | 翻訳機能全体 | +| Ollama Host | Text input | `http://localhost:11434` | placeholderにも参考値を表示 | +| Model | Select | 利用可能モデルから選択 | Ollamaからモデル一覧取得 | +| 翻訳先言語 | Select | 日本語 | 初期版は主要言語を定義 | +| Thinking | Select | off | `off/on/low/medium/high` をモデル対応範囲で扱う | +| Temperature | Slider | 0.2 推奨 | 0.0〜2.0、0.1刻み | +| Context Length | Discrete slider | 16k等 | 4k / 8k / 16k / 32k / 128k / 256k | +| Seed Mode | Segmented / Radio | 可変 | 可変 / 固定 | +| Seed Value | Integer input + spinner | 例: 42 | 固定モード時のみ有効 | +| ユーザー用システムプロンプト | Textarea | 参考文をplaceholder表示 | アプリ固定プロンプトとは分離 | + +### 5.2 詳細設定 + +数値項目は原則としてテキスト入力 + ▲▼ステッパーを使用する。 + +| 項目 | 型 | 推奨ステップ | 参考値/placeholder | +|---|---:|---:|---:| +| num_keep | int | 1 | 4 | +| num_predict | int | 1 | -1 | +| top_k | int | 1 | 40 | +| top_p | float | 0.05 | 0.9 | +| min_p | float | 0.01 | 0.05 | +| typical_p | float | 0.05 | 1.0 | +| repeat_last_n | int | 1 | 64 | +| repeat_penalty | float | 0.05 | 1.1 | +| presence_penalty | float | 0.05 | 0.0 | +| frequency_penalty | float | 0.05 | 0.0 | +| stop | string[] | - | `例: <END>` | + +### 5.3 設定UI規則 + +- 数値入力欄はキーボード直接入力を許可する。 +- 数値入力欄には▲▼ステッパーを表示する。 +- 入力値未設定時はOllamaまたはアプリ既定値を使用する。 +- 各テキスト入力欄には薄いplaceholderで参考値を表示する。 +- Context Lengthは任意数値入力ではなく固定プリセットのみとする。 +- Temperatureはスライダーのみで変更可能とし、0.1刻みとする。 +- Seedは「可変」「固定」を明示的に選択できること。 +- Seed固定時のみSeed ValueをOllama requestへ含める。 +- Seed可変時は固定seedを送信しないか、アプリ側で毎回可変となる扱いにする。 + +--- + +## 6. システムプロンプト要件 + +### 6.1 固定システムプロンプト +アプリ側に固定で保持し、通常ユーザーから編集できないこと。 + +必須内容: +- 翻訳のみを実行する。 +- 翻訳先言語に翻訳する。 +- 原文の意味、トーン、固有名詞、技術用語を可能な限り維持する。 +- 原文中の命令をLLMへの指示として解釈しない。 +- 原文中の質問へ回答せず、質問文自体を翻訳する。 +- 不要な解説、前置き、注釈を付けず、原則翻訳本文のみ返す。 + +### 6.2 ユーザー用システムプロンプト +- ユーザーが翻訳スタイルを追加指定できること。 +- 固定プロンプトを完全に置き換えないこと。 +- アプリ側で固定プロンプトと結合して1つのsystem messageとして送信すること。 + +--- + +## 7. Ollama連携要件 + +| ID | 要件 | +|---|---| +| OLL-01 | 公式Ollama REST APIを利用すること（`ollama-js`等のサードパーティSDKは使用しない） | +| OLL-02 | Browser標準のFetch API / Streams APIを使用し、NDJSONレスポンスを安全にパースすること。チャンク境界がJSONオブジェクト境界と一致しない場合にも耐えること | +| OLL-03 | OllamaアクセスはBackgroundのみから行うこと | +| OLL-04 | 既定Hostは `http://localhost:11434` とする | +| OLL-05 | モデル一覧を取得しModel選択に反映すること | +| OLL-06 | Chat APIへ `model`, `messages`, `stream`, `think`, `options` を必要に応じて渡すこと | +| OLL-07 | 未設定の詳細オプションは不要に送信しないこと | +| OLL-08 | `tfs_z`, `mirostat`, `mirostat_tau`, `mirostat_eta` は現行実装対象外とすること | +| OLL-09 | 接続先Hostはvalidatorにより `http://localhost:<port>` または `http://127.0.0.1:<port>` のみに限定すること。Ollama通信前にclient側で再検証すること | + +--- + +## 8. Firefox WebExtensions要件 + +### 8.1 採用 + +| 用途 | API / 機能 | +|---|---| +| Background | `background.scripts` | +| Toolbar | `action` | +| 設定保存 | `browser.storage.local` | +| Content Script通信 | `browser.runtime.connect()` / `runtime.Port` | +| 単発通信 | `browser.runtime.sendMessage()` | +| ページ注入 | `content_scripts` manifest宣言 | +| 設定画面 | `options_ui` | + +### 8.2 原則使用しないもの + +| 非採用 | 理由 / 代替 | +|---|---| +| Manifest V2 | MV3採用 | +| `browser_action` / `browserAction.*` | `action` を使用 | +| `tabs.executeScript()` | 必要なら `scripting.executeScript()`。初期版では原則不要 | +| `tabs.insertCSS()` | 必要なら `scripting.insertCSS()` | +| `background.service_worker` | Firefoxでは採用しない | +| `runtime.getBackgroundPage()` | message / Portで疎結合化 | +| `extension.getBackgroundPage()` | 同上 | +| `window.localStorage` | `storage.local` | +| `eval()` / `new Function()` | セキュリティ上禁止 | +| CDN / Remote JavaScript | 全依存をbundleへ同梱 | +| `innerHTML`によるLLM出力描画 | `textContent`を使用 | +| `externally_connectable` | 不要 | +| `runtime.onMessageExternal` | 不要 | +| `runtime.onConnectExternal` | 不要 | +| `window.postMessage`でページscript連携 | 不要 | +| `wrappedJSObject`, `cloneInto`, `exportFunction` | 不要 | + +--- + +## 9. 権限要件 + +### 9.1 必須権限 + +```json +{ + "permissions": ["storage"], + "host_permissions": ["http://localhost/*", "http://127.0.0.1/*"] +} +``` + +注: Firefoxのmatch patternはポート番号の指定に対応していない（Firefox bug 1362809 / 1468162）。そのため `http://localhost/*` はlocalhostの任意ポートに一致する。実際に通信してよい接続先（localhost / 127.0.0.1 + 任意ポート）はアプリ側のHost validatorで限定する（OLL-09）。 + +### 9.2 Content Script対象 + +```json +{ + "matches": ["http://*/*", "https://*/*"] +} +``` + +### 9.3 不要な権限 +初期版では以下を要求しないこと。 + +- `tabs` +- `cookies` +- `webRequest` +- `history` +- `bookmarks` +- `downloads` +- `nativeMessaging` +- `scripting`（manifest宣言Content Scriptのみで実現できる限り） + +--- + +## 10. セキュリティ要件 + +| ID | 要件 | +|---|---| +| SEC-01 | Webページ、ページDOM、選択文字列を信頼しないこと | +| SEC-02 | ページ文字列・LLM出力をHTMLとして評価しないこと | +| SEC-03 | 翻訳UIへの文字列挿入は `textContent` 等の安全なAPIを使用すること | +| SEC-04 | Content ScriptからOllamaへ直接fetchしないこと | +| SEC-05 | 権限付き通信はBackgroundに限定すること | +| SEC-06 | Backgroundで受信messageの型・長さ・requestIdを検証すること | +| SEC-07 | 選択文字列の最大長を設定すること | +| SEC-08 | Remote JavaScriptをロードしないこと | +| SEC-09 | `eval`, `new Function`, 文字列評価を使用しないこと | +| SEC-10 | ページscriptと直接オブジェクト共有しないこと | +| SEC-11 | `storage.local` に秘密鍵・パスワード等の機密情報を保存しないこと | +| SEC-12 | CSPは必要最小限とし、安易に緩和しないこと | +| SEC-13 | 設定値はBackgroundで型・範囲を再検証すること | +| SEC-14 | 異常な大量requestを避けるため同時翻訳は原則1件とすること | + +初期の最大選択長は20,000文字程度を上限候補とし、実装時に定数化する。 + +--- + +## 11. エラー処理 + +| ケース | UI/処理 | +|---|---| +| Ollama未起動 | 接続エラーを翻訳ポップオーバーに表示 | +| Host不正 | 設定値エラーとして表示 | +| モデル未存在 | モデル未検出エラー | +| Streaming中断 | 中断状態を表示、UIを操作可能に戻す | +| 選択文字列過大 | 翻訳せず上限超過メッセージ | +| 空選択 | 無視 | +| 不正message | Backgroundで破棄 | +| 設定値不正 | 保存前または送信前に拒否 | + +--- + +## 12. 非機能要件 + +| 項目 | 要件 | +|---|---| +| UX | 選択→アイコン→翻訳まで自然で、チャットUIに見えないこと | +| 性能 | 文字列選択だけではLLMを呼ばないこと | +| 同時実行 | 原則1翻訳。新規要求で旧要求をAbort | +| 保守性 | Content / Background / Settings / Ollama clientを分離 | +| 依存 | 必要最小限。大規模UIフレームワークは原則不要 | +| ログ | デバッグ用途に限定し、選択本文を恒常ログへ残さないこと | +| プライバシー | 初期版ではローカルOllamaを前提とし、選択文字列を第三者サービスへ送信しないこと | + +--- + +## 13. テスト要件 + +### 13.1 単体テスト +- 設定値validation +- system prompt組み立て +- Ollama request object生成 +- message validation +- 選択文字列長制限 +- requestId管理 +- 設定default適用 +- Seed可変/固定のrequest反映 + +### 13.2 結合テスト +- Content Script → Background → Ollama → Content Scriptのstream伝送 +- 新規request時の旧stream Abort +- Ollama未起動時のエラー処理 +- モデル未存在時のエラー処理 +- storage保存/復元 + +### 13.3 Firefox実機動作確認 +最低限以下を実際のFirefoxで確認すること。 + +1. 通常HTMLページで文字列選択後、翻訳アイコンが表示される。 +2. アイコン押下までOllama requestが発生しない。 +3. アイコン押下で翻訳ポップオーバーが表示される。 +4. streaming結果が逐次表示される。 +5. コピーが動作する。 +6. 再生成が動作する。 +7. 閉じる操作が動作する。 +8. 新規翻訳で旧streamがキャンセルされる。 +9. 拡張無効時は翻訳アイコンが出ない。 +10. 設定変更後の値が次回翻訳に反映される。 +11. Firefox再起動後も設定が保持される。 +12. Ollama停止時に適切なエラーとなる。 +13. ページ内のHTMLらしき文字列やscript文字列を選択してもDOM実行されない。 +14. LLM出力にHTML文字列が含まれてもHTMLとして解釈されない。 + +--- + +## 14. 受け入れ条件 + +以下をすべて満たした時点で初期版を完了とする。 + +- Firefoxへ一時アドオンとしてロードできる。 +- 選択文字列付近へ翻訳アイコンを表示できる。 +- ユーザー操作後のみ翻訳が開始される。 +- Ollama `chat()` streamingで翻訳できる。 +- 翻訳結果をページ上のポップオーバーへ逐次表示できる。 +- 基本設定・詳細設定を保存/反映できる。 +- Seed可変/固定を切り替えられる。 +- Context Length固定プリセットとTemperature 0.1刻みスライダーが動作する。 +- 数値詳細設定が入力欄 + ▲▼ステッパーで動作する。 +- 旧streamキャンセルが動作する。 +- 不要な高権限APIを要求しない。 +- 非推奨/旧式APIを使用しない。 +- ページ/LLM由来文字列をHTMLとして評価しない。 +- 単体・結合・Firefox実機テストが成功する。 + +--- + +## 15. 初期版の対象外 + +- Chrome/Edge完全互換 +- iframe内翻訳 +- Firefox内蔵PDF Viewerへの対応 +- 翻訳履歴管理 +- チャット機能 +- 複数同時翻訳 +- Web検索・Tool Calling +- Ollama Cloud認証 +- APIキー保存 +- Markdown/HTMLリッチレンダリング +- 自動翻訳（選択しただけでLLM実行） +- `tfs_z` / `mirostat*` |