ModifyModel - OpenSearch - Alibaba Cloud Documentation Center

Modifies the details and status 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

searchengine:ModifyModel

update

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

PUT /openapi/ha3/instances/{instanceId}/models/{modelName} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
modelName	string	Yes	The model name.	test
dryRun	string	No	Specifies whether to perform only a check. The default value is false.	true
body	object	No	The request body.
content	object	No	The model details.
method	string	No	The HTTP method to access the model service. Valid values are PUT and POST.	POST
modelType	string	No	The model type. Text embedding: text_embedding Text sparse embedding: text_sparse_embedding Image embedding: image_embedding Image content parsing: image_analyze	text_embedding
dimension	integer	No	The dimension of the model.	128
request	object	No	The model request body.
header	object	No	The HTTP header to access the model service.
Authorization	string	No	The authentication information. Format: Bearer access_token	Bearer OS-v0********6vvs
Content-Type	string	No	The content type of the HTTP request.	application/json
parameters	object	No	Specifies parameters that are different for the build and search phases.
build	object	No	The parameters for the index building phase.
input_type	string	No	The input type.	query
search	object	No	The parameters for the query phase.
input_type	string	No	The input type.	document
requestBody	string	No	The template string for the request body.	{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
urlParams	object	No	The parameters in the URL. Some model services require parameters to be passed in the URL.
build	object	No	The parameters for the index building phase.	key: value
search	object	No	The parameters for the query phase.	key: value
response	object	No	The JSONPath expression used to parse the result.
embeddings	string	No	The JSONPath expression used to parse the embeddings from the result.	$.result.embeddings[*].embedding
url	string	No	The endpoint of the model service.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
status	string	No	The model status. ok: The model is active. forbidden: The model is unavailable.	ok

Response elements

Element	Type	Description	Example
	object	The response schema.
requestId	string	The request ID.	D39EE0F1-D7EF-5F46-B781-6BF4185308B0

Examples

Success response

JSON format

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.