Package org.springframework.ai.qianfan

Class QianFanImageModel

java.lang.Object

org.springframework.ai.qianfan.QianFanImageModel

All Implemented Interfaces:

ImageModel, Model<ImagePrompt,ImageResponse>

public class QianFanImageModel
extends Object
implements ImageModel

QianFanImageModel is a class that implements the ImageModel interface. It provides a client for calling the QianFan image generation API.

Since:

1.0

Author:

Geng Rong

Constructor Summary

Constructors

Constructor	Description
QianFanImageModel(QianFanImageApi qianFanImageApi)	Creates an instance of the QianFanImageModel.
QianFanImageModel(QianFanImageApi qianFanImageApi, QianFanImageOptions options)	Creates an instance of the QianFanImageModel.
QianFanImageModel(QianFanImageApi qianFanImageApi, QianFanImageOptions options, org.springframework.retry.support.RetryTemplate retryTemplate)	Creates an instance of the QianFanImageModel.
QianFanImageModel(QianFanImageApi qianFanImageApi, QianFanImageOptions options, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Initializes a new instance of the QianFanImageModel.

Method Summary

Modifier and Type	Method	Description
ImageResponse	call(ImagePrompt imagePrompt)	Executes a method call to the AI model.
void	setObservationConvention(ImageModelObservationConvention observationConvention)

Methods inherited from class java.lang.Object

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

Constructor Details

QianFanImageModel

public QianFanImageModel(QianFanImageApi qianFanImageApi)

Creates an instance of the QianFanImageModel.

Parameters:

qianFanImageApi - The QianFanImageApi instance to be used for interacting with the QianFan Image API.

Throws:

IllegalArgumentException - if qianFanImageApi is null

QianFanImageModel

public QianFanImageModel(QianFanImageApi qianFanImageApi,
 QianFanImageOptions options)

Creates an instance of the QianFanImageModel.

Parameters:

qianFanImageApi - The QianFanImageApi instance to be used for interacting with the QianFan Image API.

options - The QianFanImageOptions to configure the image model.

Throws:

IllegalArgumentException - if qianFanImageApi is null

QianFanImageModel

public QianFanImageModel(QianFanImageApi qianFanImageApi,
 QianFanImageOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Creates an instance of the QianFanImageModel.

Parameters:

qianFanImageApi - The QianFanImageApi instance to be used for interacting with the QianFan Image API.

options - The QianFanImageOptions to configure the image model.

retryTemplate - The retry template.

Throws:

IllegalArgumentException - if qianFanImageApi is null

QianFanImageModel

public QianFanImageModel(QianFanImageApi qianFanImageApi,
 QianFanImageOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Initializes a new instance of the QianFanImageModel.

Parameters:

qianFanImageApi - The QianFanImageApi instance to be used for interacting with the QianFan Image API.

options - The QianFanImageOptions to configure the image model.

retryTemplate - The retry template.

observationRegistry - The ObservationRegistry used for instrumentation.

Method Details

call

public ImageResponse call(ImagePrompt imagePrompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ImageModel

Specified by:

call in interface Model<ImagePrompt,ImageResponse>

Parameters:

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

Returns:

the response from the AI model

setObservationConvention

public void setObservationConvention(ImageModelObservationConvention observationConvention)