Skip to content

Commit 1d5f4bd

Browse files
committed
Fix document build errors
1 parent 4c24cc5 commit 1d5f4bd

26 files changed

+619
-620
lines changed

.github/workflows/update-docs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ jobs:
3636
- name: Translate docs
3737
env:
3838
OPENAI_API_KEY: ${{ secrets.PROD_OPENAI_API_KEY }}
39-
run: pnpm docs:translate
39+
run: |
40+
pnpm docs:translate
41+
pnpm docs:build # to make sure if the generated docs are valid
4042
4143
- name: Commit changes
4244
id: commit

docs/src/content/docs/ja/extensions/ai-sdk.mdx

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,31 @@ import { Aside, Steps, Code } from '@astrojs/starlight/components';
77
import aiSdkSetupExample from '../../../../../../examples/docs/extensions/ai-sdk-setup.ts?raw';
88

99
<Aside type="caution">
10-
このアダプターはまだベータ版です。特に小規模なモデルプロバイダーでは問題が発生する可能性があります。問題は
11-
[GitHub の issues](https://github.com/openai/openai-agents-js/issues)
12-
からご報告ください。迅速に修正します。
10+
このアダプターはまだ beta
11+
です。一部のモデルプロバイダー、特に小規模なものでは問題が発生する場合があります。問題は
12+
[GitHub issues](https://github.com/openai/openai-agents-js/issues)
13+
から報告してください。迅速に修正します。
1314
</Aside>
1415

15-
標準で Agents SDK は Responses API または Chat Completions API を通じて OpenAI のモデルと連携します。ただし、別のモデルを使用したい場合は[Vercel の AI SDK](https://sdk.vercel.ai/) が幅広い対応モデルを提供しており、このアダプターを介して Agents SDK に取り込むことができます
16+
標準で Agents SDK は Responses API または Chat Completions API を通じて OpenAI モデルと動作します。ただし、他のモデルを使いたい場合は[Vercel の AI SDK](https://sdk.vercel.ai/) がこのアダプター経由で Agents SDK に組み込める多数の対応モデルを提供します
1617

1718
## セットアップ
1819

1920
<Steps>
2021

21-
1. 拡張機能パッケージをインストールして AI SDK アダプターを導入します:
22+
1. extensions パッケージをインストールして AI SDK アダプターを導入します:
2223

2324
```bash
2425
npm install @openai/agents-extensions
2526
```
2627

27-
2. [Vercel の AI SDK](https://sdk.vercel.ai/docs/models/overview) の中から目的のモデルパッケージを選び、インストールします:
28+
2. [Vercel の AI SDK](https://sdk.vercel.ai/docs/models/overview) から目的のモデルパッケージを選び、インストールします:
2829

2930
```bash
3031
npm install @ai-sdk/openai@"^1.0.0"
3132
```
3233

33-
3. アダプターとモデルをインポートし、エージェントに接続します:
34+
3. アダプターとモデルをインポートして、エージェントに接続します:
3435

3536
```typescript
3637
import { openai } from '@ai-sdk/openai';
@@ -47,21 +48,17 @@ import aiSdkSetupExample from '../../../../../../examples/docs/extensions/ai-sdk
4748

4849
<Aside type="caution">
4950
Vercel の AI SDK は最近 v2 に移行しましたが、 openai agent extensions はまだ
50-
v2 と互換性がありません。 そのため Vercel の AI SDK v1
51-
をインストールする必要があります
51+
v2 と互換性がありません。 そのため Vercel の AI SDK v1
52+
バージョンをインストールする必要があります
5253
</Aside>
5354

5455
##
5556

56-
<Code
57-
lang="typescript"
58-
code={aiSdkSetupExample}
59-
title="AI SDK のセットアップ"
60-
/>
57+
<Code lang="typescript" code={aiSdkSetupExample} title="AI SDK セットアップ" />
6158

62-
## プロバイダーメタデータの受け渡し
59+
## プロバイダーのメタデータの受け渡し
6360

64-
メッセージと一緒にプロバイダー固有のオプションを送信する必要がある場合は`providerMetadata` を通して渡します。値は基盤の AI SDK のモデルにそのまま転送されます。たとえば、 Agents SDK の次の `providerData`
61+
メッセージにプロバイダー固有のオプションを添えて送信する必要がある場合は`providerMetadata` を通して渡します。値は基盤の AI SDK モデルにそのまま転送されます。たとえば、Agents SDK で次の `providerData`
6562

6663
```ts
6764
providerData: {
@@ -73,7 +70,7 @@ providerData: {
7370
}
7471
```
7572

76-
は次のようになります
73+
AI SDK 連携を使用する場合は
7774

7875
```ts
7976
providerMetadata: {
@@ -85,4 +82,4 @@ providerMetadata: {
8582
}
8683
```
8784

88-
AI SDK 連携を使用する場合
85+
になります。

docs/src/content/docs/ja/extensions/twilio.mdx

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,37 @@ import { Aside, Steps, Code } from '@astrojs/starlight/components';
77
import twilioBasicExample from '../../../../../../examples/docs/extensions/twilio-basic.ts?raw';
88
import twilioServerExample from '../../../../../../examples/realtime-twilio/index.ts?raw';
99

10-
Twilio は、電話の通話からの raw 音声を WebSocket サーバーへ送信する [Media Streams API](https://www.twilio.com/docs/voice/media-streams) を提供しています。このセットアップを使うと、あなたの [音声エージェントの概要](/openai-agents-js/ja/guides/voice-agents) を Twilio に接続できます。`websocket` モードで既定の Realtime Session のトランスポートを使い、Twilio から届くイベントをあなたの Realtime Session に接続することもできます。ただし、その場合は適切な音声フォーマットを設定し、Web ベースの会話よりも通話のほうが自然とレイテンシーが大きくなるため、独自の割り込みタイミングを調整する必要があります
10+
Twilio は [Media Streams API](https://www.twilio.com/docs/voice/media-streams) を提供しており、電話の通話からの元音声を WebSocket サーバーへ送信します。これは、あなたの [音声エージェントの概要](/openai-agents-js/ja/guides/voice-agents) を Twilio に接続するために利用できます。Twilio から届くイベントを Realtime Session に接続するには、`websocket` モードのデフォルトの Realtime Session トランスポートを使えます。ただし、Web ベースの会話よりも電話では自然とレイテンシが増えるため、適切な音声フォーマットの設定や、割り込みタイミングの調整が必要になります
1111

12-
セットアップ体験を向上させるために、Twilio への接続を代わりに処理する専用のトランスポートレイヤーを作成しました。割り込みの処理や音声の転送も含めて処理します
12+
セットアップ体験を向上させるために、割り込み処理や音声転送を含め、Twilio への接続を代わりに処理する専用のトランスポートレイヤーを作成しました。
1313

1414
<Aside type="caution">
15-
このアダプターはまだベータ版です。まれなケースで問題やバグに遭遇する可能性があります。
16-
問題があれば [GitHub
17-
issues](https://github.com/openai/openai-agents-js/issues)
18-
に報告してください。迅速に修正します。
15+
このアダプターはまだベータ版です。エッジケースの問題やバグに遭遇する可能性があります。
16+
問題は [GitHub issues](https://github.com/openai/openai-agents-js/issues)
17+
から報告してください。迅速に修正します。
1918
</Aside>
2019

2120
## セットアップ
2221

2322
<Steps>
2423

25-
1. **Twilio アカウントと Twilio 電話番号を用意してください。**
24+
1. ** Twilio のアカウントと Twilio の電話番号を用意します **
2625

27-
2. **Twilio からのイベントを受け取れる WebSocket サーバーをセットアップしてください。**
26+
2. ** Twilio からのイベントを受け取れる WebSocket サーバーを用意します **
2827

29-
ローカルで開発している場合、これは [`ngrok`](https://ngrok.io/)
28+
ローカルで開発している場合、これはローカルトンネルの設定が必要になり、
29+
これはローカルトンネルの設定が必要になり、[`ngrok`](https://ngrok.io/)
3030
[Cloudflare Tunnel](https://developers.cloudflare.com/pages/how-to/preview-with-cloudflare-tunnel/)
31-
のようなローカルトンネルを設定する必要があることを意味します this will require you to configure a local tunnel like
32-
[`ngrok`](https://ngrok.io/) または
33-
[Cloudflare Tunnel](https://developers.cloudflare.com/pages/how-to/preview-with-cloudflare-tunnel/)
34-
を使用して、ローカルのサーバーを Twilio からアクセス可能にする必要があります。`TwilioRealtimeTransportLayer`
35-
を使って Twilio に接続できます。
31+
などを使ってローカルサーバーを Twilio からアクセス可能にします。Twilio への接続には
32+
`TwilioRealtimeTransportLayer` を使えます。
3633

37-
3. **拡張パッケージをインストールして Twilio アダプターを導入します:**
34+
3. ** 拡張パッケージをインストールして Twilio アダプターを導入します **
3835

3936
```bash
4037
npm install @openai/agents-extensions
4138
```
4239

43-
4. **アダプターとモデルをインポートして `RealtimeSession` に接続します:**
40+
4. ** `RealtimeSession` に接続するためのアダプターとモデルをインポートします **
4441

4542
<Code
4643
lang="typescript"
@@ -50,41 +47,41 @@ Twilio は、電話の通話からの raw 音声を WebSocket サーバーへ送
5047
)}
5148
/>
5249

53-
5. **`RealtimeSession` を Twilio に接続します:**
50+
5. ** `RealtimeSession` を Twilio に接続します **
5451

5552
```typescript
5653
session.connect({ apiKey: 'your-openai-api-key' });
5754
```
5855

5956
</Steps>
6057

61-
`RealtimeSession` に期待されるすべてのイベントや動作は、ツール呼び出しやガードレールなどを含め、期待どおりに動作します`RealtimeSession` を音声エージェントとあわせて使う方法の詳細は[音声エージェントの概要](/openai-agents-js/ja/guides/voice-agents) を参照してください。
58+
`RealtimeSession` に期待されるあらゆるイベントや動作は、ツール呼び出し、ガードレールなどを含め、想定どおりに機能します`RealtimeSession` を音声エージェントで使う方法の詳細は[音声エージェントの概要](/openai-agents-js/ja/guides/voice-agents) を参照してください。
6259

63-
## ヒントと留意事項
60+
## ヒントと考慮事項
6461

65-
1. **スピードが命です**
62+
1. ** スピードが命です **
6663

67-
Twilio から必要なすべてのイベントと音声を受け取るため、WebSocket 接続への参照を取得したらすぐに
64+
Twilio から必要なすべてのイベントや音声を受け取るため、WebSocket 接続を参照できるようになったらすぐに
6865
`TwilioRealtimeTransportLayer` インスタンスを作成し、その直後に `session.connect()` を呼び出してください。
6966

70-
2. **raw な Twilio イベントにアクセス。**
67+
2. ** Twilio の元イベントにアクセスする **
7168

72-
Twilio が送信する raw イベントにアクセスしたい場合は`RealtimeSession` インスタンス上の
73-
`transport_event` イベントをリッスンできます。Twilio からのすべてのイベントは `twilio_message` という type と、
74-
raw なイベントデータを含む `message` プロパティを持ちます。
69+
Twilio が送信する元イベントにアクセスしたい場合は`RealtimeSession` インスタンスで `transport_event`
70+
をリッスンします。Twilio からのすべてのイベントは `twilio_message` という type と、元イベントデータを含む
71+
`message` プロパティを持ちます。
7572

76-
3. **デバッグログを確認。**
73+
3. ** デバッグログを確認する **
7774

78-
何が起きているかについて、より多くの情報が必要になる場合があります。環境変数 `DEBUG=openai-agents*` を使用すると
79-
Agents SDK からのすべてのデバッグログが表示されます。あるいは `DEBUG=openai-agents:extensions:twilio*`
80-
を使って、Twilio アダプターのデバッグログだけを有効化できます
75+
状況をより詳しく知りたい問題に遭遇することがあります。環境変数 `DEBUG=openai-agents*` を使うと
76+
Agents SDK からのすべてのデバッグログが表示されます。あるいは、Twilio アダプターだけのデバッグログを有効にするには
77+
`DEBUG=openai-agents:extensions:twilio*` を使用できます
8178

82-
## 完全なサーバーの例
79+
## 完全なサーバー例
8380

84-
以下は、Twilio からのリクエストを受け取り、`RealtimeSession` に転送する WebSocket サーバーの、エンドツーエンドの完全な例です
81+
以下は、Twilio からのリクエストを受け取り、`RealtimeSession` にフォワードする、WebSocket サーバーの完全な end-to-end の例です
8582

8683
<Code
8784
lang="typescript"
8885
code={twilioServerExample}
89-
title="Fastify を使用したサーバーの例"
86+
title="Fastify を使ったサーバー例"
9087
/>

0 commit comments

Comments
 (0)