Skip to content

Commit 6006bd7

Browse files
committed
Docs: start adding tabs for Maven/Gradle sections
1 parent 9c390ff commit 6006bd7

20 files changed

+95
-41
lines changed
305 KB
Loading

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,12 @@ To help with dependency management, Spring AI provides a BOM (bill of materials)
3131
== Auto-configuration
3232

3333
Spring AI provides Spring Boot auto-configuration for the Anthropic Chat Client.
34-
To enable it add the following dependency to your project's Maven `pom.xml` file:
34+
To enable it add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` file:
3535

36+
[tabs]
37+
======
38+
Maven::
39+
+
3640
[source, xml]
3741
----
3842
<dependency>
@@ -41,14 +45,15 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
4145
</dependency>
4246
----
4347
44-
or to your Gradle `build.gradle` build file.
45-
48+
Gradle::
49+
+
4650
[source,groovy]
4751
----
4852
dependencies {
4953
implementation 'org.springframework.ai:spring-ai-anthropic-spring-boot-starter'
5054
}
5155
----
56+
======
5257

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

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ export SPRING_AI_AZURE_OPENAI_API_KEY=<INSERT AZURE KEY HERE>
2626
export SPRING_AI_AZURE_OPENAI_ENDPOINT=<INSERT ENDPOINT URL HERE>
2727
----
2828

29-
3029
=== OpenAI Key
3130

3231
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)
8584
== Auto-configuration
8685

8786
Spring AI provides Spring Boot auto-configuration for the Azure OpenAI Chat Client.
88-
To enable it add the following dependency to your project's Maven `pom.xml` file:
87+
To enable it add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files:
8988

89+
[tabs]
90+
======
91+
Maven::
92+
+
9093
[source, xml]
9194
----
9295
<dependency>
@@ -95,14 +98,15 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
9598
</dependency>
9699
----
97100
98-
or to your Gradle `build.gradle` build file.
99-
101+
Gradle::
102+
+
100103
[source,groovy]
101104
----
102105
dependencies {
103106
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
104107
}
105108
----
109+
======
106110

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

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/apache-cassandra.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Man
8282

8383
You can use the following properties in your Spring Boot configuration to customize the Apache Cassandra vector store.
8484

85+
[stripes=even]
8586
|===
8687
|Property|Default value
8788

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ Add these dependencies to your project:
4646

4747
=== 1. Select an Embeddings interface implementation. You can choose between:
4848

49-
* OpenAI Embedding:
50-
49+
[tabs]
50+
======
51+
OpenAI Embedding::
52+
+
5153
[source,xml]
5254
----
5355
<dependency>
@@ -56,8 +58,8 @@ Add these dependencies to your project:
5658
</dependency>
5759
----
5860
59-
* Or Azure AI Embedding:
60-
61+
Azure AI Embedding::
62+
+
6163
[source,xml]
6264
----
6365
<dependency>
@@ -66,15 +68,16 @@ Add these dependencies to your project:
6668
</dependency>
6769
----
6870
69-
* Or Local Sentence Transformers Embedding:
70-
71+
Local Sentence Transformers Embedding::
72+
+
7173
[source,xml]
7274
----
7375
<dependency>
7476
<groupId>org.springframework.ai</groupId>
7577
<artifactId>spring-ai-transformers-spring-boot-starter</artifactId>
7678
</dependency>
7779
----
80+
======
7881

7982
=== 2. Azure (AI Search) Vector Store
8083

@@ -92,6 +95,7 @@ TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Man
9295

9396
You can use the following properties in your Spring Boot configuration to customize the Azure vector store.
9497

98+
[stripes=even]
9599
|===
96100
|Property|Default value
97101

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ List<Document> results = vectorStore.similaritySearch(SearchRequest.query("Sprin
108108

109109
You can use the following properties in your Spring Boot configuration to customize the vector store.
110110

111+
[stripes=even]
111112
|===
112113
|Property| Description | Default value
113114

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

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,12 @@ A running Elasticsearch instance. The following options are available:
1616
== Auto-configuration
1717

1818
Spring AI provides Spring Boot auto-configuration for the Elasticsearch Vector Store.
19-
To enable it, add the following dependency to your project's Maven `pom.xml` file:
19+
To enable it, add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files:
2020

21+
[tabs]
22+
======
23+
Maven::
24+
+
2125
[source,xml]
2226
----
2327
<dependency>
@@ -26,29 +30,47 @@ To enable it, add the following dependency to your project's Maven `pom.xml` fil
2630
</dependency>
2731
----
2832
29-
or to your Gradle `build.gradle` build file.
30-
33+
Gradle::
34+
+
3135
[source,groovy]
3236
----
3337
dependencies {
3438
implementation 'org.springframework.ai:spring-ai-elasticsearch-store-spring-boot-starter'
3539
}
3640
----
37-
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:
38-
```
41+
======
42+
43+
[NOTE]
44+
--
45+
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:
46+
[tabs]
47+
======
48+
Maven::
49+
+
50+
[source,xml]
51+
----
3952
<dependency>
4053
<groupId>co.elastic.clients</groupId>
4154
<artifactId>elasticsearch-java</artifactId>
4255
<version>8.13.3</version>
4356
</dependency>
44-
```
57+
----
58+
59+
Gradle::
60+
+
61+
[source,groovy]
62+
----
63+
dependencies {
64+
implementation 'co.elastic.clients:elasticsearch-java:8.13.3'
65+
}
66+
----
67+
======
68+
--
4569

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

4872
TIP: Refer to the xref:getting-started.adoc#repositories[Repositories] section to add Milestone and/or Snapshot Repositories to your build file.
4973

50-
51-
5274
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.
5375
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.
5476

@@ -122,6 +144,7 @@ Spring Boot's auto-configuration feature for the Elasticsearch RestClient will c
122144

123145
The Spring Boot properties starting with `spring.elasticsearch.*` are used to configure the Elasticsearch client:
124146

147+
[stripes=even]
125148
|===
126149
|Property | Description | Default Value
127150

@@ -139,6 +162,7 @@ The Spring Boot properties starting with `spring.elasticsearch.*` are used to co
139162

140163
Properties starting with the `spring.ai.vectorstore.elasticsearch.*` prefix are used to configure `ElasticsearchVectorStore`.
141164

165+
[stripes=even]
142166
|===
143167
|Property | Description | Default Value
144168

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ dependencies {
3939

4040
You can use the following properties in your Spring Boot configuration to further configure the `GemFireVectorStore`.
4141

42+
[stripes=even]
4243
|===
4344
|Property|Default value
4445

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ NOTE: These filter expressions are converted into the equivalent Milvus filters.
165165

166166
You can use the following properties in your Spring Boot configuration to customize the Milvus vector store.
167167

168-
[cols="4,5,1"]
168+
[cols="4,5,1",stripes=even]
169169
|===
170170
|Property| Description | Default value
171171

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ spring.ai.vectorstore.mongodb.indexName=vector_index
123123
spring.ai.vectorstore.mongodb.metadata-fields-to-filter=foo
124124
----
125125

126-
126+
[stripes=even]
127127
|===
128128
|Property| Description | Default value
129129

0 commit comments

Comments
 (0)