概要 | DeepFrame Developers

DeepFrame API は、動画を根拠のある意思決定へ変換します。動画を一度 upload して index すると、Search、Workflow Review、Analysis で再利用できます。Finding と Answer は result state と確認可能な evidence を保持し、Report はその既存の answer data を整形します。

何を作れるか

まず必要な成果を選んでください。どの方法でも同じインデックス済み動画を再利用します。

Search

再利用可能な index 済みエビデンスを自然言語で検索し、関連度順の候補と timestamp を確認します。

Workflow Review

保存済み rulebook を適用し、result state と provenance を持つエビデンス付き Finding を確認します。

Analysis

保存済み profile と report template で、typed field と evidence を持つ名前付き Answer を作成します。

DeepFrame の仕組み

アップロード: 正確な file_size でアップロードセッションを作成します。返された保存先へ動画を送り、分割アップロードの場合は各パートの受領情報を記録してから完了操作を行います。content type、duration、upload strategy はサーバーが管理します。
インデックス: 動画の status が completed になるまで待ちます。インデックス済み動画は、複数の機能で再利用できます。
パスを選ぶ: index 済みエビデンスを Search、Workflow Review、Analysis で再利用します。
結果を確認: Search は timestamp 付きの一致を返します。Workflow Review は Finding を返します。Analysis は typed field を持つ名前付き Answer を返します。
レポート: 保存済み report template で既存の answer data を選択します。新しい表示 view には rerender endpoint を使います。
判断: found、not_found、uncertain、not_checked を区別します。各判断には、確認できる根拠への経路が必要です。

ベース URL とバージョン

すべてのルートは次のベース URL を使います。

https://api.deepframe.cloud/api/v1alpha1

/api/v1alpha1 は alpha channel です。この revision の contract は凍結されていますが、互換性は保証されません。breaking change は日付付きの新しい alpha revision に入ります。profile、report template、run は immutable version を固定でき、選択した instruction、answer field、表示を再現できます。規約で version と response header を確認してください。

認証

Public API Alpha キー（alpha 期間中に DeepFrame API へのアクセスを付与する key type）を bearer token として送ります。

curl --fail-with-body "$BASE_URL/api/v1alpha1/videos" \
  -H "Authorization: Bearer $DEEPFRAME_API_KEY"

API キーからワークスペースが特定され、ルートごとのアクセス権限が適用されます。プラットフォーム管理者が対象ワークスペースで Public API Alpha への opt-in を行うまで、alpha traffic は受け付けられません。認証を参照してください。

はじめに

クイックスタート

小さな動画を 1 本アップロードし、インデックス完了後に最初の検索を行います。

認証

API キー、ルートアクセス権限、ワークスペースアクセスを確認します。

アップロード

direct と multipart の upload session と処理 status を確認します。

探す

検索

インデックス済み動画を自然言語で検索します。

分析・レビュー

ルールブックとワークフロー

ルールを作成し、動画に紐づけます。

分析、プロファイル、レポート

分析プロファイル、レポートテンプレート、型付き回答、レポートを確認します。

分析ランと状態

統一された実行状態と確認手順です。

検出結果とレポート

ワークフローの検出結果、分析回答、表示用レポートを確認します。

連携を運用する

Webhook

通知の形式、署名、配信履歴を確認します。

エラー

RFC 9457 形式のエラー内容と再試行方針を確認します。

本番導入の準備

導入前の確認事項と、この alpha ポータルだけでは判断できない企業向け要件を整理します。

規約

ページ分割、安全な再試行、利用上限、alpha 版の安定性を確認します。

変更履歴

alpha 版の仕様変更を日付順に確認します。

API リファレンス

API リファレンスには、リポジトリで管理されている OpenAPI 仕様のすべての操作を掲載しています。各操作で、リクエスト、応答、応答ヘッダー、エラー、コード例を確認できます。

概要