Class InvocationParameters

java.lang.Object

dev.langchain4j.invocation.InvocationParameters

public class InvocationParameters
extends Object

Represents arbitrary parameters available during a single AI Service invocation. InvocationParameters can be specified when invoking the AI Service:

interface Assistant {
    String chat(@UserMessage String userMessage, InvocationParameters parameters);
}

InvocationParameters parameters = InvocationParameters.from(Map.of("userId", "12345"));
String response = assistant.chat("What is the weather in London?", parameters);

InvocationParameters can be accessed within the Tool-annotated method:

class Tools {
    @Tool
    String getWeather(String city, InvocationParameters parameters) {
        String userId = parameters.get("userId");
        UserPreferences preferences = getUserPreferences(userId);
        return weatherService.getWeather(city, preferences.temperatureUnits());
    }
}

In this case, the LLM is not aware of these parameters; they are only visible to LangChain4j and user code.

InvocationParameters can also be accessed within other AI Service components, such as:

- ToolProvider: inside the ToolProviderRequest
- ToolArgumentsErrorHandler and ToolExecutionErrorHandler: inside the ToolErrorContext
- RAG components: inside the Query -> Metadata

Parameters are stored in a mutable, thread safe Map.

Since:

1.6.0

Constructor Summary

Constructors

Constructor	Description
InvocationParameters()
InvocationParameters(Map<String,Object> map)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()
boolean	containsKey(String key)
boolean	equals(Object object)
static InvocationParameters	from(String key, Object value)
static InvocationParameters	from(Map<String,Object> map)
<T> T	get(String key)
<T> T	getOrDefault(String key, T defaultValue)
int	hashCode()
<T> void	put(String key, T value)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

InvocationParameters

public InvocationParameters()

InvocationParameters

public InvocationParameters(Map<String,Object> map)

Method Details

asMap

public Map<String,Object> asMap()

get

public <T> T get(String key)

getOrDefault

public <T> T getOrDefault(String key,
 T defaultValue)

put

public <T> void put(String key,
 T value)

containsKey

public boolean containsKey(String key)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static InvocationParameters from(String key,
 Object value)

from

public static InvocationParameters from(Map<String,Object> map)