Merge branch 'develop' into copy_and_paste
This commit is contained in:
misyaguziya
@@ -272,8 +272,8 @@ class ManagedProperty:
|
||||
if self.readonly:
|
||||
raise AttributeError(f"Cannot set read-only property '{self.name}'")
|
||||
|
||||
# Type check if requested
|
||||
if self.type_ is not None and not isinstance(value, self.type_):
|
||||
# Type check if requested（Noneは常に許可）
|
||||
if self.type_ is not None and value is not None and not isinstance(value, self.type_):
|
||||
return
|
||||
|
||||
# Allowed-values check: can be an iterable or a callable
|
||||
@@ -527,6 +527,19 @@ def _compute_device_validator(val, inst):
|
||||
return copy.deepcopy(val)
|
||||
return None
|
||||
|
||||
def _allowed_in_populated(list_attr_name: str):
|
||||
def _inner(value, inst):
|
||||
try:
|
||||
lst = getattr(inst, list_attr_name)
|
||||
except Exception:
|
||||
return True # インスタンス状態取得失敗時も弾かない
|
||||
if not lst: # 空/未初期化
|
||||
return True
|
||||
if value is None:
|
||||
return True
|
||||
return value in lst
|
||||
return _inner
|
||||
|
||||
|
||||
class Config:
|
||||
"""Application configuration singleton.
|
||||
@@ -558,8 +571,16 @@ class Config:
|
||||
return cls._instance
|
||||
|
||||
def saveConfigToFile(self) -> None:
|
||||
# 永続化対象を descriptor 情報 (json_serializable_vars) から再構成
|
||||
filtered = {}
|
||||
for var_name, var_func in json_serializable_vars.items():
|
||||
try:
|
||||
filtered[var_name] = var_func(self)
|
||||
except Exception:
|
||||
pass
|
||||
self._config_data = filtered
|
||||
with open(self.PATH_CONFIG, "w", encoding="utf-8") as fp:
|
||||
json_dump(self._config_data, fp, indent=4, ensure_ascii=False)
|
||||
json_dump(filtered, fp, indent=4, ensure_ascii=False)
|
||||
|
||||
def saveConfig(self, key: str, value: Any, immediate_save: bool = False) -> None:
|
||||
self._config_data[key] = value
|
||||
@@ -581,9 +602,6 @@ class Config:
|
||||
PATH_LOGS = ManagedProperty('PATH_LOGS', readonly=True, serialize=False)
|
||||
GITHUB_URL = ManagedProperty('GITHUB_URL', readonly=True, serialize=False)
|
||||
UPDATER_URL = ManagedProperty('UPDATER_URL', readonly=True, serialize=False)
|
||||
BOOTH_URL = ManagedProperty('BOOTH_URL', readonly=True, serialize=False)
|
||||
DOCUMENTS_URL = ManagedProperty('DOCUMENTS_URL', readonly=True, serialize=False)
|
||||
DEEPL_AUTH_KEY_PAGE_URL = ManagedProperty('DEEPL_AUTH_KEY_PAGE_URL', readonly=True, serialize=False)
|
||||
MAX_MIC_THRESHOLD = ManagedProperty('MAX_MIC_THRESHOLD', readonly=True, serialize=False)
|
||||
MAX_SPEAKER_THRESHOLD = ManagedProperty('MAX_SPEAKER_THRESHOLD', readonly=True, serialize=False)
|
||||
WATCHDOG_TIMEOUT = ManagedProperty('WATCHDOG_TIMEOUT', readonly=True, serialize=False)
|
||||
@@ -601,12 +619,12 @@ class Config:
|
||||
|
||||
# Read Write
|
||||
# --- Simple boolean flags (managed by descriptor) ---
|
||||
ENABLE_TRANSLATION = ManagedProperty('ENABLE_TRANSLATION', type_=bool)
|
||||
ENABLE_TRANSCRIPTION_SEND = ManagedProperty('ENABLE_TRANSCRIPTION_SEND', type_=bool)
|
||||
ENABLE_TRANSCRIPTION_RECEIVE = ManagedProperty('ENABLE_TRANSCRIPTION_RECEIVE', type_=bool)
|
||||
ENABLE_FOREGROUND = ManagedProperty('ENABLE_FOREGROUND', type_=bool)
|
||||
ENABLE_CHECK_ENERGY_SEND = ManagedProperty('ENABLE_CHECK_ENERGY_SEND', type_=bool)
|
||||
ENABLE_CHECK_ENERGY_RECEIVE = ManagedProperty('ENABLE_CHECK_ENERGY_RECEIVE', type_=bool)
|
||||
ENABLE_TRANSLATION = ManagedProperty('ENABLE_TRANSLATION', type_=bool, serialize=False)
|
||||
ENABLE_TRANSCRIPTION_SEND = ManagedProperty('ENABLE_TRANSCRIPTION_SEND', type_=bool, serialize=False)
|
||||
ENABLE_TRANSCRIPTION_RECEIVE = ManagedProperty('ENABLE_TRANSCRIPTION_RECEIVE', type_=bool, serialize=False)
|
||||
ENABLE_FOREGROUND = ManagedProperty('ENABLE_FOREGROUND', type_=bool, serialize=False)
|
||||
ENABLE_CHECK_ENERGY_SEND = ManagedProperty('ENABLE_CHECK_ENERGY_SEND', type_=bool, serialize=False)
|
||||
ENABLE_CHECK_ENERGY_RECEIVE = ManagedProperty('ENABLE_CHECK_ENERGY_RECEIVE', type_=bool, serialize=False)
|
||||
|
||||
# --- Selectable dict/list properties (managed by descriptor, not serialized) ---
|
||||
# These are dynamically generated in init_config() based on installed packages/APIs
|
||||
@@ -617,6 +635,8 @@ class Config:
|
||||
SELECTABLE_PLAMO_MODEL_LIST = ManagedProperty('SELECTABLE_PLAMO_MODEL_LIST', type_=list, serialize=False, mutable_tracking=True)
|
||||
SELECTABLE_GEMINI_MODEL_LIST = ManagedProperty('SELECTABLE_GEMINI_MODEL_LIST', type_=list, serialize=False, mutable_tracking=True)
|
||||
SELECTABLE_OPENAI_MODEL_LIST = ManagedProperty('SELECTABLE_OPENAI_MODEL_LIST', type_=list, serialize=False, mutable_tracking=True)
|
||||
SELECTABLE_GROQ_MODEL_LIST = ManagedProperty('SELECTABLE_GROQ_MODEL_LIST', type_=list, serialize=False, mutable_tracking=True)
|
||||
SELECTABLE_OPENROUTER_MODEL_LIST = ManagedProperty('SELECTABLE_OPENROUTER_MODEL_LIST', type_=list, serialize=False, mutable_tracking=True)
|
||||
SELECTABLE_LMSTUDIO_MODEL_LIST = ManagedProperty('SELECTABLE_LMSTUDIO_MODEL_LIST', type_=list, serialize=False, mutable_tracking=True)
|
||||
SELECTABLE_OLLAMA_MODEL_LIST = ManagedProperty('SELECTABLE_OLLAMA_MODEL_LIST', type_=list, serialize=False, mutable_tracking=True)
|
||||
|
||||
@@ -711,11 +731,13 @@ class Config:
|
||||
USE_EXCLUDE_WORDS = ManagedProperty('USE_EXCLUDE_WORDS', type_=bool)
|
||||
CTRANSLATE2_WEIGHT_TYPE = ManagedProperty('CTRANSLATE2_WEIGHT_TYPE', type_=str, allowed=lambda v, inst: v in inst.SELECTABLE_CTRANSLATE2_WEIGHT_TYPE_LIST)
|
||||
WHISPER_WEIGHT_TYPE = ManagedProperty('WHISPER_WEIGHT_TYPE', type_=str, allowed=lambda v, inst: v in inst.SELECTABLE_WHISPER_WEIGHT_TYPE_LIST)
|
||||
SELECTED_PLAMO_MODEL = ManagedProperty('SELECTED_PLAMO_MODEL', type_=str, allowed=lambda v, inst: v in inst.SELECTABLE_PLAMO_MODEL_LIST)
|
||||
SELECTED_GEMINI_MODEL = ManagedProperty('SELECTED_GEMINI_MODEL', type_=str, allowed=lambda v, inst: v in inst.SELECTABLE_GEMINI_MODEL_LIST)
|
||||
SELECTED_OPENAI_MODEL = ManagedProperty('SELECTED_OPENAI_MODEL', type_=str, allowed=lambda v, inst: v in inst.SELECTABLE_OPENAI_MODEL_LIST)
|
||||
SELECTED_LMSTUDIO_MODEL = ManagedProperty('SELECTED_LMSTUDIO_MODEL', type_=str, allowed=lambda v, inst: v in inst.SELECTABLE_LMSTUDIO_MODEL_LIST)
|
||||
SELECTED_OLLAMA_MODEL = ManagedProperty('SELECTED_OLLAMA_MODEL', type_=str, allowed=lambda v, inst: v in inst.SELECTABLE_OLLAMA_MODEL_LIST)
|
||||
SELECTED_PLAMO_MODEL = ManagedProperty('SELECTED_PLAMO_MODEL', type_=str, allowed=_allowed_in_populated('SELECTABLE_PLAMO_MODEL_LIST'))
|
||||
SELECTED_GEMINI_MODEL = ManagedProperty('SELECTED_GEMINI_MODEL', type_=str, allowed=_allowed_in_populated('SELECTABLE_GEMINI_MODEL_LIST'))
|
||||
SELECTED_OPENAI_MODEL = ManagedProperty('SELECTED_OPENAI_MODEL', type_=str, allowed=_allowed_in_populated('SELECTABLE_OPENAI_MODEL_LIST'))
|
||||
SELECTED_GROQ_MODEL = ManagedProperty('SELECTED_GROQ_MODEL', type_=str, allowed=_allowed_in_populated('SELECTABLE_GROQ_MODEL_LIST'))
|
||||
SELECTED_OPENROUTER_MODEL = ManagedProperty('SELECTED_OPENROUTER_MODEL', type_=str, allowed=_allowed_in_populated('SELECTABLE_OPENROUTER_MODEL_LIST'))
|
||||
SELECTED_LMSTUDIO_MODEL = ManagedProperty('SELECTED_LMSTUDIO_MODEL', type_=str, allowed=_allowed_in_populated('SELECTABLE_LMSTUDIO_MODEL_LIST'))
|
||||
SELECTED_OLLAMA_MODEL = ManagedProperty('SELECTED_OLLAMA_MODEL', type_=str, allowed=_allowed_in_populated('SELECTABLE_OLLAMA_MODEL_LIST'))
|
||||
|
||||
# --- Translation and language settings ---
|
||||
MIC_WORD_FILTER = ValidatedProperty('MIC_WORD_FILTER', _mic_word_filter_validator)
|
||||
@@ -740,7 +762,7 @@ class Config:
|
||||
|
||||
def init_config(self):
|
||||
# Read Only
|
||||
self._VERSION = "3.3.1"
|
||||
self._VERSION = "3.3.2"
|
||||
if getattr(sys, 'frozen', False):
|
||||
self._PATH_LOCAL = os_path.dirname(sys.executable)
|
||||
else:
|
||||
@@ -750,9 +772,6 @@ class Config:
|
||||
os_makedirs(self._PATH_LOGS, exist_ok=True)
|
||||
self._GITHUB_URL = "https://api.github.com/repos/misyaguziya/VRCT/releases/latest"
|
||||
self._UPDATER_URL = "https://api.github.com/repos/misyaguziya/VRCT_updater/releases/latest"
|
||||
self._BOOTH_URL = "https://misyaguziya.booth.pm/"
|
||||
self._DOCUMENTS_URL = "https://mzsoftware.notion.site/VRCT-Documents-be79b7a165f64442ad8f326d86c22246"
|
||||
self._DEEPL_AUTH_KEY_PAGE_URL = "https://www.deepl.com/ja/account/summary"
|
||||
|
||||
self._MAX_MIC_THRESHOLD = 2000
|
||||
self._MAX_SPEAKER_THRESHOLD = 4000
|
||||
@@ -798,6 +817,8 @@ class Config:
|
||||
self._SELECTABLE_PLAMO_MODEL_LIST = []
|
||||
self._SELECTABLE_GEMINI_MODEL_LIST = []
|
||||
self._SELECTABLE_OPENAI_MODEL_LIST = []
|
||||
self._SELECTABLE_GROQ_MODEL_LIST = []
|
||||
self._SELECTABLE_OPENROUTER_MODEL_LIST = []
|
||||
self._SELECTABLE_LMSTUDIO_MODEL_LIST = []
|
||||
self._SELECTABLE_OLLAMA_MODEL_LIST = []
|
||||
|
||||
@@ -922,6 +943,8 @@ class Config:
|
||||
"Plamo_API": None,
|
||||
"Gemini_API": None,
|
||||
"OpenAI_API": None,
|
||||
"Groq_API": None,
|
||||
"OpenRouter_API": None,
|
||||
}
|
||||
self._USE_EXCLUDE_WORDS = True
|
||||
self._SELECTED_TRANSLATION_COMPUTE_DEVICE = copy.deepcopy(self.SELECTABLE_COMPUTE_DEVICE_LIST[0])
|
||||
@@ -930,6 +953,8 @@ class Config:
|
||||
self._SELECTED_PLAMO_MODEL = None
|
||||
self._SELECTED_GEMINI_MODEL = None
|
||||
self._SELECTED_OPENAI_MODEL = None
|
||||
self._SELECTED_GROQ_MODEL = None
|
||||
self._SELECTED_OPENROUTER_MODEL = None
|
||||
self._LMSTUDIO_URL = "http://127.0.0.1:1234/v1"
|
||||
self._SELECTED_LMSTUDIO_MODEL = None
|
||||
self._SELECTED_OLLAMA_MODEL = None
|
||||
@@ -1012,15 +1037,46 @@ class Config:
|
||||
self._config_data = json_load(fp)
|
||||
|
||||
for key, value in self._config_data.items():
|
||||
# 読み込み時: serialize=True かつ readonlyでない Descriptor のみ反映。
|
||||
# 未知キー（Descriptorなし）は無視して注入を防止。
|
||||
try:
|
||||
setattr(self, key, value)
|
||||
descriptor = getattr(type(self), key, None)
|
||||
if isinstance(descriptor, ManagedProperty):
|
||||
if descriptor.readonly or not descriptor.serialize:
|
||||
continue
|
||||
setattr(self, key, value)
|
||||
elif isinstance(descriptor, ValidatedProperty):
|
||||
if not descriptor.serialize:
|
||||
continue
|
||||
setattr(self, key, value)
|
||||
else:
|
||||
# 不明キーは破棄（古い/不要/改竄の可能性）
|
||||
continue
|
||||
except Exception:
|
||||
errorLogging()
|
||||
self.saveConfigToFile()
|
||||
|
||||
with open(self.PATH_CONFIG, 'w', encoding="utf-8") as fp:
|
||||
for var_name, var_func in json_serializable_vars.items():
|
||||
self._config_data[var_name] = var_func(self)
|
||||
json_dump(self._config_data, fp, indent=4, ensure_ascii=False)
|
||||
def revalidate_selected_models(self):
|
||||
pairs = [
|
||||
('SELECTED_PLAMO_MODEL', 'SELECTABLE_PLAMO_MODEL_LIST'),
|
||||
('SELECTED_GEMINI_MODEL', 'SELECTABLE_GEMINI_MODEL_LIST'),
|
||||
('SELECTED_OPENAI_MODEL', 'SELECTABLE_OPENAI_MODEL_LIST'),
|
||||
('SELECTED_GROQ_MODEL', 'SELECTABLE_GROQ_MODEL_LIST'),
|
||||
('SELECTED_OPENROUTER_MODEL', 'SELECTABLE_OPENROUTER_MODEL_LIST'),
|
||||
('SELECTED_LMSTUDIO_MODEL', 'SELECTABLE_LMSTUDIO_MODEL_LIST'),
|
||||
('SELECTED_OLLAMA_MODEL', 'SELECTABLE_OLLAMA_MODEL_LIST'),
|
||||
]
|
||||
for sel_attr, list_attr in pairs:
|
||||
try:
|
||||
current = getattr(self, sel_attr)
|
||||
lst = getattr(self, list_attr)
|
||||
if lst and current is not None and current not in lst:
|
||||
if len(lst) > 0:
|
||||
setattr(self, sel_attr, lst[0])
|
||||
else:
|
||||
setattr(self, sel_attr, None)
|
||||
except Exception:
|
||||
errorLogging()
|
||||
|
||||
# Auto-register all descriptors after Config class definition
|
||||
_auto_register_descriptors()
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -216,11 +216,17 @@ _debounce_time: int = 2 # デバウンス時間（秒）
|
||||
**通信設定**
|
||||
- `OSC_IP_ADDRESS`: OSC IPアドレス（デフォルト: "127.0.0.1"）
|
||||
- `OSC_PORT`: OSCポート（デフォルト: 9000）
|
||||
- `AUTH_KEYS`: 認証キー辞書（DeepL API等）
|
||||
- `AUTH_KEYS`: 認証キー辞書（DeepL API, Groq API, OpenRouter API等）
|
||||
- `WEBSOCKET_HOST`: WebSocketホスト
|
||||
- `WEBSOCKET_PORT`: WebSocketポート
|
||||
- `WEBSOCKET_SERVER`: WebSocketサーバー有効フラグ（非永続化）
|
||||
|
||||
**翻訳エンジン モデル選択**
|
||||
- `SELECTABLE_GROQ_MODEL_LIST`: 利用可能な Groq モデルリスト（非永続化）
|
||||
- `SELECTED_GROQ_MODEL`: 選択中の Groq モデル
|
||||
- `SELECTABLE_OPENROUTER_MODEL_LIST`: 利用可能な OpenRouter モデルリスト（非永続化）
|
||||
- `SELECTED_OPENROUTER_MODEL`: 選択中の OpenRouter モデル
|
||||
|
||||
**オーバーレイ設定**
|
||||
- `OVERLAY_SMALL_LOG`: 小ログオーバーレイ有効
|
||||
- `OVERLAY_SMALL_LOG_SETTINGS`: 小ログオーバーレイ設定（位置、回転、表示時間等）
|
||||
@@ -273,11 +279,21 @@ def SELECTED_TAB_NO(self, value):
|
||||
```
|
||||
|
||||
各setterは以下のパターンを実装:
|
||||
1. 型チェック (`isinstance`)
|
||||
1. 型チェック (`isinstance`)：`ManagedProperty` による型チェックは `None` を許容するが、個別 setter が数値変換などを行う場合は `None` を拒否するケースがある
|
||||
2. 値の範囲・有効性チェック
|
||||
3. 内部変数への代入
|
||||
4. `saveConfig` 呼び出し（永続化対象の場合）
|
||||
|
||||
#### 型チェックの詳細（v3.3.0+）
|
||||
|
||||
```python
|
||||
# 型チェック実装：ManagedProperty 経由では None を常に許可
|
||||
if self.type_ is not None and value is not None and not isinstance(value, self.type_):
|
||||
return # 無視する
|
||||
```
|
||||
|
||||
この仕様は `ManagedProperty` を通じた型チェックに適用される。個別の setter で追加のバリデーションやキャストを行う場合、`None` は別途拒否されることがある。
|
||||
|
||||
### メッセージフォーマット構造
|
||||
|
||||
```python
|
||||
|
||||
@@ -4,6 +4,15 @@
|
||||
|
||||
`controller.py` は VRCT アプリケーションのビジネスロジック層であり、フロントエンド（UI）とバックエンド（Model）の間の制御フローを担当する。音声認識、翻訳、OSC通信、オーバーレイ表示など、VRCT の全機能の調整役として動作し、各種設定の取得・更新、デバイス管理、エラーハンドリングを提供する。
|
||||
|
||||
## 最近の更新 (2026-01-03)
|
||||
|
||||
- 起動高速化: 初期化時間を約12.6s→8.9sに短縮
|
||||
- AI Models Check 並列化: CTranslate2/Whisperの重みチェックを2並列で実行
|
||||
- 翻訳エンジン判定の非同期化: LMStudio/Ollamaをバックグラウンド判定、他APIは4並列
|
||||
- 重みチェック結果のキャッシュ: `_ctranslate2_available_cache` / `_whisper_available_cache` を導入し後続処理で再利用
|
||||
- 音声認識エンジン判定の高速化: Whisperはキャッシュ結果を利用し0.56s→0.00s
|
||||
- ソフトウェア更新チェックの非同期化: GitHub APIチェックをバックグラウンド化
|
||||
|
||||
## アーキテクチャ上の位置づけ
|
||||
|
||||
```
|
||||
@@ -693,7 +702,13 @@ OSC Query 機能が無効になったことを通知。無効化された機能
|
||||
- `config.AUTH_KEYS["DeepL_API"]` に保存
|
||||
- `config.SELECTABLE_TRANSLATION_ENGINE_STATUS["DeepL_API"]` を True に
|
||||
- `updateTranslationEngineAndEngineList()` を呼び出し
|
||||
4. 認証失敗時: status 400 を返却
|
||||
4. 認証失敗時 (status 400):
|
||||
- レスポンス `data` フィールドは **常に None**（キーを返さない）
|
||||
- `delDeeplAuthKey()` を呼び出してクリーンアップ
|
||||
|
||||
**認証失敗時の共通ポリシー（Plamo/Gemini/OpenAI/DeepL/Groq/OpenRouter 共通）**
|
||||
- レスポンス `data` はキーを含めず `None` を返す
|
||||
- 対応する `del*AuthKey()` を呼び出し、保存済みキーとモデル選択をクリア
|
||||
|
||||
#### `delDeeplAuthKey(*args, **kwargs) -> dict`
|
||||
|
||||
@@ -706,6 +721,118 @@ OSC Query 機能が無効になったことを通知。無効化された機能
|
||||
|
||||
---
|
||||
|
||||
### 16-1. Groq API 認証・モデル管理
|
||||
|
||||
#### `setGroqAuthKey(data, *args, **kwargs) -> dict`
|
||||
|
||||
**責務:** Groq API キーを設定し、認証を実行
|
||||
|
||||
**処理:**
|
||||
1. キー長のバリデーション（`gsk` で始まり40文字以上）
|
||||
2. `model.authenticationTranslatorGroqAuthKey()` で認証
|
||||
3. 認証成功時:
|
||||
- `config.AUTH_KEYS["Groq_API"]` に保存
|
||||
- `config.SELECTABLE_TRANSLATION_ENGINE_STATUS["Groq_API"]` を True に
|
||||
- `config.SELECTABLE_GROQ_MODEL_LIST` を取得
|
||||
- 未選択の場合は先頭モデルを自動選択
|
||||
- `model.updateTranslatorGroqClient()` でクライアント更新
|
||||
- `updateTranslationEngineAndEngineList()` を呼び出し
|
||||
4. 認証失敗時 (status 400):
|
||||
- レスポンス `data` フィールドを **None に設定** （sensitive data を隠す）
|
||||
- `delGroqAuthKey()` を呼び出してクリーンアップ
|
||||
|
||||
**API キー検証失敗時の処理:**
|
||||
- モデルリストをクリア (`config.SELECTABLE_GROQ_MODEL_LIST = []`)
|
||||
- 選択モデルをクリア (`config.SELECTED_GROQ_MODEL = None`)
|
||||
- フロントエンドに通知（レスポンス `data` は None）
|
||||
|
||||
#### `delGroqAuthKey(*args, **kwargs) -> dict`
|
||||
|
||||
**責務:** Groq API キーを削除
|
||||
|
||||
**処理:**
|
||||
1. `config.AUTH_KEYS["Groq_API"]` を None に
|
||||
2. `config.SELECTABLE_TRANSLATION_ENGINE_STATUS["Groq_API"]` を False に
|
||||
3. モデルリストと選択モデルをクリア
|
||||
4. `updateTranslationEngineAndEngineList()` を呼び出し
|
||||
|
||||
#### `getGroqAuthKey(*args, **kwargs) -> dict`
|
||||
現在の Groq API キーを取得（マスク処理なし）。
|
||||
|
||||
#### `getGroqModelList(*args, **kwargs) -> dict`
|
||||
利用可能な Groq モデルリストを取得。
|
||||
|
||||
#### `getGroqModel(*args, **kwargs) -> dict`
|
||||
現在選択中の Groq モデルを取得。
|
||||
|
||||
#### `setGroqModel(data, *args, **kwargs) -> dict`
|
||||
|
||||
**責務:** 使用する Groq モデルを変更
|
||||
|
||||
**処理:**
|
||||
1. モデル名のバリデーション（利用可能リスト内か確認）
|
||||
2. `model.setTranslatorGroqModel()` でモデル設定
|
||||
3. `model.updateTranslatorGroqClient()` でクライアント再生成
|
||||
4. `config.SELECTED_GROQ_MODEL` を更新
|
||||
|
||||
---
|
||||
|
||||
### 16-2. OpenRouter API 認証・モデル管理
|
||||
|
||||
#### `setOpenRouterAuthKey(data, *args, **kwargs) -> dict`
|
||||
|
||||
**責務:** OpenRouter API キーを設定し、認証を実行
|
||||
|
||||
**処理:**
|
||||
1. キー長のバリデーション（20文字以上）
|
||||
2. `model.authenticationTranslatorOpenRouterAuthKey()` で認証
|
||||
3. 認証成功時:
|
||||
- `config.AUTH_KEYS["OpenRouter_API"]` に保存
|
||||
- `config.SELECTABLE_TRANSLATION_ENGINE_STATUS["OpenRouter_API"]` を True に
|
||||
- `config.SELECTABLE_OPENROUTER_MODEL_LIST` を取得
|
||||
- 未選択の場合は先頭モデルを自動選択
|
||||
- `model.updateTranslatorOpenRouterClient()` でクライアント更新
|
||||
- `updateTranslationEngineAndEngineList()` を呼び出し
|
||||
4. 認証失敗時 (status 400):
|
||||
- レスポンス `data` フィールドを **None に設定** （sensitive data を隠す）
|
||||
- `delOpenRouterAuthKey()` を呼び出してクリーンアップ
|
||||
|
||||
**API キー検証失敗時の処理:**
|
||||
- モデルリストをクリア (`config.SELECTABLE_OPENROUTER_MODEL_LIST = []`)
|
||||
- 選択モデルをクリア (`config.SELECTED_OPENROUTER_MODEL = None`)
|
||||
- フロントエンドに通知（レスポンス `data` は None）
|
||||
|
||||
#### `delOpenRouterAuthKey(*args, **kwargs) -> dict`
|
||||
|
||||
**責務:** OpenRouter API キーを削除
|
||||
|
||||
**処理:**
|
||||
1. `config.AUTH_KEYS["OpenRouter_API"]` を None に
|
||||
2. `config.SELECTABLE_TRANSLATION_ENGINE_STATUS["OpenRouter_API"]` を False に
|
||||
3. モデルリストと選択モデルをクリア
|
||||
4. `updateTranslationEngineAndEngineList()` を呼び出し
|
||||
|
||||
#### `getOpenRouterAuthKey(*args, **kwargs) -> dict`
|
||||
現在の OpenRouter API キーを取得（マスク処理なし）。
|
||||
|
||||
#### `getOpenRouterModelList(*args, **kwargs) -> dict`
|
||||
利用可能な OpenRouter モデルリストを取得。
|
||||
|
||||
#### `getOpenRouterModel(*args, **kwargs) -> dict`
|
||||
現在選択中の OpenRouter モデルを取得。
|
||||
|
||||
#### `setOpenRouterModel(data, *args, **kwargs) -> dict`
|
||||
|
||||
**責務:** 使用する OpenRouter モデルを変更
|
||||
|
||||
**処理:**
|
||||
1. モデル名のバリデーション（利用可能リスト内か確認）
|
||||
2. `model.setTranslatorOpenRouterModel()` でモデル設定
|
||||
3. `model.updateTranslatorOpenRouterClient()` でクライアント再生成
|
||||
4. `config.SELECTED_OPENROUTER_MODEL` を更新
|
||||
|
||||
---
|
||||
|
||||
### 17. WebSocket サーバー制御
|
||||
|
||||
#### `setWebSocketHost(data, *args, **kwargs) -> dict`
|
||||
|
||||
@@ -4,6 +4,26 @@
|
||||
|
||||
VRCTアプリケーションのビジネスロジックを制御するコントローラークラスです。UI層とモデル層の間に位置し、ユーザーの入力を適切な処理に変換し、結果を UI に返す役割を担います。全ての機能制御、設定管理、状態管理を一元的に行います。
|
||||
|
||||
## 最近の更新 (2026-01-03)
|
||||
|
||||
### 起動高速化・非同期化
|
||||
|
||||
- 初期化時間を約12.6s→8.9sに短縮（環境計測値）
|
||||
- AI Models Check を2並列化（CTranslate2/Whisper）し、結果を `_ctranslate2_available_cache` / `_whisper_available_cache` に保存
|
||||
- 翻訳エンジン判定を並列化（ThreadPoolExecutor, max_workers=4）し、LMStudio/Ollamaはバックグラウンド判定に変更
|
||||
- ソフトウェア更新チェックをバックグラウンド化
|
||||
- OSC受信初期化をバックグラウンド化し、OSCQueryサービス生成は接続成功まで継続リトライ
|
||||
- 翻訳/音声認識エンジンのセット処理で重みチェックキャッシュを再利用し再計測を排除（0.98s/0.52s→0.00s）
|
||||
|
||||
### 影響
|
||||
|
||||
| 項目 | 内容 |
|
||||
|------|------|
|
||||
| 起動時間 | 約3.7s短縮（12.6s→8.9s） |
|
||||
| 並列・非同期化 | 翻訳・音声認識エンジン判定を並列/バックグラウンド化 |
|
||||
| 安定性 | OSCQuery起動のリトライ上限でブロッキングを抑制 |
|
||||
| 再利用性 | 重みチェック結果をキャッシュし重複I/Oを削減 |
|
||||
|
||||
## 最近の更新 (2025-10-20)
|
||||
|
||||
### 新規ローカルLLM翻訳エンジン統合
|
||||
@@ -399,25 +419,29 @@ speakerMessage(result: dict) -> None
|
||||
|
||||
## エラーハンドリング
|
||||
|
||||
### VRAM不足エラー
|
||||
### エラー構造
|
||||
- すべて `VRCTError` で生成し、ステータス・コード・メッセージ・data を統一
|
||||
- `create_error_response()` / `create_exception_error_response()` を使用し、`self.run()` へそのまま渡す
|
||||
- 代表コード: デバイス系 (`DEVICE_NO_MIC` / `DEVICE_NO_SPEAKER`)、VRAM系 (`TRANSLATION_VRAM_*`)、認証系 (`AUTH_*`)、モデル不正 (`MODEL_*`)、バリデーション系 (`VALIDATION_*`)、接続系 (`CONNECTION_LMSTUDIO_FAILED` など)
|
||||
|
||||
- 自動的にCTranslate2への切り替え
|
||||
- ユーザーへの適切な通知
|
||||
### VRAM不足エラー
|
||||
- 翻訳処理中に VRAM 例外を検出し `/run/error_translation_*_vram_overflow` で通知
|
||||
- 翻訳機能を自動で無効化し、`TRANSLATION_DISABLED_VRAM` を通知
|
||||
- マイク/スピーカー/チャット/有効化時の各パスで専用コードを返却
|
||||
|
||||
### デバイスエラー
|
||||
- マイク・スピーカー未検出時に `DEVICE_NO_MIC` / `DEVICE_NO_SPEAKER`
|
||||
- エネルギーしきい値/タイムアウト等のバリデーションに `VALIDATION_*` を使用
|
||||
|
||||
- デバイス接続状態の監視
|
||||
- 自動復旧機能
|
||||
### 認証・モデルエラー
|
||||
- DeepL/Plamo/Gemini/OpenAI/Groq/OpenRouter の認証失敗やキー長不正を `AUTH_*` で通知
|
||||
- モデル未選択/不正時は `MODEL_*` で通知し、選択リストを再送
|
||||
|
||||
### ネットワークエラー
|
||||
|
||||
- 接続状態の定期確認
|
||||
- オフライン機能への切り替え
|
||||
### 接続エラー
|
||||
- LMStudio/Ollama 接続失敗を `CONNECTION_*` で通知し、翻訳エンジンリストを更新
|
||||
|
||||
### 設定エラー
|
||||
|
||||
- 設定値の妥当性チェック
|
||||
- デフォルト値への復帰
|
||||
- IP アドレスやしきい値などの不正値を `VALIDATION_*` で統一し、リクエスト値を data に格納
|
||||
|
||||
## パフォーマンス考慮事項
|
||||
|
||||
|
||||
87
src-python/docs/details/translation_groq.md
Normal file
87
src-python/docs/details/translation_groq.md
Normal file
@@ -0,0 +1,87 @@
|
||||
# translation_groq.py - Groq 翻訳クライアント
|
||||
|
||||
## 概要
|
||||
|
||||
Groq API を用いた高速 LLM 翻訳クライアントラッパー。OpenAI 互換エンドポイント (`https://api.groq.com/openai/v1`) を利用し、モデル一覧取得・認証・モデル選択・翻訳実行を提供する。
|
||||
|
||||
## 最近の更新 (2025-12-10)
|
||||
|
||||
- Groq API サポートを新規追加
|
||||
- OpenAI 互換エンドポイント経由で高速 LLM 推論を実現
|
||||
- 除外キーワード (`whisper`, `embedding`, `image`, `tts`, `audio`, `search`, `transcribe`, `diarize`, `vision`) によるテキスト処理モデルのフィルタリング
|
||||
- YAML (`prompt/translation_groq.yml`) からシステムプロンプトをロード
|
||||
|
||||
### 影響
|
||||
|
||||
| 項目 | 内容 |
|
||||
|------|------|
|
||||
| 高速化 | Groq の専用ハードウェアによる高速推論 |
|
||||
| 互換性 | OpenAI 互換 API で既存実装との一貫性維持 |
|
||||
| 保守性 | OpenAI クライアントと同様の設計で保守容易 |
|
||||
|
||||
## 責務
|
||||
|
||||
- Groq API Key (`gsk-` で始まる40文字以上) を用いた認証確認
|
||||
- 利用可能モデルのフィルタリングとソート
|
||||
- 選択モデルの検証と内部保持
|
||||
- LangChain `ChatOpenAI` インスタンス生成（base_url に Groq エンドポイント指定）
|
||||
- システムプロンプトによる翻訳実行
|
||||
|
||||
## 公開API (メソッド)
|
||||
|
||||
```python
|
||||
class GroqClient:
|
||||
def __init__(root_path: str = None)
|
||||
def getModelList() -> list[str]
|
||||
def getAuthKey() -> str | None
|
||||
def setAuthKey(api_key: str) -> bool
|
||||
def getModel() -> str | None
|
||||
def setModel(model: str) -> bool
|
||||
def updateClient() -> None
|
||||
def translate(text: str, input_lang: str, output_lang: str) -> str
|
||||
```
|
||||
|
||||
### メソッド詳細
|
||||
|
||||
- `setAuthKey`: `_authentication_check` に成功した場合のみ内部保存
|
||||
- `getModelList`: モデル列挙後フィルタリング適用しソート
|
||||
- `setModel`: 取得済みリスト内のモデルのみ受理
|
||||
- `updateClient`: `ChatOpenAI` を選択モデル・Groq base_url で再生成
|
||||
- `translate`: システム + ユーザメッセージ構築→LLM呼び出し→レスポンス正規化
|
||||
|
||||
## 使用例
|
||||
|
||||
```python
|
||||
client = GroqClient()
|
||||
if client.setAuthKey("gsk_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"):
|
||||
models = client.getModelList()
|
||||
client.setModel(models[0])
|
||||
client.updateClient()
|
||||
result = client.translate("こんにちは世界", "Japanese", "English")
|
||||
print(result)
|
||||
```
|
||||
|
||||
## 依存関係
|
||||
|
||||
- `openai.OpenAI`: モデル列挙 / 推論（Groq エンドポイント経由）
|
||||
- `langchain_openai.ChatOpenAI`: LangChain ラッパー
|
||||
- `translation_languages.translation_lang`: 対応言語集合
|
||||
- `translation_utils.loadPromptConfig`: プロンプト YAML ロード
|
||||
|
||||
## 注意事項
|
||||
|
||||
- base_url は固定で `https://api.groq.com/openai/v1`
|
||||
- ストリーミング無効 (streaming=False) 固定
|
||||
- API Key 無設定時 `getModelList()` は空
|
||||
- API Key は `gsk` で始まり40文字以上であることを検証
|
||||
|
||||
## 制限事項
|
||||
|
||||
- エラーメッセージ詳細は包括的に扱わない (上位層でロギング)
|
||||
- 翻訳結果の構造が複雑 (list/dict) 場合を単純文字列へ normalize するのみ
|
||||
|
||||
## 関連ドキュメント
|
||||
|
||||
- `details/translation_translator.md`
|
||||
- `details/translation_languages.md`
|
||||
- `details/translation_openai.md` (類似実装)
|
||||
@@ -4,6 +4,14 @@
|
||||
|
||||
LMStudio 互換 OpenAI API を利用したローカル LLM 翻訳クライアントラッパー。モデル一覧取得・モデル選択・翻訳処理を統一インターフェースで提供する。
|
||||
|
||||
## 最近の更新 (2025-12-30)
|
||||
|
||||
- 接続失敗時のエラーハンドリング改善
|
||||
- URL への疎通確認失敗時にモデルリストをクリア (`SELECTABLE_LMSTUDIO_MODEL_LIST = []`)
|
||||
- 選択モデルをクリア (`SELECTED_LMSTUDIO_MODEL = None`)
|
||||
- `SELECTABLE_TRANSLATION_ENGINE_STATUS["LMStudio"]` を False に設定
|
||||
- フロントエンドに通知して UI を同期
|
||||
|
||||
## 最近の更新 (2025-10-20)
|
||||
|
||||
- 新規追加: ローカル LLM (LMStudio) を翻訳エンジン群へ統合
|
||||
@@ -73,6 +81,10 @@ if models:
|
||||
- `api_key` は固定文字列 "lmstudio" (LMStudio 側で不要のため) を利用
|
||||
- モデル一覧取得はエンドポイントの互換性に依存 (古いバージョン非対応の可能性)
|
||||
- `updateClient()` 呼び出し前は `translate()` を利用できない
|
||||
- **接続失敗時の自動処理:**
|
||||
- URL への疎通確認（接続テスト）が失敗すると、自動的にモデルリストと選択モデルがクリアされる
|
||||
- `SELECTABLE_TRANSLATION_ENGINE_STATUS["LMStudio"]` が False に設定され、エンジンが使用不可状態になる
|
||||
- Controller が自動的にフロントエンドに状態変化を通知
|
||||
|
||||
## 制限事項
|
||||
|
||||
|
||||
@@ -4,6 +4,14 @@
|
||||
|
||||
Ollama サーバー上で稼働するローカル LLM を翻訳エンジンとして扱うためのクライアントラッパー。モデル一覧取得・モデル選択・翻訳実行を統一パターンで提供する。
|
||||
|
||||
## 最近の更新 (2025-12-30)
|
||||
|
||||
- 接続失敗時のエラーハンドリング改善
|
||||
- `/api/ping` への疎通確認失敗時にモデルリストをクリア (`SELECTABLE_OLLAMA_MODEL_LIST = []`)
|
||||
- 選択モデルをクリア (`SELECTED_OLLAMA_MODEL = None`)
|
||||
- `SELECTABLE_TRANSLATION_ENGINE_STATUS["Ollama"]` を False に設定
|
||||
- フロントエンドに通知して UI を同期
|
||||
|
||||
## 最近の更新 (2025-10-20)
|
||||
|
||||
- 新規追加: Ollama を翻訳エンジン群へ統合
|
||||
@@ -73,6 +81,10 @@ if client.authenticationCheck():
|
||||
- サーバー既定 URL: `http://localhost:11434`
|
||||
- モデル一覧取得は起動しているローカルサーバー状態に依存
|
||||
- `updateClient()` 呼び出し前は `translate()` を利用不可
|
||||
- **接続失敗時の自動処理:**
|
||||
- `/api/ping` への疎通確認が失敗すると、自動的にモデルリストと選択モデルがクリアされる
|
||||
- `SELECTABLE_TRANSLATION_ENGINE_STATUS["Ollama"]` が False に設定され、エンジンが使用不可状態になる
|
||||
- Controller が自動的にフロントエンドに状態変化を通知
|
||||
|
||||
## 制限事項
|
||||
|
||||
|
||||
96
src-python/docs/details/translation_openrouter.md
Normal file
96
src-python/docs/details/translation_openrouter.md
Normal file
@@ -0,0 +1,96 @@
|
||||
# translation_openrouter.py - OpenRouter 翻訳クライアント
|
||||
|
||||
## 概要
|
||||
|
||||
OpenRouter API を用いた統合 LLM 翻訳クライアントラッパー。OpenAI 互換エンドポイント (`https://openrouter.ai/api/v1`) を利用し、複数の LLM プロバイダーへの統一アクセスを提供する。
|
||||
|
||||
## 最近の更新 (2025-12-29)
|
||||
|
||||
- OpenRouter API 認証チェック方法を変更
|
||||
- **以前:** `client.models.list()` を呼び出して認証確認
|
||||
- **現在:** `https://openrouter.ai/api/v1/auth/key` エンドポイントに GET リクエスト送信して確認
|
||||
- **理由:** より信頼性の高い専用認証エンドポイントを使用し、高速かつ確実に API キー有効性を検証
|
||||
- 認証失敗時の sensitive data 処理
|
||||
- API キー検証失敗時はレスポンス `data` フィールドに `None` を設定（API キーを露出させない）
|
||||
- エラーメッセージのみを返却し、具体的なキー情報は隠蔽
|
||||
|
||||
### 影響
|
||||
|
||||
| 項目 | 内容 |
|
||||
|------|------|
|
||||
| 柔軟性 | 複数 LLM プロバイダーを単一インターフェースで利用 |
|
||||
| 互換性 | OpenAI 互換 API で既存実装との一貫性維持 |
|
||||
| 拡張性 | 新規モデル追加時も API キー再設定不要 |
|
||||
|
||||
## 責務
|
||||
|
||||
- OpenRouter API Key (20文字以上) を用いた認証確認
|
||||
- `https://openrouter.ai/api/v1/auth/key` エンドポイントへの HTTP GET リクエストで検証（タイムアウト10秒）
|
||||
- ステータスコード 200 で有効と判定
|
||||
- 利用可能モデルのフィルタリングとソート
|
||||
- 選択モデルの検証と内部保持
|
||||
- LangChain `ChatOpenAI` インスタンス生成（base_url に OpenRouter エンドポイント指定）
|
||||
- システムプロンプトによる翻訳実行
|
||||
|
||||
## 公開API (メソッド)
|
||||
|
||||
```python
|
||||
class OpenRouterClient:
|
||||
def __init__(root_path: str = None)
|
||||
def getModelList() -> list[str]
|
||||
def getAuthKey() -> str | None
|
||||
def setAuthKey(api_key: str) -> bool
|
||||
def getModel() -> str | None
|
||||
def setModel(model: str) -> bool
|
||||
def updateClient() -> None
|
||||
def translate(text: str, input_lang: str, output_lang: str) -> str
|
||||
```
|
||||
|
||||
### メソッド詳細
|
||||
|
||||
- `setAuthKey`: `_authentication_check` に成功した場合のみ内部保存
|
||||
- `getModelList`: モデル列挙後フィルタリング適用しソート
|
||||
- `setModel`: 取得済みリスト内のモデルのみ受理
|
||||
- `updateClient`: `ChatOpenAI` を選択モデル・OpenRouter base_url で再生成
|
||||
- `translate`: システム + ユーザメッセージ構築→LLM呼び出し→レスポンス正規化
|
||||
|
||||
## 使用例
|
||||
|
||||
```python
|
||||
client = OpenRouterClient()
|
||||
if client.setAuthKey("sk_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"):
|
||||
models = client.getModelList()
|
||||
# OpenRouter は多数のモデルを提供
|
||||
client.setModel("anthropic/claude-3-sonnet")
|
||||
client.updateClient()
|
||||
result = client.translate("こんにちは世界", "Japanese", "English")
|
||||
print(result)
|
||||
```
|
||||
|
||||
## 依存関係
|
||||
|
||||
- `openai.OpenAI`: モデル列挙 / 推論（OpenRouter エンドポイント経由）
|
||||
- `langchain_openai.ChatOpenAI`: LangChain ラッパー
|
||||
- `translation_languages.translation_lang`: 対応言語集合
|
||||
- `translation_utils.loadPromptConfig`: プロンプト YAML ロード
|
||||
|
||||
## 注意事項
|
||||
|
||||
- base_url は固定で `https://openrouter.ai/api/v1`
|
||||
- ストリーミング無効 (streaming=False) 固定
|
||||
- API Key 無設定時 `getModelList()` は空
|
||||
- API Key は20文字以上であることを検証
|
||||
|
||||
## 制限事項
|
||||
|
||||
- エラーメッセージ詳細は包括的に扱わない (上位層でロギング)
|
||||
- 翻訳結果の構造が複雑 (list/dict) 場合を単純文字列へ normalize するのみ
|
||||
- OpenRouter の料金体系はモデル毎に異なる（利用前に確認が必要）
|
||||
|
||||
## 関連ドキュメント
|
||||
|
||||
- `details/translation_translator.md`
|
||||
- `details/translation_languages.md`
|
||||
- `details/translation_openai.md` (類似実装)
|
||||
- `details/translation_groq.md` (類似実装)
|
||||
|
||||
186
src-python/docs/details/translation_prompt_history.md
Normal file
186
src-python/docs/details/translation_prompt_history.md
Normal file
@@ -0,0 +1,186 @@
|
||||
# 翻訳プロンプトへの履歴注入（Chat/Mic/Speaker）
|
||||
|
||||
LLM は直前までの会話文脈を理解して翻訳品質を向上させられます。そのため、システムプロンプトに最近の履歴（Chat/Mic/Speaker）を内包する機能を追加しました。大量のログでトークン消費が増えないよう、YAML 設定で取り込み範囲と上限を管理できます。
|
||||
|
||||
## アーキテクチャ
|
||||
|
||||
### 履歴管理（Model）
|
||||
|
||||
**`model.py`** でChat/Mic/Speakerのメッセージ履歴を一元管理：
|
||||
|
||||
```python
|
||||
# 履歴バッファ（最大50件）
|
||||
self.translation_history: list[dict] = []
|
||||
self.translation_history_max_items = 50
|
||||
|
||||
# 履歴追加（オリジナルメッセージのみ、翻訳結果は保存しない）
|
||||
model.addTranslationHistory("chat", "こんにちは")
|
||||
model.addTranslationHistory("mic", "今日はいい天気")
|
||||
model.addTranslationHistory("speaker", "Hello!")
|
||||
|
||||
# 履歴取得
|
||||
history = model.getTranslationHistory(max_items=10)
|
||||
|
||||
# 履歴クリア
|
||||
model.clearTranslationHistory()
|
||||
```
|
||||
|
||||
### 自動注入（Model → Translator → 各LLMクライアント）
|
||||
|
||||
- **`model.getTranslate()`** で履歴を取得し、`translator.translate(..., context_history=history)` に渡す。
|
||||
- **`Translator.translate()`** 側でエンジンごとの分岐直前に `setContextHistory()` を呼び、履歴をプロンプト組み立てに反映する。
|
||||
|
||||
```python
|
||||
# model.getTranslate()
|
||||
history = self.getTranslationHistory()
|
||||
translation = self.translator.translate(
|
||||
translator_name=translator_name,
|
||||
weight_type=config.CTRANSLATE2_WEIGHT_TYPE,
|
||||
source_language=source_language,
|
||||
target_language=target_language,
|
||||
target_country=target_country,
|
||||
message=message,
|
||||
context_history=history,
|
||||
)
|
||||
|
||||
# Translator.translate() の一例（OpenAI）
|
||||
case "OpenAI_API":
|
||||
if self.openai_client is None:
|
||||
result = False
|
||||
else:
|
||||
if context_history:
|
||||
self.openai_client.setContextHistory(context_history)
|
||||
result = self.openai_client.translate(message, input_lang=source_language, output_lang=target_language)
|
||||
```
|
||||
|
||||
### メッセージ処理（Controller）
|
||||
|
||||
**`controller.py`** で各メッセージ処理完了後に履歴へ追加（翻訳の成否に関係なく、オリジナル文だけ保存）：
|
||||
|
||||
- **Chat**: `chatMessage()` の末尾で `model.addTranslationHistory("chat", ...)`
|
||||
- **Mic**: `micMessage()` の末尾で `model.addTranslationHistory("mic", ...)`
|
||||
- **Speaker**: `speakerMessage()` の末尾で `model.addTranslationHistory("speaker", ...)`
|
||||
|
||||
## 設定ファイル（例: OpenAI）
|
||||
|
||||
`src-python/models/translation/translation_settings/prompt/translation_openai.yml`
|
||||
|
||||
```yaml
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
history:
|
||||
use_history: true # 履歴をプロンプトへ注入するか
|
||||
sources: [chat, mic, speaker] # 取り込み対象の履歴種別
|
||||
max_messages: 10 # 注入する履歴件数の上限（新しい順）
|
||||
max_chars: 4000 # 履歴整形後の最大文字数（超過時は先頭を切り捨て）
|
||||
header_template: |
|
||||
Conversation context (recent {max_messages} messages):
|
||||
{history}
|
||||
item_template: "[{timestamp}][{source}] {text}"
|
||||
```
|
||||
|
||||
- `system_prompt`: 従来どおり、`{supported_languages}`/`{input_lang}`/`{output_lang}` が利用可能。
|
||||
- `history.use_history`: 履歴注入を有効化します。
|
||||
- `history.sources`: 取り込み対象ソース。`chat`/`mic`/`speaker` から選択。
|
||||
- `history.max_messages`: 新しい順に N 件を取り込みます。
|
||||
- `history.max_chars`: 整形後の履歴文字列の最大長。上限を超えた場合は先頭側を切り捨て（新しい文脈を優先）。
|
||||
- `history.header_template`: 履歴ヘッダの整形テンプレート。`{max_messages}`/`{history}` が利用可能。
|
||||
- `history.item_template`: 各履歴アイテムの整形テンプレート。`{timestamp}`（HH:MM形式）/`{source}`/`{text}` が利用可能。
|
||||
|
||||
## 実装（OpenAI クライアント）
|
||||
|
||||
`src-python/models/translation/translation_openai.py`
|
||||
|
||||
- `OpenAIClient.setContextHistory(history_items: list[dict])` を追加。
|
||||
- `history_items` は以下のキーを含む辞書の配列：
|
||||
- `source`: `"chat" | "mic" | "speaker"`
|
||||
- `text`: 文字列
|
||||
- `timestamp`: ISO形式の日時文字列（HH:MM形式にフォーマットされてプロンプトに挿入）
|
||||
- `translate()` 呼び出し時、YAML の `history` 設定に基づき、指定履歴をシステムプロンプト末尾へ整形して注入します。
|
||||
- 文字数上限は簡易的に `max_chars` で制御（トークンカウントは行わず、過剰消費抑制用の安全策）。
|
||||
|
||||
## 使い方
|
||||
|
||||
### 基本的な流れ
|
||||
|
||||
1. **メッセージ発生時に履歴追加**（controller.py で自動実行）
|
||||
```python
|
||||
# Chat送信時（オリジナルメッセージのみ保存）
|
||||
model.addTranslationHistory("chat", user_message)
|
||||
|
||||
# Mic入力時（音声認識結果のみ保存）
|
||||
model.addTranslationHistory("mic", transcribed_text)
|
||||
|
||||
# Speaker受信時（受信したオリジナルメッセージのみ保存）
|
||||
model.addTranslationHistory("speaker", received_text)
|
||||
```
|
||||
|
||||
2. **翻訳時に自動注入**（model.py で自動実行）
|
||||
```python
|
||||
# getTranslate() 内で自動的に履歴が各LLMクライアントへ注入される
|
||||
translation = model.getTranslate(translator_name, ...)
|
||||
```
|
||||
|
||||
3. **設定の調整**（YAML編集）
|
||||
```yaml
|
||||
history:
|
||||
use_history: true # 有効/無効
|
||||
sources: [chat, mic] # chatとmicのみ使う場合
|
||||
max_messages: 5 # 最新5件のみ
|
||||
max_chars: 2000 # 2000文字まで
|
||||
```
|
||||
|
||||
### 手動で履歴を操作（必要な場合のみ）
|
||||
|
||||
```python
|
||||
# 履歴をクリア
|
||||
model.clearTranslationHistory()
|
||||
|
||||
# 履歴を取得
|
||||
recent_history = model.getTranslationHistory(max_items=10)
|
||||
|
||||
# 手動で追加
|
||||
model.addTranslationHistory("chat", "カスタムメッセージ")
|
||||
```
|
||||
|
||||
## 連携方法（開発者向け）
|
||||
|
||||
既存のcontroller/model統合により、**自動で動作**します：
|
||||
|
||||
1. ユーザーがChat入力 → `controller.chatMessage()` → メッセージ処理完了後に `model.addTranslationHistory()` 呼び出し（翻訳の成功/失敗に関係なく）
|
||||
2. マイク音声 → `controller.micMessage()` → メッセージ処理完了後に `model.addTranslationHistory()` 呼び出し（翻訳の成功/失敗に関係なく）
|
||||
3. スピーカー受信 → `controller.speakerMessage()` → メッセージ処理完了後に `model.addTranslationHistory()` 呼び出し（翻訳の成功/失敗に関係なく）
|
||||
4. 翻訳実行 → `model.getTranslate()` → LLMクライアントへ履歴を自動注入 → `client.translate()` で履歴付きプロンプト生成
|
||||
|
||||
**重要**: 履歴にはオリジナルメッセージのみが保存されます。翻訳結果は履歴に含まれません。これによりトークン消費を抑え、文脈として必要な情報のみを提供します。
|
||||
|
||||
**追加実装は不要です。** YAML設定を変更するだけで履歴注入の有効/無効や範囲を制御できます。
|
||||
|
||||
## 連携方法
|
||||
|
||||
## 対応状況
|
||||
|
||||
✅ **全LLMクライアントに展開済み**
|
||||
|
||||
以下のすべてのクライアントで履歴注入機能が利用可能です：
|
||||
- OpenAI (`translation_openai.py` / `translation_openai.yml`)
|
||||
- Gemini (`translation_gemini.py` / `translation_gemini.yml`)
|
||||
- Groq (`translation_groq.py` / `translation_groq.yml`)
|
||||
- OpenRouter (`translation_openrouter.py` / `translation_openrouter.yml`)
|
||||
- LMStudio (`translation_lmstudio.py` / `translation_lmstudio.yml`)
|
||||
- Ollama (`translation_ollama.py` / `translation_ollama.yml`)
|
||||
- Plamo (`translation_plamo.py` / `translation_plamo.yml`)
|
||||
|
||||
各クライアントで同一の設定形式とAPIインターフェースを使用します：
|
||||
- `setContextHistory(history_items: list[dict])` メソッド
|
||||
- YAML の `history` セクション
|
||||
|
||||
## 今後の拡張案
|
||||
|
||||
- 実トークン見積りに基づく切り詰め（tiktoken 等）
|
||||
- 要約モデルを使った古い履歴の縮約
|
||||
@@ -12,6 +12,13 @@
|
||||
- Microsoft Translator（Bing）
|
||||
- Papago Translator
|
||||
- CTranslate2（ローカル翻訳）
|
||||
- Plamo API（プリファードネットワークス LLM）
|
||||
- Gemini API（Google LLM）
|
||||
- OpenAI API（ChatGPT系）
|
||||
- Groq API（高速 LLM 推論）
|
||||
- OpenRouter API（統合 LLM プロバイダー）
|
||||
- LMStudio（ローカル LLM）
|
||||
- Ollama（ローカル LLM）
|
||||
|
||||
### 統一インターフェース
|
||||
- エンジン依存を隠蔽した単一の翻訳メソッド
|
||||
@@ -405,41 +412,74 @@ root/
|
||||
- `model.py`: 翻訳機能統合
|
||||
- `controller.py`: 翻訳制御インターフェース
|
||||
|
||||
## 最近の更新 (2025-10-20)
|
||||
## 最近の更新
|
||||
|
||||
### 新規ローカル LLM エンジン追加
|
||||
### 2025-12-10: Groq API および OpenRouter API サポート追加
|
||||
|
||||
#### Groq API 統合
|
||||
- Groq API (`https://api.groq.com/openai/v1`) を翻訳エンジンとして追加
|
||||
- OpenAI 互換エンドポイントで高速 LLM 推論を実現
|
||||
- API キーバリデーション（`gsk` で始まり40文字以上）
|
||||
- モデルリスト自動取得とフィルタリング（テキスト処理モデルのみ）
|
||||
- 認証成功時に `SELECTABLE_GROQ_MODEL_LIST` を更新、未選択時は先頭モデルを自動選択
|
||||
- API キー無効時にモデルリストと選択モデルをクリアしフロントエンドに通知
|
||||
|
||||
#### OpenRouter API 統合
|
||||
- OpenRouter API (`https://openrouter.ai/api/v1`) を翻訳エンジンとして追加
|
||||
- 単一 API キーで複数 LLM プロバイダーへアクセス可能
|
||||
- API キーバリデーション（20文字以上）
|
||||
- モデルリスト自動取得とフィルタリング（テキスト処理モデルのみ）
|
||||
- 認証成功時に `SELECTABLE_OPENROUTER_MODEL_LIST` を更新、未選択時は先頭モデルを自動選択
|
||||
- API キー無効時にモデルリストと選択モデルをクリアしフロントエンドに通知
|
||||
|
||||
#### updateTranslationEngineAndEngineList() の拡張
|
||||
- `SELECTABLE_TRANSLATION_ENGINE_STATUS` で Groq_API と OpenRouter_API の状態を管理
|
||||
- 各エンジンの認証キー更新時に自動的にモデルリストを再取得
|
||||
- フロントエンドへの通知を `run_mapping` 経由で送信
|
||||
|
||||
#### 影響
|
||||
| 項目 | 内容 |
|
||||
|------|------|
|
||||
| Groq API | 高速 LLM 推論による翻訳速度向上 |
|
||||
| OpenRouter API | 単一キーで複数 LLM プロバイダーへアクセス |
|
||||
| モデル管理 | API キー検証失敗時の自動クリアで一貫性向上 |
|
||||
| UX改善 | 認証後の自動モデル選択で初期設定簡略化 |
|
||||
|
||||
### 2025-10-20: LLM エンジン拡張と最適化
|
||||
|
||||
#### 新規ローカル LLM エンジン追加
|
||||
|
||||
LMStudio / Ollama を翻訳エンジンとして追加。接続確認後にモデルリスト (`SELECTABLE_LMSTUDIO_MODEL_LIST` / `SELECTABLE_OLLAMA_MODEL_LIST`) を取得し、未選択なら先頭モデルを自動選択 (`SELECTED_LMSTUDIO_MODEL` / `SELECTED_OLLAMA_MODEL`)。現時点では CTranslate2 と同様にローカル動作を想定し、翻訳関数側は将来の統合（温度等パラメータ）に備えて抽象化維持。
|
||||
|
||||
### モデル選択プロパティ名称統一
|
||||
#### モデル選択プロパティ名称統一
|
||||
|
||||
Plamo / Gemini / OpenAI の選択モデルプロパティを `SELECTED_*` 形式へ変更。旧名称 (`PLAMO_MODEL` / `GEMINI_MODEL` / `OPENAI_MODEL`) は利用停止。自動認証後のモデルリスト更新ロジックで未選択時に先頭補完を行う。
|
||||
|
||||
### OpenAI / Gemini / Plamo 認証後のモデルリスト自動更新
|
||||
#### OpenAI / Gemini / Plamo 認証後のモデルリスト自動更新
|
||||
|
||||
Auth設定メソッド完了時に `SELECTABLE_*_MODEL_LIST` を再取得し不足時は UI へ push。OpenAI はキー設定直後に最新モデルリストを反映し高速化。Gemini / Plamo も同様に `updateTranslator*Client()` 呼び出しでクライアント再生成。
|
||||
|
||||
### CTranslate2 言語ネスト化対応
|
||||
#### CTranslate2 言語ネスト化対応
|
||||
|
||||
`translation_lang["CTranslate2"][weight_type]["source"|"target"]` へ構造変更。`CTRANSLATE2_WEIGHT_TYPE` により重みタイプ別の言語集合を参照。Translator 内では `translator_name == "CTranslate2"` の分岐で weight_type を参照して言語判定を行う実装に変更。
|
||||
|
||||
### YAML 言語マッピング導入
|
||||
#### YAML 言語マッピング導入
|
||||
|
||||
外部ファイル `languages.yml` を読み込んで翻訳エンジン別対応言語を動的拡張。新言語追加は YAML 編集のみで実現（コード再デプロイ不要）。読み込み失敗時は空辞書でフォールバックし既存ハードコードを保持。
|
||||
|
||||
### VRAM エラー検知とフォールバック
|
||||
#### VRAM エラー検知とフォールバック
|
||||
|
||||
DeepL / Plamo / Gemini / OpenAI 実行時の VRAM 不足検知で自動的に CTranslate2 へ切替し翻訳を停止 (`ENABLE_TRANSLATION=False`)。ユーザー通知後は再度有効化要求時に再初期化を試行。安定性向上のためログへ VRAM エラー詳細を記録。
|
||||
|
||||
### トークナイザーパス修正
|
||||
#### トークナイザーパス修正
|
||||
|
||||
CTranslate2 トークナイザーのダウンロード処理で保存ディレクトリ作成とパス使用順序不整合を修正。これにより初回起動時の失敗率低下。
|
||||
|
||||
### 全言語ペア包括テスト導入
|
||||
#### 全言語ペア包括テスト導入
|
||||
|
||||
`backend_test.py` にて `test_translate_all_language_pairs()` を追加。複数エンジン・全言語ペアを列挙実行し `translation_test_results.json` を生成。失敗ペアの早期検出と YAML 追加言語検証に活用。
|
||||
|
||||
### 影響
|
||||
#### 影響
|
||||
|
||||
| 項目 | 内容 |
|
||||
|------|------|
|
||||
|
||||
212
src-python/docs/error_handling_migration_guide.md
Normal file
212
src-python/docs/error_handling_migration_guide.md
Normal file
@@ -0,0 +1,212 @@
|
||||
# エラーハンドリング統一システム移行ガイド
|
||||
|
||||
## 概要
|
||||
|
||||
`errors.py`で定義された統一エラーシステムを使用して、すべてのエラーハンドリングを標準化しました。
|
||||
|
||||
## 変更パターン
|
||||
|
||||
### 1. 基本的なエラーレスポンス
|
||||
|
||||
#### 修正前:
|
||||
```python
|
||||
response = {
|
||||
"status": 400,
|
||||
"result": {
|
||||
"message": "Error message",
|
||||
"data": some_value
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 修正後:
|
||||
```python
|
||||
from errors import ErrorCode, VRCTError
|
||||
|
||||
response = VRCTError.create_error_response(
|
||||
ErrorCode.APPROPRIATE_ERROR_CODE,
|
||||
data=some_value
|
||||
)
|
||||
```
|
||||
|
||||
### 2. run_mapping経由のエラー通知
|
||||
|
||||
#### 修正前:
|
||||
```python
|
||||
self.run(
|
||||
400,
|
||||
self.run_mapping["error_device"],
|
||||
{
|
||||
"message": "No mic device detected",
|
||||
"data": None
|
||||
},
|
||||
)
|
||||
```
|
||||
|
||||
#### 修正後:
|
||||
```python
|
||||
error_response = VRCTError.create_error_response(
|
||||
ErrorCode.DEVICE_NO_MIC,
|
||||
data=None
|
||||
)
|
||||
self.run(
|
||||
error_response["status"],
|
||||
self.run_mapping["error_device"],
|
||||
error_response["result"],
|
||||
)
|
||||
```
|
||||
|
||||
### 3. 例外からのエラー生成
|
||||
|
||||
#### 修正前:
|
||||
```python
|
||||
except Exception as e:
|
||||
errorLogging()
|
||||
response = {
|
||||
"status": 400,
|
||||
"result": {
|
||||
"message": f"Error {e}",
|
||||
"data": original_value
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 修正後:
|
||||
```python
|
||||
except Exception as e:
|
||||
errorLogging()
|
||||
response = VRCTError.create_exception_error_response(
|
||||
e,
|
||||
data=original_value
|
||||
)
|
||||
```
|
||||
|
||||
## 既に移行済みの箇所
|
||||
|
||||
### デバイスエラー
|
||||
- ✅ `progressBarMicEnergy` - `ErrorCode.DEVICE_NO_MIC`
|
||||
- ✅ `progressBarSpeakerEnergy` - `ErrorCode.DEVICE_NO_SPEAKER`
|
||||
|
||||
### ウェイトダウンロードエラー
|
||||
- ✅ `DownloadCTranslate2.downloaded` - `ErrorCode.WEIGHT_CTRANSLATE2_DOWNLOAD`
|
||||
- ✅ `DownloadWhisper.downloaded` - `ErrorCode.WEIGHT_WHISPER_DOWNLOAD`
|
||||
|
||||
### 翻訳エラー
|
||||
- ✅ `micMessage` - `ErrorCode.TRANSLATION_ENGINE_LIMIT`, `ErrorCode.TRANSLATION_VRAM_MIC`, `ErrorCode.TRANSLATION_DISABLED_VRAM`
|
||||
- ✅ `speakerMessage` - `ErrorCode.TRANSLATION_ENGINE_LIMIT`, `ErrorCode.TRANSLATION_VRAM_SPEAKER`, `ErrorCode.TRANSLATION_DISABLED_VRAM`
|
||||
- ✅ `chatMessage` - `ErrorCode.TRANSLATION_ENGINE_LIMIT`, `ErrorCode.TRANSLATION_VRAM_CHAT`, `ErrorCode.TRANSLATION_DISABLED_VRAM`
|
||||
- ✅ `setEnableTranslation` - `ErrorCode.TRANSLATION_VRAM_ENABLE`, `ErrorCode.TRANSLATION_DISABLED_VRAM`
|
||||
|
||||
### バリデーションエラー
|
||||
- ✅ `setMicThreshold` - `ErrorCode.VALIDATION_MIC_THRESHOLD`
|
||||
- ✅ `setSpeakerThreshold` - `ErrorCode.VALIDATION_SPEAKER_THRESHOLD`
|
||||
- ✅ `setMicRecordTimeout` - `ErrorCode.VALIDATION_MIC_RECORD_TIMEOUT`
|
||||
- ✅ `setMicPhraseTimeout` - `ErrorCode.VALIDATION_MIC_PHRASE_TIMEOUT`
|
||||
- ✅ `setMicMaxPhrases` - `ErrorCode.VALIDATION_MIC_MAX_PHRASES`
|
||||
- ✅ `setSpeakerRecordTimeout` - `ErrorCode.VALIDATION_SPEAKER_RECORD_TIMEOUT`
|
||||
- ✅ `setSpeakerPhraseTimeout` - `ErrorCode.VALIDATION_SPEAKER_PHRASE_TIMEOUT`
|
||||
- ✅ `setSpeakerMaxPhrases` - `ErrorCode.VALIDATION_SPEAKER_MAX_PHRASES`
|
||||
- ✅ `setOscIpAddress` - `ErrorCode.VALIDATION_INVALID_IP`, `ErrorCode.VALIDATION_CANNOT_SET_IP`
|
||||
|
||||
### VRC連携エラー
|
||||
- ✅ `setEnableVrcMicMuteSync` - `ErrorCode.VRC_MIC_MUTE_SYNC_OSC_DISABLED`
|
||||
|
||||
### 認証エラー
|
||||
- ✅ `setDeeplAuthKey` - `ErrorCode.AUTH_DEEPL_LENGTH`, `ErrorCode.AUTH_DEEPL_FAILED`
|
||||
|
||||
## 未移行の箇所（要対応）
|
||||
|
||||
以下の箇所は同様のパターンで移行が必要です:
|
||||
|
||||
### 認証関連
|
||||
- ⬜ `setPlamoAuthKey` - `ErrorCode.AUTH_PLAMO_LENGTH`, `ErrorCode.AUTH_PLAMO_FAILED`
|
||||
- ⬜ `setPlamoModel` - `ErrorCode.MODEL_PLAMO_INVALID`
|
||||
- ⬜ `setGeminiAuthKey` - `ErrorCode.AUTH_GEMINI_LENGTH`, `ErrorCode.AUTH_GEMINI_FAILED`
|
||||
- ⬜ `setGeminiModel` - `ErrorCode.MODEL_GEMINI_INVALID`
|
||||
- ⬜ `setOpenAIAuthKey` - `ErrorCode.AUTH_OPENAI_INVALID`, `ErrorCode.AUTH_OPENAI_FAILED`
|
||||
- ⬜ `setOpenAIModel` - `ErrorCode.MODEL_OPENAI_INVALID`
|
||||
- ⬜ `setGroqAuthKey` - `ErrorCode.AUTH_GROQ_INVALID`, `ErrorCode.AUTH_GROQ_FAILED`
|
||||
- ⬜ `setGroqModel` - `ErrorCode.MODEL_GROQ_INVALID`
|
||||
- ⬜ `setOpenRouterAuthKey` - `ErrorCode.AUTH_OPENROUTER_INVALID`, `ErrorCode.AUTH_OPENROUTER_FAILED`
|
||||
- ⬜ `setOpenRouterModel` - `ErrorCode.MODEL_OPENROUTER_INVALID`
|
||||
|
||||
### 接続関連
|
||||
- ⬜ `checkTranslatorLMStudioConnection` - `ErrorCode.CONNECTION_LMSTUDIO_FAILED`
|
||||
- ⬜ `setTranslatorLMStudioURL` - `ErrorCode.CONNECTION_LMSTUDIO_URL_INVALID`
|
||||
- ⬜ `setTranslatorLMStudioModel` - `ErrorCode.MODEL_LMSTUDIO_INVALID`
|
||||
- ⬜ `checkTranslatorOllamaConnection` - `ErrorCode.CONNECTION_OLLAMA_FAILED`
|
||||
- ⬜ `setTranslatorOllamaModel` - `ErrorCode.MODEL_OLLAMA_INVALID`
|
||||
|
||||
### WebSocket関連
|
||||
- ⬜ `setWebSocketHost` - `ErrorCode.VALIDATION_INVALID_IP`, `ErrorCode.WEBSOCKET_HOST_INVALID`
|
||||
- ⬜ `setWebSocketPort` - `ErrorCode.WEBSOCKET_PORT_UNAVAILABLE`
|
||||
- ⬜ `setEnableWebSocketServer` - `ErrorCode.WEBSOCKET_SERVER_UNAVAILABLE`
|
||||
|
||||
### 音声認識VRAM関連
|
||||
- ⬜ `startTranscriptionSendMessage` - `ErrorCode.TRANSCRIPTION_VRAM_MIC`, `ErrorCode.TRANSCRIPTION_SEND_DISABLED_VRAM`
|
||||
- ⬜ `startTranscriptionReceiveMessage` - `ErrorCode.TRANSCRIPTION_VRAM_SPEAKER`, `ErrorCode.TRANSCRIPTION_RECEIVE_DISABLED_VRAM`
|
||||
|
||||
## エラーコードとエンドポイントの対応
|
||||
|
||||
`errors.py`の`ENDPOINT_ERROR_MAPPING`に、すべてのエンドポイントとエラーコードの対応が定義されています。
|
||||
UI開発者はこのマッピングを参照して、各エンドポイントがどのようなエラーを返すか確認できます。
|
||||
|
||||
## エラーレスポンスの構造
|
||||
|
||||
統一されたエラーレスポンスは以下の構造を持ちます:
|
||||
|
||||
```python
|
||||
{
|
||||
"status": 400, # HTTPステータスコード
|
||||
"result": {
|
||||
"error_code": "ERROR_CODE_CONSTANT", # エラーコード定数
|
||||
"message": "Human readable message", # 人間が読めるメッセージ
|
||||
"data": None or original_value, # エラー時に戻す値（通常は元の値）
|
||||
"details": {}, # 追加情報（オプション）
|
||||
"category": "category_name", # エラーカテゴリ
|
||||
"severity": "warning|error|critical", # 重要度
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## UI側での活用
|
||||
|
||||
UI側では`error_code`を使用して、エラーの種類を判定し、適切な処理を行うことができます:
|
||||
|
||||
```javascript
|
||||
if (response.status === 400) {
|
||||
const { error_code, message, data, severity } = response.result;
|
||||
|
||||
switch (error_code) {
|
||||
case "DEVICE_NO_MIC":
|
||||
// マイクデバイスエラーの処理
|
||||
break;
|
||||
case "VALIDATION_MIC_THRESHOLD":
|
||||
// バリデーションエラーの処理（元の値に戻す）
|
||||
setValue(data);
|
||||
break;
|
||||
// ...
|
||||
}
|
||||
|
||||
// 重要度に応じた表示
|
||||
if (severity === "critical") {
|
||||
showCriticalError(message);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 移行作業の進め方
|
||||
|
||||
1. **パターンの確認**: 上記の変更パターンを参照
|
||||
2. **エラーコードの特定**: `errors.py`から適切な`ErrorCode`を選択
|
||||
3. **コードの置き換え**: 古いエラーハンドリングを新しいシステムに置き換え
|
||||
4. **テスト**: エラーが正しく返されることを確認
|
||||
5. **チェックリストの更新**: このドキュメントの✅を更新
|
||||
|
||||
## 注意事項
|
||||
|
||||
- すべてのエラーは`errors.py`に定義されたエラーコードを使用すること
|
||||
- 新しいエラーが必要な場合は、まず`errors.py`に追加すること
|
||||
- エラーメッセージは`ERROR_METADATA`で定義されたデフォルトメッセージを使用すること
|
||||
- カスタムメッセージが必要な場合は`custom_message`パラメータを使用
|
||||
- `data`パラメータには、エラー時にUIが元の値に戻せるように、元の値を渡すこと
|
||||
@@ -17,6 +17,10 @@
|
||||
- `/run/enable_translation` - 翻訳機能の有効/無効状態
|
||||
- `/run/transcription_mic_message` - マイク音声認識結果
|
||||
- `/run/transcription_speaker_message` - スピーカー音声認識結果
|
||||
- `/run/selectable_groq_model_list` - 利用可能な Groq モデルリスト通知
|
||||
- `/run/selected_groq_model` - 選択中の Groq モデル通知
|
||||
- `/run/selectable_openrouter_model_list` - 利用可能な OpenRouter モデルリスト通知
|
||||
- `/run/selected_openrouter_model` - 選択中の OpenRouter モデル通知
|
||||
- `/run/error_*` - 各種エラー通知
|
||||
- `/run/initialization_complete` - 初期化完了通知
|
||||
|
||||
@@ -30,7 +34,20 @@
|
||||
**エンドポイント分類:**
|
||||
|
||||
- `/get/data/*` - 設定値の取得（初期化時に使用）
|
||||
- `/get/data/groq_auth_key` - Groq API キー取得
|
||||
- `/get/data/selectable_groq_model_list` - 利用可能な Groq モデルリスト取得
|
||||
- `/get/data/selected_groq_model` - 選択中の Groq モデル取得
|
||||
- `/get/data/openrouter_auth_key` - OpenRouter API キー取得
|
||||
- `/get/data/selectable_openrouter_model_list` - 利用可能な OpenRouter モデルリスト取得
|
||||
- `/get/data/selected_openrouter_model` - 選択中の OpenRouter モデル取得
|
||||
- `/set/data/*` - 設定値の更新
|
||||
- `/set/data/groq_auth_key` - Groq API キー設定
|
||||
- `/set/data/selected_groq_model` - Groq モデル選択
|
||||
- `/set/data/openrouter_auth_key` - OpenRouter API キー設定
|
||||
- `/set/data/selected_openrouter_model` - OpenRouter モデル選択
|
||||
- `/delete/data/*` - 設定値の削除
|
||||
- `/delete/data/groq_auth_key` - Groq API キー削除
|
||||
- `/delete/data/openrouter_auth_key` - OpenRouter API キー削除
|
||||
- `/set/enable/*` - 機能の有効化
|
||||
- `/set/disable/*` - 機能の無効化
|
||||
- `/run/*` - アクション実行（メッセージ送信、ダウンロード等）
|
||||
|
||||
@@ -215,6 +215,76 @@ CTranslate2 モデルがロード済みかチェック。
|
||||
|
||||
**戻り値:** 認証成功時 True
|
||||
|
||||
---
|
||||
|
||||
#### Groq API 統合
|
||||
|
||||
##### `authenticationTranslatorGroqAuthKey(auth_key: str) -> bool`
|
||||
|
||||
**責務:** Groq API キーの検証
|
||||
|
||||
**処理:** `translator.authenticationGroqAuthKey()` に委譲し、`root_path=config.PATH_LOCAL` を渡す
|
||||
|
||||
**戻り値:** 認証成功時 True
|
||||
|
||||
##### `getTranslatorGroqModelList() -> list[str]`
|
||||
|
||||
**責務:** 利用可能な Groq モデルリストの取得
|
||||
|
||||
**処理:** `translator.getGroqModelList()` に委譲
|
||||
|
||||
**戻り値:** モデル名のリスト（例: `["llama3-8b-8192", "mixtral-8x7b-32768"]`）
|
||||
|
||||
##### `setTranslatorGroqModel(model: str) -> bool`
|
||||
|
||||
**責務:** 使用する Groq モデルの設定
|
||||
|
||||
**処理:** `translator.setGroqModel(model)` に委譲
|
||||
|
||||
**戻り値:** 設定成功時 True（モデルが利用可能リストに含まれない場合 False）
|
||||
|
||||
##### `updateTranslatorGroqClient() -> None`
|
||||
|
||||
**責務:** Groq クライアントの更新（モデル変更後に呼び出し）
|
||||
|
||||
**処理:** `translator.updateGroqClient()` に委譲し、新しいモデルで LangChain `ChatOpenAI` インスタンスを再生成
|
||||
|
||||
---
|
||||
|
||||
#### OpenRouter API 統合
|
||||
|
||||
##### `authenticationTranslatorOpenRouterAuthKey(auth_key: str) -> bool`
|
||||
|
||||
**責務:** OpenRouter API キーの検証
|
||||
|
||||
**処理:** `translator.authenticationOpenRouterAuthKey()` に委譲し、`root_path=config.PATH_LOCAL` を渡す
|
||||
|
||||
**戻り値:** 認証成功時 True
|
||||
|
||||
##### `getTranslatorOpenRouterModelList() -> list[str]`
|
||||
|
||||
**責務:** 利用可能な OpenRouter モデルリストの取得
|
||||
|
||||
**処理:** `translator.getOpenRouterModelList()` に委譲
|
||||
|
||||
**戻り値:** モデル名のリスト（例: `["anthropic/claude-3-sonnet", "google/gemini-pro"]`）
|
||||
|
||||
##### `setTranslatorOpenRouterModel(model: str) -> bool`
|
||||
|
||||
**責務:** 使用する OpenRouter モデルの設定
|
||||
|
||||
**処理:** `translator.setOpenRouterModel(model)` に委譲
|
||||
|
||||
**戻り値:** 設定成功時 True（モデルが利用可能リストに含まれない場合 False）
|
||||
|
||||
##### `updateTranslatorOpenRouterClient() -> None`
|
||||
|
||||
**責務:** OpenRouter クライアントの更新（モデル変更後に呼び出し）
|
||||
|
||||
**処理:** `translator.updateOpenRouterClient()` に委譲し、新しいモデルで LangChain `ChatOpenAI` インスタンスを再生成
|
||||
|
||||
---
|
||||
|
||||
#### 翻訳実行
|
||||
|
||||
##### `getTranslate(translator_name, source_language, target_language, target_country, message) -> Tuple[str, bool]`
|
||||
|
||||
694
src-python/errors.py
Normal file
694
src-python/errors.py
Normal file
@@ -0,0 +1,694 @@
|
||||
# src-python/errors.py
|
||||
"""
|
||||
統一エラー管理システム
|
||||
|
||||
すべてのエラーを一元管理し、エンドポイントとエラーコードの対応を明確にする。
|
||||
"""
|
||||
|
||||
from typing import Any, Optional, Dict
|
||||
from enum import Enum
|
||||
|
||||
|
||||
class ErrorCode(str, Enum):
|
||||
"""エラーコード定数
|
||||
|
||||
命名規則: カテゴリ_具体的な内容
|
||||
"""
|
||||
# ============================================================================
|
||||
# デバイス関連エラー (DEVICE_*)
|
||||
# ============================================================================
|
||||
DEVICE_NO_MIC = "DEVICE_NO_MIC"
|
||||
DEVICE_NO_SPEAKER = "DEVICE_NO_SPEAKER"
|
||||
|
||||
# ============================================================================
|
||||
# 翻訳関連エラー (TRANSLATION_*)
|
||||
# ============================================================================
|
||||
TRANSLATION_ENGINE_LIMIT = "TRANSLATION_ENGINE_LIMIT"
|
||||
TRANSLATION_VRAM_CHAT = "TRANSLATION_VRAM_CHAT"
|
||||
TRANSLATION_VRAM_MIC = "TRANSLATION_VRAM_MIC"
|
||||
TRANSLATION_VRAM_SPEAKER = "TRANSLATION_VRAM_SPEAKER"
|
||||
TRANSLATION_VRAM_ENABLE = "TRANSLATION_VRAM_ENABLE"
|
||||
TRANSLATION_DISABLED_VRAM = "TRANSLATION_DISABLED_VRAM"
|
||||
|
||||
# ============================================================================
|
||||
# 音声認識関連エラー (TRANSCRIPTION_*)
|
||||
# ============================================================================
|
||||
TRANSCRIPTION_VRAM_MIC = "TRANSCRIPTION_VRAM_MIC"
|
||||
TRANSCRIPTION_VRAM_SPEAKER = "TRANSCRIPTION_VRAM_SPEAKER"
|
||||
TRANSCRIPTION_SEND_DISABLED_VRAM = "TRANSCRIPTION_SEND_DISABLED_VRAM"
|
||||
TRANSCRIPTION_RECEIVE_DISABLED_VRAM = "TRANSCRIPTION_RECEIVE_DISABLED_VRAM"
|
||||
|
||||
# ============================================================================
|
||||
# ウェイトダウンロード関連エラー (WEIGHT_*)
|
||||
# ============================================================================
|
||||
WEIGHT_CTRANSLATE2_DOWNLOAD = "WEIGHT_CTRANSLATE2_DOWNLOAD"
|
||||
WEIGHT_WHISPER_DOWNLOAD = "WEIGHT_WHISPER_DOWNLOAD"
|
||||
|
||||
# ============================================================================
|
||||
# バリデーションエラー (VALIDATION_*)
|
||||
# ============================================================================
|
||||
VALIDATION_MIC_THRESHOLD = "VALIDATION_MIC_THRESHOLD"
|
||||
VALIDATION_SPEAKER_THRESHOLD = "VALIDATION_SPEAKER_THRESHOLD"
|
||||
VALIDATION_MIC_RECORD_TIMEOUT = "VALIDATION_MIC_RECORD_TIMEOUT"
|
||||
VALIDATION_MIC_PHRASE_TIMEOUT = "VALIDATION_MIC_PHRASE_TIMEOUT"
|
||||
VALIDATION_MIC_MAX_PHRASES = "VALIDATION_MIC_MAX_PHRASES"
|
||||
VALIDATION_SPEAKER_RECORD_TIMEOUT = "VALIDATION_SPEAKER_RECORD_TIMEOUT"
|
||||
VALIDATION_SPEAKER_PHRASE_TIMEOUT = "VALIDATION_SPEAKER_PHRASE_TIMEOUT"
|
||||
VALIDATION_SPEAKER_MAX_PHRASES = "VALIDATION_SPEAKER_MAX_PHRASES"
|
||||
VALIDATION_INVALID_IP = "VALIDATION_INVALID_IP"
|
||||
VALIDATION_CANNOT_SET_IP = "VALIDATION_CANNOT_SET_IP"
|
||||
|
||||
# ============================================================================
|
||||
# 認証エラー (AUTH_*)
|
||||
# ============================================================================
|
||||
AUTH_DEEPL_LENGTH = "AUTH_DEEPL_LENGTH"
|
||||
AUTH_DEEPL_FAILED = "AUTH_DEEPL_FAILED"
|
||||
AUTH_PLAMO_LENGTH = "AUTH_PLAMO_LENGTH"
|
||||
AUTH_PLAMO_FAILED = "AUTH_PLAMO_FAILED"
|
||||
AUTH_GEMINI_LENGTH = "AUTH_GEMINI_LENGTH"
|
||||
AUTH_GEMINI_FAILED = "AUTH_GEMINI_FAILED"
|
||||
AUTH_OPENAI_INVALID = "AUTH_OPENAI_INVALID"
|
||||
AUTH_OPENAI_FAILED = "AUTH_OPENAI_FAILED"
|
||||
AUTH_GROQ_INVALID = "AUTH_GROQ_INVALID"
|
||||
AUTH_GROQ_FAILED = "AUTH_GROQ_FAILED"
|
||||
AUTH_OPENROUTER_INVALID = "AUTH_OPENROUTER_INVALID"
|
||||
AUTH_OPENROUTER_FAILED = "AUTH_OPENROUTER_FAILED"
|
||||
|
||||
# ============================================================================
|
||||
# モデル選択エラー (MODEL_*)
|
||||
# ============================================================================
|
||||
MODEL_PLAMO_INVALID = "MODEL_PLAMO_INVALID"
|
||||
MODEL_GEMINI_INVALID = "MODEL_GEMINI_INVALID"
|
||||
MODEL_OPENAI_INVALID = "MODEL_OPENAI_INVALID"
|
||||
MODEL_GROQ_INVALID = "MODEL_GROQ_INVALID"
|
||||
MODEL_OPENROUTER_INVALID = "MODEL_OPENROUTER_INVALID"
|
||||
MODEL_LMSTUDIO_INVALID = "MODEL_LMSTUDIO_INVALID"
|
||||
MODEL_OLLAMA_INVALID = "MODEL_OLLAMA_INVALID"
|
||||
|
||||
# ============================================================================
|
||||
# 接続エラー (CONNECTION_*)
|
||||
# ============================================================================
|
||||
CONNECTION_LMSTUDIO_FAILED = "CONNECTION_LMSTUDIO_FAILED"
|
||||
CONNECTION_OLLAMA_FAILED = "CONNECTION_OLLAMA_FAILED"
|
||||
CONNECTION_LMSTUDIO_URL_INVALID = "CONNECTION_LMSTUDIO_URL_INVALID"
|
||||
|
||||
# ============================================================================
|
||||
# WebSocketエラー (WEBSOCKET_*)
|
||||
# ============================================================================
|
||||
WEBSOCKET_HOST_INVALID = "WEBSOCKET_HOST_INVALID"
|
||||
WEBSOCKET_PORT_UNAVAILABLE = "WEBSOCKET_PORT_UNAVAILABLE"
|
||||
WEBSOCKET_SERVER_UNAVAILABLE = "WEBSOCKET_SERVER_UNAVAILABLE"
|
||||
|
||||
# ============================================================================
|
||||
# VRC連携エラー (VRC_*)
|
||||
# ============================================================================
|
||||
VRC_MIC_MUTE_SYNC_OSC_DISABLED = "VRC_MIC_MUTE_SYNC_OSC_DISABLED"
|
||||
|
||||
# ============================================================================
|
||||
# 汎用エラー (GENERAL_*)
|
||||
# ============================================================================
|
||||
GENERAL_EXCEPTION = "GENERAL_EXCEPTION"
|
||||
GENERAL_UNKNOWN = "GENERAL_UNKNOWN"
|
||||
|
||||
|
||||
class ErrorCategory(str, Enum):
|
||||
"""エラーカテゴリ"""
|
||||
DEVICE = "device"
|
||||
TRANSLATION = "translation"
|
||||
TRANSCRIPTION = "transcription"
|
||||
WEIGHT = "weight"
|
||||
VALIDATION = "validation"
|
||||
AUTH = "auth"
|
||||
MODEL = "model"
|
||||
CONNECTION = "connection"
|
||||
WEBSOCKET = "websocket"
|
||||
VRC = "vrc"
|
||||
GENERAL = "general"
|
||||
|
||||
|
||||
# エラーコードのメタデータ定義
|
||||
ERROR_METADATA: Dict[ErrorCode, Dict[str, Any]] = {
|
||||
# デバイスエラー
|
||||
ErrorCode.DEVICE_NO_MIC: {
|
||||
"category": ErrorCategory.DEVICE,
|
||||
"message": "No mic device detected",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.DEVICE_NO_SPEAKER: {
|
||||
"category": ErrorCategory.DEVICE,
|
||||
"message": "No speaker device detected",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# 翻訳エラー
|
||||
ErrorCode.TRANSLATION_ENGINE_LIMIT: {
|
||||
"category": ErrorCategory.TRANSLATION,
|
||||
"message": "Translation engine limit error",
|
||||
"severity": "warning",
|
||||
"user_action_required": False,
|
||||
"auto_fallback": True,
|
||||
},
|
||||
ErrorCode.TRANSLATION_VRAM_CHAT: {
|
||||
"category": ErrorCategory.TRANSLATION,
|
||||
"message": "VRAM out of memory during translation of chat",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.TRANSLATION_VRAM_MIC: {
|
||||
"category": ErrorCategory.TRANSLATION,
|
||||
"message": "VRAM out of memory during translation of mic",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.TRANSLATION_VRAM_SPEAKER: {
|
||||
"category": ErrorCategory.TRANSLATION,
|
||||
"message": "VRAM out of memory during translation of speaker",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.TRANSLATION_VRAM_ENABLE: {
|
||||
"category": ErrorCategory.TRANSLATION,
|
||||
"message": "VRAM out of memory enabling translation",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.TRANSLATION_DISABLED_VRAM: {
|
||||
"category": ErrorCategory.TRANSLATION,
|
||||
"message": "Translation disabled due to VRAM overflow",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# 音声認識エラー
|
||||
ErrorCode.TRANSCRIPTION_VRAM_MIC: {
|
||||
"category": ErrorCategory.TRANSCRIPTION,
|
||||
"message": "VRAM out of memory during mic transcription",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.TRANSCRIPTION_VRAM_SPEAKER: {
|
||||
"category": ErrorCategory.TRANSCRIPTION,
|
||||
"message": "VRAM out of memory during speaker transcription",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.TRANSCRIPTION_SEND_DISABLED_VRAM: {
|
||||
"category": ErrorCategory.TRANSCRIPTION,
|
||||
"message": "Transcription send disabled due to VRAM overflow",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.TRANSCRIPTION_RECEIVE_DISABLED_VRAM: {
|
||||
"category": ErrorCategory.TRANSCRIPTION,
|
||||
"message": "Transcription receive disabled due to VRAM overflow",
|
||||
"severity": "critical",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# ウェイトダウンロードエラー
|
||||
ErrorCode.WEIGHT_CTRANSLATE2_DOWNLOAD: {
|
||||
"category": ErrorCategory.WEIGHT,
|
||||
"message": "CTranslate2 weight download error",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.WEIGHT_WHISPER_DOWNLOAD: {
|
||||
"category": ErrorCategory.WEIGHT,
|
||||
"message": "Whisper weight download error",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# バリデーションエラー
|
||||
ErrorCode.VALIDATION_MIC_THRESHOLD: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Mic energy threshold value is out of range",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_SPEAKER_THRESHOLD: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Speaker energy threshold value is out of range",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_MIC_RECORD_TIMEOUT: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Mic record timeout value is out of range",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_MIC_PHRASE_TIMEOUT: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Mic phrase timeout value is out of range",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_MIC_MAX_PHRASES: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Mic max phrases value is out of range",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_SPEAKER_RECORD_TIMEOUT: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Speaker record timeout value is out of range",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_SPEAKER_PHRASE_TIMEOUT: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Speaker phrase timeout value is out of range",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_SPEAKER_MAX_PHRASES: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Speaker max phrases value is out of range",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_INVALID_IP: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Invalid IP address",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.VALIDATION_CANNOT_SET_IP: {
|
||||
"category": ErrorCategory.VALIDATION,
|
||||
"message": "Cannot set IP address",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# 認証エラー
|
||||
ErrorCode.AUTH_DEEPL_LENGTH: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "DeepL auth key length is not correct",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_DEEPL_FAILED: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Authentication failure of deepL auth key",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_PLAMO_LENGTH: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Plamo auth key length is not correct",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_PLAMO_FAILED: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Authentication failure of plamo auth key",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_GEMINI_LENGTH: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Gemini auth key length is not correct",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_GEMINI_FAILED: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Authentication failure of gemini auth key",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_OPENAI_INVALID: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "OpenAI auth key is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_OPENAI_FAILED: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Authentication failure of OpenAI auth key",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_GROQ_INVALID: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Groq auth key is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_GROQ_FAILED: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Authentication failure of Groq auth key",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_OPENROUTER_INVALID: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "OpenRouter auth key is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.AUTH_OPENROUTER_FAILED: {
|
||||
"category": ErrorCategory.AUTH,
|
||||
"message": "Authentication failure of OpenRouter auth key",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# モデル選択エラー
|
||||
ErrorCode.MODEL_PLAMO_INVALID: {
|
||||
"category": ErrorCategory.MODEL,
|
||||
"message": "Plamo model is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.MODEL_GEMINI_INVALID: {
|
||||
"category": ErrorCategory.MODEL,
|
||||
"message": "Gemini model is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.MODEL_OPENAI_INVALID: {
|
||||
"category": ErrorCategory.MODEL,
|
||||
"message": "OpenAI model is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.MODEL_GROQ_INVALID: {
|
||||
"category": ErrorCategory.MODEL,
|
||||
"message": "Groq model is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.MODEL_OPENROUTER_INVALID: {
|
||||
"category": ErrorCategory.MODEL,
|
||||
"message": "OpenRouter model is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.MODEL_LMSTUDIO_INVALID: {
|
||||
"category": ErrorCategory.MODEL,
|
||||
"message": "LMStudio model is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.MODEL_OLLAMA_INVALID: {
|
||||
"category": ErrorCategory.MODEL,
|
||||
"message": "ollama model is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# 接続エラー
|
||||
ErrorCode.CONNECTION_LMSTUDIO_FAILED: {
|
||||
"category": ErrorCategory.CONNECTION,
|
||||
"message": "Cannot connect to LMStudio server",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.CONNECTION_OLLAMA_FAILED: {
|
||||
"category": ErrorCategory.CONNECTION,
|
||||
"message": "Cannot connect to ollama server",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.CONNECTION_LMSTUDIO_URL_INVALID: {
|
||||
"category": ErrorCategory.CONNECTION,
|
||||
"message": "LMStudio URL is not valid",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# WebSocketエラー
|
||||
ErrorCode.WEBSOCKET_HOST_INVALID: {
|
||||
"category": ErrorCategory.WEBSOCKET,
|
||||
"message": "WebSocket server host is not available",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.WEBSOCKET_PORT_UNAVAILABLE: {
|
||||
"category": ErrorCategory.WEBSOCKET,
|
||||
"message": "WebSocket server port is not available",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
ErrorCode.WEBSOCKET_SERVER_UNAVAILABLE: {
|
||||
"category": ErrorCategory.WEBSOCKET,
|
||||
"message": "WebSocket server host or port is not available",
|
||||
"severity": "error",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# VRC連携エラー
|
||||
ErrorCode.VRC_MIC_MUTE_SYNC_OSC_DISABLED: {
|
||||
"category": ErrorCategory.VRC,
|
||||
"message": "Cannot enable VRC mic mute sync while OSC query is disabled",
|
||||
"severity": "warning",
|
||||
"user_action_required": True,
|
||||
},
|
||||
|
||||
# 汎用エラー
|
||||
ErrorCode.GENERAL_EXCEPTION: {
|
||||
"category": ErrorCategory.GENERAL,
|
||||
"message": "An error occurred",
|
||||
"severity": "error",
|
||||
"user_action_required": False,
|
||||
},
|
||||
ErrorCode.GENERAL_UNKNOWN: {
|
||||
"category": ErrorCategory.GENERAL,
|
||||
"message": "Unknown error",
|
||||
"severity": "error",
|
||||
"user_action_required": False,
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
class VRCTError:
|
||||
"""VRCTエラーハンドリングクラス"""
|
||||
|
||||
@staticmethod
|
||||
def create_error_response(
|
||||
error_code: ErrorCode,
|
||||
data: Any = None,
|
||||
details: Optional[Dict[str, Any]] = None,
|
||||
custom_message: Optional[str] = None
|
||||
) -> Dict[str, Any]:
|
||||
"""統一されたエラーレスポンスを生成
|
||||
|
||||
Args:
|
||||
error_code: エラーコード
|
||||
data: エラー時に戻す値（通常は元の値）
|
||||
details: 追加の詳細情報
|
||||
custom_message: カスタムメッセージ（指定しない場合はデフォルトメッセージ）
|
||||
|
||||
Returns:
|
||||
エラーレスポンス辞書
|
||||
"""
|
||||
metadata = ERROR_METADATA.get(error_code, ERROR_METADATA[ErrorCode.GENERAL_UNKNOWN])
|
||||
|
||||
return {
|
||||
"status": 400,
|
||||
"result": {
|
||||
"error_code": error_code.value,
|
||||
"message": custom_message or metadata["message"],
|
||||
"data": data,
|
||||
"details": details or {},
|
||||
"category": metadata["category"].value,
|
||||
"severity": metadata["severity"],
|
||||
}
|
||||
}
|
||||
|
||||
@staticmethod
|
||||
def create_exception_error_response(
|
||||
exception: Exception,
|
||||
data: Any = None,
|
||||
error_code: ErrorCode = ErrorCode.GENERAL_EXCEPTION
|
||||
) -> Dict[str, Any]:
|
||||
"""例外からエラーレスポンスを生成
|
||||
|
||||
Args:
|
||||
exception: 発生した例外
|
||||
data: エラー時に戻す値
|
||||
error_code: エラーコード
|
||||
|
||||
Returns:
|
||||
エラーレスポンス辞書
|
||||
"""
|
||||
return VRCTError.create_error_response(
|
||||
error_code=error_code,
|
||||
data=data,
|
||||
custom_message=f"Error: {str(exception)}",
|
||||
details={"exception_type": type(exception).__name__}
|
||||
)
|
||||
|
||||
|
||||
# エンドポイントとエラーコードのマッピング
|
||||
# UIがエラーハンドリングする際の参照として使用
|
||||
ENDPOINT_ERROR_MAPPING: Dict[str, Dict[str, ErrorCode]] = {
|
||||
# run_mapping経由のエラー通知
|
||||
"/run/error_device": {
|
||||
"NO_MIC": ErrorCode.DEVICE_NO_MIC,
|
||||
"NO_SPEAKER": ErrorCode.DEVICE_NO_SPEAKER,
|
||||
},
|
||||
"/run/error_translation_engine": {
|
||||
"LIMIT": ErrorCode.TRANSLATION_ENGINE_LIMIT,
|
||||
},
|
||||
"/run/error_translation_chat_vram_overflow": {
|
||||
"VRAM": ErrorCode.TRANSLATION_VRAM_CHAT,
|
||||
},
|
||||
"/run/error_translation_mic_vram_overflow": {
|
||||
"VRAM": ErrorCode.TRANSLATION_VRAM_MIC,
|
||||
},
|
||||
"/run/error_translation_speaker_vram_overflow": {
|
||||
"VRAM": ErrorCode.TRANSLATION_VRAM_SPEAKER,
|
||||
},
|
||||
"/run/error_transcription_mic_vram_overflow": {
|
||||
"VRAM": ErrorCode.TRANSCRIPTION_VRAM_MIC,
|
||||
},
|
||||
"/run/error_transcription_speaker_vram_overflow": {
|
||||
"VRAM": ErrorCode.TRANSCRIPTION_VRAM_SPEAKER,
|
||||
},
|
||||
"/run/error_ctranslate2_weight": {
|
||||
"DOWNLOAD": ErrorCode.WEIGHT_CTRANSLATE2_DOWNLOAD,
|
||||
},
|
||||
"/run/error_whisper_weight": {
|
||||
"DOWNLOAD": ErrorCode.WEIGHT_WHISPER_DOWNLOAD,
|
||||
},
|
||||
|
||||
# エンドポイント直接のエラーレスポンス
|
||||
"/set/data/mic_threshold": {
|
||||
"OUT_OF_RANGE": ErrorCode.VALIDATION_MIC_THRESHOLD,
|
||||
},
|
||||
"/set/data/speaker_threshold": {
|
||||
"OUT_OF_RANGE": ErrorCode.VALIDATION_SPEAKER_THRESHOLD,
|
||||
},
|
||||
"/set/data/mic_record_timeout": {
|
||||
"OUT_OF_RANGE": ErrorCode.VALIDATION_MIC_RECORD_TIMEOUT,
|
||||
},
|
||||
"/set/data/mic_phrase_timeout": {
|
||||
"OUT_OF_RANGE": ErrorCode.VALIDATION_MIC_PHRASE_TIMEOUT,
|
||||
},
|
||||
"/set/data/mic_max_phrases": {
|
||||
"OUT_OF_RANGE": ErrorCode.VALIDATION_MIC_MAX_PHRASES,
|
||||
},
|
||||
"/set/data/speaker_record_timeout": {
|
||||
"OUT_OF_RANGE": ErrorCode.VALIDATION_SPEAKER_RECORD_TIMEOUT,
|
||||
},
|
||||
"/set/data/speaker_phrase_timeout": {
|
||||
"OUT_OF_RANGE": ErrorCode.VALIDATION_SPEAKER_PHRASE_TIMEOUT,
|
||||
},
|
||||
"/set/data/speaker_max_phrases": {
|
||||
"OUT_OF_RANGE": ErrorCode.VALIDATION_SPEAKER_MAX_PHRASES,
|
||||
},
|
||||
"/set/data/osc_ip_address": {
|
||||
"INVALID": ErrorCode.VALIDATION_INVALID_IP,
|
||||
"CANNOT_SET": ErrorCode.VALIDATION_CANNOT_SET_IP,
|
||||
},
|
||||
"/set/data/deepl_auth_key": {
|
||||
"LENGTH": ErrorCode.AUTH_DEEPL_LENGTH,
|
||||
"FAILED": ErrorCode.AUTH_DEEPL_FAILED,
|
||||
},
|
||||
"/set/data/plamo_auth_key": {
|
||||
"LENGTH": ErrorCode.AUTH_PLAMO_LENGTH,
|
||||
"FAILED": ErrorCode.AUTH_PLAMO_FAILED,
|
||||
},
|
||||
"/set/data/selected_plamo_model": {
|
||||
"INVALID": ErrorCode.MODEL_PLAMO_INVALID,
|
||||
},
|
||||
"/set/data/gemini_auth_key": {
|
||||
"LENGTH": ErrorCode.AUTH_GEMINI_LENGTH,
|
||||
"FAILED": ErrorCode.AUTH_GEMINI_FAILED,
|
||||
},
|
||||
"/set/data/selected_gemini_model": {
|
||||
"INVALID": ErrorCode.MODEL_GEMINI_INVALID,
|
||||
},
|
||||
"/set/data/openai_auth_key": {
|
||||
"INVALID": ErrorCode.AUTH_OPENAI_INVALID,
|
||||
"FAILED": ErrorCode.AUTH_OPENAI_FAILED,
|
||||
},
|
||||
"/set/data/selected_openai_model": {
|
||||
"INVALID": ErrorCode.MODEL_OPENAI_INVALID,
|
||||
},
|
||||
"/set/data/groq_auth_key": {
|
||||
"INVALID": ErrorCode.AUTH_GROQ_INVALID,
|
||||
"FAILED": ErrorCode.AUTH_GROQ_FAILED,
|
||||
},
|
||||
"/set/data/selected_groq_model": {
|
||||
"INVALID": ErrorCode.MODEL_GROQ_INVALID,
|
||||
},
|
||||
"/set/data/openrouter_auth_key": {
|
||||
"INVALID": ErrorCode.AUTH_OPENROUTER_INVALID,
|
||||
"FAILED": ErrorCode.AUTH_OPENROUTER_FAILED,
|
||||
},
|
||||
"/set/data/selected_openrouter_model": {
|
||||
"INVALID": ErrorCode.MODEL_OPENROUTER_INVALID,
|
||||
},
|
||||
"/run/lmstudio_connection": {
|
||||
"FAILED": ErrorCode.CONNECTION_LMSTUDIO_FAILED,
|
||||
},
|
||||
"/set/data/lmstudio_url": {
|
||||
"INVALID": ErrorCode.CONNECTION_LMSTUDIO_URL_INVALID,
|
||||
},
|
||||
"/set/data/selected_lmstudio_model": {
|
||||
"INVALID": ErrorCode.MODEL_LMSTUDIO_INVALID,
|
||||
},
|
||||
"/run/ollama_connection": {
|
||||
"FAILED": ErrorCode.CONNECTION_OLLAMA_FAILED,
|
||||
},
|
||||
"/set/data/selected_ollama_model": {
|
||||
"INVALID": ErrorCode.MODEL_OLLAMA_INVALID,
|
||||
},
|
||||
"/set/data/websocket_host": {
|
||||
"INVALID_IP": ErrorCode.VALIDATION_INVALID_IP,
|
||||
"UNAVAILABLE": ErrorCode.WEBSOCKET_HOST_INVALID,
|
||||
},
|
||||
"/set/data/websocket_port": {
|
||||
"UNAVAILABLE": ErrorCode.WEBSOCKET_PORT_UNAVAILABLE,
|
||||
},
|
||||
"/set/enable/websocket_server": {
|
||||
"UNAVAILABLE": ErrorCode.WEBSOCKET_SERVER_UNAVAILABLE,
|
||||
},
|
||||
"/set/enable/vrc_mic_mute_sync": {
|
||||
"OSC_DISABLED": ErrorCode.VRC_MIC_MUTE_SYNC_OSC_DISABLED,
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def get_error_metadata(error_code: ErrorCode) -> Dict[str, Any]:
|
||||
"""エラーコードのメタデータを取得
|
||||
|
||||
Args:
|
||||
error_code: エラーコード
|
||||
|
||||
Returns:
|
||||
メタデータ辞書
|
||||
"""
|
||||
return ERROR_METADATA.get(error_code, ERROR_METADATA[ErrorCode.GENERAL_UNKNOWN])
|
||||
|
||||
|
||||
def is_critical_error(error_code: ErrorCode) -> bool:
|
||||
"""クリティカルエラーかどうかを判定
|
||||
|
||||
Args:
|
||||
error_code: エラーコード
|
||||
|
||||
Returns:
|
||||
クリティカルエラーの場合True
|
||||
"""
|
||||
metadata = get_error_metadata(error_code)
|
||||
return metadata.get("severity") == "critical"
|
||||
|
||||
|
||||
def requires_user_action(error_code: ErrorCode) -> bool:
|
||||
"""ユーザーアクションが必要なエラーかどうかを判定
|
||||
|
||||
Args:
|
||||
error_code: エラーコード
|
||||
|
||||
Returns:
|
||||
ユーザーアクションが必要な場合True
|
||||
"""
|
||||
metadata = get_error_metadata(error_code)
|
||||
return metadata.get("user_action_required", False)
|
||||
@@ -58,6 +58,10 @@ run_mapping = {
|
||||
"selected_gemini_model":"/run/selected_gemini_model",
|
||||
"selectable_openai_model_list":"/run/selectable_openai_model_list",
|
||||
"selected_openai_model":"/run/selected_openai_model",
|
||||
"selectable_groq_model_list":"/run/selectable_groq_model_list",
|
||||
"selected_groq_model":"/run/selected_groq_model",
|
||||
"selectable_openrouter_model_list":"/run/selectable_openrouter_model_list",
|
||||
"selected_openrouter_model":"/run/selected_openrouter_model",
|
||||
"selectable_lmstudio_model_list":"/run/selectable_lmstudio_model_list",
|
||||
"selected_lmstudio_model":"/run/selected_lmstudio_model",
|
||||
"selectable_ollama_model_list":"/run/selectable_ollama_model_list",
|
||||
@@ -207,6 +211,21 @@ mapping = {
|
||||
"/set/data/openai_auth_key": {"status": True, "variable":controller.setOpenAIAuthKey},
|
||||
"/delete/data/openai_auth_key": {"status": True, "variable":controller.delOpenAIAuthKey},
|
||||
|
||||
"/get/data/selectable_groq_model_list": {"status": True, "variable":controller.getGroqModelList},
|
||||
"/get/data/selected_groq_model": {"status": True, "variable":controller.getGroqModel},
|
||||
"/set/data/selected_groq_model": {"status": True, "variable":controller.setGroqModel},
|
||||
"/get/data/groq_auth_key": {"status": True, "variable":controller.getGroqAuthKey},
|
||||
"/set/data/groq_auth_key": {"status": True, "variable":controller.setGroqAuthKey},
|
||||
"/delete/data/groq_auth_key": {"status": True, "variable":controller.delGroqAuthKey},
|
||||
|
||||
"/get/data/selectable_openrouter_model_list": {"status": True, "variable":controller.getOpenRouterModelList},
|
||||
"/get/data/selected_openrouter_model": {"status": True, "variable":controller.getOpenRouterModel},
|
||||
"/set/data/selected_openrouter_model": {"status": True, "variable":controller.setOpenRouterModel},
|
||||
"/get/data/openrouter_auth_key": {"status": True, "variable":controller.getOpenRouterAuthKey},
|
||||
"/set/data/openrouter_auth_key": {"status": True, "variable":controller.setOpenRouterAuthKey},
|
||||
"/delete/data/openrouter_auth_key": {"status": True, "variable":controller.delOpenRouterAuthKey},
|
||||
|
||||
"/get/data/connected_lmstudio": {"status": True, "variable":controller.getTranslatorLMStudioConnection},
|
||||
"/run/lmstudio_connection": {"status": True, "variable":controller.checkTranslatorLMStudioConnection},
|
||||
"/get/data/selectable_lmstudio_model_list": {"status": True, "variable":controller.getTranslatorLStudioModelList},
|
||||
"/get/data/selected_lmstudio_model": {"status": True, "variable":controller.getTranslatorLMStudioModel},
|
||||
@@ -214,6 +233,7 @@ mapping = {
|
||||
"/get/data/lmstudio_url": {"status": True, "variable":controller.getTranslatorLMStudioURL},
|
||||
"/set/data/lmstudio_url": {"status": True, "variable":controller.setTranslatorLMStudioURL},
|
||||
|
||||
"/get/data/connected_ollama": {"status": True, "variable":controller.getTranslatorOllamaConnection},
|
||||
"/run/ollama_connection": {"status": True, "variable":controller.checkTranslatorOllamaConnection},
|
||||
"/get/data/selectable_ollama_model_list": {"status": True, "variable":controller.getTranslatorOllamaModelList},
|
||||
"/get/data/selected_ollama_model": {"status": True, "variable":controller.getTranslatorOllamaModel},
|
||||
|
||||
@@ -118,6 +118,8 @@ class Model:
|
||||
self.previous_receive_message = ""
|
||||
self.translator = Translator()
|
||||
self.keyword_processor = KeywordProcessor()
|
||||
self.translation_history: list[dict] = []
|
||||
self.translation_history_max_items = 20
|
||||
overlay_small_log_settings = copy.deepcopy(config.OVERLAY_SMALL_LOG_SETTINGS)
|
||||
overlay_large_log_settings = copy.deepcopy(config.OVERLAY_LARGE_LOG_SETTINGS)
|
||||
overlay_large_log_settings["ui_scaling"] = overlay_large_log_settings["ui_scaling"] * 0.25
|
||||
@@ -251,6 +253,44 @@ class Model:
|
||||
self.ensure_initialized()
|
||||
self.translator.updateOpenAIClient()
|
||||
|
||||
def authenticationTranslatorGroqAuthKey(self, auth_key: str) -> bool:
|
||||
result = self.translator.authenticationGroqAuthKey(auth_key, root_path=config.PATH_LOCAL)
|
||||
return result
|
||||
|
||||
def getTranslatorGroqModelList(self) -> list[str]:
|
||||
self.ensure_initialized()
|
||||
return self.translator.getGroqModelList()
|
||||
|
||||
def setTranslatorGroqModel(self, model: str) -> bool:
|
||||
self.ensure_initialized()
|
||||
result = self.translator.setGroqModel(model=model)
|
||||
return result
|
||||
|
||||
def updateTranslatorGroqClient(self) -> None:
|
||||
self.ensure_initialized()
|
||||
self.translator.updateGroqClient()
|
||||
|
||||
def authenticationTranslatorOpenRouterAuthKey(self, auth_key: str) -> bool:
|
||||
result = self.translator.authenticationOpenRouterAuthKey(auth_key, root_path=config.PATH_LOCAL)
|
||||
return result
|
||||
|
||||
def getTranslatorOpenRouterModelList(self) -> list[str]:
|
||||
self.ensure_initialized()
|
||||
return self.translator.getOpenRouterModelList()
|
||||
|
||||
def setTranslatorOpenRouterModel(self, model: str) -> bool:
|
||||
self.ensure_initialized()
|
||||
result = self.translator.setOpenRouterModel(model=model)
|
||||
return result
|
||||
|
||||
def updateTranslatorOpenRouterClient(self) -> None:
|
||||
self.ensure_initialized()
|
||||
self.translator.updateOpenRouterClient()
|
||||
|
||||
def getTranslatorLMStudioConnected(self) -> bool:
|
||||
self.ensure_initialized()
|
||||
return self.translator.getLMStudioConnected()
|
||||
|
||||
def authenticationTranslatorLMStudio(self, base_url: str) -> bool:
|
||||
result = self.translator.setLMStudioClientURL(base_url=base_url, root_path=config.PATH_LOCAL)
|
||||
return result
|
||||
@@ -267,6 +307,10 @@ class Model:
|
||||
self.ensure_initialized()
|
||||
self.translator.updateLMStudioClient()
|
||||
|
||||
def getTranslatorOllamaConnected(self) -> bool:
|
||||
self.ensure_initialized()
|
||||
return self.translator.getOllamaConnected()
|
||||
|
||||
def authenticationTranslatorOllama(self) -> bool:
|
||||
result = self.translator.checkOllamaClient(root_path=config.PATH_LOCAL)
|
||||
return result
|
||||
@@ -338,16 +382,62 @@ class Model:
|
||||
|
||||
return compatible_engines
|
||||
|
||||
def addTranslationHistory(self, source: str, text: str) -> None:
|
||||
"""Add a message to translation context history.
|
||||
|
||||
Args:
|
||||
source: "chat" | "mic" | "speaker"
|
||||
text: message content
|
||||
"""
|
||||
self.ensure_initialized()
|
||||
if not text or not text.strip():
|
||||
return
|
||||
|
||||
history_item = {
|
||||
"source": source,
|
||||
"text": text.strip(),
|
||||
"timestamp": datetime.now().isoformat(),
|
||||
}
|
||||
self.translation_history.append(history_item)
|
||||
|
||||
# 最大件数を超えた場合は古いものを削除
|
||||
if len(self.translation_history) > self.translation_history_max_items:
|
||||
self.translation_history = self.translation_history[-self.translation_history_max_items:]
|
||||
|
||||
def getTranslationHistory(self, max_items: int = None) -> list[dict]:
|
||||
"""Get recent translation context history.
|
||||
|
||||
Args:
|
||||
max_items: Maximum number of items to return (newest first)
|
||||
|
||||
Returns:
|
||||
List of history items
|
||||
"""
|
||||
self.ensure_initialized()
|
||||
if max_items is None or max_items <= 0:
|
||||
return self.translation_history
|
||||
return self.translation_history[-max_items:]
|
||||
|
||||
def clearTranslationHistory(self) -> None:
|
||||
"""Clear all translation context history."""
|
||||
self.ensure_initialized()
|
||||
self.translation_history = []
|
||||
|
||||
def getTranslate(self, translator_name, source_language, target_language, target_country, message):
|
||||
self.ensure_initialized()
|
||||
success_flag = False
|
||||
|
||||
# Get context history for LLM-based translators
|
||||
history = self.getTranslationHistory()
|
||||
|
||||
translation = self.translator.translate(
|
||||
translator_name=translator_name,
|
||||
weight_type=config.CTRANSLATE2_WEIGHT_TYPE,
|
||||
source_language=source_language,
|
||||
target_language=target_language,
|
||||
target_country=target_country,
|
||||
message=message
|
||||
message=message,
|
||||
context_history=history
|
||||
)
|
||||
|
||||
# 翻訳失敗時のフェールセーフ処理
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
@@ -1,7 +0,0 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
@@ -1,7 +0,0 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
@@ -1,7 +0,0 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
@@ -4,14 +4,14 @@ from langchain_google_genai import ChatGoogleGenerativeAI
|
||||
|
||||
try:
|
||||
from .translation_languages import translation_lang
|
||||
from .translation_utils import loadPromptConfig
|
||||
from .translation_utils import loadTranslatePromptConfig
|
||||
except Exception:
|
||||
import sys
|
||||
from os import path as os_path
|
||||
print(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
sys.path.append(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
from translation_languages import translation_lang
|
||||
from translation_utils import loadPromptConfig
|
||||
from translation_utils import loadTranslatePromptConfig
|
||||
|
||||
logger = logging.getLogger("langchain_google_genai")
|
||||
logger.setLevel(logging.ERROR)
|
||||
@@ -57,9 +57,19 @@ class GeminiClient:
|
||||
self.model = None
|
||||
|
||||
# プロンプト設定をYAMLファイルから読み込む
|
||||
prompt_config = loadPromptConfig(root_path, "translation_gemini.yml")
|
||||
prompt_config = loadTranslatePromptConfig(root_path, "translation_gemini.yml")
|
||||
self.supported_languages = list(translation_lang["Gemini_API"]["source"].keys())
|
||||
self.prompt_template = prompt_config["system_prompt"]
|
||||
# history config (optional)
|
||||
self.history_cfg = prompt_config.get("history", {
|
||||
"use_history": False,
|
||||
"sources": [],
|
||||
"max_messages": 0,
|
||||
"max_chars": 0,
|
||||
"header_template": "",
|
||||
"item_template": "[{source}] {role}: {text}",
|
||||
})
|
||||
self._context_history: list[dict] = []
|
||||
|
||||
self.gemini_llm = None
|
||||
|
||||
@@ -91,6 +101,16 @@ class GeminiClient:
|
||||
api_key=self.api_key,
|
||||
)
|
||||
|
||||
def setContextHistory(self, history_items: list[dict]) -> None:
|
||||
"""Set recent conversation history for prompt injection.
|
||||
|
||||
Each item should be a dict containing:
|
||||
- source: "chat" | "mic" | "speaker"
|
||||
- text: message string
|
||||
- timestamp: ISO format datetime string
|
||||
"""
|
||||
self._context_history = history_items or []
|
||||
|
||||
def translate(self, text: str, input_lang: str, output_lang: str) -> str:
|
||||
system_prompt = self.prompt_template.format(
|
||||
supported_languages=self.supported_languages,
|
||||
@@ -98,6 +118,41 @@ class GeminiClient:
|
||||
output_lang=output_lang
|
||||
)
|
||||
|
||||
# Inject recent conversation history if enabled by YAML config
|
||||
if self.history_cfg.get("use_history"):
|
||||
allowed_sources = set(self.history_cfg.get("sources", []))
|
||||
max_messages = int(self.history_cfg.get("max_messages", 0))
|
||||
max_chars = int(self.history_cfg.get("max_chars", 0))
|
||||
item_tmpl = self.history_cfg.get("item_template", "[{source}] {role}: {text}")
|
||||
header_tmpl = self.history_cfg.get("header_template", "{history}")
|
||||
|
||||
filtered = [h for h in self._context_history if h.get("source") in allowed_sources]
|
||||
recent = filtered[-max_messages:] if max_messages > 0 else filtered
|
||||
formatted_items = []
|
||||
for h in recent:
|
||||
# Format timestamp as HH:MM to save tokens
|
||||
timestamp_str = ''
|
||||
if 'timestamp' in h:
|
||||
from datetime import datetime
|
||||
try:
|
||||
ts = datetime.fromisoformat(h['timestamp'])
|
||||
timestamp_str = ts.strftime('%H:%M')
|
||||
except:
|
||||
timestamp_str = ''
|
||||
formatted_items.append(
|
||||
item_tmpl.format(
|
||||
timestamp=timestamp_str,
|
||||
source=h.get("source", ""),
|
||||
text=h.get("text", ""),
|
||||
)
|
||||
)
|
||||
history_blob = "\n".join(formatted_items).strip()
|
||||
if max_chars and len(history_blob) > max_chars:
|
||||
history_blob = history_blob[-max_chars:]
|
||||
history_header = header_tmpl.format(max_messages=max_messages, history=history_blob)
|
||||
if history_header:
|
||||
system_prompt = f"{system_prompt}\n\n{history_header}"
|
||||
|
||||
messages = [
|
||||
{"role": "system", "content": system_prompt},
|
||||
{"role": "user", "content": text}
|
||||
|
||||
201
src-python/models/translation/translation_groq.py
Normal file
201
src-python/models/translation/translation_groq.py
Normal file
@@ -0,0 +1,201 @@
|
||||
from openai import OpenAI
|
||||
from langchain_openai import ChatOpenAI
|
||||
from pydantic import SecretStr
|
||||
|
||||
try:
|
||||
from .translation_languages import translation_lang
|
||||
from .translation_utils import loadTranslatePromptConfig
|
||||
except Exception:
|
||||
import sys
|
||||
from os import path as os_path
|
||||
sys.path.append(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
from translation_languages import translation_lang, loadTranslationLanguages
|
||||
from translation_utils import loadTranslatePromptConfig
|
||||
translation_lang = loadTranslationLanguages(path=".", force=True)
|
||||
|
||||
def _authentication_check(api_key: str) -> bool:
|
||||
"""Check if the provided API key is valid by attempting to list models.
|
||||
"""
|
||||
try:
|
||||
client = OpenAI(
|
||||
api_key=api_key,
|
||||
base_url="https://api.groq.com/openai/v1",
|
||||
)
|
||||
client.models.list()
|
||||
return True
|
||||
except Exception:
|
||||
return False
|
||||
|
||||
def _get_available_text_models(api_key: str) -> list[str]:
|
||||
"""Extract only Groq models suitable for translation and chat applications.
|
||||
"""
|
||||
client = OpenAI(
|
||||
api_key=api_key,
|
||||
base_url="https://api.groq.com/openai/v1",
|
||||
)
|
||||
res = client.models.list()
|
||||
allowed_models = []
|
||||
|
||||
for model in res.data:
|
||||
model_id = model.id
|
||||
|
||||
# 除外対象のキーワード
|
||||
exclude_keywords = [
|
||||
"whisper", # 音声認識
|
||||
"embedding", # 埋め込み
|
||||
"image", # 画像生成
|
||||
"tts", # 音声合成
|
||||
"audio", # 音声系
|
||||
"search", # 検索補助モデル
|
||||
"transcribe", # 音声→文字起こし
|
||||
"diarize", # 話者分離
|
||||
"vision" # 画像入力系
|
||||
]
|
||||
|
||||
# 除外キーワードが含まれているモデルをスキップ
|
||||
if any(kw in model_id.lower() for kw in exclude_keywords):
|
||||
continue
|
||||
|
||||
# テキスト処理用モデルのみ対象
|
||||
allowed_models.append(model_id)
|
||||
|
||||
allowed_models.sort()
|
||||
return allowed_models
|
||||
|
||||
class GroqClient:
|
||||
"""Groq API Translation wrapper using OpenAI-compatible endpoint.
|
||||
|
||||
Groq provides a fast LLM inference platform with an OpenAI-compatible API.
|
||||
The API endpoint: https://api.groq.com/openai/v1
|
||||
"""
|
||||
def __init__(self, root_path: str = None):
|
||||
self.api_key = None
|
||||
self.model = None
|
||||
self.base_url = "https://api.groq.com/openai/v1"
|
||||
|
||||
prompt_config = loadTranslatePromptConfig(root_path, "translation_groq.yml")
|
||||
self.supported_languages = list(translation_lang["Groq_API"]["source"].keys())
|
||||
self.prompt_template = prompt_config["system_prompt"]
|
||||
# history config (optional)
|
||||
self.history_cfg = prompt_config.get("history", {
|
||||
"use_history": False,
|
||||
"sources": [],
|
||||
"max_messages": 0,
|
||||
"max_chars": 0,
|
||||
"header_template": "",
|
||||
"item_template": "[{source}] {role}: {text}",
|
||||
})
|
||||
self._context_history: list[dict] = []
|
||||
|
||||
self.groq_llm = None
|
||||
|
||||
def getModelList(self) -> list[str]:
|
||||
return _get_available_text_models(self.api_key) if self.api_key else []
|
||||
|
||||
def getAuthKey(self) -> str:
|
||||
return self.api_key
|
||||
|
||||
def setAuthKey(self, api_key: str) -> bool:
|
||||
result = _authentication_check(api_key)
|
||||
if result:
|
||||
self.api_key = api_key
|
||||
return result
|
||||
|
||||
def getModel(self) -> str:
|
||||
return self.model
|
||||
|
||||
def setModel(self, model: str) -> bool:
|
||||
if model in self.getModelList():
|
||||
self.model = model
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
def updateClient(self) -> None:
|
||||
self.groq_llm = ChatOpenAI(
|
||||
base_url=self.base_url,
|
||||
model=self.model,
|
||||
api_key=SecretStr(self.api_key),
|
||||
streaming=False,
|
||||
)
|
||||
|
||||
def setContextHistory(self, history_items: list[dict]) -> None:
|
||||
"""Set recent conversation history for prompt injection.
|
||||
|
||||
Each item should be a dict containing:
|
||||
- source: "chat" | "mic" | "speaker"
|
||||
- text: message string
|
||||
- timestamp: ISO format datetime string
|
||||
"""
|
||||
self._context_history = history_items or []
|
||||
|
||||
def translate(self, text: str, input_lang: str, output_lang: str) -> str:
|
||||
system_prompt = self.prompt_template.format(
|
||||
supported_languages=self.supported_languages,
|
||||
input_lang=input_lang,
|
||||
output_lang=output_lang,
|
||||
)
|
||||
|
||||
# Inject recent conversation history if enabled by YAML config
|
||||
if self.history_cfg.get("use_history"):
|
||||
allowed_sources = set(self.history_cfg.get("sources", []))
|
||||
max_messages = int(self.history_cfg.get("max_messages", 0))
|
||||
max_chars = int(self.history_cfg.get("max_chars", 0))
|
||||
item_tmpl = self.history_cfg.get("item_template", "[{source}] {role}: {text}")
|
||||
header_tmpl = self.history_cfg.get("header_template", "{history}")
|
||||
|
||||
filtered = [h for h in self._context_history if h.get("source") in allowed_sources]
|
||||
recent = filtered[-max_messages:] if max_messages > 0 else filtered
|
||||
formatted_items = []
|
||||
for h in recent:
|
||||
# Format timestamp as HH:MM to save tokens
|
||||
timestamp_str = ''
|
||||
if 'timestamp' in h:
|
||||
from datetime import datetime
|
||||
try:
|
||||
ts = datetime.fromisoformat(h['timestamp'])
|
||||
timestamp_str = ts.strftime('%H:%M')
|
||||
except:
|
||||
timestamp_str = ''
|
||||
formatted_items.append(
|
||||
item_tmpl.format(
|
||||
timestamp=timestamp_str,
|
||||
source=h.get("source", ""),
|
||||
text=h.get("text", ""),
|
||||
)
|
||||
)
|
||||
history_blob = "\n".join(formatted_items).strip()
|
||||
if max_chars and len(history_blob) > max_chars:
|
||||
history_blob = history_blob[-max_chars:]
|
||||
history_header = header_tmpl.format(max_messages=max_messages, history=history_blob)
|
||||
if history_header:
|
||||
system_prompt = f"{system_prompt}\n\n{history_header}"
|
||||
|
||||
messages = [
|
||||
{"role": "system", "content": system_prompt},
|
||||
{"role": "user", "content": text},
|
||||
]
|
||||
|
||||
resp = self.groq_llm.invoke(messages)
|
||||
content = ""
|
||||
if isinstance(resp.content, str):
|
||||
content = resp.content
|
||||
elif isinstance(resp.content, list):
|
||||
for part in resp.content:
|
||||
if isinstance(part, str):
|
||||
content += part
|
||||
elif isinstance(part, dict) and "content" in part and isinstance(part["content"], str):
|
||||
content += part["content"]
|
||||
return content.strip()
|
||||
|
||||
if __name__ == "__main__":
|
||||
AUTH_KEY = "GROQ_API_KEY"
|
||||
client = GroqClient()
|
||||
client.setAuthKey(AUTH_KEY)
|
||||
models = client.getModelList()
|
||||
if models:
|
||||
print("Available models:", models)
|
||||
model = input("Select a model: ")
|
||||
client.setModel(model)
|
||||
client.updateClient()
|
||||
print(client.translate("こんにちは世界", "Japanese", "English"))
|
||||
@@ -41,14 +41,14 @@ def _load_languages(path: str, filename: str) -> str:
|
||||
Returns:
|
||||
Absolute path to the resource file
|
||||
"""
|
||||
if os.path.exists(os.path.join(path, "_internal", "languages", "languages.yml")):
|
||||
languages_path = os.path.join(path, "_internal", "languages", "languages.yml")
|
||||
elif os.path.exists(os.path.join(os.path.dirname(os.path.abspath(__file__)), "models", "translation", "languages", "languages.yml")):
|
||||
languages_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "models", "translation", "languages", "languages.yml")
|
||||
elif os.path.exists(os.path.join(os.path.dirname(os.path.abspath(__file__)), "languages", "languages.yml")):
|
||||
languages_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "languages", "languages.yml")
|
||||
if os.path.exists(os.path.join(path, "_internal", "translation_settings", "languages", filename)):
|
||||
languages_path = os.path.join(path, "_internal", "translation_settings", "languages", filename)
|
||||
elif os.path.exists(os.path.join(os.path.dirname(os.path.abspath(__file__)), "models", "translation", "translation_settings", "languages", filename)):
|
||||
languages_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "models", "translation", "translation_settings", "languages", filename)
|
||||
elif os.path.exists(os.path.join(os.path.dirname(os.path.abspath(__file__)), "translation_settings", "languages", filename)):
|
||||
languages_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "translation_settings", "languages", filename)
|
||||
else:
|
||||
raise FileNotFoundError(f"Prompt file not found: {filename}")
|
||||
raise FileNotFoundError(f"Languages file not found: {filename}")
|
||||
with open(languages_path, "r", encoding="utf-8") as f:
|
||||
return yaml.safe_load(f)
|
||||
|
||||
@@ -99,7 +99,7 @@ def loadTranslationLanguages(path: str, force: bool = False) -> Dict[str, Any]:
|
||||
if _loaded and not force:
|
||||
return translation_lang
|
||||
|
||||
data = _load_languages(path, "languages/languages.yml")
|
||||
data = _load_languages(path, "languages.yml")
|
||||
|
||||
if not isinstance(data, dict):
|
||||
raise ValueError(
|
||||
|
||||
@@ -1,40 +1,42 @@
|
||||
from openai import OpenAI
|
||||
from langchain_openai import ChatOpenAI
|
||||
from pydantic import SecretStr
|
||||
import requests
|
||||
|
||||
try:
|
||||
from .translation_languages import translation_lang
|
||||
from .translation_utils import loadPromptConfig
|
||||
from .translation_utils import loadTranslatePromptConfig
|
||||
except Exception:
|
||||
import sys
|
||||
from os import path as os_path
|
||||
sys.path.append(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
from translation_languages import translation_lang
|
||||
from translation_utils import loadPromptConfig
|
||||
sys.path.append(os_path.dirname(os_path.abspath(__file__)))
|
||||
from translation_languages import translation_lang, loadTranslationLanguages
|
||||
from translation_utils import loadTranslatePromptConfig
|
||||
translation_lang = loadTranslationLanguages(path=".", force=True)
|
||||
|
||||
def _authentication_check(api_key: str, base_url: str | None = None) -> bool:
|
||||
def _authentication_check(base_url: str | None = None) -> bool:
|
||||
"""Check if the provided API key is valid by attempting to list models.
|
||||
"""
|
||||
try:
|
||||
client = OpenAI(api_key=api_key, base_url=base_url)
|
||||
client.models.list()
|
||||
return True
|
||||
response = requests.get(f"{base_url}/models", timeout=0.2)
|
||||
if response.status_code == 200:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
except Exception:
|
||||
return False
|
||||
|
||||
def _get_available_text_models(api_key: str, base_url: str | None = None) -> list[str]:
|
||||
def _get_available_text_models(base_url: str | None = None) -> list[str]:
|
||||
"""Extract the list of available text models from the LM Studio.
|
||||
"""
|
||||
try:
|
||||
client = OpenAI(api_key=api_key, base_url=base_url)
|
||||
res = client.models.list()
|
||||
models = res.data
|
||||
response = requests.get(f"{base_url}/models", timeout=0.2)
|
||||
models = response.json()["data"]
|
||||
except Exception:
|
||||
models = []
|
||||
|
||||
allowed_models = []
|
||||
for model in models:
|
||||
allowed_models.append(model.id)
|
||||
allowed_models.append(model["id"])
|
||||
|
||||
allowed_models.sort()
|
||||
return allowed_models
|
||||
@@ -48,9 +50,19 @@ class LMStudioClient:
|
||||
self.model = None
|
||||
self.base_url = base_url # None の場合は公式エンドポイント
|
||||
|
||||
prompt_config = loadPromptConfig(root_path, "translation_lmstudio.yml")
|
||||
prompt_config = loadTranslatePromptConfig(root_path, "translation_lmstudio.yml")
|
||||
self.supported_languages = list(translation_lang["LMStudio"]["source"].keys())
|
||||
self.prompt_template = prompt_config["system_prompt"]
|
||||
# history config (optional)
|
||||
self.history_cfg = prompt_config.get("history", {
|
||||
"use_history": False,
|
||||
"sources": [],
|
||||
"max_messages": 0,
|
||||
"max_chars": 0,
|
||||
"header_template": "",
|
||||
"item_template": "[{source}] {role}: {text}",
|
||||
})
|
||||
self._context_history: list[dict] = []
|
||||
|
||||
self.openai_llm = None
|
||||
|
||||
@@ -58,13 +70,13 @@ class LMStudioClient:
|
||||
return self.base_url
|
||||
|
||||
def setBaseURL(self, base_url: str | None) -> None:
|
||||
result = _authentication_check(api_key=self.api_key, base_url=base_url)
|
||||
result = _authentication_check(base_url=base_url)
|
||||
if result:
|
||||
self.base_url = base_url
|
||||
return result
|
||||
|
||||
def getModelList(self) -> list[str]:
|
||||
return _get_available_text_models(api_key=self.api_key, base_url=self.base_url) if self.base_url else []
|
||||
return _get_available_text_models(base_url=self.base_url) if self.base_url else []
|
||||
|
||||
def getModel(self) -> str:
|
||||
return self.model
|
||||
@@ -84,12 +96,58 @@ class LMStudioClient:
|
||||
streaming=False,
|
||||
)
|
||||
|
||||
def setContextHistory(self, history_items: list[dict]) -> None:
|
||||
"""Set recent conversation history for prompt injection.
|
||||
|
||||
Each item should be a dict containing:
|
||||
- source: "chat" | "mic" | "speaker"
|
||||
- text: message string
|
||||
- timestamp: ISO format datetime string
|
||||
"""
|
||||
self._context_history = history_items or []
|
||||
|
||||
def translate(self, text: str, input_lang: str, output_lang: str) -> str:
|
||||
system_prompt = self.prompt_template.format(
|
||||
supported_languages=self.supported_languages,
|
||||
input_lang=input_lang,
|
||||
output_lang=output_lang,
|
||||
)
|
||||
|
||||
# Inject recent conversation history if enabled by YAML config
|
||||
if self.history_cfg.get("use_history"):
|
||||
allowed_sources = set(self.history_cfg.get("sources", []))
|
||||
max_messages = int(self.history_cfg.get("max_messages", 0))
|
||||
max_chars = int(self.history_cfg.get("max_chars", 0))
|
||||
item_tmpl = self.history_cfg.get("item_template", "[{source}] {role}: {text}")
|
||||
header_tmpl = self.history_cfg.get("header_template", "{history}")
|
||||
|
||||
filtered = [h for h in self._context_history if h.get("source") in allowed_sources]
|
||||
recent = filtered[-max_messages:] if max_messages > 0 else filtered
|
||||
formatted_items = []
|
||||
for h in recent:
|
||||
# Format timestamp as HH:MM to save tokens
|
||||
timestamp_str = ''
|
||||
if 'timestamp' in h:
|
||||
from datetime import datetime
|
||||
try:
|
||||
ts = datetime.fromisoformat(h['timestamp'])
|
||||
timestamp_str = ts.strftime('%H:%M')
|
||||
except:
|
||||
timestamp_str = ''
|
||||
formatted_items.append(
|
||||
item_tmpl.format(
|
||||
timestamp=timestamp_str,
|
||||
source=h.get("source", ""),
|
||||
text=h.get("text", ""),
|
||||
)
|
||||
)
|
||||
history_blob = "\n".join(formatted_items).strip()
|
||||
if max_chars and len(history_blob) > max_chars:
|
||||
history_blob = history_blob[-max_chars:]
|
||||
history_header = header_tmpl.format(max_messages=max_messages, history=history_blob)
|
||||
if history_header:
|
||||
system_prompt = f"{system_prompt}\n\n{history_header}"
|
||||
|
||||
messages = [
|
||||
{"role": "system", "content": system_prompt},
|
||||
{"role": "user", "content": text},
|
||||
@@ -108,7 +166,7 @@ class LMStudioClient:
|
||||
return content.strip()
|
||||
|
||||
if __name__ == "__main__":
|
||||
client = LMStudioClient(base_url="http://192.168.68.110:1234/v1")
|
||||
client = LMStudioClient(base_url="http://127.0.0.1:1234/v1")
|
||||
models = client.getModelList()
|
||||
if models:
|
||||
print("Available models:", models)
|
||||
|
||||
@@ -3,19 +3,20 @@ from langchain_ollama import ChatOllama
|
||||
|
||||
try:
|
||||
from .translation_languages import translation_lang
|
||||
from .translation_utils import loadPromptConfig
|
||||
from .translation_utils import loadTranslatePromptConfig
|
||||
except Exception:
|
||||
import sys
|
||||
from os import path as os_path
|
||||
sys.path.append(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
from translation_languages import translation_lang
|
||||
from translation_utils import loadPromptConfig
|
||||
sys.path.append(os_path.dirname(os_path.abspath(__file__)))
|
||||
from translation_languages import translation_lang, loadTranslationLanguages
|
||||
from translation_utils import loadTranslatePromptConfig
|
||||
translation_lang = loadTranslationLanguages(path=".", force=True)
|
||||
|
||||
def _authentication_check(base_url: str | None = None) -> bool:
|
||||
"""Check authentication for Ollama API.
|
||||
"""
|
||||
try:
|
||||
response = requests.get(f"{base_url}")
|
||||
response = requests.get(f"{base_url}", timeout=0.2)
|
||||
if response.status_code == 200:
|
||||
return True
|
||||
else:
|
||||
@@ -47,9 +48,19 @@ class OllamaClient:
|
||||
self.model = None
|
||||
self.base_url = "http://localhost:11434"
|
||||
|
||||
prompt_config = loadPromptConfig(root_path, "translation_ollama.yml")
|
||||
prompt_config = loadTranslatePromptConfig(root_path, "translation_ollama.yml")
|
||||
self.supported_languages = list(translation_lang["Ollama"]["source"].keys())
|
||||
self.prompt_template = prompt_config["system_prompt"]
|
||||
# history config (optional)
|
||||
self.history_cfg = prompt_config.get("history", {
|
||||
"use_history": False,
|
||||
"sources": [],
|
||||
"max_messages": 0,
|
||||
"max_chars": 0,
|
||||
"header_template": "",
|
||||
"item_template": "[{source}] {role}: {text}",
|
||||
})
|
||||
self._context_history: list[dict] = []
|
||||
|
||||
self.openai_llm = None
|
||||
|
||||
@@ -78,12 +89,58 @@ class OllamaClient:
|
||||
streaming=False,
|
||||
)
|
||||
|
||||
def setContextHistory(self, history_items: list[dict]) -> None:
|
||||
"""Set recent conversation history for prompt injection.
|
||||
|
||||
Each item should be a dict containing:
|
||||
- source: "chat" | "mic" | "speaker"
|
||||
- text: message string
|
||||
- timestamp: ISO format datetime string
|
||||
"""
|
||||
self._context_history = history_items or []
|
||||
|
||||
def translate(self, text: str, input_lang: str, output_lang: str) -> str:
|
||||
system_prompt = self.prompt_template.format(
|
||||
supported_languages=self.supported_languages,
|
||||
input_lang=input_lang,
|
||||
output_lang=output_lang,
|
||||
)
|
||||
|
||||
# Inject recent conversation history if enabled by YAML config
|
||||
if self.history_cfg.get("use_history"):
|
||||
allowed_sources = set(self.history_cfg.get("sources", []))
|
||||
max_messages = int(self.history_cfg.get("max_messages", 0))
|
||||
max_chars = int(self.history_cfg.get("max_chars", 0))
|
||||
item_tmpl = self.history_cfg.get("item_template", "[{source}] {role}: {text}")
|
||||
header_tmpl = self.history_cfg.get("header_template", "{history}")
|
||||
|
||||
filtered = [h for h in self._context_history if h.get("source") in allowed_sources]
|
||||
recent = filtered[-max_messages:] if max_messages > 0 else filtered
|
||||
formatted_items = []
|
||||
for h in recent:
|
||||
# Format timestamp as HH:MM to save tokens
|
||||
timestamp_str = ''
|
||||
if 'timestamp' in h:
|
||||
from datetime import datetime
|
||||
try:
|
||||
ts = datetime.fromisoformat(h['timestamp'])
|
||||
timestamp_str = ts.strftime('%H:%M')
|
||||
except:
|
||||
timestamp_str = ''
|
||||
formatted_items.append(
|
||||
item_tmpl.format(
|
||||
timestamp=timestamp_str,
|
||||
source=h.get("source", ""),
|
||||
text=h.get("text", ""),
|
||||
)
|
||||
)
|
||||
history_blob = "\n".join(formatted_items).strip()
|
||||
if max_chars and len(history_blob) > max_chars:
|
||||
history_blob = history_blob[-max_chars:]
|
||||
history_header = header_tmpl.format(max_messages=max_messages, history=history_blob)
|
||||
if history_header:
|
||||
system_prompt = f"{system_prompt}\n\n{history_header}"
|
||||
|
||||
messages = [
|
||||
{"role": "system", "content": system_prompt},
|
||||
{"role": "user", "content": text},
|
||||
|
||||
@@ -4,13 +4,14 @@ from pydantic import SecretStr
|
||||
|
||||
try:
|
||||
from .translation_languages import translation_lang
|
||||
from .translation_utils import loadPromptConfig
|
||||
from .translation_utils import loadTranslatePromptConfig
|
||||
except Exception:
|
||||
import sys
|
||||
from os import path as os_path
|
||||
sys.path.append(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
from translation_languages import translation_lang
|
||||
from translation_utils import loadPromptConfig
|
||||
from translation_languages import translation_lang, loadTranslationLanguages
|
||||
from translation_utils import loadTranslatePromptConfig
|
||||
translation_lang = loadTranslationLanguages(path=".", force=True)
|
||||
|
||||
def _authentication_check(api_key: str, base_url: str | None = None) -> bool:
|
||||
"""Check if the provided API key is valid by attempting to list models.
|
||||
@@ -68,9 +69,19 @@ class OpenAIClient:
|
||||
self.model = None
|
||||
self.base_url = base_url # None の場合は公式エンドポイント
|
||||
|
||||
prompt_config = loadPromptConfig(root_path, "translation_openai.yml")
|
||||
prompt_config = loadTranslatePromptConfig(root_path, "translation_openai.yml")
|
||||
self.supported_languages = list(translation_lang["OpenAI_API"]["source"].keys())
|
||||
self.prompt_template = prompt_config["system_prompt"]
|
||||
# history config (optional)
|
||||
self.history_cfg = prompt_config.get("history", {
|
||||
"use_history": False,
|
||||
"sources": [],
|
||||
"max_messages": 0,
|
||||
"max_chars": 0,
|
||||
"header_template": "",
|
||||
"item_template": "[{source}] {role}: {text}",
|
||||
})
|
||||
self._context_history: list[dict] = []
|
||||
|
||||
self.openai_llm = None
|
||||
|
||||
@@ -104,12 +115,62 @@ class OpenAIClient:
|
||||
streaming=False,
|
||||
)
|
||||
|
||||
def setContextHistory(self, history_items: list[dict]) -> None:
|
||||
"""Set recent conversation history for prompt injection.
|
||||
|
||||
Each item should be a dict containing:
|
||||
- source: "chat" | "mic" | "speaker"
|
||||
- text: message string
|
||||
- timestamp: ISO format datetime string
|
||||
"""
|
||||
self._context_history = history_items or []
|
||||
|
||||
def translate(self, text: str, input_lang: str, output_lang: str) -> str:
|
||||
system_prompt = self.prompt_template.format(
|
||||
supported_languages=self.supported_languages,
|
||||
input_lang=input_lang,
|
||||
output_lang=output_lang,
|
||||
)
|
||||
|
||||
# Inject recent conversation history if enabled by YAML config
|
||||
if self.history_cfg.get("use_history"):
|
||||
allowed_sources = set(self.history_cfg.get("sources", []))
|
||||
max_messages = int(self.history_cfg.get("max_messages", 0))
|
||||
max_chars = int(self.history_cfg.get("max_chars", 0))
|
||||
item_tmpl = self.history_cfg.get("item_template", "[{source}] {role}: {text}")
|
||||
header_tmpl = self.history_cfg.get("header_template", "{history}")
|
||||
|
||||
# filter by source and take newest N
|
||||
filtered = [h for h in self._context_history if h.get("source") in allowed_sources]
|
||||
recent = filtered[-max_messages:] if max_messages > 0 else filtered
|
||||
# format items
|
||||
formatted_items = []
|
||||
for h in recent:
|
||||
# Format timestamp as HH:MM to save tokens
|
||||
timestamp_str = ''
|
||||
if 'timestamp' in h:
|
||||
from datetime import datetime
|
||||
try:
|
||||
ts = datetime.fromisoformat(h['timestamp'])
|
||||
timestamp_str = ts.strftime('%H:%M')
|
||||
except:
|
||||
timestamp_str = ''
|
||||
formatted_items.append(
|
||||
item_tmpl.format(
|
||||
timestamp=timestamp_str,
|
||||
source=h.get("source", ""),
|
||||
text=h.get("text", ""),
|
||||
)
|
||||
)
|
||||
history_blob = "\n".join(formatted_items).strip()
|
||||
# truncate by char limit to mitigate token use
|
||||
if max_chars and len(history_blob) > max_chars:
|
||||
history_blob = history_blob[-max_chars:]
|
||||
# assemble header and append to system prompt
|
||||
history_header = header_tmpl.format(max_messages=max_messages, history=history_blob)
|
||||
if history_header:
|
||||
system_prompt = f"{system_prompt}\n\n{history_header}"
|
||||
|
||||
messages = [
|
||||
{"role": "system", "content": system_prompt},
|
||||
{"role": "user", "content": text},
|
||||
@@ -128,7 +189,7 @@ class OpenAIClient:
|
||||
return content.strip()
|
||||
|
||||
if __name__ == "__main__":
|
||||
AUTH_KEY = "OPENAI_API_KEY"
|
||||
AUTH_KEY = input("OPENAI_API_KEY: ")
|
||||
client = OpenAIClient()
|
||||
client.setAuthKey(AUTH_KEY)
|
||||
models = client.getModelList()
|
||||
|
||||
199
src-python/models/translation/translation_openrouter.py
Normal file
199
src-python/models/translation/translation_openrouter.py
Normal file
@@ -0,0 +1,199 @@
|
||||
import requests
|
||||
from openai import OpenAI
|
||||
from langchain_openai import ChatOpenAI
|
||||
from pydantic import SecretStr
|
||||
|
||||
try:
|
||||
from .translation_languages import translation_lang
|
||||
from .translation_utils import loadTranslatePromptConfig
|
||||
except Exception:
|
||||
import sys
|
||||
from os import path as os_path
|
||||
sys.path.append(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
from translation_languages import translation_lang, loadTranslationLanguages
|
||||
from translation_utils import loadTranslatePromptConfig
|
||||
translation_lang = loadTranslationLanguages(path=".", force=True)
|
||||
|
||||
def _authentication_check(api_key: str) -> bool:
|
||||
"""Check if the provided API key is valid by attempting to list models.
|
||||
"""
|
||||
|
||||
url = "https://openrouter.ai/api/v1/auth/key"
|
||||
headers = {
|
||||
"Authorization": f"Bearer {api_key}"
|
||||
}
|
||||
|
||||
r = requests.get(url, headers=headers, timeout=10)
|
||||
|
||||
return r.status_code == 200
|
||||
|
||||
def _get_available_text_models(api_key: str, base_url: str | None = None) -> list[str]:
|
||||
"""Extract only OpenRouter models suitable for translation and chat applications.
|
||||
"""
|
||||
client = OpenAI(api_key=api_key, base_url=base_url)
|
||||
res = client.models.list()
|
||||
allowed_models = []
|
||||
|
||||
for model in res.data:
|
||||
model_id = model.id
|
||||
|
||||
# 除外対象のキーワード
|
||||
exclude_keywords = [
|
||||
"whisper", # 音声認識
|
||||
"embedding", # 埋め込み
|
||||
"image", # 画像生成
|
||||
"tts", # 音声合成
|
||||
"audio", # 音声系
|
||||
"search", # 検索補助モデル
|
||||
"transcribe", # 音声→文字起こし
|
||||
"diarize", # 話者分離
|
||||
"vision" # 画像入力系
|
||||
]
|
||||
|
||||
# 除外キーワードが含まれているモデルをスキップ
|
||||
if any(kw in model_id.lower() for kw in exclude_keywords):
|
||||
continue
|
||||
|
||||
# テキスト処理用モデルのみ対象
|
||||
allowed_models.append(model_id)
|
||||
|
||||
allowed_models.sort()
|
||||
return allowed_models
|
||||
|
||||
class OpenRouterClient:
|
||||
"""OpenRouter API Translation wrapper using OpenAI-compatible endpoint.
|
||||
|
||||
OpenRouter provides access to various LLM models via a unified API.
|
||||
The API endpoint: https://openrouter.ai/api/v1
|
||||
"""
|
||||
def __init__(self, root_path: str = None):
|
||||
self.api_key = None
|
||||
self.model = None
|
||||
self.base_url = "https://openrouter.ai/api/v1"
|
||||
|
||||
prompt_config = loadTranslatePromptConfig(root_path, "translation_openrouter.yml")
|
||||
self.supported_languages = list(translation_lang["OpenRouter_API"]["source"].keys())
|
||||
self.prompt_template = prompt_config["system_prompt"]
|
||||
# history config (optional)
|
||||
self.history_cfg = prompt_config.get("history", {
|
||||
"use_history": False,
|
||||
"sources": [],
|
||||
"max_messages": 0,
|
||||
"max_chars": 0,
|
||||
"header_template": "",
|
||||
"item_template": "[{source}] {role}: {text}",
|
||||
})
|
||||
self._context_history: list[dict] = []
|
||||
|
||||
self.openrouter_llm = None
|
||||
|
||||
def getModelList(self) -> list[str]:
|
||||
return _get_available_text_models(self.api_key, self.base_url) if self.api_key else []
|
||||
|
||||
def getAuthKey(self) -> str:
|
||||
return self.api_key
|
||||
|
||||
def setAuthKey(self, api_key: str) -> bool:
|
||||
result = _authentication_check(api_key)
|
||||
if result:
|
||||
self.api_key = api_key
|
||||
return result
|
||||
|
||||
def getModel(self) -> str:
|
||||
return self.model
|
||||
|
||||
def setModel(self, model: str) -> bool:
|
||||
if model in self.getModelList():
|
||||
self.model = model
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
def updateClient(self) -> None:
|
||||
self.openrouter_llm = ChatOpenAI(
|
||||
base_url=self.base_url,
|
||||
model=self.model,
|
||||
api_key=SecretStr(self.api_key),
|
||||
streaming=False,
|
||||
)
|
||||
|
||||
def setContextHistory(self, history_items: list[dict]) -> None:
|
||||
"""Set recent conversation history for prompt injection.
|
||||
|
||||
Each item should be a dict containing:
|
||||
- source: "chat" | "mic" | "speaker"
|
||||
- text: message string
|
||||
- timestamp: ISO format datetime string
|
||||
"""
|
||||
self._context_history = history_items or []
|
||||
|
||||
def translate(self, text: str, input_lang: str, output_lang: str) -> str:
|
||||
system_prompt = self.prompt_template.format(
|
||||
supported_languages=self.supported_languages,
|
||||
input_lang=input_lang,
|
||||
output_lang=output_lang,
|
||||
)
|
||||
|
||||
# Inject recent conversation history if enabled by YAML config
|
||||
if self.history_cfg.get("use_history"):
|
||||
allowed_sources = set(self.history_cfg.get("sources", []))
|
||||
max_messages = int(self.history_cfg.get("max_messages", 0))
|
||||
max_chars = int(self.history_cfg.get("max_chars", 0))
|
||||
item_tmpl = self.history_cfg.get("item_template", "[{source}] {role}: {text}")
|
||||
header_tmpl = self.history_cfg.get("header_template", "{history}")
|
||||
|
||||
filtered = [h for h in self._context_history if h.get("source") in allowed_sources]
|
||||
recent = filtered[-max_messages:] if max_messages > 0 else filtered
|
||||
formatted_items = []
|
||||
for h in recent:
|
||||
# Format timestamp as HH:MM to save tokens
|
||||
timestamp_str = ''
|
||||
if 'timestamp' in h:
|
||||
from datetime import datetime
|
||||
try:
|
||||
ts = datetime.fromisoformat(h['timestamp'])
|
||||
timestamp_str = ts.strftime('%H:%M')
|
||||
except:
|
||||
timestamp_str = ''
|
||||
formatted_items.append(
|
||||
item_tmpl.format(
|
||||
timestamp=timestamp_str,
|
||||
source=h.get("source", ""),
|
||||
text=h.get("text", ""),
|
||||
)
|
||||
)
|
||||
history_blob = "\n".join(formatted_items).strip()
|
||||
if max_chars and len(history_blob) > max_chars:
|
||||
history_blob = history_blob[-max_chars:]
|
||||
history_header = header_tmpl.format(max_messages=max_messages, history=history_blob)
|
||||
if history_header:
|
||||
system_prompt = f"{system_prompt}\n\n{history_header}"
|
||||
|
||||
messages = [
|
||||
{"role": "system", "content": system_prompt},
|
||||
{"role": "user", "content": text},
|
||||
]
|
||||
|
||||
resp = self.openrouter_llm.invoke(messages)
|
||||
content = ""
|
||||
if isinstance(resp.content, str):
|
||||
content = resp.content
|
||||
elif isinstance(resp.content, list):
|
||||
for part in resp.content:
|
||||
if isinstance(part, str):
|
||||
content += part
|
||||
elif isinstance(part, dict) and "content" in part and isinstance(part["content"], str):
|
||||
content += part["content"]
|
||||
return content.strip()
|
||||
|
||||
if __name__ == "__main__":
|
||||
AUTH_KEY = input("OPENROUTER_API_KEY: ")
|
||||
client = OpenRouterClient()
|
||||
client.setAuthKey(AUTH_KEY)
|
||||
models = client.getModelList()
|
||||
if models:
|
||||
print("Available models:", models)
|
||||
model = input("Select a model: ")
|
||||
client.setModel(model)
|
||||
client.updateClient()
|
||||
print(client.translate("こんにちは世界", "Japanese", "English"))
|
||||
@@ -4,13 +4,14 @@ from pydantic import SecretStr
|
||||
|
||||
try:
|
||||
from .translation_languages import translation_lang
|
||||
from .translation_utils import loadPromptConfig
|
||||
from .translation_utils import loadTranslatePromptConfig
|
||||
except Exception:
|
||||
import sys
|
||||
from os import path as os_path
|
||||
sys.path.append(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
from translation_languages import translation_lang
|
||||
from translation_utils import loadPromptConfig
|
||||
from translation_languages import translation_lang, loadTranslationLanguages
|
||||
from translation_utils import loadTranslatePromptConfig
|
||||
translation_lang = loadTranslationLanguages(path=".", force=True)
|
||||
|
||||
BASE_URL = "https://api.platform.preferredai.jp/v1"
|
||||
|
||||
@@ -43,9 +44,19 @@ class PlamoClient:
|
||||
self.base_url = BASE_URL
|
||||
self.model = None
|
||||
|
||||
prompt_config = loadPromptConfig(root_path, "translation_plamo.yml")
|
||||
prompt_config = loadTranslatePromptConfig(root_path, "translation_plamo.yml")
|
||||
self.supported_languages = list(translation_lang["Plamo_API"]["source"].keys())
|
||||
self.prompt_template = prompt_config["system_prompt"]
|
||||
# history config (optional)
|
||||
self.history_cfg = prompt_config.get("history", {
|
||||
"use_history": False,
|
||||
"sources": [],
|
||||
"max_messages": 0,
|
||||
"max_chars": 0,
|
||||
"header_template": "",
|
||||
"item_template": "[{source}] {role}: {text}",
|
||||
})
|
||||
self._context_history: list[dict] = []
|
||||
|
||||
self.plamo_llm = None
|
||||
|
||||
@@ -79,12 +90,58 @@ class PlamoClient:
|
||||
api_key=SecretStr(self.api_key),
|
||||
)
|
||||
|
||||
def setContextHistory(self, history_items: list[dict]) -> None:
|
||||
"""Set recent conversation history for prompt injection.
|
||||
|
||||
Each item should be a dict containing:
|
||||
- source: "chat" | "mic" | "speaker"
|
||||
- text: message string
|
||||
- timestamp: ISO format datetime string
|
||||
"""
|
||||
self._context_history = history_items or []
|
||||
|
||||
def translate(self, text: str, input_lang: str, output_lang: str) -> str:
|
||||
system_prompt = self.prompt_template.format(
|
||||
supported_languages=self.supported_languages,
|
||||
input_lang=input_lang,
|
||||
output_lang=output_lang
|
||||
)
|
||||
|
||||
# Inject recent conversation history if enabled by YAML config
|
||||
if self.history_cfg.get("use_history"):
|
||||
allowed_sources = set(self.history_cfg.get("sources", []))
|
||||
max_messages = int(self.history_cfg.get("max_messages", 0))
|
||||
max_chars = int(self.history_cfg.get("max_chars", 0))
|
||||
item_tmpl = self.history_cfg.get("item_template", "[{source}] {role}: {text}")
|
||||
header_tmpl = self.history_cfg.get("header_template", "{history}")
|
||||
|
||||
filtered = [h for h in self._context_history if h.get("source") in allowed_sources]
|
||||
recent = filtered[-max_messages:] if max_messages > 0 else filtered
|
||||
formatted_items = []
|
||||
for h in recent:
|
||||
# Format timestamp as HH:MM to save tokens
|
||||
timestamp_str = ''
|
||||
if 'timestamp' in h:
|
||||
from datetime import datetime
|
||||
try:
|
||||
ts = datetime.fromisoformat(h['timestamp'])
|
||||
timestamp_str = ts.strftime('%H:%M')
|
||||
except:
|
||||
timestamp_str = ''
|
||||
formatted_items.append(
|
||||
item_tmpl.format(
|
||||
timestamp=timestamp_str,
|
||||
source=h.get("source", ""),
|
||||
text=h.get("text", ""),
|
||||
)
|
||||
)
|
||||
history_blob = "\n".join(formatted_items).strip()
|
||||
if max_chars and len(history_blob) > max_chars:
|
||||
history_blob = history_blob[-max_chars:]
|
||||
history_header = header_tmpl.format(max_messages=max_messages, history=history_blob)
|
||||
if history_header:
|
||||
system_prompt = f"{system_prompt}\n\n{history_header}"
|
||||
|
||||
messages = [
|
||||
{"role": "system", "content": system_prompt},
|
||||
{"role": "user", "content": text},
|
||||
|
||||
@@ -769,3 +769,11 @@ LMStudio:
|
||||
Ollama:
|
||||
source: *openai_langs
|
||||
target: *openai_langs
|
||||
|
||||
Groq_API:
|
||||
source: *openai_langs
|
||||
target: *openai_langs
|
||||
|
||||
OpenRouter_API:
|
||||
source: *openai_langs
|
||||
target: *openai_langs
|
||||
@@ -0,0 +1,16 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
history:
|
||||
use_history: true
|
||||
sources: [chat, mic, speaker]
|
||||
max_messages: 5
|
||||
max_chars: 4000
|
||||
header_template: |
|
||||
Conversation context (recent {max_messages} messages):
|
||||
{history}
|
||||
item_template: "[{timestamp}][{source}] {text}"
|
||||
@@ -0,0 +1,16 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
history:
|
||||
use_history: true
|
||||
sources: [chat, mic, speaker]
|
||||
max_messages: 5
|
||||
max_chars: 4000
|
||||
header_template: |
|
||||
Conversation context (recent {max_messages} messages):
|
||||
{history}
|
||||
item_template: "[{timestamp}][{source}] {text}"
|
||||
@@ -0,0 +1,16 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
history:
|
||||
use_history: true
|
||||
sources: [chat, mic, speaker]
|
||||
max_messages: 5
|
||||
max_chars: 4000
|
||||
header_template: |
|
||||
Conversation context (recent {max_messages} messages):
|
||||
{history}
|
||||
item_template: "[{timestamp}][{source}] {text}"
|
||||
@@ -0,0 +1,16 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
history:
|
||||
use_history: true
|
||||
sources: [chat, mic, speaker]
|
||||
max_messages: 5
|
||||
max_chars: 4000
|
||||
header_template: |
|
||||
Conversation context (recent {max_messages} messages):
|
||||
{history}
|
||||
item_template: "[{timestamp}][{source}] {text}"
|
||||
@@ -0,0 +1,16 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
history:
|
||||
use_history: true
|
||||
sources: [chat, mic, speaker] # 取り込み対象の履歴種別
|
||||
max_messages: 5 # 注入する履歴件数の上限（新しい順）
|
||||
max_chars: 4000 # 履歴整形後の最大文字数（超過時は先頭を切り捨て）
|
||||
header_template: |
|
||||
Conversation context (recent {max_messages} messages):
|
||||
{history}
|
||||
item_template: "[{timestamp}][{source}] {text}"
|
||||
@@ -0,0 +1,16 @@
|
||||
system_prompt: |
|
||||
You are a helpful translation assistant.
|
||||
Supported languages:
|
||||
{supported_languages}
|
||||
|
||||
Translate the user provided text from {input_lang} to {output_lang}.
|
||||
Return ONLY the translated text. Do not add quotes or extra commentary.
|
||||
history:
|
||||
use_history: true
|
||||
sources: [chat, mic, speaker]
|
||||
max_messages: 5
|
||||
max_chars: 4000
|
||||
header_template: |
|
||||
Conversation context (recent {max_messages} messages):
|
||||
{history}
|
||||
item_template: "[{timestamp}][{source}] {text}"
|
||||
@@ -4,4 +4,13 @@ system_prompt: |
|
||||
{supported_languages}
|
||||
|
||||
Translate the following text from {input_lang} to {output_lang}.
|
||||
output only the translated text without any additional commentary.
|
||||
output only the translated text without any additional commentary.
|
||||
history:
|
||||
use_history: true
|
||||
sources: [chat, mic, speaker]
|
||||
max_messages: 5
|
||||
max_chars: 4000
|
||||
header_template: |
|
||||
Conversation context (recent {max_messages} messages):
|
||||
{history}
|
||||
item_template: "[{timestamp}][{source}] {text}"
|
||||
@@ -15,6 +15,8 @@ try:
|
||||
from .translation_openai import OpenAIClient
|
||||
from .translation_lmstudio import LMStudioClient
|
||||
from .translation_ollama import OllamaClient
|
||||
from .translation_groq import GroqClient
|
||||
from .translation_openrouter import OpenRouterClient
|
||||
except Exception:
|
||||
import sys
|
||||
sys.path.append(os_path.dirname(os_path.dirname(os_path.dirname(os_path.abspath(__file__)))))
|
||||
@@ -25,6 +27,8 @@ except Exception:
|
||||
from translation_openai import OpenAIClient
|
||||
from translation_lmstudio import LMStudioClient
|
||||
from translation_ollama import OllamaClient
|
||||
from translation_groq import GroqClient
|
||||
from translation_openrouter import OpenRouterClient
|
||||
|
||||
import ctranslate2
|
||||
import transformers
|
||||
@@ -50,6 +54,8 @@ class Translator:
|
||||
self.plamo_client: Optional[PlamoClient] = None
|
||||
self.gemini_client: Optional[GeminiClient] = None
|
||||
self.openai_client: Optional[OpenAIClient] = None
|
||||
self.groq_client: Optional[GroqClient] = None
|
||||
self.openrouter_client: Optional[OpenRouterClient] = None
|
||||
self.lmstudio_client: LMStudioClient[LMStudioClient] = None
|
||||
self.ollama_client: OllamaClient[OllamaClient] = None
|
||||
self.ctranslate2_translator: Any = None
|
||||
@@ -176,6 +182,84 @@ class Translator:
|
||||
"""Update the OpenAI client (fetch available models)."""
|
||||
self.openai_client.updateClient()
|
||||
|
||||
def authenticationGroqAuthKey(self, auth_key: str, root_path: str = None) -> bool:
|
||||
"""Authenticate Groq API with the provided key.
|
||||
|
||||
Returns True on success, False on failure.
|
||||
"""
|
||||
self.groq_client = GroqClient(root_path=root_path)
|
||||
if self.groq_client.setAuthKey(auth_key):
|
||||
return True
|
||||
else:
|
||||
self.groq_client = None
|
||||
return False
|
||||
|
||||
def getGroqModelList(self) -> list[str]:
|
||||
"""Get available Groq models.
|
||||
|
||||
Returns a list of model names, or an empty list on failure.
|
||||
"""
|
||||
if self.groq_client is None:
|
||||
return []
|
||||
return self.groq_client.getModelList()
|
||||
|
||||
def setGroqModel(self, model: str) -> bool:
|
||||
"""Change the Groq model used for translation.
|
||||
|
||||
Returns True on success, False on failure.
|
||||
"""
|
||||
if self.groq_client is None:
|
||||
return False
|
||||
return self.groq_client.setModel(model)
|
||||
|
||||
def updateGroqClient(self) -> None:
|
||||
"""Update the Groq client (fetch available models)."""
|
||||
self.groq_client.updateClient()
|
||||
|
||||
def authenticationOpenRouterAuthKey(self, auth_key: str, root_path: str = None) -> bool:
|
||||
"""Authenticate OpenRouter API with the provided key.
|
||||
|
||||
Returns True on success, False on failure.
|
||||
"""
|
||||
self.openrouter_client = OpenRouterClient(root_path=root_path)
|
||||
if self.openrouter_client.setAuthKey(auth_key):
|
||||
return True
|
||||
else:
|
||||
self.openrouter_client = None
|
||||
return False
|
||||
|
||||
def getOpenRouterModelList(self) -> list[str]:
|
||||
"""Get available OpenRouter models.
|
||||
|
||||
Returns a list of model names, or an empty list on failure.
|
||||
"""
|
||||
if self.openrouter_client is None:
|
||||
return []
|
||||
return self.openrouter_client.getModelList()
|
||||
|
||||
def setOpenRouterModel(self, model: str) -> bool:
|
||||
"""Change the OpenRouter model used for translation.
|
||||
|
||||
Returns True on success, False on failure.
|
||||
"""
|
||||
if self.openrouter_client is None:
|
||||
return False
|
||||
return self.openrouter_client.setModel(model)
|
||||
|
||||
def updateOpenRouterClient(self) -> None:
|
||||
"""Update the OpenRouter client (fetch available models)."""
|
||||
self.openrouter_client.updateClient()
|
||||
|
||||
def getLMStudioConnected(self) -> bool:
|
||||
"""Get LM Studio connection status.
|
||||
|
||||
Returns True if connected, False otherwise.
|
||||
"""
|
||||
if self.lmstudio_client is None:
|
||||
return False
|
||||
else:
|
||||
return True
|
||||
|
||||
def setLMStudioClientURL(self, base_url: str | None = None, root_path: str = None) -> bool:
|
||||
"""Authenticate LM Studio with the provided base URL.
|
||||
|
||||
@@ -207,13 +291,26 @@ class Translator:
|
||||
"""Update the LM Studio client (fetch available models)."""
|
||||
self.lmstudio_client.updateClient()
|
||||
|
||||
def getOllamaConnected(self) -> bool:
|
||||
"""Get Ollama connection status.
|
||||
|
||||
Returns True if connected, False otherwise.
|
||||
"""
|
||||
if self.ollama_client is None:
|
||||
return False
|
||||
else:
|
||||
return True
|
||||
|
||||
def checkOllamaClient(self, root_path: str = None) -> bool:
|
||||
"""Check if Ollama client is available.
|
||||
|
||||
Returns True if Ollama is reachable, False otherwise.
|
||||
"""
|
||||
self.ollama_client = OllamaClient(root_path=root_path)
|
||||
return self.ollama_client.authenticationCheck()
|
||||
result = self.ollama_client.authenticationCheck()
|
||||
if result is False:
|
||||
self.ollama_client = None
|
||||
return result
|
||||
|
||||
def getOllamaModelList(self, root_path: str = None) -> bool:
|
||||
"""Initialize Ollama client and fetch available models.
|
||||
@@ -328,9 +425,18 @@ class Translator:
|
||||
target_language = translation_lang[translator_name]["target"][target_language]
|
||||
return source_language, target_language
|
||||
|
||||
def translate(self, translator_name: str, weight_type: str, source_language: str, target_language: str, target_country: str, message: str) -> Any:
|
||||
def translate(self, translator_name: str, weight_type: str, source_language: str, target_language: str, target_country: str, message: str, context_history: Optional[list[dict]] = None) -> Any:
|
||||
"""Translate `message` using the named translator backend.
|
||||
|
||||
Args:
|
||||
translator_name: Name of the translator backend to use
|
||||
weight_type: Model weight type for CTranslate2
|
||||
source_language: Source language name
|
||||
target_language: Target language name
|
||||
target_country: Target country for locale-specific translations
|
||||
message: Text to translate
|
||||
context_history: Optional conversation context (Chat/Mic/Speaker messages)
|
||||
|
||||
Returns translated string on success, or False on failure. When
|
||||
source_language == target_language the original message is returned.
|
||||
"""
|
||||
@@ -363,6 +469,8 @@ class Translator:
|
||||
if self.plamo_client is None:
|
||||
result = False
|
||||
else:
|
||||
if context_history:
|
||||
self.plamo_client.setContextHistory(context_history)
|
||||
result = self.plamo_client.translate(
|
||||
message,
|
||||
input_lang=source_language,
|
||||
@@ -372,6 +480,8 @@ class Translator:
|
||||
if self.gemini_client is None:
|
||||
result = False
|
||||
else:
|
||||
if context_history:
|
||||
self.gemini_client.setContextHistory(context_history)
|
||||
result = self.gemini_client.translate(
|
||||
message,
|
||||
input_lang=source_language,
|
||||
@@ -381,15 +491,41 @@ class Translator:
|
||||
if self.openai_client is None:
|
||||
result = False
|
||||
else:
|
||||
if context_history:
|
||||
self.openai_client.setContextHistory(context_history)
|
||||
result = self.openai_client.translate(
|
||||
message,
|
||||
input_lang=source_language,
|
||||
output_lang=target_language,
|
||||
)
|
||||
case "Groq_API":
|
||||
if self.groq_client is None:
|
||||
result = False
|
||||
else:
|
||||
if context_history:
|
||||
self.groq_client.setContextHistory(context_history)
|
||||
result = self.groq_client.translate(
|
||||
message,
|
||||
input_lang=source_language,
|
||||
output_lang=target_language,
|
||||
)
|
||||
case "OpenRouter_API":
|
||||
if self.openrouter_client is None:
|
||||
result = False
|
||||
else:
|
||||
if context_history:
|
||||
self.openrouter_client.setContextHistory(context_history)
|
||||
result = self.openrouter_client.translate(
|
||||
message,
|
||||
input_lang=source_language,
|
||||
output_lang=target_language,
|
||||
)
|
||||
case "LMStudio":
|
||||
if self.lmstudio_client is None:
|
||||
result = False
|
||||
else:
|
||||
if context_history:
|
||||
self.lmstudio_client.setContextHistory(context_history)
|
||||
result = self.lmstudio_client.translate(
|
||||
message,
|
||||
input_lang=source_language,
|
||||
@@ -399,6 +535,8 @@ class Translator:
|
||||
if self.ollama_client is None:
|
||||
result = False
|
||||
else:
|
||||
if context_history:
|
||||
self.ollama_client.setContextHistory(context_history)
|
||||
result = self.ollama_client.translate(
|
||||
message,
|
||||
input_lang=source_language,
|
||||
|
||||
@@ -101,16 +101,16 @@ def downloadCTranslate2Tokenizer(path: str, weight_type: str = "m2m100_418M-ct2-
|
||||
tokenizer_path = os_path.join("./weights", "ctranslate2", directory_name, "tokenizer")
|
||||
transformers.AutoTokenizer.from_pretrained(tokenizer, cache_dir=tokenizer_path)
|
||||
|
||||
def loadPromptConfig(root_path: str | None = None, prompt_filename: str | None = None) -> dict:
|
||||
def loadTranslatePromptConfig(root_path: str | None = None, prompt_filename: str | None = None) -> dict:
|
||||
# PyInstaller 展開後
|
||||
if root_path and prompt_filename and os_path.exists(os_path.join(root_path, "_internal", "prompt", prompt_filename)):
|
||||
prompt_path = os_path.join(root_path, "_internal", "prompt", prompt_filename)
|
||||
if root_path and prompt_filename and os_path.exists(os_path.join(root_path, "_internal", "translation_settings", "prompt", prompt_filename)):
|
||||
prompt_path = os_path.join(root_path, "_internal", "translation_settings", "prompt", prompt_filename)
|
||||
# src-python 直下実行
|
||||
elif prompt_filename and os_path.exists(os_path.join(os_path.dirname(__file__), "models", "translation", "prompt", prompt_filename)):
|
||||
prompt_path = os_path.join(os_path.dirname(__file__), "models", "translation", "prompt", prompt_filename)
|
||||
elif prompt_filename and os_path.exists(os_path.join(os_path.dirname(__file__), "models", "translation", "translation_settings", "prompt", prompt_filename)):
|
||||
prompt_path = os_path.join(os_path.dirname(__file__), "models", "translation", "translation_settings", "prompt", prompt_filename)
|
||||
# translation フォルダ直下実行
|
||||
elif prompt_filename and os_path.exists(os_path.join(os_path.dirname(__file__), "prompt", prompt_filename)):
|
||||
prompt_path = os_path.join(os_path.dirname(__file__), "prompt", prompt_filename)
|
||||
elif prompt_filename and os_path.exists(os_path.join(os_path.dirname(__file__), "translation_settings", "prompt", prompt_filename)):
|
||||
prompt_path = os_path.join(os_path.dirname(__file__), "translation_settings", "prompt", prompt_filename)
|
||||
else:
|
||||
raise FileNotFoundError(f"Prompt file not found: {prompt_filename}")
|
||||
with open(prompt_path, "r", encoding="utf-8") as f:
|
||||
|
||||
Reference in New Issue
Block a user