simple-openai-client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efa6dcdade7db76ddf992abe323c53b86f773bc6e1955caf03b3fbe5411b8910
+  data.tar.gz: 1851ceaf75dae20d8a1eb6f4f08ecd71b3b0002faf1e921d32aa0f03110e9480
+SHA512:
+  metadata.gz: b161ea843f3c55e500d303c18b51cd9a081c9d3250a5b70380fc8fdfac27ee506c640132094f834b2d64eced2fca2a10d25d7a2e1eb338fe7a8bbb5d70632951
+  data.tar.gz: e8e3f0e4b51c6c9f540dccc3eda4c91026bba5ee2ca53774296e756a71fd4b1ea34744379e60d78ff2171f638ac636c3e25bb7c92f244c1073d594354ba85cd8

data/lib/openai-client.rb

@@ -0,0 +1,163 @@
+# Reference:
+# - https://platform.openai.com/docs/guides/function-calling/supported-models
+#
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+class OpenAIClient
+    attr_accessor :api_key, :model, :messages, :functions, :callbacks, :version
+  
+    def initialize(api_key:, model:, messages: [], functions: [], callbacks: [], version: 'v2')
+      self.api_key = api_key
+      self.model = model
+      self.messages = messages
+      self.functions = functions
+      self.callbacks = callbacks
+      self.version = version
+    end
+  
+    # Return an array with the available models
+    def models
+      uri = URI("https://api.openai.com/v1/models")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+  
+      # Create a GET request instead of POST
+      request = Net::HTTP::Get.new(uri.request_uri, {
+        "Authorization" => "Bearer #{self.api_key}",
+        "Content-Type" => "application/json"
+        # Removed "OpenAI-Beta" header as it's typically not required
+      })
+  
+      response = http.request(request)
+  
+      if response.is_a?(Net::HTTPSuccess)
+        parsed_response = JSON.parse(response.body)
+        # Extract and return the list of models
+        parsed_response['data'].map { |model| model['id'] }
+      else
+        raise "Error: #{response.code} #{response.message}"
+        #puts response.body
+        #[]
+      end
+    rescue JSON::ParserError => e
+      raise "Failed to parse JSON response: #{e.message}"
+      #[]
+    rescue StandardError => e
+      raise "An error occurred: #{e.message}"
+      #[]
+    end # models
+
+    # Ask something to GPT.
+    # Return the response.
+    def ask(s, context: [])
+        # Use v1 chat completions endpoint (with functions support)
+        uri = URI("https://api.openai.com/v1/chat/completions")
+
+        # add contenxt to the history of messages
+        self.messages += context
+
+        # add new question asked by the user to the history of messages
+        self.messages << { "role" => "user", "content" => s }
+
+        request_body = {
+            "model" => self.model, # A known model that supports function calling; update as needed
+            "messages" => self.messages
+            # To let the model decide if and when to call a function, omit "function_call"
+            # If you want the model to call a function explicitly, you can add: "function_call" => "auto"
+        }
+
+        request_body["functions"] = self.functions if self.functions.size > 0
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        request = Net::HTTP::Post.new(uri.path, {
+            "Content-Type" => "application/json",
+            "Authorization" => "Bearer #{self.api_key}",
+            "OpenAI-Beta" => "assistants=#{version}"
+        })
+        request.body = JSON.dump(request_body)
+
+        response = http.request(request)
+
+        if response.is_a?(Net::HTTPSuccess)
+            response_json = JSON.parse(response.body)
+
+            # Check if the assistant decided to call a function
+            function_call = response_json.dig("choices", 0, "message", "function_call")
+
+            unless function_call
+                # add new response from AI to the history of messages
+                assistant_reply = response_json.dig("choices", 0, "message", "content")
+                self.messages << { "role" => "assistant", "content" => assistant_reply }
+                # return the resonse from AI
+                return assistant_reply
+            else
+                function_call_name = function_call["name"]
+                function_call_args = JSON.parse(function_call["arguments"]) rescue {}
+                
+                # Handle the function call
+                result = self.callbacks[function_call_name.to_sym].call(function_call_args);
+
+                # Now we send the function result back to the assistant as another message:
+                follow_up_uri = URI("https://api.openai.com/v1/chat/completions")
+                follow_up_messages = messages.dup
+                follow_up_messages << {
+                    "role" => "function",
+                    "name" => function_call_name,
+                    "content" => JSON.dump(result)
+                }
+
+                follow_up_request_body = {
+                    "model" => self.model,
+                    "messages" => follow_up_messages
+                }
+
+                follow_up_http = Net::HTTP.new(follow_up_uri.host, follow_up_uri.port)
+                follow_up_http.use_ssl = true
+
+                follow_up_request = Net::HTTP::Post.new(follow_up_uri.path, {
+                    "Content-Type" => "application/json",
+                    "Authorization" => "Bearer #{OPENAI_API_KEY}",
+                    "OpenAI-Beta" => "assistants=#{version}"
+                })
+                follow_up_request.body = JSON.dump(follow_up_request_body)
+                
+                follow_up_response = follow_up_http.request(follow_up_request)
+                if follow_up_response.is_a?(Net::HTTPSuccess)
+                    follow_up_response_json = JSON.parse(follow_up_response.body)
+                    final_reply = follow_up_response_json.dig("choices", 0, "message", "content")
+                    # add new response from AI to the history of messages
+                    self.messages << { "role" => "assistant", "content" => final_reply }
+                    # return the response form the AI.
+                    return final_reply
+                else
+                    raise "Error after function call: #{follow_up_response.code} - #{follow_up_response.message} - #{follow_up_response.body}"
+                end
+            end
+        else
+            raise "Error: #{response.code} - #{response.message} - #{response.body}"
+        end
+    end # def ask
+
+    # manage copilot from terminal
+    def console
+        puts "Mass-Copilot Console".blue
+        puts "Type 'exit' to quit.".blue
+        while true
+            print "You: ".green
+            prompt = gets.chomp
+            break if prompt.downcase.strip == 'exit'
+            begin
+                puts "Mass-Copilot: #{ask(prompt)}".blue
+            rescue => e
+                puts "Error: #{e.to_console}".red
+            end
+        end
+    end # def console
+
+end # class OpenAIClient
+  

data/openai-client.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+    s.name        = 'simple-openai-client'
+    s.version     = '1.0.1'
+    s.date        = '2025-01-05'
+    s.summary     = "Very simple Ruby library for operating OpenAI API for building Agents."
+    s.description = "Very simple Ruby library for operating OpenAI API for building Agents."
+    s.authors     = ["Leandro Daniel Sardi"]
+    s.email       = 'leandro@massprospecting.com'
+    s.files       = [
+      'lib/openai-client.rb',
+      'openai-client.gemspec'
+    ]
+    s.homepage    = 'https://github.com/leandrosardi/openai-client'
+    s.license     = 'MIT'
+    s.add_runtime_dependency 'uri', '~> 0.11.2', '>= 0.11.2'
+    s.add_runtime_dependency 'net-http', '~> 0.2.0', '>= 0.2.0'
+    s.add_runtime_dependency 'json', '~> 2.6.3', '>= 2.6.3'
+    s.add_runtime_dependency 'blackstack-core', '~> 1.2.15', '>= 1.2.15'
+    #s.add_runtime_dependency 'selenium-webdriver', '~> 4.10.0', '>= 4.10.0'
+    #s.add_runtime_dependency 'watir', '~> 7.3.0', '>= 7.3.0'
+    #s.add_runtime_dependency 'sequel', '~> 5.75.0', '>= 5.75.0'
+    s.add_runtime_dependency 'colorize', '~> 0.8.1', '>= 0.8.1'
+    s.add_runtime_dependency 'simple_cloud_logging', '~> 1.2.2', '>= 1.2.2'
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: simple-openai-client
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Leandro Daniel Sardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+- !ruby/object:Gem::Dependency
+  name: blackstack-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.15
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.15
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.15
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: simple_cloud_logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: Very simple Ruby library for operating OpenAI API for building Agents.
+email: leandro@massprospecting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/openai-client.rb
+- openai-client.gemspec
+homepage: https://github.com/leandrosardi/openai-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Very simple Ruby library for operating OpenAI API for building Agents.
+test_files: []