Skip to content

Commit 47ff1da

Browse files
docs: update translated document pages (#2719)
1 parent fc609e1 commit 47ff1da

File tree

3 files changed

+134
-131
lines changed

3 files changed

+134
-131
lines changed

docs/ja/tracing.md

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,35 @@ search:
44
---
55
# トレーシング
66

7-
Agents SDK には組み込みのトレーシングが含まれており、エージェント実行中のイベント( LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、さらに発生したカスタムイベント)を包括的に記録します。[Traces ダッシュボード](https://platform.openai.com/traces) を使用すると、開発中および本番環境でワークフローをデバッグ、可視化、監視できます。
7+
Agents SDK には組み込みのトレーシングが含まれており、エージェント実行中のイベント( LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、さらには発生したカスタムイベント)を包括的に記録します。[Traces ダッシュボード](https://platform.openai.com/traces) を使用すると、開発中および本番環境でワークフローをデバッグ、可視化、監視できます。
88

99
!!!note
1010

11-
トレーシングはデフォルトで有効です。無効化する一般的な方法は 3 つあります
11+
トレーシングはデフォルトで有効です。一般的な方法として、次の 3 つで無効化できます
1212

13-
1. 環境変数 `OPENAI_AGENTS_DISABLE_TRACING=1` を設定して、トレーシングをグローバルに無効化できます
14-
2. [`set_tracing_disabled(True)`][agents.set_tracing_disabled] を使ってコード内でトレーシングをグローバルに無効化できます
15-
3. [`agents.run.RunConfig.tracing_disabled`][] を `True` に設定して、単一の実行に対してトレーシングを無効化できます
13+
1. 環境変数 `OPENAI_AGENTS_DISABLE_TRACING=1` を設定して、グローバルにトレーシングを無効化できます
14+
2. [`set_tracing_disabled(True)`][agents.set_tracing_disabled] を使って、コード内でグローバルにトレーシングを無効化できます
15+
3. [`agents.run.RunConfig.tracing_disabled`][] を `True` に設定して、単一の実行でトレーシングを無効化できます
1616

17-
***OpenAI の API を使用し、 Zero Data Retention ( ZDR ) ポリシーの下で運用している組織では、トレーシングは利用できません。***
17+
***OpenAI の API を使用し、Zero Data Retention ( ZDR ) ポリシーの下で運用している組織では、トレーシングは利用できません。***
1818

1919
## トレースとスパン
2020

21-
- **トレース**は「ワークフロー」の単一のエンドツーエンド操作を表します。トレースはスパンで構成されます。トレースには次のプロパティがあります。
21+
- **トレース** は「ワークフロー」の単一のエンドツーエンド操作を表します。スパンで構成されます。トレースには次のプロパティがあります。
2222
- `workflow_name`: 論理的なワークフローまたはアプリです。たとえば「Code generation」や「Customer service」です。
2323
- `trace_id`: トレースの一意な ID です。指定しない場合は自動生成されます。形式は `trace_<32_alphanumeric>` である必要があります。
24-
- `group_id`: オプションのグループ ID で、同じ会話からの複数のトレースを関連付けるために使用します。たとえばチャットスレッド ID を使用できます。
24+
- `group_id`: 同じ会話からの複数のトレースを関連付けるための任意のグループ ID です。たとえば、チャットスレッド ID を使用できます。
2525
- `disabled`: True の場合、トレースは記録されません。
26-
- `metadata`: トレースのオプションのメタデータです
27-
- **スパン**は開始時刻と終了時刻を持つ操作を表します。スパンには次があります。
26+
- `metadata`: トレースの任意のメタデータです
27+
- **スパン** は開始時刻と終了時刻を持つ操作を表します。スパンには次があります。
2828
- `started_at``ended_at` のタイムスタンプ。
29-
- `trace_id`。所属するトレースを表します
30-
- `parent_id`このスパンの親スパン(存在する場合)を指します
31-
- `span_data`スパンに関する情報です。たとえば `AgentSpanData` にはエージェントの情報が含まれ`GenerationSpanData` には LLM 生成の情報が含まれます
29+
- `trace_id`: 属するトレースを表します
30+
- `parent_id`: このスパンの親スパン(存在する場合)を指します
31+
- `span_data`: スパンに関する情報です。たとえば `AgentSpanData` にはエージェントの情報`GenerationSpanData` には LLM 生成の情報などが含まれます
3232

33-
## デフォルトのトレーシング
33+
## デフォルトトレーシング
3434

35-
デフォルトでは、 SDK は次をトレースします。
35+
デフォルトで、 SDK は次をトレースします。
3636

3737
- `Runner.{run, run_sync, run_streamed}()` 全体は `trace()` でラップされます。
3838
- エージェントが実行されるたびに、`agent_span()` でラップされます
@@ -42,15 +42,15 @@ Agents SDK には組み込みのトレーシングが含まれており、エー
4242
- ハンドオフは `handoff_span()` でラップされます
4343
- 音声入力( speech-to-text )は `transcription_span()` でラップされます
4444
- 音声出力( text-to-speech )は `speech_span()` でラップされます
45-
- 関連する音声スパンは `speech_group_span()` の配下になる場合があります
45+
- 関連する音声スパンは `speech_group_span()` の子になる場合があります
4646

47-
デフォルトでは、トレース名は「Agent workflow」です。`trace` を使用する場合はこの名前を設定できます。また、[`RunConfig`][agents.run.RunConfig] で名前やその他のプロパティを設定することもできます
47+
デフォルトで、トレース名は「Agent workflow」です。`trace` を使用する場合はこの名前を設定できます。また、[`RunConfig`][agents.run.RunConfig] で名前や他のプロパティを設定することもできます
4848

49-
さらに、[カスタムトレースプロセッサー](#custom-tracing-processors) を設定して、トレースを他の送信先へ送ることができます(置き換えまたは副次的な送信先として)。
49+
さらに、[カスタムトレースプロセッサー](#custom-tracing-processors) を設定して、トレースを他の送信先へプッシュできます(置き換えまたは二次送信先として)。
5050

51-
## 高レベルのトレース
51+
## 上位レベルトレース
5252

53-
場合によっては、複数回の `run()` 呼び出しを単一のトレースの一部にしたいことがあります。これはコード全体を `trace()` でラップすることで実現できます
53+
場合によっては、`run()` への複数回の呼び出しを 1 つのトレースに含めたいことがあります。これを行うには、コード全体を `trace()` でラップします
5454

5555
```python
5656
from agents import Agent, Runner, trace
@@ -71,43 +71,43 @@ async def main():
7171

7272
[`trace()`][agents.tracing.trace] 関数を使用してトレースを作成できます。トレースは開始と終了が必要です。方法は 2 つあります。
7373

74-
1. **推奨**: `with trace(...) as my_trace` のように、トレースをコンテキストマネージャーとして使用します。これにより、適切なタイミングでトレースが自動的に開始・終了されます。
74+
1. **推奨**: コンテキストマネージャーとしてトレースを使用します。つまり `with trace(...) as my_trace` です。これにより、適切なタイミングでトレースが自動的に開始・終了されます。
7575
2. [`trace.start()`][agents.tracing.Trace.start][`trace.finish()`][agents.tracing.Trace.finish] を手動で呼び出すこともできます。
7676

77-
現在のトレースは Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) で追跡されます。これは並行処理でも自動的に機能することを意味します。トレースを手動で開始/終了する場合は、現在のトレースを更新するために `start()`/`finish()``mark_as_current``reset_current` を渡す必要があります。
77+
現在のトレースは Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) を介して追跡されます。これは並行処理でも自動的に機能することを意味します。トレースを手動で開始 / 終了する場合は、現在のトレースを更新するために `start()` / `finish()``mark_as_current``reset_current` を渡す必要があります。
7878

7979
## スパンの作成
8080

81-
さまざまな [`*_span()`][agents.tracing.create] メソッドを使用してスパンを作成できます。一般に、スパンを手動で作成する必要はありません。カスタムのスパン情報を追跡するために [`custom_span()`][agents.tracing.custom_span] 関数が利用できます。
81+
さまざまな [`*_span()`][agents.tracing.create] メソッドを使ってスパンを作成できます。一般に、スパンを手動で作成する必要はありません。カスタムスパン情報を追跡するために [`custom_span()`][agents.tracing.custom_span] 関数が利用できます。
8282

83-
スパンは自動的に現在のトレースの一部となり、最も近い現在のスパンの配下にネストされます。これは Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) によって追跡されます
83+
スパンは自動的に現在のトレースの一部となり、最も近い現在のスパンの下にネストされます。これは Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) で追跡されます
8484

8585
## 機密データ
8686

87-
特定のスパンは、機密性の高い可能性があるデータを取得する場合があります
87+
一部のスパンは、機密性のある可能性があるデータを取得する場合があります
8888

89-
`generation_span()` は LLM 生成の入力/出力を保存し、`function_span()` は関数呼び出しの入力/出力を保存します。これらには機密データが含まれる可能性があるため、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] によってそのデータの取得を無効化できます
89+
`generation_span()` は LLM 生成の入力 / 出力を保存し、`function_span()` は関数呼び出しの入力 / 出力を保存します。これらには機密データが含まれる可能性があるため、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] でそのデータの取得を無効化できます
9090

91-
同様に、音声スパンにはデフォルトで入力および出力音声の base64 エンコードされた PCM データが含まれます。[`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] を設定することで、この音声データの取得を無効化できます。
91+
同様に、音声スパンにはデフォルトで入力 / 出力音声の base64 エンコードされた PCM データが含まれます。[`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] を設定することで、この音声データの取得を無効化できます。
9292

93-
デフォルトでは、`trace_include_sensitive_data``True` です。コードを変更せずにデフォルトを設定するには、アプリ実行前に環境変数 `OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA``true/1` または `false/0` に設定します
93+
デフォルトで `trace_include_sensitive_data``True` です。コードを変更せずにデフォルトを設定するには、アプリ実行前に環境変数 `OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA``true/1` または `false/0` として export します
9494

95-
## カスタムトレースプロセッサー
95+
## カスタムトレーシングプロセッサー
9696

9797
トレーシングの高レベルアーキテクチャは次のとおりです。
9898

9999
- 初期化時に、トレース作成を担当するグローバルな [`TraceProvider`][agents.tracing.setup.TraceProvider] を作成します。
100-
- `TraceProvider`[`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor] を設定し、トレース/スパンをバッチで [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter] に送信します。`BackendSpanExporter` はスパンとトレースをバッチで OpenAI バックエンドにエクスポートします
100+
- `TraceProvider`[`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor] を設定し、トレース / スパンをバッチで [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter] に送信します。これはスパンとトレースをバッチで OpenAI バックエンドへエクスポートします
101101

102-
このデフォルト設定をカスタマイズして、代替または追加のバックエンドにトレースを送信したり、エクスポーターの挙動を変更したりするには、次の 2 つの方法があります。
102+
このデフォルト設定をカスタマイズし、代替または追加バックエンドへトレースを送信したり、エクスポーターの動作を変更したりするには、次の 2 つの方法があります。
103103

104-
1. [`add_trace_processor()`][agents.tracing.add_trace_processor] を使うと、準備できたトレースとスパンを受け取る**追加の**トレースプロセッサーを追加できます。これにより、OpenAI バックエンドへの送信に加えて独自の処理を行えます
105-
2. [`set_trace_processors()`][agents.tracing.set_trace_processors] を使うと、デフォルトプロセッサーを独自のトレースプロセッサーで**置き換え**できます。これは、そうした処理を行う `TracingProcessor` を含めない限り、トレースが OpenAI バックエンドに送信されないことを意味します
104+
1. [`add_trace_processor()`][agents.tracing.add_trace_processor] は、準備完了時にトレースとスパンを受け取る**追加**のトレースプロセッサーを追加できます。これにより、OpenAI バックエンドへの送信に加えて独自処理を実行できます
105+
2. [`set_trace_processors()`][agents.tracing.set_trace_processors] 、デフォルトプロセッサーを独自のトレースプロセッサーで**置き換え**できます。これは、そうする `TracingProcessor` を含めない限り、トレースが OpenAI バックエンドへ送信されないことを意味します
106106

107107

108108
## 非 OpenAI モデルでのトレーシング
109109

110-
OpenAI API キーを非 OpenAI モデルとともに使用して、トレーシングを無効化せずに OpenAI Traces ダッシュボードで無料トレーシングを有効化できます。
110+
OpenAI API キーを非 OpenAI モデルと共に使用して、トレーシングを無効化することなく OpenAI Traces ダッシュボードで無料トレーシングを有効化できます。
111111

112112
```python
113113
import os
@@ -128,7 +128,7 @@ agent = Agent(
128128
)
129129
```
130130

131-
単一の実行に対してのみ別のトレーシングキーが必要な場合は、グローバルエクスポーターを変更する代わりに `RunConfig` 経由で渡してください。
131+
単一の実行でのみ別のトレーシングキーが必要な場合は、グローバルエクスポーターを変更する代わりに `RunConfig` 経由で渡してください。
132132

133133
```python
134134
from agents import Runner, RunConfig
@@ -140,13 +140,13 @@ await Runner.run(
140140
)
141141
```
142142

143-
## 追加メモ
144-
- Openai Traces ダッシュボードで無料トレースを表示します
143+
## 追加の注意事項
144+
- Openai Traces ダッシュボードで無料トレースを確認します
145145

146146

147-
## エコシステム統合
147+
## エコシステム連携
148148

149-
以下のコミュニティおよびベンダー統合は、OpenAI Agents SDK のトレーシング機能をサポートしています
149+
次のコミュニティおよびベンダー連携は、OpenAI Agents SDK のトレーシングサーフェスをサポートしています
150150

151151
### 外部トレーシングプロセッサー一覧
152152

@@ -171,4 +171,5 @@ await Runner.run(
171171
- [LangDB AI](https://docs.langdb.ai/getting-started/working-with-agent-frameworks/working-with-openai-agents-sdk)
172172
- [Agenta](https://docs.agenta.ai/observability/integrations/openai-agents)
173173
- [PostHog](https://posthog.com/docs/llm-analytics/installation/openai-agents)
174-
- [Traccia](https://traccia.ai/docs/integrations/openai-agents)
174+
- [Traccia](https://traccia.ai/docs/integrations/openai-agents)
175+
- [PromptLayer](https://docs.promptlayer.com/languages/integrations#openai-agents-sdk)

0 commit comments

Comments
 (0)