@copilotkit/runtime 1.1.3-feat-runtime-remote-actions.2 → 1.2.1

package/src/agents/langgraph/events.ts

@@ -1,309 +0,0 @@
-export enum LangGraphEventTypes {
-  OnChainStart = "on_chain_start",
-  OnChainStream = "on_chain_stream",
-  OnChainEnd = "on_chain_end",
-  OnChatModelStart = "on_chat_model_start",
-  OnChatModelStream = "on_chat_model_stream",
-  OnChatModelEnd = "on_chat_model_end",
-  OnToolStart = "on_tool_start",
-  OnToolEnd = "on_tool_end",
-  OnCopilotKitStateSync = "on_copilotkit_state_sync",
-}
-
-type LangGraphOnCopilotKitStateSyncEvent = {
-  event: LangGraphEventTypes.OnCopilotKitStateSync;
-  thread_id: string;
-  agent_name: string;
-  node_name: string;
-  run_id: string;
-  active: boolean;
-  role: string;
-  state: any;
-  running: boolean;
-};
-
-type LangGraphOnChainStartEvent = {
-  event: LangGraphEventTypes.OnChainStart;
-  run_id: string;
-  name: string;
-  tags: string[];
-  metadata: { thread_id: string };
-  data: {
-    input: any;
-  };
-  parent_ids: string[];
-};
-
-type LangGraphOnChainEndEvent = {
-  event: LangGraphEventTypes.OnChainEnd;
-  name: string;
-  run_id: string;
-  tags: string[];
-  metadata: {
-    thread_id: string;
-    langgraph_step: number;
-    langgraph_node: string;
-    langgraph_triggers: string[];
-    langgraph_task_idx: number;
-    thread_ts: string;
-  };
-  data: {
-    input: any;
-    output: any;
-  };
-  parent_ids: string[];
-};
-
-type LangGraphOnChatModelStartEvent = {
-  event: LangGraphEventTypes.OnChatModelStart;
-  name: string;
-  run_id: string;
-  tags: string[];
-  metadata: {
-    thread_id: string;
-    langgraph_step: number;
-    langgraph_node: string;
-    langgraph_triggers: string[];
-    langgraph_task_idx: number;
-    thread_ts: string;
-    ls_provider: string;
-    ls_model_name: string;
-    ls_model_type: string;
-    ls_temperature: number;
-  };
-  data: {
-    input: {
-      messages: {
-        lc: number;
-        type: string;
-        id: string[];
-        kwargs: {
-          content: string;
-          type: string;
-          id: string;
-        };
-      }[][];
-    };
-  };
-  parent_ids: string[];
-};
-
-type LangGraphOnChatModelStreamEvent = {
-  event: LangGraphEventTypes.OnChatModelStream;
-  name: string;
-  run_id: string;
-  tags: string[];
-  metadata: {
-    thread_id: string;
-    langgraph_step: number;
-    langgraph_node: string;
-    langgraph_triggers: string[];
-    langgraph_task_idx: number;
-    thread_ts: string;
-    ls_provider: string;
-    ls_model_name: string;
-    ls_model_type: string;
-    ls_temperature: number;
-  };
-  data: {
-    chunk: {
-      lc: number;
-      type: string;
-      id: string[];
-      kwargs: {
-        content: string;
-        additional_kwargs: {
-          tool_calls: {
-            index: number;
-            id: string;
-            function: { arguments: string; name: string };
-            type: string;
-          }[];
-        };
-        type: string;
-        id: string;
-        tool_calls: { name: string; args: {}; id: string; type: string }[];
-        tool_call_chunks: {
-          name: string;
-          args: string;
-          id: string;
-          index: number;
-          type: string;
-        }[];
-        invalid_tool_calls: any[];
-      };
-    };
-  };
-  parent_ids: string[];
-};
-
-type LangGraphOnChatModelEndEvent = {
-  event: LangGraphEventTypes.OnChatModelEnd;
-  name: string;
-  run_id: string;
-  tags: string[];
-  metadata: {
-    thread_id: string;
-    langgraph_step: number;
-    langgraph_node: string;
-    langgraph_triggers: string[];
-    langgraph_task_idx: number;
-    thread_ts: string;
-    ls_provider: string;
-    ls_model_name: string;
-    ls_model_type: string;
-    ls_temperature: number;
-  };
-  data: {
-    input: any;
-    output: {
-      generations: {
-        text: string;
-        generation_info: {
-          finish_reason: string;
-          model_name: string;
-          system_fingerprint: string;
-        };
-        type: string;
-        message: {
-          lc: number;
-          type: string;
-          id: string[];
-          kwargs: {
-            content: string;
-            additional_kwargs: {
-              tool_calls: {
-                index: number;
-                id: string;
-                function: { arguments: string; name: string };
-                type: string;
-              }[];
-            };
-            response_metadata: {
-              finish_reason: string;
-              model_name: string;
-              system_fingerprint: string;
-            };
-            type: string;
-            id: string;
-            tool_calls: { name: string; args: { query: string }; id: string; type: string }[];
-            invalid_tool_calls: any[];
-          };
-        };
-      }[][];
-      llm_output: any;
-      run: any;
-    };
-  };
-  parent_ids: string[];
-};
-
-type LangGraphOnChainStreamEvent = {
-  event: LangGraphEventTypes.OnChainStream;
-  name: string;
-  run_id: string;
-  tags: string[];
-  metadata: {
-    thread_id: string;
-    langgraph_step?: number;
-    langgraph_node?: string;
-    langgraph_triggers?: string[];
-    langgraph_task_idx?: number;
-    thread_ts?: string;
-  };
-  data: {
-    chunk: {
-      messages: {
-        lc: number;
-        type: string;
-        id: string[];
-        kwargs: {
-          content: string;
-          additional_kwargs?: {
-            tool_calls?: {
-              index: number;
-              id: string;
-              function: { arguments: string; name: string };
-              type: string;
-            }[];
-          };
-          response_metadata?: {
-            finish_reason: string;
-            model_name: string;
-            system_fingerprint: string;
-          };
-          type: string;
-          id: string;
-          tool_calls?: { name: string; args: { query: string }; id: string; type: string }[];
-          invalid_tool_calls?: any[];
-        };
-      }[];
-    };
-  };
-  parent_ids: string[];
-};
-
-type LangGraphOnToolStartEvent = {
-  event: LangGraphEventTypes.OnToolStart;
-  name: string;
-  run_id: string;
-  tags: string[];
-  metadata: {
-    thread_id: string;
-    langgraph_step: number;
-    langgraph_node: string;
-    langgraph_triggers: string[];
-    langgraph_task_idx: number;
-    thread_ts: string;
-  };
-  data: {
-    input: {
-      query: string;
-    };
-  };
-  parent_ids: string[];
-};
-
-type LangGraphOnToolEndEvent = {
-  event: LangGraphEventTypes.OnToolEnd;
-  name: string;
-  run_id: string;
-  tags: string[];
-  metadata: {
-    thread_id: string;
-    langgraph_step: number;
-    langgraph_node: string;
-    langgraph_triggers: string[];
-    langgraph_task_idx: number;
-    thread_ts: string;
-  };
-  data: {
-    input: {
-      query: string;
-    };
-    output: {
-      lc: number;
-      type: string;
-      id: string[];
-      kwargs: {
-        content: string[];
-        type: string;
-        name: string;
-        tool_call_id: string;
-        status: string;
-      };
-    };
-  };
-  parent_ids: string[];
-};
-
-export type LangGraphEvent =
-  | LangGraphOnChainStartEvent
-  | LangGraphOnChainStreamEvent
-  | LangGraphOnChainEndEvent
-  | LangGraphOnChatModelStartEvent
-  | LangGraphOnChatModelStreamEvent
-  | LangGraphOnChatModelEndEvent
-  | LangGraphOnToolStartEvent
-  | LangGraphOnToolEndEvent
-  | LangGraphOnCopilotKitStateSyncEvent;

package/src/graphql/inputs/agent-session.input.ts

@@ -1,13 +0,0 @@
-import { Field, InputType } from "type-graphql";
-
-@InputType()
-export class AgentSessionInput {
-  @Field(() => String)
-  agentName: string;
-
-  @Field(() => String, { nullable: true })
-  threadId?: string;
-
-  @Field(() => String, { nullable: true })
-  nodeName?: string;
-}

package/src/graphql/inputs/agent-state.input.ts

@@ -1,10 +0,0 @@
-import { Field, InputType } from "type-graphql";
-
-@InputType()
-export class AgentStateInput {
-  @Field(() => String)
-  agentName: string;
-
-  @Field(() => String)
-  state: string;
-}

package/src/lib/runtime/copilot-runtime.ts

@@ -1,360 +0,0 @@
-/**
- * <Callout type="info">
- *   This is the reference for the `CopilotRuntime` class. For more information and example code snippets, please see [Concept: Copilot Runtime](/concepts/copilot-runtime).
- * </Callout>
- *
- * ## Usage
- *
- * ```tsx
- * import { CopilotRuntime } from "@copilotkit/runtime";
- *
- * const copilotKit = new CopilotRuntime();
- * ```
- */
-
-import { Action, actionParametersToJsonSchema, Parameter, randomId } from "@copilotkit/shared";
-import { RemoteChain, RemoteChainParameters, CopilotServiceAdapter } from "../../service-adapters";
-import { MessageInput } from "../../graphql/inputs/message.input";
-import { ActionInput } from "../../graphql/inputs/action.input";
-import { RuntimeEventSource } from "../../service-adapters/events";
-import { convertGqlInputToMessages } from "../../service-adapters/conversion";
-import { AgentStateMessage, Message } from "../../graphql/types/converted";
-import { ForwardedParametersInput } from "../../graphql/inputs/forwarded-parameters.input";
-import {
-  setupRemoteActions,
-  RemoteActionDefinition,
-  LangGraphAgentAction,
-  isLangGraphAgentAction,
-} from "./remote-actions";
-import { GraphQLContext } from "../integrations/shared";
-import { AgentSessionInput } from "../../graphql/inputs/agent-session.input";
-import { from } from "rxjs";
-import { AgentStateInput } from "../../graphql/inputs/agent-state.input";
-
-interface CopilotRuntimeRequest {
-  serviceAdapter: CopilotServiceAdapter;
-  messages: MessageInput[];
-  actions: ActionInput[];
-  agentSession?: AgentSessionInput;
-  agentStates?: AgentStateInput[];
-  outputMessagesPromise: Promise<Message[]>;
-  threadId?: string;
-  runId?: string;
-  publicApiKey?: string;
-  graphqlContext: GraphQLContext;
-  forwardedParameters?: ForwardedParametersInput;
-  url?: string;
-}
-
-interface CopilotRuntimeResponse {
-  threadId: string;
-  runId?: string;
-  eventSource: RuntimeEventSource;
-  serverSideActions: Action<any>[];
-  actionInputsWithoutAgents: ActionInput[];
-}
-
-type ActionsConfiguration<T extends Parameter[] | [] = []> =
-  | Action<T>[]
-  | ((ctx: { properties: any; url?: string }) => Action<T>[]);
-
-interface OnBeforeRequestOptions {
-  threadId?: string;
-  runId?: string;
-  inputMessages: Message[];
-  properties: any;
-  url?: string;
-}
-
-type OnBeforeRequestHandler = (options: OnBeforeRequestOptions) => void | Promise<void>;
-
-interface OnAfterRequestOptions {
-  threadId: string;
-  runId?: string;
-  inputMessages: Message[];
-  outputMessages: Message[];
-  properties: any;
-  url?: string;
-}
-
-type OnAfterRequestHandler = (options: OnAfterRequestOptions) => void | Promise<void>;
-
-interface Middleware {
-  /**
-   * A function that is called before the request is processed.
-   */
-  onBeforeRequest?: OnBeforeRequestHandler;
-
-  /**
-   * A function that is called after the request is processed.
-   */
-  onAfterRequest?: OnAfterRequestHandler;
-}
-
-export interface CopilotRuntimeConstructorParams<T extends Parameter[] | [] = []> {
-  /**
-   * Middleware to be used by the runtime.
-   *
-   * ```ts
-   * onBeforeRequest: (options: {
-   *   threadId?: string;
-   *   runId?: string;
-   *   inputMessages: Message[];
-   *   properties: any;
-   * }) => void | Promise<void>;
-   * ```
-   *
-   * ```ts
-   * onAfterRequest: (options: {
-   *   threadId?: string;
-   *   runId?: string;
-   *   inputMessages: Message[];
-   *   outputMessages: Message[];
-   *   properties: any;
-   * }) => void | Promise<void>;
-   * ```
-   */
-  middleware?: Middleware;
-
-  /*
-   * A list of server side actions that can be executed.
-   */
-  actions?: ActionsConfiguration<T>;
-
-  /*
-   * A list of remote actions that can be executed.
-   */
-  remoteActions?: RemoteActionDefinition[];
-
-  /*
-   * An array of LangServer URLs.
-   */
-  langserve?: RemoteChainParameters[];
-}
-
-export class CopilotRuntime<const T extends Parameter[] | [] = []> {
-  public actions: ActionsConfiguration<T>;
-  private remoteActionDefinitions: RemoteActionDefinition[];
-  private langserve: Promise<Action<any>>[] = [];
-  private onBeforeRequest?: OnBeforeRequestHandler;
-  private onAfterRequest?: OnAfterRequestHandler;
-
-  constructor(params?: CopilotRuntimeConstructorParams<T>) {
-    this.actions = params?.actions || [];
-
-    for (const chain of params?.langserve || []) {
-      const remoteChain = new RemoteChain(chain);
-      this.langserve.push(remoteChain.toAction());
-    }
-
-    this.remoteActionDefinitions = params?.remoteActions || [];
-
-    this.onBeforeRequest = params?.middleware?.onBeforeRequest;
-    this.onAfterRequest = params?.middleware?.onAfterRequest;
-  }
-
-  async processRuntimeRequest(request: CopilotRuntimeRequest): Promise<CopilotRuntimeResponse> {
-    const {
-      serviceAdapter,
-      messages: rawMessages,
-      actions: clientSideActionsInput,
-      threadId,
-      runId,
-      outputMessagesPromise,
-      graphqlContext,
-      forwardedParameters,
-      agentSession,
-      url,
-    } = request;
-
-    if (agentSession) {
-      return this.processAgentRequest(request);
-    }
-
-    const messages = rawMessages.filter((message) => !message.agentStateMessage);
-
-    const inputMessages = convertGqlInputToMessages(messages);
-    const serverSideActions = await this.getServerSideActions(request);
-
-    const serverSideActionsInput: ActionInput[] = serverSideActions.map((action) => ({
-      name: action.name,
-      description: action.description,
-      jsonSchema: JSON.stringify(actionParametersToJsonSchema(action.parameters)),
-    }));
-
-    const actionInputs = flattenToolCallsNoDuplicates([
-      ...serverSideActionsInput,
-      ...clientSideActionsInput,
-    ]);
-
-    await this.onBeforeRequest?.({
-      threadId,
-      runId,
-      inputMessages,
-      properties: graphqlContext.properties,
-      url,
-    });
-
-    try {
-      const eventSource = new RuntimeEventSource();
-
-      const result = await serviceAdapter.process({
-        messages: inputMessages,
-        actions: actionInputs,
-        threadId,
-        runId,
-        eventSource,
-        forwardedParameters,
-      });
-
-      outputMessagesPromise
-        .then((outputMessages) => {
-          this.onAfterRequest?.({
-            threadId: result.threadId,
-            runId: result.runId,
-            inputMessages,
-            outputMessages,
-            properties: graphqlContext.properties,
-            url,
-          });
-        })
-        .catch((_error) => {});
-
-      return {
-        threadId: result.threadId,
-        runId: result.runId,
-        eventSource,
-        serverSideActions,
-        actionInputsWithoutAgents: actionInputs.filter(
-          (action) =>
-            // TODO-AGENTS: do not exclude ALL server side actions
-            !serverSideActions.find((serverSideAction) => serverSideAction.name == action.name),
-          // !isLangGraphAgentAction(
-          //   serverSideActions.find((serverSideAction) => serverSideAction.name == action.name),
-          // ),
-        ),
-      };
-    } catch (error) {
-      console.error("Error getting response:", error);
-      throw error;
-    }
-  }
-
-  private async processAgentRequest(
-    request: CopilotRuntimeRequest,
-  ): Promise<CopilotRuntimeResponse> {
-    const { messages: rawMessages, outputMessagesPromise, graphqlContext, agentSession } = request;
-    const { threadId = randomId(), agentName, nodeName } = agentSession;
-    const serverSideActions = await this.getServerSideActions(request);
-
-    const messages = convertGqlInputToMessages(rawMessages);
-
-    const agent = serverSideActions.find(
-      (action) => action.name === agentName && isLangGraphAgentAction(action),
-    ) as LangGraphAgentAction;
-
-    if (!agent) {
-      throw new Error(`Agent ${agentName} not found`);
-    }
-
-    const serverSideActionsInput: ActionInput[] = serverSideActions
-      .filter((action) => !isLangGraphAgentAction(action))
-      .map((action) => ({
-        name: action.name,
-        description: action.description,
-        jsonSchema: JSON.stringify(actionParametersToJsonSchema(action.parameters)),
-      }));
-
-    const actionInputsWithoutAgents = flattenToolCallsNoDuplicates([
-      ...serverSideActionsInput,
-      ...request.actions,
-    ]);
-
-    await this.onBeforeRequest?.({
-      threadId,
-      runId: undefined,
-      inputMessages: messages,
-      properties: graphqlContext.properties,
-    });
-    try {
-      const eventSource = new RuntimeEventSource();
-      const stream = await agent.langGraphAgentHandler({
-        name: agentName,
-        threadId,
-        nodeName,
-        actionInputsWithoutAgents,
-      });
-
-      eventSource.stream(async (eventStream$) => {
-        from(stream).subscribe({
-          next: (event) => eventStream$.next(event),
-          error: (err) => console.error("Error in stream", err),
-          complete: () => eventStream$.complete(),
-        });
-      });
-
-      outputMessagesPromise
-        .then((outputMessages) => {
-          this.onAfterRequest?.({
-            threadId,
-            runId: undefined,
-            inputMessages: messages,
-            outputMessages,
-            properties: graphqlContext.properties,
-          });
-        })
-        .catch((_error) => {});
-
-      return {
-        threadId,
-        runId: undefined,
-        eventSource,
-        serverSideActions: [],
-        actionInputsWithoutAgents,
-      };
-    } catch (error) {
-      console.error("Error getting response:", error);
-      throw error;
-    }
-  }
-
-  private async getServerSideActions(request: CopilotRuntimeRequest): Promise<Action<any>[]> {
-    const { messages: rawMessages, graphqlContext, agentStates, url } = request;
-    const inputMessages = convertGqlInputToMessages(rawMessages);
-    const langserveFunctions: Action<any>[] = [];
-
-    for (const chainPromise of this.langserve) {
-      try {
-        const chain = await chainPromise;
-        langserveFunctions.push(chain);
-      } catch (error) {
-        console.error("Error loading langserve chain:", error);
-      }
-    }
-    const remoteActions = await setupRemoteActions({
-      remoteActionDefinitions: this.remoteActionDefinitions,
-      graphqlContext,
-      messages: inputMessages,
-      agentStates,
-    });
-
-    const configuredActions =
-      typeof this.actions === "function"
-        ? this.actions({ properties: graphqlContext.properties, url })
-        : this.actions;
-
-    return [...configuredActions, ...langserveFunctions, ...remoteActions];
-  }
-}
-
-export function flattenToolCallsNoDuplicates(toolsByPriority: ActionInput[]): ActionInput[] {
-  let allTools: ActionInput[] = [];
-  const allToolNames: string[] = [];
-  for (const tool of toolsByPriority) {
-    if (!allToolNames.includes(tool.name)) {
-      allTools.push(tool);
-      allToolNames.push(tool.name);
-    }
-  }
-  return allTools;
-}