dont use nonstandard property on responses object, add metatable with method

Author: leafo

examples/responses/basic.lua

@@ -1,64 +1,77 @@
+-- Simple demo script for the Responses API.
+-- Run with: lua examples/responses/basic.lua
+
 local openai = require("openai")
 local cjson = require("cjson")
+
 local api_key = os.getenv("OPENAI_API_KEY")
 assert(api_key, "Set OPENAI_API_KEY in your environment before running.")
+
 local client = openai.new(api_key)
-print("== One-off response ==")
-local response, err, raw = client:create_response("Write one short sentence about Lua.")
-if not (response) then
-  io.stderr:write("Request failed: " .. tostring(err) .. "\n")
-  if raw then
-    io.stderr:write(cjson.encode(raw), "\n")
+
+print("== One-off response (raw API) ==")
+local status, response = client:create_response("Write one short sentence about Lua.")
+
+if status ~= 200 then
+  io.stderr:write("Request failed with status: " .. status .. "\n")
+  if response then
+    io.stderr:write(cjson.encode(response) .. "\n")
   end
   os.exit(1)
 end
-print("Response ID: " .. tostring(response.id))
-print("Output text: " .. tostring(response.output_text))
-print("Stop reason: " .. tostring(response.stop_reason or 'unknown'))
-print("\n== Streaming example ==")
-local streamed_text = nil
-response, err, raw = client:create_response("Stream a brief greeting.", {
-  stream = true
-}, function(chunk)
+
+print("Response ID: " .. response.id)
+print("Status: " .. (response.status or "unknown"))
+
+print("\n== Streaming example (via session) ==")
+local stream_session = client:new_responses_chat_session()
+
+local streamed_text, err, raw = stream_session:send("Stream a brief greeting.", function(chunk)
   if chunk.text_delta then
     io.write(chunk.text_delta)
     io.flush()
   end
+
   if chunk.response then
-    return print("\n\nCompleted response ID: " .. tostring(chunk.response.id))
+    print("\n\nCompleted response ID: " .. chunk.response.id)
   end
 end)
-streamed_text = response
-if not (streamed_text) then
-  io.stderr:write("Streaming request failed: " .. tostring(err) .. "\n")
+
+if not streamed_text then
+  io.stderr:write("Streaming request failed: " .. err .. "\n")
   if raw then
-    io.stderr:write(cjson.encode(raw), "\n")
+    io.stderr:write(cjson.encode(raw) .. "\n")
   end
   os.exit(1)
 end
-print("Full streamed text: " .. tostring(streamed_text))
+
+print("Full streamed text: " .. streamed_text)
+
 print("\n== Stateful session ==")
 local session = client:new_responses_chat_session({
-  model = "gpt-4.1-mini",
   instructions = "Keep answers concise."
 })
+
 local first
 first, err, raw = session:send("Introduce yourself in 5 words.")
-if not (first) then
-  io.stderr:write("Session request failed: " .. tostring(err) .. "\n")
+if not first then
+  io.stderr:write("Session request failed: " .. err .. "\n")
   if raw then
-    io.stderr:write(cjson.encode(raw), "\n")
+    io.stderr:write(cjson.encode(raw) .. "\n")
   end
   os.exit(1)
 end
-print("First reply (" .. tostring(first.id) .. "): " .. tostring(first.output_text))
+
+print("First reply (" .. first.id .. "): " .. first:get_output_text())
+
 local second
 second, err, raw = session:send("Now say goodbye in the same style.")
-if not (second) then
-  io.stderr:write("Second session request failed: " .. tostring(err) .. "\n")
+if not second then
+  io.stderr:write("Second session request failed: " .. err .. "\n")
   if raw then
-    io.stderr:write(cjson.encode(raw), "\n")
+    io.stderr:write(cjson.encode(raw) .. "\n")
   end
   os.exit(1)
 end
-return print("Second reply (" .. tostring(second.id) .. "): " .. tostring(second.output_text))
+
+print("Second reply (" .. second.id .. "): " .. second:get_output_text())

examples/responses/basic.moon

@@ -19,7 +19,7 @@ local response, err = session:send({
 
 if response then
   print("Response ID:", response.id)
-  print("Output:", response.output_text)
+  print("Output:", response:get_output_text())
 else
   print("Error:", err)
 end

examples/responses/image.lua

@@ -113,9 +113,9 @@ local recipe_response, err = session:create_response("Give me a recipe for choco
 })
 
 if recipe_response then
-  print(recipe_response.output_text)
+  print(recipe_response:get_output_text())
   -- Verify it parses as valid JSON
-  assert(cjson.decode(recipe_response.output_text), "Failed to parse JSON")
+  assert(cjson.decode(recipe_response:get_output_text()), "Failed to parse JSON")
 else
   io.stderr:write("Error: " .. tostring(err) .. "\n")
   os.exit(1)

examples/responses/structured_output.lua

@@ -86,13 +86,13 @@ if #tool_calls > 0 then
       })
 
       if follow_up then
-        print("\nFinal response:", follow_up.output_text)
+        print("\nFinal response:", follow_up:get_output_text())
       else
         print("Error sending tool result:", err2)
       end
     end
   end
 else
   -- No tool calls, just print the response
-  print("Response:", response.output_text)
+  print("Response:", response:get_output_text())
 end

examples/responses/tools.lua

@@ -1,6 +1,47 @@
 local cjson = require("cjson")
 local types
 types = require("tableshape").types
+local response_mt = {
+  __index = {
+    get_output_text = function(self)
+      local parts = { }
+      if self.output then
+        local _list_0 = self.output
+        for _index_0 = 1, #_list_0 do
+          local block = _list_0[_index_0]
+          if block.content then
+            local _list_1 = block.content
+            for _index_1 = 1, #_list_1 do
+              local item = _list_1[_index_1]
+              if item.type == "output_text" and item.text then
+                table.insert(parts, item.text)
+              end
+            end
+          end
+        end
+      elseif self.content then
+        local _list_0 = self.content
+        for _index_0 = 1, #_list_0 do
+          local item = _list_0[_index_0]
+          if item.type == "output_text" and item.text then
+            table.insert(parts, item.text)
+          end
+        end
+      end
+      return table.concat(parts)
+    end
+  },
+  __tostring = function(self)
+    return self:get_output_text()
+  end
+}
+local add_response_helpers
+add_response_helpers = function(response)
+  if response then
+    setmetatable(response, response_mt)
+  end
+  return response
+end
 local empty = (types["nil"] + types.literal(cjson.null)):describe("nullable")
 local input_content_item = types.one_of({
   types.partial({
@@ -107,44 +148,6 @@ parse_response_stream_chunk = function(chunk)
     }
   end
 end
-local extract_output_text
-extract_output_text = function(response)
-  if not (response) then
-    return ""
-  end
-  local parts = { }
-  if response.output then
-    local _list_0 = response.output
-    for _index_0 = 1, #_list_0 do
-      local block = _list_0[_index_0]
-      if block.content then
-        local _list_1 = block.content
-        for _index_1 = 1, #_list_1 do
-          local item = _list_1[_index_1]
-          if item.type == "output_text" and item.text then
-            table.insert(parts, item.text)
-          end
-        end
-      end
-    end
-  elseif response.content then
-    local _list_0 = response.content
-    for _index_0 = 1, #_list_0 do
-      local item = _list_0[_index_0]
-      if item.type == "output_text" and item.text then
-        table.insert(parts, item.text)
-      end
-    end
-  end
-  return table.concat(parts)
-end
-local add_response_helpers
-add_response_helpers = function(response)
-  if response then
-    response.output_text = extract_output_text(response)
-  end
-  return response
-end
 local create_response_stream_filter
 create_response_stream_filter = function(chunk_callback)
   assert(types["function"](chunk_callback), "Must provide chunk_callback function when streaming response")
@@ -228,8 +231,8 @@ do
             table.insert(accumulated_text, chunk.text_delta)
           end
           if chunk.response then
-            final_response = add_response_helpers(chunk.response)
-            chunk.response = final_response
+            add_response_helpers(chunk.response)
+            final_response = chunk.response
           end
           if stream_callback then
             return stream_callback(chunk)
@@ -284,6 +287,5 @@ return {
   ResponsesChatSession = ResponsesChatSession,
   parse_responses_response = parse_responses_response,
   parse_response_stream_chunk = parse_response_stream_chunk,
-  create_response_stream_filter = create_response_stream_filter,
-  extract_output_text = extract_output_text
+  create_response_stream_filter = create_response_stream_filter
 }