RAG overview

Available in VPC

Retrieval Augmented Generation (RAG) is a NAVER Cloud Platform service that allows LLM to generate customized answers with high accuracy by referencing user data. The RAG service provides APIs for generating answers to questions and retrieving, editing, and deleting documents and files referenced in the answer generation in RESTful form.

API key

The RAG API issues an API key, a user identification tool, to each account so that only authorized users can call it. The API key is used as a parameter in the request header that is passed as authentication information when calling the API. Therefore, to use the RAG API, you must first obtain an API key.

Issue API key

API keys can be issued in RAG of the NAVER Cloud Platform console. The following describes how to issue them.

1. In the NAVER Cloud Platform console, click Services > AI Services > RAG > Services menus, in that order.
2. Click the [Manage API key] button in the service table.
3. When the Manage API key pop-up window appears, click the [Issue API key] button.
4. When the Issue API key pop-up window appears, click the [Issue] button.
   • In the Copy API key pop-up window, copy the issued API key.

Set API security

If the API key is leaked to a third party, security issues may arise, such as unauthorized use of RAG resources, so proper preparation and response are required.

Delete and reissue API key

If you do not use the API key or suspect that it has been stolen by a third party, you must delete the issued API key and reissue it. The following describes how to delete and reissue the API key.

1. In the NAVER Cloud Platform console, click Services > AI Services > RAG menus, in that order.
2. Click the [Manage API key] button in the service table.
3. When the Manage API key page appears, click of the API key to delete, and then click the Delete menu.
4. When the Delete API key pop-up window appears, click the [Delete] button.
5. See Issue API key and issue a new API key.

Common RAG settings

The following describes commonly used request and response formats in RAG APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

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

Request headers

The following describes the request headers.

Response

The following describes the common response format.

Response body

The response body includes the following data:

responseError
responseError defines the API call failure information. The following describes responseError.

Response status codes

The following describes the response status codes.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

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

RAG API

The following describes the APIs provided by the RAG service.

Chats

Documents

Files

RAG related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand RAG APIs.

• RAG service guides
  • User Guide{target="_blank"}: how to use RAG in the NAVER Cloud Platform console
  • Ncloud use environment guide: guide on VPC and Classic environments and supported features