Skip to content

Commit aa45028

Browse files
jxblummarkpollack
authored andcommitted
Correct grammar in the Image Model API doc
Closes #1454
1 parent ae743f9 commit aa45028

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/imageclient.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ public class ImageMessage {
7373

7474
==== ImageOptions
7575

76-
Represents the options that can be passed to the Image generation model. The `ImageOptions` class extends the `ModelOptions` interface and is used to define few portable options that can be passed to the AI model.
76+
Represents the options that can be passed to the Image generation model. The `ImageOptions` interface extends the `ModelOptions` interface and is used to define few portable options that can be passed to the AI model.
7777

78-
The `ImageOptions` class is defined as follows:
78+
The `ImageOptions` interface is defined as follows:
7979

8080
[source,java]
8181
----
@@ -97,12 +97,12 @@ public interface ImageOptions extends ModelOptions {
9797
Additionally, every model specific ImageModel implementation can have its own options that can be passed to the AI model. For example, the OpenAI Image Generation model has its own options like `quality`, `style`, etc.
9898

9999

100-
This is a powerful feature that allows developers to use model specific options when starting the application and then override them with at runtime using the `ImagePrompt`.
100+
This is a powerful feature that allows developers to use model specific options when starting the application and then override them at runtime using the `ImagePrompt`.
101101

102102

103103
=== ImageResponse
104104

105-
The structure of the `ChatResponse` class is as follows:
105+
The structure of the `ImageResponse` class is as follows:
106106

107107
[source,java]
108108
----
@@ -130,7 +130,7 @@ public class ImageResponse implements ModelResponse<ImageGeneration> {
130130

131131
The https://github.com/spring-projects/spring-ai/blob/main/spring-ai-core/src/main/java/org/springframework/ai/image/ImageResponse.java[ImageResponse] class holds the AI Model's output, with each `ImageGeneration` instance containing one of potentially multiple outputs resulting from a single prompt.
132132

133-
The `ImageResponse` class also carries a `ImageResponseMetadata` metadata about the AI Model's response.
133+
The `ImageResponse` class also carries a `ImageResponseMetadata` object holding metadata about the AI Model's response.
134134

135135
=== ImageGeneration
136136

@@ -160,7 +160,10 @@ public class ImageGeneration implements ModelResult<Image> {
160160
`ImageModel` implementations are provided for the following Model providers:
161161

162162
* xref:api/image/openai-image.adoc[OpenAI Image Generation]
163+
* xref:api/image/azure-openai-image.adoc[Azure OpenAI Image Generation]
164+
* xref:api/image/qianfan-image.adoc[QianFan Image Generation]
163165
* xref:api/image/stabilityai-image.adoc[StabilityAI Image Generation]
166+
* xref:api/image/zhipuai-image.adoc[ZhiPuAI Image Generation]
164167

165168
== API Docs
166169

0 commit comments

Comments
 (0)