feat: add QianFan model client

models/spring-ai-qianfan/README.md

@@ -0,0 +1,3 @@
+[QianFan Chat Documentation](https://docs.spring.io/spring-ai/reference/1.0-SNAPSHOT/api/chat/qianfan-chat.html)
+
+[QianFan Embedding Documentation](https://docs.spring.io/spring-ai/reference/1.0-SNAPSHOT/api/embeddings/qianfan-embeddings.html)

models/spring-ai-qianfan/pom.xml

@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.springframework.ai</groupId>
+        <artifactId>spring-ai</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+    <artifactId>spring-ai-qianfan</artifactId>
+    <packaging>jar</packaging>
+    <name>Spring AI QianFan</name>
+    <description>Baidu QianFan support</description>
+    <url>https://github.com/spring-projects/spring-ai</url>
+
+    <scm>
+        <url>https://github.com/spring-projects/spring-ai</url>
+        <connection>git://github.com/spring-projects/spring-ai.git</connection>
+        <developerConnection>git@github.com:spring-projects/spring-ai.git</developerConnection>
+    </scm>
+
+    <dependencies>
+
+        <!-- production dependencies -->
+        <dependency>
+            <groupId>org.springframework.ai</groupId>
+            <artifactId>spring-ai-core</artifactId>
+            <version>${project.parent.version}</version>
+        </dependency>
+
+		<dependency>
+			<groupId>org.springframework.ai</groupId>
+			<artifactId>spring-ai-retry</artifactId>
+			<version>${project.parent.version}</version>
+		</dependency>
+
+        <!-- Spring Framework -->
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-context-support</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-logging</artifactId>
+        </dependency>
+
+        <!-- test dependencies -->
+        <dependency>
+            <groupId>org.springframework.ai</groupId>
+            <artifactId>spring-ai-test</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+    </dependencies>
+
+</project>

models/spring-ai-qianfan/src/main/java/org/springframework/ai/qianfan/QianFanChatClient.java

@@ -0,0 +1,199 @@
+/*
+ * Copyright 2023 - 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.qianfan;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.ai.chat.ChatClient;
+import org.springframework.ai.chat.ChatResponse;
+import org.springframework.ai.chat.Generation;
+import org.springframework.ai.chat.StreamingChatClient;
+import org.springframework.ai.chat.prompt.ChatOptions;
+import org.springframework.ai.chat.prompt.Prompt;
+import org.springframework.ai.model.ModelOptionsUtils;
+import org.springframework.ai.qianfan.api.QianFanApi;
+import org.springframework.ai.qianfan.api.QianFanApi.ChatCompletion;
+import org.springframework.ai.qianfan.api.QianFanApi.ChatCompletionChunk;
+import org.springframework.ai.qianfan.api.QianFanApi.ChatCompletionMessage;
+import org.springframework.ai.qianfan.api.QianFanApi.ChatCompletionMessage.Role;
+import org.springframework.ai.qianfan.api.QianFanApi.ChatCompletionRequest;
+import org.springframework.ai.retry.RetryUtils;
+import org.springframework.http.ResponseEntity;
+import org.springframework.retry.support.RetryTemplate;
+import org.springframework.util.Assert;
+import reactor.core.publisher.Flux;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * {@link ChatClient} and {@link StreamingChatClient} implementation for
+ * {@literal QianFan} backed by {@link QianFanApi}.
+ *
+ * @author Geng Rong
+ * @see ChatClient
+ * @see StreamingChatClient
+ * @see QianFanApi
+ */
+public class QianFanChatClient implements ChatClient, StreamingChatClient {
+
+	private static final Logger logger = LoggerFactory.getLogger(QianFanChatClient.class);
+
+	/**
+	 * The default options used for the chat completion requests.
+	 */
+	private final QianFanChatOptions defaultOptions;
+
+	/**
+	 * The retry template used to retry the QianFan API calls.
+	 */
+	public final RetryTemplate retryTemplate;
+
+	/**
+	 * Low-level access to the QianFan API.
+	 */
+	private final QianFanApi qianFanApi;
+
+	/**
+	 * Creates an instance of the QianFanChatClient.
+	 * @param qianFanApi The QianFanApi instance to be used for interacting with the
+	 * QianFan Chat API.
+	 * @throws IllegalArgumentException if QianFanApi is null
+	 */
+	public QianFanChatClient(QianFanApi qianFanApi) {
+		this(qianFanApi,
+				QianFanChatOptions.builder().withModel(QianFanApi.DEFAULT_CHAT_MODEL).withTemperature(0.7f).build());
+	}
+
+	/**
+	 * Initializes an instance of the QianFanChatClient.
+	 * @param qianFanApi The QianFanApi instance to be used for interacting with the
+	 * QianFan Chat API.
+	 * @param options The QianFanChatOptions to configure the chat client.
+	 */
+	public QianFanChatClient(QianFanApi qianFanApi, QianFanChatOptions options) {
+		this(qianFanApi, options, RetryUtils.DEFAULT_RETRY_TEMPLATE);
+	}
+
+	/**
+	 * Initializes a new instance of the QianFanChatClient.
+	 * @param qianFanApi The QianFanApi instance to be used for interacting with the
+	 * QianFan Chat API.
+	 * @param options The QianFanChatOptions to configure the chat client.
+	 * @param retryTemplate The retry template.
+	 */
+	public QianFanChatClient(QianFanApi qianFanApi, QianFanChatOptions options, RetryTemplate retryTemplate) {
+		Assert.notNull(qianFanApi, "QianFanApi must not be null");
+		Assert.notNull(options, "Options must not be null");
+		Assert.notNull(retryTemplate, "RetryTemplate must not be null");
+		this.qianFanApi = qianFanApi;
+		this.defaultOptions = options;
+		this.retryTemplate = retryTemplate;
+	}
+
+	@Override
+	public ChatResponse call(Prompt prompt) {
+
+		ChatCompletionRequest request = createRequest(prompt, false);
+
+		return this.retryTemplate.execute(ctx -> {
+
+			ResponseEntity<ChatCompletion> completionEntity = this.doChatCompletion(request);
+
+			var chatCompletion = completionEntity.getBody();
+			if (chatCompletion == null) {
+				logger.warn("No chat completion returned for prompt: {}", prompt);
+				return new ChatResponse(List.of());
+			}
+
+			// if (chatCompletion.baseResponse() != null &&
+			// chatCompletion.baseResponse().statusCode() != 0) {
+			// throw new RuntimeException(chatCompletion.baseResponse().message());
+			// }
+
+			var generation = new Generation(chatCompletion.result(),
+					Map.of("id", chatCompletion.id(), "role", Role.ASSISTANT));
+			return new ChatResponse(Collections.singletonList(generation));
+		});
+	}
+
+	@Override
+	public Flux<ChatResponse> stream(Prompt prompt) {
+		var request = createRequest(prompt, true);
+
+		return retryTemplate.execute(ctx -> {
+			var completionChunks = this.qianFanApi.chatCompletionStream(request);
+
+			return completionChunks.map(this::toChatCompletion).map(chatCompletion -> {
+				String id = chatCompletion.id();
+				var generation = new Generation(chatCompletion.result(), Map.of("id", id, "role", Role.ASSISTANT));
+				return new ChatResponse(Collections.singletonList(generation));
+			});
+		});
+	}
+
+	/**
+	 * Convert the ChatCompletionChunk into a ChatCompletion.
+	 * @param chunk the ChatCompletionChunk to convert
+	 * @return the ChatCompletion
+	 */
+	private ChatCompletion toChatCompletion(ChatCompletionChunk chunk) {
+		return new ChatCompletion(chunk.id(), chunk.object(), chunk.created(), chunk.result(), chunk.usage());
+	}
+
+	/**
+	 * Accessible for testing.
+	 */
+	public ChatCompletionRequest createRequest(Prompt prompt, boolean stream) {
+		var chatCompletionMessages = prompt.getInstructions()
+			.stream()
+			.map(m -> new ChatCompletionMessage(m.getContent(),
+					ChatCompletionMessage.Role.valueOf(m.getMessageType().name())))
+			.toList();
+		var systemMessageList = chatCompletionMessages.stream().filter(msg -> msg.role() == Role.SYSTEM).toList();
+
+		if (systemMessageList.size() > 1) {
+			throw new IllegalArgumentException("Only one system message is allowed in the prompt");
+		}
+
+		var systemMessage = systemMessageList.isEmpty() ? null : systemMessageList.get(0).content();
+
+		var request = new ChatCompletionRequest(chatCompletionMessages, systemMessage, stream);
+
+		if (this.defaultOptions != null) {
+			request = ModelOptionsUtils.merge(this.defaultOptions, request, ChatCompletionRequest.class);
+		}
+
+		if (prompt.getOptions() != null) {
+			if (prompt.getOptions() instanceof ChatOptions runtimeOptions) {
+				var updatedRuntimeOptions = ModelOptionsUtils.copyToTarget(runtimeOptions, ChatOptions.class,
+						QianFanChatOptions.class);
+				request = ModelOptionsUtils.merge(updatedRuntimeOptions, request, ChatCompletionRequest.class);
+			}
+			else {
+				throw new IllegalArgumentException("Prompt options are not of type ChatOptions: "
+						+ prompt.getOptions().getClass().getSimpleName());
+			}
+		}
+		return request;
+	}
+
+	private ResponseEntity<ChatCompletion> doChatCompletion(ChatCompletionRequest request) {
+		return this.qianFanApi.chatCompletionEntity(request);
+	}
+
+}