Skip to content

Commit 7e961e9

Browse files
areibmanareibman
authored
Add separate docs for OpenAI Agents SDKs (#1080)
Separate OpenAI Agents docs
1 parent 4eaa5d6 commit 7e961e9

File tree

5 files changed

+66
-10
lines changed

5 files changed

+66
-10
lines changed

‎README.md‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ AgentOps helps developers build, evaluate, and monitor AI agents. From prototype
5656

5757
<div align="center" style="background-color: white; padding: 20px; border-radius: 10px; margin: 0 auto; max-width: 800px;">
5858
<div style="display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 30px; margin-bottom: 20px;">
59-
<a href="https://docs.agentops.ai/v1/integrations/openai-agents"><img src="docs/images/external/openai/agents-sdk.svg" height="45" alt="OpenAI Agents SDK"></a>
59+
<a href="https://docs.agentops.ai/v2/integrations/openai_agents_python"><img src="docs/images/external/openai/agents-sdk.svg" height="45" alt="OpenAI Agents SDK"></a>
6060
<a href="https://docs.agentops.ai/v1/integrations/crewai"><img src="docs/v1/img/docs-icons/crew-banner.png" height="45" alt="CrewAI"></a>
6161
<a href="https://docs.ag2.ai/docs/ecosystem/agentops"><img src="docs/images/external/ag2/ag2-logo.svg" height="45" alt="AG2 (AutoGen)"></a>
6262
<a href="https://docs.agentops.ai/v1/integrations/microsoft"><img src="docs/images/external/microsoft/microsoft_logo.svg" height="45" alt="Microsoft"></a>
@@ -216,14 +216,25 @@ All decorators support:
216216

217217
### OpenAI Agents SDK 🖇️
218218

219-
Build multi-agent systems with tools, handoffs, and guardrails. AgentOps natively integrates with OpenAI Agents.
219+
Build multi-agent systems with tools, handoffs, and guardrails. AgentOps natively integrates with the OpenAI Agents SDKs for both Python and TypeScript.
220+
221+
#### Python
220222

221223
```bash
222224
pip install openai-agents
223225
```
224226

225-
- [AgentOps integration example](https://docs.agentops.ai/v1/integrations/agents_sdk)
226-
- [Official OpenAI Agents SDK documentation](https://openai.github.io/openai-agents-python/)
227+
- [Python integration guide](https://docs.agentops.ai/v2/integrations/openai_agents_python)
228+
- [OpenAI Agents Python documentation](https://openai.github.io/openai-agents-python/)
229+
230+
#### TypeScript
231+
232+
```bash
233+
npm install agentops @openai/agents
234+
```
235+
236+
- [TypeScript integration guide](https://docs.agentops.ai/v2/integrations/openai_agents_js)
237+
- [OpenAI Agents JS documentation](https://openai.github.io/openai-agents-js)
227238

228239
### CrewAI 🛶
229240

‎docs/mint.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,8 @@
180180
"v2/integrations/litellm",
181181
"v2/integrations/mem0",
182182
"v2/integrations/openai",
183-
"v2/integrations/agents_sdk",
183+
"v2/integrations/openai_agents_python",
184+
"v2/integrations/openai_agents_js",
184185
"v2/integrations/smolagents",
185186
"v2/integrations/ibm_watsonx_ai",
186187
"v2/integrations/xai"

‎docs/v2/integrations/openai_agents_js.mdx‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: OpenAI Agents JS
3+
description: 'AgentOps integration with the OpenAI Agents SDK for TypeScript/JavaScript.'
4+
---
5+
6+
[OpenAI Agents JS](https://github.com/openai/openai-agents-js) is a lightweight yet powerful SDK for building multi-agent workflows in TypeScript. AgentOps seamlessly integrates to provide observability into these workflows.
7+
8+
- [OpenAI Agents JS documentation](https://openai.github.io/openai-agents-js)
9+
- [Python guide](/v2/integrations/openai_agents_python)
10+
11+
## Installation
12+
13+
```bash
14+
npm install agentops @openai/agents
15+
```
16+
17+
## Usage
18+
19+
```typescript
20+
import { agentops } from 'agentops';
21+
import { Agent, run } from '@openai/agents';
22+
23+
await agentops.init();
24+
25+
const agent = new Agent({
26+
name: 'Assistant',
27+
instructions: 'You are a helpful assistant.'
28+
});
29+
30+
const result = await run(agent, 'Hello, world!');
31+
console.log(result.finalOutput);
32+
```
33+
34+
<script type="module" src="/scripts/github_stars.js"></script>
35+
<script type="module" src="/scripts/scroll-img-fadein-animation.js"></script>
36+
<script type="module" src="/scripts/button_heartbeat_animation.js"></script>
37+
<script type="css" src="/styles/styles.css"></script>
38+
<script type="module" src="/scripts/adjust_api_dynamically.js"></script>

docs/v2/integrations/agents_sdk.mdx renamed to docs/v2/integrations/openai_agents_python.mdx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@ title: OpenAI Agents SDK
33
description: 'AgentOps and OpenAI Agents SDK integration for powerful multi-agent workflow monitoring.'
44
---
55

6-
[OpenAI Agents SDK](https://github.com/openai/agentsdk_prototype) is a lightweight yet powerful framework for building multi-agent workflows. The SDK provides a comprehensive set of tools for creating, managing, and monitoring agent-based applications. AgentOps seamlessly integrates to provide observability into these workflows.
6+
[OpenAI Agents Python](https://github.com/openai/openai-agents-python) is a lightweight yet powerful SDK for building multi-agent workflows in Python. AgentOps seamlessly integrates to provide observability into these workflows.
7+
8+
- [OpenAI Agents Python documentation](https://openai.github.io/openai-agents-python/)
9+
- [TypeScript guide](/v2/integrations/openai_agents_js)
710

811
## Core Concepts
912

@@ -12,7 +15,9 @@ description: 'AgentOps and OpenAI Agents SDK integration for powerful multi-agen
1215
- **Guardrails**: Configurable safety checks for input and output validation
1316
- **Tracing**: Built-in tracking of agent runs, allowing you to view, debug and optimize your workflows
1417

15-
## Installation
18+
## Python
19+
20+
### Installation
1621

1722
Install AgentOps, the OpenAI Agents SDK, and `python-dotenv` for managing API keys:
1823
<CodeGroup>
@@ -27,7 +32,7 @@ Install AgentOps, the OpenAI Agents SDK, and `python-dotenv` for managing API ke
2732
```
2833
</CodeGroup>
2934

30-
## Setting Up API Keys
35+
### Setting Up API Keys
3136

3237
Before using the OpenAI Agents SDK with AgentOps, you need to set up your API keys:
3338
- **OPENAI_API_KEY**: From the [OpenAI Platform](https://platform.openai.com/api-keys)
@@ -57,7 +62,7 @@ AGENTOPS_API_KEY = os.getenv("AGENTOPS_API_KEY")
5762
OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
5863
```
5964

60-
## Usage
65+
### Usage
6166

6267
AgentOps will automatically instrument the OpenAI Agents SDK after being initialized. You can then create agents, run them, and track their interactions.
6368

‎docs/v2/introduction.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ description: "AgentOps is the developer favorite platform for testing, debugging
3535
<Card title="CrewAI" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/crewai/crewai-logo.png?raw=true" alt="CrewAI" />} iconType="image" href="/v2/integrations/crewai" />
3636
<Card title="Google ADK" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/google-adk/google-adk-logo.png?raw=true" alt="Google ADK" />} iconType="image" href="/v2/integrations/google_adk" />
3737
<Card title="LangChain" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/langchain/langchain-logo.svg?raw=true" alt="LangChain" />} iconType="image" href="/v2/integrations/langchain" />
38-
<Card title="OpenAI Agents SDK" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/openai/openai-logomark.png?raw=true" alt="OpenAI Agents SDK" />} iconType="image" href="/v2/integrations/agents_sdk" />
38+
<Card title="OpenAI Agents (Python)" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/openai/openai-logomark.png?raw=true" alt="OpenAI Agents Python" />} iconType="image" href="/v2/integrations/openai_agents_python" />
39+
<Card title="OpenAI Agents (TypeScript)" icon={<img src="https://www.github.com/agentops-ai/agentops/blob/main/docs/images/external/openai/openai-logomark.png?raw=true" alt="OpenAI Agents JS" />} iconType="image" href="/v2/integrations/openai_agents_js" />
3940
<Card title="Smolagents" icon={<img src="https://github.com/AgentOps-AI/agentops/blob/main/docs/images/external/huggingface/hf-logo.png?raw=true" alt="smolagents" />} iconType="image" href="/v2/integrations/smolagents" />
4041
</CardGroup>
4142

0 commit comments

Comments
 (0)