tencentcloud-sdk-nodejs 4.1.33 → 4.1.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/cat/v20180409/cat_client.js +3 -0
  3. package/es/services/hunyuan/v20230901/hunyuan_client.js +3 -0
  4. package/es/services/partners/v20180321/partners_client.js +3 -0
  5. package/es/services/wedata/v20210820/wedata_client.js +5 -2
  6. package/package.json +1 -1
  7. package/tencentcloud/common/sdk_version.d.ts +1 -1
  8. package/tencentcloud/common/sdk_version.js +1 -1
  9. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +5 -1
  10. package/tencentcloud/services/cat/v20180409/cat_client.js +6 -0
  11. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +78 -29
  12. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +6 -0
  13. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +1 -1
  14. package/tencentcloud/services/ess/v20201111/ess_client.js +1 -1
  15. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.d.ts +12 -1
  16. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.js +13 -0
  17. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +1181 -1097
  18. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +1 -0
  19. package/tencentcloud/services/partners/v20180321/partners_client.d.ts +5 -1
  20. package/tencentcloud/services/partners/v20180321/partners_client.js +6 -0
  21. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +76 -8
  22. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +1 -1
  23. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +2 -2
  24. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +1 -1
  25. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -1
  26. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  27. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +9 -10
  28. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +1 -1
  29. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +10 -1
  30. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +7 -3
  31. package/tencentcloud/services/wedata/v20210820/wedata_client.js +9 -3
  32. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +93 -40
@@ -1,367 +1,383 @@
1
1
  /**
2
- * ChatCompletions请求参数结构体
2
+ * 人物描述
3
3
  */
4
- export interface ChatCompletionsRequest {
4
+ export interface Character {
5
5
  /**
6
- * 模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-code、hunyuan-role、hunyuan-functioncall、hunyuan-vision、hunyuan-turbo、hunyuan-turbo-latest、hunyuan-turbo-20241223、hunyuan-turbo-20241120、hunyuan-large、hunyuan-large-longcontext、hunyuan-turbo-vision、hunyuan-standard-vision、hunyuan-lite-vision、hunyuan-turbos-20250226、hunyuan-turbos-latest、hunyuan-t1-20250321、hunyuan-t1-latest、hunyuan-turbos-role-plus。各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。注意:不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
6
+ * 人物名称
7
7
  */
8
- Model: string;
8
+ Name?: string;
9
9
  /**
10
- * 聊天上下文信息。
11
- 说明:
12
- 1. 长度最多为 40,按对话时间从旧到新在数组中排列。
13
- 2. Message.Role 可选值:system、user、assistant、 tool(functioncall场景)。
14
- 其中,system 角色可选,如存在则必须位于列表的最开始。user(tool) 和 assistant 需交替出现(一问一答),以 user 提问开始,user(tool)提问结束,其中tool可以连续出现多次,且 Content 不能为空。Role 的顺序示例:[system(可选) user assistant user(tool tool ...) assistant user(tool tool ...) ...]。
15
- 3. Messages 中 Content 总长度不能超过模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。
10
+ * 人物对应SystemPrompt
16
11
  */
17
- Messages: Array<Message>;
12
+ SystemPrompt?: string;
13
+ }
14
+ /**
15
+ * 翻译接口返回的回复,支持多个
16
+ */
17
+ export interface TranslationChoice {
18
18
  /**
19
- * 流式调用开关。
20
- 说明:
21
- 1. 未传值时默认为非流式调用(false)。
22
- 2. 流式调用时以 SSE 协议增量返回结果(返回值取 Choices[n].Delta 中的值,需要拼接增量数据才能获得完整结果)。
23
- 3. 非流式调用时:
24
- 调用方式与普通 HTTP 请求无异。
25
- 接口响应耗时较长,**如需更低时延建议设置为 true**。
26
- 只返回一次最终结果(返回值取 Choices[n].Message 中的值)。
27
-
28
- 注意:
29
- 通过 SDK 调用时,流式和非流式调用需用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
19
+ * 结束标志位,可能为 stop、 sensitive。
20
+ stop 表示输出正常结束。
21
+ sensitive 只在开启流式输出审核时会出现,表示安全审核未通过。
30
22
  */
31
- Stream?: boolean;
23
+ FinishReason?: string;
32
24
  /**
33
- * 流式输出审核开关。
34
- 说明:
35
- 1. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
36
- 2. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。未传值时默认为流式模式(true)。
37
- 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
38
- 4. 如果值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
39
-
40
- 注意:
41
- 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
25
+ * 索引值,流式调用时使用该字段。
42
26
  */
43
- StreamModeration?: boolean;
27
+ Index?: number;
44
28
  /**
45
- * 说明:
46
- 1. 影响输出文本的多样性。模型已有默认参数,不传值时使用各模型推荐值,不推荐用户修改。
47
- 2. 取值区间为 [0.0, 1.0]。取值越大,生成文本的多样性越强。
29
+ * 增量返回值,流式调用时使用该字段。
48
30
  */
49
- TopP?: number;
31
+ Delta?: TranslationDelta;
50
32
  /**
51
- * 说明:
52
- 1. 影响模型输出多样性,模型已有默认参数,不传值时使用各模型推荐值,不推荐用户修改。
53
- 2. 取值区间为 [0.0, 2.0]。较高的数值会使输出更加多样化和不可预测,而较低的数值会使其更加集中和确定。
33
+ * 返回值,非流式调用时使用该字段。
54
34
  */
55
- Temperature?: number;
35
+ Message?: TranslationMessage;
36
+ }
37
+ /**
38
+ * Token 数量
39
+ */
40
+ export interface Usage {
56
41
  /**
57
- * 功能增强(如搜索)开关。
58
- 说明:
59
- 1. hunyuan-lite 无功能增强(如搜索)能力,该参数对 hunyuan-lite 版本不生效。
60
- 2. 未传值时默认关闭开关。
61
- 3. 关闭时将直接由主模型生成回复内容,可以降低响应时延(对于流式输出时的首字时延尤为明显)。但在少数场景里,回复效果可能会下降。
62
- 4. 安全审核能力不属于功能增强范围,不受此字段影响。
63
- 5. 2025-04-20 00:00:00起,由默认开启状态转为默认关闭状态。
42
+ * 输入 Token 数量。
64
43
  */
65
- EnableEnhancement?: boolean;
44
+ PromptTokens?: number;
66
45
  /**
67
- * 可调用的工具列表,仅对 hunyuan-turbo、hunyuan-functioncall 模型生效。
46
+ * 输出 Token 数量。
68
47
  */
69
- Tools?: Array<Tool>;
48
+ CompletionTokens?: number;
70
49
  /**
71
- * 工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-turbo、hunyuan-functioncall 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto
50
+ * Token 数量。
72
51
  */
73
- ToolChoice?: string;
52
+ TotalTokens?: number;
53
+ }
54
+ /**
55
+ * RunThread请求参数结构体
56
+ */
57
+ export interface RunThreadRequest {
74
58
  /**
75
- * 强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填
59
+ * 会话 ID
76
60
  */
77
- CustomTool?: Tool;
61
+ ThreadID: string;
78
62
  /**
79
- * 默认是false,在值为true且命中搜索时,接口会返回SearchInfo
63
+ * 助手 ID(目前未使用,留空)
80
64
  */
81
- SearchInfo?: boolean;
65
+ AssistantID?: string;
82
66
  /**
83
- * 搜索引文角标开关。
84
- 说明:
85
- 1. 配合EnableEnhancement和SearchInfo参数使用。打开后,回答中命中搜索的结果会在片段后增加角标标志,对应SearchInfo列表中的链接。
86
- 2. false:开关关闭,true:开关打开。
87
- 3. 未传值时默认开关关闭(false)。
67
+ * 模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro、 hunyuan-code、 hunyuan-role、 hunyuan-functioncall、 hunyuan-vision、 hunyuan-turbo。各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。注意:不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
88
68
  */
89
- Citation?: boolean;
69
+ Model?: string;
90
70
  /**
91
- * 是否开启极速版搜索,默认false,不开启;在开启且命中搜索时,会启用极速版搜索,流式输出首字返回更快。
71
+ * 附加消息
92
72
  */
93
- EnableSpeedSearch?: boolean;
73
+ AdditionalMessages?: Array<ThreadAdditionalMessage>;
94
74
  /**
95
- * 多媒体开关。
96
- 详细介绍请阅读 [多媒体介绍](https://cloud.tencent.com/document/product/1729/111178) 中的说明。
97
- 说明:
98
- 1. 该参数目前仅对白名单内用户生效,如您想体验该功能请 [联系我们](https://cloud.tencent.com/act/event/Online_service)。
99
- 2. 该参数仅在功能增强(如搜索)开关开启(EnableEnhancement=true)并且极速版搜索开关关闭(EnableSpeedSearch=false)时生效。
100
- 3. hunyuan-lite 无多媒体能力,该参数对 hunyuan-lite 版本不生效。
101
- 4. 未传值时默认关闭。
102
- 5. 开启并搜索到对应的多媒体信息时,会输出对应的多媒体地址,可以定制个性化的图文消息。
75
+ * 说明:1. 影响模型输出多样性,模型已有默认参数,不传值时使用各模型推荐值,不推荐用户修改。2. 取值区间为 [0.0, 2.0]。较高的数值会使输出更加多样化和不可预测,而较低的数值会使其更加集中和确定。
103
76
  */
104
- EnableMultimedia?: boolean;
77
+ Temperature?: number;
105
78
  /**
106
- * 是否开启深度研究该问题,默认是false,在值为true且命中深度研究该问题时,会返回深度研究该问题信息。
79
+ * 说明:1. 影响输出文本的多样性。模型已有默认参数,不传值时使用各模型推荐值,不推荐用户修改。2. 取值区间为 [0.0, 1.0]。取值越大,生成文本的多样性越强。
107
80
  */
108
- EnableDeepSearch?: boolean;
81
+ TopP?: number;
109
82
  /**
110
- * 说明: 1. 确保模型的输出是可复现的。 2. 取值区间为非0正整数,最大值10000。 3. 非必要不建议使用,不合理的取值会影响效果。
83
+ * 是否流式输出,当前只允许 true
111
84
  */
112
- Seed?: number;
85
+ Stream?: boolean;
113
86
  /**
114
- * 强制搜索增强开关。
115
- 说明:
116
- 1. 未传值时默认关闭。
117
- 2. 开启后,将强制走AI搜索,当AI搜索结果为空时,由大模型回复兜底话术。
87
+ * 运行过程中可使用的 token 最大数量。
118
88
  */
119
- ForceSearchEnhancement?: boolean;
89
+ MaxPromptTokens?: number;
120
90
  /**
121
- * 自定义结束生成字符串
122
-
123
- 调用 OpenAI 的接口时,如果您指定了 `stop` 参数, 模型会停止在匹配到 `stop` 的内容之前。
124
- 在调用混元接口时,会停止在匹配到 `stop` 的内容之后。
125
-
126
- **说明:**
127
- 未来我们可能会修改此行为以便和 OpenAI 保持一致。
128
- 但是目前有使用该参数的情况下,开发者需要注意该参数是否会对应用造成影响,以及未来该行为调整时带来的影响。
91
+ * 运行过程中可使用的完成 token 的最大数量。
129
92
  */
130
- Stop?: Array<string>;
93
+ MaxCompletionTokens?: number;
131
94
  /**
132
- * 推荐问答开关。
133
- 说明:
134
- 1. 未传值时默认关闭。
135
- 2. 开启后,在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答, 最多返回3条。
95
+ * 可调用的工具列表,仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。
136
96
  */
137
- EnableRecommendedQuestions?: boolean;
97
+ Tools?: Array<Tool>;
138
98
  /**
139
- * 是否开启深度阅读,默认是false,在值为true时,会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true;2.目前暂时只支持单文档单轮的深度阅读;3.深度阅读功能的文件上传可以使用FilesUploads接口,具体参数详见FilesUploads接口文档
99
+ * 工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto
140
100
  */
141
- EnableDeepRead?: boolean;
101
+ ToolChoice?: string;
142
102
  }
143
103
  /**
144
- * 搜索引文信息
104
+ * SubmitHunyuanImageChatJob请求参数结构体
145
105
  */
146
- export interface SearchResult {
147
- /**
148
- * 搜索引文序号
149
- 注意:此字段可能返回 null,表示取不到有效值。
150
- */
151
- Index?: number;
106
+ export interface SubmitHunyuanImageChatJobRequest {
152
107
  /**
153
- * 搜索引文标题
154
- 注意:此字段可能返回 null,表示取不到有效值。
108
+ * 本轮对话的文本描述。
109
+ 提交一个任务请求对应发起一轮生图对话,每轮对话中可输入一条 Prompt,生成一张图像,支持通过多轮输入 Prompt 来不断调整图像内容。
110
+ 推荐使用中文,最多可传1024个 utf-8 字符。
111
+ 输入示例:
112
+ <li> 第一轮对话:一颗红色的苹果 </li>
113
+ <li> 第二轮对话:将苹果改为绿色 </li>
114
+ <li> 第三轮对话:苹果放在桌子上 </li>
155
115
  */
156
- Title?: string;
116
+ Prompt: string;
157
117
  /**
158
- * 搜索引文链接
159
- 注意:此字段可能返回 null,表示取不到有效值。
118
+ * 上传上一轮对话的 ChatId,本轮对话将在指定的上一轮对话结果基础上继续生成图像。
119
+ 如果不传代表新建一个对话组,重新开启一轮新的对话。
120
+ 一个对话组中,最多支持进行100轮对话。
160
121
  */
161
- Url?: string;
122
+ ChatId?: string;
162
123
  /**
163
- * 搜索引文站点名
124
+ * 为生成结果图添加显式水印标识的开关,默认为1。
125
+ 1:添加。
126
+ 0:不添加。
127
+ 其他数值:默认按1处理。
128
+ 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
164
129
  */
165
- Text?: string;
130
+ LogoAdd?: number;
166
131
  /**
167
- * 搜索引文图标
132
+ * 标识内容设置。
133
+ 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
168
134
  */
169
- Icon?: string;
135
+ LogoParam?: LogoParam;
170
136
  }
171
137
  /**
172
- * logo参数
138
+ * QueryHunyuanImageJob请求参数结构体
173
139
  */
174
- export interface LogoParam {
140
+ export interface QueryHunyuanImageJobRequest {
175
141
  /**
176
- * 水印url
142
+ * 任务 ID。
177
143
  */
178
- LogoUrl?: string;
144
+ JobId: string;
145
+ }
146
+ /**
147
+ * 3D文件
148
+ */
149
+ export interface File3D {
179
150
  /**
180
- * 水印base64,url和base64二选一传入
151
+ * 3D文件的格式。取值范围:GIF, OBJ
181
152
  */
182
- LogoImage?: string;
153
+ Type?: string;
183
154
  /**
184
- * 水印图片位于融合结果图中的坐标,将按照坐标对标识图片进行位置和大小的拉伸匹配
155
+ * 文件的Url
185
156
  */
186
- LogoRect?: LogoRect;
157
+ Url?: string;
187
158
  }
188
159
  /**
189
- * FilesUploads请求参数结构体
160
+ * QueryHunyuanImageChatJob请求参数结构体
190
161
  */
191
- export interface FilesUploadsRequest {
192
- /**
193
- * 文件名。
194
- */
195
- Name: string;
162
+ export interface QueryHunyuanImageChatJobRequest {
196
163
  /**
197
- * 文件链接。目前支持 csv, doc, docx, pdf, ppt, pptx, txt, xls, xlsx 格式,单文件大小限制为100M
164
+ * 任务 ID
198
165
  */
199
- URL: string;
166
+ JobId?: string;
200
167
  }
201
168
  /**
202
- * GetEmbedding请求参数结构体
169
+ * Embedding 信息。
203
170
  */
204
- export interface GetEmbeddingRequest {
171
+ export interface EmbeddingData {
205
172
  /**
206
- * 输入文本。总长度不超过 1024 个 Token,超过则会截断最后面的内容。
173
+ * Embedding 信息,目前为 1024 维浮点数。
174
+ 注意:此字段可能返回 null,表示取不到有效值。
207
175
  */
208
- Input?: string;
176
+ Embedding?: Array<number>;
209
177
  /**
210
- * 输入文本数组。输入数组总长度不超过 50
178
+ * 下标,目前不支持批量,因此固定为 0
179
+ 注意:此字段可能返回 null,表示取不到有效值。
211
180
  */
212
- InputList?: Array<string>;
213
- }
214
- /**
215
- * 具体的图片内容
216
- */
217
- export interface ImageUrl {
181
+ Index?: number;
218
182
  /**
219
- * 图片的 Url(以 http:// 或 https:// 开头)
183
+ * 目前固定为 "embedding"。
220
184
  注意:此字段可能返回 null,表示取不到有效值。
221
185
  */
222
- Url: string;
186
+ Object?: string;
223
187
  }
224
188
  /**
225
- * 多媒体详情
189
+ * SetPayMode返回参数结构体
226
190
  */
227
- export interface Multimedia {
228
- /**
229
- * 多媒体类型,可选值包括 image、music、album、playlist。
230
- 说明:
231
- 1. image:图片;music:单曲,类型为单曲时,会返回详细歌手和歌曲信息;album:专辑;playlist:歌单。
232
- 2. 当 type 为 music、album、playlist 时,需要配合 [QQ音乐SDK](https://developer.y.qq.com/) 使用。
233
- */
234
- Type?: string;
191
+ export interface SetPayModeResponse {
235
192
  /**
236
- * 多媒体地址。
237
- 说明:
238
- 1. type 为 image 时,地址为图片的预览地址;其他类型时,地址为封面图地址。
193
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
239
194
  */
240
- Url?: string;
195
+ RequestId?: string;
196
+ }
197
+ /**
198
+ * 翻译接口返回的内容(流式返回)
199
+ */
200
+ export interface TranslationDelta {
241
201
  /**
242
- * 多媒体详情地址。
243
- 说明:
244
- 1. 仅 type 为 image 时,该字段有值。
245
- 注意:此字段可能返回 null,表示取不到有效值。
202
+ * 角色名称。
246
203
  */
247
- JumpUrl?: string;
204
+ Role?: string;
248
205
  /**
249
- * 名称。
250
- 说明:
251
- 1. type 为 image 时,该字段为空。
252
- 注意:此字段可能返回 null,表示取不到有效值。
206
+ * 内容详情。
253
207
  */
254
- Title?: string;
208
+ Content?: string;
209
+ }
210
+ /**
211
+ * 歌曲详情。具体含义参考 [QQ音乐SDK](https://developer.y.qq.com/)
212
+ */
213
+ export interface SongExt {
255
214
  /**
256
- * 描述。
257
- 注意:此字段可能返回 null,表示取不到有效值。
215
+ * 歌曲id
258
216
  */
259
- Desc?: string;
217
+ SongId?: number;
260
218
  /**
261
- * 歌手名称。
262
- 说明:
263
- 1. 仅 type 为 music 时,该字段有值。
264
- 注意:此字段可能返回 null,表示取不到有效值。
219
+ * 歌曲mid
265
220
  */
266
- Singer?: string;
221
+ SongMid?: string;
267
222
  /**
268
- * 歌曲详情。
269
- 说明:
270
- 1. 仅 type 为 music 时,该字段有值。
271
- 注意:此字段可能返回 null,表示取不到有效值。
223
+ * 歌曲是否为vip。1:vip歌曲; 0:普通歌曲。
272
224
  */
273
- Ext?: SongExt;
225
+ Vip?: number;
274
226
  }
275
227
  /**
276
- * 人物描述
228
+ * 输入框
277
229
  */
278
- export interface Character {
230
+ export interface LogoRect {
279
231
  /**
280
- * 人物名称
232
+ * 左上角X坐标
281
233
  */
282
- Name?: string;
234
+ X?: number;
283
235
  /**
284
- * 人物对应SystemPrompt
236
+ * 左上角Y坐标
285
237
  */
286
- SystemPrompt?: string;
238
+ Y?: number;
239
+ /**
240
+ * 方框宽度
241
+ */
242
+ Width?: number;
243
+ /**
244
+ * 方框高度
245
+ */
246
+ Height?: number;
287
247
  }
288
248
  /**
289
- * ActivateService请求参数结构体
249
+ * SubmitHunyuanImageJob返回参数结构体
290
250
  */
291
- export interface ActivateServiceRequest {
251
+ export interface SubmitHunyuanImageJobResponse {
292
252
  /**
293
- * 开通之后,是否关闭后付费;默认为0,不关闭;1为关闭
253
+ * 任务 ID。
294
254
  */
295
- PayMode?: number;
255
+ JobId?: string;
256
+ /**
257
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
258
+ */
259
+ RequestId?: string;
296
260
  }
297
261
  /**
298
- * GetThread请求参数结构体
262
+ * GetThread返回参数结构体
299
263
  */
300
- export interface GetThreadRequest {
264
+ export interface GetThreadResponse {
301
265
  /**
302
266
  * 会话 ID
303
267
  */
304
- ThreadID: string;
268
+ ID?: string;
269
+ /**
270
+ * 对象类型
271
+ */
272
+ Object?: string;
273
+ /**
274
+ * 创建时间,Unix 时间戳,单位为秒。
275
+ */
276
+ CreatedAt?: number;
277
+ /**
278
+ * 提供给工具的资源列表
279
+ 注意:此字段可能返回 null,表示取不到有效值。
280
+ */
281
+ ToolResources?: ThreadToolResources;
282
+ /**
283
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
284
+ */
285
+ RequestId?: string;
305
286
  }
306
287
  /**
307
- * 可以传入多种类型的内容,如图片或文本。
288
+ * 翻译对话参考示例
308
289
  */
309
- export interface Content {
290
+ export interface Reference {
310
291
  /**
311
- * 内容类型
312
- 注意:
313
- 需包含至少一个 Type 为"text"的参数及至少一个 Type 为"image_url"的参数。
314
- 参数值可选范围:[text", "image_url"]
315
- 注意:此字段可能返回 null,表示取不到有效值。
292
+ * 翻译文本类型,枚举"sentence"表示句子, "term"表示术语
316
293
  */
317
- Type: string;
294
+ Type?: string;
318
295
  /**
319
- * 当 Type 为 text 时使用,表示具体的文本内容。当 Type 为 image_url 时,当前字段内容需保持为空,传递内容不生效。
320
- 注意:此字段可能返回 null,表示取不到有效值。
296
+ * 原文
321
297
  */
322
298
  Text?: string;
323
299
  /**
324
- * 图片的url,当 Type 为 image_url 时使用,表示具体的图片内容
325
- 如"https://example.com/1.png" 或 图片的base64(注意 "data:image/jpeg;base64," 为必要部分):"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA......"。当 Type 为 text 时,当前字段内容需保持为空,传递内容不生效。
326
- 注意:此字段可能返回 null,表示取不到有效值。
300
+ * 译文
327
301
  */
328
- ImageUrl?: ImageUrl;
302
+ Translation?: string;
329
303
  }
330
304
  /**
331
- * 翻译接口返回的回复,支持多个
305
+ * 搜索结果信息
332
306
  */
333
- export interface TranslationChoice {
307
+ export interface SearchInfo {
334
308
  /**
335
- * 结束标志位,可能为 stop、 sensitive。
336
- stop 表示输出正常结束。
337
- sensitive 只在开启流式输出审核时会出现,表示安全审核未通过。
309
+ * 搜索引文信息
310
+ 注意:此字段可能返回 null,表示取不到有效值。
338
311
  */
339
- FinishReason?: string;
312
+ SearchResults?: Array<SearchResult>;
340
313
  /**
341
- * 索引值,流式调用时使用该字段。
314
+ * 脑图(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回)
315
+ 注意:此字段可能返回 null,表示取不到有效值。
342
316
  */
343
- Index?: number;
317
+ Mindmap?: Mindmap;
344
318
  /**
345
- * 增量返回值,流式调用时使用该字段。
319
+ * 相关事件(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
320
+ 注意:此字段可能返回 null,表示取不到有效值。
346
321
  */
347
- Delta?: TranslationDelta;
322
+ RelevantEvents?: Array<RelevantEvent>;
348
323
  /**
349
- * 返回值,非流式调用时使用该字段。
324
+ * 相关组织及人物(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
325
+ 注意:此字段可能返回 null,表示取不到有效值。
350
326
  */
351
- Message?: TranslationMessage;
327
+ RelevantEntities?: Array<RelevantEntity>;
328
+ /**
329
+ * 时间线(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
330
+ 注意:此字段可能返回 null,表示取不到有效值。
331
+ */
332
+ Timeline?: Array<Timeline>;
333
+ /**
334
+ * 是否命中搜索深度模式
335
+ 注意:此字段可能返回 null,表示取不到有效值。
336
+ */
337
+ SupportDeepSearch?: boolean;
338
+ /**
339
+ * 搜索回复大纲(深度模式下返回)
340
+ 注意:此字段可能返回 null,表示取不到有效值。
341
+ */
342
+ Outline?: Array<string>;
352
343
  }
353
344
  /**
354
- * ChatTranslations返回参数结构体
345
+ * FilesDeletions请求参数结构体
355
346
  */
356
- export interface ChatTranslationsResponse {
347
+ export interface FilesDeletionsRequest {
357
348
  /**
358
- * 本次请求的 RequestId。
349
+ * 文件标识符。
359
350
  */
360
- Id?: string;
351
+ ID: string;
352
+ }
353
+ /**
354
+ * 脑图
355
+ */
356
+ export interface Mindmap {
361
357
  /**
362
- * 免责声明。
358
+ * 脑图缩略图链接
359
+ 注意:此字段可能返回 null,表示取不到有效值。
363
360
  */
364
- Note?: string;
361
+ ThumbUrl: string;
362
+ /**
363
+ * 脑图图片链接
364
+ 注意:此字段可能返回 null,表示取不到有效值。
365
+ */
366
+ Url: string;
367
+ }
368
+ /**
369
+ * RunThread返回参数结构体
370
+ */
371
+ export interface RunThreadResponse {
372
+ /**
373
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
374
+ */
375
+ RequestId?: string;
376
+ }
377
+ /**
378
+ * ChatCompletions返回参数结构体
379
+ */
380
+ export interface ChatCompletionsResponse {
365
381
  /**
366
382
  * Unix 时间戳,单位为秒。
367
383
  */
@@ -371,121 +387,87 @@ export interface ChatTranslationsResponse {
371
387
  按照总 Token 数量计费。
372
388
  */
373
389
  Usage?: Usage;
390
+ /**
391
+ * 免责声明。
392
+ */
393
+ Note?: string;
394
+ /**
395
+ * 本次请求的 RequestId。
396
+ */
397
+ Id?: string;
374
398
  /**
375
399
  * 回复内容。
376
400
  */
377
- Choices?: Array<TranslationChoice>;
401
+ Choices?: Array<Choice>;
378
402
  /**
379
403
  * 错误信息。
380
404
  如果流式返回中服务处理异常,返回该错误信息。
405
+ 注意:此字段可能返回 null,表示取不到有效值。
381
406
  */
382
407
  ErrorMsg?: ErrorMsg;
408
+ /**
409
+ * 多轮会话风险审核,值为1时,表明存在信息安全风险,建议终止客户多轮会话。
410
+ * @deprecated
411
+ */
412
+ ModerationLevel?: string;
413
+ /**
414
+ * 搜索结果信息
415
+ */
416
+ SearchInfo?: SearchInfo;
417
+ /**
418
+ * 多媒体信息。
419
+ 说明:
420
+ 1. 可以用多媒体信息替换回复内容里的占位符,得到完整的消息。
421
+ 2. 可能会出现回复内容里存在占位符,但是因为审核等原因没有返回多媒体信息。
422
+ */
423
+ Replaces?: Array<Replace>;
424
+ /**
425
+ * 推荐问答。
426
+ */
427
+ RecommendedQuestions?: Array<string>;
383
428
  /**
384
429
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
385
430
  */
386
431
  RequestId?: string;
387
432
  }
388
433
  /**
389
- * SubmitHunyuanImageJob请求参数结构体
434
+ * GetThreadMessageList请求参数结构体
390
435
  */
391
- export interface SubmitHunyuanImageJobRequest {
436
+ export interface GetThreadMessageListRequest {
392
437
  /**
393
- * 文本描述。
394
- 算法将根据输入的文本智能生成与之相关的图像。
395
- 不能为空,推荐使用中文。最多可传1024个 utf-8 字符。
438
+ * 会话 ID
396
439
  */
397
- Prompt: string;
440
+ ThreadID: string;
398
441
  /**
399
- * 反向提示词。
400
- 推荐使用中文。最多可传1024个 utf-8 字符。
442
+ * 返回的消息条数,1 - 100 条
401
443
  */
402
- NegativePrompt?: string;
403
- /**
404
- * 绘画风格。
405
- 请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格,传入风格编号。
406
- 不传默认不指定风格。
407
- */
408
- Style?: string;
409
- /**
410
- * 生成图分辨率。
411
- 支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3),不传默认使用1024:1024。
412
- 如果上传 ContentImage 参考图,分辨率仅支持:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1),不传将自动适配分辨率。如果参考图被用于做风格转换,将生成保持原图长宽比例且长边为1024的图片,指定的分辨率不生效。
413
- */
414
- Resolution?: string;
415
- /**
416
- * 图片生成数量。
417
- 支持1 ~ 4张,默认生成1张。
418
- */
419
- Num?: number;
420
- /**
421
- * 超分选项,默认不做超分,可选开启。
422
- x2:2倍超分
423
- x4:4倍超分
424
- 在 Resolution 的基础上按比例提高分辨率,例如1024:1024开启2倍超分后将得到2048:2048。
425
- */
426
- Clarity?: string;
427
- /**
428
- * 用于引导内容的参考图。
429
- 图片限制:单边分辨率小于5000,转成 Base64 字符串后小于 8MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
430
- */
431
- ContentImage?: Image;
432
- /**
433
- * prompt 扩写开关。1为开启,0为关闭,不传默认开启。
434
- 开启扩写后,将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片,返回生成图片结果时将一并返回扩写后的 prompt 文本。
435
- 如果关闭扩写,将直接使用原始输入的 prompt 生成图片。如果上传了参考图,扩写关闭不生效,将保持开启。
436
- 建议开启,在多数场景下可提升生成图片效果、丰富生成图片细节。
437
- */
438
- Revise?: number;
439
- /**
440
- * 随机种子,默认随机。
441
- 不传:随机种子生成。
442
- 正数:固定种子生成。
443
- 扩写开启时固定种子不生效,将保持随机。
444
- */
445
- Seed?: number;
446
- /**
447
- * 为生成结果图添加显式水印标识的开关,默认为1。
448
- 1:添加。
449
- 0:不添加。
450
- 其他数值:默认按1处理。
451
- 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
452
- */
453
- LogoAdd?: number;
444
+ Limit?: number;
454
445
  /**
455
- * 标识内容设置。
456
- 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
446
+ * 排序方式,按创建时间升序(asc)或降序(desc),默认为 desc
457
447
  */
458
- LogoParam?: LogoParam;
448
+ Order?: string;
459
449
  }
460
450
  /**
461
- * Token 数量
451
+ * QueryHunyuanTo3DJob请求参数结构体
462
452
  */
463
- export interface Usage {
464
- /**
465
- * 输入 Token 数量。
466
- */
467
- PromptTokens?: number;
468
- /**
469
- * 输出 Token 数量。
470
- */
471
- CompletionTokens?: number;
453
+ export interface QueryHunyuanTo3DJobRequest {
472
454
  /**
473
- * 总 Token 数量。
455
+ * 任务ID
474
456
  */
475
- TotalTokens?: number;
457
+ JobId?: string;
476
458
  }
477
459
  /**
478
- * 多媒体占位符替换信息
460
+ * GetThreadMessage请求参数结构体
479
461
  */
480
- export interface Replace {
462
+ export interface GetThreadMessageRequest {
481
463
  /**
482
- * 占位符序号
464
+ * 会话 ID
483
465
  */
484
- Id?: string;
466
+ ThreadID: string;
485
467
  /**
486
- * 多媒体详情
468
+ * 消息 ID
487
469
  */
488
- Multimedia?: Array<Multimedia>;
470
+ MessageID: string;
489
471
  }
490
472
  /**
491
473
  * SubmitHunyuanImageChatJob返回参数结构体
@@ -500,128 +482,6 @@ export interface SubmitHunyuanImageChatJobResponse {
500
482
  */
501
483
  RequestId?: string;
502
484
  }
503
- /**
504
- * SubmitHunyuanTo3DJob请求参数结构体
505
- */
506
- export interface SubmitHunyuanTo3DJobRequest {
507
- /**
508
- * 3D内容的描述,中文正向提示词。最多支持200个 utf-8 字符,ImageBase64、ImageUrl和 Prompt必填其一,且Prompt和ImageBase64/ImageUrl不能同时存在。
509
- */
510
- Prompt?: string;
511
- /**
512
- * 输入图 Base64 数据。最多支持200个 utf-8 字符,ImageBase64、ImageUrl和 Prompt必填其一,且Prompt和ImageBase64/ImageUrl不能同时存在。
513
- */
514
- ImageBase64?: string;
515
- /**
516
- * 输入图Url。最多支持200个 utf-8 字符,ImageBase64、ImageUrl和 Prompt必填其一,且Prompt和ImageBase64/ImageUrl不能同时存在。
517
- */
518
- ImageUrl?: string;
519
- /**
520
- * 生成数量。默认1,当前限制只能为1。
521
- */
522
- Num?: number;
523
- }
524
- /**
525
- * 会话消息未完成原因
526
- */
527
- export interface ThreadMessageInCompleteDetailsObject {
528
- /**
529
- * 会话消息未完成原因
530
- */
531
- Reason?: string;
532
- }
533
- /**
534
- * QueryHunyuanImageChatJob请求参数结构体
535
- */
536
- export interface QueryHunyuanImageChatJobRequest {
537
- /**
538
- * 任务 ID。
539
- */
540
- JobId?: string;
541
- }
542
- /**
543
- * RunThread请求参数结构体
544
- */
545
- export interface RunThreadRequest {
546
- /**
547
- * 会话 ID
548
- */
549
- ThreadID: string;
550
- /**
551
- * 助手 ID(目前未使用,留空)
552
- */
553
- AssistantID?: string;
554
- /**
555
- * 模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro、 hunyuan-code、 hunyuan-role、 hunyuan-functioncall、 hunyuan-vision、 hunyuan-turbo。各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。注意:不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
556
- */
557
- Model?: string;
558
- /**
559
- * 附加消息
560
- */
561
- AdditionalMessages?: Array<ThreadAdditionalMessage>;
562
- /**
563
- * 说明:1. 影响模型输出多样性,模型已有默认参数,不传值时使用各模型推荐值,不推荐用户修改。2. 取值区间为 [0.0, 2.0]。较高的数值会使输出更加多样化和不可预测,而较低的数值会使其更加集中和确定。
564
- */
565
- Temperature?: number;
566
- /**
567
- * 说明:1. 影响输出文本的多样性。模型已有默认参数,不传值时使用各模型推荐值,不推荐用户修改。2. 取值区间为 [0.0, 1.0]。取值越大,生成文本的多样性越强。
568
- */
569
- TopP?: number;
570
- /**
571
- * 是否流式输出,当前只允许 true
572
- */
573
- Stream?: boolean;
574
- /**
575
- * 运行过程中可使用的 token 最大数量。
576
- */
577
- MaxPromptTokens?: number;
578
- /**
579
- * 运行过程中可使用的完成 token 的最大数量。
580
- */
581
- MaxCompletionTokens?: number;
582
- /**
583
- * 可调用的工具列表,仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。
584
- */
585
- Tools?: Array<Tool>;
586
- /**
587
- * 工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto
588
- */
589
- ToolChoice?: string;
590
- }
591
- /**
592
- * SubmitHunyuanImageChatJob请求参数结构体
593
- */
594
- export interface SubmitHunyuanImageChatJobRequest {
595
- /**
596
- * 本轮对话的文本描述。
597
- 提交一个任务请求对应发起一轮生图对话,每轮对话中可输入一条 Prompt,生成一张图像,支持通过多轮输入 Prompt 来不断调整图像内容。
598
- 推荐使用中文,最多可传1024个 utf-8 字符。
599
- 输入示例:
600
- <li> 第一轮对话:一颗红色的苹果 </li>
601
- <li> 第二轮对话:将苹果改为绿色 </li>
602
- <li> 第三轮对话:苹果放在桌子上 </li>
603
- */
604
- Prompt: string;
605
- /**
606
- * 上传上一轮对话的 ChatId,本轮对话将在指定的上一轮对话结果基础上继续生成图像。
607
- 如果不传代表新建一个对话组,重新开启一轮新的对话。
608
- 一个对话组中,最多支持进行100轮对话。
609
- */
610
- ChatId?: string;
611
- /**
612
- * 为生成结果图添加显式水印标识的开关,默认为1。
613
- 1:添加。
614
- 0:不添加。
615
- 其他数值:默认按1处理。
616
- 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
617
- */
618
- LogoAdd?: number;
619
- /**
620
- * 标识内容设置。
621
- 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
622
- */
623
- LogoParam?: LogoParam;
624
- }
625
485
  /**
626
486
  * ChatTranslations请求参数结构体
627
487
  */
@@ -738,19 +598,6 @@ export interface GetThreadMessageResponse {
738
598
  */
739
599
  RequestId?: string;
740
600
  }
741
- /**
742
- * 图片信息
743
- */
744
- export interface Image {
745
- /**
746
- * 图片Url。
747
- */
748
- ImageUrl?: string;
749
- /**
750
- * 图片Base64。
751
- */
752
- ImageBase64?: string;
753
- }
754
601
  /**
755
602
  * 用户指定模型使用的工具
756
603
  */
@@ -765,50 +612,35 @@ export interface Tool {
765
612
  Function: ToolFunction;
766
613
  }
767
614
  /**
768
- * GetThreadMessageList请求参数结构体
615
+ * 搜索引文信息
769
616
  */
770
- export interface GetThreadMessageListRequest {
617
+ export interface SearchResult {
771
618
  /**
772
- * 会话 ID
619
+ * 搜索引文序号
620
+ 注意:此字段可能返回 null,表示取不到有效值。
773
621
  */
774
- ThreadID: string;
622
+ Index?: number;
775
623
  /**
776
- * 返回的消息条数,1 - 100 条
624
+ * 搜索引文标题
625
+ 注意:此字段可能返回 null,表示取不到有效值。
777
626
  */
778
- Limit?: number;
627
+ Title?: string;
779
628
  /**
780
- * 排序方式,按创建时间升序(asc)或降序(desc),默认为 desc
629
+ * 搜索引文链接
630
+ 注意:此字段可能返回 null,表示取不到有效值。
781
631
  */
782
- Order?: string;
783
- }
784
- /**
785
- * SubmitHunyuanTo3DJob返回参数结构体
786
- */
787
- export interface SubmitHunyuanTo3DJobResponse {
632
+ Url?: string;
788
633
  /**
789
- * 任务id
634
+ * 搜索引文站点名
790
635
  */
791
- JobId?: string;
636
+ Text?: string;
792
637
  /**
793
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
638
+ * 搜索引文图标
794
639
  */
795
- RequestId?: string;
640
+ Icon?: string;
796
641
  }
797
642
  /**
798
- * 3D文件
799
- */
800
- export interface File3D {
801
- /**
802
- * 3D文件的格式。取值范围:GIF, OBJ
803
- */
804
- Type?: string;
805
- /**
806
- * 文件的Url
807
- */
808
- Url?: string;
809
- }
810
- /**
811
- * 返回的回复, 支持多个
643
+ * 返回的回复, 支持多个
812
644
  */
813
645
  export interface Choice {
814
646
  /**
@@ -838,110 +670,67 @@ export interface Choice {
838
670
  ModerationLevel?: string;
839
671
  }
840
672
  /**
841
- * GetTokenCount返回参数结构体
673
+ * 会话消息
842
674
  */
843
- export interface GetTokenCountResponse {
844
- /**
845
- * token计数
846
- */
847
- TokenCount?: number;
848
- /**
849
- * 字符计数
850
- */
851
- CharacterCount?: number;
852
- /**
853
- * 切分后的列表
854
- */
855
- Tokens?: Array<string>;
675
+ export interface ThreadMessage {
856
676
  /**
857
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
677
+ * 消息 ID
858
678
  */
859
- RequestId?: string;
860
- }
861
- /**
862
- * QueryHunyuanImageChatJob返回参数结构体
863
- */
864
- export interface QueryHunyuanImageChatJobResponse {
679
+ ID?: string;
865
680
  /**
866
- * 当前任务状态码:
867
- 1:等待中、2:运行中、4:处理失败、5:处理完成。
681
+ * 对象类型
868
682
  */
869
- JobStatusCode?: string;
683
+ Object?: string;
870
684
  /**
871
- * 当前任务状态:排队中、处理中、处理失败或者处理完成。
872
-
685
+ * 创建时间
873
686
  */
874
- JobStatusMsg?: string;
687
+ CreatedAt?: number;
875
688
  /**
876
- * 任务处理失败错误码。
877
-
689
+ * 会话 ID
878
690
  */
879
- JobErrorCode?: string;
691
+ ThreadID?: string;
880
692
  /**
881
- * 任务处理失败错误信息。
882
-
693
+ * 状态,处理中 in_progress,已完成 completed,未完成 incomplete。
883
694
  */
884
- JobErrorMsg?: string;
695
+ Status?: string;
885
696
  /**
886
- * 本轮对话的 ChatId,ChatId 用于唯一标识一轮对话。
887
- 一个对话组中,最多支持进行100轮对话。
888
- 每轮对话数据有效期为7天,到期后 ChatId 失效,有效期内的历史对话数据可通过 History 查询,如有长期使用需求请及时保存输入输出数据。
697
+ * 未完成原因
698
+ 注意:此字段可能返回 null,表示取不到有效值。
889
699
  */
890
- ChatId?: string;
700
+ InCompleteDetails?: ThreadMessageInCompleteDetailsObject;
891
701
  /**
892
- * 生成图 URL 列表,有效期7天,请及时保存。
702
+ * 完成时间
703
+ 注意:此字段可能返回 null,表示取不到有效值。
893
704
  */
894
- ResultImage?: Array<string>;
705
+ CompletedAt?: number;
895
706
  /**
896
- * 结果 detail 数组,Success 代表成功。
897
-
707
+ * 未完成时间
708
+ 注意:此字段可能返回 null,表示取不到有效值。
898
709
  */
899
- ResultDetails?: Array<string>;
710
+ InCompleteAt?: number;
900
711
  /**
901
- * 本轮对话前置的历史对话数据(不含生成图)。
712
+ * 角色
902
713
  */
903
- History?: Array<History>;
714
+ Role?: string;
904
715
  /**
905
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
716
+ * 内容
906
717
  */
907
- RequestId?: string;
908
- }
909
- /**
910
- * Embedding 信息。
911
- */
912
- export interface EmbeddingData {
718
+ Content?: string;
913
719
  /**
914
- * Embedding 信息,目前为 1024 维浮点数。
720
+ * 助手 ID
915
721
  注意:此字段可能返回 null,表示取不到有效值。
916
722
  */
917
- Embedding?: Array<number>;
723
+ AssistantID?: string;
918
724
  /**
919
- * 下标,目前不支持批量,因此固定为 0。
725
+ * 运行 ID
920
726
  注意:此字段可能返回 null,表示取不到有效值。
921
727
  */
922
- Index?: number;
728
+ RunID?: string;
923
729
  /**
924
- * 目前固定为 "embedding"。
730
+ * 附件
925
731
  注意:此字段可能返回 null,表示取不到有效值。
926
732
  */
927
- Object?: string;
928
- }
929
- /**
930
- * 群聊会话内容
931
- */
932
- export interface GroupMessage {
933
- /**
934
- * 角色,可选值包括 system、user、assistant、 tool。
935
- */
936
- Role: string;
937
- /**
938
- * 文本内容
939
- */
940
- Content?: string;
941
- /**
942
- * 角色名称
943
- */
944
- Name?: string;
733
+ Attachments?: Array<ThreadMessageAttachmentObject>;
945
734
  }
946
735
  /**
947
736
  * GroupChatCompletions请求参数结构体
@@ -987,627 +776,876 @@ export interface GroupChatCompletionsRequest {
987
776
  SessionId?: string;
988
777
  }
989
778
  /**
990
- * 3D文件列表
779
+ * function定义
991
780
  */
992
- export interface File3Ds {
781
+ export interface ToolFunction {
993
782
  /**
994
- * 3D文件列表
783
+ * function名称,只能包含a-z,A-Z,0-9,\_或-
995
784
  */
996
- File3D?: Array<File3D>;
785
+ Name: string;
786
+ /**
787
+ * function参数,一般为json字符串
788
+ */
789
+ Parameters: string;
790
+ /**
791
+ * function的简单描述
792
+ */
793
+ Description?: string;
997
794
  }
998
795
  /**
999
- * 搜索结果信息
796
+ * ImageQuestion返回参数结构体
1000
797
  */
1001
- export interface SearchInfo {
798
+ export interface ImageQuestionResponse {
1002
799
  /**
1003
- * 搜索引文信息
1004
- 注意:此字段可能返回 null,表示取不到有效值。
800
+ * Unix 时间戳,单位为秒。
1005
801
  */
1006
- SearchResults?: Array<SearchResult>;
802
+ Created?: number;
1007
803
  /**
1008
- * 脑图(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回)
1009
- 注意:此字段可能返回 null,表示取不到有效值。
804
+ * Token 统计信息。
805
+ 按照总 Token 数量计费。
1010
806
  */
1011
- Mindmap?: Mindmap;
807
+ Usage?: Usage;
1012
808
  /**
1013
- * 相关事件(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
1014
- 注意:此字段可能返回 null,表示取不到有效值。
809
+ * 免责声明。
1015
810
  */
1016
- RelevantEvents?: Array<RelevantEvent>;
811
+ Note?: string;
1017
812
  /**
1018
- * 相关组织及人物(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
1019
- 注意:此字段可能返回 null,表示取不到有效值。
813
+ * 本次请求的 RequestId。
1020
814
  */
1021
- RelevantEntities?: Array<RelevantEntity>;
815
+ Id?: string;
1022
816
  /**
1023
- * 时间线(回复中不一定存在,流式协议中,仅在最后一条流式数据中返回,深度模式下返回)
1024
- 注意:此字段可能返回 null,表示取不到有效值。
817
+ * 回复内容。
1025
818
  */
1026
- Timeline?: Array<Timeline>;
819
+ Choices?: Array<Choice>;
1027
820
  /**
1028
- * 是否命中搜索深度模式
821
+ * 错误信息。
822
+ 如果流式返回中服务处理异常,返回该错误信息。
1029
823
  注意:此字段可能返回 null,表示取不到有效值。
1030
824
  */
1031
- SupportDeepSearch?: boolean;
825
+ ErrorMsg?: ErrorMsg;
1032
826
  /**
1033
- * 搜索回复大纲(深度模式下返回)
1034
- 注意:此字段可能返回 null,表示取不到有效值。
827
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1035
828
  */
1036
- Outline?: Array<string>;
829
+ RequestId?: string;
1037
830
  }
1038
831
  /**
1039
- * 返回的内容(流式返回)
832
+ * 拍照解题内容
1040
833
  */
1041
- export interface Delta {
834
+ export interface ImageMessage {
1042
835
  /**
1043
- * 角色名称。
836
+ * 角色,可选值包括 system、user、assistant。
1044
837
  */
1045
- Role?: string;
838
+ Role: string;
1046
839
  /**
1047
- * 内容详情。
840
+ * 文本内容
1048
841
  */
1049
842
  Content?: string;
1050
843
  /**
1051
- * 模型生成的工具调用,仅 hunyuan-functioncall 模型支持
1052
- 说明:
1053
- 对于每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并。
1054
-
1055
- 注意:此字段可能返回 null,表示取不到有效值。
1056
- */
1057
- ToolCalls?: Array<ToolCall>;
1058
- }
1059
- /**
1060
- * SetPayMode返回参数结构体
1061
- */
1062
- export interface SetPayModeResponse {
1063
- /**
1064
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
844
+ * 多种类型内容(目前支持图片和文本),仅 hunyuan-vision 和 hunyuan-turbo-vision 模型支持
1065
845
  */
1066
- RequestId?: string;
846
+ Contents?: Array<Content>;
1067
847
  }
1068
848
  /**
1069
- * QueryHunyuanTo3DJob请求参数结构体
849
+ * SetPayMode请求参数结构体
1070
850
  */
1071
- export interface QueryHunyuanTo3DJobRequest {
851
+ export interface SetPayModeRequest {
1072
852
  /**
1073
- * 任务ID
853
+ * 设置后付费状态,0:后付费打开;1:后付费关闭
1074
854
  */
1075
- JobId?: string;
855
+ PayMode: number;
1076
856
  }
1077
857
  /**
1078
- * 歌曲详情。具体含义参考 [QQ音乐SDK](https://developer.y.qq.com/)
858
+ * 群聊会话内容
1079
859
  */
1080
- export interface SongExt {
860
+ export interface GroupMessage {
1081
861
  /**
1082
- * 歌曲id
862
+ * 角色,可选值包括 system、user、assistant、 tool。
1083
863
  */
1084
- SongId?: number;
864
+ Role: string;
1085
865
  /**
1086
- * 歌曲mid
866
+ * 文本内容
1087
867
  */
1088
- SongMid?: string;
868
+ Content?: string;
1089
869
  /**
1090
- * 歌曲是否为vip。1:vip歌曲; 0:普通歌曲。
870
+ * 角色名称
1091
871
  */
1092
- Vip?: number;
872
+ Name?: string;
1093
873
  }
1094
874
  /**
1095
- * 翻译接口返回的内容(流式返回)
875
+ * 相关事件
1096
876
  */
1097
- export interface TranslationDelta {
877
+ export interface RelevantEvent {
1098
878
  /**
1099
- * 角色名称。
879
+ * 相关事件标题
880
+ 注意:此字段可能返回 null,表示取不到有效值。
1100
881
  */
1101
- Role?: string;
882
+ Title: string;
1102
883
  /**
1103
- * 内容详情。
884
+ * 相关事件内容
885
+ 注意:此字段可能返回 null,表示取不到有效值。
1104
886
  */
1105
- Content?: string;
887
+ Content: string;
888
+ /**
889
+ * 相关事件时间
890
+ 注意:此字段可能返回 null,表示取不到有效值。
891
+ */
892
+ Datetime: string;
893
+ /**
894
+ * 相关事件引用文章标号
895
+ 注意:此字段可能返回 null,表示取不到有效值。
896
+ */
897
+ Reference: Array<number | bigint>;
1106
898
  }
1107
899
  /**
1108
- * 模型生成的工具调用
900
+ * FilesDeletions返回参数结构体
1109
901
  */
1110
- export interface ToolCall {
902
+ export interface FilesDeletionsResponse {
1111
903
  /**
1112
- * 工具调用id
904
+ * 文件标识符。
1113
905
  */
1114
- Id: string;
906
+ ID?: string;
1115
907
  /**
1116
- * 工具调用类型,当前只支持function
908
+ * 对象类型,始终为 file。
1117
909
  */
1118
- Type: string;
910
+ Object?: string;
1119
911
  /**
1120
- * 具体的function调用
912
+ * 是否删除成功。
1121
913
  */
1122
- Function: ToolCallFunction;
914
+ Deleted?: boolean;
1123
915
  /**
1124
- * 索引值
916
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1125
917
  */
1126
- Index?: number;
918
+ RequestId?: string;
1127
919
  }
1128
920
  /**
1129
- * 会话额外消息
921
+ * 已上传的文件对象。
1130
922
  */
1131
- export interface ThreadAdditionalMessage {
923
+ export interface FileObject {
1132
924
  /**
1133
- * 角色
925
+ * 文件标识符,可在各个API中引用。
1134
926
  */
1135
- Role?: string;
927
+ ID?: string;
1136
928
  /**
1137
- * 内容
929
+ * 对象类型,始终为 file。
1138
930
  */
1139
- Content?: string;
931
+ Object?: string;
1140
932
  /**
1141
- * 附件
1142
- 注意:此字段可能返回 null,表示取不到有效值。
933
+ * 文件大小,单位为字节。
1143
934
  */
1144
- Attachments?: Array<ThreadMessageAttachmentObject>;
1145
- }
1146
- /**
1147
- * function定义
1148
- */
1149
- export interface ToolFunction {
935
+ Bytes?: number;
1150
936
  /**
1151
- * function名称,只能包含a-z,A-Z,0-9,\_或-
937
+ * 文件创建时的 Unix 时间戳(秒)。
1152
938
  */
1153
- Name: string;
939
+ CreatedAt?: number;
1154
940
  /**
1155
- * function参数,一般为json字符串
941
+ * 文件名。
1156
942
  */
1157
- Parameters: string;
943
+ Filename?: string;
1158
944
  /**
1159
- * function的简单描述
945
+ * 上传文件的用途。
1160
946
  */
1161
- Description?: string;
947
+ Purpose?: string;
1162
948
  }
1163
949
  /**
1164
- * 具体的function调用
950
+ * 模型生成的工具调用
1165
951
  */
1166
- export interface ToolCallFunction {
952
+ export interface ToolCall {
1167
953
  /**
1168
- * function名称
954
+ * 工具调用id
1169
955
  */
1170
- Name: string;
956
+ Id: string;
1171
957
  /**
1172
- * function参数,一般为json字符串
958
+ * 工具调用类型,当前只支持function
1173
959
  */
1174
- Arguments: string;
1175
- }
1176
- /**
1177
- * SetPayMode请求参数结构体
1178
- */
1179
- export interface SetPayModeRequest {
960
+ Type: string;
1180
961
  /**
1181
- * 设置后付费状态,0:后付费打开;1:后付费关闭
962
+ * 具体的function调用
1182
963
  */
1183
- PayMode: number;
964
+ Function: ToolCallFunction;
965
+ /**
966
+ * 索引值
967
+ */
968
+ Index?: number;
1184
969
  }
1185
970
  /**
1186
- * TextToImageLite请求参数结构体
971
+ * GetThreadMessageList返回参数结构体
1187
972
  */
1188
- export interface TextToImageLiteRequest {
973
+ export interface GetThreadMessageListResponse {
1189
974
  /**
1190
- * 文本描述。
1191
- 算法将根据输入的文本智能生成与之相关的图像。建议详细描述画面主体、细节、场景等,文本描述越丰富,生成效果越精美。
1192
- 不能为空,推荐使用中文。最多可传256个 utf-8 字符。
975
+ * 消息列表
1193
976
  */
1194
- Prompt: string;
977
+ Data?: Array<ThreadMessage>;
1195
978
  /**
1196
- * 反向文本描述。
1197
- 用于一定程度上从反面引导模型生成的走向,减少生成结果中出现描述内容的可能,但不能完全杜绝。
1198
- 推荐使用中文。最多可传256个 utf-8 字符。
979
+ * 第一条消息 ID
980
+ 注意:此字段可能返回 null,表示取不到有效值。
981
+ * @deprecated
1199
982
  */
1200
- NegativePrompt?: string;
983
+ FirstID?: string;
1201
984
  /**
1202
- * 绘画风格。
1203
- 请在 [文生图轻量版风格列表](https://cloud.tencent.com/document/product/1729/108992) 中选择期望的风格,传入风格编号。不传默认使用201(日系动漫风格)。
985
+ * 已废弃
986
+ 注意:此字段可能返回 null,表示取不到有效值。
987
+ * @deprecated
1204
988
  */
1205
- Style?: string;
989
+ LastID?: number;
1206
990
  /**
1207
- * 生成图分辨率。
1208
- 支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3)、1080:1920(9:16)、1920:1080(16:9),不传默认使用768:768。
991
+ * 是否还有更多消息
1209
992
  */
1210
- Resolution?: string;
993
+ HasMore?: boolean;
1211
994
  /**
1212
- * 为生成结果图添加标识的开关,默认为1。
1213
- 1:添加标识。
1214
- 0:不添加标识。
1215
- 其他数值:默认按0处理。
1216
- 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
995
+ * 对象类型
1217
996
  */
1218
- LogoAdd?: number;
997
+ Object?: string;
1219
998
  /**
1220
- * 标识内容设置。
1221
- 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
999
+ * 第一条消息 ID
1222
1000
  */
1223
- LogoParam?: LogoParam;
1001
+ FirstMsgID?: string;
1224
1002
  /**
1225
- * 返回图像方式(base64 或 url) ,二选一,默认为 base64。url 有效期为1小时。
1003
+ * 最后一条消息 ID
1226
1004
  */
1227
- RspImgType?: string;
1005
+ LastMsgID?: string;
1006
+ /**
1007
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1008
+ */
1009
+ RequestId?: string;
1228
1010
  }
1229
1011
  /**
1230
- * 输入框
1012
+ * 图片信息
1231
1013
  */
1232
- export interface LogoRect {
1014
+ export interface Image {
1233
1015
  /**
1234
- * 左上角X坐标
1016
+ * 图片Url。
1235
1017
  */
1236
- X?: number;
1018
+ ImageUrl?: string;
1237
1019
  /**
1238
- * 左上角Y坐标
1020
+ * 图片Base64。
1239
1021
  */
1240
- Y?: number;
1022
+ ImageBase64?: string;
1023
+ }
1024
+ /**
1025
+ * 在会话中提供给助手工具的一系列资源。不同类型的工具会有各自对应的资源。比如代码解释器需要一个文件 ID 的列表,而文件搜索工具则需要一个向量存储 ID 的列表。
1026
+ */
1027
+ export interface ThreadToolResources {
1241
1028
  /**
1242
- * 方框宽度
1029
+ * 文件 ID 列表
1243
1030
  */
1244
- Width?: number;
1031
+ CodeInterpreter?: Array<string>;
1245
1032
  /**
1246
- * 方框高度
1033
+ * 向量存储 ID 列表
1247
1034
  */
1248
- Height?: number;
1035
+ VectorStoreIDs?: Array<string>;
1249
1036
  }
1250
1037
  /**
1251
- * 相关组织及人物
1038
+ * 多媒体占位符替换信息
1252
1039
  */
1253
- export interface RelevantEntity {
1254
- /**
1255
- * 相关组织及人物名称
1256
- 注意:此字段可能返回 null,表示取不到有效值。
1257
- */
1258
- Name: string;
1040
+ export interface Replace {
1259
1041
  /**
1260
- * 相关组织及人物内容
1261
- 注意:此字段可能返回 null,表示取不到有效值。
1042
+ * 占位符序号
1262
1043
  */
1263
- Content: string;
1044
+ Id?: string;
1264
1045
  /**
1265
- * 相关事件引用文章标号
1266
- 注意:此字段可能返回 null,表示取不到有效值。
1046
+ * 多媒体详情
1267
1047
  */
1268
- Reference: Array<number | bigint>;
1048
+ Multimedia?: Array<Multimedia>;
1269
1049
  }
1270
1050
  /**
1271
- * CreateThread返回参数结构体
1051
+ * CreateThread请求参数结构体
1272
1052
  */
1273
- export interface CreateThreadResponse {
1053
+ export declare type CreateThreadRequest = null;
1054
+ /**
1055
+ * 会话内容
1056
+ */
1057
+ export interface Message {
1274
1058
  /**
1275
- * 会话 ID
1059
+ * 角色,可选值包括 system、user、assistant、 tool。
1276
1060
  */
1277
- ID?: string;
1061
+ Role: string;
1278
1062
  /**
1279
- * 对象类型
1063
+ * 文本内容
1280
1064
  */
1281
- Object?: string;
1065
+ Content?: string;
1282
1066
  /**
1283
- * 创建时间,Unix 时间戳,单位为秒。
1067
+ * 多种类型内容(目前支持图片和文本),仅 hunyuan-vision 和 hunyuan-turbo-vision 模型支持
1068
+ 注意:此字段可能返回 null,表示取不到有效值。
1284
1069
  */
1285
- CreatedAt?: number;
1070
+ Contents?: Array<Content>;
1286
1071
  /**
1287
- * 提供给工具的资源列表
1072
+ * 当role为tool时传入,标识具体的函数调用
1288
1073
  注意:此字段可能返回 null,表示取不到有效值。
1289
1074
  */
1290
- ToolResources?: ThreadToolResources;
1075
+ ToolCallId?: string;
1291
1076
  /**
1292
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1077
+ * 模型生成的工具调用,仅 hunyuan-pro 或者 hunyuan-functioncall 模型支持
1078
+ 注意:此字段可能返回 null,表示取不到有效值。
1293
1079
  */
1294
- RequestId?: string;
1080
+ ToolCalls?: Array<ToolCall>;
1081
+ /**
1082
+ * 文件标识符。单次最大 50 个文件。
1083
+ 注意:此字段可能返回 null,表示取不到有效值。
1084
+ */
1085
+ FileIDs?: Array<string>;
1086
+ /**
1087
+ * 思维链内容。用于展示模型思考过程,仅 Hunyuan-T1 系列模型可用。注意:在进行多轮对话时,请**不要**将此字段拼接到 messages 中。请求 messages 的请求参数中包含 reasoning_content,接口将报错。
1088
+ */
1089
+ ReasoningContent?: string;
1295
1090
  }
1296
1091
  /**
1297
- * SubmitHunyuanImageJob返回参数结构体
1092
+ * 翻译接口会话内容
1298
1093
  */
1299
- export interface SubmitHunyuanImageJobResponse {
1094
+ export interface TranslationMessage {
1300
1095
  /**
1301
- * 任务 ID
1096
+ * 角色,可选值包括 system、user、assistant、 tool
1302
1097
  */
1303
- JobId?: string;
1098
+ Role?: string;
1304
1099
  /**
1305
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1100
+ * 文本内容
1306
1101
  */
1307
- RequestId?: string;
1102
+ Content?: string;
1308
1103
  }
1309
1104
  /**
1310
- * GroupChatCompletions返回参数结构体
1105
+ * ChatCompletions请求参数结构体
1311
1106
  */
1312
- export interface GroupChatCompletionsResponse {
1107
+ export interface ChatCompletionsRequest {
1313
1108
  /**
1314
- * Unix 时间戳,单位为秒。
1109
+ * 模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-code、hunyuan-role、hunyuan-functioncall、hunyuan-vision、hunyuan-turbo、hunyuan-turbo-latest、hunyuan-turbo-20241223、hunyuan-turbo-20241120、hunyuan-large、hunyuan-large-longcontext、hunyuan-turbo-vision、hunyuan-standard-vision、hunyuan-lite-vision、hunyuan-turbos-20250226、hunyuan-turbos-latest、hunyuan-t1-20250321、hunyuan-t1-latest、hunyuan-turbos-role-plus。各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。注意:不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
1315
1110
  */
1316
- Created?: number;
1111
+ Model: string;
1317
1112
  /**
1318
- * Token 统计信息。
1319
- 按照总 Token 数量计费。
1113
+ * 聊天上下文信息。
1114
+ 说明:
1115
+ 1. 长度最多为 40,按对话时间从旧到新在数组中排列。
1116
+ 2. Message.Role 可选值:system、user、assistant、 tool(functioncall场景)。
1117
+ 其中,system 角色可选,如存在则必须位于列表的最开始。user(tool) 和 assistant 需交替出现(一问一答),以 user 提问开始,user(tool)提问结束,其中tool可以连续出现多次,且 Content 不能为空。Role 的顺序示例:[system(可选) user assistant user(tool tool ...) assistant user(tool tool ...) ...]。
1118
+ 3. Messages 中 Content 总长度不能超过模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。
1320
1119
  */
1321
- Usage?: Usage;
1120
+ Messages: Array<Message>;
1322
1121
  /**
1323
- * 免责声明。
1122
+ * 流式调用开关。
1123
+ 说明:
1124
+ 1. 未传值时默认为非流式调用(false)。
1125
+ 2. 流式调用时以 SSE 协议增量返回结果(返回值取 Choices[n].Delta 中的值,需要拼接增量数据才能获得完整结果)。
1126
+ 3. 非流式调用时:
1127
+ 调用方式与普通 HTTP 请求无异。
1128
+ 接口响应耗时较长,**如需更低时延建议设置为 true**。
1129
+ 只返回一次最终结果(返回值取 Choices[n].Message 中的值)。
1130
+
1131
+ 注意:
1132
+ 通过 SDK 调用时,流式和非流式调用需用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
1324
1133
  */
1325
- Note?: string;
1134
+ Stream?: boolean;
1326
1135
  /**
1327
- * 本次请求的 RequestId。
1136
+ * 流式输出审核开关。
1137
+ 说明:
1138
+ 1. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
1139
+ 2. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。未传值时默认为流式模式(true)。
1140
+ 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
1141
+ 4. 如果值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
1142
+
1143
+ 注意:
1144
+ 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
1328
1145
  */
1329
- Id?: string;
1146
+ StreamModeration?: boolean;
1330
1147
  /**
1331
- * 回复内容。
1148
+ * 说明:
1149
+ 1. 影响输出文本的多样性。模型已有默认参数,不传值时使用各模型推荐值,不推荐用户修改。
1150
+ 2. 取值区间为 [0.0, 1.0]。取值越大,生成文本的多样性越强。
1332
1151
  */
1333
- Choices?: Array<Choice>;
1152
+ TopP?: number;
1334
1153
  /**
1335
- * 错误信息。
1336
- 如果流式返回中服务处理异常,返回该错误信息。
1337
- 注意:此字段可能返回 null,表示取不到有效值。
1154
+ * 说明:
1155
+ 1. 影响模型输出多样性,模型已有默认参数,不传值时使用各模型推荐值,不推荐用户修改。
1156
+ 2. 取值区间为 [0.0, 2.0]。较高的数值会使输出更加多样化和不可预测,而较低的数值会使其更加集中和确定。
1338
1157
  */
1339
- ErrorMsg?: ErrorMsg;
1158
+ Temperature?: number;
1340
1159
  /**
1341
- * 搜索结果信息
1160
+ * 功能增强(如搜索)开关。
1161
+ 说明:
1162
+ 1. hunyuan-lite 无功能增强(如搜索)能力,该参数对 hunyuan-lite 版本不生效。
1163
+ 2. 未传值时默认关闭开关。
1164
+ 3. 关闭时将直接由主模型生成回复内容,可以降低响应时延(对于流式输出时的首字时延尤为明显)。但在少数场景里,回复效果可能会下降。
1165
+ 4. 安全审核能力不属于功能增强范围,不受此字段影响。
1166
+ 5. 2025-04-20 00:00:00起,由默认开启状态转为默认关闭状态。
1342
1167
  */
1343
- SearchInfo?: SearchInfo;
1168
+ EnableEnhancement?: boolean;
1344
1169
  /**
1345
- * 多媒体信息。
1170
+ * 可调用的工具列表,仅对 hunyuan-turbo、hunyuan-functioncall 模型生效。
1171
+ */
1172
+ Tools?: Array<Tool>;
1173
+ /**
1174
+ * 工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-turbo、hunyuan-functioncall 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto
1175
+ */
1176
+ ToolChoice?: string;
1177
+ /**
1178
+ * 强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填
1179
+ */
1180
+ CustomTool?: Tool;
1181
+ /**
1182
+ * 默认是false,在值为true且命中搜索时,接口会返回SearchInfo
1183
+ */
1184
+ SearchInfo?: boolean;
1185
+ /**
1186
+ * 搜索引文角标开关。
1346
1187
  说明:
1347
- 1. 可以用多媒体信息替换回复内容里的占位符,得到完整的消息。
1348
- 2. 可能会出现回复内容里存在占位符,但是因为审核等原因没有返回多媒体信息。
1188
+ 1. 配合EnableEnhancement和SearchInfo参数使用。打开后,回答中命中搜索的结果会在片段后增加角标标志,对应SearchInfo列表中的链接。
1189
+ 2. false:开关关闭,true:开关打开。
1190
+ 3. 未传值时默认开关关闭(false)。
1349
1191
  */
1350
- Replaces?: Array<Replace>;
1192
+ Citation?: boolean;
1351
1193
  /**
1352
- * 推荐问答。
1194
+ * 是否开启极速版搜索,默认false,不开启;在开启且命中搜索时,会启用极速版搜索,流式输出首字返回更快。
1353
1195
  */
1354
- RecommendedQuestions?: Array<string>;
1196
+ EnableSpeedSearch?: boolean;
1355
1197
  /**
1356
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1198
+ * 多媒体开关。
1199
+ 详细介绍请阅读 [多媒体介绍](https://cloud.tencent.com/document/product/1729/111178) 中的说明。
1200
+ 说明:
1201
+ 1. 该参数目前仅对白名单内用户生效,如您想体验该功能请 [联系我们](https://cloud.tencent.com/act/event/Online_service)。
1202
+ 2. 该参数仅在功能增强(如搜索)开关开启(EnableEnhancement=true)并且极速版搜索开关关闭(EnableSpeedSearch=false)时生效。
1203
+ 3. hunyuan-lite 无多媒体能力,该参数对 hunyuan-lite 版本不生效。
1204
+ 4. 未传值时默认关闭。
1205
+ 5. 开启并搜索到对应的多媒体信息时,会输出对应的多媒体地址,可以定制个性化的图文消息。
1357
1206
  */
1358
- RequestId?: string;
1207
+ EnableMultimedia?: boolean;
1208
+ /**
1209
+ * 是否开启深度研究该问题,默认是false,在值为true且命中深度研究该问题时,会返回深度研究该问题信息。
1210
+ */
1211
+ EnableDeepSearch?: boolean;
1212
+ /**
1213
+ * 说明: 1. 确保模型的输出是可复现的。 2. 取值区间为非0正整数,最大值10000。 3. 非必要不建议使用,不合理的取值会影响效果。
1214
+ */
1215
+ Seed?: number;
1216
+ /**
1217
+ * 强制搜索增强开关。
1218
+ 说明:
1219
+ 1. 未传值时默认关闭。
1220
+ 2. 开启后,将强制走AI搜索,当AI搜索结果为空时,由大模型回复兜底话术。
1221
+ */
1222
+ ForceSearchEnhancement?: boolean;
1223
+ /**
1224
+ * 自定义结束生成字符串
1225
+
1226
+ 调用 OpenAI 的接口时,如果您指定了 `stop` 参数, 模型会停止在匹配到 `stop` 的内容之前。
1227
+ 在调用混元接口时,会停止在匹配到 `stop` 的内容之后。
1228
+
1229
+ **说明:**
1230
+ 未来我们可能会修改此行为以便和 OpenAI 保持一致。
1231
+ 但是目前有使用该参数的情况下,开发者需要注意该参数是否会对应用造成影响,以及未来该行为调整时带来的影响。
1232
+ */
1233
+ Stop?: Array<string>;
1234
+ /**
1235
+ * 推荐问答开关。
1236
+ 说明:
1237
+ 1. 未传值时默认关闭。
1238
+ 2. 开启后,在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答, 最多返回3条。
1239
+ */
1240
+ EnableRecommendedQuestions?: boolean;
1241
+ /**
1242
+ * 是否开启深度阅读,默认是false,在值为true时,会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true;2.目前暂时只支持单文档单轮的深度阅读;3.深度阅读功能的文件上传可以使用FilesUploads接口,具体参数详见FilesUploads接口文档
1243
+ */
1244
+ EnableDeepRead?: boolean;
1359
1245
  }
1360
1246
  /**
1361
- * GetThread返回参数结构体
1247
+ * logo参数
1362
1248
  */
1363
- export interface GetThreadResponse {
1249
+ export interface LogoParam {
1364
1250
  /**
1365
- * 会话 ID
1251
+ * 水印url
1366
1252
  */
1367
- ID?: string;
1253
+ LogoUrl?: string;
1368
1254
  /**
1369
- * 对象类型
1255
+ * 水印base64,url和base64二选一传入
1370
1256
  */
1371
- Object?: string;
1257
+ LogoImage?: string;
1372
1258
  /**
1373
- * 创建时间,Unix 时间戳,单位为秒。
1259
+ * 水印图片位于融合结果图中的坐标,将按照坐标对标识图片进行位置和大小的拉伸匹配
1374
1260
  */
1375
- CreatedAt?: number;
1261
+ LogoRect?: LogoRect;
1262
+ }
1263
+ /**
1264
+ * FilesUploads请求参数结构体
1265
+ */
1266
+ export interface FilesUploadsRequest {
1376
1267
  /**
1377
- * 提供给工具的资源列表
1378
- 注意:此字段可能返回 null,表示取不到有效值。
1268
+ * 文件名。
1379
1269
  */
1380
- ToolResources?: ThreadToolResources;
1270
+ Name: string;
1381
1271
  /**
1382
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1272
+ * 文件链接。目前支持 csv, doc, docx, pdf, ppt, pptx, txt, xls, xlsx 格式,单文件大小限制为100M。
1383
1273
  */
1384
- RequestId?: string;
1274
+ URL: string;
1385
1275
  }
1386
1276
  /**
1387
- * ActivateService返回参数结构体
1277
+ * GetEmbedding请求参数结构体
1388
1278
  */
1389
- export interface ActivateServiceResponse {
1279
+ export interface GetEmbeddingRequest {
1390
1280
  /**
1391
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1281
+ * 输入文本。总长度不超过 1024 Token,超过则会截断最后面的内容。
1392
1282
  */
1393
- RequestId?: string;
1283
+ Input?: string;
1284
+ /**
1285
+ * 输入文本数组。输入数组总长度不超过 50 。
1286
+ */
1287
+ InputList?: Array<string>;
1394
1288
  }
1395
1289
  /**
1396
- * QueryHunyuanImageJob返回参数结构体
1290
+ * 具体的图片内容
1397
1291
  */
1398
- export interface QueryHunyuanImageJobResponse {
1292
+ export interface ImageUrl {
1399
1293
  /**
1400
- * 当前任务状态码:
1401
- 1:等待中、2:运行中、4:处理失败、5:处理完成。
1294
+ * 图片的 Url(以 http:// 或 https:// 开头)
1295
+ 注意:此字段可能返回 null,表示取不到有效值。
1296
+ */
1297
+ Url: string;
1298
+ }
1299
+ /**
1300
+ * 多媒体详情
1301
+ */
1302
+ export interface Multimedia {
1303
+ /**
1304
+ * 多媒体类型,可选值包括 image、music、album、playlist。
1305
+ 说明:
1306
+ 1. image:图片;music:单曲,类型为单曲时,会返回详细歌手和歌曲信息;album:专辑;playlist:歌单。
1307
+ 2. 当 type 为 music、album、playlist 时,需要配合 [QQ音乐SDK](https://developer.y.qq.com/) 使用。
1308
+ */
1309
+ Type?: string;
1310
+ /**
1311
+ * 多媒体地址。
1312
+ 说明:
1313
+ 1. type 为 image 时,地址为图片的预览地址;其他类型时,地址为封面图地址。
1314
+ */
1315
+ Url?: string;
1316
+ /**
1317
+ * 多媒体详情地址。
1318
+ 说明:
1319
+ 1. 仅 type 为 image 时,该字段有值。
1320
+ 注意:此字段可能返回 null,表示取不到有效值。
1321
+ */
1322
+ JumpUrl?: string;
1323
+ /**
1324
+ * 名称。
1325
+ 说明:
1326
+ 1. type 为 image 时,该字段为空。
1327
+ 注意:此字段可能返回 null,表示取不到有效值。
1328
+ */
1329
+ Title?: string;
1330
+ /**
1331
+ * 描述。
1332
+ 注意:此字段可能返回 null,表示取不到有效值。
1333
+ */
1334
+ Desc?: string;
1335
+ /**
1336
+ * 歌手名称。
1337
+ 说明:
1338
+ 1. 仅 type 为 music 时,该字段有值。
1339
+ 注意:此字段可能返回 null,表示取不到有效值。
1340
+ */
1341
+ Singer?: string;
1342
+ /**
1343
+ * 歌曲详情。
1344
+ 说明:
1345
+ 1. 仅 type 为 music 时,该字段有值。
1346
+ 注意:此字段可能返回 null,表示取不到有效值。
1347
+ */
1348
+ Ext?: SongExt;
1349
+ }
1350
+ /**
1351
+ * GroupChatCompletions返回参数结构体
1352
+ */
1353
+ export interface GroupChatCompletionsResponse {
1354
+ /**
1355
+ * Unix 时间戳,单位为秒。
1356
+ */
1357
+ Created?: number;
1358
+ /**
1359
+ * Token 统计信息。
1360
+ 按照总 Token 数量计费。
1361
+ */
1362
+ Usage?: Usage;
1363
+ /**
1364
+ * 免责声明。
1402
1365
  */
1403
- JobStatusCode?: string;
1366
+ Note?: string;
1404
1367
  /**
1405
- * 当前任务状态:排队中、处理中、处理失败或者处理完成。
1406
-
1368
+ * 本次请求的 RequestId。
1407
1369
  */
1408
- JobStatusMsg?: string;
1370
+ Id?: string;
1409
1371
  /**
1410
- * 任务处理失败错误码。
1411
-
1372
+ * 回复内容。
1412
1373
  */
1413
- JobErrorCode?: string;
1374
+ Choices?: Array<Choice>;
1414
1375
  /**
1415
- * 任务处理失败错误信息。
1416
-
1376
+ * 错误信息。
1377
+ 如果流式返回中服务处理异常,返回该错误信息。
1378
+ 注意:此字段可能返回 null,表示取不到有效值。
1417
1379
  */
1418
- JobErrorMsg?: string;
1380
+ ErrorMsg?: ErrorMsg;
1419
1381
  /**
1420
- * 生成图 URL 列表,有效期1小时,请及时保存。
1421
-
1382
+ * 搜索结果信息
1422
1383
  */
1423
- ResultImage?: Array<string>;
1384
+ SearchInfo?: SearchInfo;
1424
1385
  /**
1425
- * 结果 detail 数组,Success 代表成功。
1426
-
1386
+ * 多媒体信息。
1387
+ 说明:
1388
+ 1. 可以用多媒体信息替换回复内容里的占位符,得到完整的消息。
1389
+ 2. 可能会出现回复内容里存在占位符,但是因为审核等原因没有返回多媒体信息。
1427
1390
  */
1428
- ResultDetails?: Array<string>;
1391
+ Replaces?: Array<Replace>;
1429
1392
  /**
1430
- * 对应 SubmitHunyuanImageJob 接口中 Revise 参数。开启扩写时,返回扩写后的 prompt 文本。 如果关闭扩写,将直接返回原始输入的 prompt。
1393
+ * 推荐问答。
1431
1394
  */
1432
- RevisedPrompt?: Array<string>;
1395
+ RecommendedQuestions?: Array<string>;
1433
1396
  /**
1434
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId
1397
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1435
1398
  */
1436
1399
  RequestId?: string;
1437
1400
  }
1438
1401
  /**
1439
- * FilesUploads返回参数结构体
1402
+ * SubmitHunyuanImageJob请求参数结构体
1440
1403
  */
1441
- export interface FilesUploadsResponse {
1404
+ export interface SubmitHunyuanImageJobRequest {
1442
1405
  /**
1443
- * 文件标识符,可在各个API中引用。
1406
+ * 文本描述。
1407
+ 算法将根据输入的文本智能生成与之相关的图像。
1408
+ 不能为空,推荐使用中文。最多可传1024个 utf-8 字符。
1444
1409
  */
1445
- ID?: string;
1410
+ Prompt: string;
1446
1411
  /**
1447
- * 对象类型,始终为 file。
1412
+ * 反向提示词。
1413
+ 推荐使用中文。最多可传1024个 utf-8 字符。
1448
1414
  */
1449
- Object?: string;
1415
+ NegativePrompt?: string;
1450
1416
  /**
1451
- * 文件大小,单位为字节。
1417
+ * 绘画风格。
1418
+ 请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格,传入风格编号。
1419
+ 不传默认不指定风格。
1452
1420
  */
1453
- Bytes?: number;
1421
+ Style?: string;
1454
1422
  /**
1455
- * 文件创建时的 Unix 时间戳(秒)。
1423
+ * 生成图分辨率。
1424
+ 支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3),不传默认使用1024:1024。
1425
+ 如果上传 ContentImage 参考图,分辨率仅支持:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1),不传将自动适配分辨率。如果参考图被用于做风格转换,将生成保持原图长宽比例且长边为1024的图片,指定的分辨率不生效。
1456
1426
  */
1457
- CreatedAt?: number;
1427
+ Resolution?: string;
1458
1428
  /**
1459
- * 文件名。
1429
+ * 图片生成数量。
1430
+ 支持1 ~ 4张,默认生成1张。
1460
1431
  */
1461
- Filename?: string;
1432
+ Num?: number;
1462
1433
  /**
1463
- * 上传文件的用途。
1434
+ * 超分选项,默认不做超分,可选开启。
1435
+ x2:2倍超分
1436
+ x4:4倍超分
1437
+ 在 Resolution 的基础上按比例提高分辨率,例如1024:1024开启2倍超分后将得到2048:2048。
1464
1438
  */
1465
- Purpose?: string;
1439
+ Clarity?: string;
1466
1440
  /**
1467
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1441
+ * 用于引导内容的参考图。
1442
+ 图片限制:单边分辨率小于5000,转成 Base64 字符串后小于 8MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
1468
1443
  */
1469
- RequestId?: string;
1444
+ ContentImage?: Image;
1445
+ /**
1446
+ * prompt 扩写开关。1为开启,0为关闭,不传默认开启。
1447
+ 开启扩写后,将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片,返回生成图片结果时将一并返回扩写后的 prompt 文本。
1448
+ 如果关闭扩写,将直接使用原始输入的 prompt 生成图片。如果上传了参考图,扩写关闭不生效,将保持开启。
1449
+ 建议开启,在多数场景下可提升生成图片效果、丰富生成图片细节。
1450
+ */
1451
+ Revise?: number;
1452
+ /**
1453
+ * 随机种子,默认随机。
1454
+ 不传:随机种子生成。
1455
+ 正数:固定种子生成。
1456
+ 扩写开启时固定种子不生效,将保持随机。
1457
+ */
1458
+ Seed?: number;
1459
+ /**
1460
+ * 为生成结果图添加显式水印标识的开关,默认为1。
1461
+ 1:添加。
1462
+ 0:不添加。
1463
+ 其他数值:默认按1处理。
1464
+ 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
1465
+ */
1466
+ LogoAdd?: number;
1467
+ /**
1468
+ * 标识内容设置。
1469
+ 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
1470
+ */
1471
+ LogoParam?: LogoParam;
1470
1472
  }
1471
1473
  /**
1472
- * FilesDeletions返回参数结构体
1474
+ * GetTokenCount返回参数结构体
1473
1475
  */
1474
- export interface FilesDeletionsResponse {
1476
+ export interface GetTokenCountResponse {
1475
1477
  /**
1476
- * 文件标识符。
1478
+ * token计数
1477
1479
  */
1478
- ID?: string;
1480
+ TokenCount?: number;
1479
1481
  /**
1480
- * 对象类型,始终为 file。
1482
+ * 字符计数
1481
1483
  */
1482
- Object?: string;
1484
+ CharacterCount?: number;
1483
1485
  /**
1484
- * 是否删除成功。
1486
+ * 切分后的列表
1485
1487
  */
1486
- Deleted?: boolean;
1488
+ Tokens?: Array<string>;
1487
1489
  /**
1488
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1490
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId
1489
1491
  */
1490
1492
  RequestId?: string;
1491
1493
  }
1492
1494
  /**
1493
- * 脑图
1495
+ * 时间线
1494
1496
  */
1495
- export interface Mindmap {
1497
+ export interface Timeline {
1496
1498
  /**
1497
- * 脑图缩略图链接
1499
+ * 标题
1498
1500
  注意:此字段可能返回 null,表示取不到有效值。
1499
1501
  */
1500
- ThumbUrl: string;
1502
+ Title?: string;
1501
1503
  /**
1502
- * 脑图图片链接
1504
+ * 时间
1503
1505
  注意:此字段可能返回 null,表示取不到有效值。
1504
1506
  */
1505
- Url: string;
1507
+ Datetime?: string;
1508
+ /**
1509
+ * 相关网页链接
1510
+ 注意:此字段可能返回 null,表示取不到有效值。
1511
+ */
1512
+ Url?: string;
1506
1513
  }
1507
1514
  /**
1508
- * 在会话中提供给助手工具的一系列资源。不同类型的工具会有各自对应的资源。比如代码解释器需要一个文件 ID 的列表,而文件搜索工具则需要一个向量存储 ID 的列表。
1515
+ * 3D文件列表
1509
1516
  */
1510
- export interface ThreadToolResources {
1511
- /**
1512
- * 文件 ID 列表
1513
- */
1514
- CodeInterpreter?: Array<string>;
1517
+ export interface File3Ds {
1515
1518
  /**
1516
- * 向量存储 ID 列表
1519
+ * 3D文件列表
1517
1520
  */
1518
- VectorStoreIDs?: Array<string>;
1521
+ File3D?: Array<File3D>;
1519
1522
  }
1520
1523
  /**
1521
- * 会话消息
1524
+ * 返回的内容(流式返回)
1522
1525
  */
1523
- export interface ThreadMessage {
1526
+ export interface Delta {
1524
1527
  /**
1525
- * 消息 ID
1528
+ * 角色名称。
1526
1529
  */
1527
- ID?: string;
1530
+ Role?: string;
1528
1531
  /**
1529
- * 对象类型
1532
+ * 内容详情。
1530
1533
  */
1531
- Object?: string;
1534
+ Content?: string;
1532
1535
  /**
1533
- * 创建时间
1536
+ * 模型生成的工具调用,仅 hunyuan-functioncall 模型支持
1537
+ 说明:
1538
+ 对于每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并。
1539
+
1540
+ 注意:此字段可能返回 null,表示取不到有效值。
1534
1541
  */
1535
- CreatedAt?: number;
1542
+ ToolCalls?: Array<ToolCall>;
1536
1543
  /**
1537
- * 会话 ID
1544
+ * 思维链内容。用于展示模型思考过程,仅 Hunyuan-T1 系列模型可用。注意:在进行多轮对话时,请不要将此字段拼接到 messages 中。请求 messages 的请求参数中包含 reasoning_content,接口将报错。
1538
1545
  */
1539
- ThreadID?: string;
1546
+ ReasoningContent?: string;
1547
+ }
1548
+ /**
1549
+ * TextToImageLite返回参数结构体
1550
+ */
1551
+ export interface TextToImageLiteResponse {
1540
1552
  /**
1541
- * 状态,处理中 in_progress,已完成 completed,未完成 incomplete。
1553
+ * 根据入参 RspImgType 填入不同,返回不同的内容。
1554
+ 如果传入 base64 则返回生成图 Base64 编码。
1555
+ 如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
1542
1556
  */
1543
- Status?: string;
1557
+ ResultImage?: string;
1544
1558
  /**
1545
- * 未完成原因
1546
- 注意:此字段可能返回 null,表示取不到有效值。
1559
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1547
1560
  */
1548
- InCompleteDetails?: ThreadMessageInCompleteDetailsObject;
1561
+ RequestId?: string;
1562
+ }
1563
+ /**
1564
+ * TextToImageLite请求参数结构体
1565
+ */
1566
+ export interface TextToImageLiteRequest {
1549
1567
  /**
1550
- * 完成时间
1551
- 注意:此字段可能返回 null,表示取不到有效值。
1568
+ * 文本描述。
1569
+ 算法将根据输入的文本智能生成与之相关的图像。建议详细描述画面主体、细节、场景等,文本描述越丰富,生成效果越精美。
1570
+ 不能为空,推荐使用中文。最多可传256个 utf-8 字符。
1552
1571
  */
1553
- CompletedAt?: number;
1572
+ Prompt: string;
1554
1573
  /**
1555
- * 未完成时间
1556
- 注意:此字段可能返回 null,表示取不到有效值。
1574
+ * 反向文本描述。
1575
+ 用于一定程度上从反面引导模型生成的走向,减少生成结果中出现描述内容的可能,但不能完全杜绝。
1576
+ 推荐使用中文。最多可传256个 utf-8 字符。
1557
1577
  */
1558
- InCompleteAt?: number;
1578
+ NegativePrompt?: string;
1559
1579
  /**
1560
- * 角色
1580
+ * 绘画风格。
1581
+ 请在 [文生图轻量版风格列表](https://cloud.tencent.com/document/product/1729/108992) 中选择期望的风格,传入风格编号。不传默认使用201(日系动漫风格)。
1561
1582
  */
1562
- Role?: string;
1583
+ Style?: string;
1563
1584
  /**
1564
- * 内容
1585
+ * 生成图分辨率。
1586
+ 支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3)、1080:1920(9:16)、1920:1080(16:9),不传默认使用768:768。
1565
1587
  */
1566
- Content?: string;
1588
+ Resolution?: string;
1567
1589
  /**
1568
- * 助手 ID
1569
- 注意:此字段可能返回 null,表示取不到有效值。
1590
+ * 为生成结果图添加标识的开关,默认为1。
1591
+ 1:添加标识。
1592
+ 0:不添加标识。
1593
+ 其他数值:默认按0处理。
1594
+ 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
1570
1595
  */
1571
- AssistantID?: string;
1596
+ LogoAdd?: number;
1572
1597
  /**
1573
- * 运行 ID
1574
- 注意:此字段可能返回 null,表示取不到有效值。
1598
+ * 标识内容设置。
1599
+ 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
1575
1600
  */
1576
- RunID?: string;
1601
+ LogoParam?: LogoParam;
1577
1602
  /**
1578
- * 附件
1579
- 注意:此字段可能返回 null,表示取不到有效值。
1603
+ * 返回图像方式(base64 或 url) ,二选一,默认为 base64。url 有效期为1小时。
1604
+ */
1605
+ RspImgType?: string;
1606
+ }
1607
+ /**
1608
+ * QueryHunyuanImageJob返回参数结构体
1609
+ */
1610
+ export interface QueryHunyuanImageJobResponse {
1611
+ /**
1612
+ * 当前任务状态码:
1613
+ 1:等待中、2:运行中、4:处理失败、5:处理完成。
1614
+ */
1615
+ JobStatusCode?: string;
1616
+ /**
1617
+ * 当前任务状态:排队中、处理中、处理失败或者处理完成。
1618
+
1580
1619
  */
1581
- Attachments?: Array<ThreadMessageAttachmentObject>;
1582
- }
1583
- /**
1584
- * 已上传的文件对象。
1585
- */
1586
- export interface FileObject {
1620
+ JobStatusMsg?: string;
1587
1621
  /**
1588
- * 文件标识符,可在各个API中引用。
1622
+ * 任务处理失败错误码。
1623
+
1589
1624
  */
1590
- ID?: string;
1625
+ JobErrorCode?: string;
1591
1626
  /**
1592
- * 对象类型,始终为 file。
1627
+ * 任务处理失败错误信息。
1628
+
1593
1629
  */
1594
- Object?: string;
1630
+ JobErrorMsg?: string;
1595
1631
  /**
1596
- * 文件大小,单位为字节。
1632
+ * 生成图 URL 列表,有效期1小时,请及时保存。
1633
+
1597
1634
  */
1598
- Bytes?: number;
1635
+ ResultImage?: Array<string>;
1599
1636
  /**
1600
- * 文件创建时的 Unix 时间戳(秒)。
1637
+ * 结果 detail 数组,Success 代表成功。
1638
+
1601
1639
  */
1602
- CreatedAt?: number;
1640
+ ResultDetails?: Array<string>;
1603
1641
  /**
1604
- * 文件名。
1642
+ * 对应 SubmitHunyuanImageJob 接口中 Revise 参数。开启扩写时,返回扩写后的 prompt 文本。 如果关闭扩写,将直接返回原始输入的 prompt。
1605
1643
  */
1606
- Filename?: string;
1644
+ RevisedPrompt?: Array<string>;
1607
1645
  /**
1608
- * 上传文件的用途。
1646
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1609
1647
  */
1610
- Purpose?: string;
1648
+ RequestId?: string;
1611
1649
  }
1612
1650
  /**
1613
1651
  * 混元生图多轮对话历史记录。
@@ -1635,264 +1673,326 @@ export interface History {
1635
1673
  Seed?: number;
1636
1674
  }
1637
1675
  /**
1638
- * GetEmbedding返回参数结构体
1676
+ * FilesList请求参数结构体
1639
1677
  */
1640
- export interface GetEmbeddingResponse {
1678
+ export interface FilesListRequest {
1641
1679
  /**
1642
- * 返回的 Embedding 信息。
1680
+ * 分页偏移量。
1643
1681
  */
1644
- Data?: Array<EmbeddingData>;
1682
+ Offset?: number;
1645
1683
  /**
1646
- * Token 使用计数,按照总 Token 数量收费。
1684
+ * 每页数量,最大 100。
1647
1685
  */
1648
- Usage?: EmbeddingUsage;
1686
+ Limit?: number;
1687
+ }
1688
+ /**
1689
+ * GetTokenCount请求参数结构体
1690
+ */
1691
+ export interface GetTokenCountRequest {
1692
+ /**
1693
+ * 输入文本
1694
+ */
1695
+ Prompt: string;
1696
+ }
1697
+ /**
1698
+ * 群聊配置
1699
+ */
1700
+ export interface GroupChatConfig {
1701
+ /**
1702
+ * 人物名称
1703
+ */
1704
+ UserName?: string;
1705
+ /**
1706
+ * ### 主题:\n武道修炼与科技创新的碰撞\n\n### 地点:\n布尔玛的实验室\n\n### 故事背景:\n布尔玛正在研发一种新型的龙珠雷达,旨在更精确地定位龙珠的位置。她邀请了孙悟空、天津饭、饺子和雅木茶前来测试新设备。然而,这些武道家们对科技的理解有限,导致了一系列有趣的误解和互动。\n\n### 人物关系:\n- **布尔玛**:天才科学家,负责研发和解释新设备。\n- **孙悟空**:纯粹的战斗狂,对科技一窍不通,但对新事物充满好奇。\n- **天津饭**:严肃自律的武道家,对科技持谨慎态度,但愿意尝试。\n- **饺子**:内向单纯,依赖天津饭,对科技感到困惑和害怕。\n- **雅木茶**:幽默自嘲的前沙漠强盗,对科技有一定了解,但更倾向于轻松调侃。\n\n### 人物目标:\n- **布尔玛**:希望新龙珠雷达能够得到有效测试,并得到反馈以改进。\n- **孙悟空**:希望通过新设备找到更强的对手进行战斗。\n- **天津饭**:希望通过测试新设备提升自己的武道修炼。\n- **饺子**:希望在不引起麻烦的情况下完成任务,并得到天津饭的认可。\n- **雅木茶**:希望通过参与测试证明自己的价值,同时享受与朋友们的互动。\n\n### 场景描述:\n布尔玛在实验室中展示她的新龙珠雷达,解释其工作原理和优势。孙悟空对设备的功能感到兴奋,但完全无法理解技术细节,不断提出天真的问题。天津饭则严肃地询问设备的安全性和可靠性,表现出对科技的谨慎态度。饺子对复杂的设备感到害怕,不断向天津饭寻求确认和安慰。雅木茶则在一旁调侃大家的反应,试图缓解紧张气氛。布尔玛在解释过程中不断被孙悟空的问题打断,感到无奈,但也被他的热情所感染。最终,大家决定一起外出测试新设备,展开一场充满欢笑和冒险的旅程。
1707
+ */
1708
+ Description?: string;
1709
+ /**
1710
+ * 角色描述
1711
+ */
1712
+ Characters?: Array<Character>;
1713
+ }
1714
+ /**
1715
+ * QueryHunyuanTo3DJob返回参数结构体
1716
+ */
1717
+ export interface QueryHunyuanTo3DJobResponse {
1718
+ /**
1719
+ * 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功
1720
+ */
1721
+ Status?: string;
1722
+ /**
1723
+ * 生成的3D文件数组
1724
+ */
1725
+ ResultFile3Ds?: Array<File3Ds>;
1726
+ /**
1727
+ * 错误码
1728
+ */
1729
+ ErrorCode?: string;
1730
+ /**
1731
+ * 错误信息
1732
+ */
1733
+ ErrorMessage?: string;
1649
1734
  /**
1650
1735
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1651
1736
  */
1652
1737
  RequestId?: string;
1653
1738
  }
1654
1739
  /**
1655
- * GetThreadMessageList返回参数结构体
1740
+ * ActivateService请求参数结构体
1656
1741
  */
1657
- export interface GetThreadMessageListResponse {
1742
+ export interface ActivateServiceRequest {
1658
1743
  /**
1659
- * 消息列表
1744
+ * 开通之后,是否关闭后付费;默认为0,不关闭;1为关闭
1660
1745
  */
1661
- Data?: Array<ThreadMessage>;
1746
+ PayMode?: number;
1747
+ }
1748
+ /**
1749
+ * GetThread请求参数结构体
1750
+ */
1751
+ export interface GetThreadRequest {
1662
1752
  /**
1663
- * 第一条消息 ID
1753
+ * 会话 ID
1754
+ */
1755
+ ThreadID: string;
1756
+ }
1757
+ /**
1758
+ * 可以传入多种类型的内容,如图片或文本。
1759
+ */
1760
+ export interface Content {
1761
+ /**
1762
+ * 内容类型
1763
+ 注意:
1764
+ 需包含至少一个 Type 为"text"的参数及至少一个 Type 为"image_url"的参数。
1765
+ 参数值可选范围:[text", "image_url"]
1664
1766
  注意:此字段可能返回 null,表示取不到有效值。
1665
- * @deprecated
1666
1767
  */
1667
- FirstID?: string;
1768
+ Type: string;
1668
1769
  /**
1669
- * 已废弃
1770
+ * 当 Type 为 text 时使用,表示具体的文本内容。当 Type 为 image_url 时,当前字段内容需保持为空,传递内容不生效。
1670
1771
  注意:此字段可能返回 null,表示取不到有效值。
1671
- * @deprecated
1672
1772
  */
1673
- LastID?: number;
1773
+ Text?: string;
1674
1774
  /**
1675
- * 是否还有更多消息
1775
+ * 图片的url,当 Type 为 image_url 时使用,表示具体的图片内容
1776
+ 如"https://example.com/1.png" 或 图片的base64(注意 "data:image/jpeg;base64," 为必要部分):"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA......"。当 Type 为 text 时,当前字段内容需保持为空,传递内容不生效。
1777
+ 注意:此字段可能返回 null,表示取不到有效值。
1676
1778
  */
1677
- HasMore?: boolean;
1779
+ ImageUrl?: ImageUrl;
1780
+ }
1781
+ /**
1782
+ * ChatTranslations返回参数结构体
1783
+ */
1784
+ export interface ChatTranslationsResponse {
1678
1785
  /**
1679
- * 对象类型
1786
+ * 本次请求的 RequestId。
1680
1787
  */
1681
- Object?: string;
1788
+ Id?: string;
1682
1789
  /**
1683
- * 第一条消息 ID
1790
+ * 免责声明。
1684
1791
  */
1685
- FirstMsgID?: string;
1792
+ Note?: string;
1686
1793
  /**
1687
- * 最后一条消息 ID
1794
+ * Unix 时间戳,单位为秒。
1688
1795
  */
1689
- LastMsgID?: string;
1796
+ Created?: number;
1797
+ /**
1798
+ * Token 统计信息。
1799
+ 按照总 Token 数量计费。
1800
+ */
1801
+ Usage?: Usage;
1802
+ /**
1803
+ * 回复内容。
1804
+ */
1805
+ Choices?: Array<TranslationChoice>;
1806
+ /**
1807
+ * 错误信息。
1808
+ 如果流式返回中服务处理异常,返回该错误信息。
1809
+ */
1810
+ ErrorMsg?: ErrorMsg;
1690
1811
  /**
1691
1812
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1692
1813
  */
1693
1814
  RequestId?: string;
1694
1815
  }
1695
1816
  /**
1696
- * QueryHunyuanImageJob请求参数结构体
1817
+ * 会话消息未完成原因
1697
1818
  */
1698
- export interface QueryHunyuanImageJobRequest {
1819
+ export interface ThreadMessageInCompleteDetailsObject {
1699
1820
  /**
1700
- * 任务 ID。
1821
+ * 会话消息未完成原因
1701
1822
  */
1702
- JobId: string;
1823
+ Reason?: string;
1703
1824
  }
1704
1825
  /**
1705
- * 翻译对话参考示例
1826
+ * SubmitHunyuanTo3DJob请求参数结构体
1706
1827
  */
1707
- export interface Reference {
1828
+ export interface SubmitHunyuanTo3DJobRequest {
1708
1829
  /**
1709
- * 翻译文本类型,枚举"sentence"表示句子, "term"表示术语
1830
+ * 3D内容的描述,中文正向提示词。最多支持200个 utf-8 字符,ImageBase64、ImageUrl和 Prompt必填其一,且Prompt和ImageBase64/ImageUrl不能同时存在。
1710
1831
  */
1711
- Type?: string;
1832
+ Prompt?: string;
1712
1833
  /**
1713
- * 原文
1834
+ * 输入图 Base64 数据。最多支持200个 utf-8 字符,ImageBase64、ImageUrl和 Prompt必填其一,且Prompt和ImageBase64/ImageUrl不能同时存在。
1714
1835
  */
1715
- Text?: string;
1836
+ ImageBase64?: string;
1716
1837
  /**
1717
- * 译文
1838
+ * 输入图Url。最多支持200个 utf-8 字符,ImageBase64、ImageUrl和 Prompt必填其一,且Prompt和ImageBase64/ImageUrl不能同时存在。
1718
1839
  */
1719
- Translation?: string;
1840
+ ImageUrl?: string;
1841
+ /**
1842
+ * 生成数量。默认1,当前限制只能为1。
1843
+ */
1844
+ Num?: number;
1720
1845
  }
1721
1846
  /**
1722
- * FilesList请求参数结构体
1847
+ * ImageQuestion请求参数结构体
1723
1848
  */
1724
- export interface FilesListRequest {
1849
+ export interface ImageQuestionRequest {
1725
1850
  /**
1726
- * 分页偏移量。
1851
+ * 模型名称,可选值包括 hunyuan-vision-image-question。各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。注意:不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
1727
1852
  */
1728
- Offset?: number;
1853
+ Model: string;
1729
1854
  /**
1730
- * 每页数量,最大 100
1855
+ * 聊天上下文信息。说明:1. 长度最多为 40,按对话时间从旧到新在数组中排列。2. Message.Role 可选值:system、user、assistant。其中,system 角色可选,如存在则必须位于列表的最开始。user 和 assistant 需交替出现(一问一答),以 user 提问开始,user提问结束,且 Content 不能为空。Role 的顺序示例:[system(可选) user assistant user assistant user ...]3. Messages 中 Content 总长度不能超过模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。
1731
1856
  */
1732
- Limit?: number;
1857
+ Messages: Array<ImageMessage>;
1858
+ /**
1859
+ * 流式调用开关。
1860
+ 说明:
1861
+ 1. 未传值时默认为非流式调用(false)。
1862
+ 2. 流式调用时以 SSE 协议增量返回结果(返回值取 Choices[n].Delta 中的值,需要拼接增量数据才能获得完整结果)。
1863
+ 3. 非流式调用时:
1864
+ 调用方式与普通 HTTP 请求无异。
1865
+ 接口响应耗时较长,**如需更低时延建议设置为 true**。
1866
+ 只返回一次最终结果(返回值取 Choices[n].Message 中的值)。
1867
+
1868
+ 注意:
1869
+ 通过 SDK 调用时,流式和非流式调用需用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
1870
+ */
1871
+ Stream?: boolean;
1733
1872
  }
1734
1873
  /**
1735
- * 运行时异常信息。
1874
+ * SubmitHunyuanTo3DJob返回参数结构体
1736
1875
  */
1737
- export interface ErrorMsg {
1876
+ export interface SubmitHunyuanTo3DJobResponse {
1738
1877
  /**
1739
- * 错误提示信息。
1878
+ * 任务id
1740
1879
  */
1741
- Msg?: string;
1880
+ JobId?: string;
1742
1881
  /**
1743
- * 错误码。
1744
- 4000 服务内部异常。
1745
- 4001 请求模型超时。
1746
-
1882
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1747
1883
  */
1748
- Code?: number;
1884
+ RequestId?: string;
1749
1885
  }
1750
1886
  /**
1751
- * 群聊配置
1887
+ * QueryHunyuanImageChatJob返回参数结构体
1752
1888
  */
1753
- export interface GroupChatConfig {
1889
+ export interface QueryHunyuanImageChatJobResponse {
1754
1890
  /**
1755
- * 人物名称
1891
+ * 当前任务状态码:
1892
+ 1:等待中、2:运行中、4:处理失败、5:处理完成。
1756
1893
  */
1757
- UserName?: string;
1894
+ JobStatusCode?: string;
1758
1895
  /**
1759
- * ### 主题:\n武道修炼与科技创新的碰撞\n\n### 地点:\n布尔玛的实验室\n\n### 故事背景:\n布尔玛正在研发一种新型的龙珠雷达,旨在更精确地定位龙珠的位置。她邀请了孙悟空、天津饭、饺子和雅木茶前来测试新设备。然而,这些武道家们对科技的理解有限,导致了一系列有趣的误解和互动。\n\n### 人物关系:\n- **布尔玛**:天才科学家,负责研发和解释新设备。\n- **孙悟空**:纯粹的战斗狂,对科技一窍不通,但对新事物充满好奇。\n- **天津饭**:严肃自律的武道家,对科技持谨慎态度,但愿意尝试。\n- **饺子**:内向单纯,依赖天津饭,对科技感到困惑和害怕。\n- **雅木茶**:幽默自嘲的前沙漠强盗,对科技有一定了解,但更倾向于轻松调侃。\n\n### 人物目标:\n- **布尔玛**:希望新龙珠雷达能够得到有效测试,并得到反馈以改进。\n- **孙悟空**:希望通过新设备找到更强的对手进行战斗。\n- **天津饭**:希望通过测试新设备提升自己的武道修炼。\n- **饺子**:希望在不引起麻烦的情况下完成任务,并得到天津饭的认可。\n- **雅木茶**:希望通过参与测试证明自己的价值,同时享受与朋友们的互动。\n\n### 场景描述:\n布尔玛在实验室中展示她的新龙珠雷达,解释其工作原理和优势。孙悟空对设备的功能感到兴奋,但完全无法理解技术细节,不断提出天真的问题。天津饭则严肃地询问设备的安全性和可靠性,表现出对科技的谨慎态度。饺子对复杂的设备感到害怕,不断向天津饭寻求确认和安慰。雅木茶则在一旁调侃大家的反应,试图缓解紧张气氛。布尔玛在解释过程中不断被孙悟空的问题打断,感到无奈,但也被他的热情所感染。最终,大家决定一起外出测试新设备,展开一场充满欢笑和冒险的旅程。
1896
+ * 当前任务状态:排队中、处理中、处理失败或者处理完成。
1897
+
1760
1898
  */
1761
- Description?: string;
1899
+ JobStatusMsg?: string;
1762
1900
  /**
1763
- * 角色描述
1901
+ * 任务处理失败错误码。
1902
+
1764
1903
  */
1765
- Characters?: Array<Character>;
1766
- }
1767
- /**
1768
- * RunThread返回参数结构体
1769
- */
1770
- export interface RunThreadResponse {
1904
+ JobErrorCode?: string;
1771
1905
  /**
1772
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1906
+ * 任务处理失败错误信息。
1907
+
1773
1908
  */
1774
- RequestId?: string;
1775
- }
1776
- /**
1777
- * FilesDeletions请求参数结构体
1778
- */
1779
- export interface FilesDeletionsRequest {
1909
+ JobErrorMsg?: string;
1780
1910
  /**
1781
- * 文件标识符。
1911
+ * 本轮对话的 ChatId,ChatId 用于唯一标识一轮对话。
1912
+ 一个对话组中,最多支持进行100轮对话。
1913
+ 每轮对话数据有效期为7天,到期后 ChatId 失效,有效期内的历史对话数据可通过 History 查询,如有长期使用需求请及时保存输入输出数据。
1782
1914
  */
1783
- ID: string;
1784
- }
1785
- /**
1786
- * FilesList返回参数结构体
1787
- */
1788
- export interface FilesListResponse {
1915
+ ChatId?: string;
1789
1916
  /**
1790
- * 文件数量。
1917
+ * 生成图 URL 列表,有效期7天,请及时保存。
1791
1918
  */
1792
- Total?: number;
1919
+ ResultImage?: Array<string>;
1793
1920
  /**
1794
- * 对象类型,始终为 list。
1921
+ * 结果 detail 数组,Success 代表成功。
1922
+
1795
1923
  */
1796
- Object?: string;
1924
+ ResultDetails?: Array<string>;
1797
1925
  /**
1798
- * FileObject 列表。
1926
+ * 本轮对话前置的历史对话数据(不含生成图)。
1799
1927
  */
1800
- Data?: Array<FileObject>;
1928
+ History?: Array<History>;
1801
1929
  /**
1802
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1930
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId
1803
1931
  */
1804
1932
  RequestId?: string;
1805
1933
  }
1806
1934
  /**
1807
- * GetTokenCount请求参数结构体
1935
+ * GetEmbedding返回参数结构体
1808
1936
  */
1809
- export interface GetTokenCountRequest {
1937
+ export interface GetEmbeddingResponse {
1810
1938
  /**
1811
- * 输入文本
1939
+ * 返回的 Embedding 信息。
1812
1940
  */
1813
- Prompt: string;
1814
- }
1815
- /**
1816
- * TextToImageLite返回参数结构体
1817
- */
1818
- export interface TextToImageLiteResponse {
1941
+ Data?: Array<EmbeddingData>;
1819
1942
  /**
1820
- * 根据入参 RspImgType 填入不同,返回不同的内容。
1821
- 如果传入 base64 则返回生成图 Base64 编码。
1822
- 如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
1943
+ * Token 使用计数,按照总 Token 数量收费。
1823
1944
  */
1824
- ResultImage?: string;
1945
+ Usage?: EmbeddingUsage;
1825
1946
  /**
1826
1947
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1827
1948
  */
1828
1949
  RequestId?: string;
1829
1950
  }
1830
1951
  /**
1831
- * GetThreadMessage请求参数结构体
1952
+ * 会话额外消息
1832
1953
  */
1833
- export interface GetThreadMessageRequest {
1954
+ export interface ThreadAdditionalMessage {
1834
1955
  /**
1835
- * 会话 ID
1956
+ * 角色
1836
1957
  */
1837
- ThreadID: string;
1958
+ Role?: string;
1838
1959
  /**
1839
- * 消息 ID
1960
+ * 内容
1840
1961
  */
1841
- MessageID: string;
1842
- }
1843
- /**
1844
- * CreateThread请求参数结构体
1845
- */
1846
- export declare type CreateThreadRequest = null;
1847
- /**
1848
- * 会话消息附件
1849
- */
1850
- export interface ThreadMessageAttachmentObject {
1962
+ Content?: string;
1851
1963
  /**
1852
- * 文件 ID
1964
+ * 附件
1853
1965
  注意:此字段可能返回 null,表示取不到有效值。
1854
1966
  */
1855
- FileID?: string;
1967
+ Attachments?: Array<ThreadMessageAttachmentObject>;
1856
1968
  }
1857
1969
  /**
1858
- * 时间线
1970
+ * 具体的function调用
1859
1971
  */
1860
- export interface Timeline {
1861
- /**
1862
- * 标题
1863
- 注意:此字段可能返回 null,表示取不到有效值。
1864
- */
1865
- Title?: string;
1972
+ export interface ToolCallFunction {
1866
1973
  /**
1867
- * 时间
1868
- 注意:此字段可能返回 null,表示取不到有效值。
1974
+ * function名称
1869
1975
  */
1870
- Datetime?: string;
1976
+ Name: string;
1871
1977
  /**
1872
- * 相关网页链接
1873
- 注意:此字段可能返回 null,表示取不到有效值。
1978
+ * function参数,一般为json字符串
1874
1979
  */
1875
- Url?: string;
1980
+ Arguments: string;
1876
1981
  }
1877
1982
  /**
1878
- * 相关事件
1983
+ * 相关组织及人物
1879
1984
  */
1880
- export interface RelevantEvent {
1985
+ export interface RelevantEntity {
1881
1986
  /**
1882
- * 相关事件标题
1987
+ * 相关组织及人物名称
1883
1988
  注意:此字段可能返回 null,表示取不到有效值。
1884
1989
  */
1885
- Title: string;
1990
+ Name: string;
1886
1991
  /**
1887
- * 相关事件内容
1992
+ * 相关组织及人物内容
1888
1993
  注意:此字段可能返回 null,表示取不到有效值。
1889
1994
  */
1890
1995
  Content: string;
1891
- /**
1892
- * 相关事件时间
1893
- 注意:此字段可能返回 null,表示取不到有效值。
1894
- */
1895
- Datetime: string;
1896
1996
  /**
1897
1997
  * 相关事件引用文章标号
1898
1998
  注意:此字段可能返回 null,表示取不到有效值。
@@ -1900,106 +2000,105 @@ export interface RelevantEvent {
1900
2000
  Reference: Array<number | bigint>;
1901
2001
  }
1902
2002
  /**
1903
- * 会话内容
2003
+ * CreateThread返回参数结构体
1904
2004
  */
1905
- export interface Message {
1906
- /**
1907
- * 角色,可选值包括 system、user、assistant、 tool。
1908
- */
1909
- Role: string;
2005
+ export interface CreateThreadResponse {
1910
2006
  /**
1911
- * 文本内容
2007
+ * 会话 ID
1912
2008
  */
1913
- Content?: string;
2009
+ ID?: string;
1914
2010
  /**
1915
- * 多种类型内容(目前支持图片和文本),仅 hunyuan-vision 和 hunyuan-turbo-vision 模型支持
1916
- 注意:此字段可能返回 null,表示取不到有效值。
2011
+ * 对象类型
1917
2012
  */
1918
- Contents?: Array<Content>;
2013
+ Object?: string;
1919
2014
  /**
1920
- * 当role为tool时传入,标识具体的函数调用
1921
- 注意:此字段可能返回 null,表示取不到有效值。
2015
+ * 创建时间,Unix 时间戳,单位为秒。
1922
2016
  */
1923
- ToolCallId?: string;
2017
+ CreatedAt?: number;
1924
2018
  /**
1925
- * 模型生成的工具调用,仅 hunyuan-pro 或者 hunyuan-functioncall 模型支持
2019
+ * 提供给工具的资源列表
1926
2020
  注意:此字段可能返回 null,表示取不到有效值。
1927
2021
  */
1928
- ToolCalls?: Array<ToolCall>;
2022
+ ToolResources?: ThreadToolResources;
1929
2023
  /**
1930
- * 文件标识符。单次最大 50 个文件。
1931
- 注意:此字段可能返回 null,表示取不到有效值。
2024
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1932
2025
  */
1933
- FileIDs?: Array<string>;
2026
+ RequestId?: string;
2027
+ }
2028
+ /**
2029
+ * ActivateService返回参数结构体
2030
+ */
2031
+ export interface ActivateServiceResponse {
1934
2032
  /**
1935
- * 思维链内容。用于展示模型思考过程,仅 Hunyuan-T1 系列模型可用。注意:在进行多轮对话时,请**不要**将此字段拼接到 messages 中。请求 messages 的请求参数中包含 reasoning_content,接口将报错。
2033
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1936
2034
  */
1937
- ReasoningContent?: string;
2035
+ RequestId?: string;
1938
2036
  }
1939
2037
  /**
1940
- * 翻译接口会话内容
2038
+ * FilesUploads返回参数结构体
1941
2039
  */
1942
- export interface TranslationMessage {
2040
+ export interface FilesUploadsResponse {
1943
2041
  /**
1944
- * 角色,可选值包括 system、user、assistant、 tool。
2042
+ * 文件标识符,可在各个API中引用。
1945
2043
  */
1946
- Role?: string;
2044
+ ID?: string;
1947
2045
  /**
1948
- * 文本内容
2046
+ * 对象类型,始终为 file。
1949
2047
  */
1950
- Content?: string;
1951
- }
1952
- /**
1953
- * ChatCompletions返回参数结构体
1954
- */
1955
- export interface ChatCompletionsResponse {
2048
+ Object?: string;
1956
2049
  /**
1957
- * Unix 时间戳,单位为秒。
2050
+ * 文件大小,单位为字节。
1958
2051
  */
1959
- Created?: number;
2052
+ Bytes?: number;
1960
2053
  /**
1961
- * Token 统计信息。
1962
- 按照总 Token 数量计费。
2054
+ * 文件创建时的 Unix 时间戳(秒)。
1963
2055
  */
1964
- Usage?: Usage;
2056
+ CreatedAt?: number;
1965
2057
  /**
1966
- * 免责声明。
2058
+ * 文件名。
1967
2059
  */
1968
- Note?: string;
2060
+ Filename?: string;
1969
2061
  /**
1970
- * 本次请求的 RequestId。
2062
+ * 上传文件的用途。
1971
2063
  */
1972
- Id?: string;
2064
+ Purpose?: string;
1973
2065
  /**
1974
- * 回复内容。
2066
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
1975
2067
  */
1976
- Choices?: Array<Choice>;
2068
+ RequestId?: string;
2069
+ }
2070
+ /**
2071
+ * 运行时异常信息。
2072
+ */
2073
+ export interface ErrorMsg {
1977
2074
  /**
1978
- * 错误信息。
1979
- 如果流式返回中服务处理异常,返回该错误信息。
1980
- 注意:此字段可能返回 null,表示取不到有效值。
2075
+ * 错误提示信息。
1981
2076
  */
1982
- ErrorMsg?: ErrorMsg;
2077
+ Msg?: string;
1983
2078
  /**
1984
- * 多轮会话风险审核,值为1时,表明存在信息安全风险,建议终止客户多轮会话。
1985
- * @deprecated
2079
+ * 错误码。
2080
+ 4000 服务内部异常。
2081
+ 4001 请求模型超时。
2082
+
1986
2083
  */
1987
- ModerationLevel?: string;
2084
+ Code?: number;
2085
+ }
2086
+ /**
2087
+ * FilesList返回参数结构体
2088
+ */
2089
+ export interface FilesListResponse {
1988
2090
  /**
1989
- * 搜索结果信息
2091
+ * 文件数量。
1990
2092
  */
1991
- SearchInfo?: SearchInfo;
2093
+ Total?: number;
1992
2094
  /**
1993
- * 多媒体信息。
1994
- 说明:
1995
- 1. 可以用多媒体信息替换回复内容里的占位符,得到完整的消息。
1996
- 2. 可能会出现回复内容里存在占位符,但是因为审核等原因没有返回多媒体信息。
2095
+ * 对象类型,始终为 list。
1997
2096
  */
1998
- Replaces?: Array<Replace>;
2097
+ Object?: string;
1999
2098
  /**
2000
- * 推荐问答。
2099
+ * FileObject 列表。
2001
2100
  */
2002
- RecommendedQuestions?: Array<string>;
2101
+ Data?: Array<FileObject>;
2003
2102
  /**
2004
2103
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
2005
2104
  */
@@ -2019,27 +2118,12 @@ export interface EmbeddingUsage {
2019
2118
  TotalTokens?: number;
2020
2119
  }
2021
2120
  /**
2022
- * QueryHunyuanTo3DJob返回参数结构体
2121
+ * 会话消息附件
2023
2122
  */
2024
- export interface QueryHunyuanTo3DJobResponse {
2025
- /**
2026
- * 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功
2027
- */
2028
- Status?: string;
2029
- /**
2030
- * 生成的3D文件数组
2031
- */
2032
- ResultFile3Ds?: Array<File3Ds>;
2033
- /**
2034
- * 错误码
2035
- */
2036
- ErrorCode?: string;
2037
- /**
2038
- * 错误信息
2039
- */
2040
- ErrorMessage?: string;
2123
+ export interface ThreadMessageAttachmentObject {
2041
2124
  /**
2042
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2125
+ * 文件 ID
2126
+ 注意:此字段可能返回 null,表示取不到有效值。
2043
2127
  */
2044
- RequestId?: string;
2128
+ FileID?: string;
2045
2129
  }