アプリケーションデータから指定されたファイルを完全に削除します。API を介したデータテーブルの削除はサポートされていません。詳細については、以下の API ガイドをご参照ください。
操作説明
- API を介したデータテーブルの削除はサポートされていません。データテーブルまたはテーブル内の特定のデータを削除するには、アプリケーションデータに移動して操作を実行してください。
- この API はアプリケーションデータ内のファイルを削除するために使用され、すでに構築されているナレッジベースには影響しません。ナレッジベースからファイルを削除するには、DeleteIndexDocument API を呼び出してください。
- RAM ユーザーがこの API を呼び出すには、まず Alibaba Cloud Model Studio のAPI 権限 (
sfm:DeleteFile権限ポイントを含むAliyunBailianDataFullAccessが必要) を取得し、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは、権限付与なしでこの API を直接呼び出すことができます。この API の呼び出しには、最新バージョンのAlibaba Cloud Model Studio SDK を使用することを推奨します。 - この API は、ステータスが「解析失敗」(
PARSE_FAILED) または「解析成功」(PARSE_SUCCESS) のファイルのみを削除できます。 - この API はべき等です。
レート制限に関する注意:
この API を頻繁に呼び出すと、レート制限がトリガーされます。1 秒あたりのリクエスト数が 10 を超えないようにしてください。レート制限が発生した場合は、しばらく待ってからリトライしてください。
今すぐお試しください
この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。
RAM 認証
下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。
-
アクション:特定のリソースに対して実行可能な操作。ポリシー構文では
Action要素として指定します。 -
API:アクションを具体的に実行するための API。
-
アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。
-
リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
Resource要素で対応する ARN を指定してください。 - リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーの
Resource要素でアスタリスク (*) でマークされます。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
-
条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
-
依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。
アクション | アクセスレベル | リソースタイプ | 条件キー | 依存アクション |
|---|---|---|---|---|
sfm:DeleteFile | delete | *All Resource
| なし | なし |
リクエスト構文
DELETE /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| FileId | string | 必須 | ファイル ID。AddFile API によって返される | file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx |
| WorkspaceId | string | 必須 | ファイルが属するワークスペースの ID。ID の取得方法については、「ワークスペースの使用方法」をご参照ください。 | llm-3shx2gu255oxxxx |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|
リクエストパラメーターは必要ありません。
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | レスポンスのスキーマ | ||
| Code | string | エラー状態コード。 | InvalidParameter |
| Data | object | API 応答のビジネスデータフィールド。 | |
| FileId | string | ファイル ID。 | file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx |
| Message | string | エラーメッセージ。 | Current file status does not support delete. |
| RequestId | string | リクエスト ID | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Status | string | API が返す状態コード。 | 200 |
| Success | boolean | API 呼び出しが成功したかどうかを示します。有効な値:
| true |
例
成功レスポンス
JSONJSON
{
"Code": "InvalidParameter",
"Data": {
"FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx"
},
"Message": "Current file status does not support delete.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "200",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。