diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/bedrock.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/bedrock.adoc index e293b05e5..a5f04bc00 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/bedrock.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/bedrock.adoc @@ -23,7 +23,6 @@ Then add the Spring Boot Starter dependency to your project's Maven `pom.xml` bu spring-ai-bedrock-ai-spring-boot-starter org.springframework.ai - 0.8.0-SNAPSHOT ---- @@ -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 diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/azure-openai-chat.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/azure-openai-chat.adoc index b1bdd2b75..0fe57a9e9 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/azure-openai-chat.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/azure-openai-chat.adoc @@ -62,7 +62,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-azure-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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 org.springframework.ai spring-ai-azure-openai - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-anthropic.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-anthropic.adoc index 824ece272..6e435ec64 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-anthropic.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-anthropic.adoc @@ -29,7 +29,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's org.springframework.ai spring-ai-bedrock-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-bedrock - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-cohere.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-cohere.adoc index e0227ff53..8699dc98b 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-cohere.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-cohere.adoc @@ -25,7 +25,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's org.springframework.ai spring-ai-bedrock-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-bedrock - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-llama2.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-llama2.adoc index 9c90bc69c..e5bfe44f0 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-llama2.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-llama2.adoc @@ -29,7 +29,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's org.springframework.ai spring-ai-bedrock-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-bedrock - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-titan.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-titan.adoc index 500e9623a..9996d7d9c 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-titan.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/bedrock/bedrock-titan.adoc @@ -26,7 +26,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's org.springframework.ai spring-ai-bedrock-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-bedrock - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/huggingface.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/huggingface.adoc index 3d07d1a28..5dd27bcc9 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/huggingface.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/huggingface.adoc @@ -15,7 +15,6 @@ Add the `spring-ai-huggingface` dependency: org.springframework.ai spring-ai-huggingface - 0.8.0-SNAPSHOT ---- @@ -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. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/openai-image.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/openai-image.adoc index a5b349fbd..1d2a6954a 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/openai-image.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/openai-image.adoc @@ -25,7 +25,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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 diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/stabilityai-image.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/stabilityai-image.adoc index 6b1b82035..cff23b345 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/stabilityai-image.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/image/stabilityai-image.adoc @@ -24,7 +24,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-stability-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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 diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/ollama-chat.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/ollama-chat.adoc index e6febfd16..40fa0266c 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/ollama-chat.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/ollama-chat.adoc @@ -27,7 +27,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-ollama-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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 org.springframework.ai spring-ai-ollama - 0.8.0-SNAPSHOT ---- @@ -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. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/openai-chat.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/openai-chat.adoc index fbf55e4e1..a43cf5971 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/openai-chat.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/openai-chat.adoc @@ -16,7 +16,8 @@ export SPRING_AI_OPENAI_API_KEY= === 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 org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-openai - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/vertexai-chat.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/vertexai-chat.adoc index 52710f72f..716495134 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/vertexai-chat.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/vertexai-chat.adoc @@ -35,7 +35,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-vertex-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-vertex-ai - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/azure-openai-embeddings.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/azure-openai-embeddings.adoc index 1b6c17108..7c7b5eb25 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/azure-openai-embeddings.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/azure-openai-embeddings.adoc @@ -39,7 +39,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-azure-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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 org.springframework.ai spring-ai-azure-openai - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-cohere-embedding.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-cohere-embedding.adoc index f911f4ee1..a1040dfc7 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-cohere-embedding.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-cohere-embedding.adoc @@ -24,7 +24,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's org.springframework.ai spring-ai-bedrock-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-bedrock - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-titan-embedding.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-titan-embedding.adoc index 012db321b..33caf89e8 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-titan-embedding.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/bedrock-titan-embedding.adoc @@ -31,7 +31,6 @@ Add the `spring-ai-bedrock-ai-spring-boot-starter` dependency to your project's org.springframework.ai spring-ai-bedrock-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-bedrock - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/ollama-embeddings.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/ollama-embeddings.adoc index ada56054e..20b2852ce 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/ollama-embeddings.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/ollama-embeddings.adoc @@ -32,7 +32,6 @@ To enable it add the following dependency to your Maven `pom.xml` file: org.springframework.ai spring-ai-ollama-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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 org.springframework.ai spring-ai-ollama - 0.8.0-SNAPSHOT ---- @@ -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. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/onnx.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/onnx.adoc index d19b272d0..aec840b57 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/onnx.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/onnx.adoc @@ -38,10 +38,11 @@ Add the `spring-ai-transformers` project to your maven dependencies: org.springframework.ai spring-ai-transformers - 0.8.0-SNAPSHOT ---- +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 org.springframework.ai spring-ai-transformers-spring-boot-starter - 0.8.0-SNAPSHOT ---- +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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc index 79465b94e..958793925 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc @@ -34,7 +34,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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` org.springframework.ai spring-ai-openai - 0.8.0-SNAPSHOT ---- @@ -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. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/postgresml-embeddings.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/postgresml-embeddings.adoc index ad4534fda..f34efb91b 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/postgresml-embeddings.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/postgresml-embeddings.adoc @@ -26,7 +26,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-postgresml-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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. org.springframework.ai spring-ai-postgresml - 0.8.0-SNAPSHOT ---- @@ -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] diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/vertexai-embeddings.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/vertexai-embeddings.adoc index 398a0bdd0..9489f5306 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/vertexai-embeddings.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/vertexai-embeddings.adoc @@ -35,7 +35,6 @@ To enable it add the following dependency to your project's Maven `pom.xml` file org.springframework.ai spring-ai-vertex-ai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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: org.springframework.ai spring-ai-vertex-ai - 0.8.0-SNAPSHOT ---- @@ -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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure.adoc index 8a489efa4..658002770 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure.adoc @@ -48,7 +48,6 @@ Add these dependencies to your project: org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -59,7 +58,6 @@ Add these dependencies to your project: org.springframework.ai spring-ai-azure-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -70,7 +68,6 @@ Add these dependencies to your project: org.springframework.ai spring-ai-transformers-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -81,10 +78,11 @@ Add these dependencies to your project: org.springframework.ai spring-ai-azure-vector-store - 0.8.0-SNAPSHOT ---- +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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc index 25d6daa2f..d423e5d4f 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc @@ -36,7 +36,6 @@ Add these dependencies to your project: org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -47,10 +46,11 @@ Add these dependencies to your project: org.springframework.ai spring-ai-chroma-store - 0.8.0-SNAPSHOT ---- +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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc index 55f240b85..48e44e244 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc @@ -29,7 +29,6 @@ Add the Neo4j Vector Store dependency to your project: org.springframework.ai spring-ai-neo4j-store - 0.8.0-SNAPSHOT ---- @@ -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 org.springframework.ai spring-ai-neo4j-store-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -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. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pgvector.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pgvector.adoc index fcc880f0c..504f12651 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pgvector.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pgvector.adoc @@ -86,7 +86,6 @@ Add these dependencies to your project: org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -97,10 +96,11 @@ Add these dependencies to your project: org.springframework.ai spring-ai-pgvector-store - 0.8.0-SNAPSHOT ---- +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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc index 6f2ea9786..5ad2dbbf8 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc @@ -63,7 +63,6 @@ Add these dependencies to your project: org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -74,10 +73,11 @@ Add these dependencies to your project: org.springframework.ai spring-ai-pinecone - 0.8.0-SNAPSHOT ---- +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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc index f5c6c341c..efbadca68 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc @@ -40,7 +40,6 @@ Add these dependencies to your project: org.springframework.ai spring-ai-transformers-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -51,10 +50,11 @@ or use OpenAI (Cloud) org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- +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' org.springframework.ai spring-ai-redis - 0.8.0-SNAPSHOT @@ -79,6 +78,8 @@ export SPRING_AI_OPENAI_API_KEY='Your_OpenAI_API_Key' ---- +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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc index 3a8452011..8f9caf899 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc @@ -32,7 +32,6 @@ Add these dependencies to your project: org.springframework.ai spring-ai-transformers-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -43,7 +42,6 @@ or use OpenAI (Cloud) org.springframework.ai spring-ai-openai-spring-boot-starter - 0.8.0-SNAPSHOT ---- @@ -61,10 +59,11 @@ export SPRING_AI_OPENAI_API_KEY='Your_OpenAI_API_Key' org.springframework.ai spring-ai-weaviate-store - 0.8.0-SNAPSHOT ---- +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: diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc index 42d6d7dee..4f34cbcb9 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc @@ -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 org.springframework.ai spring-ai-bom - {project-version} + 0.8.0-SNAPSHOT pom import @@ -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