Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
137 changes: 71 additions & 66 deletions docs/ja/agents.md

Large diffs are not rendered by default.

38 changes: 21 additions & 17 deletions docs/ja/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,29 @@ search:
---
# 設定

このページでは、デフォルトの OpenAI キーやクライアント、デフォルトの OpenAI API 形式、トレーシングのエクスポート既定値、ロギングの動作など、通常はアプリケーション起動時に一度だけ設定する SDK 全体のデフォルトについて説明します
このページでは、通常はアプリケーション起動時に一度だけ設定する SDK 全体のデフォルト値(デフォルトの OpenAI キーまたはクライアント、デフォルトの OpenAI API 形式、トレーシングエクスポートのデフォルト値、ロギング動作など)について説明します

代わりに特定のエージェントや実行を設定する必要がある場合は、次から始めてください
これらのデフォルト値は sandbox ベースのワークフローにも適用されますが、sandbox ワークスペース、sandbox クライアント、セッション再利用は個別に設定します

- `RunConfig`、セッション、会話状態オプションについては [エージェントの実行](running_agents.md)。
- モデル選択とプロバイダー設定については [モデル](models/index.md)。
- 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーについては [トレーシング](tracing.md)。
代わりに特定のエージェントまたは実行を設定する必要がある場合は、次から始めてください。

- 通常の `Agent` における instructions、tools、出力型、ハンドオフ、ガードレールは [Agents](agents.md) を参照してください。
- `RunConfig`、セッション、会話状態オプションは [Running agents](running_agents.md) を参照してください。
- `SandboxRunConfig`、マニフェスト、機能、sandbox クライアント固有のワークスペース設定は [Sandbox agents](sandbox/guide.md) を参照してください。
- モデル選択とプロバイダー設定は [Models](models/index.md) を参照してください。
- 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーは [Tracing](tracing.md) を参照してください。

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

デフォルトでは、 SDK は LLM リクエストとトレーシングに `OPENAI_API_KEY` 環境変数を使用します。このキーは SDK が最初に OpenAI クライアントを作成したときに解決されるため(遅延初期化)、最初のモデル呼び出しの前に環境変数を設定してください。アプリ起動前にその環境変数を設定できない場合は、キーを設定するために [set_default_openai_key()][agents.set_default_openai_key] 関数を使用できます。
デフォルトでは、SDK は LLM リクエストとトレーシングに `OPENAI_API_KEY` 環境変数を使用します。キーは SDK が最初に OpenAI クライアントを作成するとき(遅延初期化)に解決されるため、最初のモデル呼び出し前に環境変数を設定してください。アプリ起動前にその環境変数を設定できない場合は、キーを設定するために [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` インスタンスを作成し、環境変数の API キーまたは上で設定したデフォルトキーを使用します。これは [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 @@ -32,7 +36,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 @@ -42,15 +46,15 @@ set_default_openai_api("chat_completions")

## トレーシング

トレーシングはデフォルトで有効です。デフォルトでは、上記セクションのモデルリクエストと同じ OpenAI API キー(つまり環境変数または設定したデフォルトキー)を使用します。トレーシングで使用する API キーは、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数で個別に設定できます
トレーシングはデフォルトで有効です。デフォルトでは、上記セクションのモデルリクエストと同じ OpenAI API キー(つまり、環境変数または設定したデフォルトキー)を使用します。トレーシングに使用する API キーを明示的に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します

```python
from agents import set_tracing_export_api_key

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

デフォルトのエクスポーター使用時にトレースを特定の organization や project に紐付ける必要がある場合は、アプリ起動前に次の環境変数を設定してください。
デフォルトエクスポーター使用時に、特定の組織またはプロジェクトにトレースを紐付ける必要がある場合は、アプリ起動前に次の環境変数を設定してください。

```bash
export OPENAI_ORG_ID="org_..."
Expand All @@ -77,7 +81,7 @@ from agents import set_tracing_disabled
set_tracing_disabled(True)
```

トレーシングは有効のままにしつつ、機密性の高い可能性がある入出力をトレースペイロードから除外したい場合は、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] を `False` に設定してください
トレーシングは有効のままにしつつ、機密性がある可能性のある入力/出力をトレースペイロードから除外したい場合は、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] を `False` に設定します

```python
from agents import Runner, RunConfig
Expand All @@ -89,27 +93,27 @@ await Runner.run(
)
```

アプリ起動前にこの環境変数を設定すれば、コードを書かずにデフォルトを変更することもできます
コードを書かずにデフォルトを変更するには、アプリ起動前にこの環境変数を設定することもできます

```bash
export OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA=0
```

トレーシング制御の詳細は、[トレーシングガイド](tracing.md) を参照してください。
トレーシング制御の全体については、[tracing guide](tracing.md) を参照してください。

## デバッグロギング

SDK は 2 つの Python ロガー(`openai.agents` と `openai.agents.tracing`)を定義しており、デフォルトではハンドラーをアタッチしません。ログはアプリケーションの Python ロギング設定に従います。

詳細なロギングを有効にするには、[`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 guide](https://docs.python.org/3/howto/logging.html) を参照してください。
または、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることもできます。詳細は [Python logging guide](https://docs.python.org/3/howto/logging.html) を参照してください。

```python
import logging
Expand All @@ -130,9 +134,9 @@ logger.addHandler(logging.StreamHandler())

### ログ内の機密データ

一部のログには機密データ(たとえばユーザーデータ)が含まれる可能性があります
一部のログには機密データ(たとえば、ユーザーデータ)が含まれる場合があります

デフォルトでは、 SDK は LLM の入出力やツールの入出力を **ログに記録しません** 。これらの保護は次によって制御されます
デフォルトでは、SDK は LLM の入力/出力やツールの入力/出力を **記録しません**。これらの保護は次で制御されます

```bash
OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
Expand Down
Loading