Method●Since v1.0

invoke

Executes the agent with the given state and returns the final state after all processing.

This method runs the agent's entire workflow synchronously, including:

Processing the input messages through any configured middleware
Calling the language model to generate responses
Executing any tool calls made by the model
Running all middleware hooks (beforeModel, afterModel, etc.)

invoke(
  state: InvokeStateParameter<Types>,
  config: InvokeConfiguration<InferContextInput<Types["Context"] extends InteropZodObject | AnyAnnotationRoot  any[any] : AnyAnnotationRoot>  InferMiddlewareContextInputs<Types["Middleware"]>>
): Promise<MergedAgentState<Types>>

Parameters

Name	Type	Description
`state`*	`InvokeStateParameter<Types>`	The initial state for the agent execution. Can be: An object containing `messages` array and any middleware-specific state properties A Command object for more advanced control flow
`config`	`InvokeConfiguration<InferContextInput<Types["Context"] extends InteropZodObject \| AnyAnnotationRoot ? any[any] : AnyAnnotationRoot> & InferMiddlewareContextInputs<Types["Middleware"]>>`	Optional runtime configuration including:

Example

const agent = new ReactAgent({
  llm: myModel,
  tools: [calculator, webSearch],
  responseFormat: z.object({
    weather: z.string(),
  }),
});

const result = await agent.invoke({
  messages: [{ role: "human", content: "What's the weather in Paris?" }]
});

console.log(result.structuredResponse.weather); // outputs: "It's sunny and 75°F."

View source on GitHub

invoke

Parameters

Example

LangChain Assistant

Menu

invoke

Parameters

Example