make_textbook5 プログラム仕様

AI処理専用:講義テキスト(文字起こし)とスライドMarkdownから教科書用/スライド用Markdownを生成します。

LiteLLMを通してOpenAIとGoogle(Gemini)を統一的に呼び出します。 既存のmessages構築とログ保存形式は維持します。 AIに渡すmessagesを .log ファイルに保存します。

make_textbook5.py 技術ドキュメント

ai.make_textbook5.build_messages(api_choice: str, system_instructions: str, lecture_text: str, slide_markdown: str, final_instruction: str)

指定されたAPI形式に基づいてAIへのメッセージリストを構築します。

OpenAI形式 (role を分けてメッセージを構築) と Google/Gemini形式 (単一の user メッセージに結合) の両方に対応します。

パラメータ:
  • api_choice -- str: 使用するAIのAPI選択肢 ('openai', 'openai5', 'lmstudio', 'gemini', 'google')。

  • system_instructions -- str: AIへのシステム指示。

  • lecture_text -- str: 講義の文字起こしテキスト。

  • slide_markdown -- str: 講義スライドのMarkdownテキスト。

  • final_instruction -- str: AIへの最終指示。

戻り値:

list: 構築されたAIメッセージのリスト。

ai.make_textbook5.call_ai_api(messages: list, api_choice: str, model_name: str, reasoning_effort: str | None = None) → str | None

LiteLLMライブラリを介してAIサービスを呼び出し、応答テキストを返します。

OpenAI, Gemini, LM Studioなどのプロバイダーに対応し、LM Studio (Qwen3.8) の reasoning_effort パラメータも処理します。

パラメータ:
  • messages -- list: AIに送信するメッセージのリスト。

  • api_choice -- str: 使用するAIのAPI選択肢。

  • model_name -- str: 使用するAIモデルの名前。

  • reasoning_effort -- str or None, optional: LM StudioのQwen3.8で使用する推論量 ('low', 'medium', 'xhigh')。デフォルトはNone。

戻り値:

str or None: AIからの応答本文、またはエラーが発生した場合はNone。

ai.make_textbook5.main()

スクリプトの主要な処理フローを制御します。

コマンドライン引数を解析し、出力ファイル名を決定した後、AI処理関数 run_ai_processing を呼び出します。

戻り値:

None

ai.make_textbook5.parse_args()

コマンドライン引数を解析し、AI設定を読み込みます。

ai.env からAI設定を読み込み、INIファイルからプロンプトテンプレートを読み込みます。 モデル名の指定ロジックを含みます。

戻り値:

tuple: argparse.ArgumentParser オブジェクトと解析された引数を格納した argparse.Namespace オブジェクトのタプル。

ai.make_textbook5.read_ini(inifile=None)

INIファイルから設定を読み込みます。

key=val 形式の設定を解析し、複数行の値 (三重クォート) や $VAR 形式の変数展開をサポートします。

パラメータ:

inifile -- str, optional: 読み込むINIファイルのパス。デフォルトはNone。

戻り値:

dict: 読み込まれた設定を格納した辞書。

例外:

FileNotFoundError -- INIファイルが見つからなかった場合。

ai.make_textbook5.run_ai_processing(infile: str, in_slide_file: str, textbook_file: str, slide_file: str, args: Namespace)

AIによる教科書とスライドの生成処理を実行し、結果をファイルに保存します。

入力ファイルからテキストを読み込み、指定された言語と専門分野に基づいてプロンプトを構築します。 AIの応答から教科書とスライドのセクションを抽出し、それぞれのファイルに書き込みます。

パラメータ:
  • infile -- str: 講義の文字起こしテキストファイルのパス。

  • in_slide_file -- str: 入力スライドMarkdownファイルのパス。

  • textbook_file -- str: 出力する教科書Markdownファイルのパス。

  • slide_file -- str: 出力するスライドMarkdownファイルのパス。

  • args -- argparse.Namespace: 解析されたコマンドライン引数。

戻り値:

None

ai.make_textbook5.save_messages_log(messages: list, infile: str)

AIに送信するメッセージをJSON形式でログファイルに保存します。

入力ファイル名に基づいてログファイル名 (.log) を生成し、メッセージ内容をUTF-8エンコーディングで保存します。

パラメータ:
  • messages -- list: 保存するAIメッセージのリスト。

  • infile -- str: 入力ファイルのパス。ログファイル名の基盤として使用されます。

戻り値:

None

ai.make_textbook5.search_file(infile=None)

指定されたファイルを現在のディレクトリまたはスクリプトのディレクトリから検索します。

infile が指定されていない場合、スクリプト名に基づいたINIファイルを検索します。

パラメータ:

infile -- str, optional: 検索するファイルパス。デフォルトはNone。

戻り値:

str or None: 見つかったファイルの絶対パス、または見つからなかった場合はNone。

ai.make_textbook5.select_model(args: Namespace) → str

コマンドライン引数とAPI選択に基づいて使用するAIモデル名を決定します。

--model オプションが指定されている場合はそれを優先し、それ以外の場合はAPI種別に応じたデフォルトモデル または環境変数のモデルを選択します。

パラメータ:

args -- argparse.Namespace: 解析されたコマンドライン引数。

戻り値:

str: 選択されたAIモデル名。

例外:

ValueError -- 未対応のAPIが指定された場合。

ai.make_textbook5.terminate()

スクリプトを終了します。

pause グローバル変数が1の場合、ユーザーにEnterキーの入力を求めます。

戻り値:

None