SubmitIndexJob

​

Operation description

• Resource Access Management (RAM) users must first obtain API permissions for Model Studio (requires AliyunBailianDataFullAccess, which includes the sfm:SubmitIndexJob permission), and join a workspace before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest Model Studio SDK to invoke this operation.
• Before invoking this operation, you must invoke the CreateIndex operation and obtain the corresponding IndexId.
• After invoking this operation, the node requires time to execute and may take several hours during peak periods. Do not submit duplicate requests before the node completes. To query the node execution status, invoke the GetIndexJobStatus operation.
• After the knowledge base is created, you can associate it with an agent application in the same workspace through Application Management (or pass the IndexID through rag_options in Application Calls) to supplement your Model Studio application with private knowledge and up-to-date information. You can also choose not to use a Model Studio application and directly query the knowledge base by invoking the Retrieve operation.
• This operation does not support idempotence.

​

Try it now

​

RAM authorization

• Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
• API: The API that you can call to perform the action.
• Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
• Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
  • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
  • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
• Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
• Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

​

Request syntax

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

​

Path Parameters

​

Request parameters

​

Response elements

​

Examples

{
  "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
}

​

Error codes

​

Release notes