Simplify the doc catalog. Add 0.8.1 update notes
This commit is contained in:
Christian Tzolov
@@ -17,10 +17,6 @@
|
||||
package org.springframework.ai.mistralai;
|
||||
|
||||
import org.springframework.ai.embedding.EmbeddingClient;
|
||||
import org.springframework.ai.mistralai.MistralAiChatClient;
|
||||
import org.springframework.ai.mistralai.MistralAiChatOptions;
|
||||
import org.springframework.ai.mistralai.MistralAiEmbeddingClient;
|
||||
import org.springframework.ai.mistralai.MistralAiEmbeddingOptions;
|
||||
import org.springframework.ai.mistralai.api.MistralAiApi;
|
||||
import org.springframework.boot.SpringBootConfiguration;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
|
||||
@@ -3,37 +3,34 @@
|
||||
* xref:getting-started.adoc[Getting Started]
|
||||
* xref:api/index.adoc[]
|
||||
** xref:api/embeddings.adoc[]
|
||||
*** xref:api/embeddings/openai-embeddings.adoc[]
|
||||
*** xref:api/embeddings/ollama-embeddings.adoc[]
|
||||
*** xref:api/embeddings/azure-openai-embeddings.adoc[]
|
||||
*** xref:api/embeddings/postgresml-embeddings.adoc[]
|
||||
*** xref:api/embeddings/vertexai-embeddings.adoc[]
|
||||
*** xref:api/bedrock.adoc[Amazon Bedrock Embeddings]
|
||||
**** xref:api/embeddings/bedrock-cohere-embedding.adoc[]
|
||||
**** xref:api/embeddings/bedrock-titan-embedding.adoc[]
|
||||
*** xref:api/embeddings/onnx.adoc[]
|
||||
*** xref:api/embeddings/openai-embeddings.adoc[OpenAI]
|
||||
*** xref:api/embeddings/ollama-embeddings.adoc[Ollama]
|
||||
*** xref:api/embeddings/azure-openai-embeddings.adoc[Azure OpenAI]
|
||||
*** xref:api/embeddings/postgresml-embeddings.adoc[PostgresML]
|
||||
*** xref:api/embeddings/vertexai-embeddings.adoc[Google VertexAI PaLM2]
|
||||
*** xref:api/bedrock.adoc[Amazon Bedrock]
|
||||
**** xref:api/embeddings/bedrock-cohere-embedding.adoc[Cohere]
|
||||
**** xref:api/embeddings/bedrock-titan-embedding.adoc[Titan]
|
||||
*** xref:api/embeddings/onnx.adoc[Transformers (ONNX)]
|
||||
** xref:api/chatclient.adoc[]
|
||||
*** xref:api/clients/openai-chat.adoc[]
|
||||
*** xref:api/clients/openai-chat.adoc[OpenAI]
|
||||
**** xref:api/clients/functions/openai-chat-functions.adoc[Function Calling]
|
||||
*** xref:api/clients/azure-openai-chat.adoc[]
|
||||
*** xref:api/clients/ollama-chat.adoc[Ollama]
|
||||
*** xref:api/clients/azure-openai-chat.adoc[Azure OpenAI]
|
||||
**** xref:api/clients/functions/azure-open-ai-chat-functions.adoc[Function Calling]
|
||||
*** xref:api/clients/ollama-chat.adoc[]
|
||||
*** xref:api/bedrock-chat.adoc[Amazon Bedrock Chat]
|
||||
**** xref:api/clients/bedrock/bedrock-anthropic.adoc[]
|
||||
**** xref:api/clients/bedrock/bedrock-llama2.adoc[]
|
||||
**** xref:api/clients/bedrock/bedrock-cohere.adoc[]
|
||||
**** xref:api/clients/bedrock/bedrock-titan.adoc[]
|
||||
*** xref:api/clients/huggingface.adoc[]
|
||||
*** xref:api/bedrock-chat.adoc[Amazon Bedrock]
|
||||
**** xref:api/clients/bedrock/bedrock-anthropic.adoc[Anthropic]
|
||||
**** xref:api/clients/bedrock/bedrock-llama2.adoc[Llama2]
|
||||
**** xref:api/clients/bedrock/bedrock-cohere.adoc[Cohere]
|
||||
**** xref:api/clients/bedrock/bedrock-titan.adoc[Titan]
|
||||
*** xref:api/clients/huggingface.adoc[HuggingFace]
|
||||
*** xref:api/clients/google-vertexai.adoc[Google VertexAI]
|
||||
**** xref:api/clients/vertexai-palm2-chat.adoc[VertexAI PaLM2 ]
|
||||
**** xref:api/clients/vertexai-gemini-chat.adoc[VertexAI Gemini]
|
||||
***** xref:api/clients/functions/vertexai-gemini-chat-functions.adoc[Function Calling]
|
||||
** xref:api/functions.adoc[]
|
||||
** xref:api/imageclient.adoc[]
|
||||
*** xref:api/clients/image/openai-image.adoc[]
|
||||
*** xref:api/clients/image/stabilityai-image.adoc[]
|
||||
** xref:api/prompt.adoc[]
|
||||
** xref:api/output-parser.adoc[]
|
||||
*** xref:api/clients/image/openai-image.adoc[OpenAI]
|
||||
*** xref:api/clients/image/stabilityai-image.adoc[Stability]
|
||||
** xref:api/vectordbs.adoc[]
|
||||
*** xref:api/vectordbs/azure.adoc[]
|
||||
*** xref:api/vectordbs/chroma.adoc[]
|
||||
@@ -44,6 +41,9 @@
|
||||
*** xref:api/vectordbs/redis.adoc[]
|
||||
*** xref:api/vectordbs/pinecone.adoc[]
|
||||
*** xref:api/vectordbs/qdrant.adoc[]
|
||||
** xref:api/functions.adoc[Function Calling]
|
||||
** xref:api/prompt.adoc[]
|
||||
** xref:api/output-parser.adoc[]
|
||||
** xref:api/etl-pipeline.adoc[]
|
||||
** xref:api/testing.adoc[]
|
||||
** xref:api/generic-model.adoc[]
|
||||
|
||||
@@ -1,14 +1,60 @@
|
||||
[[upgrade-notes]]
|
||||
= Upgrading to 0.8.0
|
||||
= Upgrading Notes
|
||||
|
||||
== January 24, 2024 Update
|
||||
== Upgrading to 0.8.1
|
||||
|
||||
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`.
|
||||
|
||||
So, you need to change the dependency from
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<dependency>
|
||||
<groupId>org.springframework.ai</groupId>
|
||||
<artifactId>spring-ai-vertex-ai</artifactId>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
To
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<dependency>
|
||||
<groupId>org.springframework.ai</groupId>
|
||||
<artifactId>spring-ai-vertex-ai-palm2</artifactId>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
and the related Boot starter for the Palm2 model has changed from
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<dependency>
|
||||
<groupId>org.springframework.ai</groupId>
|
||||
<artifactId>spring-ai-vertex-ai-spring-boot-starter</artifactId>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
to
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<dependency>
|
||||
<groupId>org.springframework.ai</groupId>
|
||||
<artifactId>spring-ai-vertex-ai-palm2-spring-boot-starter</artifactId>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
== Upgrading to 0.8.0
|
||||
|
||||
=== January 24, 2024 Update
|
||||
|
||||
* Moving the `prompt` and `messages` and `metadata` packages to subpackages of `org.sf.ai.chat`
|
||||
* New functionality is *text to image* clients. Classes are `OpenAiImageClient` and `StabilityAiImageClient`. See the integration tests for usage, docs are coming soon.
|
||||
* 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.
|
||||
* 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.
|
||||
|
||||
== January 13, 2024 Update
|
||||
=== January 13, 2024 Update
|
||||
|
||||
The following OpenAi Autoconfiguration chat properties has changed
|
||||
|
||||
@@ -17,12 +63,12 @@ The following OpenAi Autoconfiguration chat properties has changed
|
||||
|
||||
Find updated documentation about the OpenAi properties: https://docs.spring.io/spring-ai/reference/api/clients/openai.html
|
||||
|
||||
== December 27, 2023 Update
|
||||
=== December 27, 2023 Update
|
||||
|
||||
Merge SimplePersistentVectorStore and InMemoryVectorStore into SimpleVectorStore
|
||||
* Replace InMemoryVectorStore with SimpleVectorStore
|
||||
|
||||
== December 20, 2023 Update
|
||||
=== December 20, 2023 Update
|
||||
|
||||
Refactor the Ollama client and related classes and package names
|
||||
|
||||
@@ -30,7 +76,7 @@ Refactor the Ollama client and related classes and package names
|
||||
* The OllamaChatClient method signatures have changed.
|
||||
* 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.
|
||||
|
||||
== December 19, 2023 Update
|
||||
=== December 19, 2023 Update
|
||||
|
||||
Renaming of AiClient and related classes and package names
|
||||
|
||||
@@ -47,7 +93,7 @@ Moved Maven modules from top-level directory and `embedding-clients` subdirector
|
||||
|
||||
[WARNING]
|
||||
|
||||
== December 1, 2023
|
||||
=== December 1, 2023
|
||||
|
||||
We are transitioning the project's Group ID:
|
||||
|
||||
@@ -62,7 +108,7 @@ Please use the 0.7.1-SNAPSHOT if you don't want to be on the bleeding edge.
|
||||
|
||||
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].
|
||||
|
||||
== 0.7.1-SNAPSHOT Dependencies
|
||||
=== 0.7.1-SNAPSHOT Dependencies
|
||||
|
||||
* Azure OpenAI
|
||||
+
|
||||
|
||||
Reference in New Issue
Block a user