すべてのプロダクト
Search

このプロダクト

    :DeleteIndexDocument

    ドキュメントセンター

    :DeleteIndexDocument

    最終更新日:Aug 13, 2025

    指定された非構造化ナレッジベースから 1 つ以上のドキュメントを完全に削除します。この操作は、構造化ナレッジベースからのドキュメントの削除をサポートしていません。

    操作説明

    • RAM ユーザーがこの操作を呼び出すには、Alibaba Cloud Model Studio に必要な API 権限 が必要です。 `sfm:DeleteIndexDocument` 権限を含む `AliyunBailianDataFullAccess` 権限が必要です。Alibaba Cloud アカウントは、認証なしでこの操作を呼び出すことができます。この操作を呼び出すには、最新バージョンの Alibaba Cloud Model Studio SDK を使用してください。

    • 構造化ナレッジベースからドキュメントを削除する方法の詳細については、「ナレッジベース」をご参照ください。

    • この操作を呼び出す前に、ナレッジベースが存在し、その ID（`IndexId`）が有効であることを確認してください。

    • インポート失敗（`INSERT_ERROR`）またはインポート成功（`FINISH`）のステータスのドキュメントのみを削除できます。ナレッジベース内のドキュメントのステータスを照会するには、[ListIndexDocuments] 操作を呼び出します。

    • この操作は元に戻せません。削除されたドキュメントの内容は復元できず、[Retrieve] 操作でその情報にアクセスできなくなります。注意して進めてください。

    • この操作を呼び出しても、[アプリケーションデータ] にインポートされたドキュメントは削除されません。

    • この操作は冪等です。

    速度制限： この操作は速度制限の対象となります。呼び出し頻度は 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要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sfm:DeleteIndexDocument

    delete

    *All Resource

    *

    		 なし なし

    リクエスト構文

    POST /{WorkspaceId}/index/delete_index_document HTTP/1.1

    リクエストパラメーター

    パラメーター

    タイプ

    必須 / 任意

    説明

    例
    WorkspaceId

    string

    必須

    ナレッジベースが属するワークスペースの ID。ワークスペース ID の取得方法については、「ワークスペースの使用」をご参照ください。

    llm-3z7uw7fwz0vxxxx
    IndexId

    string

    必須

    ナレッジベースの ID。これは、[CreateIndex] 操作によって返される `Data.Id` 値です。

    79c0alxxxx
    DocumentIds

    array

    必須

    ドキュメント ID のリスト。

    string

    任意

    ドキュメント ID。これは、[AddFile] 操作によって返される `FileId` 値です。[アプリケーションデータ] ページのファイル名の横にある ID アイコンをクリックして、ID を取得することもできます。

    file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。

    17204B98-xxxx-4F9A-8464-2446A84821CA
    Code

    string

    エラーコード。

    Index.InvalidParameter
    Message

    string

    エラーメッセージ。

    Required parameter(%s) missing or invalid, please check the request parameters.
    Success

    boolean

    呼び出しが成功したかどうかを示します。有効な値：

    • true: 呼び出しは成功しました。

    • false: 呼び出しは失敗しました。

    true
    Data

    object

    返されたデータ。

    DeletedDocument

    array

    削除されたドキュメントの ID のリスト。

    string

    ドキュメント ID。

    file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx
    Status

    string

    呼び出しに対して返された状態コード。

    200

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "DeletedDocument": [
      "file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx"
    ]
  },
  "Status": "200"
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。