Skip to content

Commit b219c21

Browse files
tzolovmarkpollack
authored andcommitted
docs: reorganize documentation structure
- Restructure navigation with clearer hierarchy using "Reference" and "Guides" sections - Remove deprecated model-specific function calling documentation - Update all model references to point to centralized Tool Calling documentation - Rename "Docker Compose" to "Development-time Services" for clarity - Move "Testing" under Reference section - Add link to "Awesome Spring AI" community resources Signed-off-by: Christian Tzolov <[email protected]>
1 parent 6df8484 commit b219c21

14 files changed

+119
-1596
lines changed
Lines changed: 114 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,124 @@
11
* xref:index.adoc[Overview]
22
** xref:concepts.adoc[AI Concepts]
33
* xref:getting-started.adoc[Getting Started]
4-
* xref:api/chatclient.adoc[]
5-
** xref:api/advisors.adoc[Advisors]
6-
* xref:api/index.adoc[AI Models]
7-
** xref:api/chatmodel.adoc[Chat Models]
8-
*** xref:api/chat/comparison.adoc[Chat Models Comparison]
9-
*** xref:api/chat/bedrock-converse.adoc[Amazon Bedrock Converse]
10-
*** xref:api/chat/anthropic-chat.adoc[Anthropic 3]
11-
**** xref:api/chat/functions/anthropic-chat-functions.adoc[Anthropic Function Calling (Deprecated)]
12-
*** xref:api/chat/azure-openai-chat.adoc[Azure OpenAI]
13-
**** xref:api/chat/functions/azure-open-ai-chat-functions.adoc[Azure OpenAI Function Calling]
14-
*** xref:api/chat/deepseek-chat.adoc[DeepSeek]
15-
*** xref:api/chat/dmr-chat.adoc[Docker Model Runner]
16-
*** xref:api/chat/google-vertexai.adoc[Google VertexAI]
17-
**** xref:api/chat/vertexai-gemini-chat.adoc[VertexAI Gemini]
18-
*** xref:api/chat/groq-chat.adoc[Groq]
19-
*** xref:api/chat/huggingface.adoc[Hugging Face]
20-
*** xref:api/chat/mistralai-chat.adoc[Mistral AI]
21-
**** xref:api/chat/functions/mistralai-chat-functions.adoc[Mistral Function Calling (Deprecated)]
22-
*** xref:api/chat/minimax-chat.adoc[MiniMax]
23-
**** xref:api/chat/functions/minimax-chat-functions.adoc[MinmaxFunction Calling]
24-
*** xref:api/chat/moonshot-chat.adoc[Moonshot AI]
25-
//// **** xref:api/chat/functions/moonshot-chat-functions.adoc[Moonshot Function Calling]
26-
*** xref:api/chat/nvidia-chat.adoc[NVIDIA]
27-
*** xref:api/chat/ollama-chat.adoc[Ollama]
28-
**** xref:api/chat/functions/ollama-chat-functions.adoc[Ollama Function Calling (Deprecated)]
29-
*** xref:api/chat/perplexity-chat.adoc[Perplexity AI]
30-
*** OCI Generative AI
31-
**** xref:api/chat/oci-genai/cohere-chat.adoc[Cohere]
32-
*** xref:api/chat/openai-chat.adoc[OpenAI]
33-
**** xref:api/chat/functions/openai-chat-functions.adoc[OpenAI Function Calling (Deprecated)]
34-
*** xref:api/chat/qianfan-chat.adoc[QianFan]
35-
*** xref:api/chat/zhipuai-chat.adoc[ZhiPu AI]
36-
** xref:api/embeddings.adoc[Embedding Models]
37-
*** xref:api/bedrock.adoc[Amazon Bedrock]
38-
**** xref:api/embeddings/bedrock-cohere-embedding.adoc[Cohere]
39-
**** xref:api/embeddings/bedrock-titan-embedding.adoc[Titan]
40-
*** xref:api/embeddings/azure-openai-embeddings.adoc[Azure OpenAI]
41-
*** xref:api/embeddings/mistralai-embeddings.adoc[Mistral AI]
42-
*** xref:api/embeddings/minimax-embeddings.adoc[MiniMax]
43-
*** xref:api/embeddings/oci-genai-embeddings.adoc[OCI GenAI]
44-
*** xref:api/embeddings/ollama-embeddings.adoc[Ollama]
45-
*** xref:api/embeddings/onnx.adoc[(ONNX) Transformers]
46-
*** xref:api/embeddings/openai-embeddings.adoc[OpenAI]
47-
*** xref:api/embeddings/postgresml-embeddings.adoc[PostgresML]
48-
*** xref:api/embeddings/qianfan-embeddings.adoc[QianFan]
49-
*** VertexAI
50-
**** xref:api/embeddings/vertexai-embeddings-text.adoc[Text Embedding]
51-
**** xref:api/embeddings/vertexai-embeddings-multimodal.adoc[Multimodal Embedding]
52-
*** xref:api/embeddings/zhipuai-embeddings.adoc[ZhiPu AI]
53-
** xref:api/imageclient.adoc[Image Models]
54-
*** xref:api/image/azure-openai-image.adoc[Azure OpenAI]
55-
*** xref:api/image/openai-image.adoc[OpenAI]
56-
*** xref:api/image/stabilityai-image.adoc[Stability]
57-
*** xref:api/image/zhipuai-image.adoc[ZhiPuAI]
58-
*** xref:api/image/qianfan-image.adoc[QianFan]
59-
** xref:api/audio[Audio Models]
60-
*** xref:api/audio/transcriptions.adoc[]
61-
**** xref:api/audio/transcriptions/azure-openai-transcriptions.adoc[Azure OpenAI]
62-
**** xref:api/audio/transcriptions/openai-transcriptions.adoc[OpenAI]
63-
*** xref:api/audio/speech.adoc[]
64-
**** xref:api/audio/speech/openai-speech.adoc[OpenAI]
65-
** xref:api/moderation[Moderation Models]
66-
*** xref:api/moderation/openai-moderation.adoc[OpenAI]
67-
*** xref:api/moderation/mistral-ai-moderation.adoc[Mistral AI]
68-
// ** xref:api/generic-model.adoc[]
694
70-
* xref:api/vectordbs.adoc[]
71-
** xref:api/vectordbs/azure.adoc[]
72-
** xref:api/vectordbs/azure-cosmos-db.adoc[]
73-
** xref:api/vectordbs/apache-cassandra.adoc[]
74-
** xref:api/vectordbs/chroma.adoc[]
75-
** xref:api/vectordbs/couchbase.adoc[]
76-
** xref:api/vectordbs/elasticsearch.adoc[]
77-
** xref:api/vectordbs/gemfire.adoc[GemFire]
78-
** xref:api/vectordbs/mariadb.adoc[]
79-
** xref:api/vectordbs/milvus.adoc[]
80-
** xref:api/vectordbs/mongodb.adoc[]
81-
** xref:api/vectordbs/neo4j.adoc[]
82-
** xref:api/vectordbs/opensearch.adoc[]
83-
** xref:api/vectordbs/oracle.adoc[Oracle]
84-
** xref:api/vectordbs/pgvector.adoc[]
85-
** xref:api/vectordbs/pinecone.adoc[]
86-
** xref:api/vectordbs/qdrant.adoc[]
87-
** xref:api/vectordbs/redis.adoc[]
88-
** xref:api/vectordbs/hana.adoc[SAP Hana]
89-
** xref:api/vectordbs/typesense.adoc[]
90-
** xref:api/vectordbs/weaviate.adoc[]
91-
92-
* xref:api/retrieval-augmented-generation.adoc[Retrieval Augmented Generation (RAG)]
93-
** xref:api/etl-pipeline.adoc[]
94-
* xref:api/structured-output-converter.adoc[Structured Output]
95-
* xref:api/chat-memory.adoc[Chat Memory]
96-
* xref:api/tools.adoc[Tool Calling]
97-
** xref:api/tools-migration.adoc[Migrating to ToolCallback API]
98-
* xref:api/mcp/mcp-overview.adoc[Model Context Protocol (MCP)]
99-
** xref:api/mcp/mcp-client-boot-starter-docs.adoc[MCP Client Boot Starters]
100-
** xref:api/mcp/mcp-server-boot-starter-docs.adoc[MCP Server Boot Starters]
101-
** xref:api/mcp/mcp-helpers.adoc[MCP Utilities]
102-
* xref:api/multimodality.adoc[Multimodality]
103-
* xref:observability/index.adoc[]
104-
* Prompt Engineering
5+
* Reference
6+
** xref:api/chatclient.adoc[]
7+
*** xref:api/advisors.adoc[Advisors]
8+
1059
** xref:api/prompt.adoc[]
106-
** xref:api/chat/prompt-engineering-patterns.adoc[]
107-
* xref:api/testing.adoc[AI Model Evaluation]
10+
** xref:api/structured-output-converter.adoc[Structured Output]
11+
** xref:api/multimodality.adoc[Multimodality]
12+
** xref:api/index.adoc[Models]
13+
14+
*** xref:api/chatmodel.adoc[Chat Models]
15+
**** xref:api/chat/comparison.adoc[Chat Models Comparison]
16+
**** xref:api/chat/bedrock-converse.adoc[Amazon Bedrock Converse]
17+
**** xref:api/chat/anthropic-chat.adoc[Anthropic 3]
18+
**** xref:api/chat/azure-openai-chat.adoc[Azure OpenAI]
19+
**** xref:api/chat/deepseek-chat.adoc[DeepSeek]
20+
**** xref:api/chat/dmr-chat.adoc[Docker Model Runner]
21+
**** xref:api/chat/google-vertexai.adoc[Google VertexAI]
22+
***** xref:api/chat/vertexai-gemini-chat.adoc[VertexAI Gemini]
23+
**** xref:api/chat/groq-chat.adoc[Groq]
24+
**** xref:api/chat/huggingface.adoc[Hugging Face]
25+
**** xref:api/chat/mistralai-chat.adoc[Mistral AI]
26+
**** xref:api/chat/minimax-chat.adoc[MiniMax]
27+
**** xref:api/chat/moonshot-chat.adoc[Moonshot AI]
28+
**** xref:api/chat/nvidia-chat.adoc[NVIDIA]
29+
**** xref:api/chat/ollama-chat.adoc[Ollama]
30+
**** xref:api/chat/perplexity-chat.adoc[Perplexity AI]
31+
**** OCI Generative AI
32+
***** xref:api/chat/oci-genai/cohere-chat.adoc[Cohere]
33+
**** xref:api/chat/openai-chat.adoc[OpenAI]
34+
**** xref:api/chat/qianfan-chat.adoc[QianFan]
35+
**** xref:api/chat/zhipuai-chat.adoc[ZhiPu AI]
36+
37+
*** xref:api/embeddings.adoc[Embedding Models]
38+
**** xref:api/bedrock.adoc[Amazon Bedrock]
39+
***** xref:api/embeddings/bedrock-cohere-embedding.adoc[Cohere]
40+
***** xref:api/embeddings/bedrock-titan-embedding.adoc[Titan]
41+
**** xref:api/embeddings/azure-openai-embeddings.adoc[Azure OpenAI]
42+
**** xref:api/embeddings/mistralai-embeddings.adoc[Mistral AI]
43+
**** xref:api/embeddings/minimax-embeddings.adoc[MiniMax]
44+
**** xref:api/embeddings/oci-genai-embeddings.adoc[OCI GenAI]
45+
**** xref:api/embeddings/ollama-embeddings.adoc[Ollama]
46+
**** xref:api/embeddings/onnx.adoc[(ONNX) Transformers]
47+
**** xref:api/embeddings/openai-embeddings.adoc[OpenAI]
48+
**** xref:api/embeddings/postgresml-embeddings.adoc[PostgresML]
49+
**** xref:api/embeddings/qianfan-embeddings.adoc[QianFan]
50+
**** VertexAI
51+
***** xref:api/embeddings/vertexai-embeddings-text.adoc[Text Embedding]
52+
***** xref:api/embeddings/vertexai-embeddings-multimodal.adoc[Multimodal Embedding]
53+
**** xref:api/embeddings/zhipuai-embeddings.adoc[ZhiPu AI]
54+
*** xref:api/imageclient.adoc[Image Models]
55+
**** xref:api/image/azure-openai-image.adoc[Azure OpenAI]
56+
**** xref:api/image/openai-image.adoc[OpenAI]
57+
**** xref:api/image/stabilityai-image.adoc[Stability]
58+
**** xref:api/image/zhipuai-image.adoc[ZhiPuAI]
59+
**** xref:api/image/qianfan-image.adoc[QianFan]
60+
61+
*** xref:api/audio[Audio Models]
62+
**** xref:api/audio/transcriptions.adoc[]
63+
***** xref:api/audio/transcriptions/azure-openai-transcriptions.adoc[Azure OpenAI]
64+
***** xref:api/audio/transcriptions/openai-transcriptions.adoc[OpenAI]
65+
**** xref:api/audio/speech.adoc[]
66+
***** xref:api/audio/speech/openai-speech.adoc[OpenAI]
67+
68+
*** xref:api/moderation[Moderation Models]
69+
**** xref:api/moderation/openai-moderation.adoc[OpenAI]
70+
**** xref:api/moderation/mistral-ai-moderation.adoc[Mistral AI]
71+
// ** xref:api/generic-model.adoc[]
72+
73+
** xref:api/chat-memory.adoc[Chat Memory]
10874

75+
** xref:api/tools.adoc[Tool Calling]
76+
*** xref:api/tools-migration.adoc[Migrating to ToolCallback API]
10977
110-
* Service Connections
111-
** xref:api/docker-compose.adoc[Docker Compose]
112-
** xref:api/testcontainers.adoc[Testcontainers]
113-
** xref:api/cloud-bindings.adoc[Cloud Bindings]
78+
** xref:api/mcp/mcp-overview.adoc[Model Context Protocol (MCP)]
79+
*** xref:api/mcp/mcp-client-boot-starter-docs.adoc[MCP Client Boot Starters]
80+
*** xref:api/mcp/mcp-server-boot-starter-docs.adoc[MCP Server Boot Starters]
81+
*** xref:api/mcp/mcp-helpers.adoc[MCP Utilities]
82+
83+
** xref:api/retrieval-augmented-generation.adoc[Retrieval Augmented Generation (RAG)]
84+
*** xref:api/etl-pipeline.adoc[]
85+
86+
** xref:api/testing.adoc[Model Evaluation]
87+
88+
** xref:api/vectordbs.adoc[]
89+
*** xref:api/vectordbs/azure.adoc[]
90+
*** xref:api/vectordbs/azure-cosmos-db.adoc[]
91+
*** xref:api/vectordbs/apache-cassandra.adoc[]
92+
*** xref:api/vectordbs/chroma.adoc[]
93+
*** xref:api/vectordbs/couchbase.adoc[]
94+
*** xref:api/vectordbs/elasticsearch.adoc[]
95+
*** xref:api/vectordbs/gemfire.adoc[GemFire]
96+
*** xref:api/vectordbs/mariadb.adoc[]
97+
*** xref:api/vectordbs/milvus.adoc[]
98+
*** xref:api/vectordbs/mongodb.adoc[]
99+
*** xref:api/vectordbs/neo4j.adoc[]
100+
*** xref:api/vectordbs/opensearch.adoc[]
101+
*** xref:api/vectordbs/oracle.adoc[Oracle]
102+
*** xref:api/vectordbs/pgvector.adoc[]
103+
*** xref:api/vectordbs/pinecone.adoc[]
104+
*** xref:api/vectordbs/qdrant.adoc[]
105+
*** xref:api/vectordbs/redis.adoc[]
106+
*** xref:api/vectordbs/hana.adoc[SAP Hana]
107+
*** xref:api/vectordbs/typesense.adoc[]
108+
*** xref:api/vectordbs/weaviate.adoc[]
109+
110+
** xref:observability/index.adoc[]
111+
112+
** xref:api/docker-compose.adoc[Development-time Services]
113+
114+
** Testing
115+
*** xref:api/testcontainers.adoc[Testcontainers]
116+
117+
* Guides
118+
** https://github.com/spring-ai-community/awesome-spring-ai[Awesome Spring AI]
119+
** xref:api/chat/prompt-engineering-patterns.adoc[]
120+
** xref:api/cloud-bindings.adoc[Deploying to the Cloud]
114121
115-
* xref:contribution-guidelines.adoc[Contribution Guidelines]
122+
// * xref:contribution-guidelines.adoc[Contribution Guidelines]
116123

117124
* xref:upgrade-notes.adoc[]

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/anthropic-chat.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ TIP: In addition to the model specific https://github.com/spring-projects/spring
165165

166166
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.
167167
This is a powerful technique to connect the LLM capabilities with external tools and APIs.
168-
Read more about xref:api/chat/functions/anthropic-chat-functions.adoc[Anthropic Function Calling].
168+
Read more about xref:api/tools.adoc[Tool Calling].
169169

170170
== Multimodal
171171

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/azure-openai-chat.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ TIP: In addition to the model specific link:https://github.com/spring-projects/s
226226

227227
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.
228228
This is a powerful technique to connect the LLM capabilities with external tools and APIs.
229-
Read more about xref:api/chat/functions/azure-open-ai-chat-functions.adoc[Azure OpenAI Function Calling].
229+
Read more about xref:api/tools.adoc[Tool Calling].
230230

231231
== Multimodal
232232

0 commit comments

Comments
 (0)