Skip to content

Commit 36c5977

Browse files
tzolovmarkpollack
authored andcommitted
docs: reorganize tool calling documentation and add observability details
- Update Observability section with details about tool calling observability support - Move "Migrating to ToolCallback API" guide from Tool Calling section to Upgrade Notes - Update Observability section with details about tool calling observability support Related to #3230 Signed-off-by: Christian Tzolov <christian.tzolov@broadcom.com>
1 parent 769cf10 commit 36c5977

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
***** xref:api/embeddings/vertexai-embeddings-text.adoc[Text Embedding]
5252
***** xref:api/embeddings/vertexai-embeddings-multimodal.adoc[Multimodal Embedding]
5353
**** xref:api/embeddings/zhipuai-embeddings.adoc[ZhiPu AI]
54+
5455
*** xref:api/imageclient.adoc[Image Models]
5556
**** xref:api/image/azure-openai-image.adoc[Azure OpenAI]
5657
**** xref:api/image/openai-image.adoc[OpenAI]
@@ -73,7 +74,6 @@
7374
** xref:api/chat-memory.adoc[Chat Memory]
7475

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

7878
** xref:api/mcp/mcp-overview.adoc[Model Context Protocol (MCP)]
7979
*** xref:api/mcp/mcp-client-boot-starter-docs.adoc[MCP Client Boot Starters]
@@ -122,3 +122,4 @@
122122
// * xref:contribution-guidelines.adoc[Contribution Guidelines]
123123
124124
* xref:upgrade-notes.adoc[]
125+
** xref:api/tools-migration.adoc[Migrating FunctionCallback to ToolCallback API]

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Spring AI provides convenient APIs to define tools, resolve tool call requests f
1414

1515
NOTE: Check the xref:api/chat/comparison.adoc[Chat Model Comparisons] to see which AI models support tool calling invocation.
1616

17+
TIP: Follow the guide to migrate from the deprecated xref:api/tools-migration.adoc[FunctionCallback to ToolCallback API].
18+
1719
== Quick Start
1820

1921
Let's see how to start using tool calling in Spring AI. We'll implement two simple tools: one for information retrieval and one for taking action. The information retrieval tool will be used to get the current date and time in the user's time zone. The action tool will be used to set an alarm for a specified time.
@@ -1253,7 +1255,9 @@ The `ToolCallbackResolver` is used internally by the `ToolCallingManager` to res
12531255

12541256
== Observability
12551257

1256-
Instrumentation for the tool calling is on its way. For now, you can use the logging feature to track the tool calling operations.
1258+
Tool calling includes observability support with spring.ai.tool observations that measure completion time and propagate tracing information. See xref:observability/index.adoc#_tool_calling[Tool Calling Observability].
1259+
1260+
Optionally, Spring AI can export tool call arguments and results as span attributes, disabled by default for sensitivity reasons. Details: xref:observability/index.adoc#_tool_call_arguments_and_result_data[Tool Call Arguments and Result Data].
12571261

12581262
=== Logging
12591263

0 commit comments

Comments
 (0)