Class DefaultInvocationContext

java.lang.Object

dev.langchain4j.invocation.DefaultInvocationContext

All Implemented Interfaces:

InvocationContext

public class DefaultInvocationContext
extends Object
implements InvocationContext

The InvocationContext built by LangChain4j.

Besides its values, it holds whether the invocation has already reported its end (see InvocationEnd). Copies made with InvocationContext.toBuilder() that keep the same invocationId() share this state, so the invocation reports its end only once, whichever copy is used. A copy with another invocation id, or a context built from scratch, starts as not ended.

Since:

1.6.0

Nested Class Summary

Nested classes/interfaces inherited from interface InvocationContext

InvocationContext.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultInvocationContext(InvocationContext.Builder builder)

Method Summary

Modifier and Type	Method	Description
Object	chatMemoryId()	The chat memory id parameter of the method
ChatRequestParameters	defaultRequestParameters()	Returns the default ChatRequestParameters of the chat model configured on the AI service.
boolean	equals(Object object)
int	hashCode()
String	interfaceName()	The fully-qualified name of the AI Service interface where the invocation was initiated from
UUID	invocationId()	Unique identifier for an entire AI Service invocation.
InvocationParameters	invocationParameters()	The invocation parameters
Map<Class<? extends LangChain4jManaged>, LangChain4jManaged>	managedParameters()	LangChain4j managed parameters
List<Object>	methodArguments()	The arguments passed into the AI Service method
String	methodName()	The method name on InvocationContext.interfaceName() where the invocation was initiated from
ModelProvider	modelProvider()	Returns the ModelProvider of the chat model configured on the AI service.
UserMessage	originalUserMessage()	The UserMessage created from the AI Service method and its prompt template, before any transformation (RAG augmentation, content injection, input guardrails, output format instructions).
Instant	timestamp()	Retrieves the point in time when the invocation occurred.
String	toString()
UserMessage	userMessage()	The UserMessage to be sent to the LLM.

Methods inherited from class Object

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

Methods inherited from interface InvocationContext

toBuilder

Constructor Details

DefaultInvocationContext

public DefaultInvocationContext(InvocationContext.Builder builder)

Method Details

invocationId

public UUID invocationId()

Description copied from interface: InvocationContext

Unique identifier for an entire AI Service invocation. AI Services created with AiServices treat each subscription to a publisher returned by an AI Service method as a separate invocation, with its own identifier.

Specified by:

invocationId in interface InvocationContext

interfaceName

public String interfaceName()

Description copied from interface: InvocationContext

The fully-qualified name of the AI Service interface where the invocation was initiated from

Specified by:

interfaceName in interface InvocationContext

See Also:

• InvocationContext.methodName()

methodName

public String methodName()

Description copied from interface: InvocationContext

The method name on InvocationContext.interfaceName() where the invocation was initiated from

Specified by:

methodName in interface InvocationContext

methodArguments

public List<Object> methodArguments()

Description copied from interface: InvocationContext

The arguments passed into the AI Service method

Specified by:

methodArguments in interface InvocationContext

userMessage

public UserMessage userMessage()

Description copied from interface: InvocationContext

The UserMessage to be sent to the LLM. This is the message after all transformations (RAG augmentation, content injection, input guardrails, output format instructions).

Specified by:

userMessage in interface InvocationContext

originalUserMessage

public UserMessage originalUserMessage()

Description copied from interface: InvocationContext

The UserMessage created from the AI Service method and its prompt template, before any transformation (RAG augmentation, content injection, input guardrails, output format instructions). It is what the user asked, without the retrieved content, for example to decide which tools or models are relevant to the question.

Specified by:

originalUserMessage in interface InvocationContext

chatMemoryId

public Object chatMemoryId()

Description copied from interface: InvocationContext

The chat memory id parameter of the method

Specified by:

chatMemoryId in interface InvocationContext

defaultRequestParameters

public ChatRequestParameters defaultRequestParameters()

Description copied from interface: InvocationContext

Returns the default ChatRequestParameters of the chat model configured on the AI service.

Specified by:

defaultRequestParameters in interface InvocationContext

modelProvider

public ModelProvider modelProvider()

Description copied from interface: InvocationContext

Returns the ModelProvider of the chat model configured on the AI service.

Specified by:

modelProvider in interface InvocationContext

invocationParameters

public InvocationParameters invocationParameters()

Description copied from interface: InvocationContext

The invocation parameters

Specified by:

invocationParameters in interface InvocationContext

managedParameters

public Map<Class<? extends LangChain4jManaged>, LangChain4jManaged> managedParameters()

Description copied from interface: InvocationContext

LangChain4j managed parameters

Specified by:

managedParameters in interface InvocationContext

timestamp

public Instant timestamp()

Description copied from interface: InvocationContext

Retrieves the point in time when the invocation occurred.

Specified by:

timestamp in interface InvocationContext

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