Class: TencentCloud::Es::V20250101::ChatCompletionsRequest

Inherits:

Common::AbstractModel

Object
Common::AbstractModel
TencentCloud::Es::V20250101::ChatCompletionsRequest

show all

Defined in:: lib/v20250101/models.rb

Overview

ChatCompletions请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

#deserialize(params) ⇒ Object
#initialize(messages = nil, modelname = nil, stream = nil, topp = nil, temperature = nil, onlinesearch = nil, onlinesearchoptions = nil, tools = nil, toolchoice = nil, customtool = nil) ⇒ ChatCompletionsRequest constructor

A new instance of ChatCompletionsRequest.

Constructor Details

#initialize(messages = nil, modelname = nil, stream = nil, topp = nil, temperature = nil, onlinesearch = nil, onlinesearchoptions = nil, tools = nil, toolchoice = nil, customtool = nil) ⇒ `ChatCompletionsRequest`

Returns a new instance of ChatCompletionsRequest.

# File 'lib/v20250101/models.rb', line 45

def initialize(messages=nil, modelname=nil, stream=nil, topp=nil, temperature=nil, onlinesearch=nil, onlinesearchoptions=nil, tools=nil, toolchoice=nil, customtool=nil)
  @Messages = messages
  @ModelName = modelname
  @Stream = stream
  @TopP = topp
  @Temperature = temperature
  @OnlineSearch = onlinesearch
  @OnlineSearchOptions = onlinesearchoptions
  @Tools = tools
  @ToolChoice = toolchoice
  @CustomTool = customtool
end

Instance Attribute Details

#CustomTool ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def CustomTool
  @CustomTool
end

#Messages ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def Messages
  @Messages
end

#ModelName ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def ModelName
  @ModelName
end

#OnlineSearch ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def OnlineSearch
  @OnlineSearch
end

#OnlineSearchOptions ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def OnlineSearchOptions
  @OnlineSearchOptions
end

#Stream ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def Stream
  @Stream
end

#Temperature ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def Temperature
  @Temperature
end

#ToolChoice ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def ToolChoice
  @ToolChoice
end

#Tools ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def Tools
  @Tools
end

#TopP ⇒ `Object`

Parameters:

Messages: —

会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
ModelName: —

模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
Stream: —

是否以流式接口的形式返回数据，默认true。
TopP: —

取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果。
Temperature: —

取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果。
OnlineSearch: —

是否开启联网搜索。默认为 false。
OnlineSearchOptions: —

当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
Tools: —

可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。
ToolChoice: —

工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto
CustomTool: —

强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填



43
44
45

# File 'lib/v20250101/models.rb', line 43

def TopP
  @TopP
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20250101/models.rb', line 58

def deserialize(params)
  unless params['Messages'].nil?
    @Messages = []
    params['Messages'].each do |i|
      message_tmp = Message.new
      message_tmp.deserialize(i)
      @Messages << message_tmp
    end
  end
  @ModelName = params['ModelName']
  @Stream = params['Stream']
  @TopP = params['TopP']
  @Temperature = params['Temperature']
  @OnlineSearch = params['OnlineSearch']
  unless params['OnlineSearchOptions'].nil?
    @OnlineSearchOptions = OnlineSearchOptions.new
    @OnlineSearchOptions.deserialize(params['OnlineSearchOptions'])
  end
  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
end

Class: TencentCloud::Es::V20250101::ChatCompletionsRequest

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(messages = nil, modelname = nil, stream = nil, topp = nil, temperature = nil, onlinesearch = nil, onlinesearchoptions = nil, tools = nil, toolchoice = nil, customtool = nil) ⇒ ChatCompletionsRequest

Instance Attribute Details

#CustomTool ⇒ Object

#Messages ⇒ Object

#ModelName ⇒ Object

#OnlineSearch ⇒ Object

#OnlineSearchOptions ⇒ Object

#Stream ⇒ Object

#Temperature ⇒ Object

#ToolChoice ⇒ Object

#Tools ⇒ Object

#TopP ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

#initialize(messages = nil, modelname = nil, stream = nil, topp = nil, temperature = nil, onlinesearch = nil, onlinesearchoptions = nil, tools = nil, toolchoice = nil, customtool = nil) ⇒ `ChatCompletionsRequest`

#CustomTool ⇒ `Object`

#Messages ⇒ `Object`

#ModelName ⇒ `Object`

#OnlineSearch ⇒ `Object`

#OnlineSearchOptions ⇒ `Object`

#Stream ⇒ `Object`

#Temperature ⇒ `Object`

#ToolChoice ⇒ `Object`

#Tools ⇒ `Object`

#TopP ⇒ `Object`

#deserialize(params) ⇒ `Object`