APIリファレンス¶
このページでは、mkdocstringsプラグインを使用してagents_sdk_models
パッケージのAPIリファレンスを自動生成します。
Agents SDK Models エージェントSDKモデル
AgentPipeline
¶
AgentPipeline class for managing the generation and evaluation of content using OpenAI Agents SDK OpenAI Agents SDKを使用してコンテンツの生成と評価を管理するパイプラインクラス
.. deprecated:: 0.0.22 AgentPipeline is deprecated and will be removed in v0.1.0. Use GenAgent with Flow/Step architecture instead. See migration guide: docs/deprecation_plan.md
This class handles: このクラスは以下を処理します: - Content generation using instructions / instructionsを使用したコンテンツ生成 - Content evaluation with scoring / スコアリングによるコンテンツ評価 - Session history management / セッション履歴の管理 - Output formatting and routing / 出力のフォーマットとルーティング
Preferred alternative: 推奨代替手段: - Use GenAgent for single-step pipeline functionality - Use Flow/Step architecture for complex workflows - See examples/gen_agent_example.py for migration examples
Source code in src\agents_sdk_models\pipeline.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
|
__init__(name, generation_instructions, evaluation_instructions, *, input_guardrails=None, output_guardrails=None, output_model=None, model=None, evaluation_model=None, generation_tools=None, evaluation_tools=None, routing_func=None, session_history=None, history_size=10, threshold=85, retries=3, improvement_callback=None, dynamic_prompt=None, retry_comment_importance=None, locale='en')
¶
Initialize the Pipeline with configuration parameters 設定パラメータでパイプラインを初期化する
.. deprecated:: 0.0.22 AgentPipeline is deprecated and will be removed in v0.1.0. Use GenAgent with Flow/Step architecture instead. See migration guide: docs/deprecation_plan.md
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Pipeline name / パイプライン名 |
required |
generation_instructions
|
str
|
System prompt for generation / 生成用システムプロンプト |
required |
evaluation_instructions
|
Optional[str]
|
System prompt for evaluation / 評価用システムプロンプト |
required |
input_guardrails
|
Optional[list]
|
Guardrails for generation / 生成用ガードレール |
None
|
output_guardrails
|
Optional[list]
|
Guardrails for evaluation / 評価用ガードレール |
None
|
output_model
|
Optional[Type[Any]]
|
Model for output formatting / 出力フォーマット用モデル |
None
|
model
|
str | None
|
LLM model name / LLMモデル名 |
None
|
evaluation_model
|
str | None
|
Optional LLM model name for evaluation; if None, uses model. 日本語: 評価用のLLMモデル名(Noneの場合はmodelを使用) |
None
|
generation_tools
|
Optional[list]
|
Tools for generation / 生成用ツール |
None
|
evaluation_tools
|
Optional[list]
|
Tools for evaluation / 評価用ツール |
None
|
routing_func
|
Optional[Callable[[Any], Any]]
|
Function for output routing / 出力ルーティング用関数 |
None
|
session_history
|
Optional[list]
|
Session history / セッション履歴 |
None
|
history_size
|
int
|
Size of history to keep / 保持する履歴サイズ |
10
|
threshold
|
int
|
Evaluation score threshold / 評価スコアの閾値 |
85
|
retries
|
int
|
Number of retry attempts / リトライ試行回数 |
3
|
improvement_callback
|
Optional[Callable[[Any, EvaluationResult], None]]
|
Callback for improvement suggestions / 改善提案用コールバック |
None
|
dynamic_prompt
|
Optional[Callable[[str], str]]
|
Optional function to dynamically build prompt / 動的プロンプト生成関数(任意) |
None
|
retry_comment_importance
|
Optional[list[str]]
|
Importance levels of comments to include on retry / リトライ時にプロンプトに含めるコメントの重大度レベル(任意) |
None
|
locale
|
str
|
Language code for localized messages ("en" or "ja") |
'en'
|
Source code in src\agents_sdk_models\pipeline.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
|
run(user_input)
¶
Run the pipeline with user input ユーザー入力でパイプラインを実行する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
str
|
User input text / ユーザー入力テキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Any |
Processed output or None if evaluation fails / 処理済み出力、または評価失敗時はNone |
Source code in src\agents_sdk_models\pipeline.py
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
|
AgentPipelineStep
¶
Bases: Step
Step that wraps AgentPipeline for use in Flow FlowでAgentPipelineを使用するためのラッパーステップ
This step allows using existing AgentPipeline instances as flow steps. このステップは既存のAgentPipelineインスタンスをフローステップとして使用できます。
Source code in src\agents_sdk_models\step.py
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
|
__init__(name, pipeline, next_step=None)
¶
Initialize agent pipeline step エージェントパイプラインステップを初期化
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
pipeline
|
Any
|
AgentPipeline instance / AgentPipelineインスタンス |
required |
next_step
|
Optional[str]
|
Next step after pipeline execution / パイプライン実行後の次ステップ |
None
|
Source code in src\agents_sdk_models\step.py
359 360 361 362 363 364 365 366 367 368 369 370 371 |
|
run(user_input, ctx)
async
¶
Execute agent pipeline step エージェントパイプラインステップを実行
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input / ユーザー入力 |
required |
ctx
|
Context
|
Current context / 現在のコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context / 更新済みコンテキスト |
Source code in src\agents_sdk_models\step.py
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
|
ClarificationQuestion
dataclass
¶
Represents a clarification question from the pipeline パイプラインからの明確化質問を表現するクラス
Attributes:
Name | Type | Description |
---|---|---|
question |
str
|
The clarification question text / 明確化質問テキスト |
turn |
int
|
Current turn number / 現在のターン番号 |
remaining_turns |
int
|
Remaining turns / 残りターン数 |
Source code in src\agents_sdk_models\clearify_pipeline.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
|
__str__()
¶
String representation of the clarification question 明確化質問の文字列表現
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Formatted question with turn info / ターン情報付きフォーマット済み質問 |
Source code in src\agents_sdk_models\clearify_pipeline.py
73 74 75 76 77 78 79 80 81 |
|
ClaudeModel
¶
Bases: OpenAIChatCompletionsModel
Anthropic Claude model implementation that extends OpenAI's chat completions model OpenAIのチャット補完モデルを拡張したAnthropic Claudeモデルの実装
Source code in src\agents_sdk_models\anthropic.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
|
__init__(model='claude-3-5-sonnet-latest', temperature=0.3, api_key=None, base_url='https://api.anthropic.com/v1/', thinking=False, **kwargs)
¶
Initialize the Anthropic Claude model with OpenAI compatible interface OpenAI互換インターフェースでAnthropic Claudeモデルを初期化する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
str
|
Name of the Claude model to use (e.g. "claude-3-5-sonnet-latest") 使用するClaudeモデルの名前(例:"claude-3-5-sonnet-latest") |
'claude-3-5-sonnet-latest'
|
temperature
|
float
|
Sampling temperature between 0 and 1 サンプリング温度(0から1の間) |
0.3
|
api_key
|
str
|
Anthropic API key Anthropic APIキー |
None
|
base_url
|
str
|
Base URL for the Anthropic OpenAI compatibility API Anthropic OpenAI互換APIのベースURL |
'https://api.anthropic.com/v1/'
|
thinking
|
bool
|
Enable extended thinking for complex reasoning 複雑な推論のための拡張思考を有効にする |
False
|
**kwargs
|
Any
|
Additional arguments to pass to the OpenAI API OpenAI APIに渡す追加の引数 |
{}
|
Source code in src\agents_sdk_models\anthropic.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
|
Clearify
¶
Bases: ClearifyBase
Default clarification output with string user requirement 文字列ユーザー要求を持つデフォルト明確化出力
Attributes:
Name | Type | Description |
---|---|---|
clearity |
bool
|
True if requirements are confirmed / 要件が確定した場合True |
user_requirement |
Optional[str]
|
Confirmed user requirement as string / 文字列として確定したユーザー要求 |
Source code in src\agents_sdk_models\clearify_pipeline.py
46 47 48 49 50 51 52 53 54 55 |
|
ClearifyBase
¶
Bases: BaseModel
Base class for requirement clarification output 要件明確化出力のベースクラス
Attributes:
Name | Type | Description |
---|---|---|
clearity |
bool
|
True if requirements are confirmed / 要件が確定した場合True |
Source code in src\agents_sdk_models\clearify_pipeline.py
25 26 27 28 29 30 31 32 33 |
|
ClearifyPipeline
¶
Bases: AgentPipeline
ClearifyPipeline class for requirements clarification using OpenAI Agents SDK OpenAI Agents SDKを使用した要件明確化パイプラインクラス
This class extends AgentPipeline to handle: このクラスはAgentPipelineを拡張して以下を処理します: - Iterative requirement clarification / 反復的な要件明確化 - Type-safe output wrapping / 型安全な出力ラッピング - Maximum turn control / 最大ターン数制御 - Structured requirement extraction / 構造化された要求抽出
Source code in src\agents_sdk_models\clearify_pipeline.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 |
|
conversation_history
property
¶
Get the conversation history 会話履歴を取得する
Returns:
Type | Description |
---|---|
List[Dict[str, Any]]
|
List[Dict[str, Any]]: Conversation history / 会話履歴 |
current_turn
property
¶
Get the current turn number 現在のターン番号を取得する
Returns:
Name | Type | Description |
---|---|---|
int |
int
|
Current turn number / 現在のターン番号 |
is_complete
property
¶
Check if clarification process is complete (max turns reached) 明確化プロセスが完了しているかチェック(最大ターン数に達した)
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if max turns reached / 最大ターン数に達した場合True |
remaining_turns
property
¶
Get the remaining number of turns 残りのターン数を取得する
Returns:
Name | Type | Description |
---|---|---|
int |
int
|
Remaining turns / 残りターン数 |
__init__(name, generation_instructions, output_data=None, clerify_max_turns=20, evaluation_instructions=None, **kwargs)
¶
Initialize the ClearifyPipeline with configuration parameters 設定パラメータでClearifyPipelineを初期化する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Pipeline name / パイプライン名 |
required |
generation_instructions
|
str
|
System prompt for generation / 生成用システムプロンプト |
required |
output_data
|
Optional[Type[Any]]
|
Output data model type / 出力データモデル型 |
None
|
clerify_max_turns
|
int
|
Maximum number of clarification turns / 最大明確化ターン数 |
20
|
evaluation_instructions
|
Optional[str]
|
System prompt for evaluation / 評価用システムプロンプト |
None
|
**kwargs
|
Additional arguments for AgentPipeline / AgentPipeline用追加引数 |
{}
|
Source code in src\agents_sdk_models\clearify_pipeline.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
|
continue_clarification(user_response)
¶
Continue clarification with user response to previous question 前の質問に対するユーザー回答で明確化を継続する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_response
|
str
|
User response to clarification question / 明確化質問に対するユーザー回答 |
required |
Returns:
Name | Type | Description |
---|---|---|
Any |
Any
|
Final clarified requirement, next clarification question, or None if failed / 最終的な明確化された要求、次の明確化質問、または失敗時はNone |
Source code in src\agents_sdk_models\clearify_pipeline.py
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
|
reset_session()
¶
Reset the entire session including conversation history 会話履歴を含むセッション全体をリセットする
Source code in src\agents_sdk_models\clearify_pipeline.py
376 377 378 379 380 381 382 383 |
|
reset_turns()
¶
Reset the turn counter for a new clarification session 新しい明確化セッション用にターンカウンターをリセットする
Source code in src\agents_sdk_models\clearify_pipeline.py
367 368 369 370 371 372 373 374 |
|
run(user_input)
¶
Run the clarification pipeline with user input ユーザー入力で明確化パイプラインを実行する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
str
|
User input text / ユーザー入力テキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Any |
Any
|
Final clarified requirement, clarification question, or None if failed / 最終的な明確化された要求、明確化質問、または失敗時はNone |
Source code in src\agents_sdk_models\clearify_pipeline.py
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
|
ConditionStep
¶
Bases: Step
Step that performs conditional routing 条件付きルーティングを実行するステップ
This step evaluates a condition and routes to different steps based on the result. このステップは条件を評価し、結果に基づいて異なるステップにルーティングします。
Source code in src\agents_sdk_models\step.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
|
__init__(name, condition, if_true, if_false)
¶
Initialize condition step 条件ステップを初期化
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
condition
|
Callable[[Context], Union[bool, Awaitable[bool]]]
|
Condition function / 条件関数 |
required |
if_true
|
str
|
Step to go if condition is True / 条件がTrueの場合のステップ |
required |
if_false
|
str
|
Step to go if condition is False / 条件がFalseの場合のステップ |
required |
Source code in src\agents_sdk_models\step.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
|
run(user_input, ctx)
async
¶
Execute condition step 条件ステップを実行
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input (not used) / ユーザー入力(使用されない) |
required |
ctx
|
Context
|
Current context / 現在のコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context with routing / ルーティング付き更新済みコンテキスト |
Source code in src\agents_sdk_models\step.py
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
|
Context
¶
Bases: BaseModel
Context class for Flow/Step workflow state management フロー/ステップワークフロー状態管理用コンテキストクラス
This class provides: このクラスは以下を提供します: - Type-safe shared state / 型安全な共有状態 - Conversation history management / 会話履歴管理 - Step routing control / ステップルーティング制御 - LangChain LCEL compatibility / LangChain LCEL互換性 - User input/output coordination / ユーザー入出力調整
Source code in src\agents_sdk_models\context.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
|
__init__(**data)
¶
Initialize Context with async events 非同期イベントでContextを初期化
Source code in src\agents_sdk_models\context.py
81 82 83 84 85 86 87 88 |
|
add_assistant_message(content, metadata=None)
¶
Add assistant message to conversation history アシスタントメッセージを会話履歴に追加
Parameters:
Name | Type | Description | Default |
---|---|---|---|
content
|
str
|
Message content / メッセージ内容 |
required |
metadata
|
Optional[Dict[str, Any]]
|
Additional metadata / 追加メタデータ |
None
|
Source code in src\agents_sdk_models\context.py
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
|
add_system_message(content, metadata=None)
¶
Add system message to conversation history システムメッセージを会話履歴に追加
Parameters:
Name | Type | Description | Default |
---|---|---|---|
content
|
str
|
Message content / メッセージ内容 |
required |
metadata
|
Optional[Dict[str, Any]]
|
Additional metadata / 追加メタデータ |
None
|
Source code in src\agents_sdk_models\context.py
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
|
add_user_message(content, metadata=None)
¶
Add user message to conversation history ユーザーメッセージを会話履歴に追加
Parameters:
Name | Type | Description | Default |
---|---|---|---|
content
|
str
|
Message content / メッセージ内容 |
required |
metadata
|
Optional[Dict[str, Any]]
|
Additional metadata / 追加メタデータ |
None
|
Source code in src\agents_sdk_models\context.py
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
|
as_dict()
¶
Convert to dictionary for LangChain LCEL compatibility LangChain LCEL互換性のために辞書に変換
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
Dict[str, Any]: Dictionary representation / 辞書表現 |
Source code in src\agents_sdk_models\context.py
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
|
clear_prompt()
¶
Clear and return the current prompt 現在のプロンプトをクリアして返す
Returns:
Type | Description |
---|---|
Optional[str]
|
str | None: The prompt if one was waiting / 待機中だったプロンプト |
Source code in src\agents_sdk_models\context.py
166 167 168 169 170 171 172 173 174 175 176 177 178 |
|
finish()
¶
Mark flow as finished フローを完了としてマーク
Source code in src\agents_sdk_models\context.py
215 216 217 218 219 220 |
|
from_dict(data)
classmethod
¶
Create Context from dictionary (LangChain LCEL compatibility) 辞書からContextを作成(LangChain LCEL互換性)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data
|
Dict[str, Any]
|
Dictionary data / 辞書データ |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
'Context'
|
New context instance / 新しいコンテキストインスタンス |
Source code in src\agents_sdk_models\context.py
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
|
get_artifact(key, default=None)
¶
Get artifact value 成果物の値を取得
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
Artifact key / 成果物キー |
required |
default
|
Any
|
Default value if not found / 見つからない場合のデフォルト値 |
None
|
Returns:
Name | Type | Description |
---|---|---|
Any |
Any
|
Artifact value / 成果物値 |
Source code in src\agents_sdk_models\context.py
331 332 333 334 335 336 337 338 339 340 341 342 343 |
|
get_conversation_text(include_system=False)
¶
Get conversation as formatted text 会話をフォーマット済みテキストとして取得
Parameters:
Name | Type | Description | Default |
---|---|---|---|
include_system
|
bool
|
Include system messages / システムメッセージを含める |
False
|
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Formatted conversation / フォーマット済み会話 |
Source code in src\agents_sdk_models\context.py
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
|
get_last_messages(n=10)
¶
Get last N messages 最後のNメッセージを取得
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n
|
int
|
Number of messages / メッセージ数 |
10
|
Returns:
Type | Description |
---|---|
List[Message]
|
List[Message]: Last N messages / 最後のNメッセージ |
Source code in src\agents_sdk_models\context.py
296 297 298 299 300 301 302 303 304 305 306 307 |
|
goto(label)
¶
Set next step routing 次ステップのルーティングを設定
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label
|
str
|
Next step label / 次ステップのラベル |
required |
Source code in src\agents_sdk_models\context.py
205 206 207 208 209 210 211 212 213 |
|
is_finished()
¶
Check if flow is finished フローが完了しているかチェック
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if finished / 完了している場合True |
Source code in src\agents_sdk_models\context.py
222 223 224 225 226 227 228 229 230 |
|
provide_user_input(user_input)
¶
Provide user input and clear waiting state ユーザー入力を提供し、待ち状態をクリア
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
str
|
User input text / ユーザー入力テキスト |
required |
Source code in src\agents_sdk_models\context.py
152 153 154 155 156 157 158 159 160 161 162 163 164 |
|
set_artifact(key, value)
¶
Set artifact value 成果物の値を設定
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
Artifact key / 成果物キー |
required |
value
|
Any
|
Artifact value / 成果物値 |
required |
Source code in src\agents_sdk_models\context.py
320 321 322 323 324 325 326 327 328 329 |
|
set_waiting_for_user_input(prompt)
¶
Set context to wait for user input with a prompt プロンプトでユーザー入力待ち状態に設定
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt
|
str
|
Prompt to display to user / ユーザーに表示するプロンプト |
required |
Source code in src\agents_sdk_models\context.py
139 140 141 142 143 144 145 146 147 148 149 150 |
|
update_step_info(step_name)
¶
Update current step information 現在のステップ情報を更新
Parameters:
Name | Type | Description | Default |
---|---|---|---|
step_name
|
str
|
Current step name / 現在のステップ名 |
required |
Source code in src\agents_sdk_models\context.py
309 310 311 312 313 314 315 316 317 318 |
|
wait_for_prompt_event()
async
¶
Async wait for prompt event プロンプトイベントを非同期で待機
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Prompt waiting for user / ユーザー待ちのプロンプト |
Source code in src\agents_sdk_models\context.py
193 194 195 196 197 198 199 200 201 202 203 |
|
wait_for_user_input()
async
¶
Async wait for user input ユーザー入力を非同期で待機
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
User input / ユーザー入力 |
Source code in src\agents_sdk_models\context.py
180 181 182 183 184 185 186 187 188 189 190 191 |
|
DebugStep
¶
Bases: Step
Step for debugging and logging デバッグとログ用ステップ
This step prints or logs context information for debugging purposes. このステップはデバッグ目的でコンテキスト情報を印刷またはログ出力します。
Source code in src\agents_sdk_models\step.py
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
|
__init__(name, message='', print_context=False, next_step=None)
¶
Initialize debug step デバッグステップを初期化
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
message
|
str
|
Debug message / デバッグメッセージ |
''
|
print_context
|
bool
|
Whether to print full context / 完全なコンテキストを印刷するか |
False
|
next_step
|
Optional[str]
|
Next step / 次ステップ |
None
|
Source code in src\agents_sdk_models\step.py
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 |
|
run(user_input, ctx)
async
¶
Execute debug step デバッグステップを実行
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input / ユーザー入力 |
required |
ctx
|
Context
|
Current context / 現在のコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context / 更新済みコンテキスト |
Source code in src\agents_sdk_models\step.py
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
|
EvaluationResult
dataclass
¶
Result of evaluation for generated content 生成されたコンテンツの評価結果を保持するクラス
Attributes:
Name | Type | Description |
---|---|---|
score |
int
|
Evaluation score (0-100) / 評価スコア(0-100) |
comment |
List[Comment]
|
List of Comment instances containing importance and content / 重要度と内容を持つCommentクラスのリスト |
Source code in src\agents_sdk_models\pipeline.py
46 47 48 49 50 51 52 53 54 55 56 57 |
|
Flow
¶
Flow orchestration engine for Step-based workflows ステップベースワークフロー用フローオーケストレーションエンジン
This class provides: このクラスは以下を提供します: - Declarative step-based workflow definition / 宣言的ステップベースワークフロー定義 - Synchronous and asynchronous execution modes / 同期・非同期実行モード - User input coordination for interactive workflows / 対話的ワークフロー用ユーザー入力調整 - Error handling and observability / エラーハンドリングとオブザーバビリティ
Source code in src\agents_sdk_models\flow.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 |
|
current_step_name
property
¶
Get current step name 現在のステップ名を取得
Returns:
Type | Description |
---|---|
Optional[str]
|
str | None: Current step name / 現在のステップ名 |
finished
property
¶
Check if flow is finished フローが完了しているかチェック
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if finished / 完了している場合True |
next_step_name
property
¶
Get next step name 次のステップ名を取得
Returns:
Type | Description |
---|---|
Optional[str]
|
str | None: Next step name / 次のステップ名 |
__init__(start=None, steps=None, context=None, max_steps=1000, trace_id=None)
¶
Initialize Flow with flexible step definitions 柔軟なステップ定義でFlowを初期化
This constructor now supports three ways to define steps: このコンストラクタは3つの方法でステップを定義できます: 1. Traditional: start step name + Dict[str, Step] 2. Sequential: List[Step] (creates sequential workflow) 3. Single: Single Step (creates single-step workflow)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
start
|
Optional[str]
|
Start step label (optional for List/Single mode) / 開始ステップラベル(List/Singleモードでは省略可) |
None
|
steps
|
Optional[Union[Dict[str, Step], List[Step], Step]]
|
Step definitions - Dict[str, Step], List[Step], or Step / ステップ定義 - Dict[str, Step]、List[Step]、またはStep |
None
|
context
|
Optional[Context]
|
Initial context (optional) / 初期コンテキスト(オプション) |
None
|
max_steps
|
int
|
Maximum number of steps to prevent infinite loops / 無限ループ防止のための最大ステップ数 |
1000
|
trace_id
|
Optional[str]
|
Trace ID for observability / オブザーバビリティ用トレースID |
None
|
Source code in src\agents_sdk_models\flow.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
|
__str__()
¶
String representation of flow
Source code in src\agents_sdk_models\flow.py
547 548 549 |
|
add_hook(hook_type, callback)
¶
Add observability hook オブザーバビリティフックを追加
Parameters:
Name | Type | Description | Default |
---|---|---|---|
hook_type
|
str
|
Type of hook ("before_step", "after_step", "error") / フックタイプ |
required |
callback
|
Callable
|
Callback function / コールバック関数 |
required |
Source code in src\agents_sdk_models\flow.py
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
|
feed(user_input)
¶
Provide user input to the flow フローにユーザー入力を提供
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
str
|
User input text / ユーザー入力テキスト |
required |
Source code in src\agents_sdk_models\flow.py
320 321 322 323 324 325 326 327 328 |
|
get_flow_summary()
¶
Get flow execution summary フロー実行サマリーを取得
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
Dict[str, Any]: Flow summary / フローサマリー |
Source code in src\agents_sdk_models\flow.py
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
|
get_step_history()
¶
Get execution history 実行履歴を取得
Returns:
Type | Description |
---|---|
List[Dict[str, Any]]
|
List[Dict[str, Any]]: Step execution history / ステップ実行履歴 |
Source code in src\agents_sdk_models\flow.py
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 |
|
next_prompt()
¶
Get next prompt for synchronous CLI usage 同期CLI使用用の次のプロンプトを取得
Returns:
Type | Description |
---|---|
Optional[str]
|
str | None: Prompt if waiting for user input / ユーザー入力待ちの場合のプロンプト |
Source code in src\agents_sdk_models\flow.py
310 311 312 313 314 315 316 317 318 |
|
reset()
¶
Reset flow to initial state フローを初期状態にリセット
Source code in src\agents_sdk_models\flow.py
510 511 512 513 514 515 516 517 518 519 520 |
|
run(input_data=None, initial_input=None)
async
¶
Run flow to completion without user input coordination ユーザー入力調整なしでフローを完了まで実行
This is for non-interactive workflows that don't require user input. これはユーザー入力が不要な非対話的ワークフロー用です。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_data
|
Optional[str]
|
Input data to the flow (preferred parameter name) / フローへの入力データ(推奨パラメータ名) |
None
|
initial_input
|
Optional[str]
|
Initial input to the flow (deprecated, use input_data) / フローへの初期入力(非推奨、input_dataを使用) |
None
|
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Final context / 最終コンテキスト |
Raises:
Type | Description |
---|---|
FlowExecutionError
|
If execution fails / 実行失敗時 |
Source code in src\agents_sdk_models\flow.py
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
|
run_loop()
async
¶
Run flow as background task with user input coordination ユーザー入力調整を含むバックグラウンドタスクとしてフローを実行
This method runs the flow continuously, pausing when user input is needed. このメソッドはフローを継続的に実行し、ユーザー入力が必要な時に一時停止します。 Use feed() to provide user input when the flow is waiting. フローが待機している時はfeed()を使用してユーザー入力を提供してください。
Source code in src\agents_sdk_models\flow.py
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
|
start_background_task()
async
¶
Start flow as background task フローをバックグラウンドタスクとして開始
Returns:
Type | Description |
---|---|
Task
|
asyncio.Task: Background task / バックグラウンドタスク |
Source code in src\agents_sdk_models\flow.py
533 534 535 536 537 538 539 540 541 542 543 544 545 |
|
step()
¶
Execute one step synchronously 1ステップを同期的に実行
This method executes one step and returns immediately. このメソッドは1ステップを実行してすぐに返ります。 Use for synchronous CLI applications. 同期CLIアプリケーション用に使用してください。
Source code in src\agents_sdk_models\flow.py
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 |
|
stop()
¶
Stop flow execution フロー実行を停止
Source code in src\agents_sdk_models\flow.py
522 523 524 525 526 527 528 529 530 531 |
|
FlowExecutionError
¶
Bases: Exception
Exception raised during flow execution フロー実行中に発生する例外
Source code in src\agents_sdk_models\flow.py
22 23 24 25 26 27 |
|
ForkStep
¶
Bases: Step
Step that executes multiple branches in parallel 複数のブランチを並列実行するステップ
This step starts multiple sub-flows concurrently and collects their results. このステップは複数のサブフローを同時に開始し、結果を収集します。
Source code in src\agents_sdk_models\step.py
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
|
__init__(name, branches, join_step)
¶
Initialize fork step フォークステップを初期化
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
branches
|
List[str]
|
List of branch step names to execute in parallel / 並列実行するブランチステップ名のリスト |
required |
join_step
|
str
|
Step to join results / 結果を結合するステップ |
required |
Source code in src\agents_sdk_models\step.py
251 252 253 254 255 256 257 258 259 260 261 262 263 |
|
run(user_input, ctx)
async
¶
Execute fork step フォークステップを実行
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input / ユーザー入力 |
required |
ctx
|
Context
|
Current context / 現在のコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context / 更新済みコンテキスト |
Source code in src\agents_sdk_models\step.py
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
|
FunctionStep
¶
Bases: Step
Step that executes a custom function カスタム関数を実行するステップ
This step allows executing arbitrary code within the workflow. このステップはワークフロー内で任意のコードを実行できます。
Source code in src\agents_sdk_models\step.py
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
|
__init__(name, function, next_step=None)
¶
Initialize function step 関数ステップを初期化
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
function
|
Callable[[Optional[str], Context], Union[Context, Awaitable[Context]]]
|
Function to execute / 実行する関数 |
required |
next_step
|
Optional[str]
|
Next step after execution / 実行後の次ステップ |
None
|
Source code in src\agents_sdk_models\step.py
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
|
run(user_input, ctx)
async
¶
Execute function step 関数ステップを実行
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input / ユーザー入力 |
required |
ctx
|
Context
|
Current context / 現在のコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context / 更新済みコンテキスト |
Source code in src\agents_sdk_models\step.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
|
GeminiModel
¶
Bases: OpenAIChatCompletionsModel
Gemini model implementation that extends OpenAI's chat completions model OpenAIのチャット補完モデルを拡張したGeminiモデルの実装
Source code in src\agents_sdk_models\gemini.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
|
__init__(model='gemini-2.0-flash', temperature=0.3, api_key=None, base_url='https://generativelanguage.googleapis.com/v1beta/openai/', **kwargs)
¶
Initialize the Gemini model with OpenAI compatible interface OpenAI互換インターフェースでGeminiモデルを初期化する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
str
|
Name of the Gemini model to use (e.g. "gemini-2.0-flash") 使用するGeminiモデルの名前(例:"gemini-2.0-flash") |
'gemini-2.0-flash'
|
temperature
|
float
|
Sampling temperature between 0 and 1 サンプリング温度(0から1の間) |
0.3
|
api_key
|
str
|
Gemini API key Gemini APIキー |
None
|
base_url
|
str
|
Base URL for the Gemini API Gemini APIのベースURL |
'https://generativelanguage.googleapis.com/v1beta/openai/'
|
**kwargs
|
Any
|
Additional arguments to pass to the OpenAI API OpenAI APIに渡す追加の引数 |
{}
|
Source code in src\agents_sdk_models\gemini.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
|
GenAgent
¶
Bases: Step
Step implementation that wraps AgentPipeline functionality AgentPipeline機能をラップするStep実装
This class allows using AgentPipeline directly as a Step in Flow workflows, providing generation, evaluation, and retry capabilities within a workflow context. このクラスはAgentPipelineをFlowワークフロー内で直接Stepとして使用できるようにし、 ワークフローコンテキスト内で生成、評価、リトライ機能を提供します。
Source code in src\agents_sdk_models\gen_agent.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
|
__init__(name, generation_instructions, evaluation_instructions=None, *, input_guardrails=None, output_guardrails=None, output_model=None, model=None, evaluation_model=None, generation_tools=None, evaluation_tools=None, routing_func=None, session_history=None, history_size=10, threshold=85, retries=3, improvement_callback=None, dynamic_prompt=None, retry_comment_importance=None, locale='en', next_step=None, store_result_key=None)
¶
Initialize GenAgent with AgentPipeline configuration AgentPipeline設定でGenAgentを初期化する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
generation_instructions
|
str
|
System prompt for generation / 生成用システムプロンプト |
required |
evaluation_instructions
|
Optional[str]
|
System prompt for evaluation / 評価用システムプロンプト |
None
|
input_guardrails
|
Optional[list]
|
Guardrails for generation / 生成用ガードレール |
None
|
output_guardrails
|
Optional[list]
|
Guardrails for evaluation / 評価用ガードレール |
None
|
output_model
|
Optional[Type[Any]]
|
Model for output formatting / 出力フォーマット用モデル |
None
|
model
|
str | None
|
LLM model name / LLMモデル名 |
None
|
evaluation_model
|
str | None
|
Optional LLM model name for evaluation / 評価用LLMモデル名(任意) |
None
|
generation_tools
|
Optional[list]
|
Tools for generation / 生成用ツール |
None
|
evaluation_tools
|
Optional[list]
|
Tools for evaluation / 評価用ツール |
None
|
routing_func
|
Optional[Callable[[Any], Any]]
|
Function for output routing / 出力ルーティング用関数 |
None
|
session_history
|
Optional[list]
|
Session history / セッション履歴 |
None
|
history_size
|
int
|
Size of history to keep / 保持する履歴サイズ |
10
|
threshold
|
int
|
Evaluation score threshold / 評価スコア閾値 |
85
|
retries
|
int
|
Number of retry attempts / リトライ試行回数 |
3
|
improvement_callback
|
Optional[Callable[[Any, EvaluationResult], None]]
|
Callback for improvement suggestions / 改善提案用コールバック |
None
|
dynamic_prompt
|
Optional[Callable[[str], str]]
|
Optional function to dynamically build prompt / 動的プロンプト生成関数(任意) |
None
|
retry_comment_importance
|
Optional[list[str]]
|
Importance levels of comments to include on retry / リトライ時コメント重要度レベル |
None
|
locale
|
str
|
Language code for localized messages / ローカライズメッセージ用言語コード |
'en'
|
next_step
|
Optional[str]
|
Next step after pipeline execution / パイプライン実行後の次ステップ |
None
|
store_result_key
|
Optional[str]
|
Key to store result in context shared_state / コンテキスト共有状態に結果を格納するキー |
None
|
Source code in src\agents_sdk_models\gen_agent.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
|
clear_history()
¶
Clear both pipeline and session history パイプライン履歴とセッション履歴の両方をクリア
Source code in src\agents_sdk_models\gen_agent.py
238 239 240 241 242 243 244 245 |
|
get_pipeline_history()
¶
Get the internal pipeline history 内部パイプライン履歴を取得する
Returns:
Type | Description |
---|---|
List[Dict[str, str]]
|
List[Dict[str, str]]: Pipeline history / パイプライン履歴 |
Source code in src\agents_sdk_models\gen_agent.py
192 193 194 195 196 197 198 199 200 |
|
get_session_history()
¶
Get the session history セッション履歴を取得する
Returns:
Type | Description |
---|---|
Optional[List[str]]
|
Optional[List[str]]: Session history / セッション履歴 |
Source code in src\agents_sdk_models\gen_agent.py
202 203 204 205 206 207 208 209 210 |
|
run(user_input, ctx)
async
¶
Execute GenAgent step using AgentPipeline AgentPipelineを使用してGenAgentステップを実行する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input for the pipeline / パイプライン用ユーザー入力 |
required |
ctx
|
Context
|
Current workflow context / 現在のワークフローコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context with pipeline results / パイプライン結果付き更新済みコンテキスト |
Source code in src\agents_sdk_models\gen_agent.py
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
|
set_threshold(threshold)
¶
Update evaluation threshold 評価閾値を更新する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
threshold
|
int
|
New threshold value (0-100) / 新しい閾値(0-100) |
required |
Source code in src\agents_sdk_models\gen_agent.py
247 248 249 250 251 252 253 254 255 256 257 258 |
|
update_instructions(generation_instructions=None, evaluation_instructions=None)
¶
Update pipeline instructions パイプライン指示を更新する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
generation_instructions
|
Optional[str]
|
New generation instructions / 新しい生成指示 |
None
|
evaluation_instructions
|
Optional[str]
|
New evaluation instructions / 新しい評価指示 |
None
|
Source code in src\agents_sdk_models\gen_agent.py
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
|
JoinStep
¶
Bases: Step
Step that joins results from parallel branches 並列ブランチからの結果を結合するステップ
This step waits for parallel branches to complete and merges their results. このステップは並列ブランチの完了を待機し、結果をマージします。
Source code in src\agents_sdk_models\step.py
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
|
__init__(name, fork_step, join_type='all', next_step=None)
¶
Initialize join step ジョインステップを初期化
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
fork_step
|
str
|
Associated fork step name / 関連するフォークステップ名 |
required |
join_type
|
str
|
Join type ("all" or "any") / ジョインタイプ("all"または"any") |
'all'
|
next_step
|
Optional[str]
|
Next step after join / ジョイン後の次ステップ |
None
|
Source code in src\agents_sdk_models\step.py
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
|
run(user_input, ctx)
async
¶
Execute join step ジョインステップを実行
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input / ユーザー入力 |
required |
ctx
|
Context
|
Current context / 現在のコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context / 更新済みコンテキスト |
Source code in src\agents_sdk_models\step.py
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
|
Message
¶
Bases: BaseModel
Message class for conversation history 会話履歴用メッセージクラス
Attributes:
Name | Type | Description |
---|---|---|
role |
str
|
Message role (user, assistant, system) / メッセージの役割 |
content |
str
|
Message content / メッセージ内容 |
timestamp |
datetime
|
Message timestamp / メッセージのタイムスタンプ |
metadata |
Dict[str, Any]
|
Additional metadata / 追加メタデータ |
Source code in src\agents_sdk_models\context.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
|
OllamaModel
¶
Bases: OpenAIChatCompletionsModel
Ollama model implementation that extends OpenAI's chat completions model OpenAIのチャット補完モデルを拡張したOllamaモデルの実装
Source code in src\agents_sdk_models\ollama.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
|
__init__(model='phi4-mini:latest', temperature=0.3, base_url=None, **kwargs)
¶
Initialize the Ollama model with OpenAI compatible interface OpenAI互換インターフェースでOllamaモデルを初期化する
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
str
|
Name of the Ollama model to use (e.g. "phi4-mini") 使用するOllamaモデルの名前(例:"phi4-mini") |
'phi4-mini:latest'
|
temperature
|
float
|
Sampling temperature between 0 and 1 サンプリング温度(0から1の間) |
0.3
|
base_url
|
str
|
Base URL for the Ollama API Ollama APIのベースURL |
None
|
**kwargs
|
Any
|
Additional arguments to pass to the OpenAI API OpenAI APIに渡す追加の引数 |
{}
|
Source code in src\agents_sdk_models\ollama.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
|
Step
¶
Bases: ABC
Abstract base class for workflow steps ワークフローステップの抽象基底クラス
All step implementations must provide: 全てのステップ実装は以下を提供する必要があります: - name: Step identifier for DSL reference / DSL参照用ステップ識別子 - run: Async execution method / 非同期実行メソッド
Source code in src\agents_sdk_models\step.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
__init__(name)
¶
Initialize step with name 名前でステップを初期化
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
Source code in src\agents_sdk_models\step.py
29 30 31 32 33 34 35 36 37 |
|
run(user_input, ctx)
abstractmethod
async
¶
Execute step and return updated context ステップを実行し、更新されたコンテキストを返す
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input if any / ユーザー入力(あれば) |
required |
ctx
|
Context
|
Current context / 現在のコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context with next_label set / next_labelが設定された更新済みコンテキスト |
Source code in src\agents_sdk_models\step.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
|
UserInputStep
¶
Bases: Step
Step that waits for user input ユーザー入力を待機するステップ
This step displays a prompt and waits for user response. このステップはプロンプトを表示し、ユーザー応答を待機します。 It sets the context to waiting state and returns without advancing. コンテキストを待機状態に設定し、進行せずに返します。
Source code in src\agents_sdk_models\step.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
__init__(name, prompt, next_step=None)
¶
Initialize user input step ユーザー入力ステップを初期化
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
prompt
|
str
|
Prompt to display to user / ユーザーに表示するプロンプト |
required |
next_step
|
Optional[str]
|
Next step after input (optional) / 入力後の次ステップ(オプション) |
None
|
Source code in src\agents_sdk_models\step.py
72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
run(user_input, ctx)
async
¶
Execute user input step ユーザー入力ステップを実行
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_input
|
Optional[str]
|
User input if available / 利用可能なユーザー入力 |
required |
ctx
|
Context
|
Current context / 現在のコンテキスト |
required |
Returns:
Name | Type | Description |
---|---|---|
Context |
Context
|
Updated context / 更新済みコンテキスト |
Source code in src\agents_sdk_models\step.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
create_conditional_flow(initial_step, condition_step, true_branch, false_branch, context=None)
¶
Create a conditional flow with true/false branches true/falseブランチを持つ条件付きフローを作成
Parameters:
Name | Type | Description | Default |
---|---|---|---|
initial_step
|
Step
|
Initial step / 初期ステップ |
required |
condition_step
|
Step
|
Condition step / 条件ステップ |
required |
true_branch
|
List[Step]
|
Steps for true branch / trueブランチのステップ |
required |
false_branch
|
List[Step]
|
Steps for false branch / falseブランチのステップ |
required |
context
|
Optional[Context]
|
Initial context / 初期コンテキスト |
None
|
Returns:
Name | Type | Description |
---|---|---|
Flow |
Flow
|
Created flow / 作成されたフロー |
Source code in src\agents_sdk_models\flow.py
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
|
create_evaluated_gen_agent(name, generation_instructions, evaluation_instructions, model=None, evaluation_model=None, next_step=None, threshold=85, retries=3)
¶
Create a GenAgent with both generation and evaluation 生成と評価の両方を持つGenAgentを作成
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Agent name / エージェント名 |
required |
generation_instructions
|
str
|
Generation instructions / 生成指示 |
required |
evaluation_instructions
|
str
|
Evaluation instructions / 評価指示 |
required |
model
|
Optional[str]
|
LLM model name / LLMモデル名 |
None
|
evaluation_model
|
Optional[str]
|
Evaluation model name / 評価モデル名 |
None
|
next_step
|
Optional[str]
|
Next step after execution / 実行後の次ステップ |
None
|
threshold
|
int
|
Evaluation threshold / 評価閾値 |
85
|
retries
|
int
|
Number of retries / リトライ回数 |
3
|
Returns:
Name | Type | Description |
---|---|---|
GenAgent |
GenAgent
|
Configured GenAgent instance / 設定済みGenAgentインスタンス |
Source code in src\agents_sdk_models\gen_agent.py
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
|
create_lambda_step(name, func, next_step=None)
¶
Create a simple function step from a lambda ラムダから簡単な関数ステップを作成
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Step name / ステップ名 |
required |
func
|
Callable[[Context], Any]
|
Function to execute / 実行する関数 |
required |
next_step
|
Optional[str]
|
Next step / 次ステップ |
None
|
Returns:
Name | Type | Description |
---|---|---|
FunctionStep |
FunctionStep
|
Function step / 関数ステップ |
Source code in src\agents_sdk_models\step.py
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
|
create_simple_condition(field_path, expected_value)
¶
Create a simple condition function that checks a field value フィールド値をチェックする簡単な条件関数を作成
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field_path
|
str
|
Dot-separated path to field (e.g., "shared_state.status") / フィールドへのドット区切りパス |
required |
expected_value
|
Any
|
Expected value / 期待値 |
required |
Returns:
Type | Description |
---|---|
Callable[[Context], bool]
|
Callable[[Context], bool]: Condition function / 条件関数 |
Source code in src\agents_sdk_models\step.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 |
|
create_simple_flow(steps, context=None)
¶
Create a simple linear flow from a list of steps ステップのリストから簡単な線形フローを作成
Parameters:
Name | Type | Description | Default |
---|---|---|---|
steps
|
List[tuple[str, Step]]
|
List of (name, step) tuples / (名前, ステップ)タプルのリスト |
required |
context
|
Optional[Context]
|
Initial context / 初期コンテキスト |
None
|
Returns:
Name | Type | Description |
---|---|---|
Flow |
Flow
|
Created flow / 作成されたフロー |
Source code in src\agents_sdk_models\flow.py
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 |
|
create_simple_gen_agent(name, instructions, model=None, next_step=None, threshold=85, retries=3)
¶
Create a simple GenAgent with basic configuration 基本設定でシンプルなGenAgentを作成
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Agent name / エージェント名 |
required |
instructions
|
str
|
Generation instructions / 生成指示 |
required |
model
|
Optional[str]
|
LLM model name / LLMモデル名 |
None
|
next_step
|
Optional[str]
|
Next step after execution / 実行後の次ステップ |
None
|
threshold
|
int
|
Evaluation threshold / 評価閾値 |
85
|
retries
|
int
|
Number of retries / リトライ回数 |
3
|
Returns:
Name | Type | Description |
---|---|---|
GenAgent |
GenAgent
|
Configured GenAgent instance / 設定済みGenAgentインスタンス |
Source code in src\agents_sdk_models\gen_agent.py
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
|
disable_tracing()
¶
English: Disable all tracing. 日本語: トレーシング機能をすべて無効化します。
Source code in src\agents_sdk_models\tracing.py
128 129 130 131 132 133 |
|
enable_console_tracing()
¶
English: Enable console tracing by registering ConsoleTracingProcessor and enabling tracing. 日本語: ConsoleTracingProcessorを登録してトレーシングを有効化します。
Source code in src\agents_sdk_models\tracing.py
117 118 119 120 121 122 123 124 125 |
|
get_available_models(providers, ollama_base_url=None)
¶
Get available model names for specified providers (synchronous version).
English: Get available model names for specified providers (synchronous version).
日本語: 指定されたプロバイダーの利用可能なモデル名を取得します(同期版)。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
providers
|
List[ProviderType]
|
List of providers to get models for. モデルを取得するプロバイダーのリスト。 |
required |
ollama_base_url
|
Optional[str]
|
Base URL for Ollama API. If None, uses environment variable or default. Ollama API のベース URL。None の場合、環境変数またはデフォルトを使用。 |
None
|
Returns:
Type | Description |
---|---|
dict[str, List[str]]
|
dict[str, List[str]]: Dictionary mapping provider names to lists of available models. プロバイダー名と利用可能なモデルのリストのマッピング辞書。 |
Source code in src\agents_sdk_models\llm.py
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
|
get_available_models_async(providers, ollama_base_url=None)
async
¶
Get available model names for specified providers.
English: Get available model names for specified providers.
日本語: 指定されたプロバイダーの利用可能なモデル名を取得します。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
providers
|
List[ProviderType]
|
List of providers to get models for. モデルを取得するプロバイダーのリスト。 |
required |
ollama_base_url
|
Optional[str]
|
Base URL for Ollama API. If None, uses environment variable or default. Ollama API のベース URL。None の場合、環境変数またはデフォルトを使用。 |
None
|
Returns:
Type | Description |
---|---|
dict[str, List[str]]
|
dict[str, List[str]]: Dictionary mapping provider names to lists of available models. プロバイダー名と利用可能なモデルのリストのマッピング辞書。 |
Raises:
Type | Description |
---|---|
ValueError
|
If an unsupported provider is specified. サポートされていないプロバイダーが指定された場合。 |
RequestError
|
If there's an error connecting to the Ollama API. Ollama API への接続エラーが発生した場合。 |
Source code in src\agents_sdk_models\llm.py
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
|
get_llm(model=None, provider=None, temperature=0.3, api_key=None, base_url=None, thinking=False, **kwargs)
¶
Factory function to get an instance of a language model based on the provider.
English: Factory function to get an instance of a language model based on the provider.
日本語: プロバイダーに基づいて言語モデルのインスタンスを取得するファクトリ関数。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
provider
|
ProviderType
|
The LLM provider ("openai", "google", "anthropic", "ollama"). Defaults to "openai". LLM プロバイダー ("openai", "google", "anthropic", "ollama")。デフォルトは "openai"。 |
None
|
model
|
Optional[str]
|
The specific model name for the provider. If None, uses the default for the provider. プロバイダー固有のモデル名。None の場合、プロバイダーのデフォルトを使用します。 |
None
|
temperature
|
float
|
Sampling temperature. Defaults to 0.3. サンプリング温度。デフォルトは 0.3。 |
0.3
|
api_key
|
Optional[str]
|
API key for the provider, if required. プロバイダーの API キー (必要な場合)。 |
None
|
base_url
|
Optional[str]
|
Base URL for the provider's API, if needed (e.g., for self-hosted Ollama or OpenAI-compatible APIs). プロバイダー API のベース URL (必要な場合、例: セルフホストの Ollama や OpenAI 互換 API)。 |
None
|
thinking
|
bool
|
Enable thinking mode for Claude models. Defaults to False. Claude モデルの思考モードを有効にするか。デフォルトは False。 |
False
|
tracing
|
bool
|
Whether to enable tracing for the Agents SDK. Defaults to False. Agents SDK のトレーシングを有効化するか。デフォルトは False。 |
required |
**kwargs
|
Any
|
Additional keyword arguments to pass to the model constructor. モデルのコンストラクタに渡す追加のキーワード引数。 |
{}
|
Returns:
Name | Type | Description |
---|---|---|
Model |
Model
|
An instance of the appropriate language model class. 適切な言語モデルクラスのインスタンス。 |
Raises:
Type | Description |
---|---|
ValueError
|
If an unsupported provider is specified. サポートされていないプロバイダーが指定された場合。 |
Source code in src\agents_sdk_models\llm.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
|
クラス・関数一覧¶
名前 | 種別 | 概要 |
---|---|---|
get_llm | 関数 | モデル名・プロバイダー名からLLMインスタンスを取得 |
AgentPipeline | クラス | 生成・評価・ツール・ガードレールを統合したパイプライン |
ConsoleTracingProcessor | クラス | コンソール色分けトレース出力用プロセッサ |
enable_console_tracing | 関数 | コンソールトレーシングを有効化 |
disable_tracing | 関数 | トレーシング機能をすべて無効化 |
OpenAIResponsesModel | クラス | OpenAI用モデルラッパー |
GeminiModel | クラス | Google Gemini用モデルラッパー |
ClaudeModel | クラス | Anthropic Claude用モデルラッパー |
OllamaModel | クラス | Ollama用モデルラッパー |
get_llm¶
-
モデル名・プロバイダー名からLLMインスタンスを返すファクトリ関数
-
引数:
- model (str): モデル名
- provider (str, optional): プロバイダー名(省略時は自動推論)
- temperature (float, optional): サンプリング温度
- api_key (str, optional): プロバイダーAPIキー
- base_url (str, optional): プロバイダーAPIベースURL
- thinking (bool, optional): Claudeモデル思考モード
- tracing (bool, optional): Agents SDK トレーシング有効化
- 戻り値: LLMインスタンス
引数¶
名前 | 型 | 必須/オプション | デフォルト | 説明 |
---|---|---|---|---|
model | str | 必須 | - | 使用するLLMモデル名 |
provider | str (optional) | オプション | None | モデルのプロバイダー名(自動推論可) |
temperature | float (optional) | オプション | 0.3 | サンプリング温度 |
api_key | str (optional) | オプション | None | プロバイダーAPIキー |
base_url | str (optional) | オプション | None | プロバイダーAPIベースURL |
thinking | bool (optional) | オプション | False | Claudeモデルの思考モード |
tracing | bool (optional) | オプション | False | Agents SDKのトレーシングを有効化するか |
戻り値¶
LLMインスタンス
enable_console_tracing¶
- コンソールトレーシング(
ConsoleTracingProcessor
)を有効化します。 - 引数: なし
- 戻り値: なし
disable_tracing¶
- 全てのトレーシング機能(SDKおよびコンソール)を無効化します。
- 引数: なし
- 戻り値: なし
AgentPipeline¶
- 生成・評価・ツール・ガードレールを統合したパイプライン管理クラス
- 主な引数:
- name (str): パイプライン名
- generation_instructions (str): 生成用プロンプト
- evaluation_instructions (str, optional): 評価用プロンプト
- model (str or LLM): 使用するモデル
- evaluation_model (str or LLM, optional): 評価に使用するモデル名またはLLMインスタンス(省略時は
model
を使用) - generation_tools (list, optional): 生成時ツール
- input_guardrails/output_guardrails (list, optional): 入出力ガードレール
- threshold (int): 評価閾値
- retries (int): リトライ回数
- retry_comment_importance (list[str], optional): 重要度指定
- 主なメソッド:
- run(input): 入力に対して生成・評価・自己改善を実行
- 戻り値: 生成・評価結果
引数¶
名前 | 型 | 必須/オプション | デフォルト | 説明 |
---|---|---|---|---|
name | str | 必須 | - | パイプライン名 |
generation_instructions | str | 必須 | - | 生成用システムプロンプト |
evaluation_instructions | str (optional) | オプション | None | 評価用システムプロンプト |
model | str or LLM | オプション | None | 使用するLLMモデル名またはLLMインスタンス |
evaluation_model | str or LLM | オプション | None | 評価に使用するモデル名またはLLMインスタンス(省略時はmodelを使用) |
generation_tools | list (optional) | オプション | [] | 生成時に使用するツールのリスト |
evaluation_tools | list (optional) | オプション | [] | 評価時に使用するツールのリスト |
input_guardrails | list (optional) | オプション | [] | 生成時の入力ガードレールリスト |
output_guardrails | list (optional) | オプション | [] | 評価時の出力ガードレールリスト |
routing_func | Callable (optional) | オプション | None | 出力ルーティング用関数 |
session_history | list (optional) | オプション | [] | セッション履歴 |
history_size | int | オプション | 10 | 履歴保持数 |
threshold | int | オプション | 85 | 評価スコアの閾値 |
retries | int | オプション | 3 | リトライ試行回数 |
improvement_callback | Callable[[Any, EvaluationResult], None] (optional) | オプション | None | 改善提案用コールバック |
dynamic_prompt | Callable[[str], str] (optional) | オプション | None | 動的プロンプト生成関数 |
retry_comment_importance | list[str] (optional) | オプション | [] | リトライ時にプロンプトに含めるコメント重大度 |
戻り値¶
生成・評価結果(
EvaluationResultを含むオブジェクト)
モデルラッパークラス¶
クラス名 | 概要 |
---|---|
OpenAIResponsesModel | OpenAI API用 |
GeminiModel | Google Gemini API用 |
ClaudeModel | Anthropic Claude API用 |
OllamaModel | Ollama API用 |
クラス図(mermaid)¶
classDiagram
class AgentPipeline {
+run(input)
-_build_generation_prompt()
-_build_evaluation_prompt()
}
class OpenAIResponsesModel
class GeminiModel
class ClaudeModel
class OllamaModel
AgentPipeline --> OpenAIResponsesModel
AgentPipeline --> GeminiModel
AgentPipeline --> ClaudeModel
AgentPipeline --> OllamaModel