5639606163
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.
98 lines
No EOL
3.8 KiB
Markdown
98 lines
No EOL
3.8 KiB
Markdown
---
|
|
search:
|
|
exclude: true
|
|
---
|
|
# SDK の設定
|
|
|
|
## API キーとクライアント
|
|
|
|
デフォルトでは、 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] 関数を使用します。
|
|
|
|
```python
|
|
from openai import AsyncOpenAI
|
|
from agents import set_default_openai_client
|
|
|
|
custom_client = AsyncOpenAI(base_url="...", api_key="...")
|
|
set_default_openai_client(custom_client)
|
|
```
|
|
|
|
さらに、使用する OpenAI API をカスタマイズすることもできます。既定では OpenAI Responses API を利用します。これを Chat Completions API に変更するには、 [set_default_openai_api()][agents.set_default_openai_api] 関数を使用してください。
|
|
|
|
```python
|
|
from agents import set_default_openai_api
|
|
|
|
set_default_openai_api("chat_completions")
|
|
```
|
|
|
|
## トレーシング
|
|
|
|
トレーシングはデフォルトで有効になっています。前述の 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-...")
|
|
```
|
|
|
|
トレーシングを完全に無効化するには、 [`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を呼び出します。
|
|
|
|
```python
|
|
from agents import set_tracing_disabled
|
|
|
|
set_tracing_disabled(True)
|
|
```
|
|
|
|
## デバッグログ
|
|
|
|
SDK にはハンドラーが設定されていない Python ロガーが 2 つあります。デフォルトでは、警告とエラーは `stdout` に出力されますが、それ以外のログは抑制されます。
|
|
|
|
詳細なログを有効にするには、 [`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します。
|
|
|
|
```python
|
|
from agents import enable_verbose_stdout_logging
|
|
|
|
enable_verbose_stdout_logging()
|
|
```
|
|
|
|
必要に応じて、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることも可能です。詳しくは [Python ロギングガイド](https://docs.python.org/3/howto/logging.html) を参照してください。
|
|
|
|
```python
|
|
import logging
|
|
|
|
logger = logging.getLogger("openai.agents") # or openai.agents.tracing for the Tracing logger
|
|
|
|
# To make all logs show up
|
|
logger.setLevel(logging.DEBUG)
|
|
# To make info and above show up
|
|
logger.setLevel(logging.INFO)
|
|
# To make warning and above show up
|
|
logger.setLevel(logging.WARNING)
|
|
# etc
|
|
|
|
# You can customize this as needed, but this will output to `stderr` by default
|
|
logger.addHandler(logging.StreamHandler())
|
|
```
|
|
|
|
### ログに含まれる機微情報
|
|
|
|
特定のログには機微情報（たとえば ユーザー データ）が含まれる場合があります。この情報が記録されるのを防ぎたい場合は、次の環境変数を設定してください。
|
|
|
|
LLM の入力および出力のログを無効にする:
|
|
|
|
```bash
|
|
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
|
|
```
|
|
|
|
ツールの入力および出力のログを無効にする:
|
|
|
|
```bash
|
|
export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1
|
|
``` |