创建模型信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:CreateModel | create | *Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId} |
| 无 |
请求语法
POST /openapi/ha3/instances/{instanceId}/models HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 ID | ha-cn-pl32rf0**** |
| dryRun | string | 否 | 是否仅执行校验，默认为 False。 | true |
| body | object | 否 | 请求体参数 | |
| name | string | 是 | 模型名称 | test |
| content | object | 否 | 模型详情 | |
| modelType | string | 否 | 模型类别
| text_embedding |
| dimension | integer | 否 | 模型的维度。类型为 text_embedding 和 image_embedding 时需要填写模型的维度。 | 128 |
| url | string | 否 | 模型服务的访问地址 | http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001 |
| method | string | 否 | 模型服务访问的 http method, 支持 PUT 和 POST | POST |
| request | object | 否 | 模型请求体 | |
| header | object | 否 | 访问模型服务的 http header | |
| Authorization | string | 否 | 认证信息，格式:Bearer access_token | Bearer OS-v0********6vvs |
| Content-Type | string | 否 | HTTP 请求内容类型。 | application/json |
| urlParams | object | 否 | url 中的参数，有限模型服务需要从 url 上传递参数。 | |
| build | object | 否 | 构建索引时传递的参数 | key: value |
| search | object | 否 | 查询时传递的参数 | key: value |
| 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}\"} |
| response | object | 否 | 如何解析结果信息，使用 json path 格式描述 | |
| embeddings | string | 否 | 如何解析结果信息，使用 json path 格式描述 | $.result.embeddings[*].embedding |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463"
}错误码
访问错误中心查看更多错误码。