Make the StreamingChatClient a StreamingModelClient

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

@@ -183,7 +183,7 @@ public ChatResponse call(Prompt prompt) {
 	}
 
 	@Override
-	public Flux<ChatResponse> generateStream(Prompt prompt) {
+	public Flux<ChatResponse> streamingCall(Prompt prompt) {
 
 		ChatCompletionsOptions options = toAzureChatCompletionsOptions(prompt);
 		options.setStream(true);

models/spring-ai-azure-openai/src/test/java/org/springframework/ai/azure/openai/AzureOpenAiChatClientIT.java

@@ -151,7 +151,7 @@ void beanStreamOutputParserRecords() {
 		PromptTemplate promptTemplate = new PromptTemplate(template, Map.of("format", format));
 		Prompt prompt = new Prompt(promptTemplate.createMessage());
 
-		String generationTextFromStream = chatClient.generateStream(prompt)
+		String generationTextFromStream = chatClient.streamingCall(prompt)
 			.collectList()
 			.block()
 			.stream()

models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/anthropic/BedrockAnthropicChatClient.java

@@ -107,7 +107,7 @@ public ChatResponse call(Prompt prompt) {
 	}
 
 	@Override
-	public Flux<ChatResponse> generateStream(Prompt prompt) {
+	public Flux<ChatResponse> streamingCall(Prompt prompt) {
 
 		final String promptValue = MessageToPromptConverter.create().toPrompt(prompt.getInstructions());
 

models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/cohere/BedrockCohereChatClient.java

@@ -122,7 +122,7 @@ public ChatResponse call(Prompt prompt) {
 	}
 
 	@Override
-	public Flux<ChatResponse> generateStream(Prompt prompt) {
+	public Flux<ChatResponse> streamingCall(Prompt prompt) {
 		return this.chatApi.chatCompletionStream(this.createRequest(prompt, true)).map(g -> {
 			if (g.isFinished()) {
 				String finishReason = g.finishReason().name();

models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/llama2/BedrockLlama2ChatClient.java

@@ -85,7 +85,7 @@ public ChatResponse call(Prompt prompt) {
 	}
 
 	@Override
-	public Flux<ChatResponse> generateStream(Prompt prompt) {
+	public Flux<ChatResponse> streamingCall(Prompt prompt) {
 
 		final String promptValue = MessageToPromptConverter.create().toPrompt(prompt.getInstructions());
 

models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/titan/BedrockTitanChatClient.java

@@ -84,7 +84,7 @@ public ChatResponse call(Prompt prompt) {
 	}
 
 	@Override
-	public Flux<ChatResponse> generateStream(Prompt prompt) {
+	public Flux<ChatResponse> streamingCall(Prompt prompt) {
 		return this.chatApi.chatCompletionStream(this.createRequest(prompt, true)).map(chunk -> {
 
 			Generation generation = new Generation(chunk.outputText());

models/spring-ai-bedrock/src/test/java/org/springframework/ai/bedrock/anthropic/BedrockAnthropicChatClientIT.java

@@ -134,7 +134,7 @@ void beanStreamOutputParserRecords() {
 		PromptTemplate promptTemplate = new PromptTemplate(template, Map.of("format", format));
 		Prompt prompt = new Prompt(promptTemplate.createMessage());
 
-		String generationTextFromStream = client.generateStream(prompt)
+		String generationTextFromStream = client.streamingCall(prompt)
 			.collectList()
 			.block()
 			.stream()

models/spring-ai-bedrock/src/test/java/org/springframework/ai/bedrock/cohere/BedrockCohereChatClientIT.java

@@ -134,7 +134,7 @@ void beanStreamOutputParserRecords() {
 		PromptTemplate promptTemplate = new PromptTemplate(template, Map.of("format", format));
 		Prompt prompt = new Prompt(promptTemplate.createMessage());
 
-		String generationTextFromStream = client.generateStream(prompt)
+		String generationTextFromStream = client.streamingCall(prompt)
 			.collectList()
 			.block()
 			.stream()

models/spring-ai-bedrock/src/test/java/org/springframework/ai/bedrock/llama2/BedrockLlama2ChatClientIT.java

@@ -139,7 +139,7 @@ void beanStreamOutputParserRecords() {
 		PromptTemplate promptTemplate = new PromptTemplate(template, Map.of("format", format));
 		Prompt prompt = new Prompt(promptTemplate.createMessage());
 
-		String generationTextFromStream = client.generateStream(prompt)
+		String generationTextFromStream = client.streamingCall(prompt)
 			.collectList()
 			.block()
 			.stream()

models/spring-ai-bedrock/src/test/java/org/springframework/ai/bedrock/titan/BedrockTitanChatClientIT.java

@@ -140,7 +140,7 @@ void beanStreamOutputParserRecords() {
 		PromptTemplate promptTemplate = new PromptTemplate(template, Map.of("format", format));
 		Prompt prompt = new Prompt(promptTemplate.createMessage());
 
-		String generationTextFromStream = client.generateStream(prompt)
+		String generationTextFromStream = client.streamingCall(prompt)
 			.collectList()
 			.block()
 			.stream()

models/spring-ai-ollama/src/main/java/org/springframework/ai/ollama/OllamaChatClient.java

@@ -97,7 +97,7 @@ public ChatResponse call(Prompt prompt) {
 	}
 
 	@Override
-	public Flux<ChatResponse> generateStream(Prompt prompt) {
+	public Flux<ChatResponse> streamingCall(Prompt prompt) {
 
 		Flux<OllamaApi.ChatResponse> response = this.chatApi.streamingChat(request(prompt, this.model, true));
 

models/spring-ai-ollama/src/test/java/org/springframework/ai/ollama/OllamaChatClientIT.java

@@ -167,7 +167,7 @@ void beanStreamOutputParserRecords() {
 		PromptTemplate promptTemplate = new PromptTemplate(template, Map.of("format", format));
 		Prompt prompt = new Prompt(promptTemplate.createMessage());
 
-		String generationTextFromStream = client.generateStream(prompt)
+		String generationTextFromStream = client.streamingCall(prompt)
 			.collectList()
 			.block()
 			.stream()

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

@@ -127,7 +127,7 @@ public ChatResponse call(Prompt prompt) {
 	}
 
 	@Override
-	public Flux<ChatResponse> generateStream(Prompt prompt) {
+	public Flux<ChatResponse> streamingCall(Prompt prompt) {
 		return this.retryTemplate.execute(ctx -> {
 			List<Message> messages = prompt.getInstructions();
 

models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/OpenAiChatClientIT.java

@@ -140,7 +140,7 @@ void beanStreamOutputParserRecords() {
 		PromptTemplate promptTemplate = new PromptTemplate(template, Map.of("format", format));
 		Prompt prompt = new Prompt(promptTemplate.createMessage());
 
-		String generationTextFromStream = openStreamingChatClient.generateStream(prompt)
+		String generationTextFromStream = openStreamingChatClient.streamingCall(prompt)
 			.collectList()
 			.block()
 			.stream()

spring-ai-core/src/main/java/org/springframework/ai/chat/StreamingChatClient.java

@@ -16,13 +16,10 @@
 
 package org.springframework.ai.chat;
 
-import reactor.core.publisher.Flux;
-
 import org.springframework.ai.chat.prompt.Prompt;
+import org.springframework.ai.model.StreamingModelClient;
 
 @FunctionalInterface
-public interface StreamingChatClient {
-
-	Flux<ChatResponse> generateStream(Prompt prompt);
+public interface StreamingChatClient extends StreamingModelClient<Prompt, ChatResponse> {
 
 }

spring-ai-core/src/main/java/org/springframework/ai/model/StreamingModelClient.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2024-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.ai.model;
+
+import reactor.core.publisher.Flux;
+
+/**
+ * The StreamingModelClient interface provides a generic API for invoking a AI models with
+ * streaming response. It abstracts the process of sending requests and receiving a
+ * streaming responses. The interface uses Java generics to accommodate different types of
+ * requests and responses, enhancing flexibility and adaptability across different AI
+ * model implementations.
+ *
+ * @param <TReq> the generic type of the request to the AI model
+ * @param <TResChunk> the generic type of a single item in the streaming response from the
+ * AI model
+ * @author Christian Tzolov
+ * @since 0.8.0
+ */
+public interface StreamingModelClient<TReq extends ModelRequest<?>, TResChunk extends ModelResponse<?>> {
+
+	/**
+	 * Executes a method call to the AI model.
+	 * @param request the request object to be sent to the AI model
+	 * @return the streaming response from the AI model
+	 */
+	Flux<TResChunk> streamingCall(TReq request);
+
+}

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/azure/AzureOpenAiAutoConfigurationIT.java

@@ -90,7 +90,7 @@ public void chatCompletionStreaming() {
 
 			AzureOpenAiChatClient chatClient = context.getBean(AzureOpenAiChatClient.class);
 
-			Flux<ChatResponse> response = chatClient.generateStream(new Prompt(List.of(userMessage, systemMessage)));
+			Flux<ChatResponse> response = chatClient.streamingCall(new Prompt(List.of(userMessage, systemMessage)));
 
 			List<ChatResponse> responses = response.collectList().block();
 			assertThat(responses.size()).isGreaterThan(1);

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/bedrock/anthropic/BedrockAnthropicChatAutoConfigurationIT.java

@@ -83,7 +83,7 @@ public void chatCompletionStreaming() {
 			BedrockAnthropicChatClient anthropicChatClient = context.getBean(BedrockAnthropicChatClient.class);
 
 			Flux<ChatResponse> response = anthropicChatClient
-				.generateStream(new Prompt(List.of(userMessage, systemMessage)));
+				.streamingCall(new Prompt(List.of(userMessage, systemMessage)));
 
 			List<ChatResponse> responses = response.collectList().block();
 			assertThat(responses.size()).isGreaterThan(2);

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/bedrock/cohere/BedrockCohereChatAutoConfigurationIT.java

@@ -85,7 +85,7 @@ public void chatCompletionStreaming() {
 			BedrockCohereChatClient cohereChatClient = context.getBean(BedrockCohereChatClient.class);
 
 			Flux<ChatResponse> response = cohereChatClient
-				.generateStream(new Prompt(List.of(userMessage, systemMessage)));
+				.streamingCall(new Prompt(List.of(userMessage, systemMessage)));
 
 			List<ChatResponse> responses = response.collectList().block();
 			assertThat(responses.size()).isGreaterThan(2);

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/bedrock/llama2/BedrockLlama2ChatAutoConfigurationIT.java

@@ -83,7 +83,7 @@ public void chatCompletionStreaming() {
 			BedrockLlama2ChatClient llama2ChatClient = context.getBean(BedrockLlama2ChatClient.class);
 
 			Flux<ChatResponse> response = llama2ChatClient
-				.generateStream(new Prompt(List.of(userMessage, systemMessage)));
+				.streamingCall(new Prompt(List.of(userMessage, systemMessage)));
 
 			List<ChatResponse> responses = response.collectList().block();
 			assertThat(responses.size()).isGreaterThan(2);

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/bedrock/titan/BedrockTitanChatAutoConfigurationIT.java

@@ -82,7 +82,7 @@ public void chatCompletionStreaming() {
 
 			BedrockTitanChatClient chatClient = context.getBean(BedrockTitanChatClient.class);
 
-			Flux<ChatResponse> response = chatClient.generateStream(new Prompt(List.of(userMessage, systemMessage)));
+			Flux<ChatResponse> response = chatClient.streamingCall(new Prompt(List.of(userMessage, systemMessage)));
 
 			List<ChatResponse> responses = response.collectList().block();
 			assertThat(responses.size()).isGreaterThan(1);

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/ollama/OllamaAutoConfigurationIT.java

@@ -100,7 +100,7 @@ public void chatCompletionStreaming() {
 
 			OllamaChatClient chatClient = context.getBean(OllamaChatClient.class);
 
-			Flux<ChatResponse> response = chatClient.generateStream(new Prompt(List.of(userMessage, systemMessage)));
+			Flux<ChatResponse> response = chatClient.streamingCall(new Prompt(List.of(userMessage, systemMessage)));
 
 			List<ChatResponse> responses = response.collectList().block();
 			assertThat(responses.size()).isGreaterThan(1);

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/openai/OpenAiAutoConfigurationIT.java

@@ -59,7 +59,7 @@ void generate() {
 	void generateStreaming() {
 		contextRunner.run(context -> {
 			OpenAiChatClient client = context.getBean(OpenAiChatClient.class);
-			Flux<ChatResponse> responseFlux = client.generateStream(new Prompt(new UserMessage("Hello")));
+			Flux<ChatResponse> responseFlux = client.streamingCall(new Prompt(new UserMessage("Hello")));
 			String response = responseFlux.collectList().block().stream().map(chatResponse -> {
 				return chatResponse.getResults().get(0).getOutput().getContent();
 			}).collect(Collectors.joining());