AI補完設定¶
このページでは、agents-sdk-modelsのAI補完機能を設定する方法を説明します。
概要¶
agents-sdk-modelsでは、以下のファイルを自動生成して、IDE やエディターでのAI補完をサポートしています:
openai_tools.json
- OpenAI Agents SDK用のツール定義.aidef
- 汎用的なAI定義ファイルpy.typed
- 型情報の提供
自動生成¶
ツール定義ファイルの生成¶
このスクリプトは以下のファイルを生成します:
- openai_tools.json - OpenAI Agents SDK向けのツール定義
- .aidef - 汎用的なAI定義(マークダウン形式)
生成されるファイルの例¶
openai_tools.json¶
{
"tools": [
{
"type": "function",
"function": {
"name": "agents_sdk_models.pipeline.Pipeline.run",
"description": "Run the pipeline with given prompt and configuration",
"parameters": {
"type": "object",
"properties": {
"prompt": {
"type": "str",
"description": "Parameter prompt"
},
"llm": {
"type": "LLM",
"description": "Parameter llm"
}
},
"required": ["prompt", "llm"]
}
}
}
]
}
.aidef¶
# AI Definition for agents-sdk-models
# agents-sdk-modelsのAI定義
## Module: agents_sdk_models.pipeline
### Classes / クラス
- **Pipeline**: Main pipeline class for processing prompts
- Methods / メソッド:
- `run`: Run the pipeline with given prompt and configuration
- `add_step`: Add a processing step to the pipeline
IDEでの設定¶
VS Code¶
-
Python型チェック
-
AI補完設定(Cursor)
.aidef
ファイルが自動的に認識されますopenai_tools.json
はOpenAI Agents SDK設定で利用されます
PyCharm¶
- Type hintingの有効化
- Settings → Editor → Inspections → Python → Type checker
-
"Mypy" を有効にする
-
外部ツール設定
型チェック¶
基本設定¶
pyproject.toml
にmypy設定が含まれています:
[tool.mypy]
strict = true
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
# ... その他の設定
実行方法¶
CI/CDでの自動実行¶
GitHub Actionsで自動的にAI補完ファイルを生成・検証:
- name: Generate AI tool definitions
run: |
uv run python scripts/generate_ai_tools.py
# Verify files were generated
test -f openai_tools.json && echo "✓ openai_tools.json generated"
test -f .aidef && echo "✓ .aidef generated"
カスタマイズ¶
対象モジュールの変更¶
scripts/generate_ai_tools.py
のmodules
リストを編集:
modules = [
"agents_sdk_models.pipeline",
"agents_sdk_models.llm",
"agents_sdk_models.context",
# 新しいモジュールを追加
"agents_sdk_models.your_new_module",
]
出力形式のカスタマイズ¶
生成スクリプトを編集して、出力形式をカスタマイズできます:
トラブルシューティング¶
よくある問題¶
-
モジュールのインポートエラー
→ 新しいモジュールを追加した場合、scripts/generate_ai_tools.py
の対象リストを更新 -
型情報が認識されない
→py.typed
ファイルが正しく配置されているか確認 -
AI補完が効かない →
.aidef
ファイルが最新の状態か確認し、IDEを再起動
デバッグ方法¶
# 生成スクリプトをデバッグモードで実行
uv run python scripts/generate_ai_tools.py --verbose
# 型チェックの詳細出力
uv run mypy --verbose src/agents_sdk_models/
# 生成されたファイルの検証
cat openai_tools.json | jq .
head -20 .aidef
貢献¶
AI補完機能の改善にご協力ください:
- 新しいAI定義形式の提案
- 生成スクリプトの機能追加
- IDE固有の設定例の提供
- ドキュメントの改善