向量化

1. 接口描述

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

腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。向量维度为1024维。

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

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetEmbedding。
Version	是	String	公共参数，本接口取值：2023-09-01。
Region	否	String	公共参数，此参数为可选参数。
Input	否	String	输入文本。总长度不超过 1024 个 Token，超过则会截断最后面的内容。 示例值：你好
InputList.N	否	Array of String	输入文本数组。输入数组总长度不超过 200 。 示例值：["你好", "hello"]

3. 输出参数

参数名称	类型	描述
Data	Array of EmbeddingData	返回的 Embedding 信息。
Usage	EmbeddingUsage	Token 使用计数，按照总 Token 数量收费。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求成功示例

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

输入示例

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

{
    "Input": "你好"
}

输出示例

{
    "Response": {
        "RequestId": "658a95a1f824ac766d8261b0",
        "Data": [
            {
                "Embedding": [
                    0.018218994140625,
                    0.024810791015625
                ],
                "Index": 0,
                "Object": "embedding"
            }
        ],
        "Usage": {
            "PromptTokens": 3,
            "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.EngineServerError	引擎层内部错误；请稍后重试。
FailedOperation.EngineServerLimitExceeded	引擎层请求超过限额；请稍后重试。
InvalidParameterValue	参数取值错误。