跳转到主要内容
结构化输出就像 Devin 的记事本——它在工作过程中会不断更新自己的笔记,你可以随时查看这些笔记。目前,你无法强制 Devin 立即更新笔记,但可以请求查看它到目前为止写下的内容。

进度更新

在执行长时间任务期间获取 Devin 的进度更新

应用集成

使用规范的 JSON 将 Devin 的分析和输出集成到你的应用程序中。

请求结构化输出

要使用结构化输出,请在创建会话时在提示词中包含所需的 JSON schema。 请确保指示 Devin 在每当发生相关变更时更新结构化输出。
  • PR 审查
  • 进度更新
  • 测试结果
  • 功能实现
{
  "prompt": "Review this PR and provide updates in this format. Please update the structured output immediately whenever you find new issues, have suggestions, or change your approval status:\n{
    "issues": [
      {
        "file": "src/App.tsx",
        "line": 42,
        "type": "bug",
        "description": "Memory leak in useEffect cleanup"
      }
    ],
    "suggestions": [
      "Add error handling for API calls",
      "Split component into smaller parts"
    ],
    "approved": false
  }"
}
用于 PR 审查和代码分析的简单格式。

获取结构化输出

使用 此端点 从会话中获取结构化输出。 结构化输出会在 structured_output 字段中返回。
在 Devin Web 应用中,可以随时按下 ⌘ + I(Command+I)快速查看结构化输出。

最佳实践

  • 在初始提示中包含 schema 定义
  • 定义预期的更新频率(例如:“每当你向网站添加新的组件后,请更新结构化输出”)
  • 清晰说明取值类型和值格式
  • 使用清晰且具有描述性的字段名称,以便 Devin 知道应该写什么
  • 在你的 schema 中包含示例值
  • 轮询时使用 10–30 秒的时间间隔,以避免对 Devin API 造成过大压力
  • 在会话完成或出错时停止轮询
请记住,Devin 会按照自己的节奏更新结构化输出——你无法强制触发更新,但你可以随时请求查看最新的笔记。
如果你对使用结构化输出有疑问或想报告问题,请发送邮件至 support@cognition.ai