Merge pull request #388 from shalecraig/incr/retrieve-params

Teach runs list endpoints to use parameters

Author: alexrudall

README.md

@@ -682,10 +682,10 @@ If the `status` response indicates that the `run` is `completed`, the associated
 
 ```ruby
 # Either retrieve all messages in bulk again, or...
-messages = client.messages.list(thread_id: thread_id) # Note: as of 2023-12-11 adding limit or order options isn't working, yet
+messages = client.messages.list(thread_id: thread_id, parameters: { order: 'asc' })
 
 # Alternatively retrieve the `run steps` for the run which link to the messages:
-run_steps = client.run_steps.list(thread_id: thread_id, run_id: run_id)
+run_steps = client.run_steps.list(thread_id: thread_id, run_id: run_id, parameters: { order: 'asc' })
 new_message_ids = run_steps['data'].filter_map { |step|
   if step['type'] == 'message_creation'
     step.dig('step_details', "message_creation", "message_id")
@@ -712,10 +712,10 @@ new_messages.each { |msg|
 }
 ```
 
-At any time you can list all runs which have been performed on a particular thread or are currently running (in descending/newest first order):
+At any time you can list all runs which have been performed on a particular thread or are currently running:
 
 ```ruby
-client.runs.list(thread_id: thread_id)
+client.runs.list(thread_id: thread_id, parameters: { order: "asc", limit: 3 })
 ```
 
 #### Create and Run

lib/openai/http.rb

@@ -6,8 +6,8 @@ module OpenAI
   module HTTP
     include HTTPHeaders
 
-    def get(path:)
-      parse_jsonl(conn.get(uri(path: path)) do |req|
+    def get(path:, parameters: nil)
+      parse_jsonl(conn.get(uri(path: path), parameters) do |req|
         req.headers = headers
       end&.body)
     end

lib/openai/messages.rb

@@ -4,8 +4,8 @@ def initialize(client:)
       @client = client.beta(assistants: "v1")
     end
 
-    def list(thread_id:)
-      @client.get(path: "/threads/#{thread_id}/messages")
+    def list(thread_id:, parameters: {})
+      @client.get(path: "/threads/#{thread_id}/messages", parameters: parameters)
     end
 
     def retrieve(thread_id:, id:)

lib/openai/run_steps.rb

@@ -4,8 +4,8 @@ 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")
+    def list(thread_id:, run_id:, parameters: {})
+      @client.get(path: "/threads/#{thread_id}/runs/#{run_id}/steps", parameters: parameters)
     end
 
     def retrieve(thread_id:, run_id:, id:)

lib/openai/runs.rb

@@ -4,8 +4,8 @@ def initialize(client:)
       @client = client.beta(assistants: "v1")
     end
 
-    def list(thread_id:)
-      @client.get(path: "/threads/#{thread_id}/runs")
+    def list(thread_id:, parameters: {})
+      @client.get(path: "/threads/#{thread_id}/runs", parameters: parameters)
     end
 
     def retrieve(thread_id:, id:)