feat: enable setting langgraph config from ui (CopilotKit#1704)

Author: ranst91

CopilotKit/.changeset/modern-colts-trade.md

@@ -0,0 +1,7 @@
+---
+"@copilotkit/react-core": patch
+"@copilotkit/runtime": patch
+---
+
+- feat: enable setting langgraph config from ui
+- chore: document usage of new config

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

@@ -353,7 +353,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 ?? {}),
+              config: JSON.stringify(state.config ?? {}),
             })),
             forwardedParameters: options.forwardedParameters || {},
           },

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

@@ -103,41 +103,40 @@ import { useToast } from "../components/toast/toast-provider";
 import { useCopilotRuntimeClient } from "./use-copilot-runtime-client";
 import { parseJson } from "@copilotkit/shared";
 
-interface WithInternalStateManagementAndInitial<T> {
+interface UseCoagentOptionsBase {
   /**
    * The name of the agent being used.
    */
   name: string;
   /**
-   * The initial state of the agent.
+   * @deprecated - use "config.configurable"
+   * Config to pass to a LangGraph Agent
    */
-  initialState: T;
+  configurable?: Record<string, any>;
   /**
    * Config to pass to a LangGraph Agent
    */
-  configurable?: Record<string, any>;
+  config?: {
+    configurable?: Record<string, any>;
+    [key: string]: any;
+  };
 }
 
-interface WithInternalStateManagement {
+interface WithInternalStateManagementAndInitial<T> extends UseCoagentOptionsBase {
   /**
-   * The name of the agent being used.
+   * The initial state of the agent.
    */
-  name: string;
+  initialState: T;
+}
+
+interface WithInternalStateManagement extends UseCoagentOptionsBase {
   /**
    * Optional initialState with default type any
    */
   initialState?: any;
-  /**
-   * Config to pass to a LangGraph Agent
-   */
-  configurable?: Record<string, any>;
 }
 
-interface WithExternalStateManagement<T> {
-  /**
-   * The name of the agent being used.
-   */
-  name: string;
+interface WithExternalStateManagement<T> extends UseCoagentOptionsBase {
   /**
    * The current state of the agent.
    */
@@ -146,10 +145,6 @@ 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> =
@@ -416,7 +411,11 @@ const getCoagentState = <T>({
     return {
       name,
       state: isInternalStateManagementWithInitial<T>(options) ? options.initialState : {},
-      configurable: options.configurable ?? {},
+      config: options.config
+        ? options.config
+        : options.configurable
+          ? { configurable: options.configurable }
+          : {},
       running: false,
       active: false,
       threadId: undefined,

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

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

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

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

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

@@ -57,12 +57,12 @@ export function constructLGCRemoteAction({
       });
 
       let state = {};
-      let configurable = {};
+      let config = {};
       if (agentStates) {
         const jsonState = agentStates.find((state) => state.agentName === name);
         if (jsonState) {
           state = parseJson(jsonState.state, {});
-          configurable = parseJson(jsonState.configurable, {});
+          config = parseJson(jsonState.config, {});
         }
       }
 
@@ -76,7 +76,7 @@ export function constructLGCRemoteAction({
           nodeName,
           messages: [...messages, ...additionalMessages],
           state,
-          configurable,
+          config,
           properties: graphqlContext.properties,
           actions: tryMap(actionInputsWithoutAgents, (action: ActionInput) => ({
             name: action.name,
@@ -206,12 +206,12 @@ export function constructRemoteActions({
           });
 
           let state = {};
-          let configurable = {};
+          let config = {};
           if (agentStates) {
             const jsonState = agentStates.find((state) => state.agentName === name);
             if (jsonState) {
               state = parseJson(jsonState.state, {});
-              configurable = parseJson(jsonState.configurable, {});
+              config = parseJson(jsonState.config, {});
             }
           }
 
@@ -226,7 +226,7 @@ export function constructRemoteActions({
                 nodeName,
                 messages: [...messages, ...additionalMessages],
                 state,
-                configurable,
+                config,
                 properties: graphqlContext.properties,
                 actions: tryMap(actionInputsWithoutAgents, (action: ActionInput) => ({
                   name: action.name,

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

@@ -26,7 +26,10 @@ interface ExecutionArgs extends Omit<LangGraphPlatformEndpoint, "agents"> {
   nodeName: string;
   messages: Message[];
   state: State;
-  configurable?: Record<string, any>;
+  config?: {
+    configurable?: Record<string, any>;
+    [key: string]: any;
+  };
   properties: CopilotRequestContextProperties;
   actions: ExecutionAction[];
   logger: Logger;
@@ -119,7 +122,7 @@ async function streamEvents(controller: ReadableStreamDefaultController, args: E
     agent,
     nodeName: initialNodeName,
     state: initialState,
-    configurable,
+    config: explicitConfig,
     messages,
     actions,
     logger,
@@ -234,11 +237,40 @@ async function streamEvents(controller: ReadableStreamDefaultController, args: E
   const graphInfo = await client.assistants.getGraph(assistantId);
   const graphSchema = await client.assistants.getSchemas(assistantId);
   const schemaKeys = getSchemaKeys(graphSchema);
-  if (configurable) {
-    const filteredConfigurable = schemaKeys?.config
-      ? filterObjectBySchemaKeys(configurable, schemaKeys?.config)
-      : configurable;
-    await client.assistants.update(assistantId, { config: { configurable: filteredConfigurable } });
+
+  if (explicitConfig) {
+    let filteredConfigurable = retrievedAssistant.config.configurable;
+    if (explicitConfig.configurable) {
+      filteredConfigurable = schemaKeys?.config
+        ? filterObjectBySchemaKeys(explicitConfig?.configurable, schemaKeys?.config)
+        : explicitConfig?.configurable;
+    }
+
+    const newConfig = {
+      ...retrievedAssistant.config,
+      ...explicitConfig,
+      configurable: filteredConfigurable,
+    };
+
+    // LG does not return recursion limit if it's the default, therefore we check: if no recursion limit is currently set, and the user asked for 25, there is no change.
+    const isRecursionLimitSetToDefault =
+      retrievedAssistant.config.recursion_limit == null && explicitConfig.recursion_limit === 25;
+    // Deep compare configs to avoid unnecessary update calls
+    const configsAreDifferent =
+      JSON.stringify(newConfig) !== JSON.stringify(retrievedAssistant.config);
+
+    // Check if the only difference is the recursion_limit being set to default
+    const isOnlyRecursionLimitDifferent =
+      isRecursionLimitSetToDefault &&
+      JSON.stringify({ ...newConfig, recursion_limit: null }) ===
+        JSON.stringify({ ...retrievedAssistant.config, recursion_limit: null });
+
+    // If configs are different, we further check: Is the only diff a request to set the recursion limit to its already default?
+    if (configsAreDifferent && !isOnlyRecursionLimitDifferent) {
+      await client.assistants.update(assistantId, {
+        config: newConfig,
+      });
+    }
   }
 
   // Do not input keys that are not part of the input schema

docs/content/docs/coagents/advanced/adding-runtime-configuration.mdx

@@ -31,9 +31,12 @@ function YourMainContent() {
 
   useCoAgent<AgentState>({
     name: "sample_agent",
-    // [!code highlight:4]
-    configurable: {
-      authToken: 'example-token'
+    // [!code highlight:7]
+    config: {
+      configurable: {
+        authToken: 'example-token'
+      },
+      recursion_limit: 50,
     }
   })
 

sdk-python/copilotkit/agent.py

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

sdk-python/copilotkit/integrations/fastapi.py

@@ -193,7 +193,7 @@ async def handler_v1(
     if method == 'POST' and path == 'agents/execute':
         thread_id = body.get("threadId")
         node_name = body.get("nodeName")
-        configurable = body.get("configurable")
+        config = body.get("config")
 
         name = body_get_or_raise(body, "name")
         state = body_get_or_raise(body, "state")
@@ -208,7 +208,7 @@ async def handler_v1(
             node_name=node_name,
             name=name,
             state=state,
-            configurable=configurable,
+            config=config,
             messages=messages,
             actions=actions,
             meta_events=meta_events,
@@ -273,7 +273,7 @@ def handle_execute_agent( # pylint: disable=too-many-arguments
         thread_id: str,
         name: str,
         state: dict,
-        configurable: Optional[dict] = None,
+        config: Optional[dict] = None,
         messages: List[Message],
         actions: List[ActionDict],
         node_name: str,
@@ -287,7 +287,7 @@ def handle_execute_agent( # pylint: disable=too-many-arguments
             name=name,
             node_name=node_name,
             state=state,
-            configurable=configurable,
+            config=config,
             messages=messages,
             actions=actions,
             meta_events=meta_events,