Merge remote-tracking branch 'up/main'

Author: gh-abhay

CHANGELOG.md

@@ -1,8 +1,17 @@
-## Unreleased
+## 3.7.0
 
 ### Added
 - add `RequestOptions` (#296)
 
+### Fixed
+- **chat**: add `systemFingerprint` to `ChatCompletionChunk` (#303)
+- **chat**: move `description` to `FunctionTool` (#304)
+- **chat**: make `FunctionTool#Parameters` nullable (#304)
+- **finetuning**: nullable `ErrorInfo#message` and `ErrorInfo#code` (#304)
+- **image**: correct `Quality` package name (#302) (thanks @voqaldev)
+- **assistants**: files endpoint (#298) (thanks @rjeeb)
+- **runs**: `RunRequest` builder
+
 ## 3.6.3
 > Published 13 Jan 2024
 

README.md

@@ -17,7 +17,7 @@ repositories {
 }
 
 dependencies {
-    implementation "com.aallam.openai:openai-client:3.6.3"
+    implementation "com.aallam.openai:openai-client:3.7.0"
 }
 ```
 
@@ -30,7 +30,7 @@ Alternatively, you can use [openai-client-bom](/openai-client-bom)  by adding th
 ```groovy
 dependencies {
     // import Kotlin API client BOM
-    implementation platform('com.aallam.openai:openai-client-bom:3.6.3')
+    implementation platform('com.aallam.openai:openai-client-bom:3.7.0')
 
     // define dependencies without versions
     implementation 'com.aallam.openai:openai-client'
@@ -57,7 +57,7 @@ of [Ktor's engines](https://ktor.io/docs/http-client-engines.html).
     <dependency>
         <groupId>com.aallam.openai</groupId>
         <artifactId>openai-client-jvm</artifactId>
-        <version>3.6.3</version>
+        <version>3.7.0</version>
     </dependency>
 
     <dependency>

gradle.properties

@@ -5,7 +5,7 @@ kotlin.js.compiler=ir
 
 # Lib
 GROUP=com.aallam.openai
-VERSION_NAME=3.7.0-SNAPSHOT
+VERSION_NAME=3.7.0
 
 # OSS
 SONATYPE_HOST=DEFAULT

openai-client/src/commonMain/kotlin/com.aallam.openai.client/internal/api/AssistantsApi.kt

@@ -133,7 +133,7 @@ internal class AssistantsApi(val requester: HttpRequester) : Assistants {
         val request = buildJsonObject { put("file", fileId.id) }
         return requester.perform {
             it.post {
-                url(path = "${ApiPath.Assistants}/${assistantId.id}")
+                url(path = "${ApiPath.Assistants}/${assistantId.id}/files")
                 setBody(request)
                 contentType(ContentType.Application.Json)
                 beta("assistants", 1)

openai-core/src/commonMain/kotlin/com.aallam.openai.api/Quality.kt

@@ -0,0 +1,5 @@
+/**
+ * The quality of the image that will be generated
+ */
+@Deprecated("This class is deprecated.", ReplaceWith("Quality", "com.aallam.openai.api.image.Quality"))
+public typealias Quality = com.aallam.openai.api.image.Quality

openai-core/src/commonMain/kotlin/com.aallam.openai.api/chat/ChatCompletionChunk.kt

@@ -49,4 +49,10 @@ public data class ChatCompletionChunk(
      */
     @SerialName("prompt_filter_results")
     val promptFilterResults: List<ContentFilterResultsForPrompt>? = null
+     * This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with
+     * the `seed` request parameter to understand when backend changes have been made that might impact determinism.
+     */
+
+    @SerialName("system_fingerprint")
+    public val systemFingerprint: String? = null,
 )

openai-core/src/commonMain/kotlin/com.aallam.openai.api/chat/Tool.kt

@@ -15,11 +15,6 @@ public data class Tool(
      */
     @SerialName("type") val type: ToolType,
 
-    /**
-     * Tool description.
-     */
-    @SerialName("description") val description: String? = null,
-
     /**
      * A description of what the function does, used by the model to choose when and how to call the function.
      */
@@ -38,8 +33,7 @@ public data class Tool(
         public fun function(name: String, description: String? = null, parameters: Parameters): Tool =
             Tool(
                 type = ToolType.Function,
-                description = description,
-                function = FunctionTool(name = name, parameters = parameters)
+                function = FunctionTool(name = name, description = description, parameters = parameters)
             )
     }
 }
@@ -56,12 +50,17 @@ public data class FunctionTool(
     @SerialName("name") val name: String,
 
     /**
-     * The parameters the function accepts, described as a JSON Schema object.
-     * See the [guide](https://github.com/aallam/openai-kotlin/blob/main/guides/ChatToolCalls.md) for examples,
-     * and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about
+     * The parameters the functions accept, described as a JSON Schema object.
+     * See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples,
+     * and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about
      * the format.
      *
-     * To describe a function that accepts no parameters, provide [Parameters.Empty]`.
+     * Omitting `parameters` defines a function with an empty parameter list.
+     */
+    @SerialName("parameters") val parameters: Parameters? = null,
+
+    /**
+     * A description of what the function does, used by the model to choose when and how to call the function.
      */
-    @SerialName("parameters") val parameters: Parameters
+    @SerialName("description") public val description: String? = null
 )

openai-core/src/commonMain/kotlin/com.aallam.openai.api/finetuning/ErrorInfo.kt

@@ -11,12 +11,12 @@ public data class ErrorInfo(
     /**
      * A human-readable error message.
      */
-    val message: String,
+    val message: String? = null,
 
     /**
      * A machine-readable error code.
      */
-    val code: String,
+    val code: String? = null,
 
     /**
      * The parameter that was invalid (e.g., `training_file`, `validation_file`), or null if not parameter-specific.

openai-core/src/commonMain/kotlin/com.aallam.openai.api/image/ImageCreation.kt

@@ -1,6 +1,5 @@
 package com.aallam.openai.api.image
 
-import Quality
 import com.aallam.openai.api.BetaOpenAI
 import com.aallam.openai.api.OpenAIDsl
 import com.aallam.openai.api.model.ModelId

openai-core/src/commonMain/kotlin/com.aallam.openai.api/image/Quality.kt

@@ -1,3 +1,5 @@
+package com.aallam.openai.api.image
+
 import kotlinx.serialization.Serializable
 import kotlin.jvm.JvmInline
 

openai-core/src/commonMain/kotlin/com.aallam.openai.api/image/internal/ImageCreationRequest.kt

@@ -1,9 +1,8 @@
 package com.aallam.openai.api.image.internal
 
-import Quality
-import com.aallam.openai.api.BetaOpenAI
 import com.aallam.openai.api.InternalOpenAI
 import com.aallam.openai.api.image.ImageSize
+import com.aallam.openai.api.image.Quality
 import com.aallam.openai.api.image.Style
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable