Skip to content

Refactor ImageOptions builder method #1959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Refactor ImageOptions builder method #1959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...enai/src/test/java/org/springframework/ai/azure/openai/image/AzureOpenAiImageModelIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public class AzureOpenAiImageModelIT {

@Test
void imageAsUrlTest() {
var options = ImageOptionsBuilder.builder().withHeight(1024).withWidth(1024).build();
var options = ImageOptionsBuilder.builder().height(1024).width(1024).build();

var instructions = """
A light cream colored mini golden doodle with a sign that contains the message "I'm on my way to BARCADE!".""";
Expand Down
2 changes: 1 addition & 1 deletion ...pring-ai-openai/src/test/java/org/springframework/ai/openai/image/OpenAiImageModelIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public class OpenAiImageModelIT extends AbstractIT {

@Test
void imageAsUrlTest() {
var options = ImageOptionsBuilder.builder().withHeight(1024).withWidth(1024).build();
var options = ImageOptionsBuilder.builder().height(1024).width(1024).build();

var instructions = """
A light cream colored mini golden doodle with a sign that contains the message "I'm on my way to BARCADE!".""";
Expand Down
2 changes: 1 addition & 1 deletion ...ng-ai-qianfan/src/test/java/org/springframework/ai/qianfan/image/QianFanImageModelIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public class QianFanImageModelIT {

@Test
void imageTest() {
var options = ImageOptionsBuilder.builder().withHeight(1024).withWidth(1024).build();
var options = ImageOptionsBuilder.builder().height(1024).width(1024).build();

var instructions = """
A light cream colored mini golden doodle with a sign that contains the message "I'm on my way to BARCADE!".""";
Expand Down
2 changes: 1 addition & 1 deletion ...ng-ai-zhipuai/src/test/java/org/springframework/ai/zhipuai/image/ZhiPuAiImageModelIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class ZhiPuAiImageModelIT {

@Test
void imageAsUrlTest() {
var options = ImageOptionsBuilder.builder().withHeight(1024).withWidth(1024).build();
var options = ImageOptionsBuilder.builder().height(1024).width(1024).build();

var instructions = """
A light cream colored mini golden doodle with a sign that contains the message "I'm on my way to BARCADE!".""";
Expand Down
54 changes: 54 additions & 0 deletions spring-ai-core/src/main/java/org/springframework/ai/image/ImageOptionsBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,31 +28,85 @@ public static ImageOptionsBuilder builder() {
return new ImageOptionsBuilder();
}

public ImageOptionsBuilder N(Integer n) {
this.options.setN(n);
return this;
}

public ImageOptionsBuilder model(String model) {
this.options.setModel(model);
return this;
}

public ImageOptionsBuilder responseFormat(String responseFormat) {
this.options.setResponseFormat(responseFormat);
return this;
}

public ImageOptionsBuilder width(Integer width) {
this.options.setWidth(width);
return this;
}

public ImageOptionsBuilder height(Integer height) {
this.options.setHeight(height);
return this;
}

public ImageOptionsBuilder style(String style) {
this.options.setStyle(style);
return this;
}

/**
* @deprecated use {@link #N(Integer)} instead.
*/
@Deprecated(forRemoval = true, since = "1.0.0-M5")
public ImageOptionsBuilder withN(Integer n) {
this.options.setN(n);
return this;
}

/**
* @deprecated use {@link #model(String)} instead.
*/
@Deprecated(forRemoval = true, since = "1.0.0-M5")
public ImageOptionsBuilder withModel(String model) {
this.options.setModel(model);
return this;
}

/**
* @deprecated use {@link #responseFormat(String)} instead.
*/
@Deprecated(forRemoval = true, since = "1.0.0-M5")
public ImageOptionsBuilder withResponseFormat(String responseFormat) {
this.options.setResponseFormat(responseFormat);
return this;
}

/**
* @deprecated use {@link #width(Integer)} instead.
*/
@Deprecated(forRemoval = true, since = "1.0.0-M5")
public ImageOptionsBuilder withWidth(Integer width) {
this.options.setWidth(width);
return this;
}

/**
* @deprecated use {@link #height(Integer)} instead.
*/
@Deprecated(forRemoval = true, since = "1.0.0-M5")
public ImageOptionsBuilder withHeight(Integer height) {
this.options.setHeight(height);
return this;
}

/**
* @deprecated use {@link #style(String)} instead.
*/
@Deprecated(forRemoval = true, since = "1.0.0-M5")
public ImageOptionsBuilder withStyle(String style) {
this.options.setStyle(style);
return this;
Expand Down
18 changes: 9 additions & 9 deletions ...org/springframework/ai/image/observation/DefaultImageModelObservationConventionTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ void contextualNameWhenModelIsDefined() {
ImageModelObservationContext observationContext = ImageModelObservationContext.builder()
.imagePrompt(generateImagePrompt())
.provider("superprovider")
.requestOptions(ImageOptionsBuilder.builder().withModel("mistral").build())
.requestOptions(ImageOptionsBuilder.builder().model("mistral").build())
.build();
assertThat(this.observationConvention.getContextualName(observationContext)).isEqualTo("image mistral");
}
Expand All @@ -66,7 +66,7 @@ void supportsOnlyImageModelObservationContext() {
ImageModelObservationContext observationContext = ImageModelObservationContext.builder()
.imagePrompt(generateImagePrompt())
.provider("superprovider")
.requestOptions(ImageOptionsBuilder.builder().withModel("mistral").build())
.requestOptions(ImageOptionsBuilder.builder().model("mistral").build())
.build();
assertThat(this.observationConvention.supportsContext(observationContext)).isTrue();
assertThat(this.observationConvention.supportsContext(new Observation.Context())).isFalse();
Expand All @@ -77,7 +77,7 @@ void shouldHaveLowCardinalityKeyValuesWhenDefined() {
ImageModelObservationContext observationContext = ImageModelObservationContext.builder()
.imagePrompt(generateImagePrompt())
.provider("superprovider")
.requestOptions(ImageOptionsBuilder.builder().withModel("mistral").build())
.requestOptions(ImageOptionsBuilder.builder().model("mistral").build())
.build();
assertThat(this.observationConvention.getLowCardinalityKeyValues(observationContext)).contains(
KeyValue.of(AiObservationAttributes.AI_OPERATION_TYPE.value(), "image"),
Expand All @@ -91,12 +91,12 @@ void shouldHaveHighCardinalityKeyValuesWhenDefined() {
.imagePrompt(generateImagePrompt())
.provider("superprovider")
.requestOptions(ImageOptionsBuilder.builder()
.withModel("mistral")
.withN(1)
.withHeight(1080)
.withWidth(1920)
.withStyle("sketch")
.withResponseFormat("base64")
.model("mistral")
.N(1)
.height(1080)
.width(1920)
.style("sketch")
.responseFormat("base64")
.build())
.build();

Expand Down
2 changes: 1 addition & 1 deletion ...test/java/org/springframework/ai/image/observation/ImageModelObservationContextTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ void whenMandatoryRequestOptionsThenReturn() {
var observationContext = ImageModelObservationContext.builder()
.imagePrompt(generateImagePrompt())
.provider("superprovider")
.requestOptions(ImageOptionsBuilder.builder().withModel("supersun").build())
.requestOptions(ImageOptionsBuilder.builder().model("supersun").build())
.build();

assertThat(observationContext).isNotNull();
Expand Down
6 changes: 3 additions & 3 deletions ...g/springframework/ai/image/observation/ImageModelPromptContentObservationFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ void whenEmptyPromptThenReturnOriginalContext() {
var expectedContext = ImageModelObservationContext.builder()
.imagePrompt(new ImagePrompt(""))
.provider("superprovider")
.requestOptions(ImageOptionsBuilder.builder().withModel("mistral").build())
.requestOptions(ImageOptionsBuilder.builder().model("mistral").build())
.build();
var actualContext = this.observationFilter.map(expectedContext);

Expand All @@ -63,7 +63,7 @@ void whenPromptWithTextThenAugmentContext() {
var originalContext = ImageModelObservationContext.builder()
.imagePrompt(new ImagePrompt("supercalifragilisticexpialidocious"))
.provider("superprovider")
.requestOptions(ImageOptionsBuilder.builder().withModel("mistral").build())
.requestOptions(ImageOptionsBuilder.builder().model("mistral").build())
.build();
var augmentedContext = this.observationFilter.map(originalContext);

Expand All @@ -77,7 +77,7 @@ void whenPromptWithMessagesThenAugmentContext() {
.imagePrompt(new ImagePrompt(List.of(new ImageMessage("you're a chimney sweep"),
new ImageMessage("supercalifragilisticexpialidocious"))))
.provider("superprovider")
.requestOptions(ImageOptionsBuilder.builder().withModel("mistral").build())
.requestOptions(ImageOptionsBuilder.builder().model("mistral").build())
.build();
var augmentedContext = this.observationFilter.map(originalContext);

Expand Down
Loading