指定されたナレッジベースを完全に削除します。
操作説明
- Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、まず Model Studio の API 権限(sfm:DeleteIndex 権限を含む
AliyunBailianDataFullAccessが必要)を取得し、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出すことができます。最新のModel Studio SDKを使用してこの操作を呼び出してください。 - この操作を呼び出す前に、ナレッジベースが作成済みであり、削除されていないこと(つまり、ナレッジベース ID
IndexIdが有効であること)を確認してください。 - ナレッジベースがアプリケーションに関連付けられている場合、削除する前にまずアプリケーションとの関連付けを解除する必要があります。現在、この操作はコンソールからのみ実行できます。詳細については、ナレッジベースを参照してください。
- 削除は元に戻せません。削除されたナレッジベースは復元できません。慎重に操作してください。
- この操作を呼び出しても、アプリケーションデータにインポート済みのファイルは削除されません。
- この操作はべき等性を持ちます。
レート制限: この操作は、頻繁に呼び出されるとスロットリングされます。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:DeleteIndex | none | *All Resource
| なし | なし |
リクエスト構文
POST /{WorkspaceId}/index/delete HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| WorkspaceId | string | 必須 | ナレッジベースのワークスペース ID。ワークスペース ID の取得方法については、ワークスペースの使用方法を参照してください。 | llm-3z7uw7fwz0vexxxx |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| IndexId | string | 必須 | ナレッジベース ID。CreateIndex 操作によって返される | f89ie0xxxx |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | レスポンスのスキーマ。 | ||
| Code | string | エラーコード。 | Index.InvalidParameter |
| Message | string | エラーメッセージ。 | Required parameter(%s) missing or invalid, please check the request parameters. |
| RequestId | string | リクエスト ID。 | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Status | string | 操作によって返された状態コード。 | 200 |
| Success | boolean | 操作が成功したかどうかを示します。有効な値:
| true |
例
成功レスポンス
JSONJSON
{
"Code": "Index.InvalidParameter",
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "200",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。