Skip to content

Commit ed0832a

Browse files
authored
Merge branch 'main' into fix/odd-length-audio-chunks-1824
2 parents a0c221d + a30c32e commit ed0832a

File tree

120 files changed

+2960
-2305
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+2960
-2305
lines changed

.github/workflows/tests.yml

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ jobs:
2222
enable-cache: true
2323
- name: Install dependencies
2424
run: make sync
25+
- name: Verify formatting
26+
run: make format-check
2527
- name: Run lint
2628
run: make lint
2729

@@ -41,6 +43,16 @@ jobs:
4143

4244
tests:
4345
runs-on: ubuntu-latest
46+
strategy:
47+
fail-fast: false
48+
matrix:
49+
python-version:
50+
- "3.10"
51+
- "3.11"
52+
- "3.12"
53+
- "3.13"
54+
# TODO: enable this https://github.com/openai/openai-agents-python/pull/1961/
55+
# - "3.14"
4456
env:
4557
OPENAI_API_KEY: fake-for-tests
4658
steps:
@@ -50,6 +62,7 @@ jobs:
5062
uses: astral-sh/setup-uv@v5
5163
with:
5264
enable-cache: true
65+
python-version: ${{ matrix.python-version }}
5366
- name: Install dependencies
5467
run: make sync
5568
- name: Run tests with coverage
@@ -71,7 +84,7 @@ jobs:
7184
- name: Build docs
7285
run: make build-docs
7386

74-
old_versions:
87+
old_version_tests:
7588
runs-on: ubuntu-latest
7689
env:
7790
OPENAI_API_KEY: fake-for-tests

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OpenAI Agents SDK
1+
# OpenAI Agents SDK [![PyPI](https://img.shields.io/pypi/v/openai-agents?label=pypi%20package)](https://pypi.org/project/openai-agents/)
22

33
The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows. It is provider-agnostic, supporting the OpenAI Responses and Chat Completions APIs, as well as 100+ other LLMs.
44

docs/ja/agents.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ search:
44
---
55
# エージェント
66

7-
エージェントはアプリの中核となる構成要素です。エージェントは、instructions とツールで構成された大規模言語モデル( LLM )です。
7+
エージェントはアプリの中核となる基本コンポーネントです。エージェントは、instructions と tools で構成された大規模言語モデル( LLM )です。
88

9-
## 基本設定
9+
## 基本構成
1010

11-
エージェントで最も一般的に設定するプロパティは次のとおりです
11+
よく設定するエージェントのプロパティは以下のとおりです
1212

13-
- `name`: エージェントを識別する必須の文字列
14-
- `instructions`: developer メッセージまたは system prompt とも呼ばれます。
15-
- `model`: 使用する LLM と、temperature、top_p などのモデル調整パラメーターを設定する任意の `model_settings`
16-
- `tools`: エージェントがタスクを達成するために使用できるツール
13+
- `name`: エージェントを識別する必須の文字列です
14+
- `instructions`: developer message または システムプロンプト とも呼ばれます。
15+
- `model`: どの LLM を使用するか、また任意の `model_settings` で temperature、top_p などのモデル調整パラメーターを設定できます
16+
- `tools`: エージェントがタスクを達成するために使用できるツールです
1717

1818
```python
1919
from agents import Agent, ModelSettings, function_tool
@@ -33,7 +33,7 @@ agent = Agent(
3333

3434
## コンテキスト
3535

36-
エージェントは自分の `context` 型に対してジェネリックです。コンテキストは依存性注入のためのツールで、あなたが作成して `Runner.run()` に渡すオブジェクトです。これはあらゆるエージェント、ツール、ハンドオフなどに渡され、エージェント実行のための依存関係と状態の寄せ集めとして機能します。コンテキストには任意の Python オブジェクトを指定できます
36+
エージェントはその `context` 型についてジェネリックです。コンテキストは依存性注入のためのツールで、あなたが作成して `Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、実行時の依存関係や状態をまとめて保持します。コンテキストには任意の Python オブジェクトを渡せます
3737

3838
```python
3939
@dataclass
@@ -52,7 +52,7 @@ agent = Agent[UserContext](
5252

5353
## 出力タイプ
5454

55-
デフォルトでは、エージェントはプレーンテキスト(すなわち `str`)の出力を生成します。特定の型の出力を生成したい場合は`output_type` パラメーターを使用できます。一般的な選択肢は [Pydantic](https://docs.pydantic.dev/) オブジェクトを使うことですが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップ可能な任意の型(dataclasses、リスト、TypedDict など)をサポートします。
55+
デフォルトでは、エージェントはプレーンテキスト(つまり `str`)の出力を生成します。特定の型の出力を生成させたい場合は`output_type` パラメーターを使用します。一般的には [Pydantic](https://docs.pydantic.dev/) オブジェクトを使いますが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップできる任意の型(dataclasses、lists、TypedDict など)をサポートします。
5656

5757
```python
5858
from pydantic import BaseModel
@@ -73,20 +73,20 @@ agent = Agent(
7373

7474
!!! note
7575

76-
`output_type` を渡すと、通常のプレーンテキスト応答ではなく、[structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用するようモデルに指示します
76+
`output_type` を渡すと、モデルは通常のプレーンテキスト応答ではなく、[structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用するよう指示されます
7777

78-
## マルチエージェントの設計パターン
78+
## 複数エージェントのシステム設計パターン
7979

80-
マルチエージェントシステムを設計する方法は多数ありますが、一般的に広く適用できるパターンは次の 2 つです
80+
マルチエージェントシステムの設計方法は多数ありますが、幅広く適用できるパターンとして次の 2 つがよく使われます
8181

82-
1. マネージャー(エージェントをツールとして): 中央のマネージャー/オーケストレーターが、ツールとして公開された専門のサブエージェントを呼び出し、会話の主導権を保持します。
83-
2. ハンドオフ: 対等なエージェント間で、会話を引き継ぐ専門エージェントに制御を渡します。これは分散型です。
82+
1. マネージャー(ツールとしてのエージェント): 中央のマネージャー/オーケストレーターが、ツールとして公開された専門サブエージェントを呼び出し、会話の主導権を保持します。
83+
2. ハンドオフ: 対等なエージェント同士が、会話を引き継ぐ専門エージェントに主導権を渡します。これは分散型です。
8484

85-
詳細は [エージェント構築の実践ガイド](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf) を参照してください
85+
詳細は[エージェント構築の実践ガイド](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf)をご覧ください
8686

87-
### マネージャー(エージェントをツールとして
87+
### マネージャー(ツールとしてのエージェント
8888

89-
`customer_facing_agent` はすべてのユーザー対応を行い、ツールとして公開された専門のサブエージェントを呼び出します。詳細は [ツール](tools.md#agents-as-tools) のドキュメントを参照してください
89+
`customer_facing_agent` がすべてのユーザーとのやり取りを担当し、ツールとして公開された専門サブエージェントを呼び出します。詳しくは [ツール](tools.md#agents-as-tools) のドキュメントをご覧ください
9090

9191
```python
9292
from agents import Agent
@@ -115,7 +115,7 @@ customer_facing_agent = Agent(
115115

116116
### ハンドオフ
117117

118-
ハンドオフは、エージェントが委譲できるサブエージェントです。ハンドオフが発生すると、委譲先のエージェントが会話履歴を受け取り、会話を引き継ぎます。このパターンにより、単一のタスクに優れたモジュール式の専門エージェントを実現できます。詳細は [ハンドオフ](handoffs.md) のドキュメントを参照してください
118+
ハンドオフは、エージェントが委任できるサブエージェントです。ハンドオフが発生すると、委任先のエージェントが会話履歴を受け取り、会話を引き継ぎます。このパターンにより、単一タスクに長けたモジュール式・専門特化のエージェントを実現できます。詳しくは [ハンドオフ](handoffs.md) のドキュメントをご覧ください
119119

120120
```python
121121
from agents import Agent
@@ -136,7 +136,7 @@ triage_agent = Agent(
136136

137137
## 動的 instructions
138138

139-
多くの場合、エージェント作成時に instructions を指定できますが、関数を通じて動的な instructions を提供することもできます。関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数の両方が利用可能です
139+
多くの場合、エージェントを作成するときに instructions を指定しますが、関数を通じて動的な instructions を提供することもできます。関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数の両方が利用できます
140140

141141
```python
142142
def dynamic_instructions(
@@ -153,15 +153,15 @@ agent = Agent[UserContext](
153153

154154
## ライフサイクルイベント(フック)
155155

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

158158
## ガードレール
159159

160-
ガードレールにより、エージェントの実行と並行してユーザー入力に対するチェック/検証を行い、生成された後のエージェント出力に対してもチェック/検証を実施できます。たとえば、ユーザー入力とエージェント出力の関連性をスクリーニングできます。詳細は [ガードレール](guardrails.md) のドキュメントを参照してください
160+
ガードレールにより、エージェントの実行と並行して ユーザー入力 に対するチェック/検証を行い、また、エージェントが出力を生成した後にその出力に対してもチェックを実行できます。たとえば、ユーザー入力とエージェント出力を関連性でスクリーニングできます。詳しくは [ガードレール](guardrails.md) のドキュメントをご覧ください
161161

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

164-
エージェントの `clone()` メソッドを使用すると、エージェントを複製し、必要に応じて任意のプロパティを変更できます
164+
エージェントの `clone()` メソッドを使うと、エージェントを複製し、任意のプロパティを変更できます
165165

166166
```python
167167
pirate_agent = Agent(
@@ -178,12 +178,12 @@ robot_agent = pirate_agent.clone(
178178

179179
## ツール使用の強制
180180

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

183-
1. `auto`: LLM がツールを使用するかどうかを判断します
184-
2. `required`: LLM にツールの使用を要求します(どのツールを使うかは賢く判断できます)。
183+
1. `auto`: ツールを使用するかどうかを LLM に任せます
184+
2. `required`: LLM にツールの使用を必須にします(どのツールを使うかは知的に判断します)。
185185
3. `none`: LLM にツールを _使用しない_ ことを要求します。
186-
4. 特定の文字列(例: `my_tool`)を設定: その特定のツールを LLM に使用させます
186+
4. 特定の文字列(例: `my_tool`)を設定: LLM にその特定のツールの使用を要求します
187187

188188
```python
189189
from agents import Agent, Runner, function_tool, ModelSettings
@@ -201,12 +201,12 @@ agent = Agent(
201201
)
202202
```
203203

204-
## ツール使用の挙動
204+
## ツール使用の動作
205205

206-
`Agent` `tool_use_behavior` パラメーターは、ツールの出力をどのように扱うかを制御します
206+
`Agent` の設定パラメーター `tool_use_behavior` は、ツール出力の取り扱い方法を制御します
207207

208-
- `"run_llm_again"`: デフォルト。ツールを実行し、LLM が結果を処理して最終応答を生成します
209-
- `"stop_on_first_tool"`: 最初のツール呼び出しの出力を、追加の LLM 処理なしで最終応答として使用します。
208+
- `"run_llm_again"`: デフォルト。ツールを実行し、その結果を LLM が処理して最終応答を生成します
209+
- `"stop_on_first_tool"`: 最初のツール呼び出しの出力を、その後の LLM 処理なしで最終応答として使用します。
210210

211211
```python
212212
from agents import Agent, Runner, function_tool, ModelSettings
@@ -224,7 +224,7 @@ agent = Agent(
224224
)
225225
```
226226

227-
- `StopAtTools(stop_at_tool_names=[...])`: 指定したいずれかのツールが呼び出された時点で停止し、その出力を最終応答として使用します
227+
- `StopAtTools(stop_at_tool_names=[...])`: 指定したいずれかのツールが呼び出されたら停止し、その出力を最終応答として使用します.
228228

229229
```python
230230
from agents import Agent, Runner, function_tool
@@ -248,7 +248,7 @@ agent = Agent(
248248
)
249249
```
250250

251-
- `ToolsToFinalOutputFunction`: ツール結果を処理し、停止するか LLM を継続するかを判断するカスタム関数
251+
- `ToolsToFinalOutputFunction`: ツール結果を処理し、停止するか LLM を継続するかを判断するカスタム関数です
252252

253253
```python
254254
from agents import Agent, Runner, function_tool, FunctionToolResult, RunContextWrapper
@@ -286,4 +286,4 @@ agent = Agent(
286286

287287
!!! note
288288

289-
無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループは、ツール結果が LLM に送られ、`tool_choice` によって LLM がさらに別のツール呼び出しを生成し続けることで発生します
289+
無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この動作は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループは、ツール結果が LLM に送られ、`tool_choice` により LLM が再度ツール呼び出しを生成し続けることによって発生します

0 commit comments

Comments
 (0)