@copilotkit/runtime 1.10.6 → 1.50.0-beta.0

package/dist/groq-adapter-c8aec5c5.d.ts

@@ -1,321 +0,0 @@
-import OpenAI from 'openai';
-import { b as CopilotServiceAdapter, C as CopilotRuntimeChatCompletionRequest, a as CopilotRuntimeChatCompletionResponse } from './langserve-0c6100e3.js';
-import { BaseMessageChunk, AIMessage, AIMessageChunk, BaseMessage } from '@langchain/core/messages';
-import { DynamicStructuredTool } from '@langchain/core/tools';
-import { IterableReadableStream, IterableReadableStreamInterface } from '@langchain/core/utils/stream';
-import { Groq } from 'groq-sdk';
-
-/**
- * Copilot Runtime adapter for OpenAI.
- *
- * ## Example
- *
- * ```ts
- * import { CopilotRuntime, OpenAIAdapter } from "@copilotkit/runtime";
- * import OpenAI from "openai";
- *
- * const copilotKit = new CopilotRuntime();
- *
- * const openai = new OpenAI({
- *   organization: "<your-organization-id>", // optional
- *   apiKey: "<your-api-key>",
- * });
- *
- * return new OpenAIAdapter({ openai });
- * ```
- *
- * ## Example with Azure OpenAI
- *
- * ```ts
- * import { CopilotRuntime, OpenAIAdapter } from "@copilotkit/runtime";
- * import OpenAI from "openai";
- *
- * // The name of your Azure OpenAI Instance.
- * // https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#create-a-resource
- * const instance = "<your instance name>";
- *
- * // Corresponds to your Model deployment within your OpenAI resource, e.g. my-gpt35-16k-deployment
- * // Navigate to the Azure OpenAI Studio to deploy a model.
- * const model = "<your model>";
- *
- * const apiKey = process.env["AZURE_OPENAI_API_KEY"];
- * if (!apiKey) {
- *   throw new Error("The AZURE_OPENAI_API_KEY environment variable is missing or empty.");
- * }
- *
- * const copilotKit = new CopilotRuntime();
- *
- * const openai = new OpenAI({
- *   apiKey,
- *   baseURL: `https://${instance}.openai.azure.com/openai/deployments/${model}`,
- *   defaultQuery: { "api-version": "2024-04-01-preview" },
- *   defaultHeaders: { "api-key": apiKey },
- * });
- *
- * return new OpenAIAdapter({ openai });
- * ```
- */
-
-interface OpenAIAdapterParams {
-    /**
-     * An optional OpenAI instance to use.  If not provided, a new instance will be
-     * created.
-     */
-    openai?: OpenAI;
-    /**
-     * 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;
-    /**
-     * Whether to keep the role in system messages as "System".
-     * By default, it is converted to "developer", which is used by newer OpenAI models
-     *
-     * @default false
-     */
-    keepSystemRole?: boolean;
-}
-declare class OpenAIAdapter implements CopilotServiceAdapter {
-    private model;
-    private disableParallelToolCalls;
-    private _openai;
-    private keepSystemRole;
-    get openai(): OpenAI;
-    constructor(params?: OpenAIAdapterParams);
-    process(request: CopilotRuntimeChatCompletionRequest): Promise<CopilotRuntimeChatCompletionResponse>;
-}
-
-type LangChainBaseMessageChunkStream = IterableReadableStream<BaseMessageChunk>;
-type LangChainAIMessageChunkStream = IterableReadableStreamInterface<AIMessageChunk>;
-type LangChainReturnType = LangChainBaseMessageChunkStream | LangChainAIMessageChunkStream | BaseMessageChunk | string | AIMessage;
-
-/**
- * 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
- */
-
-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>;
-}
-declare class LangChainAdapter implements CopilotServiceAdapter {
-    private options;
-    /**
-     * To use LangChain as a backend, provide a handler function to the adapter with your custom LangChain logic.
-     */
-    constructor(options: LangChainAdapterOptions);
-    process(request: CopilotRuntimeChatCompletionRequest): Promise<CopilotRuntimeChatCompletionResponse>;
-}
-
-interface GoogleGenerativeAIAdapterOptions {
-    /**
-     * A custom Google Generative AI model to use.
-     */
-    model?: string;
-    /**
-     * The API key to use.
-     */
-    apiKey?: string;
-}
-declare class GoogleGenerativeAIAdapter extends LangChainAdapter {
-    constructor(options?: GoogleGenerativeAIAdapterOptions);
-}
-
-/**
- * Copilot Runtime adapter for the OpenAI Assistant API.
- *
- * ## Example
- *
- * ```ts
- * import { CopilotRuntime, OpenAIAssistantAdapter } from "@copilotkit/runtime";
- * import OpenAI from "openai";
- *
- * const copilotKit = new CopilotRuntime();
- *
- * const openai = new OpenAI({
- *   organization: "<your-organization-id>",
- *   apiKey: "<your-api-key>",
- * });
- *
- * return new OpenAIAssistantAdapter({
- *   openai,
- *   assistantId: "<your-assistant-id>",
- *   codeInterpreterEnabled: true,
- *   fileSearchEnabled: true,
- * });
- * ```
- */
-
-interface OpenAIAssistantAdapterParams {
-    /**
-     * The ID of the assistant to use.
-     */
-    assistantId: string;
-    /**
-     * An optional OpenAI instance to use. If not provided, a new instance will be created.
-     */
-    openai?: OpenAI;
-    /**
-     * Whether to enable code interpretation.
-     * @default true
-     */
-    codeInterpreterEnabled?: boolean;
-    /**
-     * Whether to enable file search.
-     * @default true
-     */
-    fileSearchEnabled?: boolean;
-    /**
-     * 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;
-    /**
-     * Whether to keep the role in system messages as "System".
-     * By default, it is converted to "developer", which is used by newer OpenAI models
-     *
-     * @default false
-     */
-    keepSystemRole?: boolean;
-}
-declare class OpenAIAssistantAdapter implements CopilotServiceAdapter {
-    private openai;
-    private codeInterpreterEnabled;
-    private assistantId;
-    private fileSearchEnabled;
-    private disableParallelToolCalls;
-    private keepSystemRole;
-    constructor(params: OpenAIAssistantAdapterParams);
-    process(request: CopilotRuntimeChatCompletionRequest): Promise<CopilotRuntimeChatCompletionResponse>;
-    private submitToolOutputs;
-    private submitUserMessage;
-    private streamResponse;
-}
-
-/**
- * CopilotKit Adapter for Unify
- *
- * <RequestExample>
- * ```jsx CopilotRuntime Example
- * const copilotKit = new CopilotRuntime();
- * return copilotKit.response(req, new UnifyAdapter());
- * ```
- * </RequestExample>
- *
- * You can easily set the model to use by passing it to the constructor.
- * ```jsx
- * const copilotKit = new CopilotRuntime();
- * return copilotKit.response(
- *   req,
- *   new UnifyAdapter({ model: "llama-3-8b-chat@fireworks-ai" }),
- * );
- * ```
- */
-
-interface UnifyAdapterParams {
-    apiKey?: string;
-    model: string;
-}
-declare class UnifyAdapter implements CopilotServiceAdapter {
-    private apiKey;
-    private model;
-    private start;
-    constructor(options?: UnifyAdapterParams);
-    process(request: CopilotRuntimeChatCompletionRequest): Promise<CopilotRuntimeChatCompletionResponse>;
-}
-
-/**
- * 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>" });
- * ```
- */
-
-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;
-}
-declare class GroqAdapter implements CopilotServiceAdapter {
-    private model;
-    private disableParallelToolCalls;
-    private _groq;
-    get groq(): Groq;
-    constructor(params?: GroqAdapterParams);
-    process(request: CopilotRuntimeChatCompletionRequest): Promise<CopilotRuntimeChatCompletionResponse>;
-}
-
-export { GoogleGenerativeAIAdapter as G, LangChainAdapter as L, OpenAIAdapterParams as O, UnifyAdapterParams as U, OpenAIAdapter as a, OpenAIAssistantAdapterParams as b, OpenAIAssistantAdapter as c, UnifyAdapter as d, GroqAdapterParams as e, GroqAdapter as f };

package/dist/index-96b330da.d.ts

@@ -1,119 +0,0 @@
-import { BaseMessageInput } from './graphql/types/base/index.js';
-
-declare enum MessageRole {
-    user = "user",
-    assistant = "assistant",
-    system = "system",
-    tool = "tool",
-    developer = "developer"
-}
-declare enum ActionInputAvailability {
-    disabled = "disabled",
-    enabled = "enabled",
-    remote = "remote"
-}
-
-declare class MessageInput extends BaseMessageInput {
-    textMessage?: TextMessageInput;
-    actionExecutionMessage?: ActionExecutionMessageInput;
-    resultMessage?: ResultMessageInput;
-    agentStateMessage?: AgentStateMessageInput;
-    imageMessage?: ImageMessageInput;
-}
-declare class TextMessageInput {
-    content: string;
-    parentMessageId?: string;
-    role: MessageRole;
-}
-declare class ActionExecutionMessageInput {
-    name: string;
-    arguments: string;
-    parentMessageId?: string;
-    scope?: String;
-}
-declare class ResultMessageInput {
-    actionExecutionId: string;
-    actionName: string;
-    parentMessageId?: string;
-    result: string;
-}
-declare class AgentStateMessageInput {
-    threadId: string;
-    agentName: string;
-    role: MessageRole;
-    state: string;
-    running: boolean;
-    nodeName: string;
-    runId: string;
-    active: boolean;
-}
-declare class ImageMessageInput {
-    format: string;
-    bytes: string;
-    parentMessageId?: string;
-    role: MessageRole;
-}
-
-type MessageType = "TextMessage" | "ActionExecutionMessage" | "ResultMessage" | "AgentStateMessage" | "ImageMessage";
-declare class Message extends BaseMessageInput {
-    type: MessageType;
-    isTextMessage(): this is TextMessage;
-    isActionExecutionMessage(): this is ActionExecutionMessage;
-    isResultMessage(): this is ResultMessage;
-    isAgentStateMessage(): this is AgentStateMessage;
-    isImageMessage(): this is ImageMessage;
-}
-declare class TextMessage extends Message implements TextMessageInput {
-    type: MessageType;
-    content: string;
-    role: MessageRole;
-    parentMessageId?: string;
-}
-declare class ActionExecutionMessage extends Message implements Omit<ActionExecutionMessageInput, "arguments" | "scope"> {
-    type: MessageType;
-    name: string;
-    arguments: Record<string, any>;
-    parentMessageId?: string;
-}
-declare class ResultMessage extends Message implements ResultMessageInput {
-    type: MessageType;
-    actionExecutionId: string;
-    actionName: string;
-    result: string;
-    static encodeResult(result: any, error?: {
-        code: string;
-        message: string;
-    } | string | Error): string;
-    static decodeResult(result: string): {
-        error?: {
-            code: string;
-            message: string;
-        };
-        result: string;
-    };
-    hasError(): boolean;
-    getError(): {
-        code: string;
-        message: string;
-    } | undefined;
-}
-declare class AgentStateMessage extends Message implements Omit<AgentStateMessageInput, "state"> {
-    type: MessageType;
-    threadId: string;
-    agentName: string;
-    nodeName: string;
-    runId: string;
-    active: boolean;
-    role: MessageRole;
-    state: any;
-    running: boolean;
-}
-declare class ImageMessage extends Message implements ImageMessageInput {
-    type: MessageType;
-    format: string;
-    bytes: string;
-    role: MessageRole;
-    parentMessageId?: string;
-}
-
-export { ActionInputAvailability as A, ImageMessage as I, Message as M, ResultMessage as R, TextMessage as T, ActionExecutionMessage as a, MessageInput as b, MessageType as c, AgentStateMessage as d };

package/dist/langserve-0c6100e3.d.ts

@@ -1,257 +0,0 @@
-import { A as ActionInputAvailability, T as TextMessage, a as ActionExecutionMessage, R as ResultMessage, M as Message } from './index-96b330da.js';
-import * as rxjs from 'rxjs';
-import { Subject, ReplaySubject } from 'rxjs';
-import { Action, Parameter } from '@copilotkit/shared';
-
-declare class ActionInput {
-    name: string;
-    description: string;
-    jsonSchema: string;
-    available?: ActionInputAvailability;
-}
-
-declare enum GuardrailsResultStatus {
-    ALLOWED = "allowed",
-    DENIED = "denied"
-}
-declare class GuardrailsResult {
-    status: GuardrailsResultStatus;
-    reason?: string;
-}
-
-declare enum RuntimeEventTypes {
-    TextMessageStart = "TextMessageStart",
-    TextMessageContent = "TextMessageContent",
-    TextMessageEnd = "TextMessageEnd",
-    ActionExecutionStart = "ActionExecutionStart",
-    ActionExecutionArgs = "ActionExecutionArgs",
-    ActionExecutionEnd = "ActionExecutionEnd",
-    ActionExecutionResult = "ActionExecutionResult",
-    AgentStateMessage = "AgentStateMessage",
-    MetaEvent = "MetaEvent",
-    RunError = "RunError"
-}
-declare enum RuntimeMetaEventName {
-    LangGraphInterruptEvent = "LangGraphInterruptEvent",
-    LangGraphInterruptResumeEvent = "LangGraphInterruptResumeEvent",
-    CopilotKitLangGraphInterruptEvent = "CopilotKitLangGraphInterruptEvent"
-}
-type RunTimeMetaEvent = {
-    type: RuntimeEventTypes.MetaEvent;
-    name: RuntimeMetaEventName.LangGraphInterruptEvent;
-    value: string;
-} | {
-    type: RuntimeEventTypes.MetaEvent;
-    name: RuntimeMetaEventName.CopilotKitLangGraphInterruptEvent;
-    data: {
-        value: string;
-        messages: (TextMessage | ActionExecutionMessage | ResultMessage)[];
-    };
-} | {
-    type: RuntimeEventTypes.MetaEvent;
-    name: RuntimeMetaEventName.LangGraphInterruptResumeEvent;
-    data: string;
-};
-type RuntimeErrorEvent = {
-    type: RuntimeEventTypes.RunError;
-    message: string;
-    code?: string;
-};
-type RuntimeEvent = {
-    type: RuntimeEventTypes.TextMessageStart;
-    messageId: string;
-    parentMessageId?: string;
-} | {
-    type: RuntimeEventTypes.TextMessageContent;
-    messageId: string;
-    content: string;
-} | {
-    type: RuntimeEventTypes.TextMessageEnd;
-    messageId: string;
-} | {
-    type: RuntimeEventTypes.ActionExecutionStart;
-    actionExecutionId: string;
-    actionName: string;
-    parentMessageId?: string;
-} | {
-    type: RuntimeEventTypes.ActionExecutionArgs;
-    actionExecutionId: string;
-    args: string;
-} | {
-    type: RuntimeEventTypes.ActionExecutionEnd;
-    actionExecutionId: string;
-} | {
-    type: RuntimeEventTypes.ActionExecutionResult;
-    actionName: string;
-    actionExecutionId: string;
-    result: string;
-} | {
-    type: RuntimeEventTypes.AgentStateMessage;
-    threadId: string;
-    agentName: string;
-    nodeName: string;
-    runId: string;
-    active: boolean;
-    role: string;
-    state: string;
-    running: boolean;
-} | RunTimeMetaEvent | RuntimeErrorEvent;
-type EventSourceCallback = (eventStream$: RuntimeEventSubject) => Promise<void>;
-declare class RuntimeEventSubject extends ReplaySubject<RuntimeEvent> {
-    constructor();
-    sendTextMessageStart({ messageId, parentMessageId, }: {
-        messageId: string;
-        parentMessageId?: string;
-    }): void;
-    sendTextMessageContent({ messageId, content }: {
-        messageId: string;
-        content: string;
-    }): void;
-    sendTextMessageEnd({ messageId }: {
-        messageId: string;
-    }): void;
-    sendTextMessage(messageId: string, content: string): void;
-    sendActionExecutionStart({ actionExecutionId, actionName, parentMessageId, }: {
-        actionExecutionId: string;
-        actionName: string;
-        parentMessageId?: string;
-    }): void;
-    sendActionExecutionArgs({ actionExecutionId, args, }: {
-        actionExecutionId: string;
-        args: string;
-    }): void;
-    sendActionExecutionEnd({ actionExecutionId }: {
-        actionExecutionId: string;
-    }): void;
-    sendActionExecution({ actionExecutionId, actionName, args, parentMessageId, }: {
-        actionExecutionId: string;
-        actionName: string;
-        args: string;
-        parentMessageId?: string;
-    }): void;
-    sendActionExecutionResult({ actionExecutionId, actionName, result, error, }: {
-        actionExecutionId: string;
-        actionName: string;
-        result?: string;
-        error?: {
-            code: string;
-            message: string;
-        };
-    }): void;
-    sendAgentStateMessage({ threadId, agentName, nodeName, runId, active, role, state, running, }: {
-        threadId: string;
-        agentName: string;
-        nodeName: string;
-        runId: string;
-        active: boolean;
-        role: string;
-        state: string;
-        running: boolean;
-    }): void;
-}
-declare class RuntimeEventSource {
-    private eventStream$;
-    private callback;
-    private errorHandler?;
-    private errorContext?;
-    constructor(params?: {
-        errorHandler?: (error: any, context: any) => Promise<void>;
-        errorContext?: any;
-    });
-    stream(callback: EventSourceCallback): Promise<void>;
-    sendErrorMessageToChat(message?: string): void;
-    processRuntimeEvents({ serverSideActions, guardrailsResult$, actionInputsWithoutAgents, threadId, }: {
-        serverSideActions: Action<any>[];
-        guardrailsResult$?: Subject<GuardrailsResult>;
-        actionInputsWithoutAgents: ActionInput[];
-        threadId: string;
-    }): rxjs.Observable<RuntimeEvent>;
-}
-
-declare class ForwardedParametersInput {
-    model?: string;
-    maxTokens?: number;
-    stop?: string[];
-    toolChoice?: String;
-    toolChoiceFunctionName?: string;
-    temperature?: number;
-}
-
-/**
- * The extensions input is used to pass additional information to the copilot runtime, specific to a
- * service adapter or agent framework.
- */
-declare class ExtensionsInput {
-    openaiAssistantAPI?: OpenAIApiAssistantAPIInput;
-}
-declare class OpenAIApiAssistantAPIInput {
-    runId?: string;
-    threadId?: string;
-}
-
-/**
- * The extensions response is used to receive additional information from the copilot runtime, specific to a
- * service adapter or agent framework.
- *
- * Next time a request to the runtime is made, the extensions response will be included in the request as input.
- */
-declare class ExtensionsResponse {
-    openaiAssistantAPI?: OpenAIApiAssistantAPIResponse;
-}
-declare class OpenAIApiAssistantAPIResponse {
-    runId?: string;
-    threadId?: string;
-}
-
-declare class AgentSessionInput {
-    agentName: string;
-    threadId?: string;
-    nodeName?: string;
-}
-
-declare class AgentStateInput {
-    agentName: string;
-    state: string;
-    config?: string;
-}
-
-interface CopilotRuntimeChatCompletionRequest {
-    eventSource: RuntimeEventSource;
-    messages: Message[];
-    actions: ActionInput[];
-    model?: string;
-    threadId?: string;
-    runId?: string;
-    forwardedParameters?: ForwardedParametersInput;
-    extensions?: ExtensionsInput;
-    agentSession?: AgentSessionInput;
-    agentStates?: AgentStateInput[];
-}
-interface CopilotRuntimeChatCompletionResponse {
-    threadId: string;
-    runId?: string;
-    extensions?: ExtensionsResponse;
-}
-interface CopilotServiceAdapter {
-    process(request: CopilotRuntimeChatCompletionRequest): Promise<CopilotRuntimeChatCompletionResponse>;
-}
-
-interface RemoteChainParameters {
-    name: string;
-    description: string;
-    chainUrl: string;
-    parameters?: Parameter[];
-    parameterType?: "single" | "multi";
-}
-declare class RemoteChain {
-    name: string;
-    description: string;
-    chainUrl: string;
-    parameters?: Parameter[];
-    parameterType: "single" | "multi";
-    constructor(options: RemoteChainParameters);
-    toAction(): Promise<Action<any>>;
-    inferLangServeParameters(): Promise<void>;
-}
-
-export { ActionInput as A, CopilotRuntimeChatCompletionRequest as C, ExtensionsInput as E, ForwardedParametersInput as F, RemoteChainParameters as R, CopilotRuntimeChatCompletionResponse as a, CopilotServiceAdapter as b, RemoteChain as c, AgentSessionInput as d, AgentStateInput as e, RuntimeEventSource as f, ExtensionsResponse as g };

package/dist/lib/cloud/index.d.ts

@@ -1,6 +0,0 @@
-interface CopilotCloudOptions {
-    baseUrl?: string;
-    publicApiKey?: string;
-}
-
-export { CopilotCloudOptions };