add default embedding options

Author: alexcheng1982

README.md

@@ -15,7 +15,7 @@ Add Maven dependency.
 <dependency>
   <groupId>com.javaaidev</groupId>
   <artifactId>springai-openai-client</artifactId>
-  <version>0.4.0</version>
+  <version>0.4.1</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>com.javaaidev</groupId>
   <artifactId>springai-openai-client</artifactId>
-  <version>0.4.0</version>
+  <version>0.4.1</version>
 
   <name>OpenAI ChatModel</name>
   <description>Spring AI ChatModel for OpenAI using official Java SDK</description>

src/main/kotlin/com/javaaidev/openai/OpenAIEmbeddingModel.kt

@@ -2,27 +2,65 @@ package com.javaaidev.openai
 
 import com.openai.client.OpenAIClient
 import com.openai.models.EmbeddingCreateParams
+import org.springframework.ai.chat.metadata.EmptyUsage
 import org.springframework.ai.document.Document
-import org.springframework.ai.embedding.AbstractEmbeddingModel
-import org.springframework.ai.embedding.Embedding
-import org.springframework.ai.embedding.EmbeddingRequest
-import org.springframework.ai.embedding.EmbeddingResponse
+import org.springframework.ai.embedding.*
+import org.springframework.ai.model.ModelOptionsUtils
 
-class OpenAIEmbeddingModel(private val openAIClient: OpenAIClient) : AbstractEmbeddingModel() {
+class OpenAIEmbeddingModel(
+    private val openAIClient: OpenAIClient,
+    private val defaultOptions: OpenAIEmbeddingOptions? = null,
+) :
+    AbstractEmbeddingModel() {
     override fun call(request: EmbeddingRequest): EmbeddingResponse {
         val paramsBuilder = EmbeddingCreateParams.builder()
             .inputOfArrayOfStrings(request.instructions)
-        request.options.model?.let {
+
+        val options = mergeOptions(request.options)
+
+        options.model?.let {
             paramsBuilder.model(it)
         }
-        request.options.dimensions?.let {
+        options.dimensions?.let {
             paramsBuilder.dimensions(it.toLong())
         }
+        options.encodingFormat?.let {
+            paramsBuilder.encodingFormat(EmbeddingCreateParams.EncodingFormat.of(it))
+        }
+        options.user?.let {
+            paramsBuilder.user(it)
+        }
+
         val response = openAIClient.embeddings().create(paramsBuilder.build())
         val embeddings = response.data().map { e ->
             Embedding(e.embedding().map { v -> v.toFloat() }.toFloatArray(), e.index().toInt())
         }
-        return EmbeddingResponse(embeddings)
+        return EmbeddingResponse(embeddings, EmbeddingResponseMetadata(response.model(), EmptyUsage()))
+    }
+
+    private fun mergeOptions(runtimeOptions: EmbeddingOptions?): OpenAIEmbeddingOptions {
+        val defaultOptions = this.defaultOptions ?: OpenAIEmbeddingOptions.builder().build()
+        return ModelOptionsUtils.copyToTarget(
+            runtimeOptions, EmbeddingOptions::class.java,
+            OpenAIEmbeddingOptions::class.java
+        )?.let { options ->
+            OpenAIEmbeddingOptions.builder()
+                .model(ModelOptionsUtils.mergeOption(options.model, defaultOptions.model))
+                .dimensions(
+                    ModelOptionsUtils.mergeOption(
+                        options.dimensions,
+                        defaultOptions.dimensions
+                    )
+                )
+                .encodingFormat(
+                    ModelOptionsUtils.mergeOption(
+                        options.encodingFormat,
+                        defaultOptions.encodingFormat
+                    )
+                )
+                .user(ModelOptionsUtils.mergeOption(options.user, defaultOptions.user))
+                .build()
+        } ?: defaultOptions
     }
 
     override fun embed(document: Document): FloatArray {

src/test/kotlin/com/javaaidev/openai/OpenAIEmbeddingModelTest.kt

@@ -1,8 +1,7 @@
 package com.javaaidev.openai
 
 import com.openai.client.okhttp.OpenAIOkHttpClient
-import org.junit.jupiter.api.Assertions.assertNotNull
-import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.DisplayName
 import org.junit.jupiter.api.Test
 import org.springframework.ai.embedding.EmbeddingModel
@@ -13,21 +12,36 @@ class OpenAIEmbeddingModelTest {
 
     init {
         val client = OpenAIOkHttpClient.fromEnv()
-        embeddingModel = OpenAIEmbeddingModel(client)
+        embeddingModel = OpenAIEmbeddingModel(
+            client,
+            OpenAIEmbeddingOptions.builder().model("text-embedding-3-small").build()
+        )
     }
 
     @Test
     @DisplayName("simple embedding")
     fun testEmbedding() {
+        val response = embeddingModel.embed(
+            listOf("hello", "world")
+        )
+        assertNotNull(response)
+        assertTrue(response.isNotEmpty())
+    }
+
+    @Test
+    @DisplayName("embedding with options")
+    fun testEmbeddingWithOptions() {
+        val model = "text-embedding-3-large"
         val response = embeddingModel.call(
             EmbeddingRequest(
                 listOf("hello", "world"),
                 OpenAIEmbeddingOptions.builder()
-                    .model("text-embedding-3-small")
+                    .model(model)
                     .build()
             )
         )
         assertNotNull(response)
+        assertEquals(model, response.metadata.model)
         assertTrue(response.results.isNotEmpty())
     }
 }