Skip to content

Commit 082c6f1

Browse files
ThomasVitaletzolov
authored andcommitted
Docs: Fix typos in embedding documents
Signed-off-by: Thomas Vitale <ThomasVitale@users.noreply.github.com>
1 parent e5b2247 commit 082c6f1

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Read more about xref:api/chat/functions/mistralai-chat-functions.adoc[Mistral AI
140140

141141
== Sample Controller (Auto-configuration)
142142

143-
https://start.spring.io/[Create] a new Spring Boot project and add the `spring-ai-mistralai-spring-boot-starter` to your pom (or gradle) dependencies.
143+
https://start.spring.io/[Create] a new Spring Boot project and add the `spring-ai-mistral-ai-spring-boot-starter` to your pom (or gradle) dependencies.
144144

145145
Add a `application.properties` file, under the `src/main/resources` directory, to enable and configure the OpenAi Chat client:
146146

@@ -185,13 +185,13 @@ public class ChatController {
185185

186186
The link:https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-mistral-ai/src/main/java/org/springframework/ai/mistralai/MistralAiChatClient.java[MistralAiChatClient] implements the `ChatClient` and `StreamingChatClient` and uses the <<low-level-api>> to connect to the MistralAI service.
187187

188-
Add the `spring-ai-mistralai` dependency to your project's Maven `pom.xml` file:
188+
Add the `spring-ai-mistral-ai` dependency to your project's Maven `pom.xml` file:
189189

190190
[source, xml]
191191
----
192192
<dependency>
193193
<groupId>org.springframework.ai</groupId>
194-
<artifactId>spring-ai-mistralai</artifactId>
194+
<artifactId>spring-ai-mistral-ai</artifactId>
195195
</dependency>
196196
----
197197

@@ -200,7 +200,7 @@ or to your Gradle `build.gradle` build file.
200200
[source,groovy]
201201
----
202202
dependencies {
203-
implementation 'org.springframework.ai:spring-ai-mistralai'
203+
implementation 'org.springframework.ai:spring-ai-mistral-ai'
204204
}
205205
----
206206

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,12 @@ public class EmbeddingController {
155155
== Manual Configuration
156156

157157
If you are not using Spring Boot, you can manually configure the OpenAI Embedding Client.
158-
For this add the `spring-ai-mistralai` dependency to your project's Maven `pom.xml` file:
158+
For this add the `spring-ai-mistral-ai` dependency to your project's Maven `pom.xml` file:
159159
[source, xml]
160160
----
161161
<dependency>
162162
<groupId>org.springframework.ai</groupId>
163-
<artifactId>spring-ai-mistralai</artifactId>
163+
<artifactId>spring-ai-mistral-ai</artifactId>
164164
</dependency>
165165
----
166166

@@ -169,13 +169,13 @@ or to your Gradle `build.gradle` build file.
169169
[source,groovy]
170170
----
171171
dependencies {
172-
implementation 'org.springframework.ai:spring-ai-mistralai'
172+
implementation 'org.springframework.ai:spring-ai-mistral-ai'
173173
}
174174
----
175175

176176
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add the Spring AI BOM to your build file.
177177

178-
NOTE: The `spring-ai-mistralai` dependency provides access also to the `MistralAiChatClient`.
178+
NOTE: The `spring-ai-mistral-ai` dependency provides access also to the `MistralAiChatClient`.
179179
For more information about the `MistralAiChatClient` refer to the link:../chat/mistralai-chat.html[MistralAI Chat Client] section.
180180

181181
Next, create an `MistralAiEmbeddingClient` instance and use it to compute the similarity between two input texts:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ List<List<Double>> embeddings = embeddingClient.embed(List.of("Hello world", "Wo
8181
8282
----
8383

84-
NOTE: that when created manually, you must call the `afterPropertiesSet()` after setting the properties and before using the client.
84+
NOTE: If you create an instance of `TransformersEmbeddingClient` manually, you must call the `afterPropertiesSet()` method after setting the properties and before using the client.
8585

8686
The first `embed()` call downloads the large ONNX model and caches it on the local file system.
8787
Therefore, the first call might take longer than usual.

0 commit comments

Comments
 (0)