tencentcloud-sdk-tms 3.0.738 → 3.0.740

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f95401e3aa76553023b19fa12ea6437947c3c6c4
-  data.tar.gz: 041890dd35001bfddd38b293f27529f6fe92b691
+  metadata.gz: 3c307edae9fc3aa888cb2a4add340c169508a776
+  data.tar.gz: 774a8d99743772677fcf44505031db862db0791b
 SHA512:
-  metadata.gz: b38971e57c4bdc23016aeb7c31d40f4936308aade301bbbb7bef80582ee8ce7bd4ea399e94fc6001d0d723511c8aff6ec391c8ac91be5cb1a2aeac883f361c91
-  data.tar.gz: 983a5fb6424748a7dbe6da0451b1911d78d4d4984cd5a80f0e9972ffc490962a3f40a845734cf1d7e24c079beceb301ef2718d725ab30297ea5c6f4dffdd586c
+  metadata.gz: e78811f6fb1e6d81d01128868666b18b4b1523b1f6c1eff6ed701c052e2da156db9314a13134c33cffa110497952073a573ea8892cab9567cf2a96333c2b4af3
+  data.tar.gz: 70acd48832bbd2bf87a7df555bde712c5b1a4080854b5277b107a8eadfe73c587aacef4829fb9ee28fbcba177db33ad9c12c59db947c34df320daa7d67f2dbb6

data/lib/VERSION

@@ -1 +1 @@
-3.0.738
+3.0.740

data/lib/v20201229/client.rb

@@ -29,6 +29,30 @@ module TencentCloud
         end
 
 
+        # 天御文本内容安全审核接口，改接口会按照客户定制标签输出审核结果
+
+        # @param request: Request instance for ModerateText.
+        # @type request: :class:`Tencentcloud::tms::V20201229::ModerateTextRequest`
+        # @rtype: :class:`Tencentcloud::tms::V20201229::ModerateTextResponse`
+        def ModerateText(request)
+          body = send_request('ModerateText', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ModerateTextResponse.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
+
         # 本接口（Text Moderation）用于提交文本内容进行智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通文本内容安全服务](https://console.cloud.tencent.com/cms) 并调整好对应的业务配置。
 
         # ### 接口使用说明

data/lib/v20201229/models.rb

@@ -19,7 +19,7 @@ module TencentCloud
     module V20201229
       # 文本审核返回的详细结果
       class DetailResults < TencentCloud::Common::AbstractModel
-        # @param Label: 该字段用于返回检测结果所对应的全部恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告，**Custom**：自定义违规；以及其他令人反感、不安全或不适宜的内容类型。
+        # @param Label: 该字段用于返回检测结果所对应的全部恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
         # @type Label: String
         # @param Suggestion: 该字段用于返回对应当前标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
         # 注意：此字段可能返回 null，表示取不到有效值。
@@ -30,13 +30,13 @@ module TencentCloud
         # @param Score: 该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表文本越有可能属于当前返回的标签；如：*色情 99*，则表明该文本非常有可能属于色情内容；*色情 0*，则表明该文本不属于色情内容。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Score: Integer
-        # @param LibType: 该字段**仅当Label为Custom自定义关键词时有效**，用于返回自定义关键词对应的词库类型，取值为**1**（黑白库）和**2**（自定义关键词库），若未配置自定义关键词库,则默认值为1（黑白库匹配）。
+        # @param LibType: 该字段用于返回自定义关键词对应的词库类型，取值为**1**（黑白库）和**2**（自定义关键词库），若未配置自定义关键词库,则默认值为1（黑白库匹配）。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type LibType: Integer
-        # @param LibId: 该字段**仅当Label为Custom：自定义关键词时该参数有效**,用于返回自定义库的ID，以方便自定义库管理和配置。
+        # @param LibId: 该字段用于返回自定义库的ID，以方便自定义库管理和配置。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type LibId: String
-        # @param LibName: 该字段**仅当Label为Custom：自定义关键词时该参数有效**,用于返回自定义库的名称,以方便自定义库管理和配置。
+        # @param LibName: 该字段用于返回自定义库的名称,以方便自定义库管理和配置。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type LibName: String
         # @param SubLabel: 该字段用于返回当前标签（Label）下的二级标签。
@@ -173,6 +173,277 @@ module TencentCloud
         end
       end
 
+      # 内容审核多级标签结构
+      class LabelGrade < TencentCloud::Common::AbstractModel
+        # @param Code: 内容审核结果客户定制标签码
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Code: String
+        # @param Grade1: 内容审核结果客户定制一级标签
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Grade1: String
+        # @param Grade2: 内容审核结果客户定制二级标签
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Grade2: String
+        # @param Grade3: 内容审核结果客户定制三级标签
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Grade3: String
+
+        attr_accessor :Code, :Grade1, :Grade2, :Grade3
+
+        def initialize(code=nil, grade1=nil, grade2=nil, grade3=nil)
+          @Code = code
+          @Grade1 = grade1
+          @Grade2 = grade2
+          @Grade3 = grade3
+        end
+
+        def deserialize(params)
+          @Code = params['Code']
+          @Grade1 = params['Grade1']
+          @Grade2 = params['Grade2']
+          @Grade3 = params['Grade3']
+        end
+      end
+
+      # 库检测结果
+      class LibCheckResult < TencentCloud::Common::AbstractModel
+        # @param LibId: 库ID
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type LibId: String
+        # @param LibName: 库名称
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type LibName: String
+        # @param LibType: 库类型
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type LibType: Integer
+        # @param Keyword: 命中的关键词
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Keyword: String
+        # @param Positions: 命中的关键词在送审文本的位置，可能存在多个位置，每个位置显示开始位置和结束位置
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Positions: Array
+
+        attr_accessor :LibId, :LibName, :LibType, :Keyword, :Positions
+
+        def initialize(libid=nil, libname=nil, libtype=nil, keyword=nil, positions=nil)
+          @LibId = libid
+          @LibName = libname
+          @LibType = libtype
+          @Keyword = keyword
+          @Positions = positions
+        end
+
+        def deserialize(params)
+          @LibId = params['LibId']
+          @LibName = params['LibName']
+          @LibType = params['LibType']
+          @Keyword = params['Keyword']
+          unless params['Positions'].nil?
+            @Positions = []
+            params['Positions'].each do |i|
+              positions_tmp = Positions.new
+              positions_tmp.deserialize(i)
+              @Positions << positions_tmp
+            end
+          end
+        end
+      end
+
+      # 模型检测结果
+      class ModelResult < TencentCloud::Common::AbstractModel
+        # @param Content: 模型检测出的违规内容
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Content: String
+        # @param Positions: 模型检测出的违规内容的位置
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Positions: Array
+
+        attr_accessor :Content, :Positions
+
+        def initialize(content=nil, positions=nil)
+          @Content = content
+          @Positions = positions
+        end
+
+        def deserialize(params)
+          @Content = params['Content']
+          unless params['Positions'].nil?
+            @Positions = []
+            params['Positions'].each do |i|
+              positions_tmp = Positions.new
+              positions_tmp.deserialize(i)
+              @Positions << positions_tmp
+            end
+          end
+        end
+      end
+
+      # ModerateText请求参数结构体
+      class ModerateTextRequest < TencentCloud::Common::AbstractModel
+        # @param Content: 该字段表示待检测对象的文本内容，文本需要按utf-8格式编码，长度不能超过10000个字符（按unicode编码计算），并进行 Base64加密
+        # @type Content: String
+        # @param BizType: 该字段表示策略的具体编号，用于接口调度，在内容安全控制台中可配置。若不传入Biztype参数（留空），则代表采用默认的识别策略；传入则会在审核时根据业务场景采取不同的审核策略。
+        # 备注：Biztype仅为数字、字母与下划线的组合，长度为3-32个字符；不同Biztype关联不同的业务场景与识别能力策略，调用前请确认正确的Biztype
+        # @type BizType: String
+        # @param DataId: 该字段表示您为待检测对象分配的数据ID，传入后可方便您对文件进行标识和管理。
+        # 取值：由英文字母（大小写均可）、数字及四个特殊符号（_，-，@，#）组成，长度不超过64个字符
+        # @type DataId: String
+        # @param User: 该字段表示待检测对象对应的用户相关信息，传入后可便于甄别相应违规风险用户
+        # @type User: :class:`Tencentcloud::Tms.v20201229.models.User`
+        # @param Device: 该字段表示待检测对象对应的设备相关信息，传入后可便于甄别相应违规风险设备
+        # @type Device: :class:`Tencentcloud::Tms.v20201229.models.Device`
+
+        attr_accessor :Content, :BizType, :DataId, :User, :Device
+
+        def initialize(content=nil, biztype=nil, dataid=nil, user=nil, device=nil)
+          @Content = content
+          @BizType = biztype
+          @DataId = dataid
+          @User = user
+          @Device = device
+        end
+
+        def deserialize(params)
+          @Content = params['Content']
+          @BizType = params['BizType']
+          @DataId = params['DataId']
+          unless params['User'].nil?
+            @User = User.new
+            @User.deserialize(params['User'])
+          end
+          unless params['Device'].nil?
+            @Device = Device.new
+            @Device.deserialize(params['Device'])
+          end
+        end
+      end
+
+      # ModerateText返回参数结构体
+      class ModerateTextResponse < TencentCloud::Common::AbstractModel
+        # @param DataId: 该字段用于返回检测对象对应请求参数中的DataId，与输入的DataId字段中的内容对应
+        # @type DataId: String
+        # @param BizType: 该字段用于返回请求参数中的BizType参数
+        # @type BizType: String
+        # @param Suggestion: 该字段用于返回后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。
+        # 返回值：Block：建议屏蔽，Review ：建议人工复审，Pass：建议通过
+        # @type Suggestion: String
+        # @param Label: 命中标签，可参阅对应数据结构（LabelGrade）的详细描述
+        # @type Label: :class:`Tencentcloud::Tms.v20201229.models.LabelGrade`
+        # @param TcLabelCodes: 命中标签对应腾讯侧定义的标签
+        # @type TcLabelCodes: Array
+        # @param Keywords: 该字段用于返回当前标签（Label）下被检测文本命中的关键词信息，用于标注文本违规的具体原因（如：加我微信）。该参数可能会有多个返回值，代表命中的多个关键词；如返回值为空且Score不为空，则代表识别结果所对应的恶意标签（Label）是来自于语义模型判断的返回值
+        # @type Keywords: Array
+        # @param ModerationDetails: 该字段用于返回文本审核的详细结果，返回值信息可参阅对应数据结构（ModerationDetail）的详细描述
+        # @type ModerationDetails: Array
+        # @param Score: 该字段用于返回审核结果置信度，使用百分制。分数越高表示结果可信度越高。
+        # @type Score: Integer
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :DataId, :BizType, :Suggestion, :Label, :TcLabelCodes, :Keywords, :ModerationDetails, :Score, :RequestId
+
+        def initialize(dataid=nil, biztype=nil, suggestion=nil, label=nil, tclabelcodes=nil, keywords=nil, moderationdetails=nil, score=nil, requestid=nil)
+          @DataId = dataid
+          @BizType = biztype
+          @Suggestion = suggestion
+          @Label = label
+          @TcLabelCodes = tclabelcodes
+          @Keywords = keywords
+          @ModerationDetails = moderationdetails
+          @Score = score
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @DataId = params['DataId']
+          @BizType = params['BizType']
+          @Suggestion = params['Suggestion']
+          unless params['Label'].nil?
+            @Label = LabelGrade.new
+            @Label.deserialize(params['Label'])
+          end
+          @TcLabelCodes = params['TcLabelCodes']
+          @Keywords = params['Keywords']
+          unless params['ModerationDetails'].nil?
+            @ModerationDetails = []
+            params['ModerationDetails'].each do |i|
+              moderationdetail_tmp = ModerationDetail.new
+              moderationdetail_tmp.deserialize(i)
+              @ModerationDetails << moderationdetail_tmp
+            end
+          end
+          @Score = params['Score']
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # 文本审核明细结果
+      class ModerationDetail < TencentCloud::Common::AbstractModel
+        # @param Suggestion: 审核建议，Block表示建议拦截，Review表示建议人工复审，Pass表示建议放行
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Suggestion: String
+        # @param Label: 命中标签，含标签码和一二三级标签名
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Label: :class:`Tencentcloud::Tms.v20201229.models.LabelGrade`
+        # @param Score: 标签得分
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Score: Integer
+        # @param TcLabelCodes: label对应腾讯侧命中标签码
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type TcLabelCodes: Array
+        # @param LibResults: 库检测命中详情
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type LibResults: Array
+        # @param ModelResults: 模型检测详情
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ModelResults: Array
+        # @param SentimentResult: 情绪正负向检测结果
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type SentimentResult: :class:`Tencentcloud::Tms.v20201229.models.SentimentDetail`
+
+        attr_accessor :Suggestion, :Label, :Score, :TcLabelCodes, :LibResults, :ModelResults, :SentimentResult
+
+        def initialize(suggestion=nil, label=nil, score=nil, tclabelcodes=nil, libresults=nil, modelresults=nil, sentimentresult=nil)
+          @Suggestion = suggestion
+          @Label = label
+          @Score = score
+          @TcLabelCodes = tclabelcodes
+          @LibResults = libresults
+          @ModelResults = modelresults
+          @SentimentResult = sentimentresult
+        end
+
+        def deserialize(params)
+          @Suggestion = params['Suggestion']
+          unless params['Label'].nil?
+            @Label = LabelGrade.new
+            @Label.deserialize(params['Label'])
+          end
+          @Score = params['Score']
+          @TcLabelCodes = params['TcLabelCodes']
+          unless params['LibResults'].nil?
+            @LibResults = []
+            params['LibResults'].each do |i|
+              libcheckresult_tmp = LibCheckResult.new
+              libcheckresult_tmp.deserialize(i)
+              @LibResults << libcheckresult_tmp
+            end
+          end
+          unless params['ModelResults'].nil?
+            @ModelResults = []
+            params['ModelResults'].each do |i|
+              modelresult_tmp = ModelResult.new
+              modelresult_tmp.deserialize(i)
+              @ModelResults << modelresult_tmp
+            end
+          end
+          unless params['SentimentResult'].nil?
+            @SentimentResult = SentimentDetail.new
+            @SentimentResult.deserialize(params['SentimentResult'])
+          end
+        end
+      end
+
       # 标识命中的违规关键词位置信息
       class Positions < TencentCloud::Common::AbstractModel
         # @param Start: 关键词起始位置

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-tms
 version: !ruby/object:Gem::Version
-  version: 3.0.738
+  version: 3.0.740
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common
@@ -33,9 +33,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/tencentcloud-sdk-tms.rb
 - lib/v20201229/client.rb
 - lib/v20201229/models.rb
-- lib/tencentcloud-sdk-tms.rb
 - lib/v20200713/client.rb
 - lib/v20200713/models.rb
 - lib/VERSION