openai-assistant 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30d997127785423573776d064b5a0096f121df245af1c56511be53563b342505
-  data.tar.gz: 166a91a99f0caf0f5b08c9de791531c9f16c9493d2ffa1395db11237c982f620
+  metadata.gz: 44a58132dffbb0bb717d0c0f5c5760a222f88fde9f7cc9721e8ed0d91788e5bb
+  data.tar.gz: 45c2cebb8c681541526685d0c2ce90631cff61c7d0d7a72eb85b93c17b7fa23d
 SHA512:
-  metadata.gz: c5f306812242afaac48bd3da55e0280a36877238052ebdd5e75942d68bdf68cdbfc9a81d1c0ebeb2b9d8abd4b10644bdfaef37b1b22ba8580a5a00222a597693
-  data.tar.gz: 8aa5092ad31e0372595baf420020f8d953a500dce327cab67c9344221c7aceca230d4150ef11637304f8558eebcd7d32506ceb533a7de1f7e7647dd5c53dac96
+  metadata.gz: 37399c1452826279d1065a4a0829b0077fe017283e51b796055ff2830740bb668449ec90ec77109155c7b84d617fc7bd8643870e40537f4b77b9e13da90b98cc
+  data.tar.gz: a59828b4b77ea422d0aabfb2adcef8e499f5300514c42e4e45f69e09394b00234164cce72c6e25d597aa15396ab9dc9e2189a6bc3dc37e3cc617adc3f7268d9e

data/README.md

@@ -1,7 +1,7 @@
-# Openai::Assistant
+# OpenaiAsissistant::Assistant
 This project/gem is for Ruby interact with OpenAI Assistant throught rest api.
 
-The client to call is: `Openai::Assistant`
+The client to call is: `OpenaiAsissistant::Assistant`
 
 ## Installation
 Install throught RubyGems server by below step:
@@ -14,7 +14,7 @@ Install throught RubyGems server by below step:
 You can direct interact with gem by:
 
 - use the gem `require "openai/assistant"`
-- setup the api key `instance =Openai::Assistant::new(${API_KEY})`
+- setup the api key `instance =OpenaiAsissistant::Assistant::new(${API_KEY})`
 - interact with assistant: 
     + `instance.create_assistant(model, instruction)` 
 

data/lib/{openai → openai_assistant}/base.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-require_relative "../http/http"
-
-module Openai
+module OpenaiAsissistant
   # Base class of openai
   class Base
-    @openai_api_key = nil
-    @openai_url = nil
-    @http_client = nil
-
     def initialize(api_key = "")
       @openai_api_key = api_key
       # hard the host because if the official docs change the host, maybe it will change another
       # we need to update this gem for any change
       @openai_url = "https://api.openai.com/v1/assistants"
-      @http_client = Http::Client.new
+      @http_client = OpenaiAsissistant::HTTPClient.new
+    end
+
+    def default_headers
+      {
+        "Authorization": "Bearer #{@openai_api_key}",
+        "OpenAI-Beta": "assistants=v1",
+        "Content-Type": "application/json"
+      }
     end
   end
 end

data/lib/openai_assistant/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  module Assistant
+    # An openai assistant client
+    class Client
+      attr_accessor :api_key
+
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      def create_assistant(model, instructions)
+        OpenaiAsissistant::Assistant::Create.new(@api_key).create_assistant(model, instructions)
+      end
+
+      def retrieve_assistant(assistant_id)
+        OpenaiAsissistant::Assistant::Retrieve.new(@api_key).retrieve_assistant(assistant_id)
+      end
+
+      def list_assistant
+        OpenaiAsissistant::Assistant::List.new(@api_key).list_assistant
+      end
+
+      def delete_assistant(assistant_id)
+        OpenaiAsissistant::Assistant::Delete.new(@api_key).delete_assistant(assistant_id)
+      end
+    end
+  end
+end

data/lib/openai_assistant/clients/assistant/create.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  module Assistant
+    # An openai assistant
+    class Create < Base
+      # @param model [String] Select model of the assistant. refer on: https://platform.openai.com/docs/api-reference/models/list.
+      # @param instructions [String] The system instructions that the assistant uses.
+      # @return [OpenaiAsissistant::Mapper::Assistant] A new response object of assistant.
+      def create_assistant(model, instructions)
+        url = URI.parse(@openai_url)
+        req_body = {
+          "instructions": instructions,
+          "name": "assistant",
+          "tools": [{ "type": "code_interpreter" }],
+          "model": model
+        }.to_json
+        response = @http_client.call_post(url, req_body, default_headers)
+        return OpenaiAsissistant::ErrorResponse.from_json(response.body) unless response.code == "200"
+
+        OpenaiAsissistant::Mapper::Assistant.from_json(JSON.parse(response.body))
+      end
+    end
+  end
+end

data/lib/openai_assistant/clients/assistant/delete.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  module Assistant
+    # An openai assistant
+    class Delete < Base
+      # @param assistant_id [String] The id of assistant after create
+      # @return [String] Message delete the assistant ok or not
+      def delete_assistant(assistant_id)
+        url = "#{@openai_url}/#{assistant_id}"
+        uri = URI(url)
+        response = @http_client.call_delete(uri, default_headers)
+        return OpenaiAsissistant::ErrorResponse.from_json(response.body) unless response.code == "200"
+
+        true
+      end
+    end
+  end
+end

data/lib/openai_assistant/clients/assistant/list.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  module Assistant
+    # An openai assistant
+    class List < Base
+      # @return [Array<OpenaiAsissistant::Mapper::Assistant>] List all assistant
+      def list_assistant
+        url = @openai_url
+        uri = URI(url)
+        response = @http_client.call_get(uri, default_headers)
+        return OpenaiAsissistant::ErrorResponse.from_json(response.body) unless response.code == "200"
+
+        parsed = JSON.parse(response.body)
+        assistants = []
+        parsed["data"].each do |ast|
+          assistants << OpenaiAsissistant::Mapper::Assistant.from_json(ast)
+        end
+      end
+    end
+  end
+end

data/lib/openai_assistant/clients/assistant/retrieve.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  module Assistant
+    # An openai assistant
+    class Retrieve < Base
+      # @param assistant_id [String] The id of assistant after create
+      # @return [OpenaiAsissistant::Mapper::OpenaiAsissistant] A new response object of assistant.
+      def retrieve_assistant(assistant_id)
+        url = "#{@openai_url}/#{assistant_id}"
+        uri = URI(url)
+        response = @http_client.call_get(uri, default_headers)
+        return OpenaiAsissistant::ErrorResponse.from_json(response.body) unless response.code == "200"
+
+        OpenaiAsissistant::Mapper::Assistant.from_json(JSON.parse(response.body))
+      end
+    end
+  end
+end

data/lib/openai_assistant/clients/http/http.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  # An http client
+  class HTTPClient
+    # disable_ssl instead of ssl because almost the host is https
+    def call_post(url, req_body, headers, disable_ssl: false)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = disable_ssl ? false : true
+      request = Net::HTTP::Post.new(url.path, headers)
+      request.body = req_body unless req_body.nil?
+      http.request(request)
+    end
+
+    def call_delete(url, headers, disable_ssl: false)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = disable_ssl ? false : true
+      request = Net::HTTP::Delete.new(url.path, headers)
+      http.request(request)
+    end
+
+    def call_get(url, headers, disable_ssl: false)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = disable_ssl ? false : true
+      request = Net::HTTP::Get.new(url.path, headers)
+      http.request(request)
+    end
+  end
+end

data/lib/openai_assistant/error_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  # A error response of openai
+  class ErrorResponse
+    # @return [String] error message
+    attr_accessor :message
+    # @return [String] type of error
+    attr_accessor :type
+    # @return [String] parameter that caused the error
+    attr_accessor :param
+    # @return [String] error code of openai
+    attr_accessor :code
+
+    def initialize(**args)
+      args.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    def self.from_json(response_body)
+      data = JSON.parse(response_body)["error"]
+      OpenaiAsissistant::ErrorResponse.new(
+        message: data["message"],
+        type: data["type"],
+        param: data["param"],
+        code: data["code"]
+      )
+    end
+  end
+end

data/lib/openai_assistant/mappers/assistant.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  # A mapper of assistant
+  module Mapper
+    # A object model struct of assistant
+    class Assistant
+      # @return [String] The identifier, which can be referenced in API endpoints.
+      attr_accessor :id
+      # @return [String] The object type, which is always assistant.
+      attr_accessor :object
+      # @return [Integer] The Unix timestamp (in seconds) for when the assistant was created.
+      attr_accessor :created_at
+      # @return [String] The name of the assistant. The maximum length is 256 characters.
+      attr_accessor :name
+      # @return [String] The description of the assistant. The maximum length is 512 characters.
+      attr_accessor :description
+      # @return [String] ID of the model to use. Use the List models API to see all available models
+      attr_accessor :model
+      # @return [String] The system instructions that the assistant uses. The maximum length is 32768 characters.
+      attr_accessor :instructions
+      # @return [String] A list of tool enabled on the assistant.
+      attr_accessor :tools
+      # @return [String] A list of file IDs attached to this assistant.
+      attr_accessor :file_ids
+      # @return [String] Set of 16 key-value pairs that can be attached to an object.
+      attr_accessor :metadata
+
+      def initialize(**args)
+        args.each do |k, v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+
+      def self.from_json(data)
+        OpenaiAsissistant::Mapper::Assistant.new(
+          id: data["id"],
+          object: data["object"],
+          created_at: data["created_at"],
+          name: data["name"],
+          description: data["description"],
+          model: data["model"],
+          instructions: data["instructions"],
+          tools: data["tools"],
+          file_ids: data["file_ids"],
+          metadata: data["metadata"]
+        )
+      end
+    end
+  end
+end

data/lib/openai_assistant/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenaiAsissistant
+  VERSION = "1.0.0"
+end

data/lib/openai_assistant.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+require_relative "openai_assistant/clients/http/http"
+require_relative "openai_assistant/mappers/assistant"
+require_relative "openai_assistant/error_response"
+require_relative "openai_assistant/version"
+require_relative "openai_assistant/base"
+require_relative "openai_assistant/client"
+require_relative "openai_assistant/clients/assistant/create"
+require_relative "openai_assistant/clients/assistant/retrieve"
+require_relative "openai_assistant/clients/assistant/delete"
+require_relative "openai_assistant/clients/assistant/list"

data/openai-assistant.gemspec

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "lib/openai/base"
-require_relative "lib/openai/assistant/version"
+require_relative "lib/openai_assistant/base"
+require_relative "lib/openai_assistant/version"
 
 Gem::Specification.new do |spec|
   spec.name = "openai-assistant"
-  spec.version = Openai::Assistant::VERSION
+  spec.version = OpenaiAsissistant::VERSION
   spec.authors = ["duonghds"]
   spec.email = ["duong.hoang@employmenthero.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai-assistant
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - duonghds
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,11 +38,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/http/http.rb
-- lib/openai/assistant.rb
-- lib/openai/assistant/version.rb
-- lib/openai/assistant_obj.rb
-- lib/openai/base.rb
+- lib/openai_assistant.rb
+- lib/openai_assistant/base.rb
+- lib/openai_assistant/client.rb
+- lib/openai_assistant/clients/assistant/create.rb
+- lib/openai_assistant/clients/assistant/delete.rb
+- lib/openai_assistant/clients/assistant/list.rb
+- lib/openai_assistant/clients/assistant/retrieve.rb
+- lib/openai_assistant/clients/http/http.rb
+- lib/openai_assistant/error_response.rb
+- lib/openai_assistant/mappers/assistant.rb
+- lib/openai_assistant/version.rb
 - openai-assistant.gemspec
 - sig/openai/assistant.rbs
 homepage: https://rubygems.org/

data/lib/http/http.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "json"
-
-module Http
-  # An http client
-  class Client
-    def call_post(_url, req_body, headers)
-      http = Net::HTTP.new(_url.host, _url.port)
-      http.use_ssl = true
-      request = Net::HTTP::Post.new(_url.path, headers)
-      request.body = req_body unless req_body.nil?
-      http.request(request)
-    end
-
-    def call_delete(_url, headers)
-      http = Net::HTTP.new(_url.host, _url.port)
-      http.use_ssl = true
-      request = Net::HTTP::Delete.new(_url.path, headers)
-      http.request(request)
-    end
-
-    def call_get(_url, headers)
-      http = Net::HTTP.new(_url.host, _url.port)
-      http.use_ssl = true
-      request = Net::HTTP::Get.new(_url.path, headers)
-      http.request(request)
-    end
-  end
-end

data/lib/openai/assistant/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Openai
-  class Assistant < Openai::Base
-    VERSION = "0.6.0"
-  end
-end

data/lib/openai/assistant.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "assistant/version"
-require_relative "assistant_obj"
-require_relative "base"
-require_relative "../http/http"
-require "json"
-require "net/http"
-require "uri"
-
-module Openai
-  # An openai assistant
-  class Assistant < Base
-    # @param api_key [String] The api key of openai\
-    def initialize(api_key = "")
-      super(api_key)
-    end
-
-    # @param api_key [String] The api key of openai
-    def self.setup(api_key = "")
-      initialize(api_key)
-    end
-
-    # @param model [String] Select model of the assistant. refer on: https://platform.openai.com/docs/api-reference/models/list.
-    # @param instructions [String] The system instructions that the assistant uses.
-    # @return [Openai::AssistantObj] A new response object of assistant.
-    def create_assistant(model, instructions)
-      url = URI.parse(@openai_url)
-      req_body = {
-        "instructions": instructions,
-        "name": "assistant",
-        "tools": [{ "type": "code_interpreter" }],
-        "model": model
-      }.to_json
-      response = @http_client.call_post(url, req_body, default_headers)
-      unless response.code == "200"
-        parsed = JSON.parse(response.body)
-        return parsed["error"]["code"]
-      end
-      parse_assistant_object(JSON.parse(response.body))
-    end
-
-    # @param assistant_id [String] The id of assistant after create
-    # @return [Openai::AssistantObj] A new response object of assistant.
-    def retrieve_assistant(assistant_id)
-      url = "#{@openai_url}/#{assistant_id}"
-      uri = URI(url)
-      response = @http_client.call_get(uri, default_headers)
-      unless response.code == "200"
-        parsed = JSON.parse(response.body)
-        return parsed["error"]["code"]
-      end
-      parse_assistant_object(JSON.parse(response.body))
-    end
-
-    # @param assistant_id [String] The id of assistant after create
-    # @return [String] Message delete the assistant ok or not
-    def delete_assistant(assistant_id)
-      url = "#{@openai_url}/#{assistant_id}"
-      uri = URI(url)
-      response = @http_client.call_delete(uri, default_headers)
-      parsed = JSON.parse(response.body)
-      return parsed["error"]["code"] unless response.code == "200"
-
-      parsed["deleted"]
-    end
-
-    # @return [Array<Openai::AssistantObj>] List all assistant
-    def list_assistant
-      url = @openai_url
-      uri = URI(url)
-      response = @http_client.call_get(uri, default_headers)
-      parsed = JSON.parse(response.body)
-      return parsed["error"]["code"] unless response.code == "200"
-
-      assistants = []
-      parsed["data"].each do |ast|
-        assistants << parse_assistant_object(ast)
-      end
-    end
-
-    private
-
-    def parse_assistant_object(data)
-      Openai::AssistantObj.new(
-        id: data["id"],
-        object: data["object"],
-        created_at: data["created_at"],
-        name: data["name"],
-        description: data["description"],
-        model: data["model"],
-        instructions: data["instructions"],
-        tools: data["tools"],
-        file_ids: data["file_ids"],
-        metadata: data["metadata"]
-      )
-    end
-
-    def default_headers
-      {
-        "Authorization": "Bearer #{@openai_api_key}",
-        "OpenAI-Beta": "assistants=v1",
-        "Content-Type": "application/json"
-      }
-    end
-  end
-end

data/lib/openai/assistant_obj.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Openai
-  # A object model struct of assistant
-  class AssistantObj
-    # @return [String] The identifier, which can be referenced in API endpoints.
-    attr_accessor :id
-    # @return [String] The object type, which is always assistant.
-    attr_accessor :object
-    # @return [Integer] The Unix timestamp (in seconds) for when the assistant was created.
-    attr_accessor :created_at
-    # @return [String] The name of the assistant. The maximum length is 256 characters.
-    attr_accessor :name
-    # @return [String] The description of the assistant. The maximum length is 512 characters.
-    attr_accessor :description
-    # @return [String] ID of the model to use. Use the List models API to see all available models
-    attr_accessor :model
-    # @return [String] The system instructions that the assistant uses. The maximum length is 32768 characters.
-    attr_accessor :instructions
-    # @return [String] A list of tool enabled on the assistant.
-    attr_accessor :tools
-    # @return [String] A list of file IDs attached to this assistant.
-    attr_accessor :file_ids
-    # @return [String] Set of 16 key-value pairs that can be attached to an object.
-    attr_accessor :metadata
-
-    def initialize(**args)
-      args.each do |k, v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-end