AIエージェント活用事例
Views —

AIエージェント活用事例

今日の新着

44すべて 189件

全189件中 1〜20件

開発・コーディング実装例

Pythonファイルを読み取りREADMEと関数説明の下書きを作成する

著者は関数やクラスの構造を読み取り、利用案内ドキュメントと説明を付けたPythonファイルを別途作成したと報告しています。

LangChain

使い方

  1. --fileで対象ファイルを指定し、--formatでreadme、docstrings、またはbothを選択したといいます。
  2. プログラムが関数やクラスの構造を抽出した後、モデルにインストール方法、使用例、API説明の作成を依頼したそうです。関数説明モードでは全コードをモデルに渡したとされています。
  3. ドキュメントはREADME_モジュール名.mdとして、説明が追加されたコードはdocumented_ファイル名として保存されたといいます。元のファイルに直接上書きはしなかったとのことです。

結果

これはドキュメントと関数説明が含まれるファイルを生成した実装例だと著者は述べています。生成されたコードの動作維持やドキュメント内の例の自動検証は行われていないそうです。

補足

README作成時にモデルへ渡すコード本文は最初の3000文字に制限されていると著者は説明しています。長いファイルの後半の動作がドキュメントから抜け落ちる可能性があるため、別途確認が必要だとされています。

出典

GitHub 原文 ↗

プロンプト例 · LangChain

[Pythonモジュール]用のREADMEと関数説明の下書きを作成してください。agents/16-documentation-writerの構造抽出およびドキュメント生成コードを参考にし、Python環境とモデルAPI設定を整理します。結果は[空の出力フォルダ]に保存してください。

実際の関数名、入力値、返り値、例外はコードから確認して説明し、公開されていないインストールコマンドや環境変数は作成しないでください。元のREADMEパスではコード本文が3000文字までしか渡せないため、長いファイルは抜け落ちがないか確認し、分割して読み込むよう補完してください。説明が追加されたコードは元ファイルとは別のファイルにしてください。

同期・非同期関数、デフォルト値や例外のある小規模モジュールで検査します。ドキュメント内の例は作業用コピーで実行し、関数説明以外で動作が変わっていないか元ファイルと比較してください。成果物はREADME、説明追加ファイル、差分比較、実行記録です。まだ実行していない使用例を検証済みと記載せず、今回補完した長いファイル処理と検証範囲を区別してください。