@copilotkit/runtime 0.0.0-feat-dynamic-copilotcloud-qa-20250117190454

package/src/service-adapters/groq/groq-adapter.ts

@@ -0,0 +1,173 @@
+/**
+ * Copilot Runtime adapter for Groq.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import { CopilotRuntime, GroqAdapter } from "@copilotkit/runtime";
+ * import { Groq } from "groq-sdk";
+ *
+ * const groq = new Groq({ apiKey: process.env["GROQ_API_KEY"] });
+ *
+ * const copilotKit = new CopilotRuntime();
+ *
+ * return new GroqAdapter({ groq, model: "<model-name>" });
+ * ```
+ */
+import { Groq } from "groq-sdk";
+import {
+  CopilotServiceAdapter,
+  CopilotRuntimeChatCompletionRequest,
+  CopilotRuntimeChatCompletionResponse,
+} from "../service-adapter";
+import {
+  convertActionInputToOpenAITool,
+  convertMessageToOpenAIMessage,
+  limitMessagesToTokenCount,
+} from "../openai/utils";
+import { randomId } from "@copilotkit/shared";
+
+const DEFAULT_MODEL = "llama3-groq-70b-8192-tool-use-preview";
+
+export interface GroqAdapterParams {
+  /**
+   * An optional Groq instance to use.
+   */
+  groq?: Groq;
+
+  /**
+   * The model to use.
+   */
+  model?: string;
+
+  /**
+   * Whether to disable parallel tool calls.
+   * You can disable parallel tool calls to force the model to execute tool calls sequentially.
+   * This is useful if you want to execute tool calls in a specific order so that the state changes
+   * introduced by one tool call are visible to the next tool call. (i.e. new actions or readables)
+   *
+   * @default false
+   */
+  disableParallelToolCalls?: boolean;
+}
+
+export class GroqAdapter implements CopilotServiceAdapter {
+  private model: string = DEFAULT_MODEL;
+
+  private disableParallelToolCalls: boolean = false;
+  private _groq: Groq;
+  public get groq(): Groq {
+    return this._groq;
+  }
+
+  constructor(params?: GroqAdapterParams) {
+    this._groq = params?.groq || new Groq({});
+    if (params?.model) {
+      this.model = params.model;
+    }
+    this.disableParallelToolCalls = params?.disableParallelToolCalls || false;
+  }
+
+  async process(
+    request: CopilotRuntimeChatCompletionRequest,
+  ): Promise<CopilotRuntimeChatCompletionResponse> {
+    const {
+      threadId,
+      model = this.model,
+      messages,
+      actions,
+      eventSource,
+      forwardedParameters,
+    } = request;
+    const tools = actions.map(convertActionInputToOpenAITool);
+
+    let openaiMessages = messages.map(convertMessageToOpenAIMessage);
+    openaiMessages = limitMessagesToTokenCount(openaiMessages, tools, model);
+
+    let toolChoice: any = forwardedParameters?.toolChoice;
+    if (forwardedParameters?.toolChoice === "function") {
+      toolChoice = {
+        type: "function",
+        function: { name: forwardedParameters.toolChoiceFunctionName },
+      };
+    }
+    const stream = await this.groq.chat.completions.create({
+      model: model,
+      stream: true,
+      messages: openaiMessages,
+      ...(tools.length > 0 && { tools }),
+      ...(forwardedParameters?.maxTokens && {
+        max_tokens: forwardedParameters.maxTokens,
+      }),
+      ...(forwardedParameters?.stop && { stop: forwardedParameters.stop }),
+      ...(toolChoice && { tool_choice: toolChoice }),
+      ...(this.disableParallelToolCalls && { parallel_tool_calls: false }),
+      ...(forwardedParameters?.temperature && { temperature: forwardedParameters.temperature }),
+    });
+
+    eventSource.stream(async (eventStream$) => {
+      let mode: "function" | "message" | null = null;
+      let currentMessageId: string;
+      let currentToolCallId: string;
+
+      for await (const chunk of stream) {
+        const toolCall = chunk.choices[0].delta.tool_calls?.[0];
+        const content = chunk.choices[0].delta.content;
+
+        // When switching from message to function or vice versa,
+        // send the respective end event.
+        // If toolCall?.id is defined, it means a new tool call starts.
+        if (mode === "message" && toolCall?.id) {
+          mode = null;
+          eventStream$.sendTextMessageEnd({ messageId: currentMessageId });
+        } else if (mode === "function" && (toolCall === undefined || toolCall?.id)) {
+          mode = null;
+          eventStream$.sendActionExecutionEnd({ actionExecutionId: currentToolCallId });
+        }
+
+        // If we send a new message type, send the appropriate start event.
+        if (mode === null) {
+          if (toolCall?.id) {
+            mode = "function";
+            currentToolCallId = toolCall!.id;
+            eventStream$.sendActionExecutionStart({
+              actionExecutionId: currentToolCallId,
+              actionName: toolCall!.function!.name,
+              parentMessageId: chunk.id,
+            });
+          } else if (content) {
+            mode = "message";
+            currentMessageId = chunk.id;
+            eventStream$.sendTextMessageStart({ messageId: currentMessageId });
+          }
+        }
+
+        // send the content events
+        if (mode === "message" && content) {
+          eventStream$.sendTextMessageContent({
+            messageId: currentMessageId,
+            content,
+          });
+        } else if (mode === "function" && toolCall?.function?.arguments) {
+          eventStream$.sendActionExecutionArgs({
+            actionExecutionId: currentToolCallId,
+            args: toolCall.function.arguments,
+          });
+        }
+      }
+
+      // send the end events
+      if (mode === "message") {
+        eventStream$.sendTextMessageEnd({ messageId: currentMessageId });
+      } else if (mode === "function") {
+        eventStream$.sendActionExecutionEnd({ actionExecutionId: currentToolCallId });
+      }
+
+      eventStream$.complete();
+    });
+
+    return {
+      threadId: threadId || randomId(),
+    };
+  }
+}

package/src/service-adapters/index.ts

@@ -0,0 +1,16 @@
+export type {
+  CopilotRuntimeChatCompletionRequest,
+  CopilotRuntimeChatCompletionResponse,
+  CopilotServiceAdapter,
+} from "./service-adapter";
+export type { RemoteChainParameters } from "./langchain/langserve";
+export { RemoteChain } from "./langchain/langserve";
+export * from "./openai/openai-adapter";
+export * from "./langchain/langchain-adapter";
+export * from "./google/google-genai-adapter";
+export * from "./openai/openai-assistant-adapter";
+export * from "./unify/unify-adapter";
+export * from "./groq/groq-adapter";
+export * from "./anthropic/anthropic-adapter";
+export * from "./experimental/ollama/ollama-adapter";
+export * from "./experimental/empty/empty-adapter";

package/src/service-adapters/langchain/langchain-adapter.ts

@@ -0,0 +1,99 @@
+/**
+ * Copilot Runtime adapter for LangChain.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import { CopilotRuntime, LangChainAdapter } from "@copilotkit/runtime";
+ * import { ChatOpenAI } from "@langchain/openai";
+ *
+ * const copilotKit = new CopilotRuntime();
+ *
+ * const model = new ChatOpenAI({
+ *   model: "gpt-4o",
+ *   apiKey: "<your-api-key>",
+ * });
+ *
+ * return new LangChainAdapter({
+ *   chainFn: async ({ messages, tools }) => {
+ *     return model.bindTools(tools).stream(messages);
+ *     // or optionally enable strict mode
+ *     // return model.bindTools(tools, { strict: true }).stream(messages);
+ *   }
+ * });
+ * ```
+ *
+ * The asynchronous handler function (`chainFn`) can return any of the following:
+ *
+ * - A simple `string` response
+ * - A LangChain stream (`IterableReadableStream`)
+ * - A LangChain `BaseMessageChunk` object
+ * - A LangChain `AIMessage` object
+ */
+
+import { BaseMessage } from "@langchain/core/messages";
+import { CopilotServiceAdapter } from "../service-adapter";
+import {
+  CopilotRuntimeChatCompletionRequest,
+  CopilotRuntimeChatCompletionResponse,
+} from "../service-adapter";
+import {
+  convertActionInputToLangChainTool,
+  convertMessageToLangChainMessage,
+  streamLangChainResponse,
+} from "./utils";
+import { DynamicStructuredTool } from "@langchain/core/tools";
+import { LangChainReturnType } from "./types";
+import { randomId } from "@copilotkit/shared";
+import { awaitAllCallbacks } from "@langchain/core/callbacks/promises";
+
+interface ChainFnParameters {
+  model: string;
+  messages: BaseMessage[];
+  tools: DynamicStructuredTool[];
+  threadId?: string;
+  runId?: string;
+}
+
+interface LangChainAdapterOptions {
+  /**
+   * A function that uses the LangChain API to generate a response.
+   */
+  chainFn: (parameters: ChainFnParameters) => Promise<LangChainReturnType>;
+}
+
+export class LangChainAdapter implements CopilotServiceAdapter {
+  /**
+   * To use LangChain as a backend, provide a handler function to the adapter with your custom LangChain logic.
+   */
+  constructor(private options: LangChainAdapterOptions) {}
+
+  async process(
+    request: CopilotRuntimeChatCompletionRequest,
+  ): Promise<CopilotRuntimeChatCompletionResponse> {
+    try {
+      const { eventSource, model, actions, messages, runId } = request;
+      const threadId = request.threadId ?? randomId();
+      const result = await this.options.chainFn({
+        messages: messages.map(convertMessageToLangChainMessage),
+        tools: actions.map(convertActionInputToLangChainTool),
+        model,
+        threadId,
+        runId,
+      });
+
+      eventSource.stream(async (eventStream$) => {
+        await streamLangChainResponse({
+          result,
+          eventStream$,
+        });
+      });
+
+      return {
+        threadId,
+      };
+    } finally {
+      await awaitAllCallbacks();
+    }
+  }
+}

package/src/service-adapters/langchain/langserve.ts

@@ -0,0 +1,87 @@
+import { Parameter, Action } from "@copilotkit/shared";
+import { RemoteRunnable } from "langchain/runnables/remote";
+
+export interface RemoteChainParameters {
+  name: string;
+  description: string;
+  chainUrl: string;
+  parameters?: Parameter[];
+  parameterType?: "single" | "multi";
+}
+
+export class RemoteChain {
+  name: string;
+  description: string;
+  chainUrl: string;
+  parameters?: Parameter[];
+  parameterType: "single" | "multi";
+
+  constructor(options: RemoteChainParameters) {
+    this.name = options.name;
+    this.description = options.description;
+    this.chainUrl = options.chainUrl;
+    this.parameters = options.parameters;
+    this.parameterType = options.parameterType || "multi";
+  }
+
+  async toAction(): Promise<Action<any>> {
+    if (!this.parameters) {
+      await this.inferLangServeParameters();
+    }
+
+    return {
+      name: this.name,
+      description: this.description,
+      parameters: this.parameters!,
+      handler: async (args: any) => {
+        const runnable = new RemoteRunnable({ url: this.chainUrl });
+        let input: any;
+        if (this.parameterType === "single") {
+          input = args[Object.keys(args)[0]];
+        } else {
+          input = args;
+        }
+        return await runnable.invoke(input);
+      },
+    };
+  }
+
+  async inferLangServeParameters() {
+    const supportedTypes = ["string", "number", "boolean"];
+
+    let schemaUrl = this.chainUrl.replace(/\/+$/, "") + "/input_schema";
+    let schema = await fetch(schemaUrl)
+      .then((res) => res.json())
+      .catch(() => {
+        throw new Error("Failed to fetch langserve schema at " + schemaUrl);
+      });
+    // for now, don't use json schema, just do a simple conversion
+
+    if (supportedTypes.includes(schema.type)) {
+      this.parameterType = "single";
+      this.parameters = [
+        {
+          name: "input",
+          type: schema.type,
+          description: "The input to the chain",
+        },
+      ];
+    } else if (schema.type === "object") {
+      this.parameterType = "multi";
+      this.parameters = Object.keys(schema.properties).map((key) => {
+        let property = schema.properties[key];
+        if (!supportedTypes.includes(property.type)) {
+          throw new Error("Unsupported schema type");
+        }
+        return {
+          name: key,
+          type: property.type,
+          description: property.description || "",
+          required: schema.required?.includes(key) || false,
+        };
+      });
+    } else {
+      throw new Error("Unsupported schema type");
+    }
+  }
+}

package/src/service-adapters/langchain/types.ts

@@ -0,0 +1,14 @@
+import { AIMessage, AIMessageChunk, BaseMessageChunk } from "@langchain/core/messages";
+import {
+  IterableReadableStream,
+  IterableReadableStreamInterface,
+} from "@langchain/core/utils/stream";
+
+export type LangChainBaseMessageChunkStream = IterableReadableStream<BaseMessageChunk>;
+export type LangChainAIMessageChunkStream = IterableReadableStreamInterface<AIMessageChunk>;
+export type LangChainReturnType =
+  | LangChainBaseMessageChunkStream
+  | LangChainAIMessageChunkStream
+  | BaseMessageChunk
+  | string
+  | AIMessage;

package/src/service-adapters/langchain/utils.ts

@@ -0,0 +1,306 @@
+import {
+  ActionExecutionMessage,
+  Message,
+  ResultMessage,
+  TextMessage,
+} from "../../graphql/types/converted";
+import {
+  AIMessage,
+  AIMessageChunk,
+  BaseMessage,
+  BaseMessageChunk,
+  HumanMessage,
+  SystemMessage,
+  ToolMessage,
+} from "@langchain/core/messages";
+import { DynamicStructuredTool } from "@langchain/core/tools";
+import { z } from "zod";
+import { ActionInput } from "../../graphql/inputs/action.input";
+import { LangChainReturnType } from "./types";
+import { RuntimeEventSubject } from "../events";
+import { randomId, convertJsonSchemaToZodSchema } from "@copilotkit/shared";
+
+export function convertMessageToLangChainMessage(message: Message): BaseMessage {
+  if (message.isTextMessage()) {
+    if (message.role == "user") {
+      return new HumanMessage(message.content);
+    } else if (message.role == "assistant") {
+      return new AIMessage(message.content);
+    } else if (message.role === "system") {
+      return new SystemMessage(message.content);
+    }
+  } else if (message.isActionExecutionMessage()) {
+    return new AIMessage({
+      content: "",
+      tool_calls: [
+        {
+          id: message.id,
+          args: message.arguments,
+          name: message.name,
+        },
+      ],
+    });
+  } else if (message.isResultMessage()) {
+    return new ToolMessage({
+      content: message.result,
+      tool_call_id: message.actionExecutionId,
+    });
+  }
+}
+
+export function convertActionInputToLangChainTool(actionInput: ActionInput): any {
+  return new DynamicStructuredTool({
+    name: actionInput.name,
+    description: actionInput.description,
+    schema: convertJsonSchemaToZodSchema(
+      JSON.parse(actionInput.jsonSchema),
+      true,
+    ) as z.ZodObject<any>,
+    func: async () => {
+      return "";
+    },
+  });
+}
+
+interface StreamLangChainResponseParams {
+  result: LangChainReturnType;
+  eventStream$: RuntimeEventSubject;
+  actionExecution?: {
+    id: string;
+    name: string;
+  };
+}
+
+function getConstructorName(object: any): string {
+  if (object && typeof object === "object" && object.constructor && object.constructor.name) {
+    return object.constructor.name;
+  }
+  return "";
+}
+
+function isAIMessage(message: any): message is AIMessage {
+  return Object.prototype.toString.call(message) === "[object AIMessage]";
+}
+
+function isAIMessageChunk(message: any): message is AIMessageChunk {
+  return Object.prototype.toString.call(message) === "[object AIMessageChunk]";
+}
+
+function isBaseMessageChunk(message: any): message is BaseMessageChunk {
+  return Object.prototype.toString.call(message) === "[object BaseMessageChunk]";
+}
+
+function maybeSendActionExecutionResultIsMessage(
+  eventStream$: RuntimeEventSubject,
+  actionExecution?: { id: string; name: string },
+) {
+  // language models need a result after the function call
+  // we simply let them know that we are sending a message
+  if (actionExecution) {
+    eventStream$.sendActionExecutionResult({
+      actionExecutionId: actionExecution.id,
+      actionName: actionExecution.name,
+      result: "Sending a message",
+    });
+  }
+}
+
+export async function streamLangChainResponse({
+  result,
+  eventStream$,
+  actionExecution,
+}: StreamLangChainResponseParams) {
+  // We support several types of return values from LangChain functions:
+
+  // 1. string
+
+  if (typeof result === "string") {
+    if (!actionExecution) {
+      // Just send one chunk with the string as the content.
+      eventStream$.sendTextMessage(randomId(), result);
+    } else {
+      // Send as a result
+      eventStream$.sendActionExecutionResult({
+        actionExecutionId: actionExecution.id,
+        actionName: actionExecution.name,
+        result: result,
+      });
+    }
+  }
+
+  // 2. AIMessage
+  // Send the content and function call of the AIMessage as the content of the chunk.
+  else if (isAIMessage(result)) {
+    maybeSendActionExecutionResultIsMessage(eventStream$, actionExecution);
+
+    if (result.content) {
+      eventStream$.sendTextMessage(randomId(), result.content as string);
+    }
+    for (const toolCall of result.tool_calls) {
+      eventStream$.sendActionExecution({
+        actionExecutionId: toolCall.id || randomId(),
+        actionName: toolCall.name,
+        args: JSON.stringify(toolCall.args),
+      });
+    }
+  }
+
+  // 3. BaseMessageChunk
+  // Send the content and function call of the AIMessage as the content of the chunk.
+  else if (isBaseMessageChunk(result)) {
+    maybeSendActionExecutionResultIsMessage(eventStream$, actionExecution);
+
+    if (result.lc_kwargs?.content) {
+      eventStream$.sendTextMessage(randomId(), result.content as string);
+    }
+    if (result.lc_kwargs?.tool_calls) {
+      for (const toolCall of result.lc_kwargs?.tool_calls) {
+        eventStream$.sendActionExecution({
+          actionExecutionId: toolCall.id || randomId(),
+          actionName: toolCall.name,
+          args: JSON.stringify(toolCall.args),
+        });
+      }
+    }
+  }
+
+  // 4. IterableReadableStream
+  // Stream the result of the LangChain function.
+  else if (result && "getReader" in result) {
+    maybeSendActionExecutionResultIsMessage(eventStream$, actionExecution);
+
+    let reader = result.getReader();
+
+    let mode: "function" | "message" | null = null;
+    let currentMessageId: string;
+
+    const toolCallDetails = {
+      name: null,
+      id: null,
+      index: null,
+      prevIndex: null,
+    };
+
+    while (true) {
+      try {
+        const { done, value } = await reader.read();
+
+        let toolCallName: string | undefined = undefined;
+        let toolCallId: string | undefined = undefined;
+        let toolCallArgs: string | undefined = undefined;
+        let hasToolCall: boolean = false;
+        let content = "";
+        if (value && value.content) {
+          content = Array.isArray(value.content)
+            ? (((value.content[0] as any)?.text ?? "") as string)
+            : value.content;
+        }
+
+        if (isAIMessageChunk(value)) {
+          let chunk = value.tool_call_chunks?.[0];
+          toolCallArgs = chunk?.args;
+          hasToolCall = chunk != undefined;
+          if (chunk?.name) toolCallDetails.name = chunk.name;
+          // track different index on the same tool cool
+          if (chunk?.index != null) {
+            toolCallDetails.index = chunk.index; // 1
+            if (toolCallDetails.prevIndex == null) toolCallDetails.prevIndex = chunk.index;
+          }
+          // Differentiate when calling the same tool but with different index
+          if (chunk?.id)
+            toolCallDetails.id = chunk.index != null ? `${chunk.id}-idx-${chunk.index}` : chunk.id;
+
+          // Assign to internal variables that the entire script here knows how to work with
+          toolCallName = toolCallDetails.name;
+          toolCallId = toolCallDetails.id;
+        } else if (isBaseMessageChunk(value)) {
+          let chunk = value.additional_kwargs?.tool_calls?.[0];
+          toolCallName = chunk?.function?.name;
+          toolCallId = chunk?.id;
+          toolCallArgs = chunk?.function?.arguments;
+          hasToolCall = chunk?.function != undefined;
+        }
+
+        // When switching from message to function or vice versa,
+        // send the respective end event.
+        // If toolCallName is defined, it means a new tool call starts.
+        if (mode === "message" && (toolCallId || done)) {
+          mode = null;
+          eventStream$.sendTextMessageEnd({ messageId: currentMessageId });
+        } else if (mode === "function" && (!hasToolCall || done)) {
+          mode = null;
+          eventStream$.sendActionExecutionEnd({ actionExecutionId: toolCallId });
+        }
+
+        if (done) {
+          break;
+        }
+
+        // If we send a new message type, send the appropriate start event.
+        if (mode === null) {
+          if (hasToolCall && toolCallId && toolCallName) {
+            mode = "function";
+            eventStream$.sendActionExecutionStart({
+              actionExecutionId: toolCallId,
+              actionName: toolCallName,
+              parentMessageId: value.lc_kwargs?.id,
+            });
+          } else if (content) {
+            mode = "message";
+            currentMessageId = value.lc_kwargs?.id || randomId();
+            eventStream$.sendTextMessageStart({ messageId: currentMessageId });
+          }
+        }
+
+        // send the content events
+        if (mode === "message" && content) {
+          eventStream$.sendTextMessageContent({
+            messageId: currentMessageId,
+            content,
+          });
+        } else if (mode === "function" && toolCallArgs) {
+          // For calls of the same tool with different index, we seal last tool call and register a new one
+          if (toolCallDetails.index !== toolCallDetails.prevIndex) {
+            eventStream$.sendActionExecutionEnd({ actionExecutionId: toolCallId });
+            eventStream$.sendActionExecutionStart({
+              actionExecutionId: toolCallId,
+              actionName: toolCallName,
+              parentMessageId: value.lc_kwargs?.id,
+            });
+            toolCallDetails.prevIndex = toolCallDetails.index;
+          }
+          eventStream$.sendActionExecutionArgs({
+            actionExecutionId: toolCallId,
+            args: toolCallArgs,
+          });
+        }
+      } catch (error) {
+        console.error("Error reading from stream", error);
+        break;
+      }
+    }
+  } else if (actionExecution) {
+    eventStream$.sendActionExecutionResult({
+      actionExecutionId: actionExecution.id,
+      actionName: actionExecution.name,
+      result: encodeResult(result),
+    });
+  }
+
+  // unsupported type
+  else {
+    throw new Error("Invalid return type from LangChain function.");
+  }
+
+  eventStream$.complete();
+}
+
+function encodeResult(result: any): string {
+  if (result === undefined) {
+    return "";
+  } else if (typeof result === "string") {
+    return result;
+  } else {
+    return JSON.stringify(result);
+  }
+}