This version is still in development and is not considered stable yet. For the latest snapshot version, please use Spring AI 1.0.0-SNAPSHOT!

QianFan Chat

Spring AI supports the various AI language models from QianFan. You can interact with QianFan language models and create a multilingual conversational assistant based on QianFan models.

Prerequisites

You will need to create an API with QianFan to access QianFan language models.

Create an account at QianFan registration page and generate the token on the API Keys page. The Spring AI project defines a configuration property named spring.ai.qianfan.api-key and spring.ai.qianfan.secret-key. you should set to the value of the API Key and Secret Key obtained from API Keys page. Exporting an environment variable is one way to set that configuration property:

export SPRING_AI_QIANFAN_API_KEY=<INSERT API KEY HERE>
export SPRING_AI_QIANFAN_SECRET_KEY=<INSERT SECRET KEY HERE>

Add Repositories and BOM

Spring AI artifacts are published in Spring Milestone and Snapshot repositories. Refer to the Repositories section to add these repositories to your build system.

To help with dependency management, Spring AI provides a BOM (bill of materials) to ensure that a consistent version of Spring AI is used throughout the entire project. Refer to the Dependency Management section to add the Spring AI BOM to your build system.

Auto-configuration

Spring AI provides Spring Boot auto-configuration for the Azure QianFan Embedding Client. To enable it add the following dependency to your project’s Maven pom.xml file:

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-qianfan-spring-boot-starter</artifactId>
</dependency>

or to your Gradle build.gradle build file.

dependencies {
    implementation 'org.springframework.ai:spring-ai-qianfan-spring-boot-starter'
}
Refer to the Dependency Management section to add the Spring AI BOM to your build file.

Embedding Properties

Retry Properties

The prefix spring.ai.retry is used as the property prefix that lets you configure the retry mechanism for the QianFan Embedding client.

Property Description Default

spring.ai.retry.max-attempts

Maximum number of retry attempts.

10

spring.ai.retry.backoff.initial-interval

Initial sleep duration for the exponential backoff policy.

2 sec.

spring.ai.retry.backoff.multiplier

Backoff interval multiplier.

5

spring.ai.retry.backoff.max-interval

Maximum backoff duration.

3 min.

spring.ai.retry.on-client-errors

If false, throw a NonTransientAiException, and do not attempt retry for 4xx client error codes

false

spring.ai.retry.exclude-on-http-codes

List of HTTP status codes that should not trigger a retry (e.g. to throw NonTransientAiException).

empty

spring.ai.retry.on-http-codes

List of HTTP status codes that should trigger a retry (e.g. to throw TransientAiException).

empty

Connection Properties

The prefix spring.ai.qianfan is used as the property prefix that lets you connect to QianFan.

Property Description Default

spring.ai.qianfan.base-url

The URL to connect to

aip.baidubce.com/rpc/2.0/ai_custom

spring.ai.qianfan.api-key

The API Key

-

spring.ai.qianfan.secret-key

The Secret Key

-

Configuration Properties

The prefix spring.ai.qianfan.embedding is property prefix that configures the EmbeddingClient implementation for QianFan.

Property Description Default

spring.ai.qianfan.embedding.enabled

Enable QianFan embedding client.

true

spring.ai.qianfan.embedding.base-url

Optional overrides the spring.ai.qianfan.base-url to provide embedding specific url

-

spring.ai.qianfan.embedding.api-key

Optional overrides the spring.ai.qianfan.api-key to provide embedding specific api-key

-

spring.ai.qianfan.embedding.secret-key

Optional overrides the spring.ai.qianfan.secret-key to provide embedding specific secret-key

-

spring.ai.qianfan.embedding.options.model

The model to use

bge_large_zh
You can override the common spring.ai.qianfan.base-url, spring.ai.qianfan.api-key and spring.ai.qianfan.secret-key for the ChatModel and EmbeddingModel implementations. The spring.ai.qianfan.chat.base-url, spring.ai.qianfan.chat.api-key and spring.ai.qianfan.chat.secret-key properties if set take precedence over the common properties. Similarly, the spring.ai.qianfan.chat.base-url, spring.ai.qianfan.chat.api-key and spring.ai.qianfan.chat.secret-key properties if set take precedence over the common properties. This is useful if you want to use different QianFan accounts for different models and different model endpoints.
All properties prefixed with spring.ai.qianfan.embedding.options can be overridden at runtime by adding a request specific Runtime Options to the EmbeddingRequest call.

Runtime Options

The QianFanEmbeddingOptions.java provides the QianFan configurations, such as the model to use and etc.

The default options can be configured using the spring.ai.qianfan.embedding.options properties as well.

At start-time use the QianFanEmbeddingModel constructor to set the default options used for all embedding requests. At run-time you can override the default options, using a QianFanEmbeddingOptions instance as part of your EmbeddingRequest.

For example to override the default model name for a specific request:

EmbeddingResponse embeddingResponse = embeddingClient.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        QianFanEmbeddingOptions.builder()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

Sample Controller

This will create a EmbeddingClient implementation that you can inject into your class. Here is an example of a simple @Controller class that uses the EmbeddingClient implementation.

spring.ai.qianfan.api-key=YOUR_API_KEY
spring.ai.qianfan.secret-key=YOUR_SECRET_KEY
spring.ai.qianfan.embedding.options.model=tao_8k
@RestController
public class EmbeddingController {

    private final EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

Manual Configuration

If you are not using Spring Boot, you can manually configure the QianFan Embedding Client. For this add the spring-ai-qianfan dependency to your project’s Maven pom.xml file:

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-qianfan</artifactId>
</dependency>

or to your Gradle build.gradle build file.

dependencies {
    implementation 'org.springframework.ai:spring-ai-qianfan'
}
Refer to the Dependency Management section to add the Spring AI BOM to your build file.
The spring-ai-qianfan dependency provides access also to the QianFanChatModel. For more information about the QianFanChatModel refer to the QianFan Chat Client section.

Next, create an QianFanEmbeddingModel instance and use it to compute the similarity between two input texts:

var qianFanApi = new QianFanApi(System.getenv("MINIMAX_API_KEY"), System.getenv("QIANFAN_SECRET_KEY"));

var embeddingClient = new QianFanEmbeddingModel(qianFanApi)
    .withDefaultOptions(QianFanChatOptions.build()
        .withModel("bge_large_en")
        .build());

EmbeddingResponse embeddingResponse = this.embeddingClient
	.embedForResponse(List.of("Hello World", "World is big and salvation is near"));

The QianFanEmbeddingOptions provides the configuration information for the embedding requests. The options class offers a builder() for easy options creation.