AI_assistant.ini ダウンロード/コピー
AI_assistant.ini
AI_assistant.ini
1提供されたファイル `AI_assistant.ini` はPythonコードではなく、INI形式の設定ファイルです。DocstringはPythonのモジュール、クラス、関数、メソッドに付与されるドキュメンテーション文字列であり、Pythonインタプリタによってアクセスされます。したがって、INIファイルに直接Docstringを挿入することは技術的に不可能です。
2
3「既存のコードにDocstringを挿入した完成版のコード全体」というご要望は、このINIファイルには適用できません。
4
5しかし、ご要望の意図を汲み取り、このINIファイルの設定項目をSphinx (reStructuredText) 形式でドキュメント化する一例を以下に示します。これはPythonコードにDocstringを挿入する形式とは異なりますが、設定ファイルの内容をSphinxで説明する際に一般的に用いられるドキュメント形式です。
6
7---
8
9**説明:**
10
11以下は、`AI_assistant.ini` ファイルの内容をSphinx (reStructuredText) 形式で記述したドキュメントです。これはPythonコードに直接埋め込むDocstringではありませんが、設定ファイルの説明としてSphinxドキュメンテーションプロジェクトに含めることができます。
12
13```rst
14.. _ai_assistant_ini_settings:
15
16AIアシスタント設定ファイル (:file:`AI_assistant.ini`)
17=======================================================
18
19このドキュメントは、AIアシスタントアプリケーションで使用される設定ファイル :file:`AI_assistant.ini` の各項目について説明します。
20この設定ファイルは、外部エディタのパス、AI APIの選択、モデル、プロンプトテンプレートなど、アプリケーションの動作を定義するためのパラメータを格納します。
21
22.. seealso::
23 関連するAIアシスタントの利用方法については、次のドキュメントを参照してください: :doc:`AI_assistant_usage`
24
25.. sectnum::
26
27Settings セクション
28-------------------
29AIアシスタントの主要な動作パラメータを設定するセクションです。
30
31.. hlist::
32 :columns: 1
33
34 * `editor_executable` (:class:`str`)
35 AIアシスタントが生成したコンテンツを開く際に使用する外部エディタの実行可能ファイルのパスを指定します。
36 **例:** :samp:`D:/App/App/Editor/WZEditor64/wzeditor.exe`
37
38 * `input_file` (:class:`str`)
39 AIアシスタントが処理する入力ファイルのパスを指定します。この項目が空の場合、入力は手動で提供されるか、直前の出力が使用される場合があります。
40
41 * `api_selection` (:class:`str`)
42 使用するAIサービスプロバイダを選択します。これにより、利用可能なAIモデルや機能が決定されます。
43 **利用可能な選択肢:** `OpenAI`, `Anthropic`, etc.
44 **例:** :samp:`OpenAI`
45
46 * `model_selection` (:class:`str`)
47 選択したAIサービスプロバイダが提供するAIモデルの名前を指定します。使用可能なモデルは `api_selection` に依存します。
48 **例:** `gpt-4o`, `gpt-5`, `claude-3-opus-20240229`
49 **設定例:** :samp:`gpt-5`
50
51 * `temperature` (:class:`float`)
52 AIの応答のランダム性を制御する浮動小数点数です。0.0から2.0の範囲で、値が高いほどAIの応答は多様で創造的になります。0.0に近いほど予測可能で一貫性のある応答になります。
53 **設定例:** :samp:`0.7`
54
55 * `max_bytes` (:class:`int`)
56 AIへの入力として送信できる最大バイト数を指定します。この制限を超える場合、入力コンテンツは自動的に切り詰められる可能性があります。
57 **設定例:** :samp:`200000`
58
59 * `role_selection` (:class:`str`)
60 AIに割り当てる役割またはペルソナを選択します。これはAIの応答スタイル、専門知識、およびトーンに大きく影響を与えます。
61 **利用可能な選択肢:** `科学技術の専門家`, `ソフトウェアエンジニア`, `クリエイティブライター` など、アプリケーションで定義された役割。
62 **設定例:** :samp:`科学技術の専門家`
63
64 * `prompt_template_selection` (:class:`str`)
65 使用するプロンプトテンプレートを選択します。これにより、`current_prompt_text` の初期値が設定され、特定のタスクに適した基本的な指示が提供されます。
66 **利用可能な選択肢:** `技術文書の修正`, `コードレビュー`, `ブログ記事作成` など、アプリケーションで定義されたテンプレート。
67 **設定例:** :samp:`技術文書の修正`
68
69 * `current_prompt_text` (:class:`str`)
70 AIへの現在のプロンプトテキストを記述します。複数行にわたる長いプロンプトも指定可能です。この項目は `prompt_template_selection` で選ばれたテンプレートに基づいて初期化され、ユーザーが追加でカスタマイズできます。
71 **設定例:**
72 .. parsed-literal::
73 あなたは科学技術の専門家です。
74 古典力学、古典統計力学の完成から、それらの問題を通して量子力学が成立するまでの歴史を、なるべく数式を入れて詳しく説明してください。
75 回答はMarkdown形式で返し、数式はpandocでdocxに変換できるように$$~$$ブロックのLaTeX形式で出力してください。また、年表の出力に際しては、原論文を引用できるように雑誌、ページ等のreferenceも入れてください
76
77 * `output_file` (:class:`str`)
78 AIの応答を保存する出力ファイルのパスを指定します。ファイルは指定されたパスに自動的に作成または上書きされます。
79 **設定例:** :samp:`g:/qm2.md`
80
81 * `reasoning_effort` (:class:`str`)
82 AIの推論の努力レベルを制御します。これにより、AIが応答を生成する際の思考の深さが変わります。
83 **利用可能な選択肢:** `(auto)`, `low`, `medium`, `high`
84 **設定例:** :samp:`(auto)`
85
86 * `verbosity` (:class:`str`)
87 アプリケーションのログ出力の詳細レベルを指定します。これにより、コンソールやログファイルに出力される情報の量が変わります。
88 **利用可能な選択肢:** `silent`, `short`, `long`
89 **設定例:** :samp:`long`
90```