tencentcloud-sdk-hunyuan 3.0.810 → 3.0.811

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b101bd37b11a93ff1ea524dffd52db3b11e031f
-  data.tar.gz: b1698d3f1fbfbab96331f1765324aabdbac0c76f
+  metadata.gz: 27cadabb6493985840801ccea2bff7dcf5c820f9
+  data.tar.gz: 4dff8ea8906830a7c3865af1e8f3b159d0bfff56
 SHA512:
-  metadata.gz: 40840d47bff88a72c8718e6182b20cabe80dc66a4c6ea264f5b185af41d3309af7de73ffa5eb995fc998a28ecfc02ed9a25829ef1f38ebac0b0c0343628e7374
-  data.tar.gz: c8bd67888fa3ef897ff9d6ccbf2a639fd7df7532b9168350f8f871d06611af431548a9903665e431d42c3e235340ba85ee1809ea914f440ba00e8c305fa6783f
+  metadata.gz: 5da19fc481836ac1a4f0edea8501298a013e26026668c96702fe51ff9331ad0ecb7d3cd3130e1ccb2397a477947ea2cdc5b08378e259307cb14769903d21f9c6
+  data.tar.gz: 5e651c203ffee3a99f19451f09a5a2b0e752b5fe23cfa501f1f8fa78d2f3411fda51bd018ac04fa96abe19dc484e6362508990625e1abc3f7dfc11036b9fc7b0

data/lib/VERSION

@@ -1 +1 @@
-3.0.810
+3.0.811

data/lib/v20230901/client.rb

@@ -29,11 +29,39 @@ module TencentCloud
         end
 
 
-        # 腾讯混元大模型高级版是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。
+        # 腾讯混元大模型是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。
+
+        #  1. 本接口暂不支持返回图片内容。
+        #  2. 默认每种模型单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
+        #  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
+
+        # @param request: Request instance for ChatCompletions.
+        # @type request: :class:`Tencentcloud::hunyuan::V20230901::ChatCompletionsRequest`
+        # @rtype: :class:`Tencentcloud::hunyuan::V20230901::ChatCompletionsResponse`
+        def ChatCompletions(request)
+          body = send_request('ChatCompletions', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChatCompletionsResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
+        # 腾讯混元大模型（hunyuan-pro）是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。
 
         #  1. 本接口暂不支持返回图片内容。
         #  2. 默认单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
-        #  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。
+        #  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
 
         # @param request: Request instance for ChatPro.
         # @type request: :class:`Tencentcloud::hunyuan::V20230901::ChatProRequest`
@@ -61,7 +89,7 @@ module TencentCloud
 
         #  1. 本接口暂不支持返回图片内容。
         #  2. 默认单账号限制并发数为 5 路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
-        #  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。
+        #  3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
 
         # @param request: Request instance for ChatStd.
         # @type request: :class:`Tencentcloud::hunyuan::V20230901::ChatStdRequest`
@@ -85,7 +113,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 腾讯混元-Embedding接口，可以将文本转化为高质量的向量数据。
+        # 腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。
 
         # @param request: Request instance for GetEmbedding.
         # @type request: :class:`Tencentcloud::hunyuan::V20230901::GetEmbeddingRequest`

data/lib/v20230901/models.rb

@@ -17,6 +17,138 @@
 module TencentCloud
   module Hunyuan
     module V20230901
+      # ChatCompletions请求参数结构体
+      class ChatCompletionsRequest < TencentCloud::Common::AbstractModel
+        # @param Model: 模型名称，可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-pro。
+        # 各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。
+
+        # 注意：
+        # 不同的模型计费不同，请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
+        # @type Model: String
+        # @param Messages: 聊天上下文信息。
+        # 说明：
+        # 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
+        # 2. Message.Role 可选值：system、user、assistant。
+        # 其中，system 角色可选，如存在则必须位于列表的最开始。user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。
+        # 3. Messages 中 Content 总长度不超过 16000 Token，超过则会截断最前面的内容，只保留尾部内容。建议不超过 4000 Token。
+        # @type Messages: Array
+        # @param Stream: 流式调用开关。
+        # 说明：
+        # 1. 未传值时默认为非流式调用（false）。
+        # 2. 流式调用时以 SSE 协议增量返回结果（返回值取 Choices[n].Delta 中的值，需要拼接增量数据才能获得完整结果）。
+        # 3. 非流式调用时：
+        # 调用方式与普通 HTTP 请求无异。
+        # 接口响应耗时较长，**如需更低时延建议设置为 true**。
+        # 只返回一次最终结果（返回值取 Choices[n].Message 中的值）。
+
+        # 注意：
+        # 通过 SDK 调用时，流式和非流式调用需用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
+        # @type Stream: Boolean
+        # @param StreamModeration: 流式输出审核开关。
+        # 说明：
+        # 1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
+        # 2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
+        # 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
+        # 4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
+
+        # 注意：
+        # 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
+        # @type StreamModeration: Boolean
+        # @param TopP: 说明：
+        # 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
+        # 2. 默认 1.0，取值区间为 [0.0, 1.0]。
+        # 3. 非必要不建议使用，不合理的取值会影响效果。
+        # @type TopP: Float
+        # @param Temperature: 说明：
+        # 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
+        # 2. 默认 1.0，取值区间为 [0.0, 2.0]。
+        # 3. 非必要不建议使用，不合理的取值会影响效果。
+        # @type Temperature: Float
+
+        attr_accessor :Model, :Messages, :Stream, :StreamModeration, :TopP, :Temperature
+
+        def initialize(model=nil, messages=nil, stream=nil, streammoderation=nil, topp=nil, temperature=nil)
+          @Model = model
+          @Messages = messages
+          @Stream = stream
+          @StreamModeration = streammoderation
+          @TopP = topp
+          @Temperature = temperature
+        end
+
+        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']
+        end
+      end
+
+      # ChatCompletions返回参数结构体
+      class ChatCompletionsResponse < TencentCloud::Common::AbstractModel
+        # @param Created: Unix 时间戳，单位为秒。
+        # @type Created: Integer
+        # @param Usage: Token 统计信息。
+        # 按照总 Token 数量计费。
+        # @type Usage: :class:`Tencentcloud::Hunyuan.v20230901.models.Usage`
+        # @param Note: 免责声明。
+        # @type Note: String
+        # @param Id: 本轮对话的 ID。
+        # @type Id: String
+        # @param Choices: 回复内容。
+        # @type Choices: Array
+        # @param ErrorMsg: 错误信息。
+        # 如果流式返回中服务处理异常，返回该错误信息。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ErrorMsg: :class:`Tencentcloud::Hunyuan.v20230901.models.ErrorMsg`
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
+        # @type RequestId: String
+
+        attr_accessor :Created, :Usage, :Note, :Id, :Choices, :ErrorMsg, :RequestId
+
+        def initialize(created=nil, usage=nil, note=nil, id=nil, choices=nil, errormsg=nil, requestid=nil)
+          @Created = created
+          @Usage = usage
+          @Note = note
+          @Id = id
+          @Choices = choices
+          @ErrorMsg = errormsg
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @Created = params['Created']
+          unless params['Usage'].nil?
+            @Usage = Usage.new
+            @Usage.deserialize(params['Usage'])
+          end
+          @Note = params['Note']
+          @Id = params['Id']
+          unless params['Choices'].nil?
+            @Choices = []
+            params['Choices'].each do |i|
+              choice_tmp = Choice.new
+              choice_tmp.deserialize(i)
+              @Choices << choice_tmp
+            end
+          end
+          unless params['ErrorMsg'].nil?
+            @ErrorMsg = ErrorMsg.new
+            @ErrorMsg.deserialize(params['ErrorMsg'])
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChatPro请求参数结构体
       class ChatProRequest < TencentCloud::Common::AbstractModel
         # @param Messages: 聊天上下文信息。
@@ -32,7 +164,7 @@ module TencentCloud
         # @type TopP: Float
         # @param Temperature: 说明：
         # 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
-        # 2. 默认 1.0，取值区间为 [0.0，2.0]。
+        # 2. 默认 1.0，取值区间为 [0.0, 2.0]。
         # 3. 非必要不建议使用，不合理的取值会影响效果。
         # @type Temperature: Float
         # @param Stream: 流式调用开关。
@@ -41,16 +173,19 @@ module TencentCloud
         # 2. 流式调用时以 SSE 协议增量返回结果。
         # 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
         # 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
+
+        # 注意：
+        # 通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
         # @type Stream: Boolean
         # @param StreamModeration: 流式输出审核开关。
         # 说明：
-        # 1. 当 Stream 字段值为 true 时，该字段有效。
-        # 2. 未传值时默认不使用流式输出审核。
-        # 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 finish_reason 值为 sensitive。
-        # 4. 如果值为 false，则需要审核完所有输出内容后再返回结果。
+        # 1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
+        # 2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
+        # 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
+        # 4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
 
         # 注意：
-        # 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 finish_reason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
+        # 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
         # @type StreamModeration: Boolean
 
         attr_accessor :Messages, :TopP, :Temperature, :Stream, :StreamModeration
@@ -150,7 +285,7 @@ module TencentCloud
         # @type TopP: Float
         # @param Temperature: 说明：
         # 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
-        # 2. 默认 1.0，取值区间为 [0.0，2.0]。
+        # 2. 默认 1.0，取值区间为 [0.0, 2.0]。
         # 3. 非必要不建议使用，不合理的取值会影响效果。
         # @type Temperature: Float
         # @param Stream: 流式调用开关。
@@ -159,16 +294,19 @@ module TencentCloud
         # 2. 流式调用时以 SSE 协议增量返回结果。
         # 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
         # 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
+
+        # 注意：
+        # 通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
         # @type Stream: Boolean
         # @param StreamModeration: 流式输出审核开关。
         # 说明：
-        # 1. 当 Stream 字段值为 true 时，该字段有效。
-        # 2. 未传值时默认不使用流式输出审核。
-        # 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 finish_reason 值为 sensitive。
-        # 4. 如果值为 false，则需要审核完所有输出内容后再返回结果。
+        # 1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
+        # 2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
+        # 3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
+        # 4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
 
         # 注意：
-        # 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 finish_reason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
+        # 当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
         # @type StreamModeration: Boolean
 
         attr_accessor :Messages, :TopP, :Temperature, :Stream, :StreamModeration
@@ -305,7 +443,7 @@ module TencentCloud
         end
       end
 
-      # embedding 信息，当前不支持批量，所以数组元素数目为1。
+      # Embedding 信息。
       class EmbeddingData < TencentCloud::Common::AbstractModel
         # @param Embedding: embedding 信息。
         # 注意：此字段可能返回 null，表示取不到有效值。
@@ -376,7 +514,7 @@ module TencentCloud
 
       # GetEmbedding请求参数结构体
       class GetEmbeddingRequest < TencentCloud::Common::AbstractModel
-        # @param Input: 输入文本。总长度不超过1024 个token, 超过则会截断最后面的内容。
+        # @param Input: 输入文本。总长度不超过 1024 个 Token，超过则会截断最后面的内容。
         # @type Input: String
 
         attr_accessor :Input
@@ -392,9 +530,9 @@ module TencentCloud
 
       # GetEmbedding返回参数结构体
       class GetEmbeddingResponse < TencentCloud::Common::AbstractModel
-        # @param Data: 返回的 embedding 信息。
+        # @param Data: 返回的 Embedding 信息。当前不支持批量，所以数组元素数目为 1。
         # @type Data: Array
-        # @param Usage: token 使用计数，按照总token数量收费。
+        # @param Usage: Token 使用计数，按照总 Token 数量收费。
         # @type Usage: :class:`Tencentcloud::Hunyuan.v20230901.models.EmbeddingUsage`
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -472,7 +610,7 @@ module TencentCloud
       class Message < TencentCloud::Common::AbstractModel
         # @param Role: 角色
         # @type Role: String
-        # @param Content: 消息内容
+        # @param Content: 文本内容
         # @type Content: String
 
         attr_accessor :Role, :Content

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-hunyuan
 version: !ruby/object:Gem::Version
-  version: 3.0.810
+  version: 3.0.811
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common