RAG Reasoning

Classic/VPC環境で利用できます。

信頼性を高める引用の出典、引用の出典のインデックス表記などの回答タイプに合わせて学習した RAG Reasoningモデルを活用し、根拠に基づいた RAG回答を生成します。RAG Reasoningは Function calling形式でエンジンを呼び出します。単一または複数の RAG関数を指定することができ、LLMが状況に合わせて自動で最適な関数を選択して検索拡張生成を行うことができます。リランカーと連携して使用するとより安定した結果値を得ることができます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

CLOVA Studio APIで共通して使用されるヘッダの詳細は、CLOVA Studioのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

messages

messagesの説明は次の通りです。

{
    "role": "tool",
    "content": "[
                    {
                        \"search_result\": [{\"id\": \"doc-1493058999\",
                        \"doc\": \"NAVERアカウントによるログインは、個人会員を対象にしており、事業者会員は対象外です。\"
                    },
                    ...
                 ]"
}

tools

toolsの説明は次の通りです。

toolCalls

toolCallsの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

• Step 1. role: userに質問の内容を入力し、回答生成に最適な関数を呼び出す (レスポンスの確認)

  curl --location --request POST 'https://clovastudio.stream.ntruss.com/v1/api-tools/rag-reasoning' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "messages": [
      {
        "content": "A100 GPUを借りる方法",
        "role": "user"
      }
    ],
    "tools": [
      {
        "function": {
          "description": "NCloud関連検索の際に使用するツールです。\n分けて質問する必要がある場合、クエリを分割してツールを使用します。\n情報が見つからなかった場合、最終回答は出さずに suggested_queriesを参照してツールを再度使用することができます。",
          "name": "ncloud_cs_retrieval",
          "parameters": {
            "properties": {
              "query": {
                "description": "ユーザーの検索キーワードを整理して入れてください。",
                "type": "string"
              }
            },
            "required": [
              "query"
            ],
            "type": "object"
          }
        },
        "type": "function"
      }
    ],
    "toolChoice": "auto",
    "maxTokens": 1024
  }'
  

• Step 2. 最終回答を生成するための、role: toolを含めむリクエスト (レスポンスの確認)

  curl --location --request POST 'https://clovastudio.stream.ntruss.com/v1/api-tools/rag-reasoning' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "messages": [
          {
              "content": "A100 GPUを借りる方法",
              "role": "user"
          },
          {
              "role": "assistant",
              "content": "",
              "toolCalls": [
                  {
                      "id": "call_enTEYb0kWBjOwtkngbl7FGTm",
                      "type": "function",
                      "function": {
                          "name": "ncloud_cs_retrieval",
                          "arguments": {
                              "query": "A100 GPUを借りる方法"
                          }
                      }
                  }
              ]
          },
          {
              "content": "{\"search_result\": [{\"id\": \"doc-179\", \"doc\": \"GPU A100は、KR-1でのみ作成できます。A100の作成時は、KR-1の Subnetを選択してください。GPUサーバは企業会員に限り、最大5台まで作成できます。\"}, {\"id\": \"doc-248\", \"doc\": \"NAVERクラウドプラットフォームコンソールの Services > Compute > Serverメニューから GPU A100サーバを作成できます。作成方法の詳細は、サーバ作成ガイドをご参照ください。\"}, {\"id\": \"doc-156\", \"doc\": \"より多くの GPUサーバが必要な場合、または GPUサーバの作成が必要な個人会員の場合は、FAQを参照してサポートにお問い合わせください。\"}]}",
              "role": "tool",
              "toolCallId": "call_enTEYb0kWBjOwtkngbl7FGTm"
          }
      ],
      "tools": [
          {
              "function": {
                  "description": "NCloud関連検索の際に使用するツールです。\n分けて質問する必要がある場合、クエリを分割してツールを使用します。\n情報が見つからなかった場合、最終回答は出さずに suggested_queriesを参照してツールを再度使用することができます。",
                  "name": "ncloud_cs_retrieval",
                  "parameters": {
                      "properties": {
                          "query": {
                              "description": "ユーザーの検索キーワードを整理して入れてください。",
                              "type": "string"
                          }
                      },
                      "required": [
                          "query"
                      ],
                      "type": "object"
                  }
              },
              "type": "function"
          }
      ]
  }'
  

レスポンス

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

レスポンスヘッダ

レスポンスヘッダの説明は次の通りです。

レスポンスボディ

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

toolCalls

toolCallsの説明は次の通りです。

レスポンス例

レスポンスのサンプルコードは次の通りです。

• Step 1.に対するレスポンス例 (リクエストの確認)

  {
      "status": {
          "code": "20000",
          "message": "OK"
      },
      "result": {
          "message": {
              "role": "assistant",
              "content": "",
              "thinkingContent": "ユーザーから\"A100 GPUの借り方\"について質問がありました。この質問への回答を見つけるには、'ncloud_cs_retrieval'ツールを使って関連情報を検索する必要があります。",
              "toolCalls": [
                  {
                      "id": "call_enTEYb0kWBjOwtkngbl7FGTm",
                      "type": "function",
                      "function": {
                          "name": "ncloud_cs_retrieval",
                          "arguments": {
                              "query": "A100 GPUを借りる方法"
                          }
                      }
                  }
              ]
          },
          "usage": {
              "promptTokens": 135,
              "completionTokens": 84,
              "totalTokens": 219
          }
      }
  }
  

• Step 2.に対するレスポンス例 (LLMの最終回答を返す) (リクエストの例)

  {
      "status": {
          "code": "20000",
          "message": "OK"
      },
      "result": {
          "message": {
              "role": "assistant",
              "content": "A100 GPUを借りる方法は、<doc-248>NAVERクラウドプラットフォームコンソールの Services > Compute > Serverメニューから GPU A100サーバを作成できます。</doc-248>しかし、<doc-179>GPU A100は KR-1でしか作成できないため、A100の作成時には KR-1の Subnetを選択する必要があります。</doc-179>さらに、<doc-179>GPUサーバは企業会員に限り、最大5台まで作成できます。</doc-179>より多くの GPUサーバが必要な場合、または GPUサーバの作成が必要な個人会員の場合は、<doc-156>FAQを参照してサポートにお問い合わせください。</doc-156>"
          },
          "usage": {
              "promptTokens": 332,
              "completionTokens": 146,
              "totalTokens": 478
          }
      }
  }
  

失敗

呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

• クライアント共通エラー問題(4xx)
• サーバ共通エラー問題(5xx)