レポートを生成する

このガイドでは、完了した分析ラン（Run）から自動生成されたレポートを読み、必要な場合に別の presentation を明示的に rerender して取得する方法を説明します。

レポート生成では表示方法だけが変わります。動画分析を再実行せず、回答、エビデンス、result state、limitations、provenance も変更しません。

始める前に

次のものを用意してください。

• status が completed の分析ラン。
• RUN_ID に設定した分析ランの ID。
• レポート生成に必要な RUN_WORKFLOWS 権限。レポートの読み取りには VIEW_INSIGHTS 権限が必要です。

レポートを rerender する

analysis run が completed になると、API は保存済み report template の snapshot を使い、request の出力形式を自動的に render します。次の endpoint は、同じ保存済み answer から別の presentation が必要な場合だけ使ってください。Inline の report_template と、1 つ以上の出力形式を指定してください。

curl --fail-with-body -X POST "$BASE_URL/api/v1alpha1/runs/$RUN_ID/reports" \
  -H "Authorization: Bearer $DEEPFRAME_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: report-rerender-01" \
  -d '{
    "report_template": {
      "language": "ja",
      "blocks": [
        {"type":"timeline","answer_key":"inspection_timeline","label":"工程タイムライン"},
        {"type":"narrative","answer_key":"inspection_summary","label":"概要"}
      ]
    },
    "formats": ["json", "markdown"]
  }'

明示的な rerender response は 201 Created です。保存済み answer を読み、presentation だけを変更します。動画分析を再実行しません。新しいレポートリクエストごとに、新しい Idempotency-Key を使ってください。同じリクエストを再試行するときだけ、同じキーを再利用してください。

レポートを取得する

分析ランのレポートを一覧取得します。

curl --fail-with-body --get "$BASE_URL/api/v1alpha1/reports" \
  -H "Authorization: Bearer $DEEPFRAME_API_KEY" \
  --data-urlencode "run_id=$RUN_ID"

レポートを 1 件取得します。

curl --fail-with-body --get "$BASE_URL/api/v1alpha1/reports/$REPORT_ID" \
  -H "Authorization: Bearer $DEEPFRAME_API_KEY" \
  --data-urlencode "expand[]=content" \
  --data-urlencode "expand[]=manifest"

既定ではレポートの metadata を返します。expand[]=content は生成済み artifact を返し、expand[]=manifest は最新の署名付き evidence URL を含む trust binding を返します。署名付き evidence URL がある場合、evidence_urls_expire_at は manifest と URL を含む各 binding にその有効期限を示します。URL の有効期限が切れた場合は evidence ID を保持し、GET /api/v1alpha1/evidence/{evidence_id} を呼んでください。この endpoint は 302 Found と新しい署名付き media URL、Cache-Control: no-store を返します。署名付き URL を永続的な evidence identifier として扱わないでください。両方が必要な場合は、上記のように expand[] を繰り返してください。

検証可能なレポートを保つ

レポートを保存またはエクスポートするときは、manifest 全体を保持してください。各 manifest.bindings[] には result_state、limitations、evidence_refs、evidence_urls、provenance_refs が含まれます。レビュー担当者が claim から evidence を確認できない場合、その claim は不完全です。

再利用可能な template、block type、sort、group、JSON mapping は、レポートレイアウトを変更する に進んでください。