Files
VRCT/src-python/docs/details/translation_lmstudio.md
misyaguziya bcfbf51696 LMStudio 認証呼び出しで base_url を明示渡しへ修正 + ドキュメント整備(ローカルLLM/言語マッピング/フォント等)
- controller: model.authenticationTranslatorLMStudio 呼び出しに base_url=config.LMSTUDIO_URL を明示的に渡すよう修正(LMStudio 接続判定で設定 URL を利用)
- docs: 新規ドキュメントを追加・更新
  - 追加: translation_gemini.md, translation_lmstudio.md, translation_ollama.md, translation_openai.md, translation_plamo.md
  - 更新: config.md, controller.md, mainloop.md, model.md, overlay.md, translation_languages.md, translation_translator.md, 仕様書.md(翻訳/モデル管理・エンドポイント・YAML 言語定義・フォント探索・VRAM フォールバック等の記載追加)
- ドキュメントに記載した主な変更点
  - LMStudio / Ollama のローカルLLM統合(モデルリスト/選択用プロパティ追加、接続確認エンドポイント)
  - CTranslate2 の言語定義を weight_type ネスト構造へ変更対応
  - 外部 YAML による言語マッピング導入(loadTranslationLanguages)
  - フォント探索を PyInstaller バンドル(_internal/fonts/) を考慮して強化
  - 認証後のモデルリスト自動更新・SELECTED_* プロパティ名統一、VRAM エラー検知時の自動フォールバック等の動作説明追加

(コードの振る舞いは既存処理に合わせた引数指定の修正とドキュメント反映が主体)
2025-10-20 01:19:49 +09:00

3.2 KiB

translation_lmstudio.py - LMStudio ローカル LLM 翻訳クライアント

概要

LMStudio 互換 OpenAI API を利用したローカル LLM 翻訳クライアントラッパー。モデル一覧取得・モデル選択・翻訳処理を統一インターフェースで提供する。

最近の更新 (2025-10-20)

  • 新規追加: ローカル LLM (LMStudio) を翻訳エンジン群へ統合
  • getModelList() により現在起動中インスタンスから利用可能モデルを取得
  • setModel() 成功時に updateClient() を呼ぶことで LangChain ChatOpenAI を再構築
  • YAML (prompt/translation_lmstudio.yml) からシステムプロンプト (system_prompt) と対応言語をロード

影響

項目 内容
拡張性 ネットワーク不要のローカル推論を利用可能
一貫性 他 API クライアント (OpenAI/Plamo/Gemini/Ollama) と同一メソッド構成
保守性 翻訳ロジックを共通フォーマットへ集約

責務

  • LMStudio エンドポイントへの疎通確認 (認証代替)
  • 利用可能モデル一覧の収集とソート
  • 選択モデルの検証と内部保持
  • LangChain ラッパーインスタンス生成
  • システムプロンプトによる指示付き翻訳実行

公開API (メソッド)

class LMStudioClient:
    def __init__(base_url: str | None = None, root_path: str = None)
    def getBaseURL() -> str | None
    def setBaseURL(base_url: str | None) -> bool
    def getModelList() -> list[str]
    def getModel() -> str | None
    def setModel(model: str) -> bool
    def updateClient() -> None
    def translate(text: str, input_lang: str, output_lang: str) -> str

メソッド詳細

  • setBaseURL: 疎通確認 (_authentication_check) に成功した場合のみ内部更新
  • getModelList: OpenAI クライアントで /models を列挙し id を抽出
  • setModel: getModelList 内のモデル名のみ受理
  • updateClient: ChatOpenAI インスタンスを最新モデルで再生成
  • translate: システム / ユーザメッセージで LLM へ問い合わせし文字列レスポンスを正規化

使用例

client = LMStudioClient(base_url="http://localhost:1234/v1")
models = client.getModelList()
if models:
    client.setModel(models[0])
    client.updateClient()
    translated = client.translate("こんにちは世界", "Japanese", "English")
    print(translated)

依存関係

  • openai.OpenAI: LMStudio OpenAI 互換 API 呼び出し
  • langchain_openai.ChatOpenAI: LangChain 抽象化
  • translation_languages.translation_lang: 対応言語集合
  • translation_utils.loadPromptConfig: プロンプト YAML ロード

注意事項

  • api_key は固定文字列 "lmstudio" (LMStudio 側で不要のため) を利用
  • モデル一覧取得はエンドポイントの互換性に依存 (古いバージョン非対応の可能性)
  • updateClient() 呼び出し前は translate() を利用できない

制限事項

  • ストリーミング未対応 (streaming=False)
  • エラーハンドリングは包括的ではなく詳細原因は上位層で処理必要

関連ドキュメント

  • details/translation_translator.md
  • details/translation_languages.md