Add OpenAi Chat Options

Add OpenAiChatOptions

 - OpenAiChatOptions implements ChatOptions and exposes all OpenAi request options, except messages and stream.
 - Add OpenAiChatOptions field (as defaultOptions) to OpenAiChatClient. Implement star-up/runtime options merging on chat request creation
 - Add OpenAiChatOptions options field to OpenAiChatProperties. Later is set as OpenAiChatClient#defaultOptions. Use the spring.ai.openai.chat.options.* prefix to set the options.
 - Add tests for properties and options merging.
 - Move the OpenAiChatOptions.java out of the api package

Add OpenAiEmbeddingOptions

 - Add OpenAiEmbeddingOptions class implementing the EmbeddingOptions interface.
 - Add OpenAiEmbeddingClient#defaultOptions
 - Add request merging with default and propmt options.
 - Add OopenAiEmbeddingProperties#options field of type OpenAiEmbeddingOptions

Update OpenAI client docs

Part of the larger 'epic' issue #228

Author: tzolov

models/spring-ai-openai/pom.xml

@@ -34,6 +34,12 @@
 			<version>2.0.4</version>
 		</dependency>
 
+		<!-- NOTE: Required only by the @ConstructorBinding. -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot</artifactId>
+		</dependency>
+
 		<dependency>
 			<groupId>io.rest-assured</groupId>
 			<artifactId>json-path</artifactId>

models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatClient.java

@@ -28,13 +28,14 @@
 import org.springframework.ai.chat.ChatResponse;
 import org.springframework.ai.chat.Generation;
 import org.springframework.ai.chat.StreamingChatClient;
-import org.springframework.ai.chat.messages.Message;
 import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
 import org.springframework.ai.chat.metadata.RateLimit;
 import org.springframework.ai.chat.prompt.Prompt;
+import org.springframework.ai.model.ModelOptionsUtils;
 import org.springframework.ai.openai.api.OpenAiApi;
 import org.springframework.ai.openai.api.OpenAiApi.ChatCompletion;
 import org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage;
+import org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest;
 import org.springframework.ai.openai.api.OpenAiApi.OpenAiApiException;
 import org.springframework.ai.openai.metadata.OpenAiChatResponseMetadata;
 import org.springframework.ai.openai.metadata.support.OpenAiResponseHeaderExtractor;
@@ -57,12 +58,13 @@
  */
 public class OpenAiChatClient implements ChatClient, StreamingChatClient {
 
-	private Double temperature = 0.7;
-
-	private String model = "gpt-3.5-turbo";
-
 	private final Logger logger = LoggerFactory.getLogger(getClass());
 
+	private OpenAiChatOptions defaultOptions = OpenAiChatOptions.builder()
+		.withModel("gpt-3.5-turbo")
+		.withTemperature(0.7f)
+		.build();
+
 	public final RetryTemplate retryTemplate = RetryTemplate.builder()
 		.maxAttempts(10)
 		.retryOn(OpenAiApiException.class)
@@ -76,40 +78,23 @@ public OpenAiChatClient(OpenAiApi openAiApi) {
 		this.openAiApi = openAiApi;
 	}
 
-	public String getModel() {
-		return this.model;
-	}
-
-	public void setModel(String model) {
-		this.model = model;
-	}
-
-	public Double getTemperature() {
-		return this.temperature;
-	}
-
-	public void setTemperature(Double temperature) {
-		this.temperature = temperature;
+	public OpenAiChatClient withDefaultOptions(OpenAiChatOptions options) {
+		this.defaultOptions = options;
+		return this;
 	}
 
 	@Override
 	public ChatResponse call(Prompt prompt) {
 
 		return this.retryTemplate.execute(ctx -> {
-			List<Message> messages = prompt.getInstructions();
 
-			List<ChatCompletionMessage> chatCompletionMessages = messages.stream()
-				.map(m -> new ChatCompletionMessage(m.getContent(),
-						ChatCompletionMessage.Role.valueOf(m.getMessageType().name())))
-				.toList();
+			ChatCompletionRequest request = createRequest(prompt, false);
 
-			ResponseEntity<ChatCompletion> completionEntity = this.openAiApi
-				.chatCompletionEntity(new OpenAiApi.ChatCompletionRequest(chatCompletionMessages, this.model,
-						this.temperature.floatValue()));
+			ResponseEntity<ChatCompletion> completionEntity = this.openAiApi.chatCompletionEntity(request);
 
 			var chatCompletion = completionEntity.getBody();
 			if (chatCompletion == null) {
-				logger.warn("No chat completion returned for request: {}", chatCompletionMessages);
+				logger.warn("No chat completion returned for request: {}", prompt);
 				return new ChatResponse(List.of());
 			}
 
@@ -128,16 +113,9 @@ public ChatResponse call(Prompt prompt) {
 	@Override
 	public Flux<ChatResponse> stream(Prompt prompt) {
 		return this.retryTemplate.execute(ctx -> {
-			List<Message> messages = prompt.getInstructions();
+			ChatCompletionRequest request = createRequest(prompt, true);
 
-			List<ChatCompletionMessage> chatCompletionMessages = messages.stream()
-				.map(m -> new ChatCompletionMessage(m.getContent(),
-						ChatCompletionMessage.Role.valueOf(m.getMessageType().name())))
-				.toList();
-
-			Flux<OpenAiApi.ChatCompletionChunk> completionChunks = this.openAiApi
-				.chatCompletionStream(new OpenAiApi.ChatCompletionRequest(chatCompletionMessages, this.model,
-						this.temperature.floatValue(), true));
+			Flux<OpenAiApi.ChatCompletionChunk> completionChunks = this.openAiApi.chatCompletionStream(request);
 
 			// For chunked responses, only the first chunk contains the choice role.
 			// The rest of the chunks with same ID share the same role.
@@ -161,4 +139,34 @@ public Flux<ChatResponse> stream(Prompt prompt) {
 		});
 	}
 
+	/**
+	 * Accessible for testing.
+	 */
+	ChatCompletionRequest createRequest(Prompt prompt, boolean stream) {
+
+		List<ChatCompletionMessage> chatCompletionMessages = prompt.getInstructions()
+			.stream()
+			.map(m -> new ChatCompletionMessage(m.getContent(),
+					ChatCompletionMessage.Role.valueOf(m.getMessageType().name())))
+			.toList();
+
+		ChatCompletionRequest request = new ChatCompletionRequest(chatCompletionMessages, stream);
+
+		if (this.defaultOptions != null) {
+			request = ModelOptionsUtils.merge(request, this.defaultOptions, ChatCompletionRequest.class);
+		}
+
+		if (prompt.getOptions() != null) {
+			if (prompt.getOptions() instanceof OpenAiChatOptions runtimeOptions) {
+				request = ModelOptionsUtils.merge(runtimeOptions, request, ChatCompletionRequest.class);
+			}
+			else {
+				throw new IllegalArgumentException("Prompt options are not of type ChatCompletionRequest:"
+						+ prompt.getOptions().getClass().getSimpleName());
+			}
+		}
+
+		return request;
+	}
+
 }