Skip to content

docs: モデル選択と設定保存の説明を現行仕様にそろえる #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Eotel merged 1 commit into from
Oct 25, 2026
Merged

docs: モデル選択と設定保存の説明を現行仕様にそろえる #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ bash scripts/dev.sh
2. 表示文をクリックして訂正欄を開き、修正して「保存して公開」を押します。未保存の下書きは観客へ出ません。Ctrl / Command + Enterでも保存できます。
3. 「新着の公開」で自動公開・確認して公開を選びます。「字幕を隠す」は表示を止め、「字幕を表示」は新しい発話から再開します。
4. 「表示設定」を反映し、観客画面を別ディスプレイへ移して全画面表示します。純正へ返す場合は接続設定を「UDトークへ反映（試験接続）」に変更し、有効な編集用の参加リンクを適用します。訂正の表示はUDトーク側で確認します。
5. AIを使う場合は[開発手順](docs/development.md#環境変数)に従ってキーを設定し、再起動します。ロボットアイコンの「AI設定」で選び方を保存します。比較条件と料金は[AIの選択と振り分け](docs/ai-routing.md)を参照してください。
5. AIを使う場合は[開発手順](docs/development.md#環境変数)に従ってキーを設定し、再起動します。ロボットアイコンの「AI設定」の「モデル」で使うAIを選び、保存します。比較条件と料金は[AIの選択と振り分け](docs/ai-routing.md)を参照してください。

未保存の下書きは観客へ送られません。人が保存した文は後着の入力で上書きしません。編集競合、非表示期間、入力 API の詳細は[現行 PoC の仕様](docs/current-behavior.md)を参照してください。

Expand Down
2 changes: 1 addition & 1 deletion docs/ai-routing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Geminiは[generateContent](https://ai.google.dev/api/generate-content)、Claude

## トークの背景と直近の字幕

「トークの背景」にはテーマ、登壇者、作品名などを4,000文字まで入力できる。保存後の確定字幕から使い、既存の字幕を再校正しない。背景はAI設定と同じくメモリ上にあり、再起動で消える。
「トークの背景」にはテーマ、登壇者、作品名などを4,000文字まで入力できる。保存後の確定字幕から使い、既存の字幕を再校正しない。背景はルームのAI設定として保存し、再起動後も保持する。直近の字幕はメモリ上にあり、再起動で消える。

各要求では、その時点の背景、単語辞書、同じ接続の直前の確定字幕を取得する。直近の字幕は採用済みの表示文を古い順で最大6件・合計3,000文字まで渡し、文の途中では切らない。対象自身・後続字幕・未確定字幕・以前の接続の履歴は混ぜない。接続先や入力元を変えた場合は履歴の範囲をリセットし、同じ入力の送信形式だけを変えた場合は保つ。

Expand Down
2 changes: 1 addition & 1 deletion docs/dictionary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Deepgramの認識ヒントとUDトークの単語登録を参考にした機能

## 保存先とAPI

通常起動では `$XDG_DATA_HOME/caption-relay/dictionary.json`、未設定なら `~/.local/share/caption-relay/dictionary.json` に保存する。`CAPTION_RELAY_DICTIONARY_PATH` で別のファイルを指定できる。字幕・接続・AI設定のメモリ保存とは異なり、辞書は再起動後も保持する。単一プロセスでのローカル利用を前提とし、同じファイルを複数のサーバーで同時に更新しない。
通常起動では `$XDG_DATA_HOME/caption-relay/dictionary.json`、未設定なら `~/.local/share/caption-relay/dictionary.json` に保存する。`CAPTION_RELAY_DICTIONARY_PATH` で別のファイルを指定できる。辞書は再起動後も保持する。ルームの接続先やAI設定も、別の設定ファイルへ保存する。単一プロセスでのローカル利用を前提とし、同じファイルを複数のサーバーで同時に更新しない。

一時ファイルへ書いてから置き換え、失敗した場合は旧辞書を保持する。保存済みファイルが不正なら、空辞書で上書きせず起動を止める。保存先の内容を確認して修復する。辞書ファイルは単語・読み・誤認識例・有効状態・改版番号を含む。

Expand Down
2 changes: 1 addition & 1 deletion docs/udtalk-display.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@

公式の[Web字幕の全画面表示案内](https://udtalk.jp/post-4633/)は、投影時に管理用の表示を減らし、背景や文字サイズを調整できることを案内している。Caption Relayの観客画面も字幕を主体とし、全画面時には表示切り替えボタンを隠す。

UDトークと同じ機能をすべて再現したものではない。Caption Relayの設定は現行PoCのサーバーメモリに保存し、再起動で消える。実装の詳細は[現行PoCの仕様](current-behavior.md#別画面の表示設定)を参照する。
UDトークと同じ機能をすべて再現したものではない。表示設定はルームごとに保存し、サーバーの再起動後も保持する。字幕履歴は再起動で消える。実装の詳細は[現行PoCの仕様](current-behavior.md#別画面の表示設定)を参照する。
Loading