IDを指定して文書を追加

VPC環境で利用できます。

文書 IDを指定してインデックスシステムに JSONデータをアップロードします。システムが自動作成する IDの代わりに、ユーザーが希望する IDで文書を作成することができます。

リクエスト

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

リクエストヘッダ

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

リクエストパスパラメータ

パラメータの説明は次の通りです。

リクエストボディ

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

リクエスト例

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

curl --location --request POST 'https://kr-pub-gateway.rag.naverncp.com/api/v1/svc/{serviceId}/doc/12345' \
--header 'Authorization: Bearer {apiKey}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "12345",
  "orgid": "naver:media-ai-understanding.txt",
  "title": "Media AI Understanding",
  "file_name": "media-ai-understanding.txt",
  "body": "あのシーン、どの辺だっけ。映像編集の救い主、Media AI\n\n映像の編集したことがある人なら誰でもこのような経験はあるでしょう。数十時間の撮影映像の中から特定のシーンを探すのに無駄な時間を費やしたこと。NAVERクラウドの Media AIは、映像の制作を効率化します。映像をアップロードするだけで、AIがシーンに登場する人物や行動を自動的に分析し、スクリプトまで整理してくれます。\n\n\"主人公が走るシーンだけ集めて\"とリクエストすれば、特定の人物が走るすべてのシーンをあっという間に見つけてくれるんだから、編集者は定時退社もできますし、クリエイティブな作業にもっと集中できます。メタ情報を編集ツールと連携して、映像の編集を効率的に完成してみませんか?",
  "url": "www.naver.com",
  "created_at": "2025-06-09T19:45:11+00:00",
  "extra": {
    "bucket": "naver",
    "key": "media-ai-understanding.txt",
    "last_modified": "2025-06-09T20:45:11+00:00",
    "size": 1024
  }
}'

レスポンス

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

レスポンスボディ

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

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

RAG APIで共通して使用されるレスポンスステータスコードの詳細は、RAGのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "status": {
        "code": 200,
        "message": ""
    },
    "result": {
        "inserted": [
            "12345"
        ],
        "deleted": null,
        "updated": null
    }
}