ナレッジベースから指定されたテキストチャンクを削除します。削除されたテキストチャンクは取得または呼び出しできません。
操作説明
警告 削除されたテキストチャンクは復元できません(ハードデリート)。慎重に操作してください。
-
権限要件:
- Resource Access Management (RAM) ユーザー: まず Model Studio の API 権限を取得し(この操作に必須の sfm:DeleteChunk 権限を含む
AliyunBailianDataFullAccessポリシーを使用できます)、この操作を呼び出す前にワークスペースに参加してください。 - Alibaba Cloud アカウント: デフォルトで権限を持ち、この操作を直接呼び出すことができます。
- Resource Access Management (RAM) ユーザー: まず Model Studio の API 権限を取得し(この操作に必須の sfm:DeleteChunk 権限を含む
-
呼び出しメソッド: 最新のModel Studio SDKを使用してください。SDK は複雑な署名計算ロジックをカプセル化し、呼び出しプロシージャを簡素化します。
-
効果の遅延: 変更は通常即座に効果を発揮します。ピーク時には、わずかな遅延(秒単位)が発生する場合があります。
-
べき等性: この操作はべき等です。既に削除されたテキストチャンクに対して繰り返し削除を呼び出しても、成功応答が返されます。
レート制限: この操作は頻繁に呼び出しされるとスロットリングされます。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:DeleteChunk | delete | *All Resource
| なし | なし |
リクエスト構文
POST /{WorkspaceId}/chunk/delete HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| WorkspaceId | string | 必須 | ナレッジベースのワークスペース ID。ワークスペース ID の取得方法については、ワークスペースの使用方法を参照してください。 | llm-3z7uw7fwz0vexxxx |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| PipelineId | string | 必須 | ナレッジベース ID。CreateIndex 操作で返される | 79c0alxxxx |
| ChunkIds | array | 必須 | 削除するテキストチャンクのリスト。1 回のリクエストで指定できるテキストチャンク ID の最大値は 10 個です。 | |
string | 必須 | テキストチャンク ID。ListChunks 操作で返される Node オブジェクトの | llm-5ip55o1zrzxx_09fe52x_xxxxx_033b551e10024029992e79767b151fxx_10024xx_0 |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | レスポンスのスキーマ。 | ||
| RequestId | string | リクエスト ID。 | 35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code | string | エラー状態コード。 | |
| Message | string | エラーメッセージ。 | |
| Success | boolean | 呼び出しが成功したかどうかを示します。有効な値:
| true |
| Data | boolean | リクエストが成功した場合に返されるビジネスデータ。 | true |
| Status | string | 操作から返される状態コード。 | 200 |
例
成功レスポンス
JSONJSON
{
"RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833\n",
"Code": "",
"Message": "",
"Success": true,
"Data": true,
"Status": "200\n"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。