ドキュメントの削除
ドキュメントの削除
ナレッジベースからドキュメントを削除する方法について説明します。
リクエストメソッド
DELETE
リクエストURL
https://api-${endpoint}.gptbots.ai/v1/bot/doc/batch/delete
リクエスト認証
認証方法の説明についてはAPI Overviewをご参照ください。
リクエスト
リクエスト例
curl -X DELETE 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/batch/delete?doc=67501ddb8cf3c334cd0e8e70,12345ddb8cf3c334cd0e0987' \
-H 'Authorization: Bearer ${API Key}'
curl -X DELETE 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/batch/delete?doc=67501ddb8cf3c334cd0e8e70,12345ddb8cf3c334cd0e0987' \
-H 'Authorization: Bearer ${API Key}'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${API Key} | 認証には Authorization: Bearer ${API Key} を使用してください。トークンはAPIキーページから取得できます。 |
リクエストボディー
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| doc | Array<String> | 必須 | 削除するドキュメントIDの一覧です。 |
レスポンス
レスポンス例
{
"code": 0,
"message": "OK"
}
{
"code": 0,
"message": "OK"
}
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Int | レスポンスコード |
| message | String | レスポンスの詳細内容 |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Int | エラーコード |
| message | String | エラーの詳細内容 |