docs: 開発中の v2 の内容にアップデート (#187)

approvers · Jan 8, 2024 · 87603e6 · 87603e6
1 parent 9e39705
commit 87603e6
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ LaMDA, PaLM2 の後継として供し, Gemini Ultra, Gemini Pro, Gemini Nano か
 | モデル名 | ichiyoAI の対応バージョン | Input | Output | Price |
 | --- | --- | --- | --- | --- |
 | Gemini Pro | `v2.0.0` 〜 | Text | Text | Free |
-| Gemini Pro Vision | 未対応(`*`) | Text and Image | Text | Free |
+| Gemini Pro Vision | 未対応 | Text and Image | Text | Free |
 
 ### DALL-E
 
@@ -106,3 +106,5 @@ docker pull ghcr.io/approvers/ichiyo_ai:vX.Y.Z
 | `OPENAI_API_KEY`    | OpenAI API のトークン  | `Yes`    |
 | `GUILD_ID`          | 限界開発鯖の ID         | `Yes`    |
 | `SPONSOR_ROLE_ID`   | 購読者ロールの ID        | `Yes`     |
+| `GOOGLE_AI_API_KEY` | Google AI Studio のトークン | `Yes`     |
+| `SENTRY_DSN`        | Sentry の DSN           | `No`     |
diff --git a/docs/src/README.md b/docs/src/README.md
@@ -1,7 +1,3 @@
-> **注意**:
-> このドキュメントサイトは ichiyoAI v2.0.0 以降のバージョンに対応しています.
-> v1.19.0 以前のバージョンに関する情報は提供されていません.
-
 # はじめに
 
 **Welcome to ichiyoAI documentation!**

diff --git a/docs/src/how-to/image-generation.md b/docs/src/how-to/image-generation.md
@@ -10,16 +10,13 @@ ichiyoAI は DALL-E を利用した画像生成に対応しています.
 `/image` コマンドを使用して画像生成を行うことができます.
 
 ```md
-/image <size> <count> <model> [prompt]
+/image [model] [prompt]
 ```
 
-- `size`: 生成する画像のサイズを指定します.
-- `count`: 生成する画像の枚数を指定します.
 - `model`: 生成に使用するモデルを指定します. `dalle-2` または `dalle-3` を指定できます.
 - `prompt`: 生成する画像のテキストを指定します.
 
 ## 注意事項
 
 - DALL-E の倫理コードに引っかかるような不適切なプロンプトは実行できません.
-- 画像は右クリックメニューから 画像を保存する ( Save Image ) を選ぶか, 生成結果 をクリックしてアクセス出来るサイトからダウンロードしてください.
-  - 時間が経過した画像については Cache が消失してダウンロードできない場合があります.
+- 画像は右クリックメニューから 画像を保存する ( Save Image ) で保存できます.
diff --git a/docs/src/how-to/text-generation.md b/docs/src/how-to/text-generation.md
@@ -3,15 +3,11 @@
 ichiyoAI は ChatGPT, Gemini を利用したテキスト生成に対応しています.
 
 - [使用方法](#使用方法)
-  - [Message Command](#message-command)
-  - [メンション (Legacy)](#メンション-legacy)
 - [返信モード](#返信モード)
 - [注意事項](#注意事項)
 
 ## 使用方法
 
-### Message Command
-
 ichiyoAI に送信するプロンプトメッセージに対して Message Command を送信することで, テキスト生成を行うことができます.
 
 Message Command は以下のように構成されています. 使用するモデルに合わせてコマンドを選んでください.
@@ -20,19 +16,20 @@ Message Command は以下のように構成されています. 使用するモ
 | --- | --- |
 | GPT-4 Turbo | `Text (GPT-4 Turbo)` |
 | GPT-3.5 Turbo | `Text (GPT-3.5 Turbo)` |
-| Gemini | `Text (Gemini)` |
+| Gemini Pro | `Text (Gemini Pro)` |
 
-### メンション (Legacy)
+( `GPT-4 Turbo` は限界税への納税が必要です. 詳しくは [こちら](../premium-access.md) を参照してください.)
 
-v1.19.0 以前の方法です. この方法は今後削除される可能性があります.
+Message Command はメッセージに対して右クリック (モバイル版では長押し) すると表示されるコンテキストメニューから利用できます.
 
-ichiyoAI にメンションを送信することで, テキスト生成を行うことができます. ただしこの方法は **GPT-4 Turbo, GPT-3.5 Turbo のみ対応しています**. Gemini は対応していません.
+![コンテキストメニュー](../image/how-to/message-context-menu.png)
 
 ## 返信モード
 
-ichiyoAI のメッセージに対してメンション付きで返信すると, 返信元のリプライまで ChatGPT, Gemini が理解した上で応答します.
+ichiyoAI のメッセージに対してメンション付きで返信し, そのメッセージに対して Message Command を使用すると返信元のリプライまで ChatGPT, Gemini が理解した上で応答します.
 
 ## 注意事項
 
-- OpenAI API 側からのレスポンスの文字数が 2000 文字を超えた場合, Discord API の仕様上 ichiyoAI は返信せずに終了します.
-- OpenAI API へリクエストを送ってから3分以上かかった場合は tokio により自動的にタイムアウトになります。もう一度送るか、内容を見直してみてください。
+- v1.21.1 以前に利用できたメンションでの Text Generation は廃止されました. かわりに [Message Command](#使用方法) を利用してください.
+- API 側からのレスポンスの文字数が 2000 文字を超えた場合, Discord API の仕様上 ichiyoAI は返信せずに終了します.
+- API へリクエストを送ってから1分以上かかった場合は自動的にタイムアウトになります。もう一度送るか、内容を見直してみてください。
diff --git a/docs/src/image/how-to/message-context-menu.png b/docs/src/image/how-to/message-context-menu.png
diff --git a/docs/src/premium-access.md b/docs/src/premium-access.md
@@ -15,9 +15,8 @@ ichiyoAI では一部のモデルにおいて **限界税** を納税したユ
 
 ## 利用できるモデル一覧
 
-- GPT-4
+- GPT-4 Turbo
 - DALL-E 3
-- Gemini Ultra
 
 ## モデルの比較