1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
ES集群安装模型接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：InstallInstanceModel。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：es-xxxxxxxx |
| UsrCosModelUrlList.N | 否 | Array of String | 客户上传到cos的模型地址，单次请求限制一个。cos文件为压缩文件，格式包括：zip、tgz和tar.gz 示例值：["https://***.myqcloud.com/**.zip"] |
| ModelNames.N | 否 | Array of String | 客户指定安装的模型名称，可为空，默认为模型文件名 示例值：["test1"] |
| TaskTypes.N | 否 | Array of String | 模型使用的任务类型，包括：fill_mask, ner, question_answering, text_classification, text_embedding, text_expansion, text_similarity和zero_shot_classification，默认为text_embedding 示例值：["text_embedding"] |
| HuggingFaceModelNames.N | 否 | Array of String | HuggingFace模型名称 示例值：["BAAI/bge-base-zh-v1.5"] |
| ModelDescription | 否 | String | 模型描述 示例值：bge-v2-m3 |
| ModelSourceType | 否 | String | 模型来源：UserModel、HuggingFace和PlatformModel 示例值：PlatformModel |
| UploadedCosPaths.N | 否 | Array of String | 已上传的模型路径 示例值：["/UserModels/common/bge-reranker-v2-m3.tar.gz"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | String | 发起异步流程的flowId 示例值：1725 |
| ErrMsg | String | 调用接口的错误信息 示例值：The license of basic is basic. Don't supported to install model. |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 模型安装接口调用样例
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InstallInstanceModel
<公共请求参数>
{
"InstanceId": "es-ria27gbk",
"ModelNames": [
"bge-base-zh-v1.5"
],
"TaskTypes": [
"text_embedding"
],
"ModelDescription": "test model",
"ModelSourceType": "PlatformModel",
"UploadedCosPaths": [
"/UserModels/common/bge-base-zh-v1.5.tar.gz"
]
}输出示例
{
"Response": {
"FlowId": "4294967526",
"RequestId": "efbad3b5-5548-47bb-a88a-173adf833c26"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId，没有找到对应资源。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
| UnsupportedOperation.StatusNotNormal | 不支持该操作，当前实例运行状态不为正常。 |
