Skip to content

Commit 1cadc49

Browse files
committed
Docs: start tabulating the Maven/Gradle code snippets
1 parent 278a61f commit 1cadc49

File tree

5 files changed

+51
-25
lines changed

5 files changed

+51
-25
lines changed

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

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

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

51+
[tabs]
52+
======
53+
Maven::
54+
+
5155
[source, xml]
5256
----
5357
<dependency>
@@ -56,14 +60,15 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
5660
</dependency>
5761
----
5862
59-
or to your Gradle `build.gradle` build file.
60-
63+
Gradle::
64+
+
6165
[source,groovy]
6266
----
6367
dependencies {
6468
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
6569
}
6670
----
71+
======
6772

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

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,12 @@ Alternatively, you can enable the option to download automatically any needed mo
3333
== Auto-configuration
3434

3535
Spring AI provides Spring Boot auto-configuration for the Ollama chat integration.
36-
To enable it add the following dependency to your project's Maven `pom.xml` file:
36+
To enable it add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files:
3737

38+
[tabs]
39+
======
40+
Maven::
41+
+
3842
[source,xml]
3943
----
4044
<dependency>
@@ -43,14 +47,15 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
4347
</dependency>
4448
----
4549
46-
or to your Gradle `build.gradle` build file.
47-
50+
Gradle::
51+
+
4852
[source,groovy]
4953
----
5054
dependencies {
5155
implementation 'org.springframework.ai:spring-ai-ollama-spring-boot-starter'
5256
}
5357
----
58+
======
5459

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

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

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

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

29+
[tabs]
30+
======
31+
Maven::
32+
+
2933
[source, xml]
3034
----
3135
<dependency>
@@ -34,14 +38,15 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
3438
</dependency>
3539
----
3640
37-
or to your Gradle `build.gradle` build file.
38-
41+
Gradle::
42+
+
3943
[source,groovy]
4044
----
4145
dependencies {
4246
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
4347
}
4448
----
49+
======
4550

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

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,12 @@ gcloud auth application-default login <ACCOUNT>
2323
== Auto-configuration
2424

2525
Spring AI provides Spring Boot auto-configuration for the VertexAI Gemini Chat Client.
26-
To enable it add the following dependency to your project's Maven `pom.xml` file:
26+
To enable it add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files:
2727

28+
[tabs]
29+
======
30+
Maven::
31+
+
2832
[source, xml]
2933
----
3034
<dependency>
@@ -33,14 +37,15 @@ To enable it add the following dependency to your project's Maven `pom.xml` file
3337
</dependency>
3438
----
3539
36-
or to your Gradle `build.gradle` build file.
37-
40+
Gradle::
41+
+
3842
[source,groovy]
3943
----
4044
dependencies {
4145
implementation 'org.springframework.ai:spring-ai-vertex-ai-gemini-spring-boot-starter'
4246
}
4347
----
48+
======
4449

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

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

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,25 @@ These abstractions have multiple implementations, enabling easy component swappi
1616

1717
Spring AI provides the following features:
1818

19-
* Support for all major Model providers such as Anthropic, Azure OpenAI, Amazon Bedrock, Google, HuggingFace, Mistral, Oracle, Stability AI, Watson, Minimax, Moonshot, QianFan, ZhiPu AI, PostgresML, and ONNX Transformers.
20-
* Supported Model types are Chat, Embedding, Text to Image, Audio Transcription, Text to Speech, and Moderation. Multimodal models are also supported.
21-
* Portable API across AI providers for all models. Both synchronous and stream API options are supported. Dropping down to access model specific features is also supported.
22-
* Spring Boot Auto Configuration for all models, simplifying setup and integration.
23-
* AOT (Ahead-Of-Time) native image support for improved performance and reduced startup times.
24-
* Enhanced observability leveraging Spring ecosystem features, providing insights into AI-related operations. Spring AI offers metrics and tracing capabilities for core components including ChatClient, ChatModel, EmbeddingModel, ImageModel, and VectorStore.
25-
* Structured Output to enable mapping of AI Model output to POJOs.
26-
* Function calling support.
27-
* Support for all major Vector Database providers such as Apache Cassandra, Azure Vector Search, Chroma, Milvus, MongoDB Atlas, Neo4j, Oracle, PostgreSQL/PGVector, PineCone, Qdrant, Redis, and Weaviate.
28-
* Portable API across Vector Store providers, including a novel SQL-like metadata filter API that is also portable.
29-
* ETL framework for Data Engineering to load data into Vector Stores.
30-
* Evaluation Testing support for AI applications, allowing assessment of generated content to prevent hallucinated responses. This includes the ability to use AI models for self-evaluation, with the flexibility to choose the most suitable model for evaluation purposes.
31-
* Spring Boot autoconfiguration for establishing connections to model services or vector stores running via Testcontainers or Docker Compose.
19+
* Portable API support across AI providers for Chat, text-to-image, and Embedding models. Both synchronous and streaming API options are supported. Access to model-specific features is also available.
20+
* Support for all major xref:api/index.adoc[AI Model providers] such as Anthropic, OpenAI, Microsoft, Amazon, Google, and Ollama. Supported model types include:
21+
** xref:api/chatmodel.adoc[Chat Completion]
22+
** xref:api/embeddings.adoc[Embedding]
23+
** xref:api/imageclient.adoc[Text to Image]
24+
** xref:api/audio/transcriptions.adoc[Audio Transcription]
25+
** xref:api/audio/speech.adoc[Text to Speech]
26+
** xref:api/moderation[Moderation]
27+
* xref:api/structured-output-converter.adoc[Structured Outputs] - Mapping of AI Model output to POJOs.
28+
* Support for all major xref:api/vectordbs.adoc[Vector Database providers] such as Apache Cassandra, Azure Vector Search, Chroma, Milvus, MongoDB Atlas, Neo4j, Oracle, PostgreSQL/PGVector, PineCone, Qdrant, Redis, and Weaviate.
29+
* Portable API across Vector Store providers, including a novel SQL-like metadata filter API.
30+
* xref:api/functions.adoc[Tools/Function Calling] - permits the model to request the execution of client-side tools and functions, thereby accessing necessary real-time information as required.
31+
* xref:observability/index.adoc[Observability] - Provides insights into AI-related operations.
32+
* Document injection xref:api/etl-pipeline.adoc[ETL framework] for Data Engineering.
33+
* xref:api/testing.adoc[AI Model Evaluation] - Utilities to help evaluate generated content and protect against hallucinated response.
34+
* Spring Boot Auto Configuration and Starters for AI Models and Vector Stores.
35+
* xref:api/chatclient.adoc[ChatClient API] - Fluent API for communicating with AI Chat Models, idiomatically similar to the WebClient and RestClient APIs.
36+
* xref:api/advisors.adoc[Advisors API] - Encapsulates recurring Generative AI patterns, transforms data sent to and from Language Models (LLMs), and provides portability across various models and use cases.
37+
* Support for xref:api/chatclient.adoc#_chat_memory[Chat Conversation Memory] and xref:api/chatclient.adoc#_retrieval_augmented_generation[Retrieval Augmented Generation (RAG)].
3238
3339
This feature set lets you implement common use cases such as "`Q&A over your documentation`" or "`Chat with your documentation.`"
3440

0 commit comments

Comments
 (0)