VPC環境で利用できます。
文書 IDを指定してインデックスシステムにファイルをアップロードします。システムが自動作成する IDの代わりに、ユーザーが希望する IDで文書を作成することができます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /api/v1/svc/{serviceId}/file/{fileId} |
リクエストヘッダ
RAG APIで共通して使用されるヘッダの詳細は、RAGのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
serviceId |
String | Required | サービスの固有 ID |
fileId |
String | Required | ファイルの固有 ID
|
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
background |
Boolean | Optional | テキストの抽出をバックグラウンドで処理するかどうか
|
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
file |
ファイル | Required | アップロードするファイル (最大1個)
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST '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"'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
status |
Object | - | API処理結果 |
status.code |
Integer | - | APIレスポンスステータスコード |
status.message |
String | - | APIレスポンスステータスメッセージ |
result |
Object | - | ファイルの処理結果 |
result.inserted |
Array | - | 作成されたファイル ID |
result.deleted |
Array | - | 削除されたファイル ID (常にnull ) |
result.updated |
Array | - | 変更後のファイル ID (常にnull ) |
レスポンスステータスコード
RAG APIで共通して使用されるレスポンスステータスコードの詳細は、RAGのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"status": {
"code": 200,
"message": ""
},
"result": {
"inserted": [
"12345"
],
"deleted": null,
"updated": null
}
}