Fix Realtime runtime errors

Several problems with the generated code:
* Realtime spec (https://platform.openai.com/docs/api-reference/realtime) allows some null fields to have special meaning; Moshi defaults to not sending null fields; add SerializeNull to allow some fields to be sent null.
* Session `max_response_output_tokens` (https://platform.openai.com/docs/api-reference/realtime-sessions/create#realtime-sessions-create-max_response_output_tokens) can be either a number (1.4096) or `"inf"`; Make `RealtimeSessionMaxResponseOutputTokens` support both.
* Server is sending several undocumented values; add `in_progress`, `audio`
* Server is sending null `previous_item_id`; make `previous_item_id` nullable
* Removing unnecessary imports instead of renaming any

Author: paulpv

lib/src/main/kotlin/com/openai/infrastructure/Serializer.kt

@@ -1,17 +1,72 @@
 package com.openai.infrastructure
 
+import com.openai.models.RealtimeSessionMaxResponseOutputTokensAdapter
+import com.squareup.moshi.JsonAdapter
+import com.squareup.moshi.JsonQualifier
+import com.squareup.moshi.JsonReader
+import com.squareup.moshi.JsonWriter
 import com.squareup.moshi.Moshi
+import com.squareup.moshi.Types
+import com.squareup.moshi.adapter
 import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
+import java.lang.reflect.Type
+
+//
+//region SerializeNull https://stackoverflow.com/a/71877976/252308
+//
+
+@Retention(AnnotationRetention.RUNTIME)
+@JsonQualifier
+annotation class SerializeNull {
+    companion object {
+        class Factory : JsonAdapter.Factory {
+            override fun create(type: Type, annotations: MutableSet<out Annotation>, moshi: Moshi): JsonAdapter<*>? {
+                val nextAnnotations = Types.nextAnnotations(annotations, SerializeNull::class.java)
+                return if (nextAnnotations == null) {
+                    null
+                } else {
+                    NullIfNullJsonAdapter<Any>(moshi.nextAdapter(this, type, nextAnnotations))
+                }
+            }
+        }
+
+        class NullIfNullJsonAdapter<T>(private val delegate: JsonAdapter<T>) : JsonAdapter<T>() {
+            override fun fromJson(reader: JsonReader): T? {
+                return delegate.fromJson(reader)
+            }
+
+            override fun toJson(writer: JsonWriter, value: T?) {
+                if (value == null) {
+                    val serializeNulls: Boolean = writer.serializeNulls
+                    writer.serializeNulls = true
+                    try {
+                        delegate.toJson(writer, value)
+                    } finally {
+                        writer.serializeNulls = serializeNulls
+                    }
+                } else {
+                    delegate.toJson(writer, value)
+                }
+            }
+        }
+    }
+}
+
+//
+//endregion
+//
 
 object Serializer {
     @JvmStatic
     val moshiBuilder: Moshi.Builder = Moshi.Builder()
+        .add(SerializeNull.Companion.Factory())
         .add(OffsetDateTimeAdapter())
         .add(LocalDateTimeAdapter())
         .add(LocalDateAdapter())
         .add(UUIDAdapter())
         .add(ByteArrayAdapter())
         .add(URIAdapter())
+        .add(RealtimeSessionMaxResponseOutputTokensAdapter())
         .add(KotlinJsonAdapterFactory())
         .add(BigDecimalAdapter())
         .add(BigIntegerAdapter())

lib/src/main/kotlin/com/openai/models/RealtimeConversationItem.kt

@@ -15,8 +15,6 @@
 
 package com.openai.models
 
-import com.openai.models.RealtimeConversationItemContentInner
-
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 
@@ -60,7 +58,7 @@ data class RealtimeConversationItem (
 
     /* The content of the message, applicable for `message` items.  - Message items of role `system` support only `input_text` content - Message items of role `user` support `input_text` and `input_audio`    content - Message items of role `assistant` support `text` content.  */
     @Json(name = "content")
-    val content: kotlin.collections.List<RealtimeConversationItemContentInner>? = null,
+    val content: kotlin.collections.List<RealtimeConversationItemContent>? = null,
 
     /* The ID of the function call (for `function_call` and  `function_call_output` items). If passed on a `function_call_output`  item, the server will check that a `function_call` item with the same  ID exists in the conversation history.  */
     @Json(name = "call_id")
@@ -108,7 +106,8 @@ data class RealtimeConversationItem (
     @JsonClass(generateAdapter = false)
     enum class Status(val value: kotlin.String) {
         @Json(name = "completed") completed("completed"),
-        @Json(name = "incomplete") incomplete("incomplete");
+        @Json(name = "incomplete") incomplete("incomplete"),
+        @Json(name = "in_progress") inProgress("in_progress");
     }
     /**
      * The role of the message sender (`user`, `assistant`, `system`), only  applicable for `message` items. 

lib/src/main/kotlin/com/openai/models/RealtimeConversationItemContentInner.kt renamed to lib/src/main/kotlin/com/openai/models/RealtimeConversationItemContent.kt

@@ -30,11 +30,11 @@ import com.squareup.moshi.JsonClass
  */
 
 
-data class RealtimeConversationItemContentInner (
+data class RealtimeConversationItemContent (
 
     /* The content type (`input_text`, `input_audio`, `item_reference`, `text`).  */
     @Json(name = "type")
-    val type: RealtimeConversationItemContentInner.Type? = null,
+    val type: RealtimeConversationItemContent.Type? = null,
 
     /* The text content, used for `input_text` and `text` content types.  */
     @Json(name = "text")
@@ -61,6 +61,7 @@ data class RealtimeConversationItemContentInner (
      */
     @JsonClass(generateAdapter = false)
     enum class Type(val value: kotlin.String) {
+        @Json(name = "audio") audio("audio"),
         @Json(name = "input_audio") input_audio("input_audio"),
         @Json(name = "input_text") input_text("input_text"),
         @Json(name = "item_reference") item_reference("item_reference"),

lib/src/main/kotlin/com/openai/models/RealtimeResponse.kt

@@ -84,7 +84,8 @@ data class RealtimeResponse (
         @Json(name = "completed") completed("completed"),
         @Json(name = "cancelled") cancelled("cancelled"),
         @Json(name = "failed") failed("failed"),
-        @Json(name = "incomplete") incomplete("incomplete");
+        @Json(name = "incomplete") incomplete("incomplete"),
+        @Json(name = "in_progress") inProgress("in_progress");
     }
 
 }

lib/src/main/kotlin/com/openai/models/RealtimeResponseCreateParams.kt

@@ -15,11 +15,6 @@
 
 package com.openai.models
 
-import com.openai.models.RealtimeConversationItem
-import com.openai.models.RealtimeResponseCreateParamsConversation
-import com.openai.models.RealtimeResponseCreateParamsMaxResponseOutputTokens
-import com.openai.models.RealtimeResponseCreateParamsToolsInner
-
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 
@@ -71,7 +66,7 @@ data class RealtimeResponseCreateParams (
     val temperature: java.math.BigDecimal? = null,
 
     @Json(name = "max_response_output_tokens")
-    val maxResponseOutputTokens: RealtimeResponseCreateParamsMaxResponseOutputTokens? = null,
+    val maxResponseOutputTokens: RealtimeSessionMaxResponseOutputTokens? = null,
 
     @Json(name = "conversation")
     val conversation: RealtimeResponseCreateParamsConversation? = null,
@@ -123,6 +118,15 @@ data class RealtimeResponseCreateParams (
         @Json(name = "g711_ulaw") g711_ulaw("g711_ulaw"),
         @Json(name = "g711_alaw") g711_alaw("g711_alaw");
     }
+    /**
+    * Controls which conversation the response is added to. Currently supports `auto` and `none`, with `auto` as the default value. The `auto` value means that the contents of the response will be added to the default conversation. Set this to `none` to create an out-of-band response which  will not add items to default conversation. 
+    *
+    */
+    @JsonClass(generateAdapter = false)
+    enum class RealtimeResponseCreateParamsConversation {
+        auto,
+        none,
+    }
 
 }
 

lib/src/main/kotlin/com/openai/models/RealtimeResponseCreateParamsConversation.kt

@@ -42,7 +42,7 @@ data class RealtimeServerEventConversationItemCreated (
 
     /* The ID of the preceding item in the Conversation context, allows the  client to understand the order of the conversation.  */
     @Json(name = "previous_item_id")
-    val previousItemId: kotlin.String,
+    val previousItemId: kotlin.String? = null,
 
     @Json(name = "item")
     val item: RealtimeConversationItem

lib/src/main/kotlin/com/openai/models/RealtimeResponseCreateParamsMaxResponseOutputTokens.kt

@@ -41,7 +41,7 @@ data class RealtimeServerEventInputAudioBufferCommitted (
 
     /* The ID of the preceding item after which the new item will be inserted.  */
     @Json(name = "previous_item_id")
-    val previousItemId: kotlin.String,
+    val previousItemId: kotlin.String? = null,
 
     /* The ID of the user message item that will be created. */
     @Json(name = "item_id")

lib/src/main/kotlin/com/openai/models/RealtimeServerEventConversationItemCreated.kt

@@ -15,11 +15,7 @@
 
 package com.openai.models
 
-import com.openai.models.RealtimeResponseCreateParamsMaxResponseOutputTokens
-import com.openai.models.RealtimeResponseCreateParamsToolsInner
-import com.openai.models.RealtimeSessionInputAudioTranscription
-import com.openai.models.RealtimeSessionModel
-import com.openai.models.RealtimeSessionTurnDetection
+import com.openai.infrastructure.SerializeNull
 
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
@@ -72,9 +68,11 @@ data class RealtimeSession (
     @Json(name = "output_audio_format")
     val outputAudioFormat: RealtimeSession.OutputAudioFormat? = null,
 
+    @SerializeNull
     @Json(name = "input_audio_transcription")
     val inputAudioTranscription: RealtimeSessionInputAudioTranscription? = null,
 
+    @SerializeNull
     @Json(name = "turn_detection")
     val turnDetection: RealtimeSessionTurnDetection? = null,
 
@@ -91,7 +89,7 @@ data class RealtimeSession (
     val temperature: java.math.BigDecimal? = null,
 
     @Json(name = "max_response_output_tokens")
-    val maxResponseOutputTokens: RealtimeResponseCreateParamsMaxResponseOutputTokens? = null
+    val maxResponseOutputTokens: RealtimeSessionMaxResponseOutputTokens? = null
 
 ) {