awesome_chatgpt_actors 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32fe37cedd30787d20eaf95c4851cc99c4ec4102fae81f88743a071021e88479
-  data.tar.gz: f003f44265f1ead45eb6ea6141a00ba1e8c198015f5403c2e5abb7686d4c4ebb
+  metadata.gz: bb98a39fa29a5a112ba5072ed224c3bcad7fcd191bf22292228489706640ded8
+  data.tar.gz: 50e5314d33d6076d7480270085f2e38a533f53ae2777274d564be6310dd91a95
 SHA512:
-  metadata.gz: ed506787224dab1fea674f0007caa582fd00a79e5d1d4bb2d2615397265f6b9f04e7c3871fd88d6920014517bd09c6abf90e553b16dce833d89bb6bf422b0ffd
-  data.tar.gz: 3aefa40ed4abcf6f55cedc02b7963bee4de5477779e5235eafa96fa536e9cadd0e176114f00e5f3b01ba0049630c616f93f8b9d258d374653c47bb5a16fb124b
+  metadata.gz: 91e38acb91ebb2a453b1df7691dbd43a7c0f7c12952ba2c9c62ad104f6af34f8a584a15189ef6d4af4ff4e5a717ebfc53d32df568754ffd1cc5ac894af1e46d1
+  data.tar.gz: 2ebc58e6212bc50577b1e513ebf5d1254d78747a615885c1a80ae90709bb6881ce95989d550b8b5d219562f0c58f2075a6e6964d01e955f61170b45cff864190

data/Gemfile

@@ -10,9 +10,7 @@ gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
 
-gem "csv"
-
-gem "openai"
+gem "csv", "~> 3.1"
 
 gem "rails", require: false
 

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    awesome_chatgpt_actors (0.1.1)
-      csv
-      openai
+    awesome_chatgpt_actors (0.1.3)
+      csv (~> 3.1)
 
 GEM
   remote: https://rubygems.org/
@@ -111,7 +110,6 @@ GEM
     nio4r (2.5.9)
     nokogiri (1.14.3-x86_64-linux)
       racc (~> 1.4)
-    openai (0.3.0)
     parallel (1.22.1)
     parser (3.2.2.0)
       ast (~> 2.4.1)
@@ -192,12 +190,12 @@ GEM
     zeitwerk (2.6.7)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
   awesome_chatgpt_actors!
-  csv
-  openai
+  csv (~> 3.1)
   rails
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -1,7 +1,12 @@
-# AwesomeChatgptActors
+# Awesome ChatGPT Actors
 
-This gem is a collection of actors made for use the [AwesomeChatgptPrompts](https://github.com/f/awesome-chatgpt-prompts) in ruby.
+This gem is a collection of actors made with [Awesome Chatgpt Prompts](https://github.com/f/awesome-chatgpt-prompts) in ruby.
 So for prompts information, please refer to that repository.
+The prompts was edited and translated to brazillian portuguese, so it can be used in english and portuguese.
+The actors is currently been tested, and it's default values will be changed in the future.
+
+## Requirements
+- Ruby 2.6 or higher
 
 ## Installation
 
@@ -27,67 +32,105 @@ Run in the command line:
 ```ruby
 require 'awesome_chatgpt_actors'
 
-# Initialize a new actor
+# Initialize a new actor with default options
 actor = AwesomeChatgptActors::Actor.new
 
 # it will return an actor with the following options
 # {
-#   actor: 'Virtual Assistant',
-#   prompt: 'I want you to act as a virtual assistant. I will give you tasks and you will reply with the results of the tasks. I want you to only reply with the results of the tasks, and nothing else. Do not write explanations. My first task is ""I want you to write a short story about a cat"""
+#   role: 'Virtual Assistant',
+#   prompt: 'I want you to act as a virtual assistant. I will give you tasks and you will reply with the results of the tasks. I want you to only reply with the results of the tasks, and nothing else. Do not write explanations. My first task is ""I want you to write a short story about a cat""",
+#   actors_csv: csv_path_of_current_actor,
+#   accertivity: 1, # 1 is the most accertive, 2 is the least accertiv, this is called as temperature in openai
+#   default_frequency: 0, # can be changed if you define a default prompt to when instance is initialized
+#   default_presence: 0, # can be changed if you define a default prompt to when instance is initialized
+#   has_placeholder: false, # has a placeholder in the prompt or role to be replaced by the user input
+#   language: 'en', # pt for portuguese, en for english, it can be changed even if you don't provide an default prompt
 # }
 
 # Initialize a new actor with options
 actor = AwesomeChatgptActors::Actor.new(
-  actor: 'Linux Terminal', # The type of actor to use, check the list in https://github.com/f/awesome-chatgpt-prompts/blob/main/prompts.csv
-  language: 'en', # The language of the prompt, if other language is specified, it will requirean openai api key to perform the translation
+  role: 'Virtual Assistant', # DEFAULT. Not required. The type of actor to use, check the list in https://github.com/f/awesome-chatgpt-prompts/blob/main/prompts.csv
+  language: 'en', # DEFAULT. Not required. The language of the prompt, if other language is specified, it will requirean openai api key to perform the translation
 )
 
-# Initialize a new actor with options
+# Initialize a new actor with othe acceptable language
 actor = AwesomeChatgptActors::Actor.new(
   language: 'pt',
-  openai_api_key: 'Your OpenAI API Key' # it can be nil if you provide it as an environment variable OPENAI_API_KEY
 )
 
-# Initialize a new actor with options
+# Initialize a new actor with a different role and language
 actor = AwesomeChatgptActors::Actor.new(
-  prompt: 'I want you to act as a virtual assistant. I will give you tasks and you will reply with the results of the tasks. I want you to only reply with the results of the tasks, and nothing else. Do not write explanations. My first task is ""I want you to write a short story about a cat"""'
+  role: 'Virtual Assistant',
+  language: 'pt',
+)
+
+# Initialize a new actor with a different attributes
+## To change the attributes, you need to initialize the actor with a different prompt or it will use the default prompt of the role
+actor = AwesomeChatgptActors::Actor.new(
+  role: 'Virtual Assistant',
+  language: 'en',
+  prompt: 'I want you to act as a virtual assistant. I will give you tasks and you will reply with the results of the tasks. I want you to only reply with the results of the tasks, and nothing else. Do not write explanations. My first task is ""I want you to write a short story about a cat"""',
+  accertivity: 1, # 1 is the most accertive, 2 is the least accertiv, this is called as temperature in openai
+  default_frequency: 0, # can be changed if you define a default prompt to when instance is initialized
+  default_presence: 0, # can be changed if you define a default prompt to when instance is initialized
+  has_placeholder: false, # has a placeholder in the prompt or role to be replaced by the user input
 )
 
 # Initialize a random actor
 actor = AwesomeChatgptActors::Actor.new(
-  random: true
+  random: true,
 )
 
+
+# Initialize a random actor with a different language
+actor = AwesomeChatgptActors::Actor.new(
+  random: true,
+  language: 'pt',
+)
+
+
 # Change the actor
-actor.act_as(actor: 'Virtual Assistant', language: 'ru') # it will return the same actor with the new options, check the list in https://github.com/f/awesome-chatgpt-prompts/blob/main/prompts.csv
+actor.act_as('Virtual Assistant') # it will return the same actor with the new options, check the list in https://github.com/f/awesome-chatgpt-prompts/blob/main/prompts.csv
 
 # Add a new actor to csv file
-AwesomeChatgptActors::CastControl.add_actor(actor: 'Virtual Assistant', prompt: 'I want you to act as a virtual assistant. I will give you tasks and you will reply with the results of the tasks. I want you to only reply with the results of the tasks, and nothing else. Do not write explanations. My first task is ""I want you to write a short story about a cat"""')
+## The actor will be added to the csv file with the default options, the only required option is the actor role and prompt, if a different language is specified, it will add the prompt in the language specified csv file
+AwesomeChatgptActors::CastControl.add_actor(actor: 'Virtual Assistant', prompt: 'I want you to act as a virtual assistant. I will give you tasks and you will reply with the results of the tasks. I want you to only reply with the results of the tasks, and nothing else. Do not write explanations. My first task is ""I want you to write a short story about a cat"""', has_placeholder: false, accertivity: 1, default_frequency: 0, default_presence: 0, language: 'en')
 
 # Remove an actor from csv file
-AwesomeChatgptActors::CastControl.remove_actor(actor: 'Virtual Assistant')
+## The actor will be removed from the csv file, if a different language is specified, it will remove the actor from the language specified csv file
+AwesomeChatgptActors::CastControl.remove_actor(actor: 'Virtual Assistant', language: 'en')
 
 # Get a list of all actors
-AwesomeChatgptActors::CastoControl.actors
+AwesomeChatgptActors::CastControl.actors
+
+# Get a list of all actors in a different language
+AwesomeChatgptActors::CastControl.actors_pt
 
 # Check if an actor exists
 AwesomeChatgptActors::CastControl.actor_exists?(actor: 'Virtual Assistant')
 
+# Check if an actor exists in a different language
+AwesomeChatgptActors::CastControl.actor_exists_in_pt?(actor: 'Virtual Assistant')
+
 # CSV file path
 AwesomeChatgptActors::CastControl.csv_path # can be overriden by setting the environment variable CAST_CSV_PATH
 
+# CSV file path in a different language
+AwesomeChatgptActors::CastControl.pt_csv_path # can be overriden by setting the environment variable CAST_CSV_PATH_PT
+
 # TEMP file path
 AwesomeChatgptActors::CastControl.temp_path # can be overriden by setting the environment variable CAST_TEMP_PATH
 ```
 
 ## Testing
-
+Create a .env_test file with the same variables as the .env file, but with the test values.
 This gem was tested with Rspec. To run the tests, execute:
 
     $ bundle exec rspec
 
 <!-- Coverage: -->
 <!-- local image path: coverage-image/simplecov-actors.png -->
+[![Coverage Status](https://raw.githubusercontent.com/JesusGautamah/awesome-chatgpt-actors/master/coverage-image/simplecov-actors.png)](  https://raw.githubusercontent.com/JesusGautamah/awesome-chatgpt-actors/master/coverage-image/simplecov-actors.png)
 
 ## Contributing
 

data/awesome_chatgpt_actors.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
@@ -28,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "csv"
-  spec.add_dependency "openai"
+  spec.add_dependency "csv", "~> 3.1"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/awesome_chatgpt_actors/actor.rb

@@ -3,33 +3,35 @@
 module AwesomeChatgptActors
   # This class is the implementation of Awesome Chatgpt Prompts with improvements
   class Actor
-    def initialize(prompt_type: "Virtual Assistant", language: "en", openai_api_key: nil, random: false)
-      @csv_path = CastControl.csv_path
+    def initialize(role: "Virtual Assistant", prompt: nil,  language: "en",  random: false,
+                    has_placeholder: false, accertivity: 1, default_frequency: 0, default_presence: 0)          
+      @csv_path = CastControl.csv_path if language == "en"
+      @csv_path = CastControl.csv_path.gsub("en", language) if language != "en"
       @language = language || "en"
-      @openai_api_key = openai_api_key if openai_api_key
       @actors_csv = CSV.read(@csv_path, headers: true)
-      @actor = prompt_type
-      act_as(prompt_type) unless random
+      @role = role
+      @prompt = prompt
+      @random = random
+      @accertivity = accertivity
+      @default_frequency = default_frequency
+      @default_presence = default_presence
+      @has_placeholder = has_placeholder
+      act_as(role) unless random || prompt
       act_as(random_actor) if random
     end
 
-    attr_accessor :actor, :prompt, :actors_csv
-    attr_reader :csv_path
-
-    def act_as(prompt_type = "Virtual Assistant")
-      @actor = prompt_type
-      actor_row = actors_csv.select { |row| row["act"] == actor }
-      raise ArgumentError, "Actor type not found: #{actor}" if actor_row.empty?
+    attr_accessor :role, :prompt, :actors_csv, :accertivity, :default_frequency, :default_presence, :has_placeholder
+    attr_reader :csv_path, :random
 
+    def act_as(role = "Virtual Assistant")
+      @role = role
+      actor_row = actors_csv.select { |row| row["act"] == role }
+      raise ArgumentError, "Role not found: #{role}" if actor_row.empty?
       @prompt = actor_row.sample["prompt"]
-      self
-    end
-
-    def with_language(lang)
-      raise "No actor initialized" if prompt.nil?
-      raise "No language provided" if lang.nil?
-
-      @prompt = translate_prompt(text: prompt, language: lang)
+      @accertivity = actor_row.sample["accertivity"].to_i
+      @default_frequency = actor_row.sample["default_frequency"].to_i
+      @default_presence = actor_row.sample["default_presence"].to_i
+      @has_placeholder = actor_row.sample["has_placeholder"] == "false" ? false : true
       self
     end
 
@@ -37,10 +39,6 @@ module AwesomeChatgptActors
 
     attr_reader :language
 
-    def openai_api_key
-      @openai_api_key ||= ENV.fetch("OPENAI_API_KEY", nil)
-    end
-
     private
 
     def random_actor
@@ -49,17 +47,5 @@ module AwesomeChatgptActors
 
       actor
     end
-
-    def translate_prompt(text: nil, language: nil)
-      text = "Translate the following text from English to #{language}: \n\n#{text}\n\n"
-      client = OpenAI::Client.new(api_key: openai_api_key)
-      response = client.completions(
-        engine: "text-davinci-003", prompt: text,
-        temperature: 0.1, max_tokens: 200,
-        top_p: 1, frequency_penalty: 0,
-        presence_penalty: 0, stop: ["\n\n"]
-      )
-      response.choices.first.text
-    end
   end
 end

data/lib/awesome_chatgpt_actors/cast_control.rb

@@ -4,7 +4,11 @@ module AwesomeChatgptActors
   # This class is responsible to control the actors csv file
   class CastControl
     def self.csv_path
-      ENV.fetch("CAST_CSV_NAME", "prompts-data/awesome-chatgpt-prompts.csv")
+      ENV.fetch("CAST_CSV_NAME", "prompts-data/awesome-en-prompts.csv")
+    end
+
+    def self.pt_csv_path
+      ENV.fetch("CAST_PT_CSV_NAME", "prompts-data/awesome-pt-prompts.csv")
     end
 
     def self.temp_path
@@ -17,17 +21,36 @@ module AwesomeChatgptActors
       @actors_csv = CSV.read(csv_path, headers: true, quote_char: '"', col_sep: ",", row_sep: :auto)
     end
 
+    def self.actors_pt_csv
+      raise "The csv file does not exist" unless File.exist?(pt_csv_path)
+
+      @actors_pt_csv = CSV.read(pt_csv_path, headers: true, quote_char: '"', col_sep: ",", row_sep: :auto)
+    end
+
     def self.actors
       raise "The csv file does not exist" unless File.exist?(csv_path)
 
       actors_csv.map { |row| row["act"] }.uniq
     end
 
-    def self.add_actor(actor: nil, prompt: nil)
+    def self.actors_pt
+      raise "The csv file does not exist" unless File.exist?(pt_csv_path)
+
+      actors_pt_csv.map { |row| row["act"] }.uniq
+    end
+
+    def self.add_actor(actor: nil, prompt: nil, has_placeholder: false, accertivity: 1, default_frequency: 0, default_presence: 0, language: "en")
+      file_path = csv_path if language == "en"
+      file_path = pt_csv_path if language == "pt"
+
+      raise "The actor is nil" if actor.nil?
+      raise "The prompt is nil" if prompt.nil?
+      raise "File path is nil" if file_path.nil?
+      raise "The csv file does not exist" unless File.exist?(file_path)
       raise "The actor already exists" if actor_exist?(actor: actor)
 
-      CSV.open(csv_path, "a", headers: true, quote_char: '"', col_sep: ",", force_quotes: true) do |csv|
-        csv << [actor, prompt]
+      CSV.open(file_path, "a", headers: true, quote_char: '"', col_sep: ",", force_quotes: true) do |csv|
+        csv << [actor, prompt, has_placeholder, accertivity, default_frequency, default_presence]
       end
     end
 
@@ -39,15 +62,32 @@ module AwesomeChatgptActors
       act_column_to_array.include? actor
     end
 
-    def self.remove_actor(actor: nil)
-      raise "The actor does not exist" unless actor_exist?(actor: actor)
+    def self.actor_exist_in_pt?(actor: nil)
+      raise "The actor is nil" if actor.nil?
+      raise "The csv file does not exist" unless File.exist?(pt_csv_path)
+
+      act_column_to_array = actors_pt_csv.map { |row| row["act"] }
+      act_column_to_array.include? actor
+    end
+
+    def self.remove_actor(actor: nil, language: "en")
+      file_path = csv_path if language == "en"
+      file_path = pt_csv_path if language == "pt"
+
+      raise "The actor is nil" if actor.nil?
+      raise "File path is nil" if file_path.nil?
+      raise "The csv file does not exist" unless File.exist?(file_path)
+      (raise "The actor does not exist" unless actor_exist?(actor: actor)) if language == "en"
+      (raise "The actor does not exist" unless actor_exist_in_pt?(actor: actor)) if language == "pt"
 
-      actors_csv.delete_if { |row| row["act"] == actor }
+      actors_csv.delete_if { |row| row["act"] == actor } if language == "en"
+      actors_pt_csv.delete_if { |row| row["act"] == actor } if language == "pt"
       CSV.open(temp_path, "w", headers: true, quote_char: '"', col_sep: ",", force_quotes: true) do |csv|
-        csv << %w[act prompt]
-        actors_csv.each { |row| csv << row unless row["act"] == actor }
+        csv << %w[act prompt has_placeholder accertivity default_frequency default_presence]
+        actors_csv.each { |row| csv << row unless row["act"] == actor } if language == "en"
+        actors_pt_csv.each { |row| csv << row unless row["act"] == actor } if language == "pt"
       end
-      FileUtils.mv(temp_path, csv_path)
+      FileUtils.mv(temp_path, file_path)
     end
   end
 end

data/lib/awesome_chatgpt_actors/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AwesomeChatgptActors
-  VERSION = "0.1.1"
-end
+  VERSION = "0.1.3"
+end

data/lib/awesome_chatgpt_actors.rb

@@ -4,7 +4,6 @@ require_relative "awesome_chatgpt_actors/version"
 require_relative "awesome_chatgpt_actors/actor"
 require_relative "awesome_chatgpt_actors/cast_control"
 require "csv"
-require "openai"
 
 # Main module
 module AwesomeChatgptActors

data/lib/tasks/chatgpt_actors.rake

@@ -1,15 +1,24 @@
 # frozen_string_literal: true
 
 namespace :chatgpt_actors do
-  desc "Copy $GEM/prompts-data/awesome-chatgpt-prompts.csv to ./prompts-data/awesome-chatgpt-prompts.csv"
+  desc "Copy $GEM/prompts-data/awesome-language-prompts.csv to ./prompts-data/awesome-language-prompts.csv"
   task :install do
-    path = Gem::Specification.find_by_name("awesome_chatgpt_actors") # rubocop:disable Style/StringConcatenation
-                             .gem_dir + "/prompts-data/awesome-chatgpt-prompts.csv"
-    raise "File not found: #{path}" unless File.exist?(path)
-    raise "File already exists: prompts-data/awesome-chatgpt-prompts.csv" if File.exist?("prompts-data/awesome-chatgpt-prompts.csv")
+    en_path = Gem::Specification.find_by_name("awesome_chatgpt_actors")
+                             .gem_dir + "/prompts-data/awesome-en-prompts.csv"
+    pt_path = Gem::Specification.find_by_name("awesome_chatgpt_actors")
+                              .gem_dir + "/prompts-data/awesome-pt-prompts.csv"
+    paths = [en_path, pt_path]
+    raise "File not found: #{paths[0]}" unless File.exist?(paths[0])
+    raise "File not found: #{paths[1]}" unless File.exist?(paths[1])
 
     FileUtils.mkdir_p("prompts-data") unless Dir.exist?("prompts-data")
-    FileUtils.cp(path, "prompts-data/awesome-chatgpt-prompts.csv")
-    puts "Installed prompts-data/awesome-chatgpt-prompts.csv"
+
+    FileUtils.cp(paths[0], "prompts-data/awesome-en-prompts.csv")
+    puts "Installed prompts-data/awesome-en-prompts.csv"
+
+    FileUtils.cp(paths[1], "prompts-data/awesome-pt-prompts.csv")
+    puts "Installed prompts-data/awesome-pt-prompts.csv"
+    puts "You can contribute to the project adding more actors and prompts or languages at"
+    puts "https://github.com/JesusGautamah/awesome_chatgpt_actors"
   end
 end