RubyGems - ruboty-openai_chat - Versions diffs - 0.1.2 → 0.3.0 - Mend

ruboty-openai_chat 0.1.2 → 0.3.0

Files changed (14) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +5 -0
data/README.md +7 -0
data/lib/ruboty/handlers/openai_chat.rb +20 -0
data/lib/ruboty/openai_chat/actions/base.rb +8 -0
data/lib/ruboty/openai_chat/actions/chat.rb +45 -50
data/lib/ruboty/openai_chat/actions/remember_profile.rb +23 -0
data/lib/ruboty/openai_chat/actions/show_profile.rb +24 -0
data/lib/ruboty/openai_chat/message.rb +47 -0
data/lib/ruboty/openai_chat/version.rb +1 -1
data/lib/ruboty/openai_chat.rb +9 -2
data/ruboty-openai_chat.gemspec +1 -1
metadata +7 -5
data/lib/ruboty/openai_chat/dialog.rb +0 -53

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 314d39333cd606e790f2258e93bcca1026a8b9a95b828ce635566874ad4d97ec
-  data.tar.gz: 6b4b9a87a46f6cb84208728b25a510285f23667a2e1872457f8a9510bd017803
+  metadata.gz: 56d165955c63d1811168c341cc949fa01edef6afefdbee4fca59968f4d45bcc0
+  data.tar.gz: 035fe05f51a35bb5c94bcb2347bf4e3f783455d741d1922ae04e70928c0bd71d
 SHA512:
-  metadata.gz: 14cc9e80b32707885731cc1d4f7dd3bb43e040fc7b0ec228e6ed0443547a2864c7b4c7492ba9d70f2ec464b5e8176fdceb4159a674c060a8906d2cc29c56ec2d
-  data.tar.gz: a363accd2db5225c2aea3578bc2867dfa111455b5a75022f072de0bdf8a5de9bf4030ac95afd049607506ceedf1ddc91d531a8d82d15b3bac28eb41edcb4ef42
+  metadata.gz: 8fd13b2d9393cc7971eb13555c98a1ff3c704e01d48cfbace79958f3b5adc3c18a8ecb1f1e3c928e2844a8f6ba22ec5d8dd69df98bafd5c5f39e9b32849b04b2
+  data.tar.gz: 272e9f664c55bf3d46542a06f1360018743a4a01228c92ab32cd27bb1af0157133a839e76912033ff494b500cd87ea262501941636754b5abff0b4ecf285b8a1

data/CHANGELOG.md CHANGED Viewed

@@ -1,4 +1,9 @@
 ## [Unreleased]
+## [0.2.0] - 2022-12-26
+- Add `remember openai profile` command to remember the pretext of AI prompt.
+- Add `show openai profile` command to show the pretext of AI prompt.
+- Make `OPENAI_CHAT_PRETEXT` optional.
 ## [0.1.0] - 2022-12-17

data/README.md CHANGED Viewed

@@ -10,6 +10,13 @@ Install the gem and add to the application's Gemfile by executing:
     $ bundle add ruboty-openai-chat
+## Commands
+```
+ruboty /remember chatbot profile (?<body>.+)/ - Remembers given sentence as pretext of AI prompt
+ruboty /show chatbot profile/ - Show the remembered profile
+```
 ### ENV
 - `OPENAI_ACCESS_TOKEN` - Pass OpenAI ACCESS TOKEN

data/lib/ruboty/handlers/openai_chat.rb CHANGED Viewed

@@ -18,9 +18,29 @@ module Ruboty
         name: "chat"
       )
+      on(
+        /remember chatbot profile (?<body>.+)/,
+        description: "Remembers given sentence as pretext of AI prompt",
+        name: "remember_profile"
+      )
+      on(
+        /show chatbot profile/,
+        description: "Show the remembered profile",
+        name: "show_profile"
+      )
       def chat(message)
         Ruboty::OpenAIChat::Actions::Chat.new(message).call
       end
+      def remember_profile(message)
+        Ruboty::OpenAIChat::Actions::RememberProfile.new(message).call
+      end
+      def show_profile(message)
+        Ruboty::OpenAIChat::Actions::ShowProfile.new(message).call
+      end
     end
   end
 end

data/lib/ruboty/openai_chat/actions/base.rb CHANGED Viewed

@@ -5,6 +5,9 @@ module Ruboty
     module Actions
       # @abstract
       class Base
+        NAMESPACE = "openai-chat-actions-chat"
+        PROFILE_KEY = "profile"
         attr_reader :message
         # @param message [Ruboty::Message]
@@ -27,6 +30,11 @@ module Ruboty
         def memory
           @memory ||= Memory.new(robot)
         end
+        # @return [Array<String>]
+        def pretexts
+          [ENV["OPENAI_CHAT_PRETEXT"], memory.namespace(NAMESPACE)[PROFILE_KEY]].compact
+        end
       end
     end
   end

data/lib/ruboty/openai_chat/actions/chat.rb CHANGED Viewed

@@ -6,77 +6,76 @@ module Ruboty
   module OpenAIChat
     module Actions
       class Chat < Base
-        NAMESPACE = "openai-chat-actions-chat"
         # @return [String]
         attr_reader :human_comment, :ai_comment
         def call
           human_comment = message[:body]
-          response = complete(human_comment)
-          p response if ENV["OPENAI_CHAT_DEBUG"]
+          response = request_chat(human_comment)
+          p response if Ruboty::OpenAIChat.debug_mode?
           raise response.body if response.code >= 400
-          ai_comment = response.dig("choices", 0, "text").gsub(/\A\s+/, "") || ""
+          ai_comment = response.dig("choices", 0, "message", "content").gsub(/\A\s+/, "") || ""
-          remember_dialog(Dialog.new(human_comment: human_comment, ai_comment: ai_comment, expire_at: expire_at))
+          remember_messages(
+            Message.new(role: :user, content: human_comment, expire_at: expire_at),
+            Message.new(role: :assistant, content: ai_comment, expire_at: expire_at)
+          )
           message.reply(ai_comment)
         rescue StandardError => e
           forget
           message.reply(e.message, code: true)
-          raise e if ENV["OPENAI_CHAT_DEBUG"]
+          raise e if Ruboty::OpenAIChat.debug_mode?
           true
         end
         private
-        def complete(human_comment)
+        def request_chat(human_comment)
           # https://beta.openai.com/examples/default-chat
-          client.completions(
+          client.chat(
             parameters: {
-              model: "text-davinci-003",
-              temperature: 0.9,
-              max_tokens: 512,
-              top_p: 1,
-              frequency_penalty: 0,
-              presence_penalty: 0.6,
-              stop: Dialog::STOP_SEQUENCES,
-              prompt: build_prompt(human_comment)
+              model: "gpt-3.5-turbo",
+              messages: build_messages(human_comment).map(&:to_api_hash),
+              temperature: 0.7
             }
           )
         end
-        def build_prompt(human_comment)
-          prefix = [prompt_prefix]
-          prefix += [ENV["OPENAI_CHAT_PRETEXT"]&.gsub(/\R/, " ")].compact
+        # @return [Array<Message>]
+        def build_messages(human_comment)
+          settings = <<~STRING.chomp
+            The following is a conversation with an AI assistant. The assistant is helpful, creative, clever, and very friendly. The AI assistant's name is #{robot.name}.
+          STRING
-          dialogs = [example_dialog, *dialogs_from_memory,
-                     Dialog.new(human_comment: human_comment, ai_comment: "")].map do |dialog|
-            dialog.to_prompt.chomp
-          end.join("\n")
+          system_messages = [Message.new(role: :system, content: settings)]
+          pretexts.each do |pretext|
+            system_messages << Message.new(role: :system, content: pretext.chomp)
+          end
-          <<~STRING.chomp
-            #{prefix.join(" ")}
+          pre_messages = [*example_dialog, *messages_from_memory]
-            #{dialogs}
-          STRING
+          [*system_messages, *pre_messages, Message.new(role: :user, content: human_comment)]
         end
         # @return [Array<Dialog>]
-        def dialogs_from_memory
-          raw_dialogs.reject! { |hash| Dialog.from_hash(hash).expired? }
-          raw_dialogs.map { |hash| Dialog.from_hash(hash) }
+        def messages_from_memory
+          current = Time.now
+          raw_messages.reject! { |hash| Message.from_hash(hash).expired?(current) }
+          raw_messages.map { |hash| Message.from_hash(hash) }
         end
-        # @param dialog [Dialog]
-        def remember_dialog(dialog)
-          raw_dialogs << dialog.to_h
+        # @param messages [Array<Message>]
+        def remember_messages(*messages)
+          messages.each do |message|
+            raw_messages << message.to_h
+          end
         end
         # @return [Array<Hash>]
-        def raw_dialogs
-          memory.namespace(NAMESPACE, message.from || "general")[:dialogs] ||= []
+        def raw_messages
+          memory.namespace(NAMESPACE, message.from || "general")[:messages] ||= []
         end
         def forget
@@ -85,26 +84,22 @@ module Ruboty
         # @return [Time]
         def expire_at
-          Time.now + ENV.fetch("OPENAI_CHAT_MEMORIZE_SECONDS") { 5 * 60 }.to_i
-        end
-        # @return [String]
-        def prompt_prefix
-          "The following is a conversation with an AI assistant. The assistant is helpful, creative, clever, and very friendly. The AI assistant's name is #{robot.name}."
+          Time.now + ENV.fetch("OPENAI_CHAT_MEMORIZE_SECONDS") { 15 * 60 }.to_i
         end
+        # @return [Array<Message>]
         def example_dialog
           case language
           when :ja
-            Dialog.new(
-              human_comment: "こんにちは。あなたは誰ですか？",
-              ai_comment: "私は OpenAI 製の AI アシスタントの #{robot.name} です。なにかお手伝いできることはありますか？"
-            )
+            [
+              Message.new(role: :user, content: "こんにちは。あなたは誰ですか？"),
+              Message.new(role: :assistant, content: "私は AI アシスタントの #{robot.name} です。なにかお手伝いできることはありますか？")
+            ]
           else
-            Dialog.new(
-              human_comment: "Hello, who are you?",
-              ai_comment: "I'm #{robot.name}, an AI assistant created by OpenAI. How can I help you today?"
-            )
+            [
+              Message.new(role: :user, content: "Hello, who are you?"),
+              Message.new(role: :assistant, content: "I'm #{robot.name}, an AI assistant. How can I help you today?")
+            ]
           end
         end

data/lib/ruboty/openai_chat/actions/remember_profile.rb ADDED Viewed

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require_relative "base"
+module Ruboty
+  module OpenAIChat
+    module Actions
+      class RememberProfile < Base
+        def call
+          new_profile = message[:body].strip
+          memory.namespace(NAMESPACE)[PROFILE_KEY] = new_profile
+          message.reply("Remembered the profile.")
+        rescue StandardError => e
+          message.reply(e.message, code: true)
+          raise e if ENV["OPENAI_CHAT_DEBUG"]
+          true
+        end
+      end
+    end
+  end
+end

data/lib/ruboty/openai_chat/actions/show_profile.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require_relative "base"
+module Ruboty
+  module OpenAIChat
+    module Actions
+      class ShowProfile < Base
+        def call
+          if (profile = memory.namespace(NAMESPACE)[PROFILE_KEY])
+            message.reply(profile, code: true)
+          else
+            message.reply("No profile is set.")
+          end
+        rescue StandardError => e
+          message.reply(e.message, code: true)
+          raise e if ENV["OPENAI_CHAT_DEBUG"]
+          true
+        end
+      end
+    end
+  end
+end

data/lib/ruboty/openai_chat/message.rb ADDED Viewed

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+module Ruboty
+  module OpenAIChat
+    class Message
+      ROLES = %i[system user assistant].freeze
+      # @return [:system, :user, :assistant]
+      attr_reader :role
+      # @return [String]
+      attr_reader :content
+      # @return [Time]
+      attr_reader :expire_at
+      def self.from_hash(hash)
+        new(**hash.transform_keys(&:to_sym))
+      end
+      # @param role [:system, :user, :assistant]
+      # @param content [String]
+      # @param expire_at [Time, Integer, nil]
+      def initialize(role:, content:, expire_at: nil)
+        @role = role.to_sym
+        raise ArgumentError, "role must be :system, :user, or :assistant" unless ROLES.include?(@role)
+        @content = content
+        @expire_at = expire_at&.yield_self { |t| Time.at(t) }
+      end
+      # @return [Hash]
+      def to_h
+        { role: role, content: content, expire_at: expire_at&.to_i }
+      end
+      def to_api_hash
+        { role: role, content: content }
+      end
+      # @return [Boolean]
+      def expired?(from = Time.now)
+        expire_at && (expire_at <= from)
+      end
+    end
+  end
+end

data/lib/ruboty/openai_chat/version.rb CHANGED Viewed

@@ -2,6 +2,6 @@
 module Ruboty
   module OpenAIChat
-    VERSION = "0.1.2"
+    VERSION = "0.3.0"
   end
 end

data/lib/ruboty/openai_chat.rb CHANGED Viewed

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 require "ruboty"
-require "ruby/openai"
+require "openai"
 require_relative "openai_chat/version"
 require_relative "openai_chat/actions/base"
 require_relative "openai_chat/actions/chat"
-require_relative "openai_chat/dialog"
+require_relative "openai_chat/actions/remember_profile"
+require_relative "openai_chat/actions/show_profile"
 require_relative "openai_chat/memory"
+require_relative "openai_chat/message"
 require_relative "handlers/openai_chat"
@@ -15,5 +17,10 @@ module Ruboty
   module OpenAIChat
     class Error < StandardError; end
     # Your code goes here...
+    # @return [Boolean]
+    def self.debug_mode?
+      ENV["OPENAI_CHAT_DEBUG"]&.length&.positive?
+    end
   end
 end

data/ruboty-openai_chat.gemspec CHANGED Viewed

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency "ruboty"
-  spec.add_dependency "ruby-openai", "~> 2.0"
+  spec.add_dependency "ruby-openai", "~> 3.5"
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboty-openai_chat
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Tomoya Chiba
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-20 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruboty
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.5'
 description:
 email:
 - tomo.asleep@gmail.com
@@ -59,8 +59,10 @@ files:
 - lib/ruboty/openai_chat.rb
 - lib/ruboty/openai_chat/actions/base.rb
 - lib/ruboty/openai_chat/actions/chat.rb
-- lib/ruboty/openai_chat/dialog.rb
+- lib/ruboty/openai_chat/actions/remember_profile.rb
+- lib/ruboty/openai_chat/actions/show_profile.rb
 - lib/ruboty/openai_chat/memory.rb
+- lib/ruboty/openai_chat/message.rb
 - lib/ruboty/openai_chat/version.rb
 - ruboty-openai_chat.gemspec
 homepage: https://github.com/tomoasleep/ruboty-openai_chat

data/lib/ruboty/openai_chat/dialog.rb DELETED Viewed

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-module Ruboty
-  module OpenAIChat
-    class Dialog
-      STOP_SEQUENCES = [">> Human: ", ">> AI: "].freeze
-      STOP_SEQUENCE_PATTERN = />> (Human|AI): /.freeze
-      # @return [String]
-      attr_reader :human_comment, :ai_comment
-      # @return [Time]
-      attr_reader :expire_at
-      def self.from_hash(hash)
-        new(**hash.transform_keys(&:to_sym))
-      end
-      # @param human_comment [String]
-      # @param ai_comment [String]
-      # @param expire_at [Time, Integer, nil]
-      def initialize(human_comment:, ai_comment:, expire_at: nil)
-        @human_comment = human_comment
-        @ai_comment = ai_comment
-        @expire_at = expire_at&.yield_self { |t| Time.at(t) }
-      end
-      # @return [String]
-      def to_prompt
-        <<~STRING
-          >> Human: #{escape(human_comment).chomp}
-          >> AI: #{escape(ai_comment).chomp}
-        STRING
-      end
-      # @return [Hash]
-      def to_h
-        { human_comment: human_comment, ai_comment: ai_comment, expire_at: expire_at&.to_i }
-      end
-      # @return [Boolean]
-      def expired?
-        expire_at && (expire_at <= Time.now)
-      end
-      private
-      def escape(text)
-        text.gsub(STOP_SEQUENCE_PATTERN, &:downcase)
-      end
-    end
-  end
-end