すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

    ドキュメントセンター

    Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

    最終更新日:Aug 26, 2026

    解析済みファイルを指定されたナレッジベースに追加します。

    操作説明

    • この操作は、データクエリまたはイメージ Q&A ナレッジベースではサポートされていません。データクエリまたはイメージ Q&A ナレッジベースを更新するフォーマットについては、ナレッジベース のナレッジベース更新手順を参照してください。
    • リソースアクセス管理 (RAM) ユーザーは、この操作を呼び出す前に、まず Model Studio の API 権限 を取得し（sfm:SubmitIndexAddDocumentsJob 権限を含む AliyunBailianDataFullAccess が必要）、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出せます。この操作を呼び出すには、最新の Model Studio SDK を使用してください。
    • この操作を呼び出す前に、ナレッジベースが作成されており、削除されていないこと（つまり、ナレッジベース ID IndexId が有効であること）を確認してください。
    • この操作を呼び出す前に、AddFile 操作を呼び出して、Model Studio に追加するファイルをアップロードしてください。
    • この操作を呼び出した後、ノードの実行には時間がかかり、ピーク時には数時間かかる場合があります。ノードが完了する前に重複したリクエストを送信しないでください。ノードの実行ステータスをクエリするには、GetIndexJobStatus 操作を呼び出してください。この操作によって返される Documents ファイルリストには、この追加タスク内のすべてのファイル（指定した job_id によって一意に識別されます）が含まれており、各ファイルが正常にインポート（解析）されたかどうかを確認できます。GetIndexJobStatus を頻繁に呼び出しすぎると、レート制限がトリガーされることに注意してください。周波数は 1 分あたり 20 回を超えないようにしてください。
    • この操作が正常に呼び出された後、実行するにはある程度の時間がかかります。応答が返される前に重複したリクエストを送信しないでください。この操作にはべき等性がありません。

    レート制限: この操作を頻繁に呼び出すと、スロットリングが発生します。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:SubmitIndexAddDocumentsJob

    create

    *すべてのリソース。

    *

    		なしなし

    リクエスト構文 

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    WorkspaceId

    string

    必須

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

    llm-3shx2gu255oqxxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    IndexId

    string

    必須

    ナレッジベースの ID。CreateIndex 操作によって返される Data.Id です。

    79c0alxxxx

    SourceType

    string

    必須

    データソースのタイプ。有効な値:

    • DATA_CENTER_CATEGORY: カテゴリタイプ。アプリケーションデータ の指定されたカテゴリ配下のすべてのドキュメントをインポートします。複数のカテゴリがサポートされています。

    • DATA_CENTER_FILE: ドキュメントタイプ。アプリケーションデータ から指定されたファイルをインポートします。複数のファイルがサポートされています。

    このパラメーターが DATA_CENTER_CATEGORY に設定されている場合、CategoryIds パラメーターを指定する必要があります。このパラメーターが DATA_CENTER_FILE に設定されている場合、DocumentIds パラメーターを指定する必要があります。

    列挙値:

    • DATA_CENTER_CATEGORY :

      カテゴリタイプ。

    • DATA_CENTER_FILE :

      ドキュメントタイプ。

    DATA_CENTER_FILE

    DocumentIds

    array

    任意

    ファイル ID のリスト。

    string

    任意

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

    doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx

    CategoryIds

    array

    任意

    カテゴリ ID のリスト。

    string

    任意

    カテゴリ ID。AddCategory 操作によって返される CategoryId です。アプリケーションデータ の [ファイル] タブで、カテゴリの横にある ID アイコンをクリックしてカテゴリ ID を取得することもできます。

    cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx

    ChunkMode

    string

    任意

    このパラメーターはまだ利用できません。このパラメーターは指定しないでください。

    length

    Separator

    string

    任意

    このパラメーターはまだ利用できません。このパラメーターは指定しないでください。

    (?<=。)

    ChunkSize

    integer

    任意

    このパラメーターはまだ利用できません。このパラメーターは指定しないでください。

    128

    OverlapSize

    integer

    任意

    このパラメーターはまだ利用できません。このパラメーターは指定しないでください。

    16

    EnableHeaders

    boolean

    任意

    Excel ファイルのヘッダー組み立てを有効にするかどうかを指定します。有効にすると、ナレッジベースはすべての xlsx および xls フォーマットの最初の行をヘッダーとして扱い、各テキストチャンク（データ行）に自動的に追加します。これにより、large 言語モデルがヘッダーを通常のデータ行として扱うことを防ぎます。

    インポートするすべてのファイルが xlsx または xls フォーマットで、ヘッダーを含んでいる場合にのみ、この特徴を有効にしてください。それ以外の場合は、無効のままにしてください。

    有効な値:

    • true: 有効。

    • false: 無効。

    デフォルト値: false。

    列挙値:

    • true :

      有効。

    • false :

      無効。

    false

    Extra

    object

    任意

    uniqueId

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエストの ID。

    778C0B3B-xxxx-5FC1-A947-36EDD13606AB

    Data

    object

    操作によって返されるビジネスデータ。

    Id

    string

    タスク ID。JobId とも呼ばれます。

    42687eb254a34802bed398357f5498ae

    Status

    string

    操作によって返される状態コード。

    200

    Success

    boolean

    操作が成功したかどうかを示します。有効な値:

    • true: 成功。

    • false: 失敗。

    true

    Message

    string

    エラーメッセージ。

    必須パラメーター (%s) が欠落しているか有効ではありません。リクエストパラメーターを確認してください。

    Code

    string

    エラーコード。

    Index.InvalidParameter

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Data": {
    "Id": "42687eb254a34802bed398357f5498ae"
  },
  "Status": "200",
  "Success": true,
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Code": "Index.InvalidParameter"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明

    400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

    変更履歴

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