From 5ca0a671e5c165b83b7efb802495af813bb06feb Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Wed, 17 Dec 2025 14:25:14 +0100 Subject: [PATCH 1/2] Add Tool Argument Augmenter demo with chat memory integration Introduce a companion example for the "Explainable AI Agents" blog post, demonstrating the tool-augmenter library for capturing LLM reasoning during tool calls. Key features demonstrated: - AgentThinking record to capture inner thoughts, confidence levels, and memory notes from the LLM during tool execution - AugmentedToolCallbackProvider for transparent schema augmentation - Integration with ToolCallAdvisor and MessageChatMemoryAdvisor to persist reasoning insights in conversation history - Custom logging advisor for request/response observability This pattern enables debugging, observability, and memory-enhanced reasoning for AI agents without modifying underlying tool implementations. Signed-off-by: Christian Tzolov --- .../.gitattributes | 2 + .../recursive-advisor-with-memory/.gitignore | 33 ++ .../.mvn/wrapper/maven-wrapper.properties | 3 + .../recursive-advisor-with-memory/README.md | 154 +++++++++ advisors/recursive-advisor-with-memory/mvnw | 295 ++++++++++++++++++ .../recursive-advisor-with-memory/mvnw.cmd | 189 +++++++++++ .../recursive-advisor-with-memory/pom.xml | 118 +++++++ .../advisor/memory/DemoApplication.java | 130 ++++++++ .../src/main/resources/application.properties | 8 + pom.xml | 1 + 10 files changed, 933 insertions(+) create mode 100644 advisors/recursive-advisor-with-memory/.gitattributes create mode 100644 advisors/recursive-advisor-with-memory/.gitignore create mode 100644 advisors/recursive-advisor-with-memory/.mvn/wrapper/maven-wrapper.properties create mode 100644 advisors/recursive-advisor-with-memory/README.md create mode 100755 advisors/recursive-advisor-with-memory/mvnw create mode 100644 advisors/recursive-advisor-with-memory/mvnw.cmd create mode 100644 advisors/recursive-advisor-with-memory/pom.xml create mode 100644 advisors/recursive-advisor-with-memory/src/main/java/com/example/recursive/advisor/memory/DemoApplication.java create mode 100644 advisors/recursive-advisor-with-memory/src/main/resources/application.properties diff --git a/advisors/recursive-advisor-with-memory/.gitattributes b/advisors/recursive-advisor-with-memory/.gitattributes new file mode 100644 index 00000000..3b41682a --- /dev/null +++ b/advisors/recursive-advisor-with-memory/.gitattributes @@ -0,0 +1,2 @@ +/mvnw text eol=lf +*.cmd text eol=crlf diff --git a/advisors/recursive-advisor-with-memory/.gitignore b/advisors/recursive-advisor-with-memory/.gitignore new file mode 100644 index 00000000..667aaef0 --- /dev/null +++ b/advisors/recursive-advisor-with-memory/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/advisors/recursive-advisor-with-memory/.mvn/wrapper/maven-wrapper.properties b/advisors/recursive-advisor-with-memory/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..c0bcafe9 --- /dev/null +++ b/advisors/recursive-advisor-with-memory/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,3 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip diff --git a/advisors/recursive-advisor-with-memory/README.md b/advisors/recursive-advisor-with-memory/README.md new file mode 100644 index 00000000..18875a3b --- /dev/null +++ b/advisors/recursive-advisor-with-memory/README.md @@ -0,0 +1,154 @@ +# Recursive Advisor with Memory and Tool Argument Augmentation + +This example demonstrates how to build **explainable AI agents** using Spring AI by capturing LLM reasoning during tool calls and integrating with chat memory for enhanced context across conversations. + +## Overview + +When building AI agents with tool calling capabilities, understanding **why** an LLM chose a particular tool is crucial for debugging, observability, and building trustworthy AI systems. This demo showcases the [Tool Argument Augmenter](https://github.com/tzolov/spring-ai-tool-augmenter) library which enables: + +- **Capturing LLM Reasoning**: Extract inner thoughts, confidence levels, and memory notes during tool execution +- **Transparent Schema Augmentation**: Dynamically extend tool schemas without modifying underlying tool implementations +- **Memory-Enhanced Reasoning**: Persist reasoning insights in conversation history for improved decision-making across extended interactions + +## How It Works + +``` +┌─────────────────────────────────────────────────────────────────────────┐ +│ Tool Argument Augmenter Flow │ +├─────────────────────────────────────────────────────────────────────────┤ +│ │ +│ 1. User asks: "What is current weather in Paris?" │ +│ │ │ +│ ▼ │ +│ 2. Tool Definition Augmentation │ +│ Original: { location: string } │ +│ Augmented: { location: string, innerThought: string, │ +│ confidence: string, memoryNotes: string[] } │ +│ │ │ +│ ▼ │ +│ 3. LLM Response with Reasoning │ +│ { │ +│ "location": "Paris", │ +│ "innerThought": "User wants weather info for Paris...", │ +│ "confidence": "high", │ +│ "memoryNotes": ["User interested in Paris weather"] │ +│ } │ +│ │ │ +│ ▼ │ +│ 4. Argument Consumer processes reasoning (logging, memory storage) │ +│ │ │ +│ ▼ │ +│ 5. Original tool receives only: { "location": "Paris" } │ +│ │ +└─────────────────────────────────────────────────────────────────────────┘ +``` + +## Key Components + +### AgentThinking Record + +Defines the additional arguments to capture from the LLM: + +```java +public record AgentThinking( + @ToolParam(description = "Your step-by-step reasoning for why you're calling this tool", + required = true) + String innerThought, + + @ToolParam(description = "Confidence level (low, medium, high) in this tool choice", + required = false) + String confidence, + + @ToolParam(description = "Key insights to remember for future interactions", + required = true) + List memoryNotes +) {} +``` + +### AugmentedToolCallbackProvider + +Wraps existing tools to transparently augment their schemas: + +```java +AugmentedToolCallbackProvider provider = AugmentedToolCallbackProvider + .builder() + .toolObject(new MyTools()) + .argumentType(AgentThinking.class) + .argumentConsumer(event -> { + AgentThinking thinking = event.arguments(); + logger.info("LLM Reasoning: {}", thinking.innerThought()); + logger.info("Confidence: {}", thinking.confidence()); + logger.info("Memory Notes: {}", thinking.memoryNotes()); + }) + .removeExtraArgumentsAfterProcessing(true) + .build(); +``` + +### Integration with Advisors + +Combines tool augmentation with Spring AI's advisor chain: + +```java +ChatClient chatClient = chatClientBuilder + .defaultToolCallbacks(provider) + .defaultAdvisors( + ToolCallAdvisor.builder() + .conversationHistoryEnabled(false).build(), + MessageChatMemoryAdvisor.builder(chatMemory).build(), + new MyLogAdvisor()) + .build(); +``` + +## Running the Example + +### Prerequisites + +- Java 17 or higher +- OpenAI API key (or Anthropic API key) + +### Configuration + +Set your API key as an environment variable: + +```bash +export OPENAI_API_KEY=your-api-key +# or +export ANTHROPIC_API_KEY=your-api-key +``` + +### Build and Run + +```bash +cd advisors/recursive-advisor-with-memory +./mvnw spring-boot:run +``` + +## Sample Output + +When running the example, you'll see the LLM's reasoning captured before each tool call: + +``` +LLM Reasoning: The user is asking about the current weather in Paris. I need to call the weather tool... +Confidence: high +Memory Notes: [User interested in Paris weather, May need follow-up about activities] +Tool: weather + +REQUEST: [{"type":"USER","text":"What is current weather in Paris?"}] + +RESPONSE: [{"output":{"text":"The current weather in Paris is sunny with a temperature of 25°C."}}] +``` + +## Use Cases + +- **Debugging**: Understand why your AI agent made specific tool choices +- **Observability**: Log and monitor agent reasoning in production +- **Memory Enhancement**: Store insights for improved context in future conversations +- **Multi-Agent Coordination**: Pass coordination signals between agents +- **Analytics**: Track tool usage patterns and decision quality + +## Resources + +- [Tool Argument Augmenter Library](https://github.com/tzolov/spring-ai-tool-augmenter) +- [Explainable AI Agents Blog Post](https://spring.io/blog/2025/12/21/explainable-ai-agents-capture-llm-tool-call-reasoning-with-spring-ai) +- [Spring AI Tool Calling Documentation](https://docs.spring.io/spring-ai/reference/api/tools.html) +- [Spring AI Advisors Guide](https://docs.spring.io/spring-ai/reference/api/advisors.html) diff --git a/advisors/recursive-advisor-with-memory/mvnw b/advisors/recursive-advisor-with-memory/mvnw new file mode 100755 index 00000000..bd8896bf --- /dev/null +++ b/advisors/recursive-advisor-with-memory/mvnw @@ -0,0 +1,295 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + if [ -n "${JAVA_HOME-}" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/advisors/recursive-advisor-with-memory/mvnw.cmd b/advisors/recursive-advisor-with-memory/mvnw.cmd new file mode 100644 index 00000000..92450f93 --- /dev/null +++ b/advisors/recursive-advisor-with-memory/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/advisors/recursive-advisor-with-memory/pom.xml b/advisors/recursive-advisor-with-memory/pom.xml new file mode 100644 index 00000000..9f591441 --- /dev/null +++ b/advisors/recursive-advisor-with-memory/pom.xml @@ -0,0 +1,118 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 4.0.0 + + + + com.example + recursive-advisor-with-memory + 0.0.1-SNAPSHOT + recursive-advisor-with-memory + Demo project for Spring Boot + + + 17 + + 2.0.0-SNAPSHOT + + + + + com.logaritex.ai + tool-augmenter + 0.0.1-SNAPSHOT + + + + + + + + org.springframework.ai + spring-ai-starter-model-openai-sdk + + + + + + + io.netty + netty-resolver-dns-native-macos + osx-aarch_64 + + + + + + + + org.springframework.ai + spring-ai-bom + ${spring-ai.version} + pom + import + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + + false + + + + Central Portal Snapshots + central-portal-snapshots + https://central.sonatype.com/repository/maven-snapshots/ + + false + + + true + + + + + \ No newline at end of file diff --git a/advisors/recursive-advisor-with-memory/src/main/java/com/example/recursive/advisor/memory/DemoApplication.java b/advisors/recursive-advisor-with-memory/src/main/java/com/example/recursive/advisor/memory/DemoApplication.java new file mode 100644 index 00000000..823553a9 --- /dev/null +++ b/advisors/recursive-advisor-with-memory/src/main/java/com/example/recursive/advisor/memory/DemoApplication.java @@ -0,0 +1,130 @@ +package com.example.recursive.advisor.memory; + +import java.util.List; + +import com.logaritex.ai.tool.schema.augmenter.AugmentedToolCallbackProvider; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.springframework.ai.chat.client.ChatClient; +import org.springframework.ai.chat.client.ChatClientRequest; +import org.springframework.ai.chat.client.ChatClientResponse; +import org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor; +import org.springframework.ai.chat.client.advisor.ToolCallAdvisor; +import org.springframework.ai.chat.client.advisor.api.AdvisorChain; +import org.springframework.ai.chat.client.advisor.api.BaseAdvisor; +import org.springframework.ai.chat.memory.MessageWindowChatMemory; +import org.springframework.ai.model.ModelOptionsUtils; +import org.springframework.ai.tool.annotation.Tool; +import org.springframework.ai.tool.annotation.ToolParam; +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.core.Ordered; + +@SpringBootApplication +public class DemoApplication { + + private static final Logger logger = LoggerFactory.getLogger(DemoApplication.class); + + public static void main(String[] args) { + SpringApplication.run(DemoApplication.class, args); + } + + public record AgentThinking( + @ToolParam(description = "Your step-by-step reasoning for why you're calling this tool and what you expect", + required = true) String innerThought, + + @ToolParam(description = "Confidence level (low, medium, high) in this tool choice", + required = false) String confidence, + + @ToolParam(description = "Key insights to remember for future interactions", + required = true) List memoryNotes) { + } + + public record MyResponse(String result, AgentThinking thinking) { + } + + @Bean + CommandLineRunner commandLineRunner(ChatClient.Builder chatClientBuilder) { + return args -> { + + AugmentedToolCallbackProvider provider = AugmentedToolCallbackProvider + .builder() + .toolObject(new MyTools()) + .argumentType(AgentThinking.class) + .argumentConsumer(event -> { + // Access the extended arguments via event.arguments() + AgentThinking thinking = event.arguments(); + + // Log the LLM's reasoning - great for debugging and observability + logger.info("LLM Reasoning: {}", thinking.innerThought()); + logger.info("Confidence: {}", thinking.confidence()); + logger.info("Thinking notest: {}", thinking.memoryNotes()); + + // Access additional context from the event + logger.info("Tool: {}", event.toolDefinition().name()); + }) + .removeExtraArgumentsAfterProcessing(true) // Remove before calling actual + // tool + .build(); + + MessageWindowChatMemory chatMemory = MessageWindowChatMemory.builder().maxMessages(100).build(); + + ChatClient chatClient = chatClientBuilder // @formatter:off + .defaultToolCallbacks(provider) + .defaultAdvisors( + ToolCallAdvisor.builder() + .advisorOrder(BaseAdvisor.HIGHEST_PRECEDENCE + 300) + .conversationHistoryEnabled(false).build(), + MessageChatMemoryAdvisor.builder(chatMemory).order(Ordered.HIGHEST_PRECEDENCE + 1000).build(), + new MyLogAdvisor()) // order 0 = HIGHEST_PRECEDENCE + 2147483648 + .build(); + + var answer = chatClient + .prompt("What is current weather in Paris?") + .call() + .entity(MyResponse.class); + + // @formatter:on + + System.out.println(answer); + }; + } + + static class MyTools { + + @Tool(description = "Get the current weather for a given location") + public String weather(String location) { + return "The current weather in " + location + " is sunny with a temperature of 25°C."; + } + + } + + static class MyLogAdvisor implements BaseAdvisor { + + @Override + public int getOrder() { + return 0; + } + + @Override + public ChatClientRequest before(ChatClientRequest chatClientRequest, AdvisorChain advisorChain) { + print("REQUEST", chatClientRequest.prompt().getInstructions()); + return chatClientRequest; + } + + @Override + public ChatClientResponse after(ChatClientResponse chatClientResponse, AdvisorChain advisorChain) { + print("RESPONSE", chatClientResponse.chatResponse().getResults()); + return chatClientResponse; + } + + private void print(String label, Object object) { + System.out.println(label + ":" + ModelOptionsUtils.toJsonString(object) + "\n"); + } + + } + +} diff --git a/advisors/recursive-advisor-with-memory/src/main/resources/application.properties b/advisors/recursive-advisor-with-memory/src/main/resources/application.properties new file mode 100644 index 00000000..46013bf5 --- /dev/null +++ b/advisors/recursive-advisor-with-memory/src/main/resources/application.properties @@ -0,0 +1,8 @@ +spring.application.name=recursive-advisor-toolcall-with-memory-additionl-arguments +spring.main.web-application-type=none + +spring.ai.anthropic.api-key=${ANTHROPIC_API_KEY} + +spring.ai.openai.api-key=${OPENAI_API_KEY} + +# debug=true \ No newline at end of file diff --git a/pom.xml b/pom.xml index e7cb002b..d7bbb30c 100644 --- a/pom.xml +++ b/pom.xml @@ -59,6 +59,7 @@ advisors/recursive-advisor-demo + advisors/recursive-advisor-with-memory advisors/evaluation-recursive-advisor-demo From 780ec85ab85ab1084d44ae2798f135eb169707e6 Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Thu, 18 Dec 2025 22:49:48 +0100 Subject: [PATCH 2/2] Use the spring-ai tool-arg-augmenter code Signed-off-by: Christian Tzolov --- .../recursive-advisor-with-memory/README.md | 3 +-- .../recursive-advisor-with-memory/pom.xml | 21 ------------------- .../advisor/memory/DemoApplication.java | 2 +- 3 files changed, 2 insertions(+), 24 deletions(-) diff --git a/advisors/recursive-advisor-with-memory/README.md b/advisors/recursive-advisor-with-memory/README.md index 18875a3b..56234107 100644 --- a/advisors/recursive-advisor-with-memory/README.md +++ b/advisors/recursive-advisor-with-memory/README.md @@ -4,7 +4,7 @@ This example demonstrates how to build **explainable AI agents** using Spring AI ## Overview -When building AI agents with tool calling capabilities, understanding **why** an LLM chose a particular tool is crucial for debugging, observability, and building trustworthy AI systems. This demo showcases the [Tool Argument Augmenter](https://github.com/tzolov/spring-ai-tool-augmenter) library which enables: +When building AI agents with tool calling capabilities, understanding **why** an LLM chose a particular tool is crucial for debugging, observability, and building trustworthy AI systems. This demo showcases the [Tool Argument Augmenter](TODO) library which enables: - **Capturing LLM Reasoning**: Extract inner thoughts, confidence levels, and memory notes during tool execution - **Transparent Schema Augmentation**: Dynamically extend tool schemas without modifying underlying tool implementations @@ -148,7 +148,6 @@ RESPONSE: [{"output":{"text":"The current weather in Paris is sunny with a tempe ## Resources -- [Tool Argument Augmenter Library](https://github.com/tzolov/spring-ai-tool-augmenter) - [Explainable AI Agents Blog Post](https://spring.io/blog/2025/12/21/explainable-ai-agents-capture-llm-tool-call-reasoning-with-spring-ai) - [Spring AI Tool Calling Documentation](https://docs.spring.io/spring-ai/reference/api/tools.html) - [Spring AI Advisors Guide](https://docs.spring.io/spring-ai/reference/api/advisors.html) diff --git a/advisors/recursive-advisor-with-memory/pom.xml b/advisors/recursive-advisor-with-memory/pom.xml index 9f591441..cc857cee 100644 --- a/advisors/recursive-advisor-with-memory/pom.xml +++ b/advisors/recursive-advisor-with-memory/pom.xml @@ -23,27 +23,6 @@ - - com.logaritex.ai - tool-augmenter - 0.0.1-SNAPSHOT - - - - - - org.springframework.ai spring-ai-starter-model-openai-sdk diff --git a/advisors/recursive-advisor-with-memory/src/main/java/com/example/recursive/advisor/memory/DemoApplication.java b/advisors/recursive-advisor-with-memory/src/main/java/com/example/recursive/advisor/memory/DemoApplication.java index 823553a9..81fc57bb 100644 --- a/advisors/recursive-advisor-with-memory/src/main/java/com/example/recursive/advisor/memory/DemoApplication.java +++ b/advisors/recursive-advisor-with-memory/src/main/java/com/example/recursive/advisor/memory/DemoApplication.java @@ -2,7 +2,6 @@ import java.util.List; -import com.logaritex.ai.tool.schema.augmenter.AugmentedToolCallbackProvider; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -17,6 +16,7 @@ import org.springframework.ai.model.ModelOptionsUtils; import org.springframework.ai.tool.annotation.Tool; import org.springframework.ai.tool.annotation.ToolParam; +import org.springframework.ai.tool.augment.AugmentedToolCallbackProvider; import org.springframework.boot.CommandLineRunner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;