Class: TencentCloud::Hunyuan::V20230901::ChatCompletionsRequest

Inherits:

Common::AbstractModel

Object
Common::AbstractModel
TencentCloud::Hunyuan::V20230901::ChatCompletionsRequest

show all

Extended by:: Gem::Deprecate

Defined in:: lib/v20230901/models.rb

Overview

ChatCompletions请求参数结构体

Instance Attribute Summary collapse

#Citation ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#CustomTool ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#EnableDeepRead ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#EnableDeepSearch ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#EnableEnhancement ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#EnableMultimedia ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#EnableRecommendedQuestions ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#EnableSpeedSearch ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#EnableThinking ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#ForceSearchEnhancement ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#Messages ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#Model ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#SearchInfo ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#Seed ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#Stop ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#Stream ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#StreamModeration ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#Temperature ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#ToolChoice ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#Tools ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#TopicChoice ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#TopP ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.
#WebSearchOptions ⇒ Object

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明： 1.

Instance Method Summary collapse

Constructor Details

#initialize(model = nil, messages = nil, stream = nil, streammoderation = nil, topp = nil, temperature = nil, enableenhancement = nil, tools = nil, toolchoice = nil, customtool = nil, searchinfo = nil, citation = nil, enablespeedsearch = nil, enablemultimedia = nil, enabledeepsearch = nil, seed = nil, forcesearchenhancement = nil, stop = nil, enablerecommendedquestions = nil, enabledeepread = nil, websearchoptions = nil, topicchoice = nil, enablethinking = nil) ⇒ `ChatCompletionsRequest`

Returns a new instance of ChatCompletionsRequest.

# File 'lib/v20230901/models.rb', line 219

def initialize(model=nil, messages=nil, stream=nil, streammoderation=nil, topp=nil, temperature=nil, enableenhancement=nil, tools=nil, toolchoice=nil, customtool=nil, searchinfo=nil, citation=nil, enablespeedsearch=nil, enablemultimedia=nil, enabledeepsearch=nil, seed=nil, forcesearchenhancement=nil, stop=nil, enablerecommendedquestions=nil, enabledeepread=nil, websearchoptions=nil, topicchoice=nil, enablethinking=nil)
  @Model = model
  @Messages = messages
  @Stream = stream
  @StreamModeration = streammoderation
  @TopP = topp
  @Temperature = temperature
  @EnableEnhancement = enableenhancement
  @Tools = tools
  @ToolChoice = toolchoice
  @CustomTool = customtool
  @SearchInfo = searchinfo
  @Citation = citation
  @EnableSpeedSearch = enablespeedsearch
  @EnableMultimedia = enablemultimedia
  @EnableDeepSearch = enabledeepsearch
  @Seed = seed
  @ForceSearchEnhancement = forcesearchenhancement
  @Stop = stop
  @EnableRecommendedQuestions = enablerecommendedquestions
  @EnableDeepRead = enabledeepread
  @WebSearchOptions = websearchoptions
  @TopicChoice = topicchoice
  @EnableThinking = enablethinking
end

Instance Attribute Details

#Citation ⇒ `Object`

**说明：** 未来我们可能会修改此行为以便和 OpenAI 保持一致。但是目前有使用该参数的情况下，开发者需要注意该参数是否会对应用造成影响，以及未来该行为调整时带来的影响。说明：

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def Citation
  @Citation
end

#CustomTool ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def CustomTool
  @CustomTool
end

#EnableDeepRead ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def EnableDeepRead
  @EnableDeepRead
end

#EnableDeepSearch ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def EnableDeepSearch
  @EnableDeepSearch
end

#EnableEnhancement ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def EnableEnhancement
  @EnableEnhancement
end

#EnableMultimedia ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def EnableMultimedia
  @EnableMultimedia
end

#EnableRecommendedQuestions ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def EnableRecommendedQuestions
  @EnableRecommendedQuestions
end

#EnableSpeedSearch ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def EnableSpeedSearch
  @EnableSpeedSearch
end

#EnableThinking ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def EnableThinking
  @EnableThinking
end

#ForceSearchEnhancement ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def ForceSearchEnhancement
  @ForceSearchEnhancement
end

#Messages ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def Messages
  @Messages
end

#Model ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def Model
  @Model
end

#SearchInfo ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def SearchInfo
  @SearchInfo
end

#Seed ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def Seed
  @Seed
end

#Stop ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def Stop
  @Stop
end

#Stream ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def Stream
  @Stream
end

#StreamModeration ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def StreamModeration
  @StreamModeration
end

#Temperature ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def Temperature
  @Temperature
end

#ToolChoice ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def ToolChoice
  @ToolChoice
end

#Tools ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def Tools
  @Tools
end

#TopicChoice ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def TopicChoice
  @TopicChoice
end

#TopP ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def TopP
  @TopP
end

#WebSearchOptions ⇒ `Object`

未传值时默认关闭。
开启后，在返回值的最后一个包中会增加 RecommendedQuestions 字段表示推荐问答，最多返回3条。

Parameters:

EnableRecommendedQuestions: —

推荐问答开关。
EnableDeepRead: —

是否开启深度阅读，默认是false，在值为true时，会返回深度阅读的结果信息。说明:1.深度阅读需要开启插件增强,即设置EnableEnhancement为true,当设置EnableDeepRead为true时EnableEnhancement默认为true；2.目前暂时只支持单文档单轮的深度阅读；3.深度阅读功能的文件上传可以使用FilesUploads接口，具体参数详见FilesUploads接口文档
WebSearchOptions: —

知识注入相关的参数信息
TopicChoice: —

用户传入Topic
EnableThinking: —

模型思维链开关说明： 1. 未传值时默认开启，打开模型思维链推理能力。 2. 关闭后，关闭模型思维链推理能力。开关当前仅对hunyuan-a13b模型生效示例值：ture



212
213
214

# File 'lib/v20230901/models.rb', line 212

def WebSearchOptions
  @WebSearchOptions
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20230901/models.rb', line 245

def deserialize(params)
  @Model = params['Model']
  unless params['Messages'].nil?
    @Messages = []
    params['Messages'].each do |i|
      message_tmp = Message.new
      message_tmp.deserialize(i)
      @Messages << message_tmp
    end
  end
  @Stream = params['Stream']
  @StreamModeration = params['StreamModeration']
  @TopP = params['TopP']
  @Temperature = params['Temperature']
  @EnableEnhancement = params['EnableEnhancement']
  unless params['Tools'].nil?
    @Tools = []
    params['Tools'].each do |i|
      tool_tmp = Tool.new
      tool_tmp.deserialize(i)
      @Tools << tool_tmp
    end
  end
  @ToolChoice = params['ToolChoice']
  unless params['CustomTool'].nil?
    @CustomTool = Tool.new
    @CustomTool.deserialize(params['CustomTool'])
  end
  @SearchInfo = params['SearchInfo']
  @Citation = params['Citation']
  @EnableSpeedSearch = params['EnableSpeedSearch']
  @EnableMultimedia = params['EnableMultimedia']
  @EnableDeepSearch = params['EnableDeepSearch']
  @Seed = params['Seed']
  @ForceSearchEnhancement = params['ForceSearchEnhancement']
  @Stop = params['Stop']
  @EnableRecommendedQuestions = params['EnableRecommendedQuestions']
  @EnableDeepRead = params['EnableDeepRead']
  unless params['WebSearchOptions'].nil?
    @WebSearchOptions = WebSearchOptions.new
    @WebSearchOptions.deserialize(params['WebSearchOptions'])
  end
  @TopicChoice = params['TopicChoice']
  @EnableThinking = params['EnableThinking']
end

Class: TencentCloud::Hunyuan::V20230901::ChatCompletionsRequest

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

#Citation ⇒ Object

#CustomTool ⇒ Object

#EnableDeepRead ⇒ Object

#EnableDeepSearch ⇒ Object

#EnableEnhancement ⇒ Object

#EnableMultimedia ⇒ Object

#EnableRecommendedQuestions ⇒ Object

#EnableSpeedSearch ⇒ Object

#EnableThinking ⇒ Object

#ForceSearchEnhancement ⇒ Object

#Messages ⇒ Object

#Model ⇒ Object

#SearchInfo ⇒ Object

#Seed ⇒ Object

#Stop ⇒ Object

#Stream ⇒ Object

#StreamModeration ⇒ Object

#Temperature ⇒ Object

#ToolChoice ⇒ Object

#Tools ⇒ Object

#TopicChoice ⇒ Object

#TopP ⇒ Object

#WebSearchOptions ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

#Citation ⇒ `Object`

#CustomTool ⇒ `Object`

#EnableDeepRead ⇒ `Object`

#EnableDeepSearch ⇒ `Object`

#EnableEnhancement ⇒ `Object`

#EnableMultimedia ⇒ `Object`

#EnableRecommendedQuestions ⇒ `Object`

#EnableSpeedSearch ⇒ `Object`

#EnableThinking ⇒ `Object`

#ForceSearchEnhancement ⇒ `Object`

#Messages ⇒ `Object`

#Model ⇒ `Object`

#SearchInfo ⇒ `Object`

#Seed ⇒ `Object`

#Stop ⇒ `Object`

#Stream ⇒ `Object`

#StreamModeration ⇒ `Object`

#Temperature ⇒ `Object`

#ToolChoice ⇒ `Object`

#Tools ⇒ `Object`

#TopicChoice ⇒ `Object`

#TopP ⇒ `Object`

#WebSearchOptions ⇒ `Object`

#deserialize(params) ⇒ `Object`