Merge pull request #378 from alexrudall/add-json-mode-to-readme

Add JSON mode to the README

Author: alexrudall

README.md

@@ -217,6 +217,28 @@ puts response.dig("choices", 0, "message", "content")
 # => "The image depicts a serene natural landscape featuring a long wooden boardwalk extending straight ahead"
 ```
 
+#### JSON Mode
+
+You can set the response_format to ask for responses in JSON (at least for `gpt-3.5-turbo-1106`):
+
+```ruby
+  response = client.chat(
+    parameters: {
+        model: "gpt-3.5-turbo-1106",
+        response_format: { type: "json_object" },
+        messages: [{ role: "user", content: "Hello! Give me some JSON please."}],
+        temperature: 0.7,
+    })
+    puts response.dig("choices", 0, "message", "content")
+    {
+      "name": "John",
+      "age": 30,
+      "city": "New York",
+      "hobbies": ["reading", "traveling", "hiking"],
+      "isStudent": false
+    }
+```
+
 ### Functions
 
 You can describe and pass in functions and the model will intelligently choose to output a JSON object containing arguments to call those them. For example, if you want the model to use your method `get_current_weather` to get the current weather in a given location: