ファイルの置き換え

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
PUT	/api/v1/svc/{serviceId}/file/{fileId}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`serviceId`	String	Required	サービスの固有 ID
`fileId`	String	Required	ファイルの固有 ID

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

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

フィールド	タイプ	必須の有無	説明
`background`	Boolean	Optional	テキストの抽出をバックグラウンドで処理するか `true` \| `false` (デフォルト) `true`: ファイルをアップロードするとすぐにレスポンスを返し、テキストの抽出はバックグラウンドで非同期処理 `false`: テキストの抽出まで完了してからレスポンスを返す (同期処理)

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`file`	ファイル	Required	アップロードするファイル (最大1個) サポート形式画像: JPG、PNG、TIFF 文書: PDF、PPTX、DOCX、HWP、HWPX、TXT データファイル: MD、JSON、XML ファイルサイズ: 最大100MB
`document`	文書	Optional	アップロードするファイルのメタデータを含む文書文書の追加/置換と同じ形式の objectを json文字列で渡す document.bodyはファイルから抽出した文字列に置き換える参照: リクエストボディ

リクエスト例

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

curl --location --request PUT 'https://kr-pub-gateway.rag.naverncp.com/api/v1/svc/{serviceId}/file/12345?background=true' \
--header 'Authorization: Bearer {apiKey}' \
--header 'Content-Type: multipart/form-data' \
--form 'file=@"filePath"' \
--form 'document={"id":"string","orgid":"string","title":"string","file_name":"string","body":"","url":"string","created_at":"2025-07-25T06:43:53.863Z","extra":{"additionalProp1":{}}}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`status`	Object	-	API処理結果
`status.code`	Integer	-	APIレスポンスステータスコード
`status.message`	String	-	APIレスポンスステータスメッセージ
`result`	Object	-	ファイルの処理結果
`result.inserted`	Array	-	作成されたファイル ID (常に`null`)
`result.deleted`	Array	-	削除されたファイル ID (常に`null`)
`result.updated`	Array	-	変更後のファイル ID

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

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

レスポンス例

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

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