帮你快速理解、总结文档立即下载

文本向量

最近更新时间:2026-11-05 02:25:19
我的收藏

1. 接口描述

接口请求域名: ocr.tencentcloudapi.com 。

本接口调用文本向量模型,将文本转换为数值表示的向量,可用于文本检索、RAG 召回、相似度计算等场景。

默认接口请求频率限制:20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:GenerateTextEmbedding。
Version 是 String 公共参数,本接口取值:2018-11-19。
Region 否 String 公共参数,此参数为可选参数。
Model 是 String

选择生成向量的模型(不同模型计费单价不同)。取值:

  • 0:text-embedding-0.6b
  • 1:text-embedding-4b

示例值:1
Inputs.N 是 Array of String

输入文本列表。单次最多 7 条,单条不超过 2000 字符。


示例值:["文本向量是什么?"]
TextType 否 String

文本向量化类型。取值:

  • query:查询文本,用于检索场景的查询侧
  • document:文档文本,用于检索场景的文档侧

默认为 document


示例值:query
Instruction 否 String

自定义任务指令词,用于指定向量化任务。最大 2000 字符。不传时按 TextType 使用系统默认指令词。


示例值:Represent the query

3. 输出参数

参数名称 类型 描述
Data Array of EmbeddingObject

向量化结果列表。顺序与输入 Inputs 列表一一对应。

InputTokens Integer

输入 Token 数。


示例值:36
TotalTokens Integer

总 Token 数。


示例值:36
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例

输入示例

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

{
    "Model": "1",
    "Inputs": [
        "文本向量是什么?"
    ],
    "TextType": "query",
    "Instruction": "Represent the query"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "Embedding": [
                    -5.9178405e-05
                ],
                "Index": 0
            }
        ],
        "InputTokens": 36,
        "TotalTokens": 36,
        "RequestId": "58ed3cc0-4977-48f3-8cb8-b241bd7e50e2"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.EngineRecognizeTimeout 引擎识别超时。
FailedOperation.UnKnowError 未知错误。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。