Skip to content

Commit 4a0fe86

Browse files
docs: redesign to fit more new centralized design (#51)
1 parent 07a6c22 commit 4a0fe86

File tree

4 files changed

+180
-94
lines changed

4 files changed

+180
-94
lines changed

docs/src/components/Hero.astro

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,24 @@ import { Code, TabItem, Tabs } from '@astrojs/starlight/components';
33
import helloWorldExample from '../../../examples/docs/toppage/textAgent.ts?raw';
44
import helloWorldVoiceExample from '../../../examples/docs/toppage/voiceAgent.ts?raw';
55
const path = Astro.url.pathname;
6-
const pathPrefix = path !== '/' ? !path.endsWith("/") ? path + "/" : path : '';
6+
const pathPrefix =
7+
path !== '/' ? (!path.endsWith('/') ? path + '/' : path) : '';
78
---
89

910
<div class="openai-hero">
1011
<div class="openai-hero-container flex gap-4">
11-
<a
12-
href={`${pathPrefix}guides/quickstart`}
13-
class="openai-quickstart flex-1 flex items-center"
14-
>
12+
<div class="openai-quickstart flex-1 flex items-center">
1513
<div>
1614
<h2 class="title"><slot name="title" /></h2>
1715
<p>
1816
<slot name="description" />
1917
</p>
20-
<span class="openai-hero-cta"><slot name="cta" /></span>
18+
<a href={`${pathPrefix}guides/quickstart`} class="openai-hero-cta">
19+
<slot name="cta" />
20+
</a>
2121
</div>
22-
</a>
23-
<div class="flex-1 overflow-x-scroll">
22+
</div>
23+
<div class="openai-hero-code flex-1 overflow-x-scroll">
2424
<Tabs>
2525
<TabItem label="Text Agent">
2626
<Code lang="typescript" code={helloWorldExample} />

docs/src/content/docs/index.mdx

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,8 @@ import helloWorldExample from '../../../../examples/docs/hello-world.ts?raw';
1111

1212
<Hero>
1313
<Fragment slot="title">Quickstart</Fragment>
14-
<Fragment slot="description">
15-
Build your first agent in minutes. Learn the basics of the OpenAI Agents
16-
SDK.
17-
</Fragment>
18-
<Fragment slot="cta">Get started</Fragment>
14+
<Fragment slot="description">Build your first agent in minutes.</Fragment>
15+
<Fragment slot="cta">Let's build</Fragment>
1916
</Hero>
2017

2118
The [OpenAI Agents SDK for TypeScript](https://github.com/openai/openai-agents-js)
@@ -36,12 +33,6 @@ real-world applications without a steep learning curve. In addition, the SDK
3633
comes with built-in **tracing** that lets you visualize and debug your agentic
3734
flows, as well as evaluate them and even fine-tune models for your application.
3835

39-
<LinkCard
40-
title="OpenAI Agents SDK for Python"
41-
href="https://github.com/openai/openai-agents-python"
42-
description="Build agentic AI apps with Python."
43-
/>
44-
4536
## Why use the Agents SDK
4637

4738
The SDK has two driving design principles:

docs/src/content/docs/ja/index.mdx

Lines changed: 22 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,55 +11,47 @@ import helloWorldExample from '../../../../../examples/docs/hello-world.ts?raw';
1111

1212
<Hero>
1313
<Fragment slot="title">クイックスタート</Fragment>
14-
<Fragment slot="description">
15-
数分で最初のエージェントを構築できます。OpenAI Agents SDK
16-
の基本を学びましょう。
17-
</Fragment>
18-
<Fragment slot="cta">はじめる</Fragment>
14+
<Fragment slot="description">数分で最初のエージェントを構築します。</Fragment>
15+
<Fragment slot="cta">作ってみよう</Fragment>
1916
</Hero>
2017

21-
[TypeScript 用 OpenAI Agents SDK](https://github.com/openai/openai-agents-js) は、最小限の抽象化で軽量かつ使いやすいパッケージとしてエージェント指向の AI アプリを構築できるようにします。これは、以前のエージェント向け実験プロジェクトである [Swarm](https://github.com/openai/swarm/tree/main) を本番環境向けにアップグレードしたもので、[Python でも利用可能です](https://github.com/openai/openai-agents-python)。Agents SDK が提供する基本コンポーネントはごく少数です。
18+
[OpenAI Agents SDK for TypeScript](https://github.com/openai/openai-agents-js) は、きわめて少ない抽象化でエージェント指向の AI アプリを簡単かつ軽量に構築できるパッケージです。これは以前のエージェント向け実験
19+
[Swarm](https://github.com/openai/swarm/tree/main) を本番利用向けにアップグレードしたもので、[Python 版](https://github.com/openai/openai-agents-python) も提供されています。Agents SDK にはごく少数の基本コンポーネントがあります。
2220

23-
- **エージェント**: `instructions``tools` を備えた LLM
24-
- **ハンドオフ**: 特定のタスクを別のエージェントに委任する仕組み
25-
- **ガードレール**: エージェントへの入力を検証する仕組み
21+
- ** エージェント **: instructions と tools を備えた LLM
22+
- ** ハンドオフ **: 特定タスクを別のエージェントに委任
23+
- ** ガードレール **: エージェントへの入力を検証
2624

27-
TypeScript と組み合わせることで、これらの基本コンポーネントだけでツールとエージェント間の複雑な関係を表現でき、学習コストを抑えつつ実用的なアプリケーションを構築できます。さらにSDK には **トレーシング** が組み込まれており、エージェントフローの可視化やデバッグ、評価、さらにはアプリ向けモデルのファインチューニングまで行えます
25+
TypeScript と組み合わせることで、これらの基本コンポーネントはツールとエージェント間の複雑な関係を表現でき、学習コストを抑えつつ実運用アプリを構築できます。さらに SDK には ** トレーシング ** が組み込まれており、エージェントフローの可視化とデバッグ、評価、さらにはモデルのファインチューニングまで行えます
2826

29-
<LinkCard
30-
title="Python 用 OpenAI Agents SDK"
31-
href="https://github.com/openai/openai-agents-python"
32-
description="Python でエージェント指向 AI アプリを構築"
33-
/>
27+
## Agents SDK を使用する理由
3428

35-
## Agents SDK を利用する理由
29+
SDK の設計原則は次の 2 つです。
3630

37-
SDK の設計原則は次の二つです。
31+
1. 使う価値のある十分な機能を備えつつ、学習が容易な最小限の基本コンポーネント
32+
2. デフォルトで優れた動作を提供しつつ、細部を自由にカスタマイズ可能
3833

39-
1. 使う価値のある機能を十分に備えつつ、習得が早いようコンポーネントを絞る
40-
2. デフォルトでもすぐに使えるが、動作を細かくカスタマイズできる
34+
主な機能は以下のとおりです。
4135

42-
主な特徴は以下のとおりです。
43-
44-
- **エージェントループ**: ツール呼び出し、結果の LLM への送信、LLM が完了するまでのループ処理を内蔵
45-
- **TypeScript ファースト**: 新しい抽象概念を学ばなくても、言語機能でエージェントをオーケストレーション
46-
- **ハンドオフ**: 複数エージェント間での協調や委任を実現する強力な機能
47-
- **ガードレール**: 入力のバリデーションやチェックをエージェントと並行実行し、不合格なら早期終了
48-
- **関数ツール**: 任意の TypeScript 関数をツール化し、自動スキーマ生成と Zod による検証を提供
49-
- **トレーシング**: ワークフローの可視化・デバッグ・モニタリングに加え、OpenAI の評価・ファインチューニング・蒸留ツールを活用可能
50-
- **Realtime Agents**: 自動割り込み検知、コンテキスト管理、ガードレールなどを備えた高機能な音声エージェントを構築
36+
- ** エージェントループ **: tool を呼び出し、その結果を LLM に送り、LLM が完了するまでループ処理
37+
- ** TypeScript ファースト **: 新しい抽象化を覚えることなく、言語機能でエージェントを編成・連鎖
38+
- ** ハンドオフ **: 複数エージェント間の調整と委任を実現する強力な機能
39+
- ** ガードレール **: 入力検証やチェックをエージェントと並行して実行し、不合格なら早期終了
40+
- ** 関数ツール **: 任意の TypeScript 関数を自動スキーマ生成と Zod 検証付きで tool 化
41+
- ** トレーシング **: ワークフローを可視化・デバッグ・監視し、OpenAI の評価、ファインチューニング、蒸留ツールを活用
42+
- ** Realtime Agents **: 自動割り込み検知、コンテキスト管理、ガードレールなどを備えた高機能音声エージェントを構築
5143

5244
## インストール
5345

5446
```bash
5547
npm install @openai/agents
5648
```
5749

58-
## Hello World の例
50+
## Hello World コード例
5951

6052
<Code lang="typescript" code={helloWorldExample} title="Hello World" />
6153

62-
(_実行する場合は `OPENAI_API_KEY` 環境変数を設定してください_)
54+
(_実行する場合は、環境変数 `OPENAI_API_KEY` を設定してください_)
6355

6456
```bash
6557
export OPENAI_API_KEY=sk-...

0 commit comments

Comments
 (0)