Docs: Switch to o3 model; exclude translated pages from search (#533 )

This pull request introduces the following changes:
1. **Exclude translated pages from search**: I explored ways to make the
search plugin work with the i18n plugin, but it would require extensive
custom JavaScript hacks. So for now, I’m holding off on this work.
2. **Switch from GPT-4.1 to o3 for even better translation quality**:
While 4.1 performs well, o3 shows even greater quality for this task,
and there’s no reason to avoid using it.

2025-04-16 21:29:09 -04:00

7.4 KiB

Raw Permalink Blame History

exclude
true

エージェントの実行

Runner クラス [Runner][agents.run.Runner] を使用してエージェントを実行できます。方法は 3 つあります。

非同期で実行し、[RunResult][agents.result.RunResult] を返す [Runner.run()][agents.run.Runner.run]
同期メソッドで、内部的には .run() を呼び出す [Runner.run_sync()][agents.run.Runner.run_sync]
非同期で実行し、[RunResultStreaming][agents.result.RunResultStreaming] を返す [Runner.run_streamed()][agents.run.Runner.run_streamed]
LLM をストリーミングモードで呼び出し、受信したイベントを逐次ストリーミングします。

from agents import Agent, Runner

async def main():
    agent = Agent(name="Assistant", instructions="You are a helpful assistant")

    result = await Runner.run(agent, "Write a haiku about recursion in programming.")
    print(result.final_output)
    # Code within the code,
    # Functions calling themselves,
    # Infinite loop's dance.

詳細は結果ガイドを参照してください。

エージェントループ

Runner の run メソッドを使用する際は、開始エージェントと入力を渡します。入力は文字列（ユーザーメッセージと見なされます）または入力項目のリスト（OpenAI Responses API の項目）です。

Runner は以下のループを実行します。

現在のエージェントと現在の入力で LLM を呼び出します。
LLM が出力を生成します。
1. final_output が返された場合、ループを終了して結果を返します。
2. ハンドオフが発生した場合、現在のエージェントと入力を更新し、ループを再実行します。
3. ツール呼び出しがある場合、それらを実行し、結果を追加してループを再実行します。
指定した max_turns を超えた場合、[MaxTurnsExceeded][agents.exceptions.MaxTurnsExceeded] 例外を送出します。

!!! note LLM の出力が「最終出力」と見なされる条件は、望ましい型のテキスト出力であり、ツール呼び出しがないことです。

ストリーミング

ストリーミングを使用すると、LLM の実行中にストリーミングイベントを受け取れます。ストリーム完了後、[RunResultStreaming][agents.result.RunResultStreaming] には実行に関する完全な情報（新しく生成されたすべての出力を含む）が格納されます。.stream_events() を呼び出してストリーミングイベントを取得できます。詳しくはストリーミングガイドをご覧ください。

Run 設定

run_config パラメーターにより、エージェント実行のグローバル設定を行えます。

[model][agents.run.RunConfig.model]: 各 Agent の model 設定に関わらず使用するグローバル LLM モデルを指定します。
[model_provider][agents.run.RunConfig.model_provider]: モデル名を解決するモデルプロバイダー。デフォルトは OpenAI です。
[model_settings][agents.run.RunConfig.model_settings]: エージェント固有設定を上書きします。例としてグローバル temperature や top_p の設定など。
[input_guardrails][agents.run.RunConfig.input_guardrails], [output_guardrails][agents.run.RunConfig.output_guardrails]: すべての実行に適用する入力 / 出力ガードレールのリスト。
[handoff_input_filter][agents.run.RunConfig.handoff_input_filter]: ハンドオフに入力フィルターが設定されていない場合に適用されるグローバル入力フィルター。新しいエージェントへ送信される入力を編集できます。詳細は [Handoff.input_filter][agents.handoffs.Handoff.input_filter] を参照してください。
[tracing_disabled][agents.run.RunConfig.tracing_disabled]: 実行全体のトレーシングを無効化します。
[trace_include_sensitive_data][agents.run.RunConfig.trace_include_sensitive_data]: トレースに LLM やツール呼び出しの入出力など、機微なデータを含めるかどうかを設定します。
[workflow_name][agents.run.RunConfig.workflow_name], [trace_id][agents.run.RunConfig.trace_id], [group_id][agents.run.RunConfig.group_id]: 実行のトレーシングワークフロー名、トレース ID、トレースグループ ID を設定します。少なくとも workflow_name の設定を推奨します。group_id を設定すると、複数の実行にまたがるトレースをリンクできます。
[trace_metadata][agents.run.RunConfig.trace_metadata]: すべてのトレースに付与するメタデータ。

会話 / チャットスレッド

いずれかの run メソッドを呼び出すと、1 つ以上のエージェントが実行され（つまり 1 つ以上の LLM 呼び出しが行われ）、チャット会話の 1 つの論理ターンを表します。例:

ユーザーターン: ユーザーがテキストを入力
Runner 実行: 最初のエージェントが LLM を呼び出し、ツールを実行し、2 番目のエージェントへハンドオフ。2 番目のエージェントがさらにツールを実行し、最終出力を生成。

エージェント実行の終了時に、ユーザーに何を表示するかは自由です。たとえば、エージェントが生成したすべての新しい項目を表示する、または最終出力のみを表示する等です。いずれの場合でも、ユーザーがフォローアップ質問をしたら、再度 run メソッドを呼び出せます。

次ターンの入力は、基底クラス [RunResultBase.to_input_list()][agents.result.RunResultBase.to_input_list] を使用して取得できます。

async def main():
    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    with trace(workflow_name="Conversation", group_id=thread_id):
        # First turn
        result = await Runner.run(agent, "What city is the Golden Gate Bridge in?")
        print(result.final_output)
        # San Francisco

        # Second turn
        new_input = result.to_input_list() + [{"role": "user", "content": "What state is it in?"}]
        result = await Runner.run(agent, new_input)
        print(result.final_output)
        # California

例外

特定の状況で SDK は例外を送出します。完全な一覧は [agents.exceptions][] にあります。概要は以下のとおりです。

[AgentsException][agents.exceptions.AgentsException]: SDK が送出するすべての例外の基底クラス
[MaxTurnsExceeded][agents.exceptions.MaxTurnsExceeded]: 実行が max_turns を超えた場合に送出
[ModelBehaviorError][agents.exceptions.ModelBehaviorError]: モデルが不正な出力（例: JSON 形式違反、存在しないツールの呼び出しなど）を生成した場合に送出
[UserError][agents.exceptions.UserError]: SDK の使用方法に誤りがある場合に送出
[InputGuardrailTripwireTriggered][agents.exceptions.InputGuardrailTripwireTriggered], [OutputGuardrailTripwireTriggered][agents.exceptions.OutputGuardrailTripwireTriggered]: ガードレールが発火した場合に送出

7.4 KiB Raw Permalink Blame History Unescape Escape