feat(configurable): execute langgraph with user config (CopilotKit#1376)

Author: ranst91

CopilotKit/.changeset/polite-falcons-melt.md

@@ -0,0 +1,6 @@
+---
+"@copilotkit/react-core": minor
+"@copilotkit/runtime": minor
+---
+
+- feat(configurable): execute langgraph with user config

CopilotKit/packages/react-core/src/hooks/use-chat.ts

@@ -318,6 +318,7 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
             agentStates: Object.values(coagentStatesRef.current!).map((state) => ({
               agentName: state.name,
               state: JSON.stringify(state.state),
+              configurable: JSON.stringify(state.configurable ?? {}),
             })),
             forwardedParameters: options.forwardedParameters || {},
           },

CopilotKit/packages/react-core/src/hooks/use-coagent.ts

@@ -111,6 +111,10 @@ interface WithInternalStateManagementAndInitial<T> {
    * The initial state of the agent.
    */
   initialState: T;
+  /**
+   * Config to pass to a LangGraph Agent
+   */
+  configurable?: Record<string, any>;
 }
 
 interface WithInternalStateManagement {
@@ -122,6 +126,10 @@ interface WithInternalStateManagement {
    * Optional initialState with default type any
    */
   initialState?: any;
+  /**
+   * Config to pass to a LangGraph Agent
+   */
+  configurable?: Record<string, any>;
 }
 
 interface WithExternalStateManagement<T> {
@@ -137,6 +145,10 @@ interface WithExternalStateManagement<T> {
    * A function to update the state of the agent.
    */
   setState: (newState: T | ((prevState: T | undefined) => T)) => void;
+  /**
+   * Config to pass to a LangGraph Agent
+   */
+  configurable?: Record<string, any>;
 }
 
 type UseCoagentOptions<T> =
@@ -244,6 +256,7 @@ export function useCoAgent<T = any>(options: UseCoagentOptions<T>): UseCoagentRe
       return {
         name,
         state: isInternalStateManagementWithInitial(options) ? options.initialState : {},
+        configurable: options.configurable ?? {},
         running: false,
         active: false,
         threadId: undefined,

CopilotKit/packages/react-core/src/types/coagent-state.ts

@@ -4,6 +4,7 @@ export interface CoagentState {
   running: boolean;
   active: boolean;
   threadId?: string;
+  configurable?: Record<string, any>;
   nodeName?: string;
   runId?: string;
 }

CopilotKit/packages/runtime/src/graphql/inputs/agent-state.input.ts

@@ -7,4 +7,7 @@ export class AgentStateInput {
 
   @Field(() => String)
   state: string;
+
+  @Field(() => String, { nullable: true })
+  configurable?: string;
 }

CopilotKit/packages/runtime/src/lib/runtime/remote-action-constructors.ts

@@ -55,10 +55,12 @@ export function constructLGCRemoteAction({
       });
 
       let state = {};
+      let configurable = {};
       if (agentStates) {
-        const jsonState = agentStates.find((state) => state.agentName === name)?.state;
+        const jsonState = agentStates.find((state) => state.agentName === name);
         if (jsonState) {
-          state = JSON.parse(jsonState);
+          state = JSON.parse(jsonState.state);
+          configurable = JSON.parse(jsonState.configurable);
         }
       }
 
@@ -72,6 +74,7 @@ export function constructLGCRemoteAction({
           nodeName,
           messages: [...messages, ...additionalMessages],
           state,
+          configurable,
           properties: graphqlContext.properties,
           actions: actionInputsWithoutAgents.map((action) => ({
             name: action.name,
@@ -196,10 +199,12 @@ export function constructRemoteActions({
           });
 
           let state = {};
+          let configurable = {};
           if (agentStates) {
-            const jsonState = agentStates.find((state) => state.agentName === name)?.state;
+            const jsonState = agentStates.find((state) => state.agentName === name);
             if (jsonState) {
-              state = JSON.parse(jsonState);
+              state = JSON.parse(jsonState.state);
+              configurable = JSON.parse(jsonState.configurable);
             }
           }
 
@@ -214,6 +219,7 @@ export function constructRemoteActions({
                 nodeName,
                 messages: [...messages, ...additionalMessages],
                 state,
+                configurable,
                 properties: graphqlContext.properties,
                 actions: actionInputsWithoutAgents.map((action) => ({
                   name: action.name,

CopilotKit/packages/runtime/src/lib/runtime/remote-lg-action.ts

@@ -24,6 +24,7 @@ interface ExecutionArgs extends Omit<LangGraphPlatformEndpoint, "agents"> {
   nodeName: string;
   messages: Message[];
   state: State;
+  configurable?: Record<string, any>;
   properties: CopilotRequestContextProperties;
   actions: ExecutionAction[];
   logger: Logger;
@@ -87,6 +88,7 @@ async function streamEvents(controller: ReadableStreamDefaultController, args: E
     agent,
     nodeName: initialNodeName,
     state: initialState,
+    configurable,
     messages,
     actions,
     logger,
@@ -202,6 +204,9 @@ async function streamEvents(controller: ReadableStreamDefaultController, args: E
   }
   const assistantId = retrievedAssistant.assistant_id;
 
+  if (configurable) {
+    await client.assistants.update(assistantId, { config: { configurable } });
+  }
   const graphInfo = await client.assistants.getGraph(assistantId);
 
   let streamingStateExtractor = new StreamingStateExtractor([]);

sdk-python/copilotkit/agent.py

@@ -27,6 +27,7 @@ def execute( # pylint: disable=too-many-arguments
         self,
         *,
         state: dict,
+        configurable: Optional[dict] = None,
         messages: List[Message],
         thread_id: Optional[str] = None,
         node_name: Optional[str] = None,

sdk-python/copilotkit/integrations/fastapi.py

@@ -103,6 +103,7 @@ async def handler(request: Request, sdk: CopilotKitRemoteEndpoint):
     if method == 'POST' and path == 'agents/execute':
         thread_id = body.get("threadId")
         node_name = body.get("nodeName")
+        configurable = body.get("configurable")
 
         name = body_get_or_raise(body, "name")
         state = body_get_or_raise(body, "state")
@@ -117,6 +118,7 @@ async def handler(request: Request, sdk: CopilotKitRemoteEndpoint):
             node_name=node_name,
             name=name,
             state=state,
+            configurable=configurable,
             messages=messages,
             actions=actions,
             meta_events=meta_events,
@@ -174,6 +176,7 @@ def handle_execute_agent( # pylint: disable=too-many-arguments
         node_name: str,
         name: str,
         state: dict,
+        configurable: Optional[dict] = None,
         messages: List[Message],
         actions: List[ActionDict],
         meta_events: Optional[List[MetaEvent]] = None,
@@ -186,6 +189,7 @@ def handle_execute_agent( # pylint: disable=too-many-arguments
             name=name,
             node_name=node_name,
             state=state,
+            configurable=configurable,
             messages=messages,
             actions=actions,
             meta_events=meta_events,

sdk-python/copilotkit/langgraph_agent.py

@@ -217,6 +217,7 @@ def execute( # pylint: disable=too-many-arguments
         self,
         *,
         state: dict,
+        configurable: Optional[dict] = None,
         messages: List[Message],
         thread_id: Optional[str] = None,
         node_name: Optional[str] = None,
@@ -225,6 +226,7 @@ def execute( # pylint: disable=too-many-arguments
     ):
         return self._stream_events(
             state=state,
+            configurable=configurable,
             messages=messages,
             actions=actions,
             thread_id=thread_id,
@@ -236,6 +238,7 @@ async def _stream_events( # pylint: disable=too-many-locals
             self,
             *,
             state: Any,
+            configurable: Optional[dict] = None,
             messages: List[Message],
             thread_id: str,
             actions: Optional[List[ActionDict]] = None,
@@ -244,7 +247,7 @@ async def _stream_events( # pylint: disable=too-many-locals
         ):
 
         config = ensure_config(cast(Any, self.langgraph_config.copy()) if self.langgraph_config else {}) # pylint: disable=line-too-long
-        config["configurable"] = config.get("configurable", {})
+        config["configurable"] = {**config.get("configurable", {}), **(configurable or {})}
         config["configurable"]["thread_id"] = thread_id
 
         agent_state = await self.graph.aget_state(config)