Commit Graph

554 Commits

Author SHA1 Message Date
Sujin Kim
94dc1a6d42 docs : correct typo from "opean" to "open" in azure-openai-chat.adoc 2024-10-22 12:42:46 +02:00
Sujin Kim
24bb85879d docs : correct typo from "can some" and "can can" in azure-open-ai-chat-function.adoc 2024-10-22 12:42:46 +02:00
Sujin Kim
2d7b00a3fb docs : correct typo "1st" and "supporetd" in anthropic-chat-function 2024-10-22 12:42:46 +02:00
Sujin Kim
91ee20d9cf docs : correct typo from "what it" to "what is" in bedrock-cohere.adoc 2024-10-22 12:42:46 +02:00
Ricken Bazolo
87d055aff2 fix azure openai doc 2024-10-22 12:42:11 +02:00
Ricken Bazolo
27000c4098 fix azure openai doc 2024-10-22 12:42:11 +02:00
Ricken Bazolo
e433d599a1 Fixed broken link to test class in mistralai doc 2024-10-22 12:42:11 +02:00
Benoit Moussaud
57754e8e5d Update azure.adoc fixing type 2024-10-22 12:40:08 +02:00
dafriz
e83bddfb37 docs: fix link to moonshot-chat.adoc 2024-10-22 12:33:19 +02:00
Thomas Vitale
d5bc9c998c Consolidate Ollama auto-pull logic
Consolidate the Ollama auto-pull logic at startup time, supporting the auto-pull for the default models specified via configuration properties and for optional models specified for initialization.

Signed-off-by: Thomas Vitale <ThomasVitale@users.noreply.github.com>
2024-10-21 23:19:11 +02:00
Christian Tzolov
1cadc49a9b Docs: start tabulating the Maven/Gradle code snippets 2024-10-21 15:02:19 +02:00
Christian Tzolov
278a61fde4 Fix doc ref links 2024-10-21 10:24:28 +02:00
Christian Tzolov
6006bd7abe Docs: start adding tabs for Maven/Gradle sections 2024-10-21 08:58:58 +02:00
Christian Tzolov
1252216f3a Revert antora-component-version-maven-plugin 2024-10-20 13:39:05 +02:00
Christian Tzolov
261f18cc01 Update Spring AI docs build and content
- Upgrade Antora Maven plugin to 1.0.0-alpha.4 (replace
  Replace the io.spring.maven.antora:antora-maven-plugin:0.0.4)
- Update playbook configuration for Antora 3.2.0-alpha.6
- Refine documentation layout and styling
- Enhance observability documentation with formatted tables
- Adjust Spring AI logo size and update integration diagram
2024-10-20 12:30:55 +02:00
Thomas Vitale
5e8cecd8b1 Enhance Ollama model auto-pull feature
* Fix configuration inheritance issue when default value is not specified.
* Make it possible to enable the auto-pull feature only for specific model types (e.g. for chat models only).
* Add the possibility to list explicit models to auto-pull at startup time.

Update Ollama model defaults and add new embedding model

* Change default chat model to Mistral
* Change default embedding model to mxbai-embed-large
* Add MXBAI_EMBED_LARGE to OllamaModel enum
* Remove DEFAULT_MODEL constant from OllamaOptions
* Update relevant classes to use new defaults

Signed-off-by: Thomas Vitale <ThomasVitale@users.noreply.github.com>
Co-authored-by:Christian Tzolov <ctzolov@vmware.com>
2024-10-20 08:20:16 +02:00
Christian Tzolov
a09972a29a Dock: improve chat-model documentation 2024-10-19 09:25:23 +02:00
Thomas Vitale
8eef6e6da5 Ollama: Pull models automatically at startup
* Introduce support for Ollama model auto-pull at startup time
* Enhance support for Ollama model auto-pull at run time
* Update documentation about integrating with Ollama and managing models
* Adopt Builder pattern in Ollama Model classes for better code readability
* Unify Ollama model auto-pull functionality in production and test code
* Improve integration tests for Ollama with Testcontainers
2024-10-18 15:42:28 +02:00
Christian Tzolov
5dfdd8ddcd Doc: improve table formating 2024-10-17 21:45:07 +02:00
Christian Tzolov
d1bac75952 Docs: Add Chat Model comparision page 2024-10-17 21:15:12 +02:00
Christian Tzolov
e970c26269 Update antora version and extensions 2024-10-17 13:59:07 +02:00
Christian Tzolov
322d0fb336 Refactor Ollama implementation and improve documentation
- Enhance OllamaModelPuller with configurable retry timeout
 - Update test cases to use LLAMA3_1 instead of LLAMA3_2
 - Improve Ollama documentation with clearer prerequisites and model pulling instructions
 - Update Spring AI introduction page with new logo and diagram
 - Remove unnecessary main method from OllamaModelPuller
2024-10-17 12:54:47 +02:00
Christian Tzolov
272e541c18 Docs: chat model diagram updates 2024-10-17 10:45:05 +02:00
Christian Tzolov
2a9f9c811d Ollama: add model auto-pull feature
- Introduce internal OllamaModelPuller helper for managing model availability
 - Add pullMissingModel option to OllamaOptions
 - Implement auto-pull functionality in OllamaChatModel and OllamaEmbeddingModel
 - Update tests to cover new auto-pull feature
 - Add reference documentation

 Resolves #526
2024-10-17 00:14:59 +02:00
Christian Tzolov
a69f6bb57b update doc diagram 2024-10-16 17:50:07 +02:00
Christian Tzolov
2e045e2607 Minor doc diagram improvements 2024-10-16 16:12:43 +02:00
Christian Tzolov
f004ee7d35 Update index.adoc
minor abbreviation correction
2024-10-15 08:43:59 +02:00
CodingLuizy
a39aadc327 Fix typo in ChatClient docs
- correct response key from "generation" to "completion" in example code

The example response in the documentation incorrectly uses "generation" as the response key. This commit updates it to "completion" to accurately reflect the API's actual response format.
2024-10-14 15:46:58 -04:00
Christian Tzolov
8750ba0806 Enhance top-level tool/function calling doc
- Add detailed explanation of function calling mechanism
 - Examples use only the portable, ChatClient API
 - Include quick start guide with code examples
 - Describe multiple ways to register custom functions as beans
 - Explain how to enable functions by bean name
 - Add section on registering functions dynamically
 - Introduce new Tool Context feature for passing additional data
 - Improve overall structure and readability of the document
2024-10-14 15:43:21 -04:00
Christian Tzolov
d523ffb854 Restructure documentation navigation
- Only the catalog is updated. No existing links are changed
 - Move 'AI Concepts' under 'Overview'
 - Reorganize API sections for better hierarchy
 - Move 'Vector Databases' into its own top-level section
 - Reposition 'Function Calling', 'Multimodality', 'Testing', and 'Structured Output' as top-level items
 - Remove redundant nesting in some sections
 - Comment out 'Generic Model' section
 - Rename AI Model API into AI Models
 - Get rid of the API suffix
 - Improve Multimodality doc
 - Update feature listing
2024-10-14 15:38:18 -04:00
Lukas ʕ•́ᴥ•̀ʔ
cf99e77a2c Fix spelling mistake in Azure OpenAI Chat docs 2024-10-14 15:03:39 -04:00
Craig Walls
83923f25d8 Doc fix, reword Tip text to be more appropriate to Gemini 2024-10-14 15:01:53 -04:00
Christian Tzolov
fe09b4ddce Bring antora packages up to date 2024-10-12 16:51:10 +02:00
Christian Tzolov
4c61e47621 Upgrade antora to v0.4.16 2024-10-12 14:31:17 +02:00
Mark Pollack
4c83fe8302 Guard against NPE in ZhiPu embedding model
- Update retry test to pass - needs investigation
2024-10-08 23:37:00 +02:00
Mark Pollack
4a892b5269 Release version 1.0.0-M3 2024-10-08 23:18:50 +02:00
Mark Pollack
cddb00a5f9 Minor doc improvements to observability 2024-10-08 14:46:25 +02:00
Christian Tzolov
13709f9542 Add builder pattern and order parameter to advisors
- Introduce builder pattern for MessageChatMemoryAdvisor, PromptChatMemoryAdvisor,
   QuestionAnswerAdvisor, SafeGuardAdvisor, and VectorStoreChatMemoryAdvisor.
 - Add 'order' parameter to control advisor execution priority
 - Modify constructors to include the new 'order' parameter
 - Update AbstractChatMemoryAdvisor to support the new 'order' parameter
 - Update docs
2024-10-08 13:30:58 +02:00
Mark Pollack
e712f6cc77 Udpate Spring AI Built-in Advisors documentation 2024-10-08 12:39:04 +02:00
Mark Pollack
d96d0b53f6 Add docs for FactCheckingEvaluator 2024-10-08 12:21:52 +02:00
努力的小雨
82a69dc3a3 Update milvus.adoc
error description
2024-10-08 10:56:59 +02:00
John Blum
3738c38b66 Cleanup grammar in documentation
* Fixes grammar in (Ollama) Function Calling.
* Fixes grammar in ETL Pipeline.
* Fixes grammar in Vector Databases.

Closes #1494
2024-10-08 10:56:29 +02:00
Christian Tzolov
38082de0f8 Refactor FunctionCallback API to use ToolContext instead of Map<String, Object>
- Replaced `Map<String, Object>` with `ToolContext` in the `FunctionCallback`, `AbstractFunctionCallback`, and related classes.
 - Updated all BiFunction definitions to use `ToolContext` as the second parameter,
   enhancing the clarity and structure of the tool context management.
 - Modified `FunctionCallbackWrapper` and `FunctionCallbackContext` to adapt to the new `ToolContext` parameter.
 - Adjusted the handling of tool context in the documentation and test classes.
 - Updated relevant test cases to reflect the API changes and modified the function handling logic to ensure consistency.
2024-10-07 16:15:55 +02:00
Mark Pollack
662afdf46e Update asciidoc table in Azure OpenAI properties documentation
- Add description for spring.ai.azure.openai.custom-headers property

Fixes #1434.
2024-10-07 14:32:37 +02:00
Bruno Oliveira
78073c64ea Update bedrock-cohere-embedding.adoc to fix an incorrect description 2024-10-07 11:52:36 +02:00
Thomas Vitale
6e62ff7d83 Add Cloud Bindings for Mistral AI
* Introduce Cloud Bindings support to configure the Mistral AI integration
* Update the Cloud Bindings documentation accordingly
2024-10-07 10:04:51 +02:00
ktm
2babb2a878 Add JSON Pointer support to JsonReader
This enhancement allows users to specify a JSON Pointer to extract
specific parts of a JSON document when reading. Key changes include:

- New get(String pointer) method in JsonReader class
- Updated JsonReaderTests with pointer-based extraction tests
- Added documentation for JSON Pointer usage in etl-pipeline.adoc

This feature enables more flexible parsing of complex JSON structures,
allowing users to easily target nested data for extraction.
2024-10-06 23:10:24 +02:00
John Blum
aa4502896d Correct grammar in the Image Model API doc
Closes #1454
2024-10-06 22:50:58 +02:00
Christian Tzolov
8bea302b11 Add missing observation and merics names to the docs 2024-10-06 22:01:50 +02:00
Thomas Vitale
60e36c3b55 Update Observability documentation
* Update attributes
* Add more information on optional attributes and risks
* Include documentation for events.

Signed-off-by: Thomas Vitale <ThomasVitale@users.noreply.github.com>
2024-10-06 19:19:58 +02:00