大模型知识引擎获取特征向量-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： lke.tencentcloudapi.com 。

本接口（GetEmbedding）调用文本表示模型，将文本转化为用数值表示的向量形式，可用于文本检索、信息推荐、知识挖掘等场景。
本接口（GetEmbedding）有单账号调用上限控制，如您有提高并发限制的需求请联系我们。

默认接口请求频率限制：10次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetEmbedding。
Version	是	String	公共参数，本接口取值：2023-11-30。
Region	是	String	公共参数，详见产品支持的地域列表。
Model	是	String	模型名称示例值：lke-text-embedding-v1
Inputs.N	是	Array of String	需要 embedding 的文本, 单条文本最大长度500个字符, 总条数最大7条示例值：["hello", "world"]
Online	否	Boolean	是否在线, 后台异步任务使用离线, 实时任务使用在线, 默认值: false 示例值：false

3. 输出参数

参数名称	类型	描述
Data	Array of EmbeddingObject	特征
Usage	Usage	消耗量，返回TotalToken 示例值：{"TotalTokens":3}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取特征向量

输入示例

POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetEmbedding
<公共请求参数>

{
    "Model": "lke-text-embedding-v1",
    "Inputs": [
        "你好"
    ],
    "Online": false
}

输出示例

{
    "Response": {
        "Data": [
            {
                "Embedding": [
                    0
                ]
            }
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "Usage": {
            "TotalTokens": 3
        }
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。