RAGO-X APIとサービス連携の概要

利用例

既存ツールに文書ベースの回答と根拠を接続します。

• 社内検索
• カスタマーサポート
• 製品文書案内
• ポータル・チャット

実装前の確認

運用条件を先に確認します。

• 認証とキー管理
• リクエスト形式
• レートとクレジット
• エラーと再試行
• 根拠データ形式
• バージョン方針

公開範囲

ランディングはAPIの存在を案内しますが、完全なリファレンスは公開していません。

1. キャビネットとAPIキーを準備

開発者 → APIキー管理で必要なキャビネットだけを選択してキーを発行します。キーの原文は発行直後に一度だけ表示されるため、連携サーバーに保管してください。API基本URLと最新の形式は開発者 → API利用ガイドで確認します。このランディングサイトはAPIサーバーではありません。

2. 質問の受付と回答完了を区別

キーで許可されたキャビネットを取得し、選んだキャビネットに質問を送ります。返されたtask_idのSSEストリームに、質問送信時と同じキーで接続します。受付成功は回答完了ではありません。処理中・完了・失敗を画面で区別し、詳細ガイドのcURL例で各段階を確認してください。

3. 利用者の権限と会話を分離

APIキーの許可範囲と個々の利用者の閲覧権限は別です。連携サーバーで対象キャビネットへの権限を検証し、利用者・キャビネット・会話の関係を管理します。例の固定session_idを全員で共有せず、実際の会話ごとに識別できる値を使ってください。

4. 公開前に検証

代表的な質問で回答と返された根拠を比較し、権限のないキャビネットへの要求やストリーム切断も試します。ネットワークの受信断片を一つのSSEイベントと見なさず、イベントの区切りまで蓄積して処理してください。再試行は最新ガイドに従い、切断のたびに質問を再送しないでください。