Indexing と polling

Schema preview: このページの手順と curl は公開契約のpreviewです。stg live acceptanceが完了するまで、API keyの発行とoperationの実行は利用できません。

Indexing を開始する

Asset の upload 検証が完了した後、indexing operation を submit します。response が 202 Accepted の場合、Location と Run ID を保存してください。

Run を poll する

Run は non-terminal と terminal の状態を区別します。一定間隔で状態を取得し、完了・失敗・取消の いずれかを確認します。Retry-After が返る場合はその値を優先し、短い固定間隔で連打しないでください。

curl --request GET "${NAKATAKU_ENGINE_API_BASE_URL}/runs/${RUN_ID}" \
  --header "X-Api-Key: ${NAKATAKU_ENGINE_API_KEY}"

Asset の index status

Run の完了と Asset の検索準備完了は別の観測点です。Asset の index status を取得し、対象 version と generation を確認します。

Fail closed

ContentSpace 内の current Asset が同じ generation へ投影済みでない場合、検索 route は部分結果を返さず PRECONDITION_FAILED 相当で閉じます。古い AssetVersion や混在 generation を成功として扱いません。