@agent-inspect/openai-agents

中文文档
6.31.35发布于 2026/11/05MITTypeScriptESM + CJS构建来源已验证近 30 天下载 3974

OpenAI Agents JS processor integration for AgentInspect local traces and TraceContract checks

原始使用文档
文档目录11 节
  1. When to use
  2. When not to use
  3. Install
  4. Example
  5. Privacy
  6. API
  7. CLI
  8. Docs
  9. Troubleshooting
  10. Version
  11. License

@agent-inspect/openai-agents

OpenAI Agents JS tracing processor → local AgentInspect traces.

Support level: Supported — see SUPPORT-LEVELS.md.

When to use

  • You run agents with @openai/agents
  • You want local-only traces (no default OpenAI trace export)

When not to use

  • Replacing OpenAI's hosted tracing when you still need their dashboard
  • Non–OpenAI Agents frameworks

Install

npm install agent-inspect @agent-inspect/openai-agents @openai/agents

Peer: @openai/agents@^0.12.0

Example

import { Agent, run, setTraceProcessors } from "@openai/agents";
import { agentInspectOpenAiAgents } from "@agent-inspect/openai-agents";

setTraceProcessors([
  agentInspectOpenAiAgents({ traceDir: ".agent-inspect" }),
]);

const agent = new Agent({ name: "demo", tools: [] });
await run(agent, "hello");

Use setTraceProcessors replacement for local-only mode. Avoid addTraceProcessor() if you need to disable default exporters.

Privacy

  • Local JSONL files only
  • AgentInspect does not upload traces to OpenAI
  • Metadata-only by default
  • capture: "preview" is opt-in and persists bounded inputPreview / outputPreview span attributes, redacted before they reach disk and truncated at maxPreviewChars; there is no full-content mode
  • Redaction is key-based, so a preview can still contain sensitive free text — run agent-inspect redact before sharing

API

ExportPurpose
agentInspectOpenAiAgents(options)TracingProcessor for local persistence
getDiagnostics()Warnings for misconfiguration plus resolved capture mode and preview counters

CLI

npx agent-inspect list · sessions · report

Docs

Troubleshooting

  • Duplicate export: Using addTraceProcessor keeps SDK default exporter — use replacement mode for local-only
  • Handoffs/sessions: Mapped to run metadata; see docs for session IDs
  • Empty previews in preview mode: the span type carries no payload field (handoff, guardrail, agent), or the SDK omitted it. Payload-bearing spans report AI_CAPTURE_FIELD_UNAVAILABLE through onDiagnostic and getDiagnostics().capture
  • Previews look cut off: they are bounded by maxPreviewChars, which the share and strict redaction profiles cap further

Version

Part of the fixed AgentInspect release line. See the npm badge / package manifest for the current version.

License

MIT

版本与发布记录

@agent-inspect/openai-agents 共发布 124 个版本,首次发布于 2026/06/27;过去 12 个月发布了 124 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.31.35latest2026/11/051 天前
6.31.342026/11/051 天前
6.31.332026/11/015 天前
6.31.322026/11/015 天前
6.31.312026/10/316 天前
6.31.302026/10/307 天前

关于 @agent-inspect/openai-agents 的常见问题

@agent-inspect/openai-agents 是什么?

OpenAI Agents JS processor integration for AgentInspect local traces and TraceContract checks

如何安装 @agent-inspect/openai-agents?

在项目目录运行 npm install @agent-inspect/openai-agents,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@openai/agents(^0.12.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@agent-inspect/openai-agents 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@agent-inspect/openai-agents 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@agent-inspect/openai-agents 可以商用吗?

@agent-inspect/openai-agents 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@agent-inspect/openai-agents 的下载量有多少?

根据 npm 官方下载统计,@agent-inspect/openai-agents 在 2026/10/05 – 2026/11/03 这 30 天内被下载 3,974 次,日均约 132 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@agent-inspect/openai-agents 还在维护吗?

最新版本 6.31.35 发布于 2026/11/05(1 天前);至今共发布 124 个版本,其中过去 12 个月发布了 124 个;首次发布于 2026/06/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。