RAGの概要

VPC環境で利用できます。

RAG(Retrieval Augmented Generation)は、ユーザーのデータを参照し、LLMが精度の高いカスタマイズされた回答を生成してくれる NAVERクラウドプラットフォームのサービスです。RAGサービスは、質問に対する回答を生成し、回答生成に参照される文書とファイルを照会・変更・削除する APIを RESTful形式で提供します。

APIキー

RAG APIは、権限を持つユーザーのみ呼び出すことができるようにユーザー識別ツールの APIキーをアカウントごとに発行しています。APIキーは、API呼び出し時の認証情報として渡すリクエストヘッダのパラメータとして使用します。そのため、RAG APIを使用するには、先に APIキーを発行する必要があります。

APIキーの発行

APIキーは NAVERクラウドプラットフォームコンソールの RAGで発行できます。発行方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールで Services > AI Services > RAG > Servicesメニューを順にクリックします。
2. サービス票のヘッダで、 [APIキーを管理] ボタンをクリックします。
3. APIキー管理画面が表示されたら、 [APIキーを発行] ボタンをクリックします。
4. APIキー発行のポップアップが表示されたら、 [発行] ボタンをクリックします。
   • APIキーのコピーポップアップから発行された APIキーをコピーします。

APIのセキュリティ設定

APIキーが第三者に流出する場合、RAGリソースを任意に利用するなどセキュリティ上の深刻な問題が発生する可能性があるので、適切な事前準備と対応が必要です。

APIキーの削除と再発行

APIキーを使用していない場合や、第三者の盗用が疑われる場合は、発行した APIキーを削除し、再度発行する必要があります。削除および再発行方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールで Services > AI Services > RAGメニューを順にクリックします。
2. サービス票のヘッダで、 [APIキーを管理] ボタンをクリックします。
3. APIキー管理画面が表示されたら、削除対象 APIキーのをクリックし、削除メニューをクリックします。
4. APIキーの削除ポップアップが表示されたら、 [削除] ボタンをクリックします。
5. APIキーの発行を参照して APIキーを新規発行します。

RAGの共通設定

RAG APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://kr-pub-gateway.rag.naverncp.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

レスポンス

共通レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

responseError
responseErrorは API呼び出し失敗情報を定義します。responseErrorの説明は次の通りです。

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "code": 50008,
    "message": "Model not found"
}

RAG API

RAGサービスが提供する APIの説明は次の通りです。

Chats

Documents

Files

RAG関連リソース

RAG APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。

• RAGサービスの使用方法
  • RAGご利用ガイド: NAVERクラウドプラットフォームコンソールで RAGを使用する方法
  • Ncloud使用環境ガイド: VPC、Classic環境とサポートの有無に関するご利用ガイド