Merge pull request #574 from simonx1/add-responses-endpoint

Add new Responses API endpoint

Author: alexrudall

README.md

@@ -38,6 +38,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
       - [Streaming Chat](#streaming-chat)
       - [Vision](#vision)
       - [JSON Mode](#json-mode)
+    - [Responses API](#responses-api)
     - [Functions](#functions)
     - [Completions](#completions)
     - [Embeddings](#embeddings)
@@ -464,6 +465,74 @@ 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.
+
+```ruby
+response = client.responses(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)
+```ruby
+followup = client.responses(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: {
+  model: "gpt-4o",
+  input: "What's the weather in Paris?",
+  tools: [
+    {
+      "type" => "function",
+      "name" => "get_current_weather",
+      "description" => "Get the current weather in a given location",
+      "parameters" => {
+        "type" => "object",
+        "properties" => {
+          "location" => {
+            "type" => "string",
+            "description" => "The geographic location to get the weather for"
+          }
+        },
+        "required" => ["location"]
+      }
+    }
+  ]
+})
+
+puts response.dig("output", 0, "name") # => "get_current_weather"
+```
+
+#### Streaming
+```ruby
+chunks = []
+streamer = proc { |chunk, _| chunks << chunk }
+
+client.responses(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
+```
+
 ### 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/client.rb

@@ -32,6 +32,10 @@ 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

spec/fixtures/cassettes/gpt-4o_responsesapi_responses.yml

@@ -0,0 +1,118 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.openai.com/v1/responses
+    body:
+      encoding: UTF-8
+      string: '{"model":"gpt-4o","input":"Hello!","stream":true}'
+    headers:
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <OPENAI_ACCESS_TOKEN>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 12 Mar 2025 16:59:40 GMT
+      Content-Type:
+      - text/event-stream; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Openai-Version:
+      - '2020-10-01'
+      Openai-Organization:
+      - tropic-7
+      X-Request-Id:
+      - req_fa50380d9311693c3f763a22b24eee77
+      Openai-Processing-Ms:
+      - '51'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Cf-Cache-Status:
+      - DYNAMIC
+      Set-Cookie:
+      - __cf_bm=IY3ThYrVK7alqLEMbB1twLEG88Bef1OUz6pWWgkYrfE-1741798780-1.0.1.1-s5avIb8RUXCHgZmfvWToJkH_uELi5H6BS0QtoSVSISmg9.RBA7Z97ySYNXZ6Czt7RZnT.K6Pj9W5u3NDNf6u4rroFm_BAWRyUaZUHgbnkR0;
+        path=/; expires=Wed, 12-Mar-25 17:29:40 GMT; domain=.api.openai.com; HttpOnly;
+        Secure; SameSite=None
+      - _cfuvid=tjwk_Z09jnlOWbISJrfgtJrv.wn3k_50UJ9uEAnlEU0-1741798780709-0.0.1.1-604800000;
+        path=/; domain=.api.openai.com; HttpOnly; Secure; SameSite=None
+      X-Content-Type-Options:
+      - nosniff
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 91f4d7e9c902b1b8-WAW
+      Alt-Svc:
+      - h3=":443"; ma=86400
+    body:
+      encoding: UTF-8
+      string: |+
+        event: response.created
+        data: {"type":"response.created","response":{"id":"resp_67d1bd7c931c8191870ad798c711562004d0a3fcf4e20298","object":"response","created_at":1741798780,"status":"in_progress","error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"gpt-4o-2024-08-06","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"generate_summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
+
+        event: response.in_progress
+        data: {"type":"response.in_progress","response":{"id":"resp_67d1bd7c931c8191870ad798c711562004d0a3fcf4e20298","object":"response","created_at":1741798780,"status":"in_progress","error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"gpt-4o-2024-08-06","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"generate_summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
+
+        event: response.output_item.added
+        data: {"type":"response.output_item.added","output_index":0,"item":{"type":"message","id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","status":"in_progress","role":"assistant","content":[]}}
+
+        event: response.content_part.added
+        data: {"type":"response.content_part.added","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"part":{"type":"output_text","text":"","annotations":[]}}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":"Hi"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":" there"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":"!"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":" How"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":" can"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":" I"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":" assist"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":" you"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":" today"}
+
+        event: response.output_text.delta
+        data: {"type":"response.output_text.delta","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"delta":"?"}
+
+        event: response.output_text.done
+        data: {"type":"response.output_text.done","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"text":"Hi there! How can I assist you today?"}
+
+        event: response.content_part.done
+        data: {"type":"response.content_part.done","item_id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","output_index":0,"content_index":0,"part":{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}}
+
+        event: response.output_item.done
+        data: {"type":"response.output_item.done","output_index":0,"item":{"type":"message","id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}}
+
+        event: response.completed
+        data: {"type":"response.completed","response":{"id":"resp_67d1bd7c931c8191870ad798c711562004d0a3fcf4e20298","object":"response","created_at":1741798780,"status":"completed","error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"gpt-4o-2024-08-06","output":[{"type":"message","id":"msg_67d1bd7ce24c819188993565819babf404d0a3fcf4e20298","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"generate_summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":27,"input_tokens_details":{"cached_tokens":0},"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":38},"user":null,"metadata":{}}}
+
+  recorded_at: Wed, 12 Mar 2025 16:59:41 GMT
+recorded_with: VCR 6.1.0
+...