Skip to content

Commit ce00204

Browse files
ilayaperumalgmarkpollack
authored andcommitted
Update docs references for the Spring AI model starters
- Update the documentation references to replace the artifact ID name change for the model starters Signed-off-by: Ilayaperumal Gopinathan <ilayaperumal.gopinathan@broadcom.com>
1 parent 83ff013 commit ce00204

File tree

63 files changed

+168
-168
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+168
-168
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@ One way to run integration tests on part of the code is to first do a quick comp
101101
```shell
102102
./mvnw clean install -DskipTests -Dmaven.javadoc.skip=true
103103
```
104-
Then run the integration test for a specifi module using the `-pl` option
104+
Then run the integration test for a specific module using the `-pl` option
105105
```shell
106-
./mvnw verify -Pintegration-tests -pl spring-ai-spring-boot-autoconfigure
106+
./mvnw verify -Pintegration-tests -pl spring-ai-spring-boot-testcontainers
107107
```
108108

109109
### Documentation

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/audio/speech/openai-speech.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
2222
----
2323
<dependency>
2424
<groupId>org.springframework.ai</groupId>
25-
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
25+
<artifactId>spring-ai-starter-model-openai</artifactId>
2626
</dependency>
2727
----
2828

@@ -31,7 +31,7 @@ or to your Gradle `build.gradle` build file:
3131
[source,groovy]
3232
----
3333
dependencies {
34-
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
34+
implementation 'org.springframework.ai:spring-ai-starter-model-openai'
3535
}
3636
----
3737

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/audio/transcriptions/azure-openai-transcriptions.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To enable it, add the following dependency to your project's Maven `pom.xml` fil
1818
----
1919
<dependency>
2020
<groupId>org.springframework.ai</groupId>
21-
<artifactId>spring-ai-azure-openai-spring-boot-starter</artifactId>
21+
<artifactId>spring-ai-starter-model-azure-openai</artifactId>
2222
</dependency>
2323
----
2424

@@ -27,7 +27,7 @@ or to your Gradle `build.gradle` build file.
2727
[source,groovy]
2828
----
2929
dependencies {
30-
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
30+
implementation 'org.springframework.ai:spring-ai-starter-model-azure-openai'
3131
}
3232
----
3333

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/audio/transcriptions/openai-transcriptions.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
2020
----
2121
<dependency>
2222
<groupId>org.springframework.ai</groupId>
23-
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
23+
<artifactId>spring-ai-starter-model-openai</artifactId>
2424
</dependency>
2525
----
2626

@@ -29,7 +29,7 @@ or to your Gradle `build.gradle` build file.
2929
[source,groovy]
3030
----
3131
dependencies {
32-
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
32+
implementation 'org.springframework.ai:spring-ai-starter-model-openai'
3333
}
3434
----
3535

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Then add the Spring Boot Starter dependency to your project's Maven `pom.xml` bu
3737
[source,xml]
3838
----
3939
<dependency>
40-
<artifactId>spring-ai-bedrock-ai-spring-boot-starter</artifactId>
40+
<artifactId>spring-ai-starter-model-bedrock</artifactId>
4141
<groupId>org.springframework.ai</groupId>
4242
</dependency>
4343
----
@@ -47,7 +47,7 @@ or to your Gradle `build.gradle` build file.
4747
[source,groovy]
4848
----
4949
dependencies {
50-
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
50+
implementation 'org.springframework.ai:spring-ai-starter-model-bedrock'
5151
}
5252
----
5353

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Maven::
4141
----
4242
<dependency>
4343
<groupId>org.springframework.ai</groupId>
44-
<artifactId>spring-ai-anthropic-spring-boot-starter</artifactId>
44+
<artifactId>spring-ai-starter-model-anthropic</artifactId>
4545
</dependency>
4646
----
4747
@@ -50,7 +50,7 @@ Gradle::
5050
[source,groovy]
5151
----
5252
dependencies {
53-
implementation 'org.springframework.ai:spring-ai-anthropic-spring-boot-starter'
53+
implementation 'org.springframework.ai:spring-ai-starter-model-anthropic'
5454
}
5555
----
5656
======
@@ -203,7 +203,7 @@ var response = this.chatModel.call(new Prompt(List.of(userMessage)));
203203

204204
== Sample Controller
205205

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

208208
Add a `application.properties` file, under the `src/main/resources` directory, to enable and configure the Anthropic chat model:
209209

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Maven::
9595
----
9696
<dependency>
9797
<groupId>org.springframework.ai</groupId>
98-
<artifactId>spring-ai-azure-openai-spring-boot-starter</artifactId>
98+
<artifactId>spring-ai-starter-model-azure-openai</artifactId>
9999
</dependency>
100100
----
101101
@@ -104,14 +104,14 @@ Gradle::
104104
[source,groovy]
105105
----
106106
dependencies {
107-
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
107+
implementation 'spring-ai-starter-model-azure-openai'
108108
}
109109
----
110110
======
111111

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

114-
The Azure OpenAI Chat Client is created using the link:https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/OpenAIClientBuilder.java[OpenAIClientBuilder] provided by the Azure SDK. Spring AI allows to customize the builder by providing link:https://github.com/spring-projects/spring-ai/blob/main/spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/azure/openai/AzureOpenAIClientBuilderCustomizer.java[AzureOpenAIClientBuilderCustomizer] beans.
114+
The Azure OpenAI Chat Client is created using the link:https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/OpenAIClientBuilder.java[OpenAIClientBuilder] provided by the Azure SDK. Spring AI allows to customize the builder by providing link:https://github.com/spring-projects/spring-ai/blob/main/auto-configurations/models/spring-ai-autoconfigure-model-azure-openai/src/main/java/org/springframework/ai/model/azure/openai/autoconfigure/AzureOpenAIClientBuilderCustomizer.java[AzureOpenAIClientBuilderCustomizer] beans.
115115

116116
A customizer might be used for example to change the default response timeout:
117117

@@ -262,7 +262,7 @@ String response = ChatClient.create(chatModel).prompt()
262262

263263
== Sample Controller
264264

265-
https://start.spring.io/[Create] a new Spring Boot project and add the `spring-ai-azure-openai-spring-boot-starter` to your pom (or gradle) dependencies.
265+
https://start.spring.io/[Create] a new Spring Boot project and add the `spring-ai-starter-model-azure-openai` to your pom (or gradle) dependencies.
266266

267267
Add a `application.properties` file, under the `src/main/resources` directory, to enable and configure the OpenAi chat model:
268268

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Refer to https://docs.aws.amazon.com/bedrock/latest/userguide/getting-started.ht
3232

3333
== Auto-configuration
3434

35-
Add the `spring-ai-bedrock-converse-spring-boot-starter` dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files:
35+
Add the `spring-ai-starter-model-bedrock-converse` dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files:
3636

3737
[tabs]
3838
======
@@ -42,7 +42,7 @@ Maven::
4242
----
4343
<dependency>
4444
<groupId>org.springframework.ai</groupId>
45-
<artifactId>spring-ai-bedrock-converse-spring-boot-starter</artifactId>
45+
<artifactId>spring-ai-starter-model-bedrock-converse</artifactId>
4646
</dependency>
4747
----
4848
@@ -51,7 +51,7 @@ Gradle::
5151
[source,gradle]
5252
----
5353
dependencies {
54-
implementation 'org.springframework.ai:spring-ai-bedrock-converse-spring-boot-starter'
54+
implementation 'org.springframework.ai:spring-ai-starter-model-bedrock-converse'
5555
}
5656
----
5757
======
@@ -274,7 +274,7 @@ along with the text message "You are a very professional document summarization
274274

275275
== Sample Controller
276276

277-
Create a new Spring Boot project and add the `spring-ai-bedrock-converse-spring-boot-starter` to your dependencies.
277+
Create a new Spring Boot project and add the `spring-ai-starter-model-bedrock-converse` to your dependencies.
278278

279279
Add an `application.properties` file under `src/main/resources`:
280280

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Maven::
5252
----
5353
<dependency>
5454
<groupId>org.springframework.ai</groupId>
55-
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
55+
<artifactId>spring-ai-starter-model-openai</artifactId>
5656
</dependency>
5757
----
5858
@@ -61,7 +61,7 @@ Gradle::
6161
[source,groovy]
6262
----
6363
dependencies {
64-
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
64+
implementation 'org.springframework.ai:spring-ai-starter-model-openai'
6565
}
6666
----
6767
======
@@ -163,7 +163,7 @@ NOTE: Currently, the DeepSeek API doesn't support media content.
163163

164164
== Sample Controller
165165

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

168168
Add a `application.properties` file, under the `src/main/resources` directory, to enable and configure the OpenAi chat model:
169169

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public record Request(String location, Unit unit) {}
114114

115115
It is a best practice to annotate the request object with information such that the generated JSON schema of that function is as descriptive as possible to help the AI model pick the correct function to invoke.
116116

117-
The link:https://github.com/spring-projects/spring-ai/blob/main/spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/anthropic/tool/FunctionCallWithFunctionBeanIT.java[FunctionCallWithFunctionBeanIT.java] demonstrates this approach.
117+
The link:https://github.com/spring-projects/spring-ai/blob/main/auto-configurations/models/spring-ai-autoconfigure-model-anthropic/src/test/java/org/springframework/ai/model/anthropic/autoconfigure/tool/FunctionCallWithFunctionBeanIT.java[FunctionCallWithFunctionBeanIT.java] demonstrates this approach.
118118

119119

120120
==== FunctionCallback
@@ -191,4 +191,4 @@ NOTE: The in-prompt registered functions are enabled by default for the duration
191191

192192
This approach allows to dynamically chose different functions to be called based on the user input.
193193

194-
The https://github.com/spring-projects/spring-ai/blob/main/spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/anthropic/tool/FunctionCallWithPromptFunctionIT.java[FunctionCallWithPromptFunctionIT.java] integration test provides a complete example of how to register a function with the `AnthropicChatModel` and use it in a prompt request.
194+
The https://github.com/spring-projects/spring-ai/blob/main/auto-configurations/models/spring-ai-autoconfigure-model-anthropic/src/test/java/org/springframework/ai/model/anthropic/autoconfigure/tool/FunctionCallWithPromptFunctionIT.java[FunctionCallWithPromptFunctionIT.java] integration test provides a complete example of how to register a function with the `AnthropicChatModel` and use it in a prompt request.

0 commit comments

Comments
 (0)