SubmitAuditNote

Model Studio provides the same feature as the Intelligent Proofreading module in Alibaba Cloud public cloud: uploading a custom rule library. Due to authentication restrictions, you must pass the file key (FileKey) of your custom rule library file as an input parameter to successfully call this API. After you call this API, Model Studio processes your custom rule library and returns a structured result in XLSX format. You can call GetAuditNoteProcessingStatus to check the processing status or call DownloadAuditNote to download the processed rule library. This API is under active development and will eventually accept a publicly accessible file URL instead of a FileKey.

Operation description

All Model Studio products support iframe embedding. For details, see Customer Integration: Model Studio Public Cloud iFrame Customization Guide.

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.

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
aimiaobi:SubmitAuditNote	none	*All Resource *	None	None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Unique identifier of your Model Studio workspace. To get this ID, see Get the Workspace ID.	llm-xx
FileKey	string	Yes	The FileKey of your rule library file stored in Alibaba Cloud OSS. For how to generate a FileKey, see Common APIs: GenerateUploadConfig for File Upload and Download. Your rule library file must be in DOCX, XLSX, or PDF format. If you use XLSX, it must have exactly two columns. The table header must be "Proofreading Basis" and "Source". XLSX files give the best parsing results. DOCX and PDF files are also parsed automatically.	oss://default/your/file/key
NoteId	string	No	ID of the rule library. If you omit this parameter, the system uses Default.	note_id_unique

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	ID of the request	F2F366D6-E9FE-1006-BB70-2C650896AAB5
Success	boolean	Indicates whether the request succeeded	true
Code	string	Status code	DataNotExists
Message	string	Error message	success
HttpStatusCode	integer	HTTP status code	200
Data	string	Task ID of this rule library submission. Use this ID in later API calls.	xxx_Default_89123748917

Examples

Success response

JSON format

{
  "RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
  "Success": true,
  "Code": "DataNotExists",
  "Message": "success",
  "HttpStatusCode": 200,
  "Data": "xxx_Default_89123748917"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.