1. 接口描述
接口请求域名: es.ai.tencentcloudapi.com 。
本服务支持一系列高性能的大语言模型,包括DeepSeek以及腾讯自主研发的混元大模型,结合混合搜索等先进搜索技术,快速高效实现RAG,有效解决幻觉和知识更新问题。
本接口有单账号调用上限控制,如您有提高并发限制的需求请联系我们 。
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ChatCompletions。 |
| Version | 是 | String | 公共参数,本接口取值:2025-01-01。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Messages.N | 是 | Array of Message | 会话内容,按对话时间从旧到新在数组中排列,长度受模型窗口大小限制。 |
| ModelName | 是 | String | 模型名称,可选模型列表:hunyuan-turbo,hunyuan-large,hunyuan-large-longcontext,hunyuan-standard,hunyuan-standard-256K,deepseek-r1,deepseek-v3,deepseek-r1-distill-qwen-32b。 示例值:hunyuan-turbo |
| Stream | 否 | Boolean | 是否以流式接口的形式返回数据,默认true。 示例值:true |
| TopP | 否 | Float | 取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果 。 示例值:0.1 |
| Temperature | 否 | Float | 取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果 。 示例值:1.1 |
| OnlineSearch | 否 | Boolean | 是否开启联网搜索。默认为 false。 示例值:false |
| OnlineSearchOptions | 否 | OnlineSearchOptions | 当 OnlineSearch 为 true 时,指定的搜索引擎,默认为 bing。 |
| Tools.N | 否 | Array of Tool | 可调用的工具列表,当前支持模型:hunyuan-turbo, deepseek-v3。 |
| ToolChoice | 否 | String | 工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto 示例值:auto |
| CustomTool | 否 | Tool | 强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 此次请求的id 示例值:8f71dbaf64194da7ac3b61b145aa3534 |
| Choices | Array of Choice | 回复内容 |
| Usage | TokenUsage | token使用量 |
| OnlineSearchContent | Array of WebContent | 联网搜索结果。 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 |
4. 示例
示例1 AI 聊天问答
输入示例
POST / HTTP/1.1
Host: es.ai.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChatCompletions
<公共请求参数>
{
"Messages": [
{
"Role": "user",
"Content": "什么是大模型?"
}
],
"ModelName": "deepseek-r1",
"Stream": false,
"OnlineSearch": true,
"OnlineSearchOptions": {
"Engine": "sogou"
}
}
输出示例
{
"Response": {
"Id": "59afbba4-8b5f-47fa-972d-4bc5d77004ee",
"Usage": {
"PromptTokens": 9224,
"CompletionTokens": 203,
"TotalTokens": 9427
},
"Choices": [
{
"Message": {
"Role": "assistant",
"Content": "\n\n大模型是参数量庞大、基于深度学习的AI模型,擅长处理复杂任务如自然语言处理。",
"ReasoningContent": "\n嗯,用户让我简单描述什么是大模型,我需要先理解大模型的核心定义。根据搜索结果,大模型通常指参数规模庞大、基于深度学习的AI模型,比如GPT系列。多个网页提到参数数量达到数十亿甚至万亿,处理复杂任务能力强。例如,腾讯云和今日头条的文章都强调大模型的参数和数据处理能力。\n"
}
}
],
"RequestId": "6b5a7f7a-3e3d-4974-8480-8e21edaec5e7",
"OnlineSearchContent": [
{
"Query": "大模型 解释",
"Title": "快速了解什么是大模型 - 今日头条",
"Url": "https://m.toutiao.com/video/7340170115901932086/?upstream_biz=toutiao_pc",
"Time": "2024-02-27",
"Content": "大模型(Large Model)是AI人工智能领域中的一种重要模型,通常指的是参数量非常大、数据量也非常大的深度学习模型.大模型通常由数百万到数十亿的参数组成,需要大量的数据和计算资源进行训练和推理.",
"ChunkIndex": 0,
"Score": 0
}
]
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| UnknownParameter | 未知参数错误。 |