Call UpdateModel API to Modify Model Settings - Platform For AI

Updates the basic configuration of a model.

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

paimodel:UpdateModel

update

*All Resource

*

None

Request syntax

PUT /api/v1/models/{ModelId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ModelId	string	Yes	The model ID. For more information about how to obtain the model ID, see ListModels.	model-rbvg5wz******ks92

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
ModelName	string	No	The name of the model. The name must be 1 to 127 characters in length.	新闻分类
ModelDescription	string	No	The model description.	新闻分类。
Accessibility	string	No	The visibility of the model in the workspace. Valid values: PRIVATE: The model is visible only to you and administrators in the workspace. PUBLIC: The model is visible to everyone in the workspace.	PUBLIC
Origin	string	No	The source of the model. This parameter describes the community or organization to which the source model belongs, such as ModelScope and HuggingFace.	ModelScope
Domain	string	No	The domain of the model. This parameter specifies the field where the model is applied. Examples: nlp (natural language processing) and cv (computer vision).	nlp
Task	string	No	The task of the model. This parameter describes the specific problem that the model solves. For example, text-classification.	text-classification
ModelDoc	string	No	The model document.	https://*.md
OrderNumber	integer	No	The ordinal number of the model. You can use this parameter for custom sorting.	0
ModelType	string	No	The model type, such as Checkpoint or LoRA.	Checkpoint
ExtraInfo	object	No	Other information about the model.	{ "RatingCount": 2866, "Rating": 4.94, "FavoriteCount": 34992, "CommentCount": 754, "CoverUris": ["https://e*u.oss-cn-hangzhou.aliyuncs.com/drea*w.png"], "TippedAmountCount": 32, "DownloadCount": 606056 }
ParameterSize	integer	No	The number of parameters, in millions.	3000

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	A0F049F0-8D69-5BAC-8F10-B******A34C

Examples

Success response

JSON format

{
  "RequestId": "A0F049F0-8D69-5BAC-8F10-B******A34C"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.