Merge pull request #579 from alexrudall/feat/responses-endpoints

Add other Responses endpoints

Author: alexrudall

README.md

@@ -468,28 +468,28 @@ You can stream it as well!
 ### Responses API
 OpenAI's most advanced interface for generating model responses. Supports text and image inputs, and text outputs. Create stateful interactions with the model, using the output of previous responses as input. Extend the model's capabilities with built-in tools for file search, web search, computer use, and more. Allow the model access to external systems and data using function calling.
 
+#### Create a Response
 ```ruby
-response = client.responses(parameters: {
+response = client.responses.create(parameters: {
   model: "gpt-4o",
   input: "Hello!"
 })
-
 puts response.dig("output", 0, "content", 0, "text")
 ```
-#### Follow-up Messages (former threads functionality available in the Assistant API)
+
+#### Follow-up Messages
 ```ruby
-followup = client.responses(parameters: {
+followup = client.responses.create(parameters: {
   model: "gpt-4o",
   input: "Remind me, what is my name?",
   previous_response_id: response["id"]
 })
-
 puts followup.dig("output", 0, "content", 0, "text")
 ```
 
 #### Tool Calls
 ```ruby
-response = client.responses(parameters: {
+response = client.responses.create(parameters: {
   model: "gpt-4o",
   input: "What's the weather in Paris?",
   tools: [
@@ -510,29 +510,43 @@ response = client.responses(parameters: {
     }
   ]
 })
-
 puts response.dig("output", 0, "name") # => "get_current_weather"
 ```
 
 #### Streaming
 ```ruby
 chunks = []
 streamer = proc { |chunk, _| chunks << chunk }
-
-client.responses(parameters: {
+client.responses.create(parameters: {
   model: "gpt-4o",
   input: "Hello!",
   stream: streamer
 })
-
 output = chunks
   .select { |c| c["type"] == "response.output_text.delta" }
   .map { |c| c["delta"] }
   .join
-
 puts output
 ```
 
+#### Retrieve a Response
+```ruby
+retrieved_response = client.responses.retrieve(response_id: response["id"])
+puts retrieved_response["object"] # => "response"
+```
+
+#### Delete a Response
+```ruby
+deletion = client.responses.delete(response_id: response["id"])
+puts deletion["deleted"] # => true
+```
+
+#### List Input Items
+```ruby
+input_items = client.responses.input_items(response_id: response["id"])
+puts input_items["object"] # => "list"
+```
+
 ### Functions
 
 You can describe and pass in functions and the model will intelligently choose to output a JSON object containing arguments to call them - eg., to use your method `get_current_weather` to get the weather in a given location. Note that tool_choice is optional, but if you exclude it, the model will choose whether to use the function or not ([see here](https://platform.openai.com/docs/api-reference/chat/create#chat-create-tool_choice)).

lib/openai.rb

@@ -7,6 +7,7 @@
 require_relative "openai/finetunes"
 require_relative "openai/images"
 require_relative "openai/models"
+require_relative "openai/responses"
 require_relative "openai/assistants"
 require_relative "openai/threads"
 require_relative "openai/messages"

lib/openai/client.rb

@@ -32,10 +32,6 @@ def completions(parameters: {})
       json_post(path: "/completions", parameters: parameters)
     end
 
-    def responses(parameters: {})
-      json_post(path: "/responses", parameters: parameters)
-    end
-
     def audio
       @audio ||= OpenAI::Audio.new(client: self)
     end
@@ -56,6 +52,10 @@ def models
       @models ||= OpenAI::Models.new(client: self)
     end
 
+    def responses
+      @responses ||= OpenAI::Responses.new(client: self)
+    end
+
     def assistants
       @assistants ||= OpenAI::Assistants.new(client: self)
     end

lib/openai/responses.rb

@@ -0,0 +1,23 @@
+module OpenAI
+  class Responses
+    def initialize(client:)
+      @client = client
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/responses", parameters: parameters)
+    end
+
+    def retrieve(response_id:)
+      @client.get(path: "/responses/#{response_id}")
+    end
+
+    def delete(response_id:)
+      @client.delete(path: "/responses/#{response_id}")
+    end
+
+    def input_items(response_id:, parameters: {})
+      @client.get(path: "/responses/#{response_id}/input_items", parameters: parameters)
+    end
+  end
+end