すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:SubmitIndexJob

    ドキュメントセンター

    Alibaba Cloud Model Studio:SubmitIndexJob

    最終更新日:Aug 26, 2026

    指定された CreateIndex タスクを送信して、ナレッジベースの作成を完了します。

    操作説明

    • Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、まず Model Studio の API 権限を取得し（AliyunBailianDataFullAccess が必要、sfm:SubmitIndexJob 権限を含む）、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは権限付与なしでこの操作を直接呼び出せます。最新のModel Studio SDKを使用してこの操作を呼び出してください。
    • この操作を呼び出す前に、CreateIndex 操作を呼び出して、対応する IndexId を取得する必要があります。
    • この操作を呼び出した後、ノードの実行には時間がかかり、ピーク時には数時間かかる場合があります。ノードが完了する前に重複したリクエストを送信しないでください。ノードの実行ステータスを照会するには、GetIndexJobStatus 操作を呼び出してください。
    • ナレッジベースの作成後、同じワークスペース内のエージェントアプリケーションに、アプリケーション管理を通じて関連付けできます（または アプリケーション呼び出し で rag_options を通じて IndexID を渡すこともできます）。これにより、Model Studio アプリケーションに非公開のナレッジや最新の情報を補足できます。Model Studio アプリケーションを使用せず、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:SubmitIndexJob

    create

    *All Resource

    *

    		なしなし

    リクエスト構文 

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    WorkspaceId

    string

    必須

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

    llm-3shx2gu255oqxxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    IndexId

    string

    必須

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

    79c0alxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    Code

    string

    エラーコード。

    Index.InvalidParameter

    Data

    object

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

    Id

    string

    タスク ID。GetIndexJobStatus 操作を呼び出す際に必須の JobId です。

    eFDr2fGRzP9gdDZWAdo3xxxx

    IndexId

    string

    ナレッジベース ID。

    79c0alxxxx

    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: 成功。

    • false: 失敗。

    true

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明

    400RagIndex.IdempotentParameterMismatchThe 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.

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

    変更履歴

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