Skip to content

Fix typos in chat client module #3013

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typos in chat client module #3013

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
6 changes: 3 additions & 3 deletions spring-ai-client-chat/src/main/java/org/springframework/ai/chat/client/ChatClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

/**
* Client to perform stateless requests to an AI Model, using a fluent API.
*
* <p>
* Use {@link ChatClient#builder(ChatModel)} to prepare an instance.
*
* @author Mark Pollack
Expand Down Expand Up @@ -203,8 +203,8 @@ interface StreamPromptResponseSpec {
interface ChatClientRequestSpec {

/**
* Return a {@code ChatClient.Builder} to create a new {@code ChatClient} whose
* settings are replicated from this {@code ChatClientRequest}.
* Return a {@link ChatClient.Builder} to create a new {@link ChatClient} whose
* settings are replicated from this {@link ChatClientRequest}.
*/
Builder mutate();

Expand Down
8 changes: 4 additions & 4 deletions ...ng-ai-client-chat/src/main/java/org/springframework/ai/chat/client/DefaultChatClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ public ChatClientRequestSpec prompt(Prompt prompt) {
}

/**
* Return a {@code ChatClient2Builder} to create a new {@code ChatClient} whose
* settings are replicated from this {@code ChatClientRequest}.
* Return a {@link ChatClient.Builder} to create a new {@link ChatClient} whose
* settings are replicated from this {@link ChatClientRequest}.
*/
@Override
public Builder mutate() {
Expand Down Expand Up @@ -706,8 +706,8 @@ public TemplateRenderer getTemplateRenderer() {
}

/**
* Return a {@code ChatClient2Builder} to create a new {@code ChatClient2} whose
* settings are replicated from this {@code ChatClientRequest}.
* Return a {@link ChatClient.Builder} to create a new {@link ChatClient} whose
* settings are replicated from this {@link ChatClientRequest}.
*/
public Builder mutate() {
DefaultChatClientBuilder builder = (DefaultChatClientBuilder) ChatClient
Expand Down
2 changes: 1 addition & 1 deletion ...lient-chat/src/main/java/org/springframework/ai/chat/client/DefaultChatClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

/**
* DefaultChatClientBuilder is a builder class for creating a ChatClient.
*
* <p>
* It provides methods to set default values for various properties of the ChatClient.
*
* @author Mark Pollack
Expand Down
4 changes: 2 additions & 2 deletions spring-ai-client-chat/src/main/java/org/springframework/ai/chat/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
* AI generative model domain. This package extends the core domain defined in
* org.sf.ai.generative, providing implementations specific to chat-based generative AI
* interactions.
*
* <p>
* In line with Domain-Driven Design principles, this package includes implementations of
* entities and value objects specific to the chat context, such as ChatPrompt and
* ChatResponse, adhering to the ubiquitous language of chat interactions in AI models.
*
* <p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you intend a closing tag?

Copy link
Author

@jamespud jamespud May 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming it should be split. Or should I use <br>?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought the <p> tag needed to be closed, but it seems that's not necessary.
I apologize for the confusion.

* This bounded context is designed to encapsulate all aspects of chat-based AI
* functionalities, maintaining a clear boundary from other contexts within the AI domain.
*/
Expand Down