VPC環境で利用できます。
アップロードされている既存のファイルを削除します。指定されたファイル IDの文書と、関連するすべてのインデックス情報が削除されます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| DELETE | /api/v1/svc/{serviceId}/file/{fileId} |
リクエストヘッダ
RAG APIで共通して使用されるヘッダの詳細は、RAGのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | サービスの固有 ID |
fileId |
String | Required | ファイルの固有 ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request DELETE 'https://kr-pub-gateway.rag.naverncp.com/api/v1/svc/{serviceId}/file/12345' \
--header 'Authorization: Bearer {apiKey}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
status |
Object | - | API処理結果 |
status.code |
Integer | - | APIレスポンスステータスコード |
status.message |
String | - | APIレスポンスステータスメッセージ |
result |
Object | - | ファイルの処理結果 |
result.inserted |
Array | - | 作成されたファイル ID (常にnull) |
result.deleted |
Array | - | 削除されたファイル ID |
result.updated |
Array | - | 変更後のファイル ID (常にnull) |
レスポンスステータスコード
RAG APIで共通して使用されるレスポンスステータスコードの詳細は、RAGのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"status": {
"code": 200,
"message": ""
},
"result": {
"inserted": null,
"deleted": [
"12345"
],
"updated": null
}
}