Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove the explict spring-ai depenency versions from doc's snippets

Browse Source
This commit is contained in:
Christian Tzolov
2024-02-23 15:43:42 +01:00
parent 56c6abfc9c
commit 4ba6adfe8e
28 changed files with 108 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -23,7 +23,6 @@ Then add the Spring Boot Starter dependency to your project's Maven `pom.xml` bu
<dependency>
<artifactId>spring-ai-bedrock-ai-spring-boot-starter</artifactId>
<groupId>org.springframework.ai</groupId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -32,10 +31,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Connect to AWS Bedrock

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

@@ -62,7 +62,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -71,11 +70,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Chat Properties
@@ -189,7 +188,6 @@ To enable it, add the `spring-ai-azure-openai` dependency to your project's Mave
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-openai</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -198,10 +196,12 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-azure-openai:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-azure-openai'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
TIP: The `spring-ai-azure-openai` dependency also provide the access to the `AzureOpenAiChatClient`. For more information about the `AzureOpenAiChatClient` refer to the link:../clients/azure-openai-chat.html[Azure OpenAI Chat] section.
Next, create an `AzureOpenAiChatClient` instance and use it to generate text responses:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-anthropic.adoc
View File

@@ -29,7 +29,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -38,10 +37,12 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Enable Anthropic Chat
By default the Anthropic model is disabled.
@@ -168,7 +169,6 @@ Add the `spring-ai-bedrock` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -177,11 +177,11 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create an https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/anthropic/BedrockAnthropicChatClient.java[BedrockAnthropicChatClient] and use it for text generations:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-cohere.adoc
View File

@@ -25,7 +25,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -34,10 +33,12 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Enable Cohere Chat Support
By default the Cohere model is disabled.
@@ -166,7 +167,6 @@ Add the `spring-ai-bedrock` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -175,11 +175,11 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create an https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/cohere/BedrockCohereChatClient.java[BedrockCohereChatClient] and use it for text generations:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-llama2.adoc
View File

@@ -29,7 +29,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -38,10 +37,12 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Enable Llama2 Chat Support
By default the Bedrock Llama2 model is disabled.
@@ -164,7 +165,6 @@ Add the `spring-ai-bedrock` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -173,11 +173,11 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create an https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/llama2/BedrockLlama2ChatClient.java[BedrockLlama2ChatClient] and use it for text generations:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-titan.adoc
View File

@@ -26,7 +26,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -35,10 +34,12 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Enable Titan Chat
By default the Titan model is disabled.
@@ -162,7 +163,6 @@ Add the `spring-ai-bedrock` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -171,11 +171,11 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create an https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/titan/BedrockTitanChatClient.java[BedrockTitanChatClient] and use it for text generations:

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/huggingface.adoc
View File

@@ -15,7 +15,6 @@ Add the `spring-ai-huggingface` dependency:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-huggingface</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -26,6 +25,8 @@ You should get your HuggingFace API key and set it as an environment variable
export HUGGINGFACE_API_KEY=your_api_key_here
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Note, there is not yet a Spring Boot Starter for this client implementation.
Obtain the endpoint URL of the Inference Endpoint.

6
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/openai-image.adoc
View File

@@ -25,7 +25,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -34,12 +33,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Image Generation Properties

5
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/stabilityai-image.adoc
View File

@@ -24,7 +24,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-stability-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -33,11 +32,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-stability-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-stability-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Image Generation Properties

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/ollama-chat.adoc
View File

@@ -27,7 +27,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-ollama-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -36,11 +35,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-ollama-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-ollama-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Chat Properties
@@ -181,7 +180,6 @@ To use it add the `spring-ai-ollama` dependency to your project's Maven `pom.xml
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-ollama</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -190,10 +188,12 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-ollama:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-ollama'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
TIP: The `spring-ai-ollama` dependency provides access also to the `OllamaEmbeddingClient`.
For more information about the `OllamaEmbeddingClient` refer to the link:../embeddings/ollama-embeddings.html[Ollama Embedding Client] section.

13
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/openai-chat.adoc
View File

@@ -16,7 +16,8 @@ export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
=== Add Repositories and BOM
Spring AI artifacts are published in Spring Milestone and Snapshot repositories. Refer to the xref:getting-started.adoc#repositories[Repositories] section to add these repositories to your build system.
Spring AI artifacts are published in Spring Milestone and Snapshot repositories.
Refer to the xref:getting-started.adoc#repositories[Repositories] section to add these repositories to your build system.
To help with dependency management, Spring AI provides a BOM (bill of materials) to ensure that a consistent version of Spring AI is used throughout the entire project. Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add the Spring AI BOM to your build system.
@@ -32,7 +33,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -41,11 +41,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency_management[Dependency Management] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Chat Properties
@@ -172,7 +172,6 @@ Add the `spring-ai-openai` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -181,11 +180,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-openai:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-openai'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create a `OpenAiChatClient` and use it for text generations:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/vertexai-chat.adoc
View File

@@ -35,7 +35,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-vertex-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -44,11 +43,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-vertex-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-vertex-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Chat Properties
@@ -153,7 +152,6 @@ Add the `spring-ai-vertex-ai` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-vertex-ai</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -162,11 +160,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-vertex-ai:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-vertex-ai'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create a `VertexAiChatClient` and use it for text generations:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/azure-openai-embeddings.adoc
View File

@@ -39,7 +39,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -48,10 +47,12 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Embedding Properties
The prefix `spring.ai.azure.openai` is the property prefix to configure the connection to Azure OpenAI.
@@ -139,7 +140,6 @@ For this add the `spring-ai-azure-openai` dependency to your project's Maven `po
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-openai</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -148,10 +148,12 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-azure-openai:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-azure-openai'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
NOTE: The `spring-ai-azure-openai` dependency also provide the access to the `AzureOpenAiEmbeddingClient`. For more information about the `AzureOpenAiChatClient` refer to the link:../embeddings/azure-openai-embeddings.html[Azure OpenAI Embeddings] section.
Next, create an `AzureOpenAiEmbeddingClient` instance and use it to compute the similarity between two input texts:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-cohere-embedding.adoc
View File

@@ -24,7 +24,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -33,11 +32,11 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Enable Cohere Embedding Support
@@ -150,7 +149,6 @@ Add the `spring-ai-bedrock` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -159,11 +157,11 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create an https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/cohere/BedrockCohereEmbeddingClient.java[BedrockCohereEmbeddingClient] and use it for text embeddings:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-titan-embedding.adoc
View File

@@ -31,7 +31,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -40,11 +39,11 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Enable Titan Embedding Support
@@ -134,7 +133,6 @@ Add the `spring-ai-bedrock` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -143,11 +141,11 @@ or to your Gradle `build.gradle` build file.
[source,gradle]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-bedrock'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create an https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/titan/BedrockTitanEmbeddingClient.java[BedrockTitanEmbeddingClient] and use it for text embeddings:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/ollama-embeddings.adoc
View File

@@ -32,7 +32,6 @@ To enable it add the following dependency to your Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-ollama-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -41,11 +40,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-ollama-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-ollama-spring-boot-starter'
}
----
NOTE: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
The `spring.ai.ollama.embedding.options.*` properties are used to configure the default options used for all embedding requests.
(It is used as `OllamaEmbeddingClient#withDefaultOptions()` instance).
@@ -162,7 +161,6 @@ For this add the spring-ai-ollama dependency to your project’s Maven pom.xml f
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-ollama</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -171,10 +169,12 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-ollama:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-ollama'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
NOTE: The `spring-ai-ollama` dependency provides access also to the `OllamaChatClient`.
For more information about the `OllamaChatClient` refer to the link:../clients/ollama-chat.html[Ollama Chat Client] section.

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

@@ -38,10 +38,11 @@ Add the `spring-ai-transformers` project to your maven dependencies:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-transformers</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
then create a new `TransformersEmbeddingClient` instance and use the `setTokenizerResource(tokenizerJsonUri)` and `setModelResource(modelOnnxUri)` methods to set the URIs of the exported `tokenizer.json` and `model.onnx` files. (`classpath:`, `file:` or `https:` URI schemas are supported).
If the model is not explicitly set, `TransformersEmbeddingClient` defaults to https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2[sentence-transformers/all-MiniLM-L6-v2]:
@@ -107,10 +108,11 @@ You can bootstrap and autowire the `TransformersEmbeddingClient` with the follow
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-transformers-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
To configure it, use the `spring.ai.embedding.transformer.*` properties.
For example, add this to your _application.properties_ file to configure the client with the https://huggingface.co/intfloat/e5-small-v2[intfloat/e5-small-v2] text embedding model:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc
View File

@@ -34,7 +34,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -43,11 +42,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
----
NOTE: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Embedding Properties
@@ -141,7 +140,6 @@ For this add the `spring-ai-openai` dependency to your project's Maven `pom.xml`
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -150,10 +148,12 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-openai:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-openai'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
NOTE: The `spring-ai-openai` dependency provides access also to the `OpenAiChatClient`.
For more information about the `OpenAiChatClient` refer to the link:../clients/openai-chat.html[OpenAI Chat Client] section.

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/postgresml-embeddings.adoc
View File

@@ -26,7 +26,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-postgresml-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -35,11 +34,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-postgresml-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-postgresml-spring-boot-starter'
}
----
NOTE: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Use the `spring.ai.postgresml.embedding.options.*` properties to configure your `PostgresMlEmbeddingClient`. links
@@ -125,7 +124,6 @@ For this add the `spring-ai-postgresml` dependency to your project's Maven `pom.
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-postgresml</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -134,10 +132,12 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-postgresml:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-postgresml'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create an `PostgresMlEmbeddingClient` instance and use it to compute the similarity between two input texts:
[source,java]

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/vertexai-embeddings.adoc
View File

@@ -35,7 +35,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-vertex-ai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -44,11 +43,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-vertex-ai-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-vertex-ai-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
=== Chat Properties
@@ -120,7 +119,6 @@ Add the `spring-ai-vertex-ai` dependency to your project's Maven `pom.xml` file:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-vertex-ai</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -129,11 +127,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-vertex-ai:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-vertex-ai'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Next, create a `VertexAiEmbeddingClient` and use it for text generations:

6
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure.adoc
View File

@@ -48,7 +48,6 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -59,7 +58,6 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -70,7 +68,6 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-transformers-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -81,10 +78,11 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-vector-store</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
== Sample Code
To configure an Azure `SearchIndexClient` in your application, you can use the following code:

4
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc
View File

@@ -36,7 +36,6 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -47,10 +46,11 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-chroma-store</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
== Sample Code
Create a `RestTemplate` instance with proper ChromaDB authorization configurations and Use it to create a `ChromaApi` instance:

10
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc
View File

@@ -29,7 +29,6 @@ Add the Neo4j Vector Store dependency to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-neo4j-store</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -38,11 +37,11 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-neo4j-store:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-neo4j-store'
}
----
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
== Configuration
@@ -88,7 +87,6 @@ To enable it, add the following dependency to your project's Maven `pom.xml` fil
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-neo4j-store-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -97,10 +95,12 @@ or to your Gradle `build.gradle` build file.
[source,groovy]
----
dependencies {
implementation 'org.springframework.ai:spring-ai-neo4j-store-spring-boot-starter:0.8.0-SNAPSHOT'
implementation 'org.springframework.ai:spring-ai-neo4j-store-spring-boot-starter'
}
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
Please have a look at the list of xref:#_neo4jvectorstore_properties[configuration parameters] for the vector store to learn about the default values and configuration options.
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.

4
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pgvector.adoc
View File

@@ -86,7 +86,6 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -97,10 +96,11 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-pgvector-store</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
== Sample Code
To configure `PgVectorStore` in your application, you can use the following setup:

4
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc
View File

@@ -63,7 +63,6 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -74,10 +73,11 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-pinecone</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
== Sample Code
To configure Pinecone in your application, you can use the following setup:

7
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc
View File

@@ -40,7 +40,6 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-transformers-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -51,10 +50,11 @@ or use OpenAI (Cloud)
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
You'll need to provide your OpenAI API Key. Set it as an environment variable like so:
[source,bash]
@@ -69,7 +69,6 @@ export SPRING_AI_OPENAI_API_KEY='Your_OpenAI_API_Key'
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-redis</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
<dependency>
@@ -79,6 +78,8 @@ export SPRING_AI_OPENAI_API_KEY='Your_OpenAI_API_Key'
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
== Usage
Create a RedisVectorStore instance connected to your Redis database:

5
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc
View File

@@ -32,7 +32,6 @@ Add these dependencies to your project:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-transformers-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -43,7 +42,6 @@ or use OpenAI (Cloud)
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
@@ -61,10 +59,11 @@ export SPRING_AI_OPENAI_API_KEY='Your_OpenAI_API_Key'
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-weaviate-store</artifactId>
<version>0.8.0-SNAPSHOT</version>
</dependency>
----
TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add to add the Spring AI BOM to your build file.
== Usage
Create a WeaviateVectorStore instance connected to the local Weaviate cluster:

8
spring-ai-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc
View File

@@ -37,7 +37,7 @@ NOTE: Spring CLI allows users to define their own https://docs.spring.io/spring-
[[repositories]]
== Add Milestone and Snapshot Repositories
If you prefer to add the dependency snippets by hand, follow the directions in the following secitons.
If you prefer to add the dependency snippets by hand, follow the directions in the following sections.
To use the Milestone and Snapshot version, you need to add references to the Spring Milestone and/or Snapshot repositories in your build file.
@@ -94,7 +94,7 @@ If you’re a Maven user, you can use the BOM by adding the following to your po
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bom</artifactId>
<version>{project-version}</version>
<version>0.8.0-SNAPSHOT</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -109,7 +109,7 @@ As shown in the snippet below this can then be followed by version-less declarat
[source,gradle]
----
dependencies {
implementation platform("org.springframework.ai:spring-ai-bom:${springAiVersion}")
implementation platform("org.springframework.ai:spring-ai-bom:0.8.0-SNAPSHOT")
// Replace the following with the starter dependencies of specific modules you wish to use
implementation 'org.springframework.ai:spring-ai-openai'
}
@@ -118,7 +118,7 @@ dependencies {
[[add-dependencies]]
== Add dependencies for specific components
Each of the following sections in the documentation shows which dependnecies you need to add to your project build system.
Each of the following sections in the documentation shows which dependencies you need to add to your project build system.
=== Embeddings Models