chore: prepare release 3.4.0

.github/workflows/publish-snapshot.yml

@@ -43,7 +43,7 @@ jobs:
         uses: gradle/gradle-build-action@v2
 
       - name: Upload Artifacts
-        run: ./gradlew publish
+        run: ./gradlew publishAllPublicationsToMavenCentral
         env:
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}

.github/workflows/publish.yml

@@ -24,7 +24,7 @@ jobs:
         uses: gradle/gradle-build-action@v2
 
       - name: Upload Artifacts
-        run: ./gradlew clean publish --no-parallel --stacktrace
+        run: ./gradlew publishAllPublicationsToMavenCentral --no-configuration-cache
         env:
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}

CHANGELOG.md

@@ -1,12 +1,13 @@
-# Unreleased
+# 3.4.0
 
 ### Added
 - Introduced `Parameters.Empty` for functions without parameters.
 - Added `File.statusDetails` for retrieving file status details.
 - `HyperParams` new fields: `computeClassificationMetrics`, `classificationNClasses` and `classificationPositiveClass`.
+- **Moderation**: update categories and scores.
 
 ### Removed
-- Removed beta status from the chat and audio features.
+- Removed *beta* status from the chat and audio features.
 
 ### Deprecated
 - `completions` is deprecated.
@@ -15,12 +16,13 @@
 ### Breaking Changes
 - **Audio**: Updated `TranscriptionRequest`'s `responseFormat` type to `AudioResponseFormat`.
 - **Fine Tune**: set `HyperParams.learningRateMultiplier` to be non-nullable.
+- **Edit**: `Choice.finishReason` type to `FinishReason`.
 - **Chat**: Multiple changes have been implemented:
-  - Modified `ChatChoice.finishReason`, `ChatChunk.finishReason`, and `Choice.finishReason` types to `FinishReason`.
   - Set `index`, `message`, and `finishReason` fields in `ChatChoice` to be non-nullable.
   - Set `index`, `delta`, and `finishReason` fields in `ChatChunk` to be non-nullable.
   - Set `ChatCompletionFunction.parameters` to be non-nullable.
   - In `FunctionCall`, set `name`, `arguments`, and `argumentsAsJson()` to be non-nullable.
+  - Modified `ChatChoice.finishReason` and `ChatChunk.finishReason` types to `FinishReason`.
 
 # 3.3.2
 > Published 21 Jul 2023

README.md

@@ -17,7 +17,7 @@ repositories {
 }
 
 dependencies {
-    implementation "com.aallam.openai:openai-client:3.3.0"
+    implementation "com.aallam.openai:openai-client:3.4.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.3.0')
+    implementation platform('com.aallam.openai:openai-client-bom:3.4.0')
 
     // define dependencies without versions
     implementation 'com.aallam.openai:openai-client'

gradle.properties

@@ -5,11 +5,12 @@ kotlin.js.compiler=ir
 
 # Lib
 GROUP=com.aallam.openai
-VERSION_NAME=3.4.0-SNAPSHOT
+VERSION_NAME=3.4.0
 
 # OSS
 SONATYPE_HOST=DEFAULT
 RELEASE_SIGNING_ENABLED=true
+SONATYPE_AUTOMATIC_RELEASE=true
 
 # POM
 POM_DESCRIPTION=OpenAI API Kotlin Client

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

@@ -32,7 +32,9 @@ public data class Choice(
     public val logprobs: Logprobs? = null,
 
     /**
-     * The reason why GPT-3 stopped generating, for example "length".
+     * The reason the model stopped generating tokens. This will be [FinishReason.Stop] if the model hit a natural stop
+     * point or a provided stop sequence, or [FinishReason.Length] if the maximum number of tokens specified in the
+     * request was reached.
      */
     @SerialName("finish_reason")
     public val finishReason: FinishReason,