Skip to content

Correct grammar in the Image Model API doc #1454

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

Correct grammar in the Image Model API doc #1454

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
13 changes: 8 additions & 5 deletions spring-ai-docs/src/main/antora/modules/ROOT/pages/api/imageclient.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ public class ImageMessage {

==== ImageOptions

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.
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.

The `ImageOptions` class is defined as follows:
The `ImageOptions` interface is defined as follows:

[source,java]
----
Expand All @@ -97,12 +97,12 @@ public interface ImageOptions extends ModelOptions {
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.


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`.
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`.


=== ImageResponse

The structure of the `ChatResponse` class is as follows:
The structure of the `ImageResponse` class is as follows:

[source,java]
----
Expand Down Expand Up @@ -130,7 +130,7 @@ public class ImageResponse implements ModelResponse<ImageGeneration> {

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.

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

=== ImageGeneration

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

* xref:api/image/openai-image.adoc[OpenAI Image Generation]
* xref:api/image/azure-openai-image.adoc[Azure OpenAI Image Generation]
* xref:api/image/qianfan-image.adoc[QianFan Image Generation]
* xref:api/image/stabilityai-image.adoc[StabilityAI Image Generation]
* xref:api/image/zhipuai-image.adoc[ZhiPuAI Image Generation]

== API Docs

Expand Down