hunyuan

package
v0.0.0-...-9473012 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 3, 2024 License: GPL-3.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// 引擎层请求超时；请稍后重试。
	FAILEDOPERATION_ENGINEREQUESTTIMEOUT = "FailedOperation.EngineRequestTimeout"

	// 引擎层内部错误；请稍后重试。
	FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"

	// 引擎层请求超过限额；请稍后重试。
	FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"

	// 免费资源包余量已用尽，请购买资源包或开通后付费。
	FAILEDOPERATION_FREERESOURCEPACKEXHAUSTED = "FailedOperation.FreeResourcePackExhausted"

	// 资源包余量已用尽，请购买资源包或开通后付费。
	FAILEDOPERATION_RESOURCEPACKEXHAUSTED = "FailedOperation.ResourcePackExhausted"

	// 服务未开通，请前往控制台申请试用。
	FAILEDOPERATION_SERVICENOTACTIVATED = "FailedOperation.ServiceNotActivated"

	// 用户主动停服。
	FAILEDOPERATION_SERVICESTOP = "FailedOperation.ServiceStop"

	// 欠费停服。
	FAILEDOPERATION_SERVICESTOPARREARS = "FailedOperation.ServiceStopArrears"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// 模型不存在。
	INVALIDPARAMETERVALUE_MODEL = "InvalidParameterValue.Model"

	// 超过配额限制。
	LIMITEXCEEDED = "LimitExceeded"
)
View Source 
const APIVersion = "2023-09-01"

Variables

This section is empty.

Functions

This section is empty.

Types

type ChatCompletionsRequest 

type ChatCompletionsRequest struct {
	*tchttp.BaseRequest

	// 模型名称，可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro。
	// 各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。
	//
	// 注意：
	// 不同的模型计费不同，请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
	Model *string `json:"Model,omitnil,omitempty" name:"Model"`

	// 聊天上下文信息。
	// 说明：
	// 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
	// 2. Message.Role 可选值：system、user、assistant。
	// 其中，system 角色可选，如存在则必须位于列表的最开始。user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。
	// 3. Messages 中 Content 总长度不能超过模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
	Messages []*Message `json:"Messages,omitnil,omitempty" name:"Messages"`

	// 流式调用开关。
	// 说明：
	// 1. 未传值时默认为非流式调用（false）。
	// 2. 流式调用时以 SSE 协议增量返回结果（返回值取 Choices[n].Delta 中的值，需要拼接增量数据才能获得完整结果）。
	// 3. 非流式调用时：
	// 调用方式与普通 HTTP 请求无异。
	// 接口响应耗时较长，**如需更低时延建议设置为 true**。
	// 只返回一次最终结果（返回值取 Choices[n].Message 中的值）。
	//
	// 注意：
	// 通过 SDK 调用时，流式和非流式调用需用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
	Stream *bool `json:"Stream,omitnil,omitempty" name:"Stream"`

	// 流式输出审核开关。
	// 说明：
	// 1. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
	// 2. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。未传值时默认为流式模式（true）。
	// 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
	// 4. 如果值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
	//
	// 注意：
	// 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
	StreamModeration *bool `json:"StreamModeration,omitnil,omitempty" name:"StreamModeration"`

	// 说明：
	// 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
	// 2. 默认 1.0，取值区间为 [0.0, 1.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	TopP *float64 `json:"TopP,omitnil,omitempty" name:"TopP"`

	// 说明：
	// 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
	// 2. 默认 1.0，取值区间为 [0.0, 2.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	Temperature *float64 `json:"Temperature,omitnil,omitempty" name:"Temperature"`
}

func NewChatCompletionsRequest 

func NewChatCompletionsRequest() (request *ChatCompletionsRequest)

func (*ChatCompletionsRequest) FromJsonString 

func (r *ChatCompletionsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChatCompletionsRequest) ToJsonString 

func (r *ChatCompletionsRequest) ToJsonString() string

type ChatCompletionsRequestParams 

type ChatCompletionsRequestParams struct {
	// 模型名称，可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro。
	// 各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。
	//
	// 注意：
	// 不同的模型计费不同，请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
	Model *string `json:"Model,omitnil,omitempty" name:"Model"`

	// 聊天上下文信息。
	// 说明：
	// 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
	// 2. Message.Role 可选值：system、user、assistant。
	// 其中，system 角色可选，如存在则必须位于列表的最开始。user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。
	// 3. Messages 中 Content 总长度不能超过模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
	Messages []*Message `json:"Messages,omitnil,omitempty" name:"Messages"`

	// 流式调用开关。
	// 说明：
	// 1. 未传值时默认为非流式调用（false）。
	// 2. 流式调用时以 SSE 协议增量返回结果（返回值取 Choices[n].Delta 中的值，需要拼接增量数据才能获得完整结果）。
	// 3. 非流式调用时：
	// 调用方式与普通 HTTP 请求无异。
	// 接口响应耗时较长，**如需更低时延建议设置为 true**。
	// 只返回一次最终结果（返回值取 Choices[n].Message 中的值）。
	//
	// 注意：
	// 通过 SDK 调用时，流式和非流式调用需用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
	Stream *bool `json:"Stream,omitnil,omitempty" name:"Stream"`

	// 流式输出审核开关。
	// 说明：
	// 1. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
	// 2. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。未传值时默认为流式模式（true）。
	// 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
	// 4. 如果值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
	//
	// 注意：
	// 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
	StreamModeration *bool `json:"StreamModeration,omitnil,omitempty" name:"StreamModeration"`

	// 说明：
	// 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
	// 2. 默认 1.0，取值区间为 [0.0, 1.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	TopP *float64 `json:"TopP,omitnil,omitempty" name:"TopP"`

	// 说明：
	// 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
	// 2. 默认 1.0，取值区间为 [0.0, 2.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	Temperature *float64 `json:"Temperature,omitnil,omitempty" name:"Temperature"`
}

Predefined struct for user

type ChatCompletionsResponse 

type ChatCompletionsResponse struct {
	tchttp.BaseSSEResponse `json:"-"`
	Response               *ChatCompletionsResponseParams `json:"Response"`
}

func NewChatCompletionsResponse 

func NewChatCompletionsResponse() (response *ChatCompletionsResponse)

func (*ChatCompletionsResponse) FromJsonString 

func (r *ChatCompletionsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChatCompletionsResponse) ToJsonString 

func (r *ChatCompletionsResponse) ToJsonString() string

type ChatCompletionsResponseParams 

type ChatCompletionsResponseParams struct {
	// Unix 时间戳，单位为秒。
	Created *int64 `json:"Created,omitnil,omitempty" name:"Created"`

	// Token 统计信息。
	// 按照总 Token 数量计费。
	Usage *Usage `json:"Usage,omitnil,omitempty" name:"Usage"`

	// 免责声明。
	Note *string `json:"Note,omitnil,omitempty" name:"Note"`

	// 本轮对话的 ID。
	Id *string `json:"Id,omitnil,omitempty" name:"Id"`

	// 回复内容。
	Choices []*Choice `json:"Choices,omitnil,omitempty" name:"Choices"`

	// 错误信息。
	// 如果流式返回中服务处理异常，返回该错误信息。
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *ErrorMsg `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChatProRequest 

type ChatProRequest struct {
	*tchttp.BaseRequest

	// 聊天上下文信息。
	// 说明：
	// 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
	// 2. Message.Role 可选值：system、user、assistant。
	// 其中，system 角色可选，如存在则必须位于列表的最开始。user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。
	// 3. Messages 中 Content 总长度不能超过 hunyuan-pro 模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
	Messages []*Message `json:"Messages,omitnil,omitempty" name:"Messages"`

	// 说明：
	// 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
	// 2. 默认 1.0，取值区间为 [0.0, 1.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	TopP *float64 `json:"TopP,omitnil,omitempty" name:"TopP"`

	// 说明：
	// 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
	// 2. 默认 1.0，取值区间为 [0.0, 2.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	Temperature *float64 `json:"Temperature,omitnil,omitempty" name:"Temperature"`

	// 流式调用开关。
	// 说明：
	// 1. 未传值时默认为流式调用。
	// 2. 流式调用时以 SSE 协议增量返回结果。
	// 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
	// 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
	//
	// 注意：
	// 通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
	Stream *bool `json:"Stream,omitnil,omitempty" name:"Stream"`

	// 流式输出审核开关。
	// 说明：
	// 1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
	// 2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
	// 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
	// 4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
	//
	// 注意：
	// 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
	StreamModeration *bool `json:"StreamModeration,omitnil,omitempty" name:"StreamModeration"`
}

func NewChatProRequest 

func NewChatProRequest() (request *ChatProRequest)

func (*ChatProRequest) FromJsonString 

func (r *ChatProRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChatProRequest) ToJsonString 

func (r *ChatProRequest) ToJsonString() string

type ChatProRequestParams 

type ChatProRequestParams struct {
	// 聊天上下文信息。
	// 说明：
	// 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
	// 2. Message.Role 可选值：system、user、assistant。
	// 其中，system 角色可选，如存在则必须位于列表的最开始。user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。
	// 3. Messages 中 Content 总长度不能超过 hunyuan-pro 模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
	Messages []*Message `json:"Messages,omitnil,omitempty" name:"Messages"`

	// 说明：
	// 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
	// 2. 默认 1.0，取值区间为 [0.0, 1.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	TopP *float64 `json:"TopP,omitnil,omitempty" name:"TopP"`

	// 说明：
	// 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
	// 2. 默认 1.0，取值区间为 [0.0, 2.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	Temperature *float64 `json:"Temperature,omitnil,omitempty" name:"Temperature"`

	// 流式调用开关。
	// 说明：
	// 1. 未传值时默认为流式调用。
	// 2. 流式调用时以 SSE 协议增量返回结果。
	// 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
	// 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
	//
	// 注意：
	// 通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
	Stream *bool `json:"Stream,omitnil,omitempty" name:"Stream"`

	// 流式输出审核开关。
	// 说明：
	// 1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
	// 2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
	// 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
	// 4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
	//
	// 注意：
	// 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
	StreamModeration *bool `json:"StreamModeration,omitnil,omitempty" name:"StreamModeration"`
}

Predefined struct for user

type ChatProResponse 

type ChatProResponse struct {
	tchttp.BaseSSEResponse `json:"-"`
	Response               *ChatProResponseParams `json:"Response"`
}

func NewChatProResponse 

func NewChatProResponse() (response *ChatProResponse)

func (*ChatProResponse) FromJsonString 

func (r *ChatProResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChatProResponse) ToJsonString 

func (r *ChatProResponse) ToJsonString() string

type ChatProResponseParams 

type ChatProResponseParams struct {
	// Unix 时间戳，单位为秒。
	Created *int64 `json:"Created,omitnil,omitempty" name:"Created"`

	// Token 统计信息。
	// 按照总 Token 数量计费。
	Usage *Usage `json:"Usage,omitnil,omitempty" name:"Usage"`

	// 免责声明。
	Note *string `json:"Note,omitnil,omitempty" name:"Note"`

	// 本轮对话的 ID。
	Id *string `json:"Id,omitnil,omitempty" name:"Id"`

	// 回复内容。
	Choices []*Choice `json:"Choices,omitnil,omitempty" name:"Choices"`

	// 错误信息。
	// 如果流式返回中服务处理异常，返回该错误信息。
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *ErrorMsg `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChatStdRequest 

type ChatStdRequest struct {
	*tchttp.BaseRequest

	// 聊天上下文信息。
	// 说明：
	// 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
	// 2. Message 的 Role 当前可选值：user、assistant。
	// 其中，user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[user assistant user assistant user ...]。
	// 3. Messages 中 Content 总长度不能超过 hunyuan-standard 模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
	Messages []*Message `json:"Messages,omitnil,omitempty" name:"Messages"`

	// 说明：
	// 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
	// 2. 默认 1.0，取值区间为 [0.0, 1.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	TopP *float64 `json:"TopP,omitnil,omitempty" name:"TopP"`

	// 说明：
	// 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
	// 2. 默认 1.0，取值区间为 [0.0, 2.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	Temperature *float64 `json:"Temperature,omitnil,omitempty" name:"Temperature"`

	// 流式调用开关。
	// 说明：
	// 1. 未传值时默认为流式调用。
	// 2. 流式调用时以 SSE 协议增量返回结果。
	// 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
	// 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
	//
	// 注意：
	// 通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
	Stream *bool `json:"Stream,omitnil,omitempty" name:"Stream"`

	// 流式输出审核开关。
	// 说明：
	// 1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
	// 2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
	// 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
	// 4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
	//
	// 注意：
	// 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
	StreamModeration *bool `json:"StreamModeration,omitnil,omitempty" name:"StreamModeration"`
}

func NewChatStdRequest 

func NewChatStdRequest() (request *ChatStdRequest)

func (*ChatStdRequest) FromJsonString 

func (r *ChatStdRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChatStdRequest) ToJsonString 

func (r *ChatStdRequest) ToJsonString() string

type ChatStdRequestParams 

type ChatStdRequestParams struct {
	// 聊天上下文信息。
	// 说明：
	// 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
	// 2. Message 的 Role 当前可选值：user、assistant。
	// 其中，user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[user assistant user assistant user ...]。
	// 3. Messages 中 Content 总长度不能超过 hunyuan-standard 模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
	Messages []*Message `json:"Messages,omitnil,omitempty" name:"Messages"`

	// 说明：
	// 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
	// 2. 默认 1.0，取值区间为 [0.0, 1.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	TopP *float64 `json:"TopP,omitnil,omitempty" name:"TopP"`

	// 说明：
	// 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
	// 2. 默认 1.0，取值区间为 [0.0, 2.0]。
	// 3. 非必要不建议使用，不合理的取值会影响效果。
	Temperature *float64 `json:"Temperature,omitnil,omitempty" name:"Temperature"`

	// 流式调用开关。
	// 说明：
	// 1. 未传值时默认为流式调用。
	// 2. 流式调用时以 SSE 协议增量返回结果。
	// 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
	// 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
	//
	// 注意：
	// 通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
	Stream *bool `json:"Stream,omitnil,omitempty" name:"Stream"`

	// 流式输出审核开关。
	// 说明：
	// 1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
	// 2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
	// 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
	// 4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
	//
	// 注意：
	// 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
	StreamModeration *bool `json:"StreamModeration,omitnil,omitempty" name:"StreamModeration"`
}

Predefined struct for user

type ChatStdResponse 

type ChatStdResponse struct {
	tchttp.BaseSSEResponse `json:"-"`
	Response               *ChatStdResponseParams `json:"Response"`
}

func NewChatStdResponse 

func NewChatStdResponse() (response *ChatStdResponse)

func (*ChatStdResponse) FromJsonString 

func (r *ChatStdResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChatStdResponse) ToJsonString 

func (r *ChatStdResponse) ToJsonString() string

type ChatStdResponseParams 

type ChatStdResponseParams struct {
	// Unix 时间戳，单位为秒。
	Created *int64 `json:"Created,omitnil,omitempty" name:"Created"`

	// Token 统计信息。
	// 按照总 Token 数量计费。
	Usage *Usage `json:"Usage,omitnil,omitempty" name:"Usage"`

	// 免责声明。
	Note *string `json:"Note,omitnil,omitempty" name:"Note"`

	// 本轮对话的 ID。
	Id *string `json:"Id,omitnil,omitempty" name:"Id"`

	// 回复内容。
	Choices []*Choice `json:"Choices,omitnil,omitempty" name:"Choices"`

	// 错误信息。
	// 如果流式返回中服务处理异常，返回该错误信息。
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *ErrorMsg `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Choice 

type Choice struct {
	// 结束标志位，可能为 stop 或 sensitive。
	// stop 表示输出正常结束，sensitive 只在开启流式输出审核时会出现，表示安全审核未通过。
	FinishReason *string `json:"FinishReason,omitnil,omitempty" name:"FinishReason"`

	// 增量返回值，流式调用时使用该字段。
	// 注意：此字段可能返回 null，表示取不到有效值。
	Delta *Delta `json:"Delta,omitnil,omitempty" name:"Delta"`

	// 返回值，非流式调用时使用该字段。
	// 注意：此字段可能返回 null，表示取不到有效值。
	Message *Message `json:"Message,omitnil,omitempty" name:"Message"`
}

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ChatCompletions 

func (c *Client) ChatCompletions(request *ChatCompletionsRequest) (response *ChatCompletionsResponse, err error)

ChatCompletions 腾讯混元大模型是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。

  1. 本接口暂不支持返回图片内容。

  2. 默认每种模型单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。

  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。

可能返回的错误码: 

FAILEDOPERATION_ENGINEREQUESTTIMEOUT = "FailedOperation.EngineRequestTimeout"
FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"
FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"
FAILEDOPERATION_FREERESOURCEPACKEXHAUSTED = "FailedOperation.FreeResourcePackExhausted"
FAILEDOPERATION_RESOURCEPACKEXHAUSTED = "FailedOperation.ResourcePackExhausted"
FAILEDOPERATION_SERVICENOTACTIVATED = "FailedOperation.ServiceNotActivated"
FAILEDOPERATION_SERVICESTOP = "FailedOperation.ServiceStop"
FAILEDOPERATION_SERVICESTOPARREARS = "FailedOperation.ServiceStopArrears"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_MODEL = "InvalidParameterValue.Model"
LIMITEXCEEDED = "LimitExceeded"

func (*Client) ChatCompletionsWithContext 

func (c *Client) ChatCompletionsWithContext(ctx context.Context, request *ChatCompletionsRequest) (response *ChatCompletionsResponse, err error)

ChatCompletions 腾讯混元大模型是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。

  1. 本接口暂不支持返回图片内容。

  2. 默认每种模型单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。

  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。

可能返回的错误码: 

FAILEDOPERATION_ENGINEREQUESTTIMEOUT = "FailedOperation.EngineRequestTimeout"
FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"
FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"
FAILEDOPERATION_FREERESOURCEPACKEXHAUSTED = "FailedOperation.FreeResourcePackExhausted"
FAILEDOPERATION_RESOURCEPACKEXHAUSTED = "FailedOperation.ResourcePackExhausted"
FAILEDOPERATION_SERVICENOTACTIVATED = "FailedOperation.ServiceNotActivated"
FAILEDOPERATION_SERVICESTOP = "FailedOperation.ServiceStop"
FAILEDOPERATION_SERVICESTOPARREARS = "FailedOperation.ServiceStopArrears"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_MODEL = "InvalidParameterValue.Model"
LIMITEXCEEDED = "LimitExceeded"

func (*Client) ChatPro 

func (c *Client) ChatPro(request *ChatProRequest) (response *ChatProResponse, err error)

ChatPro <span style="font-size:1.5em;">注意：本接口将于 5 月 15 日下线；下线后将不再提供文档指引，接口本身可继续调用，建议使用 hunyuan(https://cloud.tencent.com/document/api/1729/105701) 接入。</span>

腾讯混元大模型（hunyuan-pro）是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。

  1. 本接口暂不支持返回图片内容。

  2. 默认单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。

  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。

可能返回的错误码: 

FAILEDOPERATION_ENGINEREQUESTTIMEOUT = "FailedOperation.EngineRequestTimeout"
FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"
FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"
FAILEDOPERATION_FREERESOURCEPACKEXHAUSTED = "FailedOperation.FreeResourcePackExhausted"
FAILEDOPERATION_RESOURCEPACKEXHAUSTED = "FailedOperation.ResourcePackExhausted"
FAILEDOPERATION_SERVICENOTACTIVATED = "FailedOperation.ServiceNotActivated"
FAILEDOPERATION_SERVICESTOP = "FailedOperation.ServiceStop"
FAILEDOPERATION_SERVICESTOPARREARS = "FailedOperation.ServiceStopArrears"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"

func (*Client) ChatProWithContext 

func (c *Client) ChatProWithContext(ctx context.Context, request *ChatProRequest) (response *ChatProResponse, err error)

ChatPro <span style="font-size:1.5em;">注意：本接口将于 5 月 15 日下线；下线后将不再提供文档指引，接口本身可继续调用，建议使用 hunyuan(https://cloud.tencent.com/document/api/1729/105701) 接入。</span>

腾讯混元大模型（hunyuan-pro）是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。

  1. 本接口暂不支持返回图片内容。

  2. 默认单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。

  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。

可能返回的错误码: 

FAILEDOPERATION_ENGINEREQUESTTIMEOUT = "FailedOperation.EngineRequestTimeout"
FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"
FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"
FAILEDOPERATION_FREERESOURCEPACKEXHAUSTED = "FailedOperation.FreeResourcePackExhausted"
FAILEDOPERATION_RESOURCEPACKEXHAUSTED = "FailedOperation.ResourcePackExhausted"
FAILEDOPERATION_SERVICENOTACTIVATED = "FailedOperation.ServiceNotActivated"
FAILEDOPERATION_SERVICESTOP = "FailedOperation.ServiceStop"
FAILEDOPERATION_SERVICESTOPARREARS = "FailedOperation.ServiceStopArrears"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"

func (*Client) ChatStd 

func (c *Client) ChatStd(request *ChatStdRequest) (response *ChatStdResponse, err error)

ChatStd <span style="font-size:1.5em;">注意：本接口将于 5 月 15 日下线；下线后将不再提供文档指引，接口本身可继续调用，建议使用 hunyuan(https://cloud.tencent.com/document/api/1729/105701) 接入。</span>

腾讯混元大模型标准版是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。

  1. 本接口暂不支持返回图片内容。

  2. 默认单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。

  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。

可能返回的错误码: 

FAILEDOPERATION_ENGINEREQUESTTIMEOUT = "FailedOperation.EngineRequestTimeout"
FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"
FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"
FAILEDOPERATION_FREERESOURCEPACKEXHAUSTED = "FailedOperation.FreeResourcePackExhausted"
FAILEDOPERATION_RESOURCEPACKEXHAUSTED = "FailedOperation.ResourcePackExhausted"
FAILEDOPERATION_SERVICENOTACTIVATED = "FailedOperation.ServiceNotActivated"
FAILEDOPERATION_SERVICESTOP = "FailedOperation.ServiceStop"
FAILEDOPERATION_SERVICESTOPARREARS = "FailedOperation.ServiceStopArrears"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"

func (*Client) ChatStdWithContext 

func (c *Client) ChatStdWithContext(ctx context.Context, request *ChatStdRequest) (response *ChatStdResponse, err error)

ChatStd <span style="font-size:1.5em;">注意：本接口将于 5 月 15 日下线；下线后将不再提供文档指引，接口本身可继续调用，建议使用 hunyuan(https://cloud.tencent.com/document/api/1729/105701) 接入。</span>

腾讯混元大模型标准版是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。

  1. 本接口暂不支持返回图片内容。

  2. 默认单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。

  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。

可能返回的错误码: 

FAILEDOPERATION_ENGINEREQUESTTIMEOUT = "FailedOperation.EngineRequestTimeout"
FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"
FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"
FAILEDOPERATION_FREERESOURCEPACKEXHAUSTED = "FailedOperation.FreeResourcePackExhausted"
FAILEDOPERATION_RESOURCEPACKEXHAUSTED = "FailedOperation.ResourcePackExhausted"
FAILEDOPERATION_SERVICENOTACTIVATED = "FailedOperation.ServiceNotActivated"
FAILEDOPERATION_SERVICESTOP = "FailedOperation.ServiceStop"
FAILEDOPERATION_SERVICESTOPARREARS = "FailedOperation.ServiceStopArrears"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"

func (*Client) GetEmbedding 

func (c *Client) GetEmbedding(request *GetEmbeddingRequest) (response *GetEmbeddingResponse, err error)

GetEmbedding 腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。

可能返回的错误码: 

FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"
FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) GetEmbeddingWithContext 

func (c *Client) GetEmbeddingWithContext(ctx context.Context, request *GetEmbeddingRequest) (response *GetEmbeddingResponse, err error)

GetEmbedding 腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。

可能返回的错误码: 

FAILEDOPERATION_ENGINESERVERERROR = "FailedOperation.EngineServerError"
FAILEDOPERATION_ENGINESERVERLIMITEXCEEDED = "FailedOperation.EngineServerLimitExceeded"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) GetTokenCount 

func (c *Client) GetTokenCount(request *GetTokenCountRequest) (response *GetTokenCountResponse, err error)

GetTokenCount 该接口用于计算文本对应Token数、字符数。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

func (*Client) GetTokenCountWithContext 

func (c *Client) GetTokenCountWithContext(ctx context.Context, request *GetTokenCountRequest) (response *GetTokenCountResponse, err error)

GetTokenCount 该接口用于计算文本对应Token数、字符数。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

func (*Client) QueryHunyuanImageJob 

func (c *Client) QueryHunyuanImageJob(request *QueryHunyuanImageJobRequest) (response *QueryHunyuanImageJobResponse, err error)

QueryHunyuanImageJob 混元生图接口基于混元大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。

提交任务：输入文本等，提交一个混元生图异步任务，获得任务 ID。

查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。

并发任务数（并发）说明：并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

func (*Client) QueryHunyuanImageJobWithContext 

func (c *Client) QueryHunyuanImageJobWithContext(ctx context.Context, request *QueryHunyuanImageJobRequest) (response *QueryHunyuanImageJobResponse, err error)

QueryHunyuanImageJob 混元生图接口基于混元大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。

提交任务：输入文本等，提交一个混元生图异步任务，获得任务 ID。

查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。

并发任务数（并发）说明：并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

func (*Client) SubmitHunyuanImageJob 

func (c *Client) SubmitHunyuanImageJob(request *SubmitHunyuanImageJobRequest) (response *SubmitHunyuanImageJobResponse, err error)

SubmitHunyuanImageJob 混元生图接口基于混元大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。

提交任务：输入文本等，提交一个混元生图异步任务，获得任务 ID。

查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。

并发任务数（并发）说明：并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

func (*Client) SubmitHunyuanImageJobWithContext 

func (c *Client) SubmitHunyuanImageJobWithContext(ctx context.Context, request *SubmitHunyuanImageJobRequest) (response *SubmitHunyuanImageJobResponse, err error)

SubmitHunyuanImageJob 混元生图接口基于混元大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。

提交任务：输入文本等，提交一个混元生图异步任务，获得任务 ID。

查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。

并发任务数（并发）说明：并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

type Delta 

type Delta struct {
	// 角色名称。
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`

	// 内容详情。
	Content *string `json:"Content,omitnil,omitempty" name:"Content"`
}

type EmbeddingData 

type EmbeddingData struct {
	// embedding 信息。
	// 注意：此字段可能返回 null，表示取不到有效值。
	Embedding []*float64 `json:"Embedding,omitnil,omitempty" name:"Embedding"`

	// 下标。
	// 注意：此字段可能返回 null，表示取不到有效值。
	Index *int64 `json:"Index,omitnil,omitempty" name:"Index"`

	// embedding
	// 注意：此字段可能返回 null，表示取不到有效值。
	Object *string `json:"Object,omitnil,omitempty" name:"Object"`
}

type EmbeddingUsage 

type EmbeddingUsage struct {
	// 输入 Token 数。
	PromptTokens *int64 `json:"PromptTokens,omitnil,omitempty" name:"PromptTokens"`

	// 总 Token 数。
	TotalTokens *int64 `json:"TotalTokens,omitnil,omitempty" name:"TotalTokens"`
}

type ErrorMsg 

type ErrorMsg struct {
	// 错误提示信息。
	Msg *string `json:"Msg,omitnil,omitempty" name:"Msg"`

	// 错误码。
	// 4000 服务内部异常。
	// 4001 请求模型超时。
	Code *int64 `json:"Code,omitnil,omitempty" name:"Code"`
}

type GetEmbeddingRequest 

type GetEmbeddingRequest struct {
	*tchttp.BaseRequest

	// 输入文本。总长度不超过 1024 个 Token，超过则会截断最后面的内容。
	Input *string `json:"Input,omitnil,omitempty" name:"Input"`
}

func NewGetEmbeddingRequest 

func NewGetEmbeddingRequest() (request *GetEmbeddingRequest)

func (*GetEmbeddingRequest) FromJsonString 

func (r *GetEmbeddingRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetEmbeddingRequest) ToJsonString 

func (r *GetEmbeddingRequest) ToJsonString() string

type GetEmbeddingRequestParams 

type GetEmbeddingRequestParams struct {
	// 输入文本。总长度不超过 1024 个 Token，超过则会截断最后面的内容。
	Input *string `json:"Input,omitnil,omitempty" name:"Input"`
}

Predefined struct for user

type GetEmbeddingResponse 

type GetEmbeddingResponse struct {
	*tchttp.BaseResponse
	Response *GetEmbeddingResponseParams `json:"Response"`
}

func NewGetEmbeddingResponse 

func NewGetEmbeddingResponse() (response *GetEmbeddingResponse)

func (*GetEmbeddingResponse) FromJsonString 

func (r *GetEmbeddingResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetEmbeddingResponse) ToJsonString 

func (r *GetEmbeddingResponse) ToJsonString() string

type GetEmbeddingResponseParams 

type GetEmbeddingResponseParams struct {
	// 返回的 Embedding 信息。当前不支持批量，所以数组元素数目为 1。
	Data []*EmbeddingData `json:"Data,omitnil,omitempty" name:"Data"`

	// Token 使用计数，按照总 Token 数量收费。
	Usage *EmbeddingUsage `json:"Usage,omitnil,omitempty" name:"Usage"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetTokenCountRequest 

type GetTokenCountRequest struct {
	*tchttp.BaseRequest

	// 输入文本
	Prompt *string `json:"Prompt,omitnil,omitempty" name:"Prompt"`
}

func NewGetTokenCountRequest 

func NewGetTokenCountRequest() (request *GetTokenCountRequest)

func (*GetTokenCountRequest) FromJsonString 

func (r *GetTokenCountRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetTokenCountRequest) ToJsonString 

func (r *GetTokenCountRequest) ToJsonString() string

type GetTokenCountRequestParams 

type GetTokenCountRequestParams struct {
	// 输入文本
	Prompt *string `json:"Prompt,omitnil,omitempty" name:"Prompt"`
}

Predefined struct for user

type GetTokenCountResponse 

type GetTokenCountResponse struct {
	*tchttp.BaseResponse
	Response *GetTokenCountResponseParams `json:"Response"`
}

func NewGetTokenCountResponse 

func NewGetTokenCountResponse() (response *GetTokenCountResponse)

func (*GetTokenCountResponse) FromJsonString 

func (r *GetTokenCountResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetTokenCountResponse) ToJsonString 

func (r *GetTokenCountResponse) ToJsonString() string

type GetTokenCountResponseParams 

type GetTokenCountResponseParams struct {
	// token计数
	TokenCount *int64 `json:"TokenCount,omitnil,omitempty" name:"TokenCount"`

	// 字符计数
	CharacterCount *int64 `json:"CharacterCount,omitnil,omitempty" name:"CharacterCount"`

	// 切分后的列表
	Tokens []*string `json:"Tokens,omitnil,omitempty" name:"Tokens"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Message 

type Message struct {
	// 角色
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`

	// 文本内容
	Content *string `json:"Content,omitnil,omitempty" name:"Content"`
}

type QueryHunyuanImageJobRequest 

type QueryHunyuanImageJobRequest struct {
	*tchttp.BaseRequest

	// 任务 ID。
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

func NewQueryHunyuanImageJobRequest 

func NewQueryHunyuanImageJobRequest() (request *QueryHunyuanImageJobRequest)

func (*QueryHunyuanImageJobRequest) FromJsonString 

func (r *QueryHunyuanImageJobRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*QueryHunyuanImageJobRequest) ToJsonString 

func (r *QueryHunyuanImageJobRequest) ToJsonString() string

type QueryHunyuanImageJobRequestParams 

type QueryHunyuanImageJobRequestParams struct {
	// 任务 ID。
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

Predefined struct for user

type QueryHunyuanImageJobResponse 

type QueryHunyuanImageJobResponse struct {
	*tchttp.BaseResponse
	Response *QueryHunyuanImageJobResponseParams `json:"Response"`
}

func NewQueryHunyuanImageJobResponse 

func NewQueryHunyuanImageJobResponse() (response *QueryHunyuanImageJobResponse)

func (*QueryHunyuanImageJobResponse) FromJsonString 

func (r *QueryHunyuanImageJobResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*QueryHunyuanImageJobResponse) ToJsonString 

func (r *QueryHunyuanImageJobResponse) ToJsonString() string

type QueryHunyuanImageJobResponseParams 

type QueryHunyuanImageJobResponseParams struct {
	// 当前任务状态码：
	// 1：等待中、2：运行中、4：处理失败、5：处理完成。
	JobStatusCode *string `json:"JobStatusCode,omitnil,omitempty" name:"JobStatusCode"`

	// 当前任务状态：排队中、处理中、处理失败或者处理完成。
	JobStatusMsg *string `json:"JobStatusMsg,omitnil,omitempty" name:"JobStatusMsg"`

	// 任务处理失败错误码。
	JobErrorCode *string `json:"JobErrorCode,omitnil,omitempty" name:"JobErrorCode"`

	// 任务处理失败错误信息。
	JobErrorMsg *string `json:"JobErrorMsg,omitnil,omitempty" name:"JobErrorMsg"`

	// 生成图 URL 列表，有效期1小时，请及时保存。
	ResultImage []*string `json:"ResultImage,omitnil,omitempty" name:"ResultImage"`

	// 结果 detail 数组，Success 代表成功。
	ResultDetails []*string `json:"ResultDetails,omitnil,omitempty" name:"ResultDetails"`

	// 对应 SubmitTextToImageProJob 接口中 Revise 参数。开启扩写时，返回扩写后的 prompt 文本。 如果关闭扩写，将直接返回原始输入的 prompt。
	RevisedPrompt []*string `json:"RevisedPrompt,omitnil,omitempty" name:"RevisedPrompt"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SubmitHunyuanImageJobRequest 

type SubmitHunyuanImageJobRequest struct {
	*tchttp.BaseRequest

	// 文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空，推荐使用中文。最多可传100个 utf-8 字符。
	Prompt *string `json:"Prompt,omitnil,omitempty" name:"Prompt"`

	// 绘画风格。
	// 请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格，传入风格编号。
	// 不传默认不指定风格。
	Style *string `json:"Style,omitnil,omitempty" name:"Style"`

	// 生成图分辨率。
	// 支持生成以下分辨率的图片：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。
	Resolution *string `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 为生成结果图添加显式水印标识的开关，默认为1。
	// 1：添加。
	// 0：不添加。
	// 其他数值：默认按1处理。
	// 建议您使用显著标识来提示结果图使用了 AI 绘画技术，是 AI 生成的图片。
	LogoAdd *int64 `json:"LogoAdd,omitnil,omitempty" name:"LogoAdd"`

	// prompt 扩写开关。1为开启，0为关闭，不传默认开启。
	// 开启扩写后，将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片，返回生成图片结果时将一并返回扩写后的 prompt 文本。
	// 如果关闭扩写，将直接使用原始输入的 prompt 生成图片。
	// 建议开启，在多数场景下可提升生成图片效果、丰富生成图片细节。
	Revise *int64 `json:"Revise,omitnil,omitempty" name:"Revise"`
}

func NewSubmitHunyuanImageJobRequest 

func NewSubmitHunyuanImageJobRequest() (request *SubmitHunyuanImageJobRequest)

func (*SubmitHunyuanImageJobRequest) FromJsonString 

func (r *SubmitHunyuanImageJobRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SubmitHunyuanImageJobRequest) ToJsonString 

func (r *SubmitHunyuanImageJobRequest) ToJsonString() string

type SubmitHunyuanImageJobRequestParams 

type SubmitHunyuanImageJobRequestParams struct {
	// 文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空，推荐使用中文。最多可传100个 utf-8 字符。
	Prompt *string `json:"Prompt,omitnil,omitempty" name:"Prompt"`

	// 绘画风格。
	// 请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格，传入风格编号。
	// 不传默认不指定风格。
	Style *string `json:"Style,omitnil,omitempty" name:"Style"`

	// 生成图分辨率。
	// 支持生成以下分辨率的图片：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。
	Resolution *string `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 为生成结果图添加显式水印标识的开关，默认为1。
	// 1：添加。
	// 0：不添加。
	// 其他数值：默认按1处理。
	// 建议您使用显著标识来提示结果图使用了 AI 绘画技术，是 AI 生成的图片。
	LogoAdd *int64 `json:"LogoAdd,omitnil,omitempty" name:"LogoAdd"`

	// prompt 扩写开关。1为开启，0为关闭，不传默认开启。
	// 开启扩写后，将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片，返回生成图片结果时将一并返回扩写后的 prompt 文本。
	// 如果关闭扩写，将直接使用原始输入的 prompt 生成图片。
	// 建议开启，在多数场景下可提升生成图片效果、丰富生成图片细节。
	Revise *int64 `json:"Revise,omitnil,omitempty" name:"Revise"`
}

Predefined struct for user

type SubmitHunyuanImageJobResponse 

type SubmitHunyuanImageJobResponse struct {
	*tchttp.BaseResponse
	Response *SubmitHunyuanImageJobResponseParams `json:"Response"`
}

func NewSubmitHunyuanImageJobResponse 

func NewSubmitHunyuanImageJobResponse() (response *SubmitHunyuanImageJobResponse)

func (*SubmitHunyuanImageJobResponse) FromJsonString 

func (r *SubmitHunyuanImageJobResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SubmitHunyuanImageJobResponse) ToJsonString 

func (r *SubmitHunyuanImageJobResponse) ToJsonString() string

type SubmitHunyuanImageJobResponseParams 

type SubmitHunyuanImageJobResponseParams struct {
	// 任务 ID。
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Usage 

type Usage struct {
	// 输入 Token 数量。
	PromptTokens *int64 `json:"PromptTokens,omitnil,omitempty" name:"PromptTokens"`

	// 输出 Token 数量。
	CompletionTokens *int64 `json:"CompletionTokens,omitnil,omitempty" name:"CompletionTokens"`

	// 总 Token 数量。
	TotalTokens *int64 `json:"TotalTokens,omitnil,omitempty" name:"TotalTokens"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.