@maximai/maxim-js/src/lib/models/promptChain.d.ts

Maxim AI JS SDK. Visit https://getmaxim.ai for more info.

import { Prompt } from "./prompt";
import { DeploymentVersionDeploymentConfig } from "./deployment";
export type AgentCost = {
    input: number;
    output: number;
    total: number;
};
export type AgentUsage = {
    promptTokens: number;
    completionTokens: number;
    totalTokens: number;
};
export type AgentResponseMeta = {
    cost: AgentCost;
    usage: AgentUsage;
    boundVariableResponses?: {
        [key: string]: any;
    };
    retrievedContext?: string;
};
export type AgentResponse = {
    response: string;
    meta: AgentResponseMeta;
};
export type PromptChain = {
    promptChainId: string;
    version: number;
    versionId: string;
    nodes: ({
        order: number;
    } & PromptNode)[];
    run: (input: string, options?: {
        variables?: {
            [key: string]: string;
        };
    }) => Promise<AgentResponse>;
};
export type PromptNode = {
    prompt: Prompt;
};
export type CodeBlockNode = {
    code: string;
};
export type ApiNode = {
    api: {
        url: string;
        method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
        params?: {
            id: string;
            key: string;
            value: string;
        }[];
        headers?: {
            id: string;
            key: string;
            value: string;
        }[];
        body?: string;
    };
};
export type Node = {
    order: number;
} & (PromptNode | CodeBlockNode | ApiNode);
export type PromptChainVersionConfig = {
    nodes: Node[];
};
export type PromptChainVersion = {
    id: string;
    version: number;
    promptChainId: string;
    description?: string;
    config?: PromptChainVersionConfig;
    createdAt: string;
    updatedAt: string;
};
export type PromptChainVersionsAndRules = {
    folderId: string;
    rules: DeploymentVersionDeploymentConfig;
    versions: PromptChainVersion[];
    fallbackVersion: PromptChainVersion | undefined;
};
export type MaximApiPromptChainResponse = {
    data: PromptChainVersionsAndRules;
    error?: {
        message: string;
    };
};
export type MaximApiPromptChainsResponse = {
    data: ({
        promptChainId: string;
    } & PromptChainVersionsAndRules)[];
    error?: {
        message: string;
    };
};
export type MaximApiAgentRunResponse = {
    data: AgentResponse;
    error?: {
        message: string;
    };
};