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.

Rate limit: This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

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.

Action

Access level

Resource type

Condition key

Dependent action

sfm:SubmitIndexJob

create

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID to which the knowledge base belongs. For information about how to obtain the workspace ID, see How to use a workspace.	llm-3shx2gu255oqxxxx

Request parameters

Parameter	Type	Required	Description	Example
IndexId	string	Yes	The knowledge base ID, which is the `Data.Id` returned by the CreateIndex operation.	79c0alxxxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	string	The error code.	Index.InvalidParameter
Data	object	The business data returned by the operation.
Id	string	The task ID, which is the `JobId` required when calling the GetIndexJobStatus operation.	eFDr2fGRzP9gdDZWAdo3xxxx
IndexId	string	The knowledge base ID.	79c0alxxxx
Message	string	The error message.	Required parameter(%s) missing or invalid, please check the request parameters.
RequestId	string	The request ID.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	The status code returned by the operation.	200
Success	boolean	Indicates whether the operation was successful. Valid values: true: Successful. false: Failed.	true

Examples

Success response

JSON format

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

HTTP status code	Error code	Error message	Description
400	RagIndex.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.	This request uses the same client token as the previous but different request. Do not reuse client tokens with different requests unless the request is the same.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.