数据结构

最近更新时间:2025-05-14 01:36:28

我的收藏

Approximate

用户位置信息

被如下接口引用:ChatCompletions。

名称 类型 必选 描述
Country String 表示 ISO 国家代码
示例值:CN
City String 表示城市名称
示例值:深圳
Region String 表示区域名称
示例值:南山区
Timezone String 表示IANA时区
示例值:Asia/Shanghai
Address String 表示详细地址
示例值:深圳市南山区海天二路33号腾讯滨海大厦

Character

人物描述

被如下接口引用:GroupChatCompletions。

名称 类型 必选 描述
Name String 人物名称
示例值:孙悟空
SystemPrompt String 人物对应SystemPrompt
示例值:你是《七龙珠》中的角色孙悟空,你将与{usernames}等多人展开对话。

Choice

返回的回复, 支持多个

被如下接口引用:ChatCompletions, GroupChatCompletions, ImageQuestion。

名称 类型 描述
FinishReason String 结束标志位,可能为 stop、 sensitive或者tool_calls。
stop 表示输出正常结束。
sensitive 只在开启流式输出审核时会出现,表示安全审核未通过。
tool_calls 标识函数调用。
示例值:stop
Delta Delta 增量返回值,流式调用时使用该字段。
注意:此字段可能返回 null,表示取不到有效值。
Message Message 返回值,非流式调用时使用该字段。
注意:此字段可能返回 null,表示取不到有效值。
Index Integer 索引值,流式调用时使用该字段。
示例值:0
ModerationLevel String 多轮会话风险审核,值为1时,表明存在信息安全风险,建议终止客户多轮会话。
示例值:1

Content

可以传入多种类型的内容,如图片或文本。

被如下接口引用:ChatCompletions, GroupChatCompletions, ImageQuestion。

名称 类型 必选 描述
Type String 内容类型
注意:
需包含至少一个 Type 为"text"的参数及至少一个 Type 为"image_url"的参数。
参数值可选范围:[text", "image_url"]
注意:此字段可能返回 null,表示取不到有效值。
示例值:text
Text String 当 Type 为 text 时使用,表示具体的文本内容。当 Type 为 image_url 时,当前字段内容需保持为空,传递内容不生效。
注意:此字段可能返回 null,表示取不到有效值。
示例值:下面图片中是哪个公司的 Logo?
ImageUrl ImageUrl 图片的url,当 Type 为 image_url 时使用,表示具体的图片内容
如"https://example.com/1.png" 或 图片的base64(注意 "data:image/jpeg;base64," 为必要部分):"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA......"。当 Type 为 text 时,当前字段内容需保持为空,传递内容不生效。
注意:此字段可能返回 null,表示取不到有效值。

Delta

返回的内容(流式返回)

被如下接口引用:ChatCompletions, GroupChatCompletions, ImageQuestion。

名称 类型 描述
Role String 角色名称。
示例值:assistant
Content String 内容详情。
示例值:你好!请问有什么我可以帮助你的吗?
ToolCalls Array of ToolCall 模型生成的工具调用,仅 hunyuan-functioncall 模型支持
说明:
对于每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并。

注意:此字段可能返回 null,表示取不到有效值。
ReasoningContent String 思维链内容。用于展示模型思考过程,仅 Hunyuan-T1 系列模型可用。注意:在进行多轮对话时,请不要将此字段拼接到 messages 中。请求 messages 的请求参数中包含 reasoning_content,接口将报错。
示例值:你好!

EmbeddingData

Embedding 信息。

被如下接口引用:GetEmbedding。

名称 类型 描述
Embedding Array of Float Embedding 信息,目前为 1024 维浮点数。
注意:此字段可能返回 null,表示取不到有效值。
Index Integer 下标,目前不支持批量,因此固定为 0。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Object String 目前固定为 "embedding"。
注意:此字段可能返回 null,表示取不到有效值。
示例值:embedding

EmbeddingUsage

Token 使用计数。

被如下接口引用:GetEmbedding。

名称 类型 描述
PromptTokens Integer 输入 Token 数。
示例值:8
TotalTokens Integer 总 Token 数。
示例值:8

ErrorMsg

运行时异常信息。

被如下接口引用:ChatCompletions, ChatTranslations, GroupChatCompletions, ImageQuestion。

名称 类型 描述
Msg String 错误提示信息。
Code Integer 错误码。
4000 服务内部异常。
4001 请求模型超时。

File3D

3D文件

被如下接口引用:QueryHunyuanTo3DJob。

名称 类型 必选 描述
Type String 3D文件的格式。取值范围:GIF, OBJ
示例值:GIF
Url String 文件的Url(有效期24小时)
示例值:https://xxx.gif

File3Ds

3D文件列表

被如下接口引用:QueryHunyuanTo3DJob。

名称 类型 必选 描述
File3D Array of File3D 3D文件列表

FileObject

已上传的文件对象。

被如下接口引用:FilesList。

名称 类型 必选 描述
ID String 文件标识符,可在各个API中引用。
示例值:file-YbhlphnNEsjRoKTEXukAqNZZ
Object String 对象类型,始终为 file。
示例值:file
Bytes Integer 文件大小,单位为字节。
示例值:15877
CreatedAt Integer 文件创建时的 Unix 时间戳(秒)。
示例值:1722325693
Filename String 文件名。
示例值:test.docx
Purpose String 上传文件的用途。
示例值:file-extract

GroupChatConfig

群聊配置

被如下接口引用:GroupChatCompletions。

名称 类型 必选 描述
UserName String 人物名称
示例值:布尔玛
Description String ### 主题:\n武道修炼与科技创新的碰撞\n\n### 地点:\n布尔玛的实验室\n\n### 故事背景:\n布尔玛正在研发一种新型的龙珠雷达,旨在更精确地定位龙珠的位置。她邀请了孙悟空、天津饭、饺子和雅木茶前来测试新设备。然而,这些武道家们对科技的理解有限,导致了一系列有趣的误解和互动。\n\n### 人物关系:\n- 布尔玛:天才科学家,负责研发和解释新设备。\n- 孙悟空:纯粹的战斗狂,对科技一窍不通,但对新事物充满好奇。\n- 天津饭:严肃自律的武道家,对科技持谨慎态度,但愿意尝试。\n- 饺子:内向单纯,依赖天津饭,对科技感到困惑和害怕。\n- 雅木茶:幽默自嘲的前沙漠强盗,对科技有一定了解,但更倾向于轻松调侃。\n\n### 人物目标:\n- 布尔玛:希望新龙珠雷达能够得到有效测试,并得到反馈以改进。\n- 孙悟空:希望通过新设备找到更强的对手进行战斗。\n- 天津饭:希望通过测试新设备提升自己的武道修炼。\n- 饺子:希望在不引起麻烦的情况下完成任务,并得到天津饭的认可。\n- 雅木茶:希望通过参与测试证明自己的价值,同时享受与朋友们的互动。\n\n### 场景描述:\n布尔玛在实验室中展示她的新龙珠雷达,解释其工作原理和优势。孙悟空对设备的功能感到兴奋,但完全无法理解技术细节,不断提出天真的问题。天津饭则严肃地询问设备的安全性和可靠性,表现出对科技的谨慎态度。饺子对复杂的设备感到害怕,不断向天津饭寻求确认和安慰。雅木茶则在一旁调侃大家的反应,试图缓解紧张气氛。布尔玛在解释过程中不断被孙悟空的问题打断,感到无奈,但也被他的热情所感染。最终,大家决定一起外出测试新设备,展开一场充满欢笑和冒险的旅程。
示例值:描述
Characters Array of Character 角色描述
示例值:角色描述

GroupMessage

群聊会话内容

被如下接口引用:GroupChatCompletions。

名称 类型 必选 描述
Role String 角色,可选值包括 system、user、assistant、 tool。
示例值:user
Content String 文本内容
示例值:本小姐可是天才科学家!都来看看我的新发明!
Name String 角色名称
示例值:布尔玛

History

混元生图多轮对话历史记录。

被如下接口引用:QueryHunyuanImageChatJob。

名称 类型 必选 描述
ChatId String 对话的 ID,用于唯一标识一轮对话
注意:此字段可能返回 null,表示取不到有效值。
示例值:1248907282106990592
Prompt String 原始输入的 Prompt 文本
注意:此字段可能返回 null,表示取不到有效值。
示例值:请画一个苹果在桌子上
RevisedPrompt String 扩写后的 Prompt 文本
注意:此字段可能返回 null,表示取不到有效值。
示例值:风格为摄影风格,桌子上摆放着一个红润的苹果,镜头为近景镜头
Seed Integer 生成图的随机种子
注意:此字段可能返回 null,表示取不到有效值。
示例值:1549130027

Image

图片信息

被如下接口引用:SubmitHunyuanImageJob。

名称 类型 必选 描述
ImageUrl String 图片Url。
示例值:https://xxx.com/image.jpg
ImageBase64 String 图片Base64。
示例值:/9j/4QlQaHR0c...N6a2M5ZCI

ImageMessage

拍照解题内容

被如下接口引用:ImageQuestion。

名称 类型 必选 描述
Role String 角色,可选值包括 system、user、assistant。
示例值:user
Content String 文本内容
示例值:你好!
Contents Array of Content 多种类型内容(目前支持图片和文本),仅 hunyuan-vision 和 hunyuan-turbo-vision 模型支持

ImageUrl

具体的图片内容

被如下接口引用:ChatCompletions, GroupChatCompletions, ImageQuestion。

名称 类型 必选 描述
Url String 图片的 Url(以 http:// 或 https:// 开头)
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://cloudcache.tencent-cloud.com/qcloud/ui/portal-set/build/About/images/bg-product-series_87d.png

Knowledge

外部知识

被如下接口引用:ChatCompletions。

名称 类型 必选 描述
Text String 表示具体的知识信息文本
示例值:暴雨+雷暴+8级大风!深圳将迎强对流天气!

LogoParam

logo参数

被如下接口引用:SubmitHunyuanImageChatJob, SubmitHunyuanImageJob, TextToImageLite。

名称 类型 必选 描述
LogoUrl String 水印url
示例值:https://xxx.com/logo.jpg
LogoImage String 水印base64,url和base64二选一传入
示例值:9j/4QlQaHR0c...N6a2M5ZCI
LogoRect LogoRect 水印图片位于融合结果图中的坐标,将按照坐标对标识图片进行位置和大小的拉伸匹配
示例值:{"X": 10, "Y": 10, "Width": 20, "Height": 20}

LogoRect

输入框

被如下接口引用:SubmitHunyuanImageChatJob, SubmitHunyuanImageJob, TextToImageLite。

名称 类型 必选 描述
X Integer 左上角X坐标
示例值:10
Y Integer 左上角Y坐标
示例值:10
Width Integer 方框宽度
示例值:20
Height Integer 方框高度
示例值:20

Message

会话内容

被如下接口引用:ChatCompletions, GroupChatCompletions, ImageQuestion。

名称 类型 必选 描述
Role String 角色,可选值包括 system、user、assistant、 tool。
示例值:user
Content String 文本内容
示例值:你好!
Contents Array of Content 多种类型内容(目前支持图片和文本),仅 hunyuan-vision 和 hunyuan-turbo-vision 模型支持
注意:此字段可能返回 null,表示取不到有效值。
ToolCallId String 当role为tool时传入,标识具体的函数调用
注意:此字段可能返回 null,表示取不到有效值。
示例值:call_cpv320k2c3m8fgcs8ja0
ToolCalls Array of ToolCall 模型生成的工具调用,仅 hunyuan-pro 或者 hunyuan-functioncall 模型支持
注意:此字段可能返回 null,表示取不到有效值。
FileIDs Array of String 文件标识符。单次最大 50 个文件。
注意:此字段可能返回 null,表示取不到有效值。
示例值:["file-YbhlphnNEsjRoKTEXukAqNZZ"]
ReasoningContent String 思维链内容。用于展示模型思考过程,仅 Hunyuan-T1 系列模型可用。注意:在进行多轮对话时,请不要将此字段拼接到 messages 中。请求 messages 的请求参数中包含 reasoning_content,接口将报错。
示例值:你好!

Mindmap

脑图

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 必选 描述
ThumbUrl String 脑图缩略图链接
注意:此字段可能返回 null,表示取不到有效值。
Url String 脑图图片链接
注意:此字段可能返回 null,表示取不到有效值。

Multimedia

多媒体详情

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 描述
Type String 多媒体类型,可选值包括 image、music、album、playlist。
说明:
1. image:图片;music:单曲,类型为单曲时,会返回详细歌手和歌曲信息;album:专辑;playlist:歌单。
2. 当 type 为 music、album、playlist 时,需要配合 QQ音乐SDK 使用。
示例值:image
Url String 多媒体地址。
说明:
1. type 为 image 时,地址为图片的预览地址;其他类型时,地址为封面图地址。
JumpUrl String 多媒体详情地址。
说明:
1. 仅 type 为 image 时,该字段有值。
注意:此字段可能返回 null,表示取不到有效值。
Title String 名称。
说明:
1. type 为 image 时,该字段为空。
注意:此字段可能返回 null,表示取不到有效值。
Desc String 描述。
注意:此字段可能返回 null,表示取不到有效值。
Singer String 歌手名称。
说明:
1. 仅 type 为 music 时,该字段有值。
注意:此字段可能返回 null,表示取不到有效值。
Ext SongExt 歌曲详情。
说明:
1. 仅 type 为 music 时,该字段有值。
注意:此字段可能返回 null,表示取不到有效值。

Reference

翻译对话参考示例

被如下接口引用:ChatTranslations。

名称 类型 必选 描述
Type String 翻译文本类型,枚举"sentence"表示句子, "term"表示术语
示例值:sentence
Text String 原文
示例值:Computer games are a perfect recipe for strengthening our cognitive skills
Translation String 译文
示例值:电脑游戏是增强我们认知能力的完美秘诀

RelevantEntity

相关组织及人物

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 必选 描述
Name String 相关组织及人物名称
注意:此字段可能返回 null,表示取不到有效值。
Content String 相关组织及人物内容
注意:此字段可能返回 null,表示取不到有效值。
Reference Array of Integer 相关事件引用文章标号
注意:此字段可能返回 null,表示取不到有效值。

RelevantEvent

相关事件

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 必选 描述
Title String 相关事件标题
注意:此字段可能返回 null,表示取不到有效值。
Content String 相关事件内容
注意:此字段可能返回 null,表示取不到有效值。
Datetime String 相关事件时间
注意:此字段可能返回 null,表示取不到有效值。
Reference Array of Integer 相关事件引用文章标号
注意:此字段可能返回 null,表示取不到有效值。

Replace

多媒体占位符替换信息

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 描述
Id String 占位符序号
示例值:0
Multimedia Array of Multimedia 多媒体详情

SearchInfo

搜索结果信息

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 必选 描述
SearchResults Array of SearchResult 搜索引文信息
注意:此字段可能返回 null,表示取不到有效值。
Mindmap Mindmap 脑图(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回)
注意:此字段可能返回 null,表示取不到有效值。
RelevantEvents Array of RelevantEvent 相关事件(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
注意:此字段可能返回 null,表示取不到有效值。
RelevantEntities Array of RelevantEntity 相关组织及人物(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
注意:此字段可能返回 null,表示取不到有效值。
Timeline Array of Timeline 时间线(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
注意:此字段可能返回 null,表示取不到有效值。
SupportDeepSearch Boolean 是否命中搜索深度模式
注意:此字段可能返回 null,表示取不到有效值。
Outline Array of String 搜索回复大纲(深度模式下返回)
注意:此字段可能返回 null,表示取不到有效值。

SearchResult

搜索引文信息

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 必选 描述
Index Integer 搜索引文序号
注意:此字段可能返回 null,表示取不到有效值。
Title String 搜索引文标题
注意:此字段可能返回 null,表示取不到有效值。
Url String 搜索引文链接
注意:此字段可能返回 null,表示取不到有效值。
Text String 搜索引文站点名
Icon String 搜索引文图标

SongExt

歌曲详情。具体含义参考 QQ音乐SDK

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 描述
SongId Integer 歌曲id
示例值:97773
SongMid String 歌曲mid
示例值:0039MnYb0qxYhV
Vip Integer 歌曲是否为vip。1:vip歌曲; 0:普通歌曲。
示例值:1

ThreadAdditionalMessage

会话额外消息

被如下接口引用:RunThread。

名称 类型 必选 描述
Role String 角色
示例值:user
Content String 内容
示例值:你好
Attachments Array of ThreadMessageAttachmentObject 附件
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"FileID":"file-tMjt0CQnvU25GwUDkih4tU4H"}]

ThreadMessage

会话消息

被如下接口引用:GetThreadMessageList。

名称 类型 描述
ID String 消息 ID
示例值:msg_pYmfqfAkOcN5bM1rjdEjbVZV
Object String 对象类型
示例值:thread.message
CreatedAt Integer 创建时间
示例值:1727269943
ThreadID String 会话 ID
示例值:thread_OteLtAcmh7prn7tb8uQ3SJzh
Status String 状态,处理中 in_progress,已完成 completed,未完成 incomplete。
示例值:completed
InCompleteDetails ThreadMessageInCompleteDetailsObject 未完成原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Reason": ""}
CompletedAt Integer 完成时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1727264847
InCompleteAt Integer 未完成时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1727264847
Role String 角色
示例值:user
Content String 内容
示例值:你好
AssistantID String 助手 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:asst_LhSU47qcQcFEItggpGEx5eh1
RunID String 运行 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:run_SR0cPyidY0vBWy7mcYN5loSR
Attachments Array of ThreadMessageAttachmentObject 附件
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"FileID":"file-tMjt0CQnvU25GwUDkih4tU4H"}]

ThreadMessageAttachmentObject

会话消息附件

被如下接口引用:GetThreadMessage, GetThreadMessageList, RunThread。

名称 类型 必选 描述
FileID String 文件 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:file-tMjt0CQnvU25GwUDkih4tU4H

ThreadMessageInCompleteDetailsObject

会话消息未完成原因

被如下接口引用:GetThreadMessage, GetThreadMessageList。

名称 类型 描述
Reason String 会话消息未完成原因

ThreadToolResources

在会话中提供给助手工具的一系列资源。不同类型的工具会有各自对应的资源。比如代码解释器需要一个文件 ID 的列表,而文件搜索工具则需要一个向量存储 ID 的列表。

被如下接口引用:CreateThread, GetThread。

名称 类型 必选 描述
CodeInterpreter Array of String 文件 ID 列表
示例值:["file-tZ0lWeNW4oNbEiMYGtOXEmEk"]
VectorStoreIDs Array of String 向量存储 ID 列表
示例值:["vs_ uf4c5hAL9GosVbmJ4jSUVivy"]

Timeline

时间线

被如下接口引用:ChatCompletions, GroupChatCompletions。

名称 类型 必选 描述
Title String 标题
注意:此字段可能返回 null,表示取不到有效值。
Datetime String 时间
注意:此字段可能返回 null,表示取不到有效值。
Url String 相关网页链接
注意:此字段可能返回 null,表示取不到有效值。

Tool

用户指定模型使用的工具

被如下接口引用:ChatCompletions, RunThread。

名称 类型 必选 描述
Type String 工具类型,当前只支持function
示例值:function
Function ToolFunction 具体要调用的function

ToolCall

模型生成的工具调用

被如下接口引用:ChatCompletions, GroupChatCompletions, ImageQuestion。

名称 类型 必选 描述
Id String 工具调用id
示例值:call_cpv320k2c3m8fgcs8ja0
Type String 工具调用类型,当前只支持function
示例值:function
Function ToolCallFunction 具体的function调用
Index Integer 索引值
示例值:0

ToolCallFunction

具体的function调用

被如下接口引用:ChatCompletions, GroupChatCompletions, ImageQuestion。

名称 类型 必选 描述
Name String function名称
示例值:get_current_weather
Arguments String function参数,一般为json字符串
示例值:{"location":["北京","深圳"],"unit":"celsius"}

ToolFunction

function定义

被如下接口引用:ChatCompletions, RunThread。

名称 类型 必选 描述
Name String function名称,只能包含a-z,A-Z,0-9,_或-
示例值:get_current_weather
Parameters String function参数,一般为json字符串
Description String function的简单描述
示例值:获取当前地点的天气

TranslationChoice

翻译接口返回的回复,支持多个

被如下接口引用:ChatTranslations。

名称 类型 描述
FinishReason String 结束标志位,可能为 stop、 sensitive。
stop 表示输出正常结束。
sensitive 只在开启流式输出审核时会出现,表示安全审核未通过。
示例值:stop
Index Integer 索引值,流式调用时使用该字段。
示例值:0
Delta TranslationDelta 增量返回值,流式调用时使用该字段。
Message TranslationMessage 返回值,非流式调用时使用该字段。

TranslationDelta

翻译接口返回的内容(流式返回)

被如下接口引用:ChatTranslations。

名称 类型 描述
Role String 角色名称。
示例值:assistant
Content String 内容详情。
示例值:你好!请问有什么我可以帮助你的吗?

TranslationMessage

翻译接口会话内容

被如下接口引用:ChatTranslations。

名称 类型 描述
Role String 角色,可选值包括 system、user、assistant、 tool。
示例值:user
Content String 文本内容
示例值:你好!

Usage

Token 数量

被如下接口引用:ChatCompletions, ChatTranslations, GroupChatCompletions, ImageQuestion。

名称 类型 描述
PromptTokens Integer 输入 Token 数量。
示例值:8
CompletionTokens Integer 输出 Token 数量。
示例值:20
TotalTokens Integer 总 Token 数量。
示例值:28

UserLocation

用户位置详细信息

被如下接口引用:ChatCompletions。

名称 类型 必选 描述
Type String 表示位置类型
示例值:approximate
Approximate Approximate 用户近似位置的详细信息

WebSearchOptions

知识注入相关的参数信息

被如下接口引用:ChatCompletions。

名称 类型 必选 描述
Knowledge Array of Knowledge 表示用户注入的知识信息
UserLocation UserLocation 用户位置详细信息

如果遇到产品相关问题,您可咨询 在线客服寻求帮助。

返回顶部