AI_assistant プログラム仕様

AI Assistantアプリケーション

このモジュールは、AIモデルとの対話を通じてテキスト処理を行うGUIアプリケーションを提供します。 エディタの選択、入力テキストファイルの指定、AIモデルとAPIの選択、カスタムプロンプトの定義、 そしてAIクエリの実行と結果のファイル保存・表示といった機能が含まれます。 設定はINIファイルとして保存され、次回起動時に自動で読み込まれます。

関連リンク: AI Assistant Technical Documentation (もし利用ガイドドキュメントがあれば)

class AI_assistant.AIEditorApp(master)

ベースクラス: object

AIアシスタントアプリケーションのメインウィンドウとUIを管理するクラス。

UIコンポーネントの構築、設定ファイルの読み込みと保存、AIクエリの実行、 および関連するユーザーインタラクションのハンドリングを行う。

apply_verbosity(base_prompt, verbosity)

Verbosity設定に基づいてプロンプトに指示を追加します。

APIのパラメータとしてではなく、プロンプトテキスト自体に 「簡潔に」「詳しく」といった指示を追加し、生成AIの出力スタイルを制御します。

パラメータ:
  • base_prompt (str) -- (str) 元のプロンプト文字列。

  • verbosity (str) -- (str) Verbosity設定(例: "short", "normal", "long", "(default)")。

戻り値:

(str) Verbosity指示が追加されたプロンプト文字列。

戻り値の型:

str

browse_editor_executable()

エディタ実行可能ファイルを選択するためのファイルダイアログを開きます。

ユーザーが選択したファイルのパスをエディタ実行可能ファイル入力フィールドに設定します。

browse_input_file()

入力テキストファイルを選択するためのファイルダイアログを開きます。

ユーザーが選択したファイルのパスを入力ファイル入力フィールドに設定し、 出力ファイルのパスも自動生成して設定します。

browse_output_file()

出力ファイルを選択または保存するためのファイルダイアログを開きます。

ユーザーが選択したファイルのパスを出力ファイル入力フィールドに設定します。 既存の入力ファイルに基づいて初期ディレクトリとファイル名を提案します。

create_widgets()

アプリケーションのユーザーインターフェース (UI) 要素を構築します。

エディタ設定、入出力ファイル設定、API/モデル選択、Role/Prompt設定、 パラメータ設定、アクションボタン、ステータスバーなど、 すべてのTkinterウィジェットを作成し配置します。

display_selected_prompt_template(event=None)

選択されたプロンプトテンプレートの説明に基づいて、プロンプトテキストエリアに内容を追加します。

prompt_template_combobox で選択されたプロンプトテンプレートの内容を prompt_text_area の現在の内容の末尾に追加します。

パラメータ:

event (tk.Event or None) -- (tk.Event, optional) Tkinterイベントオブジェクト。デフォルトはNone。

display_selected_role_prompt(event=None)

選択されたロールの説明に基づいて、プロンプトテキストエリアの内容を更新します。

role_combobox で選択されたロールに対応するプロンプトを prompt_text_area に表示します。

パラメータ:

event (tk.Event or None) -- (tk.Event, optional) Tkinterイベントオブジェクト。デフォルトはNone。

generate_default_output_file_path(input_file_path)

入力ファイルパスからデフォルトの出力ファイルパスを生成します。

入力ファイル名に "-output.txt" を追加した形式で、 同じディレクトリに出力ファイルパスを生成します。

パラメータ:

input_file_path (str) -- (str) 入力ファイルのパス。

戻り値:

(str) 生成されたデフォルトの出力ファイルパス。

戻り値の型:

str

load_config()

設定ファイル (.ini) を読み込みます。

アプリケーションの設定ファイル config.ini を読み込み、configparser オブジェクトに格納します。 chardetでエンコーディングを自動検出します。

load_ini_file(filename)

指定されたINI形式のファイルを読み込み、辞書型リストに変換します。

chardetを使用してファイルエンコーディングを自動検出します。 desc="value" 形式の行をキーとし、その後の行をプロンプトコンテンツとして解釈し、 リストに格納します。行頭が'#'で始まる場合はコメント行として無視します。

パラメータ:

filename (str) -- (str) 読み込むINIファイルの名前。

戻り値:

(list[dict]) 読み込んだ内容を {"desc": "...", "prompt": "..."} の形式で格納したリスト、またはエラー時に空リスト。

戻り値の型:

list[dict]

load_initial_settings()

アプリケーション起動時に保存された設定をUIにロードします。

config.ini から読み込んだ設定値に基づいて、エディタパス、ファイルパス、 API選択、モデル選択、パラメータ、ロール、プロンプトテキストエリアなどの UI要素を初期状態に設定します。

on_closing()

アプリケーションが閉じられる際の処理を行います。

現在の設定を保存し、Tkinterウィンドウを破棄します。

on_gripper_drag(event)

プロンプトテキストエリアのリサイズグリッパーがドラッグされたときの処理を行います。

グリッパーのドラッグ量に応じて、プロンプトテキストエリアの高さを動的に変更します。

パラメータ:

event (tk.Event) -- (tk.Event) マウスドラッグイベントオブジェクト。

on_gripper_press(event)

プロンプトテキストエリアのリサイズグリッパーが押されたときの処理を開始します。

グリッパーのドラッグ操作を開始するための初期座標とテキストエリアの高さ情報を保存します。

パラメータ:

event (tk.Event) -- (tk.Event) マウスボタン押下イベントオブジェクト。

run_query_logic()

AIクエリのメインロジックを実行します。

入力ファイルの読み込み、プロンプトの構築、APIへのリクエスト送信、 応答の保存、および結果の表示を処理します。 エラーハンドリングとUI更新をメインスレッドにディスパッチします。

save_config()

現在の設定を構成ファイル (.ini) に保存します。

UIの各ウィジェットから現在の設定値を取得し、 アプリケーション終了時やクエリ実行時に config.ini へ書き込みます。

start_query_thread()

AIクエリ処理を新しいスレッドで開始します。

UIをブロックしないように、実際のクエリロジックを別スレッドで実行します。 ステータスバーを更新し、クエリボタンを無効化します。

update_model_list(event=None, refresh_from_api=True)

選択されたAPIプロバイダに基づいてモデルリストを更新します。

まず組み込みのモデルリストをUIに表示し、その後、新しいスレッドでLiteLLM経由で APIから最新のモデルリストを非同期に取得し、UIを更新します。

パラメータ:
  • event (tk.Event or None) -- (tk.Event, optional) Tkinterイベントオブジェクト(ComboboxSelectedイベントから呼ばれる場合)。デフォルトはNone。

  • refresh_from_api (bool) -- (bool) APIからモデルリストを再読み込みするかどうか。デフォルトはTrue。

view_file(file_path)

指定されたファイルを外部エディタで開きます。

設定されたエディタ実行可能ファイルを使用して、指定されたパスのファイルを開きます。 エディタが設定されていない場合やファイルが存在しない場合は警告メッセージを表示します。

パラメータ:

file_path (str) -- (str) 開くファイルのパス。