Workflow Review
保存済み rulebook を再利用可能な index 済みエビデンスに適用し、finding を読みます。
このガイドでは、rulebook を作成し、workflow に紐づけて実行し、結果の finding を読む方法を説明します。
ワークフロー surface は、再利用する rule と対象の動画集合を分けます。MANAGE_RULEBOOKS がルールブックとワークフローを管理します。
ルールブック
content と rules の両方を持つルールブックを作成してください。
curl --fail-with-body -X POST "$BASE_URL/api/v1alpha1/rulebooks" \
-H "Authorization: Bearer $DEEPFRAME_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: rulebook-create-01" \
-d '{
"name": "Warehouse Safety",
"content": "Inspect every emergency exit.",
"rules": [
{"id":"SEC-04","title":"Emergency exit is clear.","description":"The exit remains unobstructed."}
]
}'GET /api/v1alpha1/rulebooks と GET /api/v1alpha1/rulebooks/{rulebook_id} でルールブックを読みます。PATCH /api/v1alpha1/rulebooks/{rulebook_id} で編集し、DELETE /api/v1alpha1/rulebooks/{rulebook_id} は 204 を返します。
CSV import
idempotency header を付けずに CSV を preview します。
curl --fail-with-body -X POST "$BASE_URL/api/v1alpha1/rulebooks/csv-imports/preview" \
-H "Authorization: Bearer $DEEPFRAME_API_KEY" \
-H "Content-Type: application/json" \
-d '{"csv_text":"Section,Rule ID,Requirement\nSafety,SEC-04,Emergency exit is clear."}'valid な preview を POST /api/v1alpha1/rulebooks/csv-imports と Idempotency-Key で確定します。preview には expiry があるため、その時刻までに import してください。
ワークフロー
ワークフローは rulebook、template type、任意の source list を紐づけます。
curl --fail-with-body -X POST "$BASE_URL/api/v1alpha1/workflows" \
-H "Authorization: Bearer $DEEPFRAME_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: workflow-create-01" \
-d '{
"name": "Warehouse safety review",
"rulebook_id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",
"template_type": "media_review",
"source_ids": ["vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"],
"playbook": "Review every indexed scene.",
"output_modes": ["report"],
"status": "draft"
}'template_type は media_review、content_review、retail_store_operations を受け付けます。output_modes は case、report、evidence_bundle を受け付けます。
ワークフローは作成時に見える source id を保存します。run で明示的な source_snapshot を渡すと、その run の source 集合を固定できます。workflow_id を含む POST /api/v1alpha1/runs で run を開始してください。
Run と review
top-level status が completed、failed、または canceled になるまで run を polling してください。ワークフローの検出結果は GET /api/v1alpha1/findings?run_id={run_id} で読みます。検出結果には rule provenance と evidence result state が残ります。分析ランと status と Findings、Answers、Reports を参照してください。