Charles preferences

Author: rpanackal

docs/guides/SPRING_AI_INTEGRATION.md

@@ -170,20 +170,19 @@ Please find [an example in our Spring Boot application](../../sample-code/spring
 
 ## OpenAI
 
+### Introduction
+
+Our OpenAI client is integrated in Spring AI classes:
+
 ### Embedding
 
-With SpringAI integration (_since v1.5.0_), you may now obtain embedding vectors for a list of strings as follows:
+Here is how to obtain embedding vectors for a list of strings:
 
 You first initialize the OpenAI client for your model of choice and attach it  `OpenAiSpringEmbeddingModel` object.
 
 ```java
 OpenAiClient client = OpenAiClient.forModel(OpenAiModel.TEXT_EMBEDDING_3_SMALL);
 OpenAiSpringEmbeddingModel embeddingModel = new OpenAiSpringEmbeddingModel(client);
-``` 
-
-Then you can invoke `embded` method on the `embeddingModel` object with the text items to embed.
-
-```java
 List<String> texts = List.of("Hello", "World");
 float[] embeddings = embeddingModel.embed(texts);
 ```

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/spring/OpenAiSpringEmbeddingModel.java

@@ -68,7 +68,7 @@ public EmbeddingResponse call(@Nonnull final EmbeddingRequest request)
 
     if (request.getOptions().getModel() != null) {
       throw new IllegalArgumentException(
-          "Invalid EmbeddingRequest: the model option must be null, as the client already defines the model.");
+          "Do not set a model in EmbeddingOptions, as the OpenAiClient already defines the model.");
     }
 
     final var openAiRequest = createEmbeddingsCreateRequest(request);
@@ -80,12 +80,10 @@ public EmbeddingResponse call(@Nonnull final EmbeddingRequest request)
   @Override
   @Nonnull
   public float[] embed(@Nonnull final Document document) throws UnsupportedOperationException {
-    if (document.isText()) {
-      return embed(
-          Objects.requireNonNull(
-              document.getFormattedContent(this.metadataMode), "Document is missing text content"));
-    }
-    throw new UnsupportedOperationException("Only text type document supported for embedding");
+    return embed(
+        Objects.requireNonNull(
+            document.getFormattedContent(this.metadataMode),
+            "Formatted content of the document should not be null."));
   }
 
   private EmbeddingsCreateRequest createEmbeddingsCreateRequest(

foundation-models/openai/src/test/java/com/sap/ai/sdk/foundationmodels/openai/spring/EmbeddingModelTest.java

@@ -80,7 +80,7 @@ void testCallWithModelOptionSetThrows() {
     assertThatThrownBy(() -> model.call(springAiRequest))
         .isInstanceOf(IllegalArgumentException.class)
         .hasMessage(
-            "Invalid EmbeddingRequest: the model option must be null, as the client already defines the model.");
+            "Do not set a model in EmbeddingOptions, as the OpenAiClient already defines the model.");
   }
 
   @Test
@@ -106,19 +106,6 @@ void testEmbedDocument() {
     assertThat(result).isEqualTo(new float[] {1, 2, 3});
   }
 
-  @Test
-  @DisplayName("Embed document with missing text content throws exception")
-  void testEmbedNonTextDocumentThrows() {
-    val document = mock(Document.class);
-    when(document.isText()).thenReturn(false);
-
-    val model = new OpenAiSpringEmbeddingModel(client);
-
-    assertThatThrownBy(() -> model.embed(document))
-        .isInstanceOf(UnsupportedOperationException.class)
-        .hasMessage("Only text type document supported for embedding");
-  }
-
   private static <T> Consumer<T> assertRecursiveEquals(T expected) {
     return (actual) -> {
       assertThat(actual).usingRecursiveComparison().isEqualTo(expected);

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/SpringAiOpenAiController.java

@@ -1,7 +1,6 @@
 package com.sap.ai.sdk.app.controllers;
 
 import com.sap.ai.sdk.app.services.SpringAiOpenAiService;
-import java.util.List;
 import javax.annotation.Nullable;
 import lombok.val;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -16,10 +15,9 @@
 class SpringAiOpenAiController {
   @Autowired private SpringAiOpenAiService service;
 
-  @GetMapping("/embed")
+  @GetMapping("/embed/strings")
   Object embed(@Nullable @RequestParam(value = "format", required = false) final String format) {
-    val response =
-        service.embedWithEmbeddingRequest(List.of("The quick brown fox jumps over the lazy dog."));
+    val response = service.embedStrings();
 
     if ("json".equals(format)) {
       return response;

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/SpringAiOpenAiService.java

@@ -20,26 +20,25 @@ public class SpringAiOpenAiService {
   /**
    * Embeds a list of strings using the OpenAI embedding model.
    *
-   * @param strings the list of strings to embed
    * @return an {@code EmbeddingResponse} containing the embeddings and metadata
    */
   @Nonnull
-  public EmbeddingResponse embedWithEmbeddingRequest(@Nonnull final List<String> strings) {
+  public EmbeddingResponse embedStrings() {
     final var options = EmbeddingOptionsBuilder.builder().withDimensions(128).build();
-    final var springAiRequest = new EmbeddingRequest(strings, options);
+    final var springAiRequest =
+        new EmbeddingRequest(List.of("The quick brown fox jumps over the lazy dog."), options);
 
     return new OpenAiSpringEmbeddingModel(client).call(springAiRequest);
   }
 
   /**
    * Embeds the content of a document using the OpenAI embedding model.
    *
-   * @param content the content of the document to embed
    * @return a float array representing the embedding of the document's content
    */
   @Nonnull
-  public float[] embedWithDocument(@Nonnull final String content) {
-    final var document = new Document(content);
+  public float[] embedDocument() {
+    final var document = new Document("The quick brown fox jumps over the lazy dog.");
     return new OpenAiSpringEmbeddingModel(client).embed(document);
   }
 }

sample-code/spring-app/src/main/resources/static/index.html

@@ -631,8 +631,8 @@ <h5 class="mb-1">Orchestration Integration</h5>
                     </div>
                     <div class="card-body">
                         <div class="d-flex align-items-center">
-                            <img src="Open-AI-Logo.svg" alt="OpenAI Logo" width="35" class="me-1 mb-2">
-                            <h5 class="mb-1">OpenAI Integration</h5>
+                            <img src="Open-AI-Logo.svg" alt="OpenAI Logo" class="me-1 mb-1">
+                            <h5 class="mb-1">OpenAI</h5>
                         </div>
                         <ul class="list-group">
                             <li class="list-group-item">

sample-code/spring-app/src/test/java/com/sap/ai/sdk/app/controllers/SpringAiOpenAiTest.java

@@ -4,24 +4,19 @@
 
 import com.sap.ai.sdk.app.services.SpringAiOpenAiService;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiModel;
-import java.util.List;
 import org.junit.jupiter.api.Test;
 
 class SpringAiOpenAiTest {
 
   private final SpringAiOpenAiService service = new SpringAiOpenAiService();
 
   @Test
-  void testEmbedWithEmbeddingRequest() {
+  void testEmbedStrings() {
 
-    var response =
-        service.embedWithEmbeddingRequest(
-            List.of(
-                "The quick brown fox jumps over the lazy dog.",
-                "To be or not to be, that is the question."));
+    var response = service.embedStrings();
 
     assertThat(response).isNotNull();
-    assertThat(response.getResults()).hasSize(2);
+    assertThat(response.getResults()).hasSize(1);
     assertThat(response.getResults().get(0).getOutput()).hasSize(128);
     assertThat(response.getMetadata().getUsage().getPromptTokens()).isNotNull();
     assertThat(response.getMetadata().getUsage().getTotalTokens()).isNotNull();