convolet/lib/types.d.ts

AI agent framework with human in the loop

type Awaitable<T> = T | Promise<T>;
declare enum NodeType {
    INTERACTION = "INTERACTION",
    BOT_EVALUATION = "BOT_EVALUATION",
    SYSTEM_EVALUATION = "SYSTEM_EVALUATION",
    BOT_DECISION = "BOT_DECISION",
    SYSTEM_DECISION = "SYSTEM_DECISION"
}
declare enum NodeStatus {
    INITIATED = "INITIATED",
    PROCESSING = "PROCESSING",
    COMPLETED = "COMPLETED"
}
declare enum FlowStatus {
    INITIATED = "INITIATED",
    PROCESSING = "PROCESSING",
    COMPLETED = "COMPLETED"
}
type NextNodeOption = {
    nodeKey: string;
    prompt: string;
};
type OutputParam = {
    name: string;
    path: string[] | string;
};
type BaseNodeConfig = {
    nodeType: NodeType;
    nodeKey: string;
    inputParams: string[];
    outputParams: string | (string | OutputParam)[];
    nextNodeOptions: string | string[] | NextNodeOption[];
};
type InteractionNodeConfig = BaseNodeConfig & {
    nodeType: NodeType.INTERACTION;
    prompt: string;
};
type BotEvaluationNodeConfig = BaseNodeConfig & {
    nodeType: NodeType.BOT_EVALUATION;
    prompt: string;
    schema: string;
};
type NodeConfig = BaseNodeConfig | InteractionNodeConfig | BotEvaluationNodeConfig;
type FlowConfig = {
    flowKey: string;
    nodes: NodeConfig[];
    startNodeKey: string;
    endNodeKey: string;
};
type DataObject = Record<string, any>;
type NodeInput = DataObject;
type InteractionNodeOutput = {
    botStreamed?: string;
    userInput?: string;
};
type EvaluationNodeOutput = DataObject;
type DecisionNodeOutput = {
    nextNodeKey: string;
    reason: string | null;
};
type NodeOutput = InteractionNodeOutput | EvaluationNodeOutput | DecisionNodeOutput;
type NodeContent = {
    type: NodeType;
    key: string;
    flowId: string;
    index: number;
    output: NodeOutput | null;
};
type SymbolRef = {
    nodeIndex: number;
    path: string[];
};
type FlowMemory = {
    initial: NodeInput;
    symbolRefs: Record<string, SymbolRef>;
};
type FlowContent = {
    id: string;
    key: string;
    config: FlowConfig;
    memory: FlowMemory;
};
type BotStreamPromptBuilder = (prompt: string, hasPreviousMessages: boolean, input: NodeInput) => string;
type BotEvaluationPromptBuilder = (prompt: string, input: NodeInput) => string;
type BotDecisionPromptBuilder = (nextNodeOptions: NextNodeOption[], input: NodeInput) => string;
type PromptBuilders = {
    botStream: BotStreamPromptBuilder;
    botEvaluation: BotEvaluationPromptBuilder;
    botDecision: BotDecisionPromptBuilder;
};
type Message = {
    role: "SYSTEM" | "BOT" | "USER";
    content: string;
};
type SystemEvaluator = (input: NodeInput, nodeContent: NodeContent, nodeConfig: NodeConfig) => Awaitable<NodeOutput>;
type FlowInitOptions<JSON_CHAT_OPTIONS, STREAM_CHAT_OPTIONS> = {
    promptBuilders?: PromptBuilders;
    systemEvaluator?: SystemEvaluator;
    jsonChatOptions?: JSON_CHAT_OPTIONS;
    streamChatOptions?: STREAM_CHAT_OPTIONS;
};
type FlowExecOptions = {
    userInput?: string;
    callBefore?: (nodeContent: NodeContent) => Awaitable<void>;
    callAfter?: (nodeContent: NodeContent) => Awaitable<void>;
};
type Adapter<JSON_CHAT_OPTIONS, STREAM_CHAT_OPTIONS, STREAM_CHAT_RESPONSE> = {
    getFlow(id: string): Promise<FlowContent>;
    createFlow(config: FlowConfig, memory: FlowMemory): Promise<FlowContent>;
    updateFlow(id: string, memory: FlowMemory): Promise<FlowContent>;
    deleteFlow(id: string): Promise<FlowContent>;
    getNodes(flowId: string): Promise<NodeContent[]>;
    deleteNodes(flowId: string): Promise<number>;
    createNode(content: NodeContent): Promise<NodeContent>;
    updateNode(content: NodeContent): Promise<NodeContent>;
    jsonChat(prompt: string, schema: string, options?: JSON_CHAT_OPTIONS): Promise<NodeOutput>;
    streamChat(prompt: string, messages: Message[], onStreamDone: (text: string) => Promise<void>, options?: STREAM_CHAT_OPTIONS): Promise<STREAM_CHAT_RESPONSE>;
};
export { Adapter, Awaitable, BaseNodeConfig, BotDecisionPromptBuilder, BotEvaluationNodeConfig, BotEvaluationPromptBuilder, BotStreamPromptBuilder, DataObject, DecisionNodeOutput, EvaluationNodeOutput, FlowConfig, FlowContent, FlowExecOptions, FlowInitOptions, FlowMemory, FlowStatus, InteractionNodeConfig, InteractionNodeOutput, Message, NextNodeOption, NodeConfig, NodeContent, NodeInput, NodeOutput, NodeStatus, NodeType, PromptBuilders, SymbolRef, SystemEvaluator, };