Merge pull request #361 from relayplatform/assistant-support

Support for Assistants, Threads, Messages and Runs

Author: alexrudall

lib/openai.rb

@@ -7,6 +7,11 @@
 require_relative "openai/finetunes"
 require_relative "openai/images"
 require_relative "openai/models"
+require_relative "openai/assistants"
+require_relative "openai/threads"
+require_relative "openai/messages"
+require_relative "openai/runs"
+require_relative "openai/run_steps"
 require_relative "openai/audio"
 require_relative "openai/version"
 
@@ -30,7 +35,7 @@ def initialize
       @organization_id = nil
       @uri_base = DEFAULT_URI_BASE
       @request_timeout = DEFAULT_REQUEST_TIMEOUT
-      @extra_headers = nil
+      @extra_headers = {}
     end
 
     def access_token

lib/openai/assistants.rb

@@ -0,0 +1,27 @@
+module OpenAI
+  class Assistants
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list
+      @client.get(path: "/assistants")
+    end
+
+    def retrieve(id:)
+      @client.get(path: "/assistants/#{id}")
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/assistants", parameters: parameters)
+    end
+
+    def modify(id:, parameters: {})
+      @client.json_post(path: "/assistants/#{id}", parameters: parameters)
+    end
+
+    def delete(id:)
+      @client.delete(path: "/assistants/#{id}")
+    end
+  end
+end

lib/openai/client.rb

@@ -53,12 +53,38 @@ def models
       @models ||= OpenAI::Models.new(client: self)
     end
 
+    def assistants
+      @assistants ||= OpenAI::Assistants.new(client: self)
+    end
+
+    def threads
+      @threads ||= OpenAI::Threads.new(client: self)
+    end
+
+    def messages
+      @messages ||= OpenAI::Messages.new(client: self)
+    end
+
+    def runs
+      @runs ||= OpenAI::Runs.new(client: self)
+    end
+
+    def run_steps
+      @run_steps ||= OpenAI::RunSteps.new(client: self)
+    end
+
     def moderations(parameters: {})
       json_post(path: "/moderations", parameters: parameters)
     end
 
     def azure?
       @api_type&.to_sym == :azure
     end
+
+    def beta(apis)
+      dup.tap do |client|
+        client.add_headers("OpenAI-Beta": apis.map { |k, v| "#{k}=#{v}" }.join(";"))
+      end
+    end
   end
 end

lib/openai/http.rb

@@ -1,13 +1,23 @@
 require "event_stream_parser"
 
+require_relative "http_headers"
+
 module OpenAI
   module HTTP
+    include HTTPHeaders
+
     def get(path:)
       parse_jsonl(conn.get(uri(path: path)) do |req|
         req.headers = headers
       end&.body)
     end
 
+    def post(path:)
+      parse_jsonl(conn.post(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
     def json_post(path:, parameters:)
       conn.post(uri(path: path)) do |req|
         configure_json_post_request(req, parameters)
@@ -78,29 +88,6 @@ def uri(path:)
       end
     end
 
-    def headers
-      if azure?
-        azure_headers
-      else
-        openai_headers
-      end.merge(@extra_headers || {})
-    end
-
-    def openai_headers
-      {
-        "Content-Type" => "application/json",
-        "Authorization" => "Bearer #{@access_token}",
-        "OpenAI-Organization" => @organization_id
-      }
-    end
-
-    def azure_headers
-      {
-        "Content-Type" => "application/json",
-        "api-key" => @access_token
-      }
-    end
-
     def multipart_parameters(parameters)
       parameters&.transform_values do |value|
         next value unless value.respond_to?(:close) # File or IO object.

lib/openai/http_headers.rb

@@ -0,0 +1,36 @@
+module OpenAI
+  module HTTPHeaders
+    def add_headers(headers)
+      @extra_headers = extra_headers.merge(headers.transform_keys(&:to_s))
+    end
+
+    private
+
+    def headers
+      if azure?
+        azure_headers
+      else
+        openai_headers
+      end.merge(extra_headers)
+    end
+
+    def openai_headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{@access_token}",
+        "OpenAI-Organization" => @organization_id
+      }
+    end
+
+    def azure_headers
+      {
+        "Content-Type" => "application/json",
+        "api-key" => @access_token
+      }
+    end
+
+    def extra_headers
+      @extra_headers ||= {}
+    end
+  end
+end

lib/openai/messages.rb

@@ -0,0 +1,23 @@
+module OpenAI
+  class Messages
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list(thread_id:)
+      @client.get(path: "/threads/#{thread_id}/messages")
+    end
+
+    def retrieve(thread_id:, id:)
+      @client.get(path: "/threads/#{thread_id}/messages/#{id}")
+    end
+
+    def create(thread_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/messages", parameters: parameters)
+    end
+
+    def modify(id:, thread_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/messages/#{id}", parameters: parameters)
+    end
+  end
+end

lib/openai/run_steps.rb

@@ -0,0 +1,15 @@
+module OpenAI
+  class RunSteps
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list(thread_id:, run_id:)
+      @client.get(path: "/threads/#{thread_id}/runs/#{run_id}/steps")
+    end
+
+    def retrieve(thread_id:, run_id:, id:)
+      @client.get(path: "/threads/#{thread_id}/runs/#{run_id}/steps/#{id}")
+    end
+  end
+end

lib/openai/runs.rb

@@ -0,0 +1,32 @@
+module OpenAI
+  class Runs
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list(thread_id:)
+      @client.get(path: "/threads/#{thread_id}/runs")
+    end
+
+    def retrieve(thread_id:, id:)
+      @client.get(path: "/threads/#{thread_id}/runs/#{id}")
+    end
+
+    def create(thread_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/runs", parameters: parameters)
+    end
+
+    def modify(id:, thread_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/runs/#{id}", parameters: parameters)
+    end
+
+    def cancel(id:, thread_id:)
+      @client.post(path: "/threads/#{thread_id}/runs/#{id}/cancel")
+    end
+
+    def submit_tool_outputs(thread_id:, run_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/runs/#{run_id}/submit_tool_outputs",
+                        parameters: parameters)
+    end
+  end
+end

lib/openai/threads.rb

@@ -0,0 +1,27 @@
+module OpenAI
+  class Threads
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list
+      @client.get(path: "/threads")
+    end
+
+    def retrieve(id:)
+      @client.get(path: "/threads/#{id}")
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/threads", parameters: parameters)
+    end
+
+    def modify(id:, parameters: {})
+      @client.json_post(path: "/threads/#{id}", parameters: parameters)
+    end
+
+    def delete(id:)
+      @client.delete(path: "/threads/#{id}")
+    end
+  end
+end