メインコンテンツへスキップ
構造化出力は Devin のメモ帳のようなものです。Devin は作業しながらメモを更新していき、いつでもそのメモを確認できます。現時点では Devin にメモの更新を強制することはできませんが、これまでに書かれた内容をいつでも参照できます。

進捗アップデート

長時間実行タスクの進行状況として、Devin の進捗を確認できます

アプリケーション連携

Devin の分析結果と出力を、一貫した JSON 形式でアプリケーションに取り込めます。

構造化出力の利用

構造化出力を使用するには、セッションを作成するときのプロンプトに、必要な JSON スキーマを含めてください。
関連する出来事があったときは必ず 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) を押すと、いつでも構造化された出力をすばやく表示できます。

ベストプラクティス

  • 初期プロンプトにスキーマ定義を含める
  • 想定する更新頻度を指定する(例:「サイトに新しいコンポーネントを追加するたびに構造化出力を更新してください」)
  • 値の型とフォーマットを明確に記載する
  • Devin が何を書くべきか理解できるよう、わかりやすく説明的なフィールド名を使う
  • スキーマにサンプル値を含める
  • Devin API に過度な負荷をかけないよう、ポーリングの間隔は 10〜30 秒程度に設定する
  • セッションが完了するかエラーになったらポーリングを停止する
Devin は独自のタイミングで構造化出力を更新します。更新を強制することはできませんが、いつでも最新のノートの表示をリクエストできます。
構造化出力の使い方に関する質問や問題の報告は、[email protected] までメールでご連絡ください。