---
title: "文書の置き換え"
slug: "rag-replace-doc"
updated: 2026-09-17T09:57:17Z
published: 2026-09-17T09:57:17Z
canonical: "api.ncloud-docs.com/rag-replace-doc"
---

> ## 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.

# 文書の置き換え

VPC環境で利用できます。

アップロードされている既存の文書を新しい文書に置き換えます。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| PUT | /api/v1/svc/{serviceId}/doc/{docId} |

### リクエストヘッダ

RAG APIで共通して使用されるヘッダの詳細は、[RAGのリクエストヘッダ](/docs/ja/rag-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `serviceId` | String | Required | サービスの固有 ID |
| `docId` | String | Required | 文書の固有 ID |

### リクエストボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `orgid` | String | Optional | 原本文書の固有 ID |
| `title` | String | Optional | 文書の件名 |
| `file_name` | String | Optional | ファイル名 |
| `body` | String | Required | 文書の本文 |
| `url` | String | Optional | ウェブサイト URL |
| `created_at` | String | Optional | 作成日時 - ISO 8601形式 |
| `extra` | Object | Optional | 付加情報 - 文書の転送時、ユーザーが任意のフィールドを`extra`配下に追加可能 - `extra.bucket`、`extra.key`、`extra.last_modified`、`extra.size`、`extra.{userField}` - フィールドタイプは初回データ入力時に自動的に決定 - 文書の分類、絞り込みなどに利用 |

### リクエスト例

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

```
curl --location --request PUT '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
  }
}'
```

## レスポンス

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

### レスポンスボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `status` | Object | - | API処理結果 |
| `status.code` | Integer | - | [APIレスポンスステータスコード](/docs/ja/rag-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C) |
| `status.message` | String | - | [APIレスポンスステータスメッセージ](/docs/ja/rag-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C) |
| `result` | Object | - | 文書の処理結果 |
| `result.inserted` | Array | - | 作成されたファイル ID (常に`null`) |
| `result.deleted` | Array | - | 削除されたファイル ID (常に`null`) |
| `result.updated` | Array | - | 変更後のファイル ID |

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

RAG APIで共通して使用されるレスポンスステータスコードの詳細は、[RAGのレスポンスステータスコード](/docs/ja/rag-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

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