前提条件

認証と、すべてのリクエストに共通する約束事。

認証

JWT の検証はゲートウェイが行います。 アクセストークンを Authorization ヘッダに Bearer スキームで載せてください。

POST /v1/rag/search
Host: <api-gateway-host>
Authorization: Bearer <access-token>
Content-Type: application/json

トークンには dep-beta:rag-data-api:call スコープが必要です。取得方法は 認証 を参照してください。スコープを欠くリクエストは API サーバに到達せず、ゲートウェイが 401 または 403 を返します。この場合の レスポンスは後述の application/problem+json 形式ではありません。 発生条件と応答形式の詳細は エラー を参照してください。

API ゲートウェイのホスト名と client_id / client_secret は個別に共有します。

リクエストの前提

項目制約違反時
Content-Typeapplication/json415
ボディサイズ4KB (4,096 バイト) 以下413
JSON のキー短縮名のみ400
未対応のトップレベルパラメータ送らない400

リクエスト・レスポンスの JSON キーは短縮名のみです (q / flt / srt / o / l / fld など。正式名は各パラメータの説明に併記)。正式名 (limit など) をキーにした 場合や未対応のパラメータは黙って無視せず 400 で拒否します。仕様に無い項目を送って いないか、まず確認してください。パラメータ名の綴り違いもここで弾かれます。

レスポンスの読み方

成功時は 200 と検索結果を返します。リクエストで指定した値がそのまま適用されたか どうかは、レスポンスの q / nq / o / l で確認できます。 サーバ側で正規化・省略値の補完が入るため、送った値と一致しない場合があります。

動作確認

curl -X POST "https://<api-gateway-host>/v1/rag/search" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"q": "自己資本比率の推移", "l": 3}'

エンドポイントごとの完全なリクエスト例は RAG 用データ API の コードスニペットを参照してください。

はじめに

RAG 用データ API の概要と、全エンドポイントに共通する約束事。

認証

OAuth 2.0 Client Credentials Flow によるアクセストークンの取得方法。

On this page

認証リクエストの前提レスポンスの読み方動作確認