Package org.springframework.ai.qianfan

Class QianFanChatModel

java.lang.Object

org.springframework.ai.qianfan.QianFanChatModel

All Implemented Interfaces:

ChatModel, StreamingChatModel, Model<Prompt,ChatResponse>, StreamingModel<Prompt,ChatResponse>

public class QianFanChatModel
extends Object
implements ChatModel, StreamingChatModel

ChatModel and StreamingChatModel implementation for QianFan backed by QianFanApi.

Since:

1.0

Author:

Geng Rong

See Also:

• ChatModel
• StreamingChatModel
• QianFanApi

Field Summary

Fields

Modifier and Type	Field	Description
final org.springframework.retry.support.RetryTemplate	retryTemplate	The retry template used to retry the QianFan API calls.

Constructor Summary

Constructors

Constructor	Description
QianFanChatModel(QianFanApi qianFanApi)	Creates an instance of the QianFanChatModel.
QianFanChatModel(QianFanApi qianFanApi, QianFanChatOptions options)	Initializes an instance of the QianFanChatModel.
QianFanChatModel(QianFanApi qianFanApi, QianFanChatOptions options, org.springframework.retry.support.RetryTemplate retryTemplate)	Initializes a new instance of the QianFanChatModel.
QianFanChatModel(QianFanApi qianFanApi, QianFanChatOptions options, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Initializes a new instance of the QianFanChatModel.

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
QianFanApi.ChatCompletionRequest	createRequest(Prompt prompt, boolean stream)	Accessible for testing.
ChatOptions	getDefaultOptions()
void	setObservationConvention(ChatModelObservationConvention observationConvention)
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.chat.model.ChatModel

call, call

Methods inherited from interface org.springframework.ai.chat.model.StreamingChatModel

stream, stream

Field Details

retryTemplate

public final org.springframework.retry.support.RetryTemplate retryTemplate

The retry template used to retry the QianFan API calls.

Constructor Details

QianFanChatModel

public QianFanChatModel(QianFanApi qianFanApi)

Creates an instance of the QianFanChatModel.

Parameters:

qianFanApi - The QianFanApi instance to be used for interacting with the QianFan Chat API.

Throws:

IllegalArgumentException - if QianFanApi is null

QianFanChatModel

public QianFanChatModel(QianFanApi qianFanApi,
 QianFanChatOptions options)

Initializes an instance of the QianFanChatModel.

Parameters:

qianFanApi - The QianFanApi instance to be used for interacting with the QianFan Chat API.

options - The QianFanChatOptions to configure the chat client.

QianFanChatModel

public QianFanChatModel(QianFanApi qianFanApi,
 QianFanChatOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Initializes a new instance of the QianFanChatModel.

Parameters:

qianFanApi - The QianFanApi instance to be used for interacting with the QianFan Chat API.

options - The QianFanChatOptions to configure the chat client.

retryTemplate - The retry template.

QianFanChatModel

public QianFanChatModel(QianFanApi qianFanApi,
 QianFanChatOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Initializes a new instance of the QianFanChatModel.

Parameters:

qianFanApi - The QianFanApi instance to be used for interacting with the QianFan Chat API.

options - The QianFanChatOptions to configure the chat client.

retryTemplate - The retry template.

observationRegistry - The ObservationRegistry used for instrumentation.

Method Details

call

public ChatResponse call(Prompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ChatModel

Specified by:

call in interface Model<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the response from the AI model

stream

public reactor.core.publisher.Flux<ChatResponse> stream(Prompt prompt)

Description copied from interface: StreamingModel

Executes a method call to the AI model.

Specified by:

stream in interface ChatModel

Specified by:

stream in interface StreamingChatModel

Specified by:

stream in interface StreamingModel<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the streaming response from the AI model

createRequest

public QianFanApi.ChatCompletionRequest createRequest(Prompt prompt,
 boolean stream)

Accessible for testing.

getDefaultOptions

public ChatOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface ChatModel

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)