Skip to content

Update all translated document pages #1289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2025
Merged

Update all translated document pages #1289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions docs/ja/agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ search:
---
# エージェント

エージェントはアプリの中心となる構成要素です。エージェントは、大規模言語モデル ( LLM ) を instructions とツールで設定したものです。
エージェントは、アプリにおける中核的なビルディングブロックです。エージェントは、インストラクションとツールで構成された LLM です。

## 基本設定

エージェントで最もよく設定するプロパティは以下のとおりです。
エージェントで最もよく設定するプロパティは次のとおりです:

- `name` : エージェントを識別する必須の文字列です。
- `instructions` : developer メッセージまたは system prompt とも呼ばれます。
- `model` : 使用する LLM を指定します。また、`temperature` 、`top_p` などのモデル調整パラメーターを設定する `model_settings` をオプションで指定できます。
- `tools` : エージェントがタスクを達成するために使用できるツールです。
- `name`: エージェントを識別する必須の文字列です。
- `instructions`: 開発者メッセージ、または system prompt とも呼ばれます。
- `model`: 使用する LLM を指定します。`model_settings` を併用すると temperature、top_p などのモデル調整パラメーターを設定できます。
- `tools`: エージェントがタスク達成のために使用できるツールです。

```python
from agents import Agent, ModelSettings, function_tool
Expand All @@ -33,7 +33,7 @@ agent = Agent(

## コンテキスト

エージェントは `context` 型についてジェネリックです。コンテキストは依存性注入用のツールで、`Runner.run()` に渡すオブジェクトです。このオブジェクトはすべてのエージェント、ツール、ハンドオフなどに渡され、実行中の依存関係や状態をまとめて保持します。任意の Python オブジェクトをコンテキストとして渡せます。
エージェントは `context` 型に対してジェネリックです。コンテキストは依存性注入の仕組みで、`Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、エージェント実行時の依存関係と状態を格納する入れ物として機能します。コンテキストには任意の Python オブジェクトを指定できます。

```python
@dataclass
Expand All @@ -52,7 +52,7 @@ agent = Agent[UserContext](

## 出力タイプ

デフォルトでは、エージェントはプレーンテキスト（つまり `str`）を出力します。特定の型で出力を受け取りたい場合は、`output_type` パラメーターを使用します。よく使われるのは Pydantic オブジェクトですが、Pydantic TypeAdapter でラップできる型であれば何でも対応しています。たとえば dataclasses 、lists 、TypedDict などです。
既定では、エージェントはプレーンテキスト (つまり `str`) を出力します。特定の型で出力させたい場合は `output_type` パラメーターを使用できます。よく使われるのは Pydantic オブジェクトですが、Pydantic の TypeAdapter でラップできる型 — dataclass、list、TypedDict など — であれば何でもサポートしています。

```python
from pydantic import BaseModel
Expand All @@ -73,11 +73,11 @@ agent = Agent(

!!! note

`output_type` を渡すと、モデルに通常のプレーンテキストではなく structured outputs を使用するよう指示します。
`output_type` を渡すと、モデルは通常のプレーンテキスト応答の代わりに structured outputs を使用するよう指示されます。

## ハンドオフ

ハンドオフは、エージェントが委任できるサブエージェントです。ハンドオフのリストを渡すと、エージェントは必要に応じてそれらに処理を委任できます。これは、単一のタスクに特化したモジュール化されたエージェントをオーケストレーションする強力なパターンです。詳細は [handoffs](handoffs.md) ドキュメントを参照してください。
ハンドオフは、エージェントが委譲できるサブエージェントです。ハンドオフのリストを渡すと、必要に応じてエージェントがそれらに処理を委譲できます。これは、単一タスクに特化したモジュール式のエージェントをオーケストレーションする強力なパターンです。詳細は [handoffs](handoffs.md) ドキュメントをご覧ください。

```python
from agents import Agent
Expand All @@ -96,9 +96,9 @@ triage_agent = Agent(
)
```

## 動的 instructions
## 動的インストラクション

ほとんどの場合、エージェント作成時に instructions を指定できます。ただし、関数を通じて動的 instructions を提供することもできます。この関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。同期関数と `async` 関数の両方が使用可能です。
通常はエージェント作成時にインストラクションを指定しますが、関数を介して動的に渡すこともできます。その関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数の両方が利用可能です。

```python
def dynamic_instructions(
Expand All @@ -113,17 +113,17 @@ agent = Agent[UserContext](
)
```

## ライフサイクルイベント (hooks)
## ライフサイクルイベント（フック）

エージェントのライフサイクルを監視したい場合があります。たとえば、イベントをログに記録したり、特定のイベント発生時にデータを事前取得したりしたい場合です。`hooks` プロパティを使用してエージェントのライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスをサブクラス化し、興味のあるメソッドをオーバーライドしてください。
エージェントのライフサイクルを観察したい場合があります。たとえば、イベントをログに記録したり、特定のイベント発生時にデータをプリフェッチしたりするケースです。そのようなときは `hooks` プロパティを使ってライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスを継承し、関心のあるメソッドをオーバーライドしてください。

## ガードレール

ガードレールを使用すると、エージェントの実行と並行してユーザー入力に対してチェックやバリデーションを実行できます。たとえば、ユーザー入力の関連性をフィルタリングすることが可能です。詳細は [guardrails](guardrails.md) ドキュメントをご覧ください。
ガードレールを使用すると、エージェントの実行と並行してユーザー入力のチェックやバリデーションを行えます。たとえば、ユーザー入力の関連性をスクリーニングできます。詳細は [guardrails](guardrails.md) ドキュメントを参照してください。

## エージェントのクローン/コピー

`clone()` メソッドを使用すると、エージェントを複製し、任意のプロパティを変更できます。
エージェントの `clone()` メソッドを使用すると、エージェントを複製し、任意のプロパティを変更できます。

```python
pirate_agent = Agent(
Expand All @@ -140,15 +140,15 @@ robot_agent = pirate_agent.clone(

## ツール使用の強制

ツールのリストを渡しても、 LLM が必ずツールを使用するとは限りません。[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定することでツールの使用を強制できます。有効な値は次のとおりです。
ツールのリストを指定しても、 LLM が必ずしもツールを使用するとは限りません。[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定することでツール使用を強制できます。指定可能な値は次のとおりです:

1. `auto` : LLM がツールを使用するかどうかを判断します。
2. `required` : LLM にツール使用を必須とします（どのツールを使うかは LLM が判断します）。
3. `none` : LLM にツールを使用しないよう要求します。
4. 具体的な文字列を指定する（`my_tool` など）: LLM にそのツールを必ず使用させます。
1. `auto` — LLM がツールを使うかどうかを判断します。
2. `required` — LLM にツールの使用を必須とします (ただしどのツールを使うかは自動で判断)。
3. `none` — LLM にツールを使用しないことを要求します。
4. 具体的な文字列 (例: `my_tool`) — LLM にその特定のツールを使用させます。

!!! note

無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に `auto` にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループとは、ツールの結果が LLM に送られ、その後 `tool_choice` により再びツール呼び出しが生成される、というサイクルが延々と続くことを指します。
無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループは、ツール結果が LLM に送られ、それにより `tool_choice` の設定でさらにツール呼び出しが生成される、というサイクルが延々と続くために発生します。

ツール呼び出し後に auto モードで続行せず、完全に停止させたい場合は、[`Agent.tool_use_behavior="stop_on_first_tool"`] を設定してください。ツール出力をそのまま最終応答として使用し、追加の LLM 処理を行いません。
ツール呼び出し後に (auto モードで続行するのではなく) エージェントを完全に停止させたい場合は、[`Agent.tool_use_behavior="stop_on_first_tool"`] を設定してください。これにより、ツールの出力をそのまま最終レスポンスとして使用し、追加の LLM 処理を行いません。
24 changes: 12 additions & 12 deletions docs/ja/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ search:

## API キーとクライアント

デフォルトでは、SDK はインポート直後に LLM リクエストとトレーシングのために `OPENAI_API_KEY` 環境変数を参照します。アプリ起動前にこの環境変数を設定できない場合は、[set_default_openai_key()][agents.set_default_openai_key] 関数を使用してキーを設定できます。
デフォルトでは、 SDK はインポートされるとすぐに LLM リクエストとトレーシングのために `OPENAI_API_KEY` 環境変数を探します。アプリ起動前にその環境変数を設定できない場合は、 [set_default_openai_key()][agents.set_default_openai_key] 関数を使用してキーを設定できます。

```python
from agents import set_default_openai_key

set_default_openai_key("sk-...")
```

あるいは、使用する OpenAI クライアントを設定することもできます。デフォルトでは、SDK は環境変数または前述のデフォルトキーを用いて `AsyncOpenAI` インスタンスを生成します。これを変更したい場合は、[set_default_openai_client()][agents.set_default_openai_client] 関数を使用してください。
また、使用する OpenAI クライアントを設定することもできます。デフォルトでは、 SDK は環境変数で指定された API キーまたは上記で設定したデフォルトキーを使って `AsyncOpenAI` インスタンスを生成します。 [set_default_openai_client()][agents.set_default_openai_client] 関数を使うことでこれを変更できます。

```python
from openai import AsyncOpenAI
Expand All @@ -24,7 +24,7 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...")
set_default_openai_client(custom_client)
```

最後に、利用する OpenAI API をカスタマイズすることも可能です。デフォルトでは OpenAI Responses API を使用しますが、[set_default_openai_api()][agents.set_default_openai_api] 関数を使って Chat Completions API に切り替えられます。
最後に、使用する OpenAI API をカスタマイズすることも可能です。デフォルトでは OpenAI Responses API を使用しますが、 [set_default_openai_api()][agents.set_default_openai_api] 関数を使って Chat Completions API に変更できます。

```python
from agents import set_default_openai_api
Expand All @@ -34,35 +34,35 @@ set_default_openai_api("chat_completions")

## トレーシング

トレーシングはデフォルトで有効になっています。使用される OpenAI API キーは前述の方法（環境変数または設定したデフォルトキー）と同じです。トレーシングで使用する API キーを個別に設定する場合は、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を利用してください。
トレーシングはデフォルトで有効になっています。デフォルトでは、上記セクションと同じ OpenAI API キー（環境変数または設定したデフォルトキー）を使用します。 [`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使ってトレーシングに使用する API キーを個別に設定できます。

```python
from agents import set_tracing_export_api_key

set_tracing_export_api_key("sk-...")
```

トレーシングを完全に無効化したい場合は、[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使用します。
[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使用してトレーシングを完全に無効化することもできます。

```python
from agents import set_tracing_disabled

set_tracing_disabled(True)
```

## デバッグログ
## デバッグロギング

SDK にはハンドラーが設定されていない 2 つの Python ロガーがあります。デフォルトでは、警告とエラーは `stdout` に出力されますが、それ以外のログは抑制されます。
SDK にはハンドラーが設定されていない Python ロガーが 2 つあります。デフォルトでは警告とエラーが `stdout` に出力され、その他のログは抑制されます。

詳細なログを有効にするには、[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用してください。
詳細なログを有効にするには、 [`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用してください。

```python
from agents import enable_verbose_stdout_logging

enable_verbose_stdout_logging()
```

また、ハンドラー・フィルター・フォーマッターなどを追加してログをカスタマイズすることもできます。詳細は [Python logging ガイド](https://docs.python.org/3/howto/logging.html) を参照してください。
ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることもできます。詳細は [Python logging ガイド](https://docs.python.org/3/howto/logging.html) をご覧ください。

```python
import logging
Expand All @@ -83,15 +83,15 @@ logger.addHandler(logging.StreamHandler())

### ログに含まれる機密データ

一部のログには機密データ（たとえばユーザーデータ）が含まれる場合があります。これらのデータのログ出力を無効にしたい場合は、以下の環境変数を設定してください。
一部のログには機密データ（例: ユーザー データ）が含まれる場合があります。これらのデータをログに残さないようにするには、次の環境変数を設定してください。

LLM の入力と出力のロギングを無効にする:
LLM の入力と出力をログに残さないようにするには:

```bash
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
```

ツールの入力と出力のロギングを無効にする:
ツールの入力と出力をログに残さないようにするには:

```bash
export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1
Expand Down
Loading