openai-assistant 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64fdebd2ebeba89ddc5a70fd0a3c56eb677935138de23e70dbdeafbd91ce5b84
-  data.tar.gz: f3b25cfae2e3e0dd3149a0da2d16f3719cf1ed54ddc8d1f22e0d6dcb4ab4a7d4
+  metadata.gz: e4ddb6b9bd825412979c3e7a33935200236dff748ce439c8c5ac29fb7dfadc6c
+  data.tar.gz: c0c4fa73e072bfc18daa545ce8b06243d581adc3a5d948ffad68e311016de6c6
 SHA512:
-  metadata.gz: 0665f422378e79c08cb8e249b10db948216c390159156bbec06f2b253799c1e525fb2a3a54d6c625157509657434b03901e902f7364714d3f253d67050a2fb35
-  data.tar.gz: 24e349e872037bec3e4ba5f95555cf0835dbee1aa1f496337d9f0cb93a4d21926eae4ca893e5d11fa9a01b5ea16bfcf7d8231f4327a53ad70eed4e28c349002c
+  metadata.gz: 67d7e18366125045cfbdb2180955b337a31b361eb8079c118a8fa8ca919b9d78878bf7879d910a2d942fdb3d5d85a23adbbf67d276974caf86d3c0c5223e0e7a
+  data.tar.gz: e3dab4d30f625f79d93f424641640f74089915b103dc7e2fa32d1995f29fdd5805cd402b73e639db6eef70f8b8c608dd36f669a3e9b41847997bf686480b3ee8

data/README.md

@@ -1,39 +1,25 @@
 # Openai::Assistant
+This project/gem is for Ruby interact with OpenAI Assistant throught rest api.
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/openai/assistant`. To experiment with that code, run `bin/console` for an interactive prompt.
+The client to call is: `Openai::Assistant`
 
 ## Installation
+Install throught RubyGems server by below step:
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+`$ bundle add openai/assistant`.
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+`$ bundle install openai/assistant`
 
 ## Usage
+You can direct interact with gem by:
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openai-assistant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/openai-assistant/blob/main/CODE_OF_CONDUCT.md).
-
-## License
+- use the gem `require "openai/assistant"`
+- setup the api key `instance =Openai::Assistant::new(${API_KEY})`
+- interact with assistant: 
+    + `instance.create_assistant(model, instruction)` 
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+    + `instance.retrieve_assistant(assistant_id)` 
 
-## Code of Conduct
+    + `instance.delete_assistant(assistant_id)` 
 
-Everyone interacting in the Openai::Assistant project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/openai-assistant/blob/main/CODE_OF_CONDUCT.md).
+    + `instance.list_assistant()`

data/lib/openai/assistant/version.rb

@@ -2,6 +2,6 @@
 
 module Openai
   class Assistant
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/openai/assistant.rb

@@ -10,12 +10,28 @@ module Openai
   # An openai assistant
   class Assistant
     @openai_api_key = nil
-    @openai_url = "https://api.openai.com/v1/assistants"
-    def self.initialize(api_key)
+    @openai_url = nil
+
+    # @param api_key [String] The api key of openai
+    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"
+    end
+
+    # @param api_key [String] The api key of openai
+    def self.setup(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"
     end
 
-    def self.create_assistant(model, instructions)
+    # @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 = @openai_url
       headers = {
         "Authorization": "Bearer #{@openai_api_key}",
@@ -40,7 +56,9 @@ module Openai
       parse_assistant_object(JSON.parse(resp.body))
     end
 
-    def self.retrieve_assistant(assistant_id)
+    # @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}"
       headers = {
         "Authorization": "Bearer #{@openai_api_key}",
@@ -59,7 +77,9 @@ module Openai
       parse_assistant_object(JSON.parse(resp.body))
     end
 
-    def self.delete_assistant(assistant_id)
+    # @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}"
       headers = {
         "Authorization": "Bearer #{@openai_api_key}",
@@ -77,7 +97,30 @@ module Openai
       parsed["deleted"]
     end
 
-    def self.parse_assistant_object(data)
+    # @return [Array<Openai::AssistantObj>] List all assistant
+    def list_assistant
+      url = @openai_url
+      headers = {
+        "Authorization": "Bearer #{@openai_api_key}",
+        "OpenAI-Beta": "assistants=v1",
+        "Content-Type": "application/json"
+      }
+      begin
+        resp = RestClient.get(url, headers)
+      rescue RestClient::ExceptionWithResponse => e
+        resp = e.response
+      end
+      parsed = JSON.parse(resp.body)
+      return parsed["error"]["code"] unless resp.code == 200
+
+      assistants = []
+      parsed["data"].each do |ast|
+        assistants << parse_assistant_object(ast)
+      end
+    end
+
+    # @return private
+    def parse_assistant_object(data)
       Openai::AssistantObj.new(
         id: data["id"],
         object: data["object"],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai-assistant
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - duonghds
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec