Skip to content

Commit 41a256c

Browse files
tzolovtzolov
committed
Simplify the doc catalog. Add 0.8.1 update notes
1 parent ea0b439 commit 41a256c

File tree

3 files changed

+77
-35
lines changed

3 files changed

+77
-35
lines changed

‎models/spring-ai-mistral-ai/src/test/java/org/springframework/ai/mistralai/MistralAiTestConfiguration.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@
1717
package org.springframework.ai.mistralai;
1818

1919
import org.springframework.ai.embedding.EmbeddingClient;
20-
import org.springframework.ai.mistralai.MistralAiChatClient;
21-
import org.springframework.ai.mistralai.MistralAiChatOptions;
22-
import org.springframework.ai.mistralai.MistralAiEmbeddingClient;
23-
import org.springframework.ai.mistralai.MistralAiEmbeddingOptions;
2420
import org.springframework.ai.mistralai.api.MistralAiApi;
2521
import org.springframework.boot.SpringBootConfiguration;
2622
import org.springframework.context.annotation.Bean;

‎spring-ai-docs/src/main/antora/modules/ROOT/nav.adoc

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,34 @@
33
* xref:getting-started.adoc[Getting Started]
44
* xref:api/index.adoc[]
55
** xref:api/embeddings.adoc[]
6-
*** xref:api/embeddings/openai-embeddings.adoc[]
7-
*** xref:api/embeddings/ollama-embeddings.adoc[]
8-
*** xref:api/embeddings/azure-openai-embeddings.adoc[]
9-
*** xref:api/embeddings/postgresml-embeddings.adoc[]
10-
*** xref:api/embeddings/vertexai-embeddings.adoc[]
11-
*** xref:api/bedrock.adoc[Amazon Bedrock Embeddings]
12-
**** xref:api/embeddings/bedrock-cohere-embedding.adoc[]
13-
**** xref:api/embeddings/bedrock-titan-embedding.adoc[]
14-
*** xref:api/embeddings/onnx.adoc[]
6+
*** xref:api/embeddings/openai-embeddings.adoc[OpenAI]
7+
*** xref:api/embeddings/ollama-embeddings.adoc[Ollama]
8+
*** xref:api/embeddings/azure-openai-embeddings.adoc[Azure OpenAI]
9+
*** xref:api/embeddings/postgresml-embeddings.adoc[PostgresML]
10+
*** xref:api/embeddings/vertexai-embeddings.adoc[Google VertexAI PaLM2]
11+
*** xref:api/bedrock.adoc[Amazon Bedrock]
12+
**** xref:api/embeddings/bedrock-cohere-embedding.adoc[Cohere]
13+
**** xref:api/embeddings/bedrock-titan-embedding.adoc[Titan]
14+
*** xref:api/embeddings/onnx.adoc[Transformers (ONNX)]
1515
** xref:api/chatclient.adoc[]
16-
*** xref:api/clients/openai-chat.adoc[]
16+
*** xref:api/clients/openai-chat.adoc[OpenAI]
1717
**** xref:api/clients/functions/openai-chat-functions.adoc[Function Calling]
18-
*** xref:api/clients/azure-openai-chat.adoc[]
18+
*** xref:api/clients/ollama-chat.adoc[Ollama]
19+
*** xref:api/clients/azure-openai-chat.adoc[Azure OpenAI]
1920
**** xref:api/clients/functions/azure-open-ai-chat-functions.adoc[Function Calling]
20-
*** xref:api/clients/ollama-chat.adoc[]
21-
*** xref:api/bedrock-chat.adoc[Amazon Bedrock Chat]
22-
**** xref:api/clients/bedrock/bedrock-anthropic.adoc[]
23-
**** xref:api/clients/bedrock/bedrock-llama2.adoc[]
24-
**** xref:api/clients/bedrock/bedrock-cohere.adoc[]
25-
**** xref:api/clients/bedrock/bedrock-titan.adoc[]
26-
*** xref:api/clients/huggingface.adoc[]
21+
*** xref:api/bedrock-chat.adoc[Amazon Bedrock]
22+
**** xref:api/clients/bedrock/bedrock-anthropic.adoc[Anthropic]
23+
**** xref:api/clients/bedrock/bedrock-llama2.adoc[Llama2]
24+
**** xref:api/clients/bedrock/bedrock-cohere.adoc[Cohere]
25+
**** xref:api/clients/bedrock/bedrock-titan.adoc[Titan]
26+
*** xref:api/clients/huggingface.adoc[HuggingFace]
2727
*** xref:api/clients/google-vertexai.adoc[Google VertexAI]
2828
**** xref:api/clients/vertexai-palm2-chat.adoc[VertexAI PaLM2 ]
2929
**** xref:api/clients/vertexai-gemini-chat.adoc[VertexAI Gemini]
3030
***** xref:api/clients/functions/vertexai-gemini-chat-functions.adoc[Function Calling]
31-
** xref:api/functions.adoc[]
3231
** xref:api/imageclient.adoc[]
33-
*** xref:api/clients/image/openai-image.adoc[]
34-
*** xref:api/clients/image/stabilityai-image.adoc[]
35-
** xref:api/prompt.adoc[]
36-
** xref:api/output-parser.adoc[]
32+
*** xref:api/clients/image/openai-image.adoc[OpenAI]
33+
*** xref:api/clients/image/stabilityai-image.adoc[Stability]
3734
** xref:api/vectordbs.adoc[]
3835
*** xref:api/vectordbs/azure.adoc[]
3936
*** xref:api/vectordbs/chroma.adoc[]
@@ -44,6 +41,9 @@
4441
*** xref:api/vectordbs/redis.adoc[]
4542
*** xref:api/vectordbs/pinecone.adoc[]
4643
*** xref:api/vectordbs/qdrant.adoc[]
44+
** xref:api/functions.adoc[Function Calling]
45+
** xref:api/prompt.adoc[]
46+
** xref:api/output-parser.adoc[]
4747
** xref:api/etl-pipeline.adoc[]
4848
** xref:api/testing.adoc[]
4949
** xref:api/generic-model.adoc[]

‎spring-ai-docs/src/main/antora/modules/ROOT/pages/upgrade-notes.adoc

Lines changed: 54 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,60 @@
11
[[upgrade-notes]]
2-
= Upgrading to 0.8.0
2+
= Upgrading Notes
33

4-
== January 24, 2024 Update
4+
== Upgrading to 0.8.1
5+
6+
Former `spring-ai-vertex-ai` has been renamed to `spring-ai-vertex-ai-palm2` and `spring-ai-vertex-ai-spring-boot-starter` has been renamed to `spring-ai-vertex-ai-palm2-spring-boot-starter`.
7+
8+
So, you need to change the dependency from
9+
10+
[source,xml]
11+
----
12+
<dependency>
13+
<groupId>org.springframework.ai</groupId>
14+
<artifactId>spring-ai-vertex-ai</artifactId>
15+
</dependency>
16+
----
17+
18+
To
19+
20+
[source,xml]
21+
----
22+
<dependency>
23+
<groupId>org.springframework.ai</groupId>
24+
<artifactId>spring-ai-vertex-ai-palm2</artifactId>
25+
</dependency>
26+
----
27+
28+
and the related Boot starter for the Palm2 model has changed from
29+
30+
[source,xml]
31+
----
32+
<dependency>
33+
<groupId>org.springframework.ai</groupId>
34+
<artifactId>spring-ai-vertex-ai-spring-boot-starter</artifactId>
35+
</dependency>
36+
----
37+
38+
to
39+
40+
[source,xml]
41+
----
42+
<dependency>
43+
<groupId>org.springframework.ai</groupId>
44+
<artifactId>spring-ai-vertex-ai-palm2-spring-boot-starter</artifactId>
45+
</dependency>
46+
----
47+
48+
== Upgrading to 0.8.0
49+
50+
=== January 24, 2024 Update
551

652
* Moving the `prompt` and `messages` and `metadata` packages to subpackages of `org.sf.ai.chat`
753
* New functionality is *text to image* clients. Classes are `OpenAiImageClient` and `StabilityAiImageClient`. See the integration tests for usage, docs are coming soon.
854
* A new package `model` that contains interfaces and base classes to support creating AI Model Clients for any input/output data type combination. At the moment the chat and image model packages implement this. We will be updating the embedding package to this new model soon.
955
* A new "portable options" design pattern. We wanted to provide as much portability in the `ChatClient` as possible across different chat based AI Models. There is a common set of generation options and then those that are specific to a model provider. A sort of "duck typing" approach is used. `ModelOptions` in the model package is a marker interface indicating implementations of this class will provide the options for a model. See `ImageOptions`, a subinterface that defines portable options across all text->image `ImageClient` implementations. Then `StabilityAiImageOptions` and `OpenAiImageOptions` provide the options specific to each model provider. All options classes are created via a fluent API builder all can be passed into the portable `ImageClient` API. These option data types are using in autoconfiguration/configuration properties for the `ImageClient` implementations.
1056

11-
== January 13, 2024 Update
57+
=== January 13, 2024 Update
1258

1359
The following OpenAi Autoconfiguration chat properties has changed
1460

@@ -17,20 +63,20 @@ The following OpenAi Autoconfiguration chat properties has changed
1763

1864
Find updated documentation about the OpenAi properties: https://docs.spring.io/spring-ai/reference/api/clients/openai.html
1965

20-
== December 27, 2023 Update
66+
=== December 27, 2023 Update
2167

2268
Merge SimplePersistentVectorStore and InMemoryVectorStore into SimpleVectorStore
2369
* Replace InMemoryVectorStore with SimpleVectorStore
2470

25-
== December 20, 2023 Update
71+
=== December 20, 2023 Update
2672

2773
Refactor the Ollama client and related classes and package names
2874

2975
* Replace the org.springframework.ai.ollama.client.OllamaClient by org.springframework.ai.ollama.OllamaChatClient.
3076
* The OllamaChatClient method signatures have changed.
3177
* Rename the org.springframework.ai.autoconfigure.ollama.OllamaProperties into org.springframework.ai.autoconfigure.ollama.OllamaChatProperties and change the suffix to: `spring.ai.ollama.chat`. Some of the properties have changed as well.
3278

33-
== December 19, 2023 Update
79+
=== December 19, 2023 Update
3480

3581
Renaming of AiClient and related classes and package names
3682

@@ -47,7 +93,7 @@ Moved Maven modules from top-level directory and `embedding-clients` subdirector
4793

4894
[WARNING]
4995

50-
== December 1, 2023
96+
=== December 1, 2023
5197

5298
We are transitioning the project's Group ID:
5399

@@ -62,7 +108,7 @@ Please use the 0.7.1-SNAPSHOT if you don't want to be on the bleeding edge.
62108

63109
You can access `0.7.1-SNAPSHOT` artifacts as before and still access https://markpollack.github.io/spring-ai-0.7.1/[0.7.1-SNAPSHOT Documentation].
64110

65-
== 0.7.1-SNAPSHOT Dependencies
111+
=== 0.7.1-SNAPSHOT Dependencies
66112

67113
* Azure OpenAI
68114
+

0 commit comments

Comments
 (0)