@copilotkit/runtime 0.37.0

package/src/service-adapters/openai/openai-assistant-adapter.ts

@@ -0,0 +1,260 @@
+/**
+ * CopilotKit Adapter for the OpenAI Assistant API.
+ *
+ * Use this adapter to get responses from the OpenAI Assistant API.
+ *
+ * <RequestExample>
+ * ```typescript
+ * const copilotKit = new CopilotRuntime();
+ * return copilotKit.response(
+ *   req,
+ *   new OpenAIAssistantAdapter({
+ *    assistantId: "your-assistant-id"
+ *   })
+ * );
+ * ```
+ * </RequestExample>
+ */
+import OpenAI from "openai";
+import {
+  CopilotServiceAdapter,
+  CopilotRuntimeChatCompletionRequest,
+  CopilotRuntimeChatCompletionResponse,
+} from "../service-adapter";
+import { Message, ResultMessage, TextMessage } from "../../graphql/types/converted";
+import {
+  convertActionInputToOpenAITool,
+  convertMessageToOpenAIMessage,
+  convertSystemMessageToAssistantAPI,
+} from "./utils";
+import { RunSubmitToolOutputsStreamParams } from "openai/resources/beta/threads/runs/runs";
+import { AssistantStream } from "openai/lib/AssistantStream";
+import { RuntimeEventSource } from "../events";
+import { ActionInput } from "../../graphql/inputs/action.input";
+import { AssistantStreamEvent, AssistantTool } from "openai/resources/beta/assistants";
+
+export interface OpenAIAssistantAdapterParams {
+  /**
+   * The ID of the assistant to use.
+   */
+  assistantId: string;
+
+  /**
+   * An instance of `OpenAI` to use for the request. If not provided, a new instance will be created.
+   */
+  openai?: OpenAI;
+
+  /**
+   * Whether to enable the code interpreter. Defaults to `true`.
+   */
+  codeInterpreterEnabled?: boolean;
+
+  /**
+   * Whether to enable retrieval. Defaults to `true`.
+   */
+  fileSearchEnabled?: boolean;
+}
+
+export class OpenAIAssistantAdapter implements CopilotServiceAdapter {
+  private openai: OpenAI;
+  private codeInterpreterEnabled: boolean;
+  private assistantId: string;
+  private fileSearchEnabled: boolean;
+
+  constructor(params: OpenAIAssistantAdapterParams) {
+    this.openai = params.openai || new OpenAI({});
+    this.codeInterpreterEnabled = params.codeInterpreterEnabled === false || true;
+    this.fileSearchEnabled = params.fileSearchEnabled === false || true;
+    this.assistantId = params.assistantId;
+  }
+
+  async process({
+    messages,
+    actions,
+    eventSource,
+    threadId,
+    runId,
+  }: CopilotRuntimeChatCompletionRequest): Promise<CopilotRuntimeChatCompletionResponse> {
+    // if we don't have a threadId, create a new thread
+    threadId ||= (await this.openai.beta.threads.create()).id;
+    const lastMessage = messages.at(-1);
+
+    let nextRunId: string | undefined = undefined;
+
+    // submit function outputs
+    if (lastMessage instanceof ResultMessage && runId) {
+      nextRunId = await this.submitToolOutputs(threadId, runId, messages, eventSource);
+    }
+    // submit user message
+    else if (lastMessage instanceof TextMessage) {
+      nextRunId = await this.submitUserMessage(threadId, messages, actions, eventSource);
+    }
+    // unsupported message
+    else {
+      throw new Error("No actionable message found in the messages");
+    }
+
+    return {
+      threadId,
+      runId: nextRunId,
+    };
+  }
+
+  private async submitToolOutputs(
+    threadId: string,
+    runId: string,
+    messages: Message[],
+    eventSource: RuntimeEventSource,
+  ) {
+    let run = await this.openai.beta.threads.runs.retrieve(threadId, runId);
+    if (!run.required_action) {
+      throw new Error("No tool outputs required");
+    }
+
+    // get the required tool call ids
+    const toolCallsIds = run.required_action.submit_tool_outputs.tool_calls.map(
+      (toolCall) => toolCall.id,
+    );
+
+    // search for these tool calls
+    const resultMessages = messages.filter(
+      (message) =>
+        message instanceof ResultMessage && toolCallsIds.includes(message.actionExecutionId),
+    ) as ResultMessage[];
+
+    if (toolCallsIds.length != resultMessages.length) {
+      throw new Error("Number of function results does not match the number of tool calls");
+    }
+
+    // submit the tool outputs
+    const toolOutputs: RunSubmitToolOutputsStreamParams.ToolOutput[] = resultMessages.map(
+      (message) => {
+        return {
+          tool_call_id: message.actionExecutionId,
+          output: message.result,
+        };
+      },
+    );
+
+    const stream = this.openai.beta.threads.runs.submitToolOutputsStream(threadId, runId, {
+      tool_outputs: toolOutputs,
+    });
+
+    await this.streamResponse(stream, eventSource);
+    return runId;
+  }
+
+  private async submitUserMessage(
+    threadId: string,
+    messages: Message[],
+    actions: ActionInput[],
+    eventSource: RuntimeEventSource,
+  ) {
+    messages = [...messages];
+
+    // get the instruction message
+    const instructionsMessage = messages.shift();
+    const instructions =
+      instructionsMessage instanceof TextMessage ? instructionsMessage.content : "";
+
+    // get the latest user message
+    const userMessage = messages
+      .map(convertMessageToOpenAIMessage)
+      .map(convertSystemMessageToAssistantAPI)
+      .at(-1);
+
+    if (userMessage.role !== "user") {
+      throw new Error("No user message found");
+    }
+
+    // create a new message on the thread
+    await this.openai.beta.threads.messages.create(threadId, {
+      role: "user",
+      content: userMessage.content,
+    });
+
+    const openaiTools = actions.map(convertActionInputToOpenAITool);
+
+    const tools = [
+      ...openaiTools,
+      ...(this.codeInterpreterEnabled ? [{ type: "code_interpreter" } as AssistantTool] : []),
+      ...(this.fileSearchEnabled ? [{ type: "file_search" } as AssistantTool] : []),
+    ];
+
+    // run the thread
+    let stream = this.openai.beta.threads.runs.stream(threadId, {
+      assistant_id: this.assistantId,
+      instructions,
+      tools: tools,
+    });
+
+    await this.streamResponse(stream, eventSource);
+
+    return getRunIdFromStream(stream);
+  }
+
+  private async streamResponse(stream: AssistantStream, eventSource: RuntimeEventSource) {
+    eventSource.stream(async (eventStream$) => {
+      let inFunctionCall = false;
+
+      for await (const chunk of stream) {
+        switch (chunk.event) {
+          case "thread.message.created":
+            if (inFunctionCall) {
+              eventStream$.sendActionExecutionEnd();
+            }
+            eventStream$.sendTextMessageStart(chunk.data.id);
+            break;
+          case "thread.message.delta":
+            if (chunk.data.delta.content?.[0].type === "text") {
+              eventStream$.sendTextMessageContent(chunk.data.delta.content?.[0].text.value);
+            }
+            break;
+          case "thread.message.completed":
+            eventStream$.sendTextMessageEnd();
+            break;
+          case "thread.run.step.delta":
+            let toolCallId: string | undefined;
+            let toolCallName: string | undefined;
+            let toolCallArgs: string | undefined;
+            if (
+              chunk.data.delta.step_details.type === "tool_calls" &&
+              chunk.data.delta.step_details.tool_calls?.[0].type === "function"
+            ) {
+              toolCallId = chunk.data.delta.step_details.tool_calls?.[0].id;
+              toolCallName = chunk.data.delta.step_details.tool_calls?.[0].function.name;
+              toolCallArgs = chunk.data.delta.step_details.tool_calls?.[0].function.arguments;
+            }
+
+            if (toolCallName && toolCallId) {
+              if (inFunctionCall) {
+                eventStream$.sendActionExecutionEnd();
+              }
+              inFunctionCall = true;
+              eventStream$.sendActionExecutionStart(toolCallId, toolCallName);
+            } else if (toolCallArgs) {
+              eventStream$.sendActionExecutionArgs(toolCallArgs);
+            }
+            break;
+        }
+      }
+      if (inFunctionCall) {
+        eventStream$.sendActionExecutionEnd();
+      }
+      eventStream$.complete();
+    });
+  }
+}
+
+function getRunIdFromStream(stream: AssistantStream): Promise<string> {
+  return new Promise<string>((resolve, reject) => {
+    let runIdGetter = (event: AssistantStreamEvent) => {
+      if (event.event === "thread.run.created") {
+        const runId = event.data.id;
+        stream.off("event", runIdGetter);
+        resolve(runId);
+      }
+    };
+    stream.on("event", runIdGetter);
+  });
+}

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

@@ -0,0 +1,164 @@
+import {
+  ActionExecutionMessage,
+  Message,
+  ResultMessage,
+  TextMessage,
+} from "../../graphql/types/converted";
+import { Tiktoken, TiktokenModel, encodingForModel } from "js-tiktoken";
+import { ActionInput } from "../../graphql/inputs/action.input";
+import { ChatCompletionMessageParam, ChatCompletionTool } from "openai/resources";
+
+export function limitMessagesToTokenCount(
+  messages: any[],
+  tools: any[],
+  model: string,
+  maxTokens?: number,
+): any[] {
+  maxTokens ||= maxTokensForOpenAIModel(model);
+
+  const result: any[] = [];
+  const toolsNumTokens = countToolsTokens(model, tools);
+  if (toolsNumTokens > maxTokens) {
+    throw new Error(`Too many tokens in function definitions: ${toolsNumTokens} > ${maxTokens}`);
+  }
+  maxTokens -= toolsNumTokens;
+
+  for (const message of messages) {
+    if (message.role === "system") {
+      const numTokens = countMessageTokens(model, message);
+      maxTokens -= numTokens;
+
+      if (maxTokens < 0) {
+        throw new Error("Not enough tokens for system message.");
+      }
+    }
+  }
+
+  let cutoff: boolean = false;
+
+  const reversedMessages = [...messages].reverse();
+  for (const message of reversedMessages) {
+    if (message.role === "system") {
+      result.unshift(message);
+      continue;
+    } else if (cutoff) {
+      continue;
+    }
+    let numTokens = countMessageTokens(model, message);
+    if (maxTokens < numTokens) {
+      cutoff = true;
+      continue;
+    }
+    result.unshift(message);
+    maxTokens -= numTokens;
+  }
+
+  return result;
+}
+
+export function maxTokensForOpenAIModel(model: string): number {
+  return maxTokensByModel[model] || DEFAULT_MAX_TOKENS;
+}
+
+const DEFAULT_MAX_TOKENS = 128000;
+
+const maxTokensByModel: { [key: string]: number } = {
+  // GPT-4
+  "gpt-4o": 128000,
+  "gpt-4o-2024-05-13": 128000,
+  "gpt-4-turbo": 128000,
+  "gpt-4-turbo-2024-04-09": 128000,
+  "gpt-4-0125-preview": 128000,
+  "gpt-4-turbo-preview": 128000,
+  "gpt-4-1106-preview": 128000,
+  "gpt-4-vision-preview": 128000,
+  "gpt-4-1106-vision-preview": 128000,
+  "gpt-4-32k": 32768,
+  "gpt-4-32k-0613": 32768,
+  "gpt-4-32k-0314": 32768,
+  "gpt-4": 8192,
+  "gpt-4-0613": 8192,
+  "gpt-4-0314": 8192,
+
+  // GPT-3.5
+  "gpt-3.5-turbo-0125": 16385,
+  "gpt-3.5-turbo": 16385,
+  "gpt-3.5-turbo-1106": 16385,
+  "gpt-3.5-turbo-instruct": 4096,
+  "gpt-3.5-turbo-16k": 16385,
+  "gpt-3.5-turbo-0613": 4096,
+  "gpt-3.5-turbo-16k-0613": 16385,
+  "gpt-3.5-turbo-0301": 4097,
+};
+
+function countToolsTokens(model: string, tools: any[]): number {
+  if (tools.length === 0) {
+    return 0;
+  }
+  const json = JSON.stringify(tools);
+  return countTokens(model, json);
+}
+
+function countMessageTokens(model: string, message: any): number {
+  return countTokens(model, message.content || "");
+}
+
+function countTokens(model: string, text: string): number {
+  let enc: Tiktoken;
+  try {
+    enc = encodingForModel(model as TiktokenModel);
+  } catch (e) {
+    enc = encodingForModel("gpt-4");
+  }
+  return enc.encode(text).length;
+}
+
+export function convertActionInputToOpenAITool(action: ActionInput): ChatCompletionTool {
+  return {
+    type: "function",
+    function: {
+      name: action.name,
+      description: action.description,
+      parameters: JSON.parse(action.jsonSchema),
+    },
+  };
+}
+
+export function convertMessageToOpenAIMessage(message: Message): ChatCompletionMessageParam {
+  if (message instanceof TextMessage) {
+    return {
+      role: message.role,
+      content: message.content,
+    };
+  } else if (message instanceof ActionExecutionMessage) {
+    return {
+      role: "assistant",
+      tool_calls: [
+        {
+          id: message.id,
+          type: "function",
+          function: {
+            name: message.name,
+            arguments: JSON.stringify(message.arguments),
+          },
+        },
+      ],
+    };
+  } else if (message instanceof ResultMessage) {
+    return {
+      role: "tool",
+      content: message.result,
+      tool_call_id: message.actionExecutionId,
+    };
+  }
+}
+
+export function convertSystemMessageToAssistantAPI(message: ChatCompletionMessageParam) {
+  return {
+    ...message,
+    ...(message.role === "system" && {
+      role: "assistant",
+      content: "THE FOLLOWING MESSAGE IS A SYSTEM MESSAGE: " + message.content,
+    }),
+  };
+}

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

@@ -0,0 +1,29 @@
+import { Message } from "../graphql/types/converted";
+import { RuntimeEventSource } from "./events";
+import { ActionInput } from "../graphql/inputs/action.input";
+
+export interface CopilotKitResponse {
+  stream: ReadableStream;
+  headers?: Record<string, string>;
+}
+
+export interface CopilotRuntimeChatCompletionRequest {
+  eventSource: RuntimeEventSource;
+  messages: Message[];
+  actions: ActionInput[];
+  model?: string;
+  threadId?: string;
+  runId?: string;
+}
+
+export interface CopilotRuntimeChatCompletionResponse {
+  stream?: ReadableStream;
+  threadId?: string;
+  runId?: string;
+}
+
+export interface CopilotServiceAdapter {
+  process(
+    request: CopilotRuntimeChatCompletionRequest,
+  ): Promise<CopilotRuntimeChatCompletionResponse>;
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "tsconfig/base.json",
+  "compilerOptions": {
+    "lib": ["es2017", "dom"],
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "strict": false,
+  },
+  "include": ["./src/**/*.ts"],
+  "exclude": ["dist", "build", "node_modules", "**/*.test.ts", "**/*.test.tsx", "**/__tests__/*"]
+}

package/tsup.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig, Options } from "tsup";
+
+export default defineConfig((options: Options) => ({
+  ...options,
+  clean: true,
+  entry: ["src/**/index.ts"],
+  format: ["esm", "cjs"],
+  dts: true,
+  minify: false,
+  external: [],
+  sourcemap: true,
+  exclude: [
+    "**/*.test.ts", // Exclude TypeScript test files
+    "**/*.test.tsx", // Exclude TypeScript React test files
+    "**/__tests__/*", // Exclude any files inside a __tests__ directory
+  ],
+}));

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}