--- title: "RAGの概要" slug: "rag-overview" updated: 2026-09-17T09:57:14Z published: 2026-09-17T09:57:14Z canonical: "api.ncloud-docs.com/rag-overview" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # RAGの概要 VPC環境で利用できます。 Retrieval Augmented Generation(RAG)は、ユーザーのデータを参照し、LLMが精度の高いカスタマイズされた回答を生成してくれる NAVERクラウドプラットフォームのサービスです。RAGサービスは、質問に対する回答を生成し、回答生成に参照される文書とファイルを管理する APIを RESTful形式で提供します。 ## APIキー RAG APIは、APIキーを使用してリクエストを認証します。各アカウントには固有のキーが発行され、APIを呼び出す際にはリクエストヘッダに含める必要があります。そのため、RAG APIを使用するには、先に APIキーを発行する必要があります。 ### APIキーの発行 APIキーは NAVERクラウドプラットフォームコンソールで発行できます。発行方法は次の通りです。 1. NAVERクラウドプラットフォームコンソールで **Menu** > **All Services** > **AI Services** > **RAG** > **Services**メニューを順にクリックします。 2. サービス票のヘッダで、 **[APIキーを管理]** ボタンをクリックします。 3. **APIキー管理**画面が表示されたら、 **[APIキーを発行]** ボタンをクリックします。 4. **APIキー発行**のポップアップが表示されたら、 **[発行]** ボタンをクリックします。 - **APIキーのコピー**ポップアップから発行された APIキーをコピーします。 注意 発行された APIキーは、**APIキーのコピー**ポップアップを閉じると確認できなくなります。発行時に必ず別の安全な場所に保管してください。 参考 APIキーは、NAVERクラウドプラットフォームのメインアカウント基準で最大5個まで作成できます。 ### APIのセキュリティ設定 APIキーが第三者に流出する場合、RAGリソースを任意に利用するなどセキュリティ上の深刻な問題が発生する可能性があるので、適切な事前準備と対応が必要です。 #### APIキーの削除と再発行 APIキーを使用していない場合や、第三者の盗用が疑われる場合は、発行した APIキーを削除し、再度発行する必要があります。削除および再発行方法は次の通りです。 1. NAVERクラウドプラットフォームコンソールで **Menu** > **All Services** > **AI Services** > **RAG**メニューを順にクリックします。 2. サービス票のヘッダで、 **[APIキーを管理]** ボタンをクリックします。 3. **APIキー管理**画面が表示されたら、削除対象 APIキーの![rag-more-icon](https://cdn.document360.io/da0368a0-4444-4862-a528-42f78876f9e6/Images/Documentation/rag-more-icon.png?sv=2026-02-06&spr=https&st=2026-11-03T16%3A40%3A16Z&se=2026-11-03T17%3A40%3A16Z&sr=c&sp=r&sig=ukWyPM2mVRQlLpxRpAI%2BI%2FuLNty%2FwlvtWvPKENb903M%3D)をクリックし、**削除**メニューをクリックします。 4. **APIキーの削除**ポップアップが表示されたら、 **[削除]** ボタンをクリックします。 5. [APIキーの発行](/docs/ja/rag-overview#API%ED%82%A4%EB%B0%9C%EA%B8%89)を参照して APIキーを新規発行します。 注意 削除した APIキーは有効ではないキーとして認識され、APIの呼び出しに使用できません。 ## RAGの共通設定 RAG APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。 ### リクエスト 共通リクエスト形式を説明します。 #### API URL リクエスト API URLは次の通りです。 ``` https://kr-pub-gateway.rag.naverncp.com ``` #### リクエストヘッダ リクエストヘッダの説明は次の通りです。 | フィールド | 必須の有無 | 説明 | | --- | --- | --- | | `Authorization` | Required | 認証用 APIキー - `Bearer {apiKey}` | | `Content-Type` | Required | リクエストデータの形式 - `application/json` \| `multipart/form-data` | | `Accept` | Optional | レスポンスデータの形式 - `text/event-stream` | 参考 - レスポンス結果は基本的に JSON形式で返されますが、`Accept`を`text/event-stream`に指定するとレスポンス結果をストリーム形式で返します。 ### レスポンス 共通レスポンス形式を説明します。 #### レスポンスボディ レスポンスボディの説明は次の通りです。 **responseError** responseErrorは API呼び出し失敗情報を定義します。responseErrorの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `code` | String | Required | エラーコード | | `message` | String | Required | エラーメッセージ | #### レスポンスステータスコード レスポンスステータスコードの説明は次の通りです。 | HTTPステータスコード | コード | メッセージ | 説明 | | --- | --- | --- | --- | | 200 | 20000 | Success | リクエスト成功 | | 400 | 400 | Bad Request | ファイルエラー | | 400 | 40000 | Invalid parameters | ヘッダパラメータエラー | | 400 | 40000 | Too large file error | 大きすぎるファイルエラー | | 400 | 40001 | Service not ready | インデックスが完了していない状態で会話を試みる - 初回: インスタンス完了後にテスト可能 - 増分インデックス: インデックスなしでもテスト可能 | | 400 | 40002 | Invalid service id | 無効なサービス ID | | 401 | 200 | Authentication failed | 認証失敗 | | 403 | 210 | Permission denied | 権限なし | | 404 | 404 | Index or document not found | インデックスまたは文書が見つからない | | 404 | 1001 | Document not found | 文書が見つからない | | 404 | 40401 | Service ID not found | 存在しないサービス ID | | 408 | 40800 | Timeout | タイムアウト | | 408 | 40801 | Llm timeout | LLMタイムアウト | | 408 | 40802 | Retrieval timeout | Retrievalタイムアウト | | 408 | 40803 | Citation timeout | Citationタイムアウト | | 415 | 41500 | Unsupported file type error | サポートしていないファイル形式 | | 422 | 42200 | Request validation error | リクエストボディエラー | | 422 | 422 | Request Validation Error | リクエストパラメータエラー | | 500 | 900 | Unexpected Error | 予期せぬエラー | | 500 | 50000 | Extract error | 抽出エラー | | 500 | 50001 | Llm error | LLMレスポンスエラー | | 500 | 50002 | Text too long | LLM最大トークン数超過 | | 500 | 50003 | Too many requests | 単位時間あたりの LLMリクエスト数超過 | | 500 | 50004 | Llm request failed | LLMリクエスト失敗 | | 500 | 50005 | Llm model not found | モデルタイプをサポートしていない | | 500 | 50006 | Client exception | 内部エラー | | 500 | 50007 | Invalid Key | 無効な APIキー | | 500 | 50008 | Model not found | LLMモデル名が見つからない | | 500 | 50009 | Quota Exceeded | LLM使用量上限超過。クレジットチャージが必要 | | 500 | 50020 | Retrieval error | 検索エラー | | 500 | 50100 | Citation error | 引用文生成エラー | | 503 | 500 | Service unavailable | 一時的にサービス不可 | | 503 | 520 | Unavailable endpoint domain | 一時的にサービス不可 | | 503 | 530 | Connection closed by endpoint | 異常終了 | | 504 | 510 | Gateway timeout | ゲートウェイタイムアウト | #### レスポンス例 呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。 ``` { "code": 50008, "message": "Model not found" } ``` ## RAG API RAGサービスが提供する APIの説明は次の通りです。 ### Chat 会話関連 APIの説明は次の通りです。 | API | 説明 | | --- | --- | | [会話の作成](/docs/ja/rag-create-chat) | ユーザークエリに対し、LLMが会話型文章を生成 | | [会話タイトルの生成](/docs/ja/rag-create-chat-title) | ユーザーとやり取りした会話に対し、LLMがタイトルを生成 | ### Document 文書関連 APIの説明は次の通りです。 | API | 説明 | | --- | --- | | [文書の追加](/docs/ja/rag-add-doc) | インデックスシステムに JSONデータをアップロード | | [IDを指定して文書を追加](/docs/ja/rag-add-doc-by-id) | 文書 IDを指定してインデックスシステムに JSONデータをアップロード | | [文書の置き換え](/docs/ja/rag-replace-doc) | アップロードされている既存の文書を新しい文書に置き換え | | [文書の削除](/docs/ja/rag-delete-doc) | アップロードされている既存の文書を削除 | | [インデックスされた文書の照会](/docs/ja/rag-get-indexed) | サービス内でインデックスされた文書を照会 | | [インデックスされた文書数の照会](/docs/ja/rag-get-count) | サービス内でインデックスされた文書数を照会 | | [文書のインデックス状態の照会](/docs/ja/rag-get-status) | インデックスリクエストした文書の処理状態を照会 | ### File ファイル関連 APIの説明は次の通りです。 | API | 説明 | | --- | --- | | [ファイルの追加](/docs/ja/rag-add-file) | インデックスシステムにファイルをアップロード | | [IDを指定してファイルを追加](/docs/ja/rag-add-file-by-id) | ファイル IDを指定してインデックスシステムにファイルをアップロード | | [ファイルの置き換え](/docs/ja/rag-replace-file) | アップロードされている既存のファイルを新しいファイルに置き換え | | [ファイルの削除](/docs/ja/rag-delete-file) | アップロードされている既存のファイルを削除 | ## RAG関連リソース RAG APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。 - RAGサービスの使用方法 - [RAGご利用ガイド](https://guide.ncloud-docs.com/docs/ja/rag-overview): NAVERクラウドプラットフォームコンソールで RAGを使用する方法 - [Ncloud使用環境ガイド](https://guide.ncloud-docs.com//docs/ja/environment-environment-1-1): VPC、Classic環境およびサポートに関する利用ガイド