chore: prepare release 3.0.0-alpha01

aallam · Jan 20, 2023 · 4a2d12b · 4a2d12b
1 parent 7862377
commit 4a2d12b
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+# 3.0.0-alpha01
+> Published 20 Jan 2023
+
+### Added
+* DSL builder functions to create requests
+* `Completions` and `Edit`: add `usage` to the responses
+* `Files`: add `download` and `delete` functions
+
+### Changed
+* `FileSource` and [okio](https://square.github.io/okio/) for I/O operations (e.g. files, images).
+* `Embeddings`: response changed to `EmbeddingResponse` to include `usage`.
+
 # 2.1.2
 > Published 11 Jan 2023
 

diff --git a/README.md b/README.md
@@ -168,7 +168,7 @@ val images = openAI.imageURL( // or openAI.imageJSON
   <summary><strong>Create embeddings</strong></summary>
 
 ````kotlin
-val embeddings: List<Embedding> = openAI.embeddings(
+val embeddings = openAI.embeddings(
     request = EmbeddingRequest(
         model = ModelId("text-similarity-babbage-001"),
         input = listOf("The food was delicious and the waiter...")
@@ -184,7 +184,7 @@ val embeddings: List<Embedding> = openAI.embeddings(
   <summary><strong>List files</strong></summary>
 
 ````kotlin
-val files: List<File> = openAI.files()
+val files = openAI.files()
 ````
 
 </details>

diff --git a/gradle.properties b/gradle.properties
@@ -5,7 +5,7 @@ kotlin.js.compiler=ir
 
 # Lib
 GROUP=com.aallam.openai
-VERSION_NAME=2.1.2
+VERSION_NAME=3.0.0-alpha01
 
 # OSS
 SONATYPE_HOST=DEFAULT

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -41,6 +41,6 @@ ulid = { group = "com.aallam.ulid", name = "ulid-kotlin", version = "1.2.0" }
 kotlin-multiplaform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 kotlinx-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 kotlinx-binary-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version = "0.12.1" }
-maven-publish = { id = "com.vanniktech.maven.publish", version = "0.23.1" }
+maven-publish = { id = "com.vanniktech.maven.publish", version = "0.23.2" }
 spotless = { id = "com.diffplug.gradle.spotless", version = "6.12.1" }
 dokka = { id = "org.jetbrains.dokka", version = "1.7.20" }
diff --git a/openai-client/build.gradle.kts b/openai-client/build.gradle.kts
@@ -27,13 +27,13 @@ kotlin {
             dependencies {
                 api(projects.openaiCore)
                 api(libs.coroutines.core)
+                api(libs.okio)
                 implementation(libs.serialization.json)
                 implementation(libs.ktor.client.core)
                 implementation(libs.ktor.client.logging)
                 implementation(libs.ktor.client.auth)
                 implementation(libs.ktor.client.content.negotiation)
                 implementation(libs.ktor.client.serialization.json)
-                implementation(libs.okio)
             }
         }
         val commonTest by getting {

diff --git a/openai-core/build.gradle.kts b/openai-core/build.gradle.kts
@@ -20,7 +20,7 @@ kotlin {
         }
         val commonMain by getting {
             dependencies {
-                implementation(libs.okio)
+                api(libs.okio)
                 implementation(libs.serialization.core)
             }
         }