tweak structured output example

Author: leafo

examples/gemini/structured_output.lua

@@ -0,0 +1,98 @@
+-- Example: Structured output with Gemini
+-- Requires GEMINI_API_KEY environment variable
+
+local Gemini = require("openai.compat.gemini")
+local cjson = require("cjson")
+
+local client = Gemini.new(os.getenv("GEMINI_API_KEY"))
+
+-- Define a JSON schema for extracting information about a person
+local person_schema = {
+  type = "json_schema",
+  json_schema = {
+    name = "person_info",
+    strict = true,
+    schema = {
+      type = "object",
+      properties = {
+        name = {
+          type = "string",
+          description = "The person's full name"
+        },
+        age = {
+          type = "number",
+          description = "The person's age in years"
+        },
+        occupation = {
+          type = "string",
+          description = "The person's job or profession"
+        },
+        skills = {
+          type = "array",
+          items = { type = "string" },
+          description = "List of skills the person has"
+        }
+      },
+      required = {"name", "age", "occupation", "skills"},
+      additionalProperties = false
+    }
+  }
+}
+
+-- Request structured output
+local status, response = client:chat({
+  {
+    role = "user",
+    content = "Extract information about this person: John Smith is a 35-year-old software engineer. He knows Python, JavaScript, and Go."
+  }
+}, {
+  response_format = person_schema
+})
+
+if status ~= 200 then
+  io.stderr:write("Error: " .. status .. "\n")
+  io.stderr:write(cjson.encode(response) .. "\n")
+  os.exit(1)
+end
+
+local content = response.choices[1].message.content
+print(content)
+-- Verify it parses as valid JSON
+assert(cjson.decode(content), "Failed to parse JSON")
+
+io.stderr:write("\n--- Using ChatSession with structured output ---\n\n")
+
+-- You can also use structured output with a chat session
+local recipe_schema = {
+  type = "json_schema",
+  json_schema = {
+    name = "recipe",
+    strict = true,
+    schema = {
+      type = "object",
+      properties = {
+        dish_name = { type = "string" },
+        prep_time_minutes = { type = "number" },
+        ingredients = {
+          type = "array",
+          items = { type = "string" }
+        },
+        steps = {
+          type = "array",
+          items = { type = "string" }
+        }
+      },
+      required = {"dish_name", "prep_time_minutes", "ingredients", "steps"},
+      additionalProperties = false
+    }
+  }
+}
+
+local chat = client:new_chat_session({
+  response_format = recipe_schema
+})
+
+local recipe_json = chat:send("Give me a simple recipe for scrambled eggs")
+print(recipe_json)
+-- Verify it parses as valid JSON
+assert(cjson.decode(recipe_json), "Failed to parse JSON")

examples/responses/structured_output.lua

@@ -52,37 +52,27 @@ local status, response = client:create_response(
 )
 
 if status ~= 200 then
-  print("Error:", status)
-  print(cjson.encode(response))
+  io.stderr:write("Error: " .. status .. "\n")
+  io.stderr:write(cjson.encode(response) .. "\n")
   os.exit(1)
 end
 
-print("Response ID:", response.id)
-print("Raw output:")
-
 -- Extract the text content from the response
 for _, output_item in ipairs(response.output or {}) do
   if output_item.content then
     for _, content_item in ipairs(output_item.content) do
       if content_item.type == "output_text" and content_item.text then
         print(content_item.text)
-
-        -- Parse and display the structured data
-        local parsed = cjson.decode(content_item.text)
-        print("\nParsed structured data:")
-        print("  Name:", parsed.name)
-        print("  Age:", parsed.age)
-        print("  Occupation:", parsed.occupation)
-        print("  Skills:", table.concat(parsed.skills, ", "))
-        print("  Employed:", parsed.is_employed and "Yes" or "No")
+        -- Verify it parses as valid JSON
+        assert(cjson.decode(content_item.text), "Failed to parse JSON")
       end
     end
   end
 end
 
-print("\n--- Using ResponsesChatSession with structured output ---\n")
+io.stderr:write("\n--- Using ResponsesChatSession with structured output ---\n\n")
 
--- You can also use structured outputs with the chat session by passing options to create_response
+-- You can also use structured outputs with the chat session
 local session = client:new_response_chat_session()
 
 local recipe_schema = {
@@ -118,29 +108,15 @@ local recipe_schema = {
   }
 }
 
--- Use create_response directly to pass the text format option
 local recipe_response, err = session:create_response("Give me a recipe for chocolate chip cookies", {
   text = { format = recipe_schema }
 })
 
 if recipe_response then
-  print("Recipe response:")
   print(recipe_response.output_text)
-
-  local recipe = cjson.decode(recipe_response.output_text)
-  print("\nFormatted recipe:")
-  print("Dish:", recipe.dish_name)
-  print("Prep time:", recipe.prep_time_minutes, "minutes")
-  print("Cook time:", recipe.cook_time_minutes, "minutes")
-  print("Servings:", recipe.servings)
-  print("\nIngredients:")
-  for _, ing in ipairs(recipe.ingredients) do
-    print("  -", ing.amount, ing.item)
-  end
-  print("\nSteps:")
-  for i, step in ipairs(recipe.steps) do
-    print(string.format("  %d. %s", i, step))
-  end
+  -- Verify it parses as valid JSON
+  assert(cjson.decode(recipe_response.output_text), "Failed to parse JSON")
 else
-  print("Error:", err)
+  io.stderr:write("Error: " .. tostring(err) .. "\n")
+  os.exit(1)
 end