Assembly Execution Progress:Assembly のリアルタイムステータス
アップロードが完了した後も、ユーザーはファイルの処理状況を知りたいものです。新機能の Assembly Execution Progress は、処理中にファイルごとの進捗イベントをリアルタイムに提供し、そのニーズに応えます。単純なスピナーの代わりに、意味のあるステータスを UI に表示できます。
Assembly Execution Progress は、まだ実験段階の機能です。改善を進める中で、動作、API の詳細、料金が変わる可能性があります。問題が発生した場合は、お問い合わせください。
なぜ重要なのか
アップロードの進捗は、ファイルが当社のサーバーに届くまでの状況を伝えます。Assembly Execution Progress は、その後、各処理 Step でファイルの処理がどこまで進んだかを伝えます。複雑なパイプラインでも、特にファイルごとに異なる経路をたどる場合に、ユーザーが安心して処理を待てるようになります。
仕組み
Transloadit は、Assembly 内の残りの
Step を予測し、その推定値と実行中のデータ(たとえば /video/encode のエンコード進捗)を組み合わせて、全体の進捗を推定します。全体の進捗率とファイルごとの進捗値が、約 2 秒ごとに更新されます。
Assembly での有効化
Assembly の作成時に、Assembly Instructions に
emit_execution_progress: true を追加します。
{
"steps": {
"resized": {
"robot": "/image/resize",
"use": ":original",
"width": 100,
"height": 100,
"resize_strategy": "fillcrop"
}
},
"emit_execution_progress": true
}
進捗ストリームの利用
Assembly の更新ストリームを開き、assembly_execution_progress イベントをリッスンします。各イベントには、progress_combined に格納された全体の推定値と、ファイルごとの進捗値の配列が含まれます。まだ進捗を推定できない場合は、UI を進捗不明の状態に保ちます。
{
"progress_combined": 75,
"progress_per_original_file": [
{
"original_id": "6bb16f6cd49a44b4ae431f576e016c6d",
"progress": 50
},
{
"original_id": "56921a2dd46246d3b4d3a98b9f8ed4e1",
"progress": 100
}
]
}
UI のヒント
アップロードの進捗と実行の進捗を組み合わせて、パイプライン全体の状況をユーザーに伝えましょう。
バッチアップロードではファイルごとの進捗を表示し、「処理が止まっている」という印象を避けましょう。
全体を示す単一のバーには全体の進捗を、詳細なリスト表示にはファイルごとの進捗を使いましょう。
注意点
進捗は推定値です。ワークフローによっては、すぐに提供できない場合や、まったく提供できない場合があります。結果の数を予測できない処理、URL Transform Assemblies、マルチパートアップロードについては、対応する Assembly のガイドをご覧ください。progress_per_original_file の各エントリーは、original_id で入力を識別します。この ID を持たないインポート済みファイルは、リストに含まれません。
次のステップ
Assembly Execution Progress のドキュメントで、互換性のルール、更新が届かない場合、null を許容する進捗スキーマについて確認してください。続いて、Assembly 更新ストリームのリファレンスを参照し、イベントを UI に組み込んでください。
