tencentcloud-sdk-tms 3.0.738 → 3.0.739

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f95401e3aa76553023b19fa12ea6437947c3c6c4
4
- data.tar.gz: 041890dd35001bfddd38b293f27529f6fe92b691
3
+ metadata.gz: 1c6888ebb8a6770d6772d12d68d581888e2eedd0
4
+ data.tar.gz: 544846bc6d05e7d30b3fa6a8a6cd6e0ea54098d1
5
5
  SHA512:
6
- metadata.gz: b38971e57c4bdc23016aeb7c31d40f4936308aade301bbbb7bef80582ee8ce7bd4ea399e94fc6001d0d723511c8aff6ec391c8ac91be5cb1a2aeac883f361c91
7
- data.tar.gz: 983a5fb6424748a7dbe6da0451b1911d78d4d4984cd5a80f0e9972ffc490962a3f40a845734cf1d7e24c079beceb301ef2718d725ab30297ea5c6f4dffdd586c
6
+ metadata.gz: fbe65b83907cedf295c3c41a8cb98704b4e0a7259bcb503c43bcfb1eae3af9872486b63cc31e1da960436f3b0492ef5e80dc129625b1487e5d18416348cbdc78
7
+ data.tar.gz: 12d746c2ff013c1977d0312e2d06a1dcbad6f0de77cb2f00828e791d29de8621293eb0baed671fa71c98146362f2ec759a9caa7785e2bb921dfe7f3abcbf0c0d
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.738
1
+ 3.0.739
@@ -29,6 +29,30 @@ module TencentCloud
29
29
  end
30
30
 
31
31
 
32
+ # 天御文本内容安全审核接口,改接口会按照客户定制标签输出审核结果
33
+
34
+ # @param request: Request instance for ModerateText.
35
+ # @type request: :class:`Tencentcloud::tms::V20201229::ModerateTextRequest`
36
+ # @rtype: :class:`Tencentcloud::tms::V20201229::ModerateTextResponse`
37
+ def ModerateText(request)
38
+ body = send_request('ModerateText', request.serialize)
39
+ response = JSON.parse(body)
40
+ if response['Response'].key?('Error') == false
41
+ model = ModerateTextResponse.new
42
+ model.deserialize(response['Response'])
43
+ model
44
+ else
45
+ code = response['Response']['Error']['Code']
46
+ message = response['Response']['Error']['Message']
47
+ reqid = response['Response']['RequestId']
48
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
49
+ end
50
+ rescue TencentCloud::Common::TencentCloudSDKException => e
51
+ raise e
52
+ rescue StandardError => e
53
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
54
+ end
55
+
32
56
  # 本接口(Text Moderation)用于提交文本内容进行智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通文本内容安全服务](https://console.cloud.tencent.com/cms) 并调整好对应的业务配置。
33
57
 
34
58
  # ### 接口使用说明
@@ -19,7 +19,7 @@ module TencentCloud
19
19
  module V20201229
20
20
  # 文本审核返回的详细结果
21
21
  class DetailResults < TencentCloud::Common::AbstractModel
22
- # @param Label: 该字段用于返回检测结果所对应的全部恶意标签。<br>返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
22
+ # @param Label: 该字段用于返回检测结果所对应的全部恶意标签。<br>返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告;以及其他令人反感、不安全或不适宜的内容类型。
23
23
  # @type Label: String
24
24
  # @param Suggestion: 该字段用于返回对应当前标签的后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。<br>返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
25
25
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -30,13 +30,13 @@ module TencentCloud
30
30
  # @param Score: 该字段用于返回当前标签(Label)下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高** ),越高代表文本越有可能属于当前返回的标签;如:*色情 99*,则表明该文本非常有可能属于色情内容;*色情 0*,则表明该文本不属于色情内容。
31
31
  # 注意:此字段可能返回 null,表示取不到有效值。
32
32
  # @type Score: Integer
33
- # @param LibType: 该字段**仅当Label为Custom自定义关键词时有效**,用于返回自定义关键词对应的词库类型,取值为**1**(黑白库)和**2**(自定义关键词库),若未配置自定义关键词库,则默认值为1(黑白库匹配)。
33
+ # @param LibType: 该字段用于返回自定义关键词对应的词库类型,取值为**1**(黑白库)和**2**(自定义关键词库),若未配置自定义关键词库,则默认值为1(黑白库匹配)。
34
34
  # 注意:此字段可能返回 null,表示取不到有效值。
35
35
  # @type LibType: Integer
36
- # @param LibId: 该字段**仅当Label为Custom:自定义关键词时该参数有效**,用于返回自定义库的ID,以方便自定义库管理和配置。
36
+ # @param LibId: 该字段用于返回自定义库的ID,以方便自定义库管理和配置。
37
37
  # 注意:此字段可能返回 null,表示取不到有效值。
38
38
  # @type LibId: String
39
- # @param LibName: 该字段**仅当Label为Custom:自定义关键词时该参数有效**,用于返回自定义库的名称,以方便自定义库管理和配置。
39
+ # @param LibName: 该字段用于返回自定义库的名称,以方便自定义库管理和配置。
40
40
  # 注意:此字段可能返回 null,表示取不到有效值。
41
41
  # @type LibName: String
42
42
  # @param SubLabel: 该字段用于返回当前标签(Label)下的二级标签。
@@ -173,6 +173,277 @@ module TencentCloud
173
173
  end
174
174
  end
175
175
 
176
+ # 内容审核多级标签结构
177
+ class LabelGrade < TencentCloud::Common::AbstractModel
178
+ # @param Code: 内容审核结果客户定制标签码
179
+ # 注意:此字段可能返回 null,表示取不到有效值。
180
+ # @type Code: String
181
+ # @param Grade1: 内容审核结果客户定制一级标签
182
+ # 注意:此字段可能返回 null,表示取不到有效值。
183
+ # @type Grade1: String
184
+ # @param Grade2: 内容审核结果客户定制二级标签
185
+ # 注意:此字段可能返回 null,表示取不到有效值。
186
+ # @type Grade2: String
187
+ # @param Grade3: 内容审核结果客户定制三级标签
188
+ # 注意:此字段可能返回 null,表示取不到有效值。
189
+ # @type Grade3: String
190
+
191
+ attr_accessor :Code, :Grade1, :Grade2, :Grade3
192
+
193
+ def initialize(code=nil, grade1=nil, grade2=nil, grade3=nil)
194
+ @Code = code
195
+ @Grade1 = grade1
196
+ @Grade2 = grade2
197
+ @Grade3 = grade3
198
+ end
199
+
200
+ def deserialize(params)
201
+ @Code = params['Code']
202
+ @Grade1 = params['Grade1']
203
+ @Grade2 = params['Grade2']
204
+ @Grade3 = params['Grade3']
205
+ end
206
+ end
207
+
208
+ # 库检测结果
209
+ class LibCheckResult < TencentCloud::Common::AbstractModel
210
+ # @param LibId: 库ID
211
+ # 注意:此字段可能返回 null,表示取不到有效值。
212
+ # @type LibId: String
213
+ # @param LibName: 库名称
214
+ # 注意:此字段可能返回 null,表示取不到有效值。
215
+ # @type LibName: String
216
+ # @param LibType: 库类型
217
+ # 注意:此字段可能返回 null,表示取不到有效值。
218
+ # @type LibType: Integer
219
+ # @param Keyword: 命中的关键词
220
+ # 注意:此字段可能返回 null,表示取不到有效值。
221
+ # @type Keyword: String
222
+ # @param Positions: 命中的关键词在送审文本的位置,可能存在多个位置,每个位置显示开始位置和结束位置
223
+ # 注意:此字段可能返回 null,表示取不到有效值。
224
+ # @type Positions: Array
225
+
226
+ attr_accessor :LibId, :LibName, :LibType, :Keyword, :Positions
227
+
228
+ def initialize(libid=nil, libname=nil, libtype=nil, keyword=nil, positions=nil)
229
+ @LibId = libid
230
+ @LibName = libname
231
+ @LibType = libtype
232
+ @Keyword = keyword
233
+ @Positions = positions
234
+ end
235
+
236
+ def deserialize(params)
237
+ @LibId = params['LibId']
238
+ @LibName = params['LibName']
239
+ @LibType = params['LibType']
240
+ @Keyword = params['Keyword']
241
+ unless params['Positions'].nil?
242
+ @Positions = []
243
+ params['Positions'].each do |i|
244
+ positions_tmp = Positions.new
245
+ positions_tmp.deserialize(i)
246
+ @Positions << positions_tmp
247
+ end
248
+ end
249
+ end
250
+ end
251
+
252
+ # 模型检测结果
253
+ class ModelResult < TencentCloud::Common::AbstractModel
254
+ # @param Content: 模型检测出的违规内容
255
+ # 注意:此字段可能返回 null,表示取不到有效值。
256
+ # @type Content: String
257
+ # @param Positions: 模型检测出的违规内容的位置
258
+ # 注意:此字段可能返回 null,表示取不到有效值。
259
+ # @type Positions: Array
260
+
261
+ attr_accessor :Content, :Positions
262
+
263
+ def initialize(content=nil, positions=nil)
264
+ @Content = content
265
+ @Positions = positions
266
+ end
267
+
268
+ def deserialize(params)
269
+ @Content = params['Content']
270
+ unless params['Positions'].nil?
271
+ @Positions = []
272
+ params['Positions'].each do |i|
273
+ positions_tmp = Positions.new
274
+ positions_tmp.deserialize(i)
275
+ @Positions << positions_tmp
276
+ end
277
+ end
278
+ end
279
+ end
280
+
281
+ # ModerateText请求参数结构体
282
+ class ModerateTextRequest < TencentCloud::Common::AbstractModel
283
+ # @param Content: 该字段表示待检测对象的文本内容,文本需要按utf-8格式编码,长度不能超过10000个字符(按unicode编码计算),并进行 Base64加密
284
+ # @type Content: String
285
+ # @param BizType: 该字段表示策略的具体编号,用于接口调度,在内容安全控制台中可配置。若不传入Biztype参数(留空),则代表采用默认的识别策略;传入则会在审核时根据业务场景采取不同的审核策略。
286
+ # 备注:Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype
287
+ # @type BizType: String
288
+ # @param DataId: 该字段表示您为待检测对象分配的数据ID,传入后可方便您对文件进行标识和管理。
289
+ # 取值:由英文字母(大小写均可)、数字及四个特殊符号(_,-,@,#)组成,长度不超过64个字符
290
+ # @type DataId: String
291
+ # @param User: 该字段表示待检测对象对应的用户相关信息,传入后可便于甄别相应违规风险用户
292
+ # @type User: :class:`Tencentcloud::Tms.v20201229.models.User`
293
+ # @param Device: 该字段表示待检测对象对应的设备相关信息,传入后可便于甄别相应违规风险设备
294
+ # @type Device: :class:`Tencentcloud::Tms.v20201229.models.Device`
295
+
296
+ attr_accessor :Content, :BizType, :DataId, :User, :Device
297
+
298
+ def initialize(content=nil, biztype=nil, dataid=nil, user=nil, device=nil)
299
+ @Content = content
300
+ @BizType = biztype
301
+ @DataId = dataid
302
+ @User = user
303
+ @Device = device
304
+ end
305
+
306
+ def deserialize(params)
307
+ @Content = params['Content']
308
+ @BizType = params['BizType']
309
+ @DataId = params['DataId']
310
+ unless params['User'].nil?
311
+ @User = User.new
312
+ @User.deserialize(params['User'])
313
+ end
314
+ unless params['Device'].nil?
315
+ @Device = Device.new
316
+ @Device.deserialize(params['Device'])
317
+ end
318
+ end
319
+ end
320
+
321
+ # ModerateText返回参数结构体
322
+ class ModerateTextResponse < TencentCloud::Common::AbstractModel
323
+ # @param DataId: 该字段用于返回检测对象对应请求参数中的DataId,与输入的DataId字段中的内容对应
324
+ # @type DataId: String
325
+ # @param BizType: 该字段用于返回请求参数中的BizType参数
326
+ # @type BizType: String
327
+ # @param Suggestion: 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。
328
+ # 返回值:Block:建议屏蔽,Review :建议人工复审,Pass:建议通过
329
+ # @type Suggestion: String
330
+ # @param Label: 命中标签,可参阅对应数据结构(LabelGrade)的详细描述
331
+ # @type Label: :class:`Tencentcloud::Tms.v20201229.models.LabelGrade`
332
+ # @param TcLabelCodes: 命中标签对应腾讯侧定义的标签
333
+ # @type TcLabelCodes: Array
334
+ # @param Keywords: 该字段用于返回当前标签(Label)下被检测文本命中的关键词信息,用于标注文本违规的具体原因(如:加我微信)。该参数可能会有多个返回值,代表命中的多个关键词;如返回值为空且Score不为空,则代表识别结果所对应的恶意标签(Label)是来自于语义模型判断的返回值
335
+ # @type Keywords: Array
336
+ # @param ModerationDetails: 该字段用于返回文本审核的详细结果,返回值信息可参阅对应数据结构(ModerationDetail)的详细描述
337
+ # @type ModerationDetails: Array
338
+ # @param Score: 该字段用于返回审核结果置信度,使用百分制。分数越高表示结果可信度越高。
339
+ # @type Score: Integer
340
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
341
+ # @type RequestId: String
342
+
343
+ attr_accessor :DataId, :BizType, :Suggestion, :Label, :TcLabelCodes, :Keywords, :ModerationDetails, :Score, :RequestId
344
+
345
+ def initialize(dataid=nil, biztype=nil, suggestion=nil, label=nil, tclabelcodes=nil, keywords=nil, moderationdetails=nil, score=nil, requestid=nil)
346
+ @DataId = dataid
347
+ @BizType = biztype
348
+ @Suggestion = suggestion
349
+ @Label = label
350
+ @TcLabelCodes = tclabelcodes
351
+ @Keywords = keywords
352
+ @ModerationDetails = moderationdetails
353
+ @Score = score
354
+ @RequestId = requestid
355
+ end
356
+
357
+ def deserialize(params)
358
+ @DataId = params['DataId']
359
+ @BizType = params['BizType']
360
+ @Suggestion = params['Suggestion']
361
+ unless params['Label'].nil?
362
+ @Label = LabelGrade.new
363
+ @Label.deserialize(params['Label'])
364
+ end
365
+ @TcLabelCodes = params['TcLabelCodes']
366
+ @Keywords = params['Keywords']
367
+ unless params['ModerationDetails'].nil?
368
+ @ModerationDetails = []
369
+ params['ModerationDetails'].each do |i|
370
+ moderationdetail_tmp = ModerationDetail.new
371
+ moderationdetail_tmp.deserialize(i)
372
+ @ModerationDetails << moderationdetail_tmp
373
+ end
374
+ end
375
+ @Score = params['Score']
376
+ @RequestId = params['RequestId']
377
+ end
378
+ end
379
+
380
+ # 文本审核明细结果
381
+ class ModerationDetail < TencentCloud::Common::AbstractModel
382
+ # @param Suggestion: 审核建议,Block表示建议拦截,Review表示建议人工复审,Pass表示建议放行
383
+ # 注意:此字段可能返回 null,表示取不到有效值。
384
+ # @type Suggestion: String
385
+ # @param Label: 命中标签,含标签码和一二三级标签名
386
+ # 注意:此字段可能返回 null,表示取不到有效值。
387
+ # @type Label: :class:`Tencentcloud::Tms.v20201229.models.LabelGrade`
388
+ # @param Score: 标签得分
389
+ # 注意:此字段可能返回 null,表示取不到有效值。
390
+ # @type Score: Integer
391
+ # @param TcLabelCodes: label对应腾讯侧命中标签码
392
+ # 注意:此字段可能返回 null,表示取不到有效值。
393
+ # @type TcLabelCodes: Array
394
+ # @param LibResults: 库检测命中详情
395
+ # 注意:此字段可能返回 null,表示取不到有效值。
396
+ # @type LibResults: Array
397
+ # @param ModelResults: 模型检测详情
398
+ # 注意:此字段可能返回 null,表示取不到有效值。
399
+ # @type ModelResults: Array
400
+ # @param SentimentResult: 情绪正负向检测结果
401
+ # 注意:此字段可能返回 null,表示取不到有效值。
402
+ # @type SentimentResult: :class:`Tencentcloud::Tms.v20201229.models.SentimentDetail`
403
+
404
+ attr_accessor :Suggestion, :Label, :Score, :TcLabelCodes, :LibResults, :ModelResults, :SentimentResult
405
+
406
+ def initialize(suggestion=nil, label=nil, score=nil, tclabelcodes=nil, libresults=nil, modelresults=nil, sentimentresult=nil)
407
+ @Suggestion = suggestion
408
+ @Label = label
409
+ @Score = score
410
+ @TcLabelCodes = tclabelcodes
411
+ @LibResults = libresults
412
+ @ModelResults = modelresults
413
+ @SentimentResult = sentimentresult
414
+ end
415
+
416
+ def deserialize(params)
417
+ @Suggestion = params['Suggestion']
418
+ unless params['Label'].nil?
419
+ @Label = LabelGrade.new
420
+ @Label.deserialize(params['Label'])
421
+ end
422
+ @Score = params['Score']
423
+ @TcLabelCodes = params['TcLabelCodes']
424
+ unless params['LibResults'].nil?
425
+ @LibResults = []
426
+ params['LibResults'].each do |i|
427
+ libcheckresult_tmp = LibCheckResult.new
428
+ libcheckresult_tmp.deserialize(i)
429
+ @LibResults << libcheckresult_tmp
430
+ end
431
+ end
432
+ unless params['ModelResults'].nil?
433
+ @ModelResults = []
434
+ params['ModelResults'].each do |i|
435
+ modelresult_tmp = ModelResult.new
436
+ modelresult_tmp.deserialize(i)
437
+ @ModelResults << modelresult_tmp
438
+ end
439
+ end
440
+ unless params['SentimentResult'].nil?
441
+ @SentimentResult = SentimentDetail.new
442
+ @SentimentResult.deserialize(params['SentimentResult'])
443
+ end
444
+ end
445
+ end
446
+
176
447
  # 标识命中的违规关键词位置信息
177
448
  class Positions < TencentCloud::Common::AbstractModel
178
449
  # @param Start: 关键词起始位置
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-tms
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.738
4
+ version: 3.0.739
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-12-28 00:00:00.000000000 Z
11
+ date: 2023-12-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common