Package org.springframework.ai.qianfan.api

Class QianFanApi

java.lang.Object

org.springframework.ai.qianfan.api.auth.AuthApi

org.springframework.ai.qianfan.api.QianFanApi

public class QianFanApi
extends AuthApi

Single class implementation of the QianFan Chat Completion API and Embedding API. QianFan Docs

Since:

1.0

Author:

Geng Rong, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	QianFanApi.ChatCompletion	Represents a chat completion response returned by model, based on the provided input.
static final record	QianFanApi.ChatCompletionChunk	Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
static final record	QianFanApi.ChatCompletionMessage	Message comprising the conversation.
static final record	QianFanApi.ChatCompletionRequest	Creates a model response for the given chat conversation.
static enum	QianFanApi.ChatModel	QianFan Chat Completion Models: QianFan Model.
static final record	QianFanApi.Embedding	Represents an embedding vector returned by embedding endpoint.
static final record	QianFanApi.EmbeddingList	List of multiple embedding responses.
static enum	QianFanApi.EmbeddingModel	QianFan Embeddings Models: Embeddings.
static final record	QianFanApi.EmbeddingRequest	Creates an embedding vector representing the input text.
static final record	QianFanApi.Usage	Usage statistics for the completion request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHAT_MODEL
static final String	DEFAULT_EMBEDDING_MODEL

Constructor Summary

Constructors

Constructor	Description
QianFanApi(String apiKey, String secretKey)	Create a new chat completion api with default base URL.
QianFanApi(String baseUrl, String apiKey, String secretKey)	Create a new chat completion api.
QianFanApi(String baseUrl, String apiKey, String secretKey, org.springframework.web.client.RestClient.Builder restClientBuilder)	Create a new chat completion api.
QianFanApi(String baseUrl, String apiKey, String secretKey, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new chat completion api.
QianFanApi(String baseUrl, String apiKey, String secretKey, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new chat completion api.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<QianFanApi.ChatCompletion>	chatCompletionEntity(QianFanApi.ChatCompletionRequest chatRequest)	Creates a model response for the given chat conversation.
reactor.core.publisher.Flux<QianFanApi.ChatCompletionChunk>	chatCompletionStream(QianFanApi.ChatCompletionRequest chatRequest)	Creates a streaming chat response for the given chat conversation.
org.springframework.http.ResponseEntity<QianFanApi.EmbeddingList>	embeddings(QianFanApi.EmbeddingRequest embeddingRequest)	Creates an embedding vector representing the input text or token array.

Methods inherited from class org.springframework.ai.qianfan.api.auth.AuthApi

getAccessToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_CHAT_MODEL

public static final String DEFAULT_CHAT_MODEL

DEFAULT_EMBEDDING_MODEL

public static final String DEFAULT_EMBEDDING_MODEL

Constructor Details

QianFanApi

public QianFanApi(String apiKey,
 String secretKey)

Create a new chat completion api with default base URL.

Parameters:

apiKey - QianFan api key.

secretKey - QianFan secret key.

QianFanApi

public QianFanApi(String baseUrl,
 String apiKey,
 String secretKey)

Create a new chat completion api.

Parameters:

baseUrl - api base URL.

apiKey - QianFan api key.

secretKey - QianFan secret key.

QianFanApi

public QianFanApi(String baseUrl,
 String apiKey,
 String secretKey,
 org.springframework.web.client.RestClient.Builder restClientBuilder)

Create a new chat completion api.

Parameters:

baseUrl - api base URL.

apiKey - QianFan api key.

secretKey - QianFan secret key.

restClientBuilder - RestClient builder.

QianFanApi

public QianFanApi(String baseUrl,
 String apiKey,
 String secretKey,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new chat completion api.

Parameters:

baseUrl - api base URL.

apiKey - QianFan api key.

secretKey - QianFan secret key.

restClientBuilder - RestClient builder.

responseErrorHandler - Response error handler.

QianFanApi

public QianFanApi(String baseUrl,
 String apiKey,
 String secretKey,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new chat completion api.

Parameters:

baseUrl - api base URL.

apiKey - QianFan api key.

secretKey - QianFan secret key.

restClientBuilder - RestClient builder.

webClientBuilder - WebClient builder.

responseErrorHandler - Response error handler.

Method Details

chatCompletionEntity

public org.springframework.http.ResponseEntity<QianFanApi.ChatCompletion> chatCompletionEntity(QianFanApi.ChatCompletionRequest chatRequest)

Creates a model response for the given chat conversation.

Parameters:

chatRequest - The chat completion request.

Returns:

Entity response with QianFanApi.ChatCompletion as a body and HTTP status code and headers.

chatCompletionStream

public reactor.core.publisher.Flux<QianFanApi.ChatCompletionChunk> chatCompletionStream(QianFanApi.ChatCompletionRequest chatRequest)

Creates a streaming chat response for the given chat conversation.

Parameters:

chatRequest - The chat completion request. Must have the stream property set to true.

Returns:

Returns a Flux stream from chat completion chunks.

embeddings

public org.springframework.http.ResponseEntity<QianFanApi.EmbeddingList> embeddings(QianFanApi.EmbeddingRequest embeddingRequest)

Creates an embedding vector representing the input text or token array.

Parameters:

embeddingRequest - The embedding request.

Returns:

Returns list of QianFanApi.Embedding wrapped in QianFanApi.EmbeddingList.