@@ -4,21 +4,21 @@ search:
44---
55# クイックスタート
66
7- Python SDK のリアルタイムエージェントは、 WebSocket トランスポート経由の OpenAI Realtime API を基盤とする、サーバー側の低レイテンシエージェントです 。
7+ Python SDK のリアルタイムエージェントは、WebSocket トランスポート経由の OpenAI Realtime API 上に構築された、サーバー側の低レイテンシーエージェントです 。
88
9- !!! note "Python SDK の範囲 "
9+ !!! note "Python SDK の境界 "
1010
11- Python SDK はブラウザー向け WebRTC トランスポートを **提供しません ** 。このページでは、サーバー側 WebSocket 上で Python が管理するリアルタイムセッションのみを扱います 。この SDK は、サーバー側のオーケストレーション、ツール、承認、テレフォニー連携に使用してください。[リアルタイムトランスポート](transport.md) も参照してください。
11+ Python SDK は、ブラウザーの WebRTC トランスポートを **提供していません ** 。このページでは、サーバー側 WebSocket を介して Python で管理されるリアルタイムセッションのみを扱います 。この SDK は、サーバー側のオーケストレーション、ツール、承認、テレフォニー連携に使用してください。併せて [リアルタイムトランスポート](transport.md) も参照してください。
1212
1313## 前提条件
1414
1515- Python 3.10 以上
1616- OpenAI API キー
17- - OpenAI Agents SDK に関する基本的な知識
17+ - OpenAI Agents SDK の基本的な知識
1818
1919## インストール
2020
21- まだの場合は、 OpenAI Agents SDK をインストールしてください:
21+ まだインストールしていない場合は、 OpenAI Agents SDK をインストールしてください:
2222
2323``` bash
2424pip install openai-agents
@@ -34,7 +34,7 @@ import asyncio
3434from agents.realtime import RealtimeAgent, RealtimeRunner
3535```
3636
37- ### 2. 開始時のエージェントの定義
37+ ### 2. 開始エージェントの定義
3838
3939``` python
4040agent = RealtimeAgent(
@@ -45,7 +45,7 @@ agent = RealtimeAgent(
4545
4646### 3. ランナーの設定
4747
48- 新しいコードでは、ネストされた ` audio.input ` / ` audio.output ` のセッション設定形式を推奨します。新しいリアルタイムエージェントでは、 ` gpt-realtime-2 ` から始めてください。
48+ 新しいコードでは、ネストされた ` audio.input ` / ` audio.output ` のセッション設定形式を推奨します。新しいリアルタイムエージェントでは、` gpt-realtime-2 ` から始めてください。
4949
5050``` python
5151runner = RealtimeRunner(
@@ -100,35 +100,35 @@ if __name__ == "__main__":
100100 asyncio.run(main())
101101```
102102
103- ` session.send_message() ` は、プレーンな文字列または構造化されたリアルタイムメッセージを受け付けます。未加工の音声チャンクには、 [ ` session.send_audio() ` ] [ agents.realtime.session.RealtimeSession.send_audio ] を使用してください。
103+ ` session.send_message() ` は、プレーン文字列または構造化されたリアルタイムメッセージのいずれかを受け取ります。生の音声チャンクには、 [ ` session.send_audio() ` ] [ agents.realtime.session.RealtimeSession.send_audio ] を使用してください。
104104
105105## このクイックスタートに含まれない内容
106106
107- - マイクキャプチャとスピーカー再生のコード。リアルタイムのコード例については、 [ ` examples/realtime ` ] ( https://github.com/openai/openai-agents-python/tree/main/examples/realtime ) を参照してください 。
107+ - マイクのキャプチャおよびスピーカー再生のコード。 [ ` examples/realtime ` ] ( https://github.com/openai/openai-agents-python/tree/main/examples/realtime ) のリアルタイムのコード例を参照してください 。
108108- SIP / テレフォニーのアタッチフロー。[ リアルタイムトランスポート] ( transport.md ) と [ SIP セクション] ( guide.md#sip-and-telephony ) を参照してください。
109109
110110## 主要設定
111111
112- 基本的なセッションが動作したら 、多くの方が次に利用する設定は次のとおりです:
112+ 基本的なセッションが動作するようになったら 、多くの方が次に利用する設定は次のとおりです:
113113
114114- ` model_name `
115115- ` audio.input.format ` , ` audio.output.format `
116116- ` audio.input.transcription `
117117- ` audio.input.noise_reduction `
118- - 自動ターン検出用の ` audio.input.turn_detection `
118+ - ` audio.input.turn_detection ` (自動ターン検出用)
119119- ` audio.output.voice `
120120- ` tool_choice ` , ` prompt ` , ` tracing `
121- - ` async_tool_calls ` , ` guardrails_settings.debounce_text_length ` , ` tool_error_formatter `
121+ - ` async_tool_calls ` , ` tool_execution.pre_approval_tool_input_guardrails ` , ` guardrails_settings.debounce_text_length ` , ` tool_error_formatter `
122122
123- ` input_audio_format ` 、` output_audio_format ` 、` input_audio_transcription ` 、` turn_detection ` などの古いフラットなエイリアスも引き続き機能しますが、新しいコードではネストされた ` audio ` 設定を推奨します 。
123+ ` input_audio_format ` 、` output_audio_format ` 、` input_audio_transcription ` 、` turn_detection ` などの古いフラットなエイリアスも引き続き機能しますが、新しいコードではネストされた ` audio ` 設定が推奨されます 。
124124
125- 手動のターン制御では、 [ リアルタイムエージェントガイド] ( guide.md#manual-response-control ) で説明されているように、 raw な ` session.update ` / ` input_audio_buffer.commit ` / ` response.create ` フローを使用してください。
125+ 手動のターン制御には、 [ リアルタイムエージェントガイド] ( guide.md#manual-response-control ) で説明されている raw な ` session.update ` / ` input_audio_buffer.commit ` / ` response.create ` フローを使用してください。
126126
127- 完全なスキーマについては、 [ ` RealtimeRunConfig ` ] [ agents.realtime.config.RealtimeRunConfig ] と [ ` RealtimeSessionModelSettings ` ] [ agents.realtime.config.RealtimeSessionModelSettings ] を参照してください。
127+ 完全なスキーマについては、[ ` RealtimeRunConfig ` ] [ agents.realtime.config.RealtimeRunConfig ] および [ ` RealtimeSessionModelSettings ` ] [ agents.realtime.config.RealtimeSessionModelSettings ] を参照してください。
128128
129129## 接続オプション
130130
131- 環境で API キーを設定します :
131+ API キーを環境変数に設定してください :
132132
133133``` bash
134134export OPENAI_API_KEY=" your-api-key-here"
@@ -140,19 +140,19 @@ export OPENAI_API_KEY="your-api-key-here"
140140session = await runner.run(model_config = {" api_key" : " your-api-key" })
141141```
142142
143- ` model_config ` は以下もサポートしています :
143+ ` model_config ` は以下にも対応しています :
144144
145145- ` url ` : カスタム WebSocket エンドポイント
146146- ` headers ` : カスタムリクエストヘッダー
147- - ` call_id ` : 既存のリアルタイム通話にアタッチします。このリポジトリでは、ドキュメント化されているアタッチフローは SIP です。
148- - ` playback_tracker ` : ユーザーが実際に聞いた音声の量を報告します
147+ - ` call_id ` : 既存のリアルタイムコールにアタッチします。このリポジトリでドキュメント化されているアタッチフローは SIP です。
148+ - ` playback_tracker ` : ユーザーが実際に聞いた音声量を報告します
149149
150- ` headers ` を明示的に渡す場合、 SDK は ` Authorization ` ヘッダーを ** 挿入しません** 。
150+ ` headers ` を明示的に渡す場合、SDK は ` Authorization ` ヘッダーを ** 挿入しません** 。
151151
152- Azure OpenAI に接続する場合は、 ` model_config["url"] ` に GA Realtime エンドポイント URL を指定し、ヘッダーを明示的に渡してください 。リアルタイムエージェントでは、レガシーのベータパス ( ` /openai/realtime?api-version=... ` ) は避けてください。詳細は [ リアルタイムエージェントガイド] ( guide.md#low-level-access-and-custom-endpoints ) を参照してください。
152+ Azure OpenAI に接続する場合は、` model_config["url"] ` に GA Realtime エンドポイント URL を指定し、明示的なヘッダーも渡してください 。リアルタイムエージェントでは、レガシーな beta パス( ` /openai/realtime?api-version=... ` )の使用は避けてください。詳細については、 [ リアルタイムエージェントガイド] ( guide.md#low-level-access-and-custom-endpoints ) を参照してください。
153153
154154## 次のステップ
155155
156- - サーバー側 WebSocket と SIP のどちらを選ぶかについては、 [ リアルタイムトランスポート] ( transport.md ) をお読みください。
157- - ライフサイクル、構造化入力、承認、ハンドオフ、ガードレール、低レベル制御については、 [ リアルタイムエージェントガイド] ( guide.md ) をお読みください。
158- - [ ` examples/realtime ` ] ( https://github.com/openai/openai-agents-python/tree/main/examples/realtime ) のコード例を参照してください 。
156+ - サーバー側 WebSocket と SIP のどちらを選ぶかを判断するには、 [ リアルタイムトランスポート] ( transport.md ) をお読みください。
157+ - ライフサイクル、構造化入力、承認、ハンドオフ、ガードレール、低レベル制御については、[ リアルタイムエージェントガイド] ( guide.md ) をお読みください。
158+ - [ ` examples/realtime ` ] ( https://github.com/openai/openai-agents-python/tree/main/examples/realtime ) のコード例をご覧ください 。
0 commit comments