Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add comments in OpenAiImageModel

Browse Source 
* Add comments in OpenAiImageModel like OpenAiChatModel
This commit is contained in:
devholic22
2024-05-23 15:24:27 +09:00
committed by Mark Pollack
parent c26d5f624c
commit d6c1b033ad
1 changed files with 31 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiImageModel.java
View File

@@ -42,36 +42,55 @@ import org.springframework.util.Assert;
*
* @author Mark Pollack
* @author Christian Tzolov
* @author Hyunjoon Choi
* @since 0.8.0
*/
public class OpenAiImageModel implements ImageModel {
private final static Logger logger = LoggerFactory.getLogger(OpenAiImageModel.class);
/**
* The default options used for the image completion requests.
*/
private OpenAiImageOptions defaultOptions;
/**
* The retry template used to retry the OpenAI Image API calls.
*/
private final RetryTemplate retryTemplate;
/**
* Low-level access to the OpenAI Image API.
*/
private final OpenAiImageApi openAiImageApi;
public final RetryTemplate retryTemplate;
/**
* Creates an instance of the OpenAiImageModel.
* @param openAiImageApi The OpenAiImageApi instance to be used for interacting with the OpenAI
* Image API.
* @throws IllegalArgumentException if openAiImageApi is null
*/
public OpenAiImageModel(OpenAiImageApi openAiImageApi) {
this(openAiImageApi, OpenAiImageOptions.builder().build(), RetryUtils.DEFAULT_RETRY_TEMPLATE);
}
public OpenAiImageModel(OpenAiImageApi openAiImageApi, OpenAiImageOptions defaultOptions,
/**
* Initializes a new instance of the OpenAiImageModel.
* @param openAiImageApi The OpenAiImageApi instance to be used for interacting with the OpenAI
* Image API.
* @param options The OpenAiImageOptions to configure the image model.
* @param retryTemplate The retry template.
*/
public OpenAiImageModel(OpenAiImageApi openAiImageApi, OpenAiImageOptions options,
RetryTemplate retryTemplate) {
Assert.notNull(openAiImageApi, "OpenAiImageApi must not be null");
Assert.notNull(defaultOptions, "defaultOptions must not be null");
Assert.notNull(options, "options must not be null");
Assert.notNull(retryTemplate, "retryTemplate must not be null");
this.openAiImageApi = openAiImageApi;
this.defaultOptions = defaultOptions;
this.defaultOptions = options;
this.retryTemplate = retryTemplate;
}
public OpenAiImageOptions getDefaultOptions() {
return this.defaultOptions;
}
@Override
public ImageResponse call(ImagePrompt imagePrompt) {
return this.retryTemplate.execute(ctx -> {
@@ -158,4 +177,7 @@ public class OpenAiImageModel implements ImageModel {
return openAiImageOptionsBuilder.build();
}
public OpenAiImageOptions getDefaultOptions() {
return this.defaultOptions;
}
}