Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
221 changes: 114 additions & 107 deletions spring-ai-docs/src/main/antora/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,117 +1,124 @@
* xref:index.adoc[Overview]
** xref:concepts.adoc[AI Concepts]
* xref:getting-started.adoc[Getting Started]
* xref:api/chatclient.adoc[]
** xref:api/advisors.adoc[Advisors]
* xref:api/index.adoc[AI Models]
** xref:api/chatmodel.adoc[Chat Models]
*** xref:api/chat/comparison.adoc[Chat Models Comparison]
*** xref:api/chat/bedrock-converse.adoc[Amazon Bedrock Converse]
*** xref:api/chat/anthropic-chat.adoc[Anthropic 3]
**** xref:api/chat/functions/anthropic-chat-functions.adoc[Anthropic Function Calling (Deprecated)]
*** xref:api/chat/azure-openai-chat.adoc[Azure OpenAI]
**** xref:api/chat/functions/azure-open-ai-chat-functions.adoc[Azure OpenAI Function Calling]
*** xref:api/chat/deepseek-chat.adoc[DeepSeek]
*** xref:api/chat/dmr-chat.adoc[Docker Model Runner]
*** xref:api/chat/google-vertexai.adoc[Google VertexAI]
**** xref:api/chat/vertexai-gemini-chat.adoc[VertexAI Gemini]
*** xref:api/chat/groq-chat.adoc[Groq]
*** xref:api/chat/huggingface.adoc[Hugging Face]
*** xref:api/chat/mistralai-chat.adoc[Mistral AI]
**** xref:api/chat/functions/mistralai-chat-functions.adoc[Mistral Function Calling (Deprecated)]
*** xref:api/chat/minimax-chat.adoc[MiniMax]
**** xref:api/chat/functions/minimax-chat-functions.adoc[MinmaxFunction Calling]
*** xref:api/chat/moonshot-chat.adoc[Moonshot AI]
//// **** xref:api/chat/functions/moonshot-chat-functions.adoc[Moonshot Function Calling]
*** xref:api/chat/nvidia-chat.adoc[NVIDIA]
*** xref:api/chat/ollama-chat.adoc[Ollama]
**** xref:api/chat/functions/ollama-chat-functions.adoc[Ollama Function Calling (Deprecated)]
*** xref:api/chat/perplexity-chat.adoc[Perplexity AI]
*** OCI Generative AI
**** xref:api/chat/oci-genai/cohere-chat.adoc[Cohere]
*** xref:api/chat/openai-chat.adoc[OpenAI]
**** xref:api/chat/functions/openai-chat-functions.adoc[OpenAI Function Calling (Deprecated)]
*** xref:api/chat/qianfan-chat.adoc[QianFan]
*** xref:api/chat/zhipuai-chat.adoc[ZhiPu AI]
** xref:api/embeddings.adoc[Embedding Models]
*** 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/azure-openai-embeddings.adoc[Azure OpenAI]
*** xref:api/embeddings/mistralai-embeddings.adoc[Mistral AI]
*** xref:api/embeddings/minimax-embeddings.adoc[MiniMax]
*** xref:api/embeddings/oci-genai-embeddings.adoc[OCI GenAI]
*** xref:api/embeddings/ollama-embeddings.adoc[Ollama]
*** xref:api/embeddings/onnx.adoc[(ONNX) Transformers]
*** xref:api/embeddings/openai-embeddings.adoc[OpenAI]
*** xref:api/embeddings/postgresml-embeddings.adoc[PostgresML]
*** xref:api/embeddings/qianfan-embeddings.adoc[QianFan]
*** VertexAI
**** xref:api/embeddings/vertexai-embeddings-text.adoc[Text Embedding]
**** xref:api/embeddings/vertexai-embeddings-multimodal.adoc[Multimodal Embedding]
*** xref:api/embeddings/zhipuai-embeddings.adoc[ZhiPu AI]
** xref:api/imageclient.adoc[Image Models]
*** xref:api/image/azure-openai-image.adoc[Azure OpenAI]
*** xref:api/image/openai-image.adoc[OpenAI]
*** xref:api/image/stabilityai-image.adoc[Stability]
*** xref:api/image/zhipuai-image.adoc[ZhiPuAI]
*** xref:api/image/qianfan-image.adoc[QianFan]
** xref:api/audio[Audio Models]
*** xref:api/audio/transcriptions.adoc[]
**** xref:api/audio/transcriptions/azure-openai-transcriptions.adoc[Azure OpenAI]
**** xref:api/audio/transcriptions/openai-transcriptions.adoc[OpenAI]
*** xref:api/audio/speech.adoc[]
**** xref:api/audio/speech/openai-speech.adoc[OpenAI]
** xref:api/moderation[Moderation Models]
*** xref:api/moderation/openai-moderation.adoc[OpenAI]
*** xref:api/moderation/mistral-ai-moderation.adoc[Mistral AI]
// ** xref:api/generic-model.adoc[]

* xref:api/vectordbs.adoc[]
** xref:api/vectordbs/azure.adoc[]
** xref:api/vectordbs/azure-cosmos-db.adoc[]
** xref:api/vectordbs/apache-cassandra.adoc[]
** xref:api/vectordbs/chroma.adoc[]
** xref:api/vectordbs/couchbase.adoc[]
** xref:api/vectordbs/elasticsearch.adoc[]
** xref:api/vectordbs/gemfire.adoc[GemFire]
** xref:api/vectordbs/mariadb.adoc[]
** xref:api/vectordbs/milvus.adoc[]
** xref:api/vectordbs/mongodb.adoc[]
** xref:api/vectordbs/neo4j.adoc[]
** xref:api/vectordbs/opensearch.adoc[]
** xref:api/vectordbs/oracle.adoc[Oracle]
** xref:api/vectordbs/pgvector.adoc[]
** xref:api/vectordbs/pinecone.adoc[]
** xref:api/vectordbs/qdrant.adoc[]
** xref:api/vectordbs/redis.adoc[]
** xref:api/vectordbs/hana.adoc[SAP Hana]
** xref:api/vectordbs/typesense.adoc[]
** xref:api/vectordbs/weaviate.adoc[]

* xref:api/retrieval-augmented-generation.adoc[Retrieval Augmented Generation (RAG)]
** xref:api/etl-pipeline.adoc[]
* xref:api/structured-output-converter.adoc[Structured Output]
* xref:api/chat-memory.adoc[Chat Memory]
* xref:api/tools.adoc[Tool Calling]
** xref:api/tools-migration.adoc[Migrating to ToolCallback API]
* xref:api/mcp/mcp-overview.adoc[Model Context Protocol (MCP)]
** xref:api/mcp/mcp-client-boot-starter-docs.adoc[MCP Client Boot Starters]
** xref:api/mcp/mcp-server-boot-starter-docs.adoc[MCP Server Boot Starters]
** xref:api/mcp/mcp-helpers.adoc[MCP Utilities]
* xref:api/multimodality.adoc[Multimodality]
* xref:observability/index.adoc[]
* Prompt Engineering
* Reference
** xref:api/chatclient.adoc[]
*** xref:api/advisors.adoc[Advisors]

** xref:api/prompt.adoc[]
** xref:api/chat/prompt-engineering-patterns.adoc[]
* xref:api/testing.adoc[AI Model Evaluation]
** xref:api/structured-output-converter.adoc[Structured Output]
** xref:api/multimodality.adoc[Multimodality]
** xref:api/index.adoc[Models]

*** xref:api/chatmodel.adoc[Chat Models]
**** xref:api/chat/comparison.adoc[Chat Models Comparison]
**** xref:api/chat/bedrock-converse.adoc[Amazon Bedrock Converse]
**** xref:api/chat/anthropic-chat.adoc[Anthropic 3]
**** xref:api/chat/azure-openai-chat.adoc[Azure OpenAI]
**** xref:api/chat/deepseek-chat.adoc[DeepSeek]
**** xref:api/chat/dmr-chat.adoc[Docker Model Runner]
**** xref:api/chat/google-vertexai.adoc[Google VertexAI]
***** xref:api/chat/vertexai-gemini-chat.adoc[VertexAI Gemini]
**** xref:api/chat/groq-chat.adoc[Groq]
**** xref:api/chat/huggingface.adoc[Hugging Face]
**** xref:api/chat/mistralai-chat.adoc[Mistral AI]
**** xref:api/chat/minimax-chat.adoc[MiniMax]
**** xref:api/chat/moonshot-chat.adoc[Moonshot AI]
**** xref:api/chat/nvidia-chat.adoc[NVIDIA]
**** xref:api/chat/ollama-chat.adoc[Ollama]
**** xref:api/chat/perplexity-chat.adoc[Perplexity AI]
**** OCI Generative AI
***** xref:api/chat/oci-genai/cohere-chat.adoc[Cohere]
**** xref:api/chat/openai-chat.adoc[OpenAI]
**** xref:api/chat/qianfan-chat.adoc[QianFan]
**** xref:api/chat/zhipuai-chat.adoc[ZhiPu AI]

*** xref:api/embeddings.adoc[Embedding Models]
**** 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/azure-openai-embeddings.adoc[Azure OpenAI]
**** xref:api/embeddings/mistralai-embeddings.adoc[Mistral AI]
**** xref:api/embeddings/minimax-embeddings.adoc[MiniMax]
**** xref:api/embeddings/oci-genai-embeddings.adoc[OCI GenAI]
**** xref:api/embeddings/ollama-embeddings.adoc[Ollama]
**** xref:api/embeddings/onnx.adoc[(ONNX) Transformers]
**** xref:api/embeddings/openai-embeddings.adoc[OpenAI]
**** xref:api/embeddings/postgresml-embeddings.adoc[PostgresML]
**** xref:api/embeddings/qianfan-embeddings.adoc[QianFan]
**** VertexAI
***** xref:api/embeddings/vertexai-embeddings-text.adoc[Text Embedding]
***** xref:api/embeddings/vertexai-embeddings-multimodal.adoc[Multimodal Embedding]
**** xref:api/embeddings/zhipuai-embeddings.adoc[ZhiPu AI]
*** xref:api/imageclient.adoc[Image Models]
**** xref:api/image/azure-openai-image.adoc[Azure OpenAI]
**** xref:api/image/openai-image.adoc[OpenAI]
**** xref:api/image/stabilityai-image.adoc[Stability]
**** xref:api/image/zhipuai-image.adoc[ZhiPuAI]
**** xref:api/image/qianfan-image.adoc[QianFan]

*** xref:api/audio[Audio Models]
**** xref:api/audio/transcriptions.adoc[]
***** xref:api/audio/transcriptions/azure-openai-transcriptions.adoc[Azure OpenAI]
***** xref:api/audio/transcriptions/openai-transcriptions.adoc[OpenAI]
**** xref:api/audio/speech.adoc[]
***** xref:api/audio/speech/openai-speech.adoc[OpenAI]

*** xref:api/moderation[Moderation Models]
**** xref:api/moderation/openai-moderation.adoc[OpenAI]
**** xref:api/moderation/mistral-ai-moderation.adoc[Mistral AI]
// ** xref:api/generic-model.adoc[]

** xref:api/chat-memory.adoc[Chat Memory]

** xref:api/tools.adoc[Tool Calling]
*** xref:api/tools-migration.adoc[Migrating to ToolCallback API]

* Service Connections
** xref:api/docker-compose.adoc[Docker Compose]
** xref:api/testcontainers.adoc[Testcontainers]
** xref:api/cloud-bindings.adoc[Cloud Bindings]
** xref:api/mcp/mcp-overview.adoc[Model Context Protocol (MCP)]
*** xref:api/mcp/mcp-client-boot-starter-docs.adoc[MCP Client Boot Starters]
*** xref:api/mcp/mcp-server-boot-starter-docs.adoc[MCP Server Boot Starters]
*** xref:api/mcp/mcp-helpers.adoc[MCP Utilities]

** xref:api/retrieval-augmented-generation.adoc[Retrieval Augmented Generation (RAG)]
*** xref:api/etl-pipeline.adoc[]

** xref:api/testing.adoc[Model Evaluation]

** xref:api/vectordbs.adoc[]
*** xref:api/vectordbs/azure.adoc[]
*** xref:api/vectordbs/azure-cosmos-db.adoc[]
*** xref:api/vectordbs/apache-cassandra.adoc[]
*** xref:api/vectordbs/chroma.adoc[]
*** xref:api/vectordbs/couchbase.adoc[]
*** xref:api/vectordbs/elasticsearch.adoc[]
*** xref:api/vectordbs/gemfire.adoc[GemFire]
*** xref:api/vectordbs/mariadb.adoc[]
*** xref:api/vectordbs/milvus.adoc[]
*** xref:api/vectordbs/mongodb.adoc[]
*** xref:api/vectordbs/neo4j.adoc[]
*** xref:api/vectordbs/opensearch.adoc[]
*** xref:api/vectordbs/oracle.adoc[Oracle]
*** xref:api/vectordbs/pgvector.adoc[]
*** xref:api/vectordbs/pinecone.adoc[]
*** xref:api/vectordbs/qdrant.adoc[]
*** xref:api/vectordbs/redis.adoc[]
*** xref:api/vectordbs/hana.adoc[SAP Hana]
*** xref:api/vectordbs/typesense.adoc[]
*** xref:api/vectordbs/weaviate.adoc[]

** xref:observability/index.adoc[]

** xref:api/docker-compose.adoc[Development-time Services]

** Testing
*** xref:api/testcontainers.adoc[Testcontainers]

* Guides
** https://github.com/spring-ai-community/awesome-spring-ai[Awesome Spring AI]
** xref:api/chat/prompt-engineering-patterns.adoc[]
** xref:api/cloud-bindings.adoc[Deploying to the Cloud]

* xref:contribution-guidelines.adoc[Contribution Guidelines]
// * xref:contribution-guidelines.adoc[Contribution Guidelines]

* xref:upgrade-notes.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ TIP: In addition to the model specific https://github.com/spring-projects/spring

You can register custom Java Tools with the `AnthropicChatModel` and have the Anthropic Claude model intelligently choose to output a JSON object containing arguments to call one or many of the registered functions.
This is a powerful technique to connect the LLM capabilities with external tools and APIs.
Read more about xref:api/chat/functions/anthropic-chat-functions.adoc[Anthropic Function Calling].
Read more about xref:api/tools.adoc[Tool Calling].

== Multimodal

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ TIP: In addition to the model specific link:https://github.com/spring-projects/s

You can register custom Java functions with the AzureOpenAiChatModel and have the model intelligently choose to output a JSON object containing arguments to call one or many of the registered functions.
This is a powerful technique to connect the LLM capabilities with external tools and APIs.
Read more about xref:api/chat/functions/azure-open-ai-chat-functions.adoc[Azure OpenAI Function Calling].
Read more about xref:api/tools.adoc[Tool Calling].

== Multimodal

Expand Down
Loading