public class ChatCompletionsRequest extends AbstractModel
header, skipSign| Constructor and Description |
|---|
ChatCompletionsRequest() |
ChatCompletionsRequest(ChatCompletionsRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
| Modifier and Type | Method and Description |
|---|---|
Boolean |
getCitation()
Get 搜索引文角标开关。
说明：
1.
|
Tool |
getCustomTool()
Get 强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填
|
Boolean |
getEnableEnhancement()
Get 功能增强（如搜索）开关。
说明：
1.
|
Boolean |
getEnableMultimedia()
Get 多媒体开关。
详细介绍请阅读 [多媒体介绍](https://cloud.tencent.com/document/product/1729/111178) 中的说明。
说明：
1.
|
Boolean |
getEnableSpeedSearch()
Get 是否开启极速版搜索，默认false，不开启；在开启且命中搜索时，会启用极速版搜索，流式输出首字返回更快。
|
Message[] |
getMessages()
Get 聊天上下文信息。
说明：
1.
|
String |
getModel()
Get 模型名称，可选值包括 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) 按需调用。
|
Boolean |
getSearchInfo()
Get 默认是false，在值为true且命中搜索时，接口会返回SearchInfo
|
Boolean |
getStream()
Get 流式调用开关。
说明：
1.
|
Boolean |
getStreamModeration()
Get 流式输出审核开关。
说明：
1.
|
Float |
getTemperature()
Get 说明：
1.
|
String |
getToolChoice()
Get 工具使用选项，可选值包括 none、auto、custom。
说明：
1.
|
Tool[] |
getTools()
Get 可调用的工具列表，仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。
|
Float |
getTopP()
Get 说明：
1.
|
void |
setCitation(Boolean Citation)
Set 搜索引文角标开关。
说明：
1.
|
void |
setCustomTool(Tool CustomTool)
Set 强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填
|
void |
setEnableEnhancement(Boolean EnableEnhancement)
Set 功能增强（如搜索）开关。
说明：
1.
|
void |
setEnableMultimedia(Boolean EnableMultimedia)
Set 多媒体开关。
详细介绍请阅读 [多媒体介绍](https://cloud.tencent.com/document/product/1729/111178) 中的说明。
说明：
1.
|
void |
setEnableSpeedSearch(Boolean EnableSpeedSearch)
Set 是否开启极速版搜索，默认false，不开启；在开启且命中搜索时，会启用极速版搜索，流式输出首字返回更快。
|
void |
setMessages(Message[] Messages)
Set 聊天上下文信息。
说明：
1.
|
void |
setModel(String Model)
Set 模型名称，可选值包括 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) 按需调用。
|
void |
setSearchInfo(Boolean SearchInfo)
Set 默认是false，在值为true且命中搜索时，接口会返回SearchInfo
|
void |
setStream(Boolean Stream)
Set 流式调用开关。
说明：
1.
|
void |
setStreamModeration(Boolean StreamModeration)
Set 流式输出审核开关。
说明：
1.
|
void |
setTemperature(Float Temperature)
Set 说明：
1.
|
void |
setToolChoice(String ToolChoice)
Set 工具使用选项，可选值包括 none、auto、custom。
说明：
1.
|
void |
setTools(Tool[] Tools)
Set 可调用的工具列表，仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。
|
void |
setTopP(Float TopP)
Set 说明：
1.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic ChatCompletionsRequest()
public ChatCompletionsRequest(ChatCompletionsRequest source)
public String getModel()
public void setModel(String Model)
Model - 模型名称，可选值包括 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) 按需调用。public Message[] getMessages()
public void setMessages(Message[] Messages)
Messages - 聊天上下文信息。
说明：
1. 长度最多为 40，按对话时间从旧到新在数组中排列。
2. Message.Role 可选值：system、user、assistant、 tool（functioncall场景）。
其中，system 角色可选，如存在则必须位于列表的最开始。user（tool） 和 assistant 需交替出现（一问一答），以 user 提问开始，user（tool）提问结束，其中tool可以连续出现多次，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user（tool tool ...） assistant user（tool tool ...） ...]。
3. Messages 中 Content 总长度不能超过模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。public Boolean getStream()
public void setStream(Boolean Stream)
Stream - 流式调用开关。
说明：
1. 未传值时默认为非流式调用（false）。
2. 流式调用时以 SSE 协议增量返回结果（返回值取 Choices[n].Delta 中的值，需要拼接增量数据才能获得完整结果）。
3. 非流式调用时：
调用方式与普通 HTTP 请求无异。
接口响应耗时较长，**如需更低时延建议设置为 true**。
只返回一次最终结果（返回值取 Choices[n].Message 中的值）。
注意：
通过 SDK 调用时，流式和非流式调用需用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。public Boolean getStreamModeration()
public void setStreamModeration(Boolean StreamModeration)
StreamModeration - 流式输出审核开关。
说明：
1. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
2. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。未传值时默认为流式模式（true）。
3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
4. 如果值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
注意：
当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。public Float getTopP()
public void setTopP(Float TopP)
TopP - 说明：
1. 影响输出文本的多样性。模型已有默认参数，不传值时使用各模型推荐值，不推荐用户修改。
2. 取值区间为 [0.0, 1.0]。取值越大，生成文本的多样性越强。public Float getTemperature()
public void setTemperature(Float Temperature)
Temperature - 说明：
1. 影响模型输出多样性，模型已有默认参数，不传值时使用各模型推荐值，不推荐用户修改。
2. 取值区间为 [0.0, 2.0]。较高的数值会使输出更加多样化和不可预测，而较低的数值会使其更加集中和确定。public Boolean getEnableEnhancement()
public void setEnableEnhancement(Boolean EnableEnhancement)
EnableEnhancement - 功能增强（如搜索）开关。
说明：
1. hunyuan-lite 无功能增强（如搜索）能力，该参数对 hunyuan-lite 版本不生效。
2. 未传值时默认打开开关。
3. 关闭时将直接由主模型生成回复内容，可以降低响应时延（对于流式输出时的首字时延尤为明显）。但在少数场景里，回复效果可能会下降。
4. 安全审核能力不属于功能增强范围，不受此字段影响。public Tool[] getTools()
public void setTools(Tool[] Tools)
Tools - 可调用的工具列表，仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。public String getToolChoice()
public void setToolChoice(String ToolChoice)
ToolChoice - 工具使用选项，可选值包括 none、auto、custom。
说明：
1. 仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。
2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。
3. 未设置时，默认值为autopublic Tool getCustomTool()
public void setCustomTool(Tool CustomTool)
CustomTool - 强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填public Boolean getSearchInfo()
public void setSearchInfo(Boolean SearchInfo)
SearchInfo - 默认是false，在值为true且命中搜索时，接口会返回SearchInfopublic Boolean getCitation()
public void setCitation(Boolean Citation)
Citation - 搜索引文角标开关。
说明：
1. 配合EnableEnhancement和SearchInfo参数使用。打开后，回答中命中搜索的结果会在片段后增加角标标志，对应SearchInfo列表中的链接。
2. false：开关关闭，true：开关打开。
3. 未传值时默认开关关闭（false）。public Boolean getEnableSpeedSearch()
public void setEnableSpeedSearch(Boolean EnableSpeedSearch)
EnableSpeedSearch - 是否开启极速版搜索，默认false，不开启；在开启且命中搜索时，会启用极速版搜索，流式输出首字返回更快。public Boolean getEnableMultimedia()
public void setEnableMultimedia(Boolean EnableMultimedia)
EnableMultimedia - 多媒体开关。
详细介绍请阅读 [多媒体介绍](https://cloud.tencent.com/document/product/1729/111178) 中的说明。
说明：
1. 该参数目前仅对白名单内用户生效，如您想体验该功能请 [联系我们](https://cloud.tencent.com/act/event/Online_service)。
2. 该参数仅在功能增强（如搜索）开关开启（EnableEnhancement=true）并且极速版搜索开关关闭（EnableSpeedSearch=false）时生效。
3. hunyuan-lite 无多媒体能力，该参数对 hunyuan-lite 版本不生效。
4. 未传值时默认关闭。
5. 开启并搜索到对应的多媒体信息时，会输出对应的多媒体地址，可以定制个性化的图文消息。Copyright © 2024. All rights reserved.