1. 接口描述
接口请求域名: hunyuan.tencentcloudapi.com 。
如需使用OpenAI兼容接口, 请参考文档:OpenAI 兼容接口
腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
- 本接口暂不支持返回图片内容。
- 默认该接口下单账号限制并发数为 5 路,如您有提高并发限制的需求请 购买 。
- 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “开发者资源 - SDK” 部分提供。
- 我们推荐您使用 API Explorer,方便快速地在线调试接口和下载各语言的示例代码,点击打开。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GroupChatCompletions。 |
Version | 是 | String | 公共参数,本接口取值:2023-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Model | 是 | String | 模型名称,可选值包括 hunyuan-large-role-group。各模型介绍请阅读 产品概述 中的说明。注意:不同的模型计费不同,请根据 购买指南 按需调用。 示例值:hunyuan-large-role-group |
Messages.N | 是 | Array of GroupMessage | 聊天上下文信息。 |
Stream | 否 | Boolean | 流式调用开关。 说明: 1. 未传值时默认为非流式调用(false)。 2. 流式调用时以 SSE 协议增量返回结果(返回值取 Choices[n].Delta 中的值,需要拼接增量数据才能获得完整结果)。 3. 非流式调用时: 调用方式与普通 HTTP 请求无异。 接口响应耗时较长,如需更低时延建议设置为 true。 只返回一次最终结果(返回值取 Choices[n].Message 中的值)。 注意: 通过 SDK 调用时,流式和非流式调用需用不同的方式获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。 示例值:false |
TargetCharacterName | 否 | String | 目标人物名称 示例值:孙悟空 |
GroupChatConfig | 否 | GroupChatConfig | 角色描述 |
UserId | 否 | String | 用户ID |
SessionId | 否 | String | 对话接口 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Created | Integer | Unix 时间戳,单位为秒。 示例值:1705634032 |
Usage | Usage | Token 统计信息。 按照总 Token 数量计费。 |
Note | String | 免责声明。 示例值:以上内容为AI生成,不代表开发者立场,请勿删除或修改本标记 |
Id | String | 本次请求的 RequestId。 示例值:9c772634-8824-43e8-bc24-8bc4c19b9151 |
Choices | Array of Choice | 回复内容。 |
ErrorMsg | ErrorMsg | 错误信息。 如果流式返回中服务处理异常,返回该错误信息。 注意:此字段可能返回 null,表示取不到有效值。 |
SearchInfo | SearchInfo | 搜索结果信息 |
Replaces | Array of Replace | 多媒体信息。 说明: 1. 可以用多媒体信息替换回复内容里的占位符,得到完整的消息。 2. 可能会出现回复内容里存在占位符,但是因为审核等原因没有返回多媒体信息。 |
RecommendedQuestions | Array of String | 推荐问答。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 |
4. 示例
示例1 调用示例
输入示例
输出示例
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.EngineRequestTimeout | 引擎层请求超时;请稍后重试。 |
FailedOperation.EngineServerError | 引擎层内部错误;请稍后重试。 |
FailedOperation.EngineServerLimitExceeded | 引擎层请求超过限额;请稍后重试。 |
FailedOperation.FreeResourcePackExhausted | 免费资源包余量已用尽,请购买资源包或开通后付费。 |
FailedOperation.ResourcePackExhausted | 资源包余量已用尽,请购买资源包或开通后付费。 |
FailedOperation.ServiceNotActivated | 服务未开通,请前往控制台申请试用。 |
FailedOperation.ServiceStop | 用户主动停服。 |
FailedOperation.ServiceStopArrears | 欠费停服。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Model | 模型不存在。 |