跳到主要内容

本文为非官方中文翻译,内容以 OpenAI 官方英文文档为准。
官方来源:https://developers.openai.com/codex/enterprise/governance

治理

在你的组织中管理 Codex 的治理指南

治理与可观测性

Codex 为企业团队提供对采用情况和影响的可见性,以及安全与合规项目所需的可审计性。使用自助仪表板进行日常跟踪,使用 Analytics API 进行程序化报告,使用 Compliance API 将详细日志导出到你的治理技术栈中。

跟踪 Codex 使用情况的方式

根据你的需求,有三种方式可以监控 Codex 的使用情况:

  • Analytics Dashboard:快速查看采用情况以及代码审查影响。
  • Analytics API:将结构化的每日指标拉取到你的数据仓库或 BI 工具中。
  • Compliance API:导出详细活动日志,用于审计、监控和调查。

Analytics Dashboard

Codex analytics dashboard

仪表板视图

analytics dashboard 允许 ChatGPT 工作区管理员和分析查看者跟踪 Codex 的采用情况、使用情况以及 Code Review 反馈。使用数据最多可能延迟 12 小时。

Codex 提供按日期范围控制的每日和每周视图。关键图表包括:

  • 按产品界面统计的活跃用户,包括 CLI、IDE 扩展、云端、桌面端和 Code Review
  • 工作区和个人使用情况明细,包括按产品界面统计的 credits 和 token 使用量
  • 按客户端统计的线程和轮次产品活动
  • 用户排名表,带有客户端筛选器以及诸如 credits、threads、turns、text tokens 和当前 streak 等排序选项
  • Code Review 活动,包括已审查的 PR、按优先级划分的问题、评论、回复、反应和反馈情绪
  • Skill 调用、代理身份使用情况以及访问令牌使用情况(当你的工作区启用这些功能时)

数据导出

管理员还可以将 Codex 分析数据导出为 CSV 或 JSON 格式。Codex 提供以下导出选项:

  • 工作区使用情况,包括按界面统计的每日活跃用户、threads、turns 和 credits
  • 每用户使用情况,包括跨各界面的每日 threads、turns 和 credits,在允许时可包含电子邮件地址
  • Code Review 详情,包括每日评论、反应、回复和按优先级划分的发现

Analytics API

当你想要自动化报告、构建内部仪表板,或将 Codex 指标与现有工程数据结合时,请使用 Analytics API

衡量内容

企业版 Analytics API 为工作区返回按日或按周划分的 UTC 时间桶。它支持工作区级和每用户使用情况、按客户端细分、Code Review 吞吐量、Code Review 评论优先级,以及用户对 Code Review 评论的参与度。

端点

基础 URL 为 https://api.chatgpt.com/v1/analytics/codex。所有端点都返回带分页的 page 对象,其中包含 has_morenext_page

使用 start_time 指定报告窗口开始时(含)的 Unix 时间戳,使用 end_time 指定报告窗口结束时(不含)的 Unix 时间戳,使用 group_by 指定 dayweek 时间桶,使用 limit 指定页面大小,使用 page 从先前响应继续。请求最多可回溯 90 天。

使用情况

GET /workspaces/{workspace_id}/usage

  • 返回按日或按周时间桶划分的 threads、turns、credits 和按客户端统计的使用总量。
  • 省略 group 以返回按用户的行。
  • 设置 group=workspace 以返回整个工作区的行。
  • 包含文本输入、缓存输入和输出 token 字段。

代码审查活动

GET /workspaces/{workspace_id}/code_reviews

  • 返回由 Codex 完成的拉取请求审查。
  • 返回由 Codex 生成的评论总数。
  • 按 P0、P1 和 P2 优先级细分评论。

用户对代码审查的参与

GET /workspaces/{workspace_id}/code_review_responses

  • 返回对 Codex 评论的回复和反应。
  • 将反应细分为正向、负向和其他反应。
  • 统计收到反应、回复或任一形式参与的评论数量。

工作原理

Analytics 使用时间窗口,并支持按天或按周分组。结果按时间排序,并通过基于游标的分页按页返回。使用作用域为 codex.enterprise.analytics.read 的 API 密钥。

常见用例

  • 工程可观测性仪表板
  • 面向领导层更新的采用情况报告
  • 使用治理和成本监控

Compliance API

当你需要用于安全、法律和治理工作流的可审计记录时,请使用 Compliance API

衡量内容

Compliance API 为企业提供一种导出 Codex 活动日志和元数据的方式,以便你将这些数据连接到现有的审计、监控和安全工作流中。它专为配合 eDiscovery、DLP、SIEM 或其他合规系统等工具使用而设计。

对于通过 ChatGPT 认证的 Codex 使用,Compliance API 导出会提供 Codex 活动的审计记录,可用于调查和合规工作流。这些审计日志最多保留 30 天。通过 API 密钥认证的 Codex 使用遵循你的 API 组织设置,不包含在 Compliance API 导出中。

你可以导出的内容

活动日志

  • 发送给 Codex 的提示文本
  • Codex 生成的响应
  • 诸如工作区、用户、时间戳和模型之类的标识符
  • token 使用量及相关请求元数据

用于审计和调查的元数据

使用记录元数据回答如下问题:

  • 谁运行了某个任务
  • 谁创建或撤销了访问令牌
  • 它何时运行
  • 使用了哪个模型
  • 处理了多少内容

常见用例

  • 安全调查
  • 合规报告
  • 策略执行审计
  • 将事件路由到 SIEM 和 eDiscovery 管道

不提供的内容

  • 生成的代码行数(这是一个带有较多噪声的生产力代理指标,且可能激励错误行为)
  • 建议的采纳率(几乎是 100%,因为用户通常会先接受更改)
  • 代码质量或性能 KPI

大多数企业会结合使用以下方式:

  1. Analytics Dashboard 用于自助监控和快速获取答案
  2. Analytics API 用于自动化报告和 BI 集成
  3. Compliance API 用于审计导出和调查