Skip to content

Commit

Permalink
doc polish before relase
Browse files Browse the repository at this point in the history
  • Loading branch information
markpollack committed Feb 23, 2024
1 parent d7fb424 commit 64b8e7c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ The Spring AI API covers a wide range of functionalities.
Each major feature is detailed in its own dedicated section.
To provide an overview, the following key functionalities are available:

* Portable API across AI providers for Chat and for Embedding models. Both synchronous and stream API options are supported. Dropping down to access model specific features is also supported.
* Portable API across Vector Store providers, including a novel SQL-like metadata filter API that is also portable.
* Function calling
* Portable API across AI providers for Chat, Text to Image, and Embedding models. Both synchronous and stream API options are supported. Dropping down to access model specific features is also supported. We support AI Models from OpenAI, Microsoft, Amazon, Google, Huggingface and more.
* Portable API across Vector Store providers, including a novel SQL-like metadata filter API that is also portable. Support for 8 vector databases are available.
* Function calling. Spring AI makes it easy to have the AI model invoke your POJO java.util.Function object.
* Spring Boot Auto Configuration and Starters for AI Models and Vector Stores.
* ETL framework for Data Engineering
* ETL framework for Data Engineering. This provides the basis of loading data into a vector database, helping implement the Retrieval Augmented Generation pattern that enables you to bring your data to the AI model to incorporate into its response.


== Feedback and Contributions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ spring boot add ai

NOTE: Spring CLI allows users to define their own https://docs.spring.io/spring-cli/reference/registering-new-projects.html[project catalogs] that define which projects you can create or add to your existing code base.

== Spring Initializr

Head on over to https://start.spring.io/[start.spring.io] and select the AI Models and Vector Stores that you want to use in your new applications.

[[repositories]]
== Add Milestone and Snapshot Repositories

Expand Down Expand Up @@ -94,7 +98,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>0.8.0-SNAPSHOT</version>
<version>0.8.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand All @@ -109,7 +113,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:0.8.0-SNAPSHOT")
implementation platform("org.springframework.ai:spring-ai-bom:0.8.0")
// Replace the following with the starter dependencies of specific modules you wish to use
implementation 'org.springframework.ai:spring-ai-openai'
}
Expand Down

0 comments on commit 64b8e7c

Please sign in to comment.