调用ModifyModel API修改模型详情和状态-智能开放搜索 OpenSearch-阿里云

修改模型详情，修改模型状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

searchengine:ModifyModel

update

*Instance

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

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-pl32rf0****
modelName	string	是	模型名称	test
dryRun	string	否	是否仅执行校验，默认为 False。	true
body	object	否	请求体参数
content	object	否	模型详情
method	string	否	模型服务访问的 http method, 支持 PUT 和 POST	POST
modelType	string	否	模型类别 a. 文本向量化：text_embedding b. 文本稀疏向量化：text_sparse_embedding c. 图片向量化：image_embedding d. 图片内容解析：image_analyze	text_embedding
dimension	integer	否	模型的维度	128
request	object	否	模型请求体
header	object	否	访问模型服务的 http header
Authorization	string	否	认证信息，格式:Bearer access_token	Bearer OS-v0********6vvs
Content-Type	string	否	HTTP 请求内容类型。	application/json
parameters	object	否	如果 body 中的参数需要区分 build 和 search 阶段，可以定义在这个参数中。
build	object	否	索引构建阶段的参数
input_type	string	否	输入类型	query
search	object	否	查询阶段的参数
input_type	string	否	输入类型	document
requestBody	string	否	请求 Body 体的模板字符串	{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
urlParams	object	否	url 中的参数，有限模型服务需要从 url 上传递参数。
build	object	否	索引构建阶段的参数	key: value
search	object	否	查询阶段的参数	key: value
response	object	否	如何解析结果信息，使用 json path 格式描述
embeddings	string	否	如何解析结果信息，使用 json path 格式描述	$.result.embeddings[*].embedding
url	string	否	模型服务的访问地址	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
status	string	否	模型状态。 ok: 模型可用 forbidden: 模型不可用	ok

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	D39EE0F1-D7EF-5F46-B781-6BF4185308B0

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。