@agent-inspect/openai-agents 3.4.0 → 3.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +72 -0
  2. package/package.json +4 -3
package/README.md ADDED
@@ -0,0 +1,72 @@
1
+ # @agent-inspect/openai-agents
2
+
3
+ OpenAI Agents JS tracing processor → local AgentInspect traces.
4
+
5
+ ## When to use
6
+
7
+ - You run agents with [`@openai/agents`](https://github.com/openai/openai-agents-js)
8
+ - You want **local-only** traces (no default OpenAI trace export)
9
+
10
+ ## When not to use
11
+
12
+ - Replacing OpenAI's hosted tracing when you still need their dashboard
13
+ - Non–OpenAI Agents frameworks
14
+
15
+ ## Install
16
+
17
+ ```bash
18
+ npm install agent-inspect @agent-inspect/openai-agents @openai/agents
19
+ ```
20
+
21
+ **Peer:** `@openai/agents@^0.12.0`
22
+
23
+ ## Example
24
+
25
+ ```ts
26
+ import { Agent, run, setTraceProcessors } from "@openai/agents";
27
+ import { agentInspectOpenAiAgents } from "@agent-inspect/openai-agents";
28
+
29
+ setTraceProcessors([
30
+ agentInspectOpenAiAgents({ traceDir: ".agent-inspect" }),
31
+ ]);
32
+
33
+ const agent = new Agent({ name: "demo", tools: [] });
34
+ await run(agent, "hello");
35
+ ```
36
+
37
+ Use **`setTraceProcessors` replacement** for local-only mode. Avoid `addTraceProcessor()` if you need to disable default exporters.
38
+
39
+ ## Privacy
40
+
41
+ - Local JSONL files only
42
+ - AgentInspect does not upload traces to OpenAI
43
+ - Metadata-only by default
44
+
45
+ ## API
46
+
47
+ | Export | Purpose |
48
+ | ------ | ------- |
49
+ | `agentInspectOpenAiAgents(options)` | `TracingProcessor` for local persistence |
50
+ | `getDiagnostics()` | Warnings for misconfiguration |
51
+
52
+ ## CLI
53
+
54
+ `npx agent-inspect list` · `sessions` · `report`
55
+
56
+ ## Docs
57
+
58
+ - [OpenAI Agents local guide](https://github.com/rajudandigam/agent-inspect/blob/main/docs/OPENAI-AGENTS-LOCAL.md)
59
+ - [Starter](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters/openai-agents)
60
+
61
+ ## Troubleshooting
62
+
63
+ - **Duplicate export:** Using `addTraceProcessor` keeps SDK default exporter — use replacement mode for local-only
64
+ - **Handoffs/sessions:** Mapped to run metadata; see docs for session IDs
65
+
66
+ ## Version
67
+
68
+ `agent-inspect@3.5.x` · OpenAI Agents `^0.12.0`
69
+
70
+ ## License
71
+
72
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agent-inspect/openai-agents",
3
- "version": "3.4.0",
3
+ "version": "3.5.1",
4
4
  "license": "MIT",
5
5
  "type": "module",
6
6
  "description": "Optional OpenAI Agents JS tracing processor integration for AgentInspect local traces",
@@ -12,7 +12,7 @@
12
12
  "bugs": {
13
13
  "url": "https://github.com/rajudandigam/agent-inspect/issues"
14
14
  },
15
- "homepage": "https://github.com/rajudandigam/agent-inspect#readme",
15
+ "homepage": "https://github.com/rajudandigam/agent-inspect/tree/main/packages/openai-agents",
16
16
  "sideEffects": false,
17
17
  "main": "./dist/index.cjs",
18
18
  "module": "./dist/index.mjs",
@@ -30,13 +30,14 @@
30
30
  }
31
31
  },
32
32
  "files": [
33
+ "README.md",
33
34
  "dist"
34
35
  ],
35
36
  "peerDependencies": {
36
37
  "@openai/agents": "^0.12.0"
37
38
  },
38
39
  "dependencies": {
39
- "agent-inspect": "3.4.0"
40
+ "agent-inspect": "3.5.1"
40
41
  },
41
42
  "publishConfig": {
42
43
  "access": "public"