コンテンツにスキップ

パースプレビューの取得

メソッド

この API は REST の方法論に従います。

HTTP メソッド

GET: 実行のパースプレビューを読み取ります — ワーカーがワイヤーフレームから導出したロールと意図、およびワイヤーフレームのノードツリー全体です。

これはインタラクティブフロー(autoConfirm = false)の confirm チェックポイント でプラグインが表示する内容であり、assemble にコストを費やす前にワイヤーフレームがどう解釈されたかをデザイナーが確認できます。完了後も読み取り可能で、その実行が何をもとに構築されたかの記録になります。

命名規則

レスポンスは内部の wf2des-api データプレーンから 逐語でプロキシ されるため、フィールドは snake_case です。形状はワーカーが所有します。

リクエストとレスポンス

ヘッダー

リクエストヘッダー

  • Authorization
  • Accept
  • Accept-language

レスポンスヘッダー

  • Content-Type

パースの取得

URI

GET /api/v1/organizations/{organization_id}/projects/{project_id}/wf2des/{wf2des_id}/parse

パスパラメータ

名前 型 必須 説明
organization_id integer 必須 組織 ID
project_id integer 必須 プロジェクト ID
wf2des_id string 必須 wf2des ID

レスポンス

レスポンスは JSON です(HTTP ステータス: 200 OK)。

{
  "wf2des_id": "wf2des-001",
  "parse": {
    "artifact_hash": "8f14e45fceea167a5a36dedd4bea2543",
    "sections": [],
    "intent": {},
    "rejected": null
  },
  "parse_tree": {
    "node_id": "2:264664",
    "role": "screen",
    "children": []
  }
}

レスポンスフィールド

名前 型 説明
wf2des_id string このパースが属する実行。
parse object | null 結果文書内の parse ブロック — セクション、意図、confirm が用いる artifact_hash、およびチェックポイントを却下した場合の rejected。
parse_tree object | null ワイヤーフレームのノードツリー全体。イミュータブルな parse.json アーティファクトからインライン化される。アーティファクトが無い場合は null。

parse.artifact_hash は POST …/confirm を呼ぶ際に parseArtifactHash として送る値です。confirm はこれを現在のアーティファクトと比較し、不一致の場合は 409 を返します。これにより、破棄済みのパースが confirm されるのを防ぎます。

認証

認証は Amazon Cognito が発行する JSON Web Token(JWT)で行われます。加えて、呼び出し元はプロジェクトへのアクセス権を保持している必要があります。

エラーハンドリング

説明 ステータスコード ステータス名
認証情報の欠落 401 Unauthorized
権限不足 403 Forbidden
パースが見つからない(未知の wf2des_id、またはパース未実行) 404 Not Found
上流の読み取り失敗(wf2des-api または S3) 500 Internal Server Error

処理フロー

  1. パスパラメータから組織 ID、プロジェクト ID、wf2des_id を取得する。
  2. ユーザーがプロジェクトへのアクセス権を持つことを検証する。
  3. 組織とプロジェクトにスコープした上で、内部 wf2des-api データプレーンへ読み取りをプロキシする(X-AI-Service-Token)。
  4. データプレーンは design_generation_result 文書を読み込み、artifact_urls.parse があればイミュータブルな parse.json アーティファクトを parse_tree としてインライン化する。このアーティファクト読み取りは 任意 であり、存在しない場合はエラーではなく parse_tree: null となる。
  5. 文書を逐語で返す。