Merge branch 'main' into feature/katex-math-rendering
This commit is contained in:
+68
-1
@@ -15,15 +15,22 @@ SSE でストリーミング応答を返す。
|
||||
{
|
||||
"message": "こんにちは",
|
||||
"session_id": "uuid(省略時は新規セッション作成)",
|
||||
"model": "gpt-5.4(省略時は DEFAULT_MODEL)"
|
||||
"model": "gpt-5.4(省略時は DEFAULT_MODEL)",
|
||||
"note_page_ids": [1, 2]
|
||||
}
|
||||
```
|
||||
|
||||
`note_page_ids` は「このセッションで本文をシステムプロンプトに載せる共有ノートのページ ID」。
|
||||
渡すとコンテキスト組み立ての前にサーバー側の指定を丸ごと置き換える(`PUT /chat/sessions/{id}/notes` と同じ内容)。
|
||||
新規セッションではフロントがまだ session_id を持てないため、初回はここでしか指定できない。省略すると現在の指定を変更しない。
|
||||
|
||||
**SSE イベント**
|
||||
| type | value | タイミング |
|
||||
|---|---|---|
|
||||
| `session_id` | セッション UUID | 新規セッション作成直後 |
|
||||
| `chunk` | テキスト断片 | LLM トークン生成ごと |
|
||||
| `tool` | `{id, name, label, detail, status, result}` | ツール実行の開始時 (`status: running`) と完了時 (`status: done`)。同じ `id` で 2 回届くのでフロントはマージして表示する |
|
||||
| `sources` | `[{title, url}]` | Web 検索した時のみ(出典一覧) |
|
||||
| `notes_updated` | — | AI が共有ノートを書き換えた直後 |
|
||||
| `done` | — | 正常完了 |
|
||||
| `error` | エラーメッセージ | 例外発生時 |
|
||||
@@ -62,6 +69,28 @@ SSE でストリーミング応答を返す。
|
||||
|
||||
---
|
||||
|
||||
### GET /chat/sessions/{session_id}/notes
|
||||
このセッションで本文をシステムプロンプトに載せるよう指定された共有ノートのページ ID を返す。
|
||||
順序はノートのタブ順(`position`)。セッションが無ければ `404`。
|
||||
|
||||
**レスポンス**
|
||||
```json
|
||||
{ "page_ids": [1, 2] }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### PUT /chat/sessions/{session_id}/notes
|
||||
指定を丸ごと置き換える。存在しないページ ID は黙って捨てられ、実際に紐付いた ID が返る。
|
||||
空配列を渡すと全解除。セッションが無ければ `404`。
|
||||
|
||||
**リクエスト**
|
||||
```json
|
||||
{ "page_ids": [1, 2] }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### DELETE /chat/sessions/{session_id}
|
||||
セッションと紐づくメッセージ・メモリをすべて削除。`204 No Content` を返す。
|
||||
|
||||
@@ -185,6 +214,44 @@ SSE でストリーミング応答を返す。
|
||||
|
||||
---
|
||||
|
||||
### POST /api/notes/import
|
||||
`multipart/form-data` の `files` でアップロードされたファイルをページとして取り込み、
|
||||
`201 Created` で作成したページの配列を返す。
|
||||
|
||||
| 拡張子 | 取り込み方 |
|
||||
|---|---|
|
||||
| `.md` / `.markdown` / `.txt` / `.text` | 1 ファイル 1 ページ。タイトルはファイル名から拡張子と `01_` 形式の通し番号を落としたもの |
|
||||
| `.zip` | 中のテキストファイルを 1 つずつページにする。第 1 階層のフォルダ名がセクションになる(`GET /api/notes/export` の ZIP をそのまま戻せる) |
|
||||
|
||||
- 既存ページとタイトルが衝突したら `タイトル (2)` のように連番を足して**別ページとして作る**(上書きはしない)
|
||||
- 文字コードは UTF-8 (BOM 可) → CP932 の順に試す
|
||||
- 対象外の拡張子・`NOTES_IMPORT_MAX_BYTES`(既定 2,000,000)超のファイル・`NOTES_IMPORT_MAX_PAGES`(既定 100)を超えた分・壊れた ZIP は**黙って飛ばす**
|
||||
- 1 ページも取り込めなかった場合のみ `400`
|
||||
|
||||
---
|
||||
|
||||
### GET /api/notes/export
|
||||
全ページを ZIP でダウンロードさせる(`Content-Disposition: attachment`)。
|
||||
1 ページ 1 ファイルの Markdown で、本文はそのまま。エントリ名は `<セクション>/<通し番号>_<タイトル>.md`
|
||||
(セクション無しのページは ZIP 直下)。通し番号は `position` 順なのでタブの並びが残る。
|
||||
ファイル名は `notes_YYYYMMDD.zip`。
|
||||
|
||||
---
|
||||
|
||||
### GET /api/notes/{page_id}/export
|
||||
1 ページを Markdown ファイルとしてダウンロードさせる。本文はそのままで、ファイル名がタイトルになる。
|
||||
ページが存在しない場合は `404`。
|
||||
|
||||
日本語タイトルを扱うため `Content-Disposition` には RFC 5987 形式を併記する:
|
||||
|
||||
```
|
||||
attachment; filename="______.md"; filename*=UTF-8''%E8%B2%B7%E3%81%84%E7%89%A9%E3%83%AA%E3%82%B9%E3%83%88.md
|
||||
```
|
||||
|
||||
ファイル名に使えない文字(`\ / : * ? " < > |` と制御文字)は `_` に置き換え、80 文字で切る。
|
||||
|
||||
---
|
||||
|
||||
## ログ
|
||||
|
||||
### GET /logs
|
||||
|
||||
@@ -66,6 +66,7 @@ backend/
|
||||
| `knowledge_sources` | id, entry_id, title, url | 上記知識の出典 URL |
|
||||
| `local_knowledge_docs` | id, path, title, content_hash, embedding_json, updated_at | ローカル Markdown KB の埋め込みキャッシュ |
|
||||
| `note_pages` | id, title, content, position, section, created_at, updated_at | ユーザーと AI が共同編集する共有ノートのページ(`section` でタブをグループ化) |
|
||||
| `session_note_pages` | id, session_id, page_id, created_at | 「このセッションではこのページの本文をプロンプトに載せる」指定(session_id × page_id は一意) |
|
||||
| `app_settings` | key, value, updated_at | GUI 設定画面から編集した接続情報 |
|
||||
| `model_presets` | id, label, value, created_at | モデル選択プルダウンの選択肢 |
|
||||
| `api_logs` | id, session_id, model, request_json, response_text, error, latency_ms, created_at | LLM API 呼び出しログ |
|
||||
@@ -79,12 +80,19 @@ LLM に渡すコンテキストは `memory_kb/memory.py` の `get_context_messag
|
||||
|---|---|---|---|---|
|
||||
| 1 | 蓄積知識 | 過去の Web 検索で得た `knowledge_entries` の**見出し一覧のみ**(本文・出典は含めない) | `knowledge.get_knowledge_context()` | 最新 `KNOWLEDGE_CONTEXT_LIMIT`(既定 15)件 |
|
||||
| 2 | 共有ノート | ページの**タイトル一覧+本文先頭 40 文字**のみ | `notes.get_notes_context()` | 全ページ(本文は入れない) |
|
||||
| 2.5 | 参照指定ノート | ユーザーがこのセッションに紐付けたページの**本文全文** | `notes.get_session_notes_context()` | 紐付いたページのみ。1 ページ `SESSION_NOTES_CONTENT_LIMIT`(既定 8000)文字で打ち切り |
|
||||
| 3 | ローカル KB | `knowledge_base/**.md` から選ばれた**ファイル全文** | `local_knowledge.get_local_kb_context()` | 直近ユーザー発言との cos 類似度上位 `LOCAL_KB_TOP_K`(既定 3)件、かつ `LOCAL_KB_MIN_SCORE`(既定 0.75)以上 |
|
||||
| 4 | 長期メモリ | `memories` の要約を全件連結 | `memory.get_context_messages()` | 上限なし |
|
||||
| 5 | 短期メモリ | セッション内の `messages` 全件(要約済みで削除された分を除く) | 同上 | 上限なし(要約で間接的に制御) |
|
||||
|
||||
層 3 のプロンプトは「Web 検索結果より優先度が高い」「これで答えられるなら検索するな」と明示しており、層 1 より優先される。
|
||||
|
||||
層 2.5 は「重い本文はツールで取りに行かせる」という原則の唯一の例外で、ユーザーが明示的に選んだページだけが対象。
|
||||
`session_note_pages` に行がある間だけ効き、`GET/PUT /chat/sessions/{id}/notes` で読み書きする。
|
||||
新規セッションではフロントがまだ session_id を持てないため、`POST /chat/stream` の `note_page_ids`
|
||||
でも同じ指定を送れるようにしてあり、コンテキストを組み立てる前にサーバー側で反映される。
|
||||
層 2 の一覧では紐付け済みのページに印が付き、同じ本文を `read_note` で読み直させないようにしている。
|
||||
|
||||
#### 要約(長期メモリ化)
|
||||
|
||||
`maybe_summarize()` がアシスタント応答の保存直後に走る。
|
||||
@@ -146,6 +154,7 @@ LLM に渡すコンテキストは `memory_kb/memory.py` の `get_context_messag
|
||||
|
||||
```
|
||||
data: {"type":"session_id","value":"<uuid>"} # 新規セッション時のみ
|
||||
data: {"type":"tool","value":{...}} # ツール実行ごとに開始・完了の2回
|
||||
data: {"type":"notes_updated"} # AIが共有ノートを更新した時のみ
|
||||
data: {"type":"sources","value":[{...}]} # Web検索した時のみ(出典の title/url)
|
||||
data: {"type":"chunk","value":"テキスト断片"} # 0回以上
|
||||
@@ -153,6 +162,13 @@ data: {"type":"done"} # 正常完了
|
||||
data: {"type":"error","value":"エラー内容"} # 例外発生時
|
||||
```
|
||||
|
||||
`tool` イベントは `llm.stream_tool_calls()`(`resolve_tool_calls()` の逐次版)が yield する進行状況を
|
||||
そのまま中継したもので、`{id, name, label, detail, status}` で始まり、同じ `id` の
|
||||
`{id, status:"done", result}` で終わる。検索結果の要約・蓄積知識への保存も
|
||||
`id: "save_knowledge"` の同形式のイベントとして送る。フロント(`ToolActivityList.vue`)は
|
||||
`id` をキーにマージし、アシスタントバブルの上に実行中スピナーつきで一覧表示する。
|
||||
表示専用なので DB には保存せず、履歴を読み直すと消える。
|
||||
|
||||
バッファリング防止のため `Cache-Control: no-cache` と `X-Accel-Buffering: no` を付与する。
|
||||
|
||||
---
|
||||
|
||||
+16
-1
@@ -46,11 +46,14 @@ Discord 連携は [discord-bot.md](discord-bot.md)、ノートの操作方法は
|
||||
## 1. チャット
|
||||
|
||||
- `POST /chat/stream` が SSE を返し、フロントは fetch + ReadableStream で受けて 1 文字ずつ描画する。
|
||||
イベントは `session_id` / `chunk` / `sources` / `notes_updated` / `done` / `error` の 6 種。
|
||||
イベントは `session_id` / `chunk` / `tool` / `sources` / `notes_updated` / `done` / `error` の 7 種。
|
||||
- アシスタントの発言は `marked` + `DOMPurify` で描画する。ストリーミング途中で閉じていないコードフェンスは
|
||||
自動で補完してから描画するので、生成中でもレイアウトが崩れない。
|
||||
- セッションは左サイドバーの一覧から切り替え・削除できる。タイトルは最初の発言の先頭 40 文字。
|
||||
- Web 検索が走った応答には出典(`sources`)が、各メッセージには自動生成されたタグが添えて表示される。
|
||||
- Web 検索・ノートの読み書き・蓄積知識の読み出しといったツール実行は、バブルの上に
|
||||
「🔍 Web検索 / クエリ / ✓ 5件の結果」の形でリアルタイムに表示される(`ToolActivityList.vue`)。
|
||||
実行中はスピナーが回り、応答が途中で切れたツールは「⚠ 中断されました」になる。表示専用で永続化はしない。
|
||||
- 失敗時は赤いバブルとトースト通知の両方で知らせる。
|
||||
|
||||
## 2. セッションの書き出し / 取り込み
|
||||
@@ -68,10 +71,13 @@ Discord 連携は [discord-bot.md](discord-bot.md)、ノートの操作方法は
|
||||
|---|---|---|
|
||||
| 1 蓄積知識 | 過去の Web 検索結果の**見出し一覧のみ**(本文は `read_knowledge` で読む) | 最新 `KNOWLEDGE_CONTEXT_LIMIT`(既定 15)件 |
|
||||
| 2 共有ノート | ページのタイトル一覧+本文先頭 40 文字 | 全ページ(本文は入れない) |
|
||||
| 2.5 参照指定ノート | このチャットに紐付けたページの**本文全文** | 紐付いたページのみ・1 ページ `SESSION_NOTES_CONTENT_LIMIT`(既定 8000)文字 |
|
||||
| 3 ローカル KB | 選ばれた Markdown の**全文** | 類似度上位 `LOCAL_KB_TOP_K`(既定 3)件かつ `LOCAL_KB_MIN_SCORE`(既定 0.75)以上 |
|
||||
| 4 長期メモリ | 要約を全件連結 | 上限なし |
|
||||
| 5 短期メモリ | セッション内の全メッセージ | 上限なし(要約で間接的に制御) |
|
||||
|
||||
層 2.5 だけは例外で、ユーザーが 📌 で選んだページの本文をツールを介さず直接載せる。
|
||||
|
||||
重い情報(ノート本文・蓄積知識の本文・Web 検索)は目次だけを渡し、本体はツール(`read_note` / `write_note` / `read_knowledge` / `web_search`)で
|
||||
取りに行かせる遅延読み込み方式。`llm.resolve_tool_calls()` が本番生成の前に最大 2 ラウンドでこれを解決する。
|
||||
|
||||
@@ -106,6 +112,15 @@ Discord 連携は [discord-bot.md](discord-bot.md)、ノートの操作方法は
|
||||
- AI 側はタイトル一覧だけを常に見ており、`read_note` で本文を読み、`write_note` で追記/全置換/新規作成する。
|
||||
AI が書き換えると SSE の `notes_updated` が飛び、開いているノートパネルが自動で最新化される。
|
||||
- 自分が編集中(未保存)のページは AI の更新で上書きされない。
|
||||
- **取り込み**: `.md` / `.txt` / `.zip` を本文エリアにドロップするか ⬆ ボタンで選ぶとページになる。
|
||||
ZIP はフォルダ名がセクションになるので、⬇ で出した ZIP をそのまま戻せば構成ごと復元される。
|
||||
タイトルが衝突したら `(2)` を足して別ページにするので、既存のページは壊れない。
|
||||
- **チャットへの紐付け**: タブの 📌 を押すと、そのページの本文が**今開いているチャット**のシステム
|
||||
プロンプトに毎回そのまま載る。AI が `read_note` を呼ぶのを待たずに確実に参照させたいときに使う。
|
||||
指定はチャット単位で保存されるので、会話ごとに違う組み合わせを選べる。
|
||||
- **ダウンロード**: パネル下部の ⬇ ボタンで、開いているページを `.md` として、または全ページを
|
||||
ZIP(1 ページ 1 Markdown、セクションはフォルダ、ファイル名の通し番号でタブ順を保持)として
|
||||
手元に保存できる。未保存の編集は書き出す前に保存される。
|
||||
|
||||
## 8-9. 自動タグ付けとワードプール
|
||||
|
||||
|
||||
+64
-1
@@ -18,10 +18,73 @@ API 仕様は `docs/api.md` の「共有ノート」節を参照。
|
||||
| タイトルを変更 | タブを**ダブルクリック**すると入力欄になるので書き換えて Enter(または欄外をクリック) |
|
||||
| ページを削除 | タブ内の **×** をクリック(確認ダイアログあり) |
|
||||
| 本文を編集 | ページを開いた状態で下の編集エリアに直接入力 |
|
||||
| ファイルを取り込む | 本文エリアにファイルをドロップ、またはパネル下部の **⬆ 取り込み** から選択 |
|
||||
| チャットに紐付ける | タブ内の **📌** をクリック(もう一度押すと解除) |
|
||||
| ページを1つ保存 | パネル下部の **⬇ このページ (.md)** をクリック |
|
||||
| 全ページを保存 | パネル下部の **⬇ すべて (.zip)** をクリック |
|
||||
|
||||
本文は入力を止めてから少し待つと自動保存される。保存待ちの間はタブに **●**(未保存マーク)が付く。
|
||||
ページが1つも無い場合は「+ 最初のページを作成」から始められる。
|
||||
|
||||
## ファイルを取り込む
|
||||
|
||||
手元のファイルをページとして取り込める。本文エリアに**ドラッグ&ドロップ**するか、
|
||||
パネル下部の **⬆ 取り込み** からファイルを選ぶ(複数まとめて可)。
|
||||
|
||||
| ファイル | どうなるか |
|
||||
|---|---|
|
||||
| `.md` / `.txt` | 1 ファイルが 1 ページになる。ファイル名がタイトル |
|
||||
| `.zip` | 中のテキストファイルが 1 つずつページになる。フォルダ名がセクションになる |
|
||||
|
||||
**⬇ すべて (.zip) で出した ZIP をそのまま戻せる**ので、バックアップや別環境への引っ越しに使える。
|
||||
ファイル名の `01_` のような通し番号は取り込み時に落とされる。
|
||||
|
||||
既存のページと同じタイトルだった場合は上書きせず、`設計メモ (2)` のように連番を足して別ページを作る。
|
||||
要らない方はタブの × で消せばよい。
|
||||
|
||||
取り込めない拡張子(PDF や画像など)や大きすぎるファイル(1 ファイル 2MB 超)は飛ばされる。
|
||||
1 つも取り込めなかったときだけエラーが表示される。
|
||||
|
||||
## チャットに紐付けて必ず読ませる
|
||||
|
||||
普段、AIに渡っているのは**ページのタイトル一覧だけ**で、本文はAIが必要だと判断したときに
|
||||
`read_note` で読みに行く。つまり「読みに行ってくれないと参照されない」。
|
||||
|
||||
タブの **📌** を押すと、そのページの本文が**今開いているチャット**のプロンプトに毎回そのまま載る。
|
||||
AIの判断を待たずに確実に参照させたい資料(仕様書、設定、前提条件など)に使う。
|
||||
|
||||
📌 が付いたタブは上端に黄色い線が入る。もう一度押すと解除。
|
||||
|
||||
**チャットごとの設定**であることに注意。
|
||||
|
||||
| チャット | 📌 を付けたページ |
|
||||
|---|---|
|
||||
| 「新機能の相談」 | 設計メモ / APIメモ |
|
||||
| 「夕飯どうする」 | 買い物リスト |
|
||||
|
||||
チャットを切り替えると 📌 の状態もそのチャットのものに切り替わる。新規チャットでは
|
||||
📌 を付けてから最初のメッセージを送れば、その1通目からちゃんと反映される。
|
||||
|
||||
長いページは 1 ページ 8000 文字(`SESSION_NOTES_CONTENT_LIMIT`)で打ち切られ、
|
||||
残りが必要ならAIが `read_note` で読み足せる。あれもこれも 📌 すると毎回のリクエストが
|
||||
その分重くなるので、本当に読ませたいページだけに絞るのがよい。
|
||||
|
||||
## 手元にダウンロードする
|
||||
|
||||
パネル下部の ⬇ ボタンでノートをファイルとして保存できる。未保存の編集があっても、
|
||||
保存してから書き出すので取りこぼしはない。
|
||||
|
||||
| ボタン | 出てくるもの |
|
||||
|---|---|
|
||||
| **⬇ このページ (.md)** | 開いているページの本文そのままの Markdown ファイル。ファイル名はページのタイトル |
|
||||
| **⬇ すべて (.zip)** | 全ページをまとめた ZIP。1 ページ 1 Markdown で、セクションはフォルダになる |
|
||||
|
||||
ZIP の中のファイル名には `01_`, `02_` … と通し番号が付く。タブの並び順を残すためで、
|
||||
展開したときも画面と同じ順番で並ぶ。ファイル名に使えない文字(`/` や `:` など)は `_` に置き換わる。
|
||||
|
||||
複数ページを 1 つのファイルに連結せず ZIP にしているのは、ページ内の見出し(`#`)が
|
||||
ページ間の見出しと混ざって階層が壊れるのを避けるため。
|
||||
|
||||
## セクションでまとめる
|
||||
|
||||
複数のページを1つのグループとしてタブ上にまとめられる。
|
||||
@@ -51,7 +114,7 @@ API 仕様は `docs/api.md` の「共有ノート」節を参照。
|
||||
## AIとの連携
|
||||
|
||||
- 全ページの**タイトル一覧**は、会話のたびに自動でAIに渡される(セクションがあれば見出し付きで)。
|
||||
ただし本文はここには含まれない。
|
||||
ただし本文はここには含まれない(📌 を付けたページを除く)。
|
||||
- AIは `read_note` ツールでページ本文を読み、`write_note` ツールで追記・置き換え・新規ページ作成ができる。
|
||||
「ノートに書いておいて」「〇〇について記録して」のように頼むと、AIが該当ページを判断して書き込む。
|
||||
- AIがノートを書き換えると、開いているノートパネルは自動的に最新の内容へ更新される。
|
||||
|
||||
Reference in New Issue
Block a user