chore(api): openapi updates for conversations

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-65d42621b731238ad4e59a35a705fc0608b17f53a14d047e66ce480c793da26b.yml
-openapi_spec_hash: d7ca86b2507600cbd5ed197cf31263c2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-937fcfac8cbab692796cd9822b37e48a311e2220a8b103106ded0ee92a0b9484.yml
+openapi_spec_hash: 74a0c58b5b8c4e06792d79b685e02a01
 config_hash: 666d6bb4b564f0d9d431124b5d1a0665

openai-java-core/src/main/kotlin/com/openai/models/conversations/ConversationCreateParams.kt

@@ -438,7 +438,6 @@ private constructor(
 
     override fun _queryParams(): QueryParams = additionalQueryParams
 
-    /** Create a conversation */
     class Body
     private constructor(
         private val items: JsonField<List<ResponseInputItem>>,

openai-java-core/src/main/kotlin/com/openai/models/conversations/ConversationDeleteParams.kt

@@ -11,7 +11,7 @@ import java.util.Objects
 import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
-/** Delete a conversation with the given ID. */
+/** Delete a conversation. Items in the conversation will not be deleted. */
 class ConversationDeleteParams
 private constructor(
     private val conversationId: String?,

openai-java-core/src/main/kotlin/com/openai/models/conversations/ConversationRetrieveParams.kt

@@ -9,7 +9,7 @@ import java.util.Objects
 import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
-/** Get a conversation with the given ID. */
+/** Get a conversation */
 class ConversationRetrieveParams
 private constructor(
     private val conversationId: String?,

openai-java-core/src/main/kotlin/com/openai/models/conversations/ConversationUpdateParams.kt

@@ -21,7 +21,7 @@ import java.util.Objects
 import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
-/** Update a conversation's metadata with the given ID. */
+/** Update a conversation */
 class ConversationUpdateParams
 private constructor(
     private val conversationId: String?,
@@ -35,13 +35,15 @@ private constructor(
     /**
      * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
      * additional information about the object in a structured format, and querying for objects via
-     * API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are
-     * strings with a maximum length of 512 characters.
+     * API or the dashboard.
      *
-     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
-     *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
+     * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum
+     * length of 512 characters.
+     *
+     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
+     *   server responded with an unexpected value).
      */
-    fun metadata(): Metadata = body.metadata()
+    fun metadata(): Optional<Metadata> = body.metadata()
 
     /**
      * Returns the raw JSON value of [metadata].
@@ -107,10 +109,15 @@ private constructor(
         /**
          * Set of 16 key-value pairs that can be attached to an object. This can be useful for
          * storing additional information about the object in a structured format, and querying for
-         * objects via API or the dashboard. Keys are strings with a maximum length of 64
-         * characters. Values are strings with a maximum length of 512 characters.
+         * objects via API or the dashboard.
+         *
+         * Keys are strings with a maximum length of 64 characters. Values are strings with a
+         * maximum length of 512 characters.
          */
-        fun metadata(metadata: Metadata) = apply { body.metadata(metadata) }
+        fun metadata(metadata: Metadata?) = apply { body.metadata(metadata) }
+
+        /** Alias for calling [Builder.metadata] with `metadata.orElse(null)`. */
+        fun metadata(metadata: Optional<Metadata>) = metadata(metadata.getOrNull())
 
         /**
          * Sets [Builder.metadata] to an arbitrary JSON value.
@@ -287,13 +294,15 @@ private constructor(
         /**
          * Set of 16 key-value pairs that can be attached to an object. This can be useful for
          * storing additional information about the object in a structured format, and querying for
-         * objects via API or the dashboard. Keys are strings with a maximum length of 64
-         * characters. Values are strings with a maximum length of 512 characters.
+         * objects via API or the dashboard.
+         *
+         * Keys are strings with a maximum length of 64 characters. Values are strings with a
+         * maximum length of 512 characters.
          *
-         * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
-         *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
+         * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
+         *   server responded with an unexpected value).
          */
-        fun metadata(): Metadata = metadata.getRequired("metadata")
+        fun metadata(): Optional<Metadata> = metadata.getOptional("metadata")
 
         /**
          * Returns the raw JSON value of [metadata].
@@ -342,10 +351,15 @@ private constructor(
             /**
              * Set of 16 key-value pairs that can be attached to an object. This can be useful for
              * storing additional information about the object in a structured format, and querying
-             * for objects via API or the dashboard. Keys are strings with a maximum length of 64
-             * characters. Values are strings with a maximum length of 512 characters.
+             * for objects via API or the dashboard.
+             *
+             * Keys are strings with a maximum length of 64 characters. Values are strings with a
+             * maximum length of 512 characters.
              */
-            fun metadata(metadata: Metadata) = metadata(JsonField.of(metadata))
+            fun metadata(metadata: Metadata?) = metadata(JsonField.ofNullable(metadata))
+
+            /** Alias for calling [Builder.metadata] with `metadata.orElse(null)`. */
+            fun metadata(metadata: Optional<Metadata>) = metadata(metadata.getOrNull())
 
             /**
              * Sets [Builder.metadata] to an arbitrary JSON value.
@@ -398,7 +412,7 @@ private constructor(
                 return@apply
             }
 
-            metadata().validate()
+            metadata().ifPresent { it.validate() }
             validated = true
         }
 
@@ -440,8 +454,10 @@ private constructor(
     /**
      * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
      * additional information about the object in a structured format, and querying for objects via
-     * API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are
-     * strings with a maximum length of 512 characters.
+     * API or the dashboard.
+     *
+     * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum
+     * length of 512 characters.
      */
     class Metadata
     @JsonCreator

openai-java-core/src/main/kotlin/com/openai/services/async/ConversationServiceAsync.kt

@@ -49,7 +49,7 @@ interface ConversationServiceAsync {
     fun create(requestOptions: RequestOptions): CompletableFuture<Conversation> =
         create(ConversationCreateParams.none(), requestOptions)
 
-    /** Get a conversation with the given ID. */
+    /** Get a conversation */
     fun retrieve(conversationId: String): CompletableFuture<Conversation> =
         retrieve(conversationId, ConversationRetrieveParams.none())
 
@@ -84,7 +84,7 @@ interface ConversationServiceAsync {
     ): CompletableFuture<Conversation> =
         retrieve(conversationId, ConversationRetrieveParams.none(), requestOptions)
 
-    /** Update a conversation's metadata with the given ID. */
+    /** Update a conversation */
     fun update(
         conversationId: String,
         params: ConversationUpdateParams,
@@ -108,7 +108,7 @@ interface ConversationServiceAsync {
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<Conversation>
 
-    /** Delete a conversation with the given ID. */
+    /** Delete a conversation. Items in the conversation will not be deleted. */
     fun delete(conversationId: String): CompletableFuture<ConversationDeletedResource> =
         delete(conversationId, ConversationDeleteParams.none())
 

openai-java-core/src/main/kotlin/com/openai/services/blocking/ConversationService.kt

@@ -48,7 +48,7 @@ interface ConversationService {
     fun create(requestOptions: RequestOptions): Conversation =
         create(ConversationCreateParams.none(), requestOptions)
 
-    /** Get a conversation with the given ID. */
+    /** Get a conversation */
     fun retrieve(conversationId: String): Conversation =
         retrieve(conversationId, ConversationRetrieveParams.none())
 
@@ -80,7 +80,7 @@ interface ConversationService {
     fun retrieve(conversationId: String, requestOptions: RequestOptions): Conversation =
         retrieve(conversationId, ConversationRetrieveParams.none(), requestOptions)
 
-    /** Update a conversation's metadata with the given ID. */
+    /** Update a conversation */
     fun update(conversationId: String, params: ConversationUpdateParams): Conversation =
         update(conversationId, params, RequestOptions.none())
 
@@ -102,7 +102,7 @@ interface ConversationService {
         requestOptions: RequestOptions = RequestOptions.none(),
     ): Conversation
 
-    /** Delete a conversation with the given ID. */
+    /** Delete a conversation. Items in the conversation will not be deleted. */
     fun delete(conversationId: String): ConversationDeletedResource =
         delete(conversationId, ConversationDeleteParams.none())
 

openai-java-core/src/test/kotlin/com/openai/models/conversations/ConversationUpdateParamsTest.kt

@@ -52,7 +52,7 @@ internal class ConversationUpdateParamsTest {
         val body = params._body()
 
         assertThat(body.metadata())
-            .isEqualTo(
+            .contains(
                 ConversationUpdateParams.Metadata.builder()
                     .putAdditionalProperty("foo", JsonValue.from("string"))
                     .build()