diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/images/model-hierarchy.jpg b/spring-ai-docs/src/main/antora/modules/ROOT/images/model-hierarchy.jpg index a82a6186f..238926982 100644 Binary files a/spring-ai-docs/src/main/antora/modules/ROOT/images/model-hierarchy.jpg and b/spring-ai-docs/src/main/antora/modules/ROOT/images/model-hierarchy.jpg differ diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/anthropic-chat.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/anthropic-chat.adoc index c8c04c232..9b22fd63e 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/anthropic-chat.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/anthropic-chat.adoc @@ -31,8 +31,12 @@ To help with dependency management, Spring AI provides a BOM (bill of materials) == Auto-configuration Spring AI provides Spring Boot auto-configuration for the Anthropic Chat Client. -To enable it add the following dependency to your project's Maven `pom.xml` file: +To enable it add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` file: +[tabs] +====== +Maven:: ++ [source, xml] ---- @@ -41,14 +45,15 @@ To enable it add the following dependency to your project's Maven `pom.xml` file ---- -or to your Gradle `build.gradle` build file. - +Gradle:: ++ [source,groovy] ---- dependencies { implementation 'org.springframework.ai:spring-ai-anthropic-spring-boot-starter' } ---- +====== TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add the Spring AI BOM to your build file. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/azure-openai-chat.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/azure-openai-chat.adoc index 1ffabb41d..42d89b07a 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/azure-openai-chat.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/azure-openai-chat.adoc @@ -26,7 +26,6 @@ export SPRING_AI_AZURE_OPENAI_API_KEY= export SPRING_AI_AZURE_OPENAI_ENDPOINT= ---- - === OpenAI Key To authenticate with the OpenAI service (not Azure), provide an OpenAI API key. This will automatically set the endpoint to https://api.openai.com/v1. @@ -85,8 +84,12 @@ To help with dependency management, Spring AI provides a BOM (bill of materials) == Auto-configuration Spring AI provides Spring Boot auto-configuration for the Azure OpenAI Chat Client. -To enable it add the following dependency to your project's Maven `pom.xml` file: +To enable it add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files: +[tabs] +====== +Maven:: ++ [source, xml] ---- @@ -95,14 +98,15 @@ To enable it add the following dependency to your project's Maven `pom.xml` file ---- -or to your Gradle `build.gradle` build file. - +Gradle:: ++ [source,groovy] ---- dependencies { 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 the Spring AI BOM to your build file. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/apache-cassandra.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/apache-cassandra.adoc index 9b0e84d7b..aecdc6cc0 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/apache-cassandra.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/apache-cassandra.adoc @@ -82,6 +82,7 @@ TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Man You can use the following properties in your Spring Boot configuration to customize the Apache Cassandra vector store. +[stripes=even] |=== |Property|Default value 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 a76ddb3b1..3ad4112c2 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 @@ -46,8 +46,10 @@ Add these dependencies to your project: === 1. Select an Embeddings interface implementation. You can choose between: -* OpenAI Embedding: - +[tabs] +====== +OpenAI Embedding:: ++ [source,xml] ---- @@ -56,8 +58,8 @@ Add these dependencies to your project: ---- -* Or Azure AI Embedding: - +Azure AI Embedding:: ++ [source,xml] ---- @@ -66,8 +68,8 @@ Add these dependencies to your project: ---- -* Or Local Sentence Transformers Embedding: - +Local Sentence Transformers Embedding:: ++ [source,xml] ---- @@ -75,6 +77,7 @@ Add these dependencies to your project: spring-ai-transformers-spring-boot-starter ---- +====== === 2. Azure (AI Search) Vector Store @@ -92,6 +95,7 @@ TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Man You can use the following properties in your Spring Boot configuration to customize the Azure vector store. +[stripes=even] |=== |Property|Default value 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 a4fe96584..5c477a2ae 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 @@ -108,6 +108,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the vector store. +[stripes=even] |=== |Property| Description | Default value diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/elasticsearch.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/elasticsearch.adoc index 3fb6f1818..5f2b0cbf7 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/elasticsearch.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/elasticsearch.adoc @@ -16,8 +16,12 @@ A running Elasticsearch instance. The following options are available: == Auto-configuration Spring AI provides Spring Boot auto-configuration for the Elasticsearch Vector Store. -To enable it, add the following dependency to your project's Maven `pom.xml` file: +To enable it, add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files: +[tabs] +====== +Maven:: ++ [source,xml] ---- @@ -26,29 +30,47 @@ To enable it, add the following dependency to your project's Maven `pom.xml` fil ---- -or to your Gradle `build.gradle` build file. - +Gradle:: ++ [source,groovy] ---- dependencies { implementation 'org.springframework.ai:spring-ai-elasticsearch-store-spring-boot-starter' } ---- -NOTE: For spring-boot versions pre 3.3.0 it's necessary to explicitly add the elasticsearch-java dependency with version > 8.13.3, otherwise the older version used will be incompatible with the queries performed: -``` +====== + +[NOTE] +-- +For spring-boot versions pre 3.3.0 it's necessary to explicitly add the elasticsearch-java dependency with version > 8.13.3, otherwise the older version used will be incompatible with the queries performed: +[tabs] +====== +Maven:: ++ +[source,xml] +---- co.elastic.clients elasticsearch-java 8.13.3 -``` +---- + +Gradle:: ++ +[source,groovy] +---- +dependencies { + implementation 'co.elastic.clients:elasticsearch-java:8.13.3' +} +---- +====== +-- TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Management] section to add the Spring AI BOM to your build file. TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file. - - The vector store implementation can initialize the requisite schema for you, but you must opt-in by specifying the `initializeSchema` boolean in the appropriate constructor or by setting `...initialize-schema=true` in the `application.properties` file. Alternatively you can opt-out the initialization and create the index manually using the Elasticsearch client, which can be useful if the index needs advanced mapping or additional configuration. @@ -122,6 +144,7 @@ Spring Boot's auto-configuration feature for the Elasticsearch RestClient will c The Spring Boot properties starting with `spring.elasticsearch.*` are used to configure the Elasticsearch client: +[stripes=even] |=== |Property | Description | Default Value @@ -139,6 +162,7 @@ The Spring Boot properties starting with `spring.elasticsearch.*` are used to co Properties starting with the `spring.ai.vectorstore.elasticsearch.*` prefix are used to configure `ElasticsearchVectorStore`. +[stripes=even] |=== |Property | Description | Default Value diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/gemfire.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/gemfire.adoc index 7006b804f..4a3ba67fa 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/gemfire.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/gemfire.adoc @@ -39,6 +39,7 @@ dependencies { You can use the following properties in your Spring Boot configuration to further configure the `GemFireVectorStore`. +[stripes=even] |=== |Property|Default value diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/milvus.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/milvus.adoc index 9175094a0..939a00aae 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/milvus.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/milvus.adoc @@ -165,7 +165,7 @@ NOTE: These filter expressions are converted into the equivalent Milvus filters. You can use the following properties in your Spring Boot configuration to customize the Milvus vector store. -[cols="4,5,1"] +[cols="4,5,1",stripes=even] |=== |Property| Description | Default value diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/mongodb.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/mongodb.adoc index 359160ad1..b125371a6 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/mongodb.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/mongodb.adoc @@ -123,7 +123,7 @@ spring.ai.vectorstore.mongodb.indexName=vector_index spring.ai.vectorstore.mongodb.metadata-fields-to-filter=foo ---- - +[stripes=even] |=== |Property| Description | Default value 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 873f534d3..51cd2d94f 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 @@ -189,6 +189,7 @@ node.`metadata.author` IN ["john","jill"] AND node.`metadata.'article_type'` = " You can use the following properties in your Spring Boot configuration to customize the Neo4j vector store. +[stripes=even] |=== |Property|Default value diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc index 187e60d95..d7437d89c 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc @@ -116,7 +116,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the OpenSearch vector store. -[cols="2,5,1"] +[cols="2,5,1",stripes=even] |=== |Property| Description | Default value diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/oracle.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/oracle.adoc index 1f78ce7fd..70271ae6e 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/oracle.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/oracle.adoc @@ -99,7 +99,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the `OracleVectorStore`. -[cols="2,5,1"] +[cols="2,5,1",stripes=even] |=== |Property| Description | Default value 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 44d610a61..e5c58458e 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 @@ -133,7 +133,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the PGVector vector store. -[cols="2,5,1"] +[cols="2,5,1",stripes=even] |=== |Property| Description | Default value 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 6c4d1648e..31c493ced 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 @@ -103,6 +103,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the Pinecone vector store. +[stripes=even] |=== |Property| Description | Default value diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc index b18aed4d1..573cc1068 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc @@ -106,7 +106,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the Qdrant vector store. -[cols="3,5,1"] +[cols="3,5,1",stripes=even] |=== |Property| Description | Default value 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 08d6331b8..04d16a93e 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 @@ -103,6 +103,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the Redis vector store. +[stripes=even] |=== |Property| Description | Default value diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/typesense.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/typesense.adoc index 5fdcf3146..f9ac86419 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/typesense.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/typesense.adoc @@ -96,6 +96,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the Typesense vector store. +[stripes=even] |=== |Property| Description | Default value 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 9a163519d..0bfd2e661 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 @@ -110,7 +110,7 @@ List results = vectorStore.similaritySearch(SearchRequest.query("Sprin You can use the following properties in your Spring Boot configuration to customize the weaviate vector store. -[cols="3,5,1"] +[cols="3,5,1",stripes=even] |=== |Property| Description | Default value 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 a97f8faa5..872bfbd5b 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 @@ -18,9 +18,13 @@ If you prefer to add the dependency snippets by hand, follow the directions in t To use the Milestone and Snapshot version, you need to add references to the Spring Milestone and/or Snapshot repositories in your build file. -For Maven, add the following repository definitions as needed: +Add the following repository definitions to your Maven or Gradle build file: -[source,xml] +[tabs] +====== +Maven:: ++ +[source,xml,indent=0,subs="verbatim,quotes"] ---- @@ -42,9 +46,9 @@ For Maven, add the following repository definitions as needed: ---- -For Gradle, add the following repository definitions as needed: - -[source,groovy] +Gradle:: ++ +[source,groovy,indent=0,subs="verbatim,quotes"] ---- repositories { mavenCentral() @@ -52,7 +56,7 @@ repositories { maven { url 'https://repo.spring.io/snapshot' } } ---- - +====== [[dependency-management]] == Dependency Management @@ -62,9 +66,13 @@ Using the BOM from your application’s build script avoids the need for you to Instead, the version of the BOM you’re using determines the utilized dependency versions. It also ensures that you’re using supported and tested versions of the dependencies by default, unless you choose to override them. -If you’re a Maven user, you can use the BOM by adding the following to your pom.xml file - +Add the BOM to your project: -[source,xml] +[tabs] +====== +Maven:: ++ +[source,xml,indent=0,subs="verbatim,quotes"] ---- @@ -79,11 +87,9 @@ If you’re a Maven user, you can use the BOM by adding the following to your po ---- -Gradle users can also use the Spring AI BOM by leveraging Gradle (5.0+) native support for declaring dependency constraints using a Maven BOM. -This is implemented by adding a 'platform' dependency handler method to the dependencies section of your Gradle build script. -As shown in the snippet below this can then be followed by version-less declarations of the Starter Dependencies for the one or more spring-ai modules you wish to use, e.g. spring-ai-openai. - -[source,gradle] +Gradle:: ++ +[source,groovy,indent=0,subs="verbatim,quotes"] ---- dependencies { implementation platform("org.springframework.ai:spring-ai-bom:1.0.0-SNAPSHOT") @@ -91,6 +97,10 @@ dependencies { implementation 'org.springframework.ai:spring-ai-openai' } ---- +Gradle users can also use the Spring AI BOM by leveraging Gradle (5.0+) native support for declaring dependency constraints using a Maven BOM. +This is implemented by adding a 'platform' dependency handler method to the dependencies section of your Gradle build script. +As shown in the snippet below this can then be followed by version-less declarations of the Starter Dependencies for the one or more spring-ai modules you wish to use, e.g. spring-ai-openai. +====== [[add-dependencies]] == Add dependencies for specific components