Track Knowledge Base Job Status in Real Time via GetIndexJobStatus - Model Studio - Alibaba Cloud - Alibaba Cloud Model Studio

Queries the current status of a specified knowledge base creation task or knowledge base document append task.

Operation description

Resource Access Management (RAM) users must first obtain API permissions for Alibaba Cloud Model Studio (AliyunBailianDataFullAccess or AliyunBailianDataReadOnlyAccess, both of which include the sfm:GetIndexJobStatus permission), and join a workspace before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest Alibaba Cloud Model Studio SDK to invoke this operation.
You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the SubmitIndexJob operation, or create a knowledge base document append task by invoking the SubmitIndexAddDocumentsJob operation. Obtain the corresponding JobId.
Invoke this operation at intervals of 5 seconds or more.
This operation supports idempotence.

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:GetIndexJobStatus

get

*All Resource

*

None

Request syntax

GET /{WorkspaceId}/index/job/status HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID. Ensure that the knowledge base you want to operate on is in this workspace. For information about how to obtain the workspace ID, see How to use a workspace.	llm-3z7uw7fwz0vexxxx

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The knowledge base job ID, which is the `Data.Id` returned by the SubmitIndexJob or SubmitIndexAddDocumentsJob operation.	20230718xxxx-146c93bf
IndexId	string	Yes	The knowledge base ID, which is the `Data.Id` returned by the CreateIndex operation.	79c0alxxxx
PageNumber	integer	No	Both the SubmitIndexJob and SubmitIndexAddDocumentsJob operations support batch file import. This operation returns the overall status of the knowledge base job (`Status`) and the import status of each file (`Document.Status`). If there are many files, use the `PageNumber` parameter for paged query. Minimum value: 1. Default value: 1.	1
pageSize	integer	No	The number of file import tasks to display per page in a paged query. No maximum limit. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	string	The error status code.	Index.Forbidden
Data	object	The data field returned by the operation.
Documents	array<object>	The list of files imported in this job.
	object	The file object.
Code	string	The error code.	Index.Document.ChunkError
DocId	string	The file ID.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
DocName	string	The file name.	XXX产品介绍
Message	string	The error message.	document parse error
Status	string	The file import status. Valid values: INSERT_ERROR: The file import failed. RUNNING: The file is being imported. DELETED: The file has been deleted. FINISH: The file was imported.	RUNNING
GmtModified	integer
JobId	string	The job ID.	66122af12a4e45ddae6bd6c84555xxxx
Status	string	The current status of the knowledge base job. Valid values: COMPLETED: Execution succeeded. FAILED: Execution failed. RUNNING: Execution in progress. PENDING: Waiting for execution. Valid values: COMPLETED : Execution succeeded. FAILED : Execution failed. RUNNING : Execution in progress. PENDING : Waiting for execution.	PENDING
Message	string	The error message.	User not authorized to operate on the specified resource.
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.Forbidden",
  "Data": {
    "Documents": [
      {
        "Code": "Index.Document.ChunkError",
        "DocId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
        "DocName": "XXX产品介绍",
        "Message": "document parse error",
        "Status": "RUNNING",
        "GmtModified": 0
      }
    ],
    "JobId": "66122af12a4e45ddae6bd6c84555xxxx",
    "Status": "PENDING"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.