Merge pull request #21 from Copyleaks/add-text-moderation

add text moderation

Author: AihamAR

demo/demo.rb

@@ -35,7 +35,7 @@ def self.run
 
     # test_submit_url(loginResponse)
 
-    test_submit_file(loginResponse)
+    # test_submit_file(loginResponse)
 
     # test_submit_ocr_file(loginResponse)
 
@@ -44,6 +44,9 @@ def self.run
     # test_ai_detection_source_code(loginResponse)
 
     # test_writing_assistant(loginResponse)
+
+    test_text_moderation(loginResponse)
+
   rescue StandardError => e
     puts '--------ERROR-------'
     puts
@@ -249,6 +252,36 @@ def self.test_writing_assistant(_authToken)
     logInfo('Writing Assistant - submit_text', res)
   end
 
+  def self.test_text_moderation(_authToken)
+    scanId = DateTime.now.strftime('%Q').to_s
+    text_moderation_request = Copyleaks::CopyleaksTextModerationRequestModel.new(
+      text: "This is some text to scan.",
+      sandbox: true,
+      language: "en",
+      labels: [
+        { id: "other-v1" },
+        { id: "adult-v1" },
+        { id: "toxic-v1" },
+        { id: "violent-v1" },
+        { id: "profanity-v1" },
+        { id: "self-harm-v1" },
+        { id: "harassment-v1" },
+        { id: "hate-speech-v1" },
+        { id: "drugs-v1" },
+        { id: "firearms-v1" },
+        { id: "cybersecurity-v1" }
+      ]
+    )
+    res = @copyleaks.text_moderation_client.submit_text(_authToken, scanId, text_moderation_request)
+
+    textModerationResponse = Copyleaks::CopyleaksTextModerationResponseModel.new(  
+      moderations: res['moderations'],
+      legend: res['legend'],
+      scanned_document: res['scannedDocument'])
+
+    logInfo('Text Moderation - submit_text', textModerationResponse)
+  end
+
   def self.logInfo(title, info = nil)
     puts '-------------' + title + '-------------'
     puts info.to_json unless info.nil?

lib/copyleaks/api.rb

@@ -26,6 +26,7 @@
 require 'date'
 require_relative 'ai_detection_client.rb'
 require_relative 'writing_assistant_client.rb'
+require_relative 'text_moderation_client.rb'
 require_relative 'utils/copyleaks_client.utils'
 
 module Copyleaks
@@ -43,6 +44,7 @@ def initialize
       # Initialize clients
       @ai_detection_client = AIDetectionClient.new(@api_client)
       @writing_assistant_client = WritingAssistantClient.new(@api_client)
+      @text_moderation_client = TextModerationClient.new(@api_client)
     end
 
     # Login to Copyleaks authentication server.
@@ -456,5 +458,8 @@ def ai_detection_client
     def writing_assistant_client
       @writing_assistant_client
     end
+    def text_moderation_client
+      @text_moderation_client
+    end
   end
 end

lib/copyleaks/models/index.rb

@@ -31,5 +31,13 @@
 require_relative 'delete_request_model.rb'
 require_relative 'start_request_model.rb'
 
+require_relative 'textModeration/requests/CopyleaksTextModerationRequestModel.rb'
+require_relative 'textModeration/responses/submodules/ModerationsModel.rb'
+require_relative 'textModeration/responses/submodules/Text.rb'
+require_relative 'textModeration/responses/submodules/TextModerationChars.rb'
+require_relative 'textModeration/responses/submodules/TextModerationScannedDocument.rb'
+require_relative 'textModeration/responses/submodules/TextModerationsLegend.rb'
+require_relative 'textModeration/responses/CopyleaksTextModerationResponseModel.rb'
+
 module Copyleaks
 end

lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/StatusWebhook.rb

@@ -18,6 +18,7 @@
  #=
 module Copyleaks
   class StatusWebhook < Webhook
+    # @param [Integer] status - The current status of the scan.
     attr_reader :status
 
     def initialize(status:, **args)

lib/copyleaks/models/textModeration/requests/CopyleaksTextModerationRequestModel.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module Copyleaks
+  class CopyleaksTextModerationRequestModel
+    attr_accessor :text, :sandbox, :language, :labels
+
+    # @param text [String] Text to produce Text Moderation report for.
+    # @param sandbox [Boolean] Use sandbox mode to test your integration. Default: false.
+    # @param language [String, nil] The language code. Optional; set to nil for auto-detect.
+    # @param labels [Array<Object>] A list of label configurations (min 1, max 32 elements).
+    def initialize(text: '', sandbox: false, language: nil, labels: [])
+
+      @text = text
+      @sandbox = sandbox
+      @language = language
+      @labels = labels
+
+      raise ArgumentError, "String cannot be blank" if @text.nil?
+      raise ArgumentError, "Labels must be a non-empty array." unless labels.is_a?(Array) && !labels.empty?
+      raise ArgumentError, "Labels cannot have more than 32 elements." if labels.length > 32
+
+    end
+
+    def to_json(options = {})
+      {
+        text: @text,
+        sandbox: @sandbox,
+        language: @language,
+        labels: @labels
+      }.to_json(options)
+    end
+
+    def self.from_json(json_string)
+      data = JSON.parse(json_string, symbolize_names: true)
+      new(
+        text: data[:text],
+        sandbox: data[:sandbox],
+        language: data[:language],
+        labels: data[:labels]
+      )
+    end
+  end
+end

lib/copyleaks/models/textModeration/responses/CopyleaksTextModerationResponseModel.rb

@@ -0,0 +1,36 @@
+require 'json'
+module Copyleaks
+
+class CopyleaksTextModerationResponseModel
+  attr_accessor :moderations, :legend, :scanned_document
+
+  # @param moderations [ModerationsModel] Moderated text segments detected in the input text.
+  # @param legend [Array<TextModerationsLegend>] An array that provides a lookup for the labels referenced by their numerical indices in the `text.chars.labels` array. Each object within this legend array defines a specific label that was used in the scan.
+  # @param scanned_document [TextModerationScannedDocument] General information about the scanned document.
+  def initialize(moderations: ModerationsModel.new, legend: [], scanned_document: TextModerationScannedDocument.new, **_ignored)
+    @moderations = moderations
+    @legend = legend
+    @scanned_document = scanned_document
+  end
+
+
+  def to_json(options = {})
+    {
+      moderations: @moderations ? JSON.parse(@moderations.to_json) : nil,
+      legend: @legend.map(&:to_json).map { |l| JSON.parse(l) },
+      scannedDocument: @scanned_document ? JSON.parse(@scanned_document.to_json) : nil
+    }.to_json(options)
+  end
+
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      moderations: data[:moderations] ? ModerationsModel.from_json(data[:moderations].to_json) : nil,
+      legend: data[:legend].map { |l| TextModerationsLegend.from_json(l.to_json) },
+      scanned_document: data[:scannedDocument] ? TextModerationScannedDocument.from_json(data[:scannedDocument].to_json) : nil
+    )
+  end
+end
+
+end

lib/copyleaks/models/textModeration/responses/submodules/ModerationsModel.rb

@@ -0,0 +1,26 @@
+require 'json'
+module Copyleaks
+
+class ModerationsModel
+  attr_accessor :text
+
+  # @param text [Text] Moderated text segments corresponding to the submitted text. Each position in the inner arrays corresponds to a single segment in the textual version.
+  def initialize(text: Text.new)
+    @text = text
+  end
+
+  def to_json(options = {})
+    {
+      text: @text ? JSON.parse(@text.to_json) : nil
+    }.to_json(options)
+  end
+
+ 
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      text: data[:text] ? Text.from_json(data[:text].to_json) : nil
+    )
+  end
+end
+end

lib/copyleaks/models/textModeration/responses/submodules/Text.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module Copyleaks
+class Text
+  attr_accessor :chars
+
+  # @param chars [TextModerationChars] An object that groups together several arrays detailing the properties of labelled segments.
+  def initialize(chars: TextModerationChars.new)
+    @chars = chars
+  end
+
+  def to_json(options = {})
+    {
+      chars: @chars ? JSON.parse(@chars.to_json) : nil
+    }.to_json(options)
+  end
+
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      chars: data[:chars] ? TextModerationChars.from_json(data[:chars].to_json) : nil
+    )
+  end
+end
+end

lib/copyleaks/models/textModeration/responses/submodules/TextModerationChars.rb

@@ -0,0 +1,35 @@
+require 'json'
+module Copyleaks
+
+class TextModerationChars
+  attr_accessor :labels, :starts, :lengths
+
+  # @param starts [Array<Integer>] Start character position of the labelled segment.
+  # @param labels [Array<Integer>] Predicted label index for the corresponding segment. The index can be resolved to its ID using the supplied legend.
+  # @param lengths [Array<Integer>] Labelled segment character length.
+  def initialize( starts: [],labels: [], lengths: [])
+    @starts = starts
+    @labels = labels
+    @lengths = lengths
+  end
+
+
+  def to_json(options = {})
+    {
+      labels: @labels,
+      starts: @starts,
+      lengths: @lengths
+    }.to_json(options)
+  end
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      labels: data[:labels],
+      starts: data[:starts],
+      lengths: data[:lengths]
+    )
+  end
+end
+
+end

lib/copyleaks/models/textModeration/responses/submodules/TextModerationScannedDocument.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'date'
+module Copyleaks
+
+class TextModerationScannedDocument
+  attr_accessor :scan_id, :total_words, :total_excluded, :actual_credits, :expected_credits, :creation_time
+
+  # @param scan_id [String] The scan id given by the user.
+  # @param total_words [Integer] Total number of words found in the scanned text.
+  # @param total_excluded [Integer] Total excluded words from the text.
+  # @param actual_credits [Integer] The cost of credits for this scan.
+  # @param expected_credits [Integer] The amount of credits that was expected to be spent on the scan.
+  # @param creation_time [Time] Creation time of the scan.
+  def initialize(scan_id: '', total_words: 0, total_excluded: 0, actual_credits: 0, expected_credits: 0, creation_time: Time.utc.now)
+    @scan_id = scan_id
+    @total_words = total_words
+    @total_excluded = total_excluded
+    @actual_credits = actual_credits
+    @expected_credits = expected_credits
+    @creation_time = creation_time
+  end
+
+
+  def to_json(options = {})
+    {
+      scanId: @scan_id,
+      totalWords: @total_words,
+      totalExcluded: @total_excluded,
+      actualCredits: @actual_credits,
+      expectedCredits: @expected_credits,
+      creationTime: @creation_time.iso8601
+    }.to_json(options)
+  end
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      scan_id: data[:scanId],
+      total_words: data[:totalWords],
+      total_excluded: data[:totalExcluded],
+      actual_credits: data[:actualCredits],
+      expected_credits: data[:expectedCredits],
+      creation_time: Time.parse(data[:creationTime]) 
+    )
+  end
+end
+end