ready
接続設定
トークンはブラウザのlocalStorageに保存できます。公開代理APIの誤利用を避けるため、API呼び出し時に X-Tester-Token として送ります。
API一覧・用途・確認場所
この確認画面は主にMain API Gatewayを対象にしています。専用ボタンがないAPIはCustom Requestにメソッド・パス・JSON Bodyを入力して確認してください。Cognito認証後の業務用APIとAdmin APIは、本番相当ユーザー画面で確認します。
| API | 使うタイミング | 正常な応答の目安 | 確認場所 |
|---|---|---|---|
| GET /v1/health | API基盤の疎通確認。 | HTTP 200、statusがok。 | この画面: 1. Health |
| POST /v1/files/upload-url | 分類に使うファイルのfileIdとアップロード先を発行。 | fileId、s3ObjectKey、uploadUrlが返る。 | この画面: 2. File Upload |
| PUT /v1/files/{fileId}/content | 社内セキュリティでS3署名URLへ直接PUTできない場合に、API経由で小さめのファイルを投入。 | statusがuploaded、object.existsがtrue。 | この画面: 2. File Upload |
| POST /v1/files/{fileId}/chunked-upload PUT /v1/files/{fileId}/chunked-upload/parts/{partNumber} POST /v1/files/{fileId}/chunked-upload/complete | 大きめのファイルを分割してアップロード。 | complete後にstatusがuploaded、sha256が一致。 | この画面: 2. File Upload |
| DELETE /v1/files/{fileId}/chunked-upload | 途中の分割アップロードを中止。 | キャンセル完了または対象なしの応答。 | Custom Request |
| GET /v1/files/{fileId} | アップロード済みか、S3オブジェクトが存在するかを確認。 | status、contentType、object.existsが確認できる。 | この画面: 3. File Status |
| POST /v1/classification-jobs | テキスト、fileId、PDF、画像等から分類ジョブを開始。 | HTTP 202、jobId、statusUrl、resultUrl。 | この画面: 4. Classification Job |
| GET /v1/classification-jobs/{jobId} | 非同期分類ジョブの進捗確認。 | queued/running/completed/failed/needs_clarification等。 | この画面: 4. Classification Job |
| GET /v1/classification-jobs/{jobId}/result | 分類完了後にTop3、理由、根拠を取得。 | candidates/top3、classificationExplanation、evidenceRefs。 | この画面: 4. Classification Job |
| GET /v1/classification-jobs/{jobId}/questions POST /v1/classification-jobs/{jobId}/answers | AIが追加情報を要求した場合の質問取得と回答登録。 | 質問一覧、回答受付、再分類開始。 | Custom Request |
| GET /v1/classification-results GET /v1/classification-results/{resultId} GET /v1/classification-results/{resultId}/evidence | Auroraへ保存済みの分類結果を検索・詳細確認・根拠確認。 | items/detail/evidenceRefsが返る。 | この画面: 5. Classification Result Store |
| POST /v1/classification-jobs/{jobId}/feedback GET /v1/feedback | 利用者レビュー、正解HS、採否コメントを蓄積。 | feedbackId、reviewStatus、一覧。 | この画面: 5. Classification Result Store |
| POST /v1/evidence/search GET /v1/evidence/{evidenceId} | RAG根拠を通常検索、HS直接検索、ベクトル/ハイブリッド検索で確認。 | evidenceItems、score、sourceType、quote。 | Custom Request |
| POST /v1/knowledge-sources POST /v1/knowledge-sync-jobs | 根拠資料ソース登録、同期ジョブ開始のPoC確認。 | sourceIdまたはsync jobの受付応答。 | Custom Request |
| POST /v1/evaluation-jobs GET /v1/evaluation-jobs GET /v1/evaluation-jobs/{evaluationJobId} GET /v1/evaluation-jobs/{evaluationJobId}/result | 評価データでTop1/Top3精度を集計。 | evaluationJobId、status、metrics。 | この画面: 6. Evaluation Job |
| POST /v1/genai/flow-executions GET /v1/genai/flow-executions/{executionName} GET /v1/genai/flow-executions/{executionName}/response | GenUや外部検証からBedrock Flowを直接試す。 | execution status、Flow応答document。 | この画面: GenAI Flow API |
| GET /v1/me GET /v1/me/dashboard | ログイン中ユーザーの属性、ダッシュボード件数、最近のジョブ確認。 | user、counts、recentJobs。 | 本番相当ユーザー画面: ダッシュボード |
| GET /v1/admin/summary GET/POST /v1/admin/tenants GET/POST /v1/admin/organizations GET/POST /v1/admin/users GET /v1/admin/jobs GET /v1/admin/audit-logs GET/POST /v1/admin/evaluation-jobs | 管理者によるテナント、組織、ユーザー、横断検索、監査、評価ジョブ確認。 | summary、items、audit logs、evaluation job。 | 本番相当ユーザー画面: 管理タブ |
1. Health
API自体が生きているかを最初に確認します。HTTP 200、status=ok が正しい応答です。
2. File Upload
推奨はAPI経由アップロードです。S3署名付きURLをブラウザに渡さず、このドメインからPoC APIの PUT /v1/files/{fileId}/content へ送ります。POCのJSON/base64経路なので大きなファイルは不向きです。
3. File Status
4. Classification Job
5. Classification Result Store
Use these APIs after a job result has been persisted. In this PoC, resultId is the same value as jobId.
6. Evaluation Job
Create a small API-based evaluation job and retrieve metrics. This is the PoC Lambda/DynamoDB implementation, not the future ECS batch worker.
GenAI Flow API
Custom Request
Ready.