すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

    ドキュメントセンター

    Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

    最終更新日:May 20, 2026

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

    操作説明

    • この API は、データクエリまたは画像 Q&A 用のナレッジベースをサポートしていません。これらのナレッジベースを更新するには、ナレッジベース のドキュメントをご参照ください。

    • RAM ユーザー (サブアカウント) がこの API を呼び出すには、Alibaba Cloud Model Studio に必要な API 権限 (具体的には、AliyunBailianDataFullAccess ポリシーで、これには sfm:SubmitIndexAddDocumentsJob 権限が含まれます) を付与され、ワークスペースに参加している必要があります。Alibaba Cloud アカウントは、認可なしでこの API を直接呼び出せます。この API の呼び出しには、最新バージョンの Alibaba Cloud Model Studio SDK を使用することを推奨します。

    • この API を呼び出す前に、ナレッジベースが存在し、有効なナレッジベース ID (IndexId) を持っていることを確認してください。

    • この API を呼び出す前に、まず AddFile API を使用して、Alibaba Cloud Model Studio にファイルをアップロードする必要があります。

    • この API を呼び出すと、ジョブはバックグラウンドで実行され、特にピーク時には完了までに数時間かかる場合があります。ジョブが完了するまで、重複したリクエストを送信しないでください。ジョブのステータスを確認するには、GetIndexJobStatus API を呼び出します。GetIndexJobStatus API が返す Documents ファイルリストには、ジョブに含まれるすべてのファイルが含まれます。このジョブは、指定した job_id によって一意に識別されます。このリストを確認して、各ファイルが正常に取り込まれた (解析された) かどうかを確認できます。GetIndexJobStatus API を頻繁に呼び出すとレート制限の対象になります。1 分あたり 20 回を超えないでください。

    • API 呼び出しが成功した場合、ジョブが処理のために送信されたことになりますが、その処理には時間がかかります。この 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要素でアスタリスク (*) でマークされます。

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

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sfm:SubmitIndexAddDocumentsJob

    create

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorkspaceId

    string

    必須

    ナレッジベースを含むワークスペースの ID です。ID を取得するには、ワークスペースの使用方法をご参照ください。

    llm-3shx2gu255oqxxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    IndexId

    string

    必須

    ナレッジベースの ID。これは、CreateIndex API から返される 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 API から返される FileId です。また、アプリケーションデータページで、ファイル名の横にある ID アイコンをクリックして ID を取得することもできます。

    doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx
    CategoryIds

    array

    任意

    カテゴリ ID のリストです。

    string

    任意

    カテゴリ ID。これは、AddCategory API から返される CategoryId です。また、アプリケーションデータページ の [カテゴリ] タブで、カテゴリ名の横にある ID アイコンをクリックして ID を取得することもできます。

    cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx

    ChunkMode

    string

    任意

    説明

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

    length
    Separator

    string

    任意

    説明

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

    (?<=。)
    ChunkSize

    integer

    任意

    説明

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

    128
    OverlapSize

    integer

    任意

    説明

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

    16
    EnableHeaders

    boolean

    任意

    Excel ファイルのヘッダーを含めるかどうかを指定します。true に設定すると、ナレッジベースはすべての .xlsx および .xls ファイルの最初の行をヘッダーとして扱い、各テキストチャンク (データ行) の先頭に自動的に追加します。これにより、大規模言語モデル (LLM) がヘッダーを通常のデータ行として誤って解釈することを防ぎます。

    説明

    インポートするすべてのドキュメントがヘッダーを含む Excel ファイルである場合にのみ、このパラメータを有効にしてください。

    有効な値：

    • true： 有効

    • false： 無効

    デフォルト値： false

    列挙値:

    • true :

      有効

    • false :

      無効

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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

    失敗時に返されるエラーメッセージです。

    Required parameter(%s) missing or invalid, please check the request parameters.
    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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IdempotentParameterMismatch The 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.

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

    変更履歴

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