Refactor OpenAI chat options

 - Deprecate existing OpenAI chat options
 - Add the options' methods by removing the prefix "with"
   - Update the following options
    - OpenAI chat options
    - OpenAI image options
    - OpenAI moderation options
    - OpenAI embedding options
    - OpenAI audiospeech options
    - OpenAI audio transcription options
 - Update referecens and docs
 - Deprecate 'with' methods in builders

Author: ilayaperumalg

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

@@ -79,10 +79,10 @@ public class OpenAiAudioSpeechModel implements SpeechModel, StreamingSpeechModel
 	public OpenAiAudioSpeechModel(OpenAiAudioApi audioApi) {
 		this(audioApi,
 				OpenAiAudioSpeechOptions.builder()
-					.withModel(OpenAiAudioApi.TtsModel.TTS_1.getValue())
-					.withResponseFormat(AudioResponseFormat.MP3)
-					.withVoice(OpenAiAudioApi.SpeechRequest.Voice.ALLOY)
-					.withSpeed(SPEED)
+					.model(OpenAiAudioApi.TtsModel.TTS_1.getValue())
+					.responseFormat(AudioResponseFormat.MP3)
+					.voice(OpenAiAudioApi.SpeechRequest.Voice.ALLOY)
+					.speed(SPEED)
 					.build());
 	}
 
@@ -189,12 +189,12 @@ private OpenAiAudioApi.SpeechRequest createRequest(SpeechPrompt request) {
 	private OpenAiAudioSpeechOptions merge(OpenAiAudioSpeechOptions source, OpenAiAudioSpeechOptions target) {
 		OpenAiAudioSpeechOptions.Builder mergedBuilder = OpenAiAudioSpeechOptions.builder();
 
-		mergedBuilder.withModel(source.getModel() != null ? source.getModel() : target.getModel());
-		mergedBuilder.withInput(source.getInput() != null ? source.getInput() : target.getInput());
-		mergedBuilder.withVoice(source.getVoice() != null ? source.getVoice() : target.getVoice());
-		mergedBuilder.withResponseFormat(
+		mergedBuilder.model(source.getModel() != null ? source.getModel() : target.getModel());
+		mergedBuilder.input(source.getInput() != null ? source.getInput() : target.getInput());
+		mergedBuilder.voice(source.getVoice() != null ? source.getVoice() : target.getVoice());
+		mergedBuilder.responseFormat(
 				source.getResponseFormat() != null ? source.getResponseFormat() : target.getResponseFormat());
-		mergedBuilder.withSpeed(source.getSpeed() != null ? source.getSpeed() : target.getSpeed());
+		mergedBuilder.speed(source.getSpeed() != null ? source.getSpeed() : target.getSpeed());
 
 		return mergedBuilder.build();
 	}

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

@@ -28,6 +28,7 @@
  *
  * @author Ahmed Yousri
  * @author Hyunjoon Choi
+ * @author Ilayaperumal Gopinathan
  * @since 1.0.0-M1
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
@@ -186,26 +187,71 @@ public static class Builder {
 
 		private final OpenAiAudioSpeechOptions options = new OpenAiAudioSpeechOptions();
 
+		public Builder model(String model) {
+			this.options.model = model;
+			return this;
+		}
+
+		public Builder input(String input) {
+			this.options.input = input;
+			return this;
+		}
+
+		public Builder voice(Voice voice) {
+			this.options.voice = voice;
+			return this;
+		}
+
+		public Builder responseFormat(AudioResponseFormat responseFormat) {
+			this.options.responseFormat = responseFormat;
+			return this;
+		}
+
+		public Builder speed(Float speed) {
+			this.options.speed = speed;
+			return this;
+		}
+
+		/**
+		 * @deprecated use {@link #model(String)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withModel(String model) {
 			this.options.model = model;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #input(String)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withInput(String input) {
 			this.options.input = input;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #voice(Voice)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withVoice(Voice voice) {
 			this.options.voice = voice;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #responseFormat(AudioResponseFormat)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withResponseFormat(AudioResponseFormat responseFormat) {
 			this.options.responseFormat = responseFormat;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #speed(Float)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withSpeed(Float speed) {
 			this.options.speed = speed;
 			return this;

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

@@ -63,9 +63,9 @@ public class OpenAiAudioTranscriptionModel implements Model<AudioTranscriptionPr
 	public OpenAiAudioTranscriptionModel(OpenAiAudioApi audioApi) {
 		this(audioApi,
 				OpenAiAudioTranscriptionOptions.builder()
-					.withModel(OpenAiAudioApi.WhisperModel.WHISPER_1.getValue())
-					.withResponseFormat(OpenAiAudioApi.TranscriptResponseFormat.JSON)
-					.withTemperature(0.7f)
+					.model(OpenAiAudioApi.WhisperModel.WHISPER_1.getValue())
+					.responseFormat(OpenAiAudioApi.TranscriptResponseFormat.JSON)
+					.temperature(0.7f)
 					.build());
 	}
 

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

@@ -30,6 +30,7 @@
  * @author Michael Lavelle
  * @author Christian Tzolov
  * @author Piotr Olaszewski
+ * @author Ilayaperumal Gopinathan
  * @since 0.8.1
  */
 @JsonInclude(Include.NON_NULL)
@@ -181,31 +182,85 @@ public Builder(OpenAiAudioTranscriptionOptions options) {
 			this.options = options;
 		}
 
+		public Builder model(String model) {
+			this.options.model = model;
+			return this;
+		}
+
+		public Builder language(String language) {
+			this.options.language = language;
+			return this;
+		}
+
+		public Builder prompt(String prompt) {
+			this.options.prompt = prompt;
+			return this;
+		}
+
+		public Builder responseFormat(TranscriptResponseFormat responseFormat) {
+			this.options.responseFormat = responseFormat;
+			return this;
+		}
+
+		public Builder temperature(Float temperature) {
+			this.options.temperature = temperature;
+			return this;
+		}
+
+		public Builder granularityType(GranularityType granularityType) {
+			this.options.granularityType = granularityType;
+			return this;
+		}
+
+		/**
+		 * @deprecated use {@link #model( String)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withModel(String model) {
 			this.options.model = model;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #language( String)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withLanguage(String language) {
 			this.options.language = language;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #prompt( String)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withPrompt(String prompt) {
 			this.options.prompt = prompt;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #responseFormat( TranscriptResponseFormat)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withResponseFormat(TranscriptResponseFormat responseFormat) {
 			this.options.responseFormat = responseFormat;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #temperature( Float)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withTemperature(Float temperature) {
 			this.options.temperature = temperature;
 			return this;
 		}
 
+		/**
+		 * @deprecated use {@link #granularityType( GranularityType)} instead.
+		 */
+		@Deprecated(forRemoval = true, since = "1.0.0-M5")
 		public Builder withGranularityType(GranularityType granularityType) {
 			this.options.granularityType = granularityType;
 			return this;

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

@@ -143,8 +143,7 @@ public class OpenAiChatModel extends AbstractToolCallSupport implements ChatMode
 	 * @throws IllegalArgumentException if openAiApi is null
 	 */
 	public OpenAiChatModel(OpenAiApi openAiApi) {
-		this(openAiApi,
-				OpenAiChatOptions.builder().withModel(OpenAiApi.DEFAULT_CHAT_MODEL).withTemperature(0.7).build());
+		this(openAiApi, OpenAiChatOptions.builder().model(OpenAiApi.DEFAULT_CHAT_MODEL).temperature(0.7).build());
 	}
 
 	/**
@@ -588,13 +587,13 @@ else if (message.getMessageType() == MessageType.TOOL) {
 		if (!CollectionUtils.isEmpty(enabledToolsToUse)) {
 
 			request = ModelOptionsUtils.merge(
-					OpenAiChatOptions.builder().withTools(this.getFunctionTools(enabledToolsToUse)).build(), request,
+					OpenAiChatOptions.builder().tools(this.getFunctionTools(enabledToolsToUse)).build(), request,
 					ChatCompletionRequest.class);
 		}
 		// Remove `streamOptions` from the request if it is not a streaming request
 		if (request.streamOptions() != null && !stream) {
 			logger.warn("Removing streamOptions from the request as it is not a streaming request!");
-			request = request.withStreamOptions(null);
+			request = request.streamOptions(null);
 		}
 
 		return request;