@proofhound/api-client 0.1.6

package/dist/optimization.d.ts

@@ -0,0 +1,574 @@
+import type { OptimizationControlActionDto, OptimizationListQueryDto, CreateOptimizationDto } from '@proofhound/shared';
+export declare const optimizationClient: {
+    listOptimizations: (projectId: string, query?: OptimizationListQueryDto) => Promise<{
+        data: {
+            id: string;
+            projectId: string;
+            name: string;
+            description: string | null;
+            strategy: string;
+            startingMode: "from_experiment" | "from_prompt_version" | "from_dataset_only";
+            status: "failed" | "running" | "stopped" | "cancelled" | "success";
+            controlState: "stop" | "resume" | "cancel" | null;
+            sourceExperimentId: string | null;
+            sourceExperimentName: string | null;
+            promptId: string | null;
+            promptName: string | null;
+            baseVersionId: string | null;
+            baseVersionNumber: number | null;
+            datasetId: string;
+            datasetName: string;
+            datasetSamples: number;
+            experimentModelId: string;
+            experimentModelName: string;
+            analysisModelId: string;
+            analysisModelName: string;
+            promptLanguage: "zh-CN" | "en-US";
+            goals: {
+                metric: "precision" | "recall" | "f1" | "accuracy" | "fpr";
+                comparator: "gte" | "gt" | "lte";
+                target: number;
+                scope: string;
+            }[];
+            fieldWhitelist: {
+                inputFields: string[];
+                metaFields: string[];
+            } | null;
+            runConfig: {
+                [x: string]: unknown;
+                temperature?: number | undefined;
+                concurrency?: number | undefined;
+                rpmLimit?: number | undefined;
+                tpmLimit?: number | undefined;
+                sampleTimeoutSeconds?: number | undefined;
+                retries?: number | undefined;
+                imageEncoding?: "url" | "base64" | undefined;
+            };
+            maxRounds: number;
+            currentRound: number;
+            bestVersionId: string | null;
+            bestVersionNumber: number | null;
+            bestMetrics: Record<string, number> | null;
+            summary: {
+                kind: "failed" | "running" | "stopped" | "cancelled" | "success";
+                reason: string;
+                finalizedAt: string;
+            } | null;
+            analysisFailureReason: string | null;
+            dbosWorkflowId: string | null;
+            createdBy: string;
+            createdByDisplayName: string | null;
+            createdByUsername: string | null;
+            startedAt: string | null;
+            finishedAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string | null;
+            trend?: number[] | null | undefined;
+            trendHasBaseline?: boolean | undefined;
+        }[];
+        total: number;
+    }>;
+    getOptimization: (projectId: string, optimizationId: string) => Promise<{
+        id: string;
+        projectId: string;
+        name: string;
+        description: string | null;
+        strategy: string;
+        startingMode: "from_experiment" | "from_prompt_version" | "from_dataset_only";
+        status: "failed" | "running" | "stopped" | "cancelled" | "success";
+        controlState: "stop" | "resume" | "cancel" | null;
+        sourceExperimentId: string | null;
+        sourceExperimentName: string | null;
+        promptId: string | null;
+        promptName: string | null;
+        baseVersionId: string | null;
+        baseVersionNumber: number | null;
+        datasetId: string;
+        datasetName: string;
+        datasetSamples: number;
+        experimentModelId: string;
+        experimentModelName: string;
+        analysisModelId: string;
+        analysisModelName: string;
+        promptLanguage: "zh-CN" | "en-US";
+        goals: {
+            metric: "precision" | "recall" | "f1" | "accuracy" | "fpr";
+            comparator: "gte" | "gt" | "lte";
+            target: number;
+            scope: string;
+        }[];
+        fieldWhitelist: {
+            inputFields: string[];
+            metaFields: string[];
+        } | null;
+        runConfig: {
+            [x: string]: unknown;
+            temperature?: number | undefined;
+            concurrency?: number | undefined;
+            rpmLimit?: number | undefined;
+            tpmLimit?: number | undefined;
+            sampleTimeoutSeconds?: number | undefined;
+            retries?: number | undefined;
+            imageEncoding?: "url" | "base64" | undefined;
+        };
+        maxRounds: number;
+        currentRound: number;
+        bestVersionId: string | null;
+        bestVersionNumber: number | null;
+        bestMetrics: Record<string, number> | null;
+        summary: {
+            kind: "failed" | "running" | "stopped" | "cancelled" | "success";
+            reason: string;
+            finalizedAt: string;
+        } | null;
+        analysisFailureReason: string | null;
+        dbosWorkflowId: string | null;
+        createdBy: string;
+        createdByDisplayName: string | null;
+        createdByUsername: string | null;
+        startedAt: string | null;
+        finishedAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string | null;
+        optimizationHint: string | null;
+        ownerHandle: string;
+        elapsedMs: number | null;
+        experimentConfig: {
+            datasetName: string;
+            promptName: string;
+            promptVersion: string;
+            modelName: string;
+            baselineExperiment: string;
+            temperature: number;
+            concurrency: number;
+            rpm: number;
+            tpm: number;
+        } | null;
+        iterationConfig: {
+            analysisModel: string;
+            strategy: string;
+            maxRounds: number;
+            noImprovementStop: number;
+            regressionThreshold: number;
+        } | null;
+        goalScope: {
+            kind: "overall" | "class";
+            classes?: string[] | undefined;
+        };
+        goalsLines: {
+            label: string;
+            targetText: string;
+            tone: "overall" | "class";
+        }[];
+        controlStrip: {
+            currentRound: number;
+            maxRounds: number;
+            phase: "experiment" | "analysis" | "paused" | "finishing";
+            samplesDone: number;
+            samplesTotal: number;
+            roundRemaining: string;
+            totalRemaining: string;
+        } | null;
+        trend: {
+            key: "recall" | "accuracy" | "fpr";
+            labelKey: string;
+            values: number[];
+            betterIsLower?: boolean | undefined;
+            target?: number | undefined;
+            bestRoundIndex?: number | undefined;
+            hasBaseline?: boolean | undefined;
+        }[];
+        trendBaselineRef: number | null;
+        bestRoundLabel: string | null;
+        rounds: {
+            index: number;
+            status: "failed" | "running" | "success" | "paused";
+            kindLabel: string;
+            metrics: {
+                label: string;
+                value: number;
+                partial?: boolean | undefined;
+                delta?: {
+                    value: number;
+                    vsLabel: string;
+                    tone: "ok" | "bad" | "neutral";
+                    betterIsLower?: boolean | undefined;
+                } | undefined;
+            }[];
+            steps: {
+                step: "experiment" | "error_analysis" | "generate_prompt";
+                status: "pending" | "failed" | "running" | "success" | "skipped";
+                errorClass?: string | null | undefined;
+                errorMessage?: string | null | undefined;
+                startedAt?: string | null | undefined;
+                finishedAt?: string | null | undefined;
+                runResultId?: string | null | undefined;
+                experimentId?: string | null | undefined;
+            }[];
+            goalChips: {
+                label: string;
+                targetText: string;
+                currentText: string;
+                achieved: "hit" | "miss";
+            }[];
+            isBaseline?: boolean | undefined;
+            isBest?: boolean | undefined;
+            startedAt?: string | undefined;
+            experimentResult?: {
+                experimentRef: string;
+                experimentStatus: "failed" | "running" | "success";
+                samplesDone: number;
+                samplesTotal: number;
+                correct: number;
+                wrong: number;
+                elapsed: string;
+                tokenSummary: string;
+                costLabel: string;
+                overallRow: {
+                    accuracy: number;
+                    precision: number;
+                    recall: number;
+                    vsLabel: string;
+                    vsDelta: number | null;
+                    vsTone: "ok" | "bad" | "neutral";
+                    deltas?: {
+                        accuracy?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                        precision?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                        recall?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                    } | undefined;
+                } | null;
+                classRows: {
+                    label: string;
+                    precision: number;
+                    recall: number;
+                    vsLabel: string;
+                    vsDelta: number | null;
+                    vsTone: "ok" | "bad" | "neutral";
+                    accuracy?: number | undefined;
+                    f1?: number | undefined;
+                    fpr?: number | undefined;
+                    deltas?: {
+                        accuracy?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                        precision?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                        recall?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                    } | undefined;
+                }[];
+                vsPrevLabel: string;
+            } | undefined;
+            errorPatterns?: {
+                percent: number;
+                title: string;
+                detail: string;
+                count: {
+                    hit: number;
+                    total: number;
+                };
+            }[] | undefined;
+            improvementSuggestions?: {
+                section: string;
+                title: string;
+                detail?: string | undefined;
+                priority?: "high" | "medium" | "low" | undefined;
+            }[] | undefined;
+            promptDiff?: {
+                from: string;
+                to: string;
+                fromText: string;
+                toText: string;
+                lines: {
+                    kind: "hunk" | "add" | "del" | "ctx";
+                    text: string;
+                    lineNumber?: number | null | undefined;
+                }[];
+            } | undefined;
+            stream?: {
+                stage: string;
+                analysisModel: string;
+                segments: {
+                    kind: "observation" | "hypothesis" | "rewrite" | "plain";
+                    text: string;
+                }[];
+                showCursor: boolean;
+            } | undefined;
+            summaryFallback?: string | undefined;
+            collapsed?: boolean | undefined;
+            promptVersionId?: string | null | undefined;
+            experimentId?: string | null | undefined;
+            promptLink?: string | undefined;
+            experimentLink?: string | undefined;
+            totalElapsed?: string | undefined;
+            totalCost?: string | undefined;
+            autoPatched?: boolean | undefined;
+            patchedVariables?: string[] | undefined;
+        }[];
+        baseline: {
+            promptVersion: string;
+            baselineExperiment: string;
+            metrics: {
+                label: string;
+                value: number;
+                betterIsLower?: boolean | undefined;
+            }[];
+            promptPreview?: string | null | undefined;
+            experimentResult?: {
+                experimentRef: string;
+                experimentStatus: "failed" | "running" | "success";
+                samplesDone: number;
+                samplesTotal: number;
+                correct: number;
+                wrong: number;
+                elapsed: string;
+                tokenSummary: string;
+                costLabel: string;
+                overallRow: {
+                    accuracy: number;
+                    precision: number;
+                    recall: number;
+                    vsLabel: string;
+                    vsDelta: number | null;
+                    vsTone: "ok" | "bad" | "neutral";
+                    deltas?: {
+                        accuracy?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                        precision?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                        recall?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                    } | undefined;
+                } | null;
+                classRows: {
+                    label: string;
+                    precision: number;
+                    recall: number;
+                    vsLabel: string;
+                    vsDelta: number | null;
+                    vsTone: "ok" | "bad" | "neutral";
+                    accuracy?: number | undefined;
+                    f1?: number | undefined;
+                    fpr?: number | undefined;
+                    deltas?: {
+                        accuracy?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                        precision?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                        recall?: {
+                            value: number;
+                            vsLabel: string;
+                            tone: "ok" | "bad" | "neutral";
+                            betterIsLower?: boolean | undefined;
+                        } | undefined;
+                    } | undefined;
+                }[];
+                vsPrevLabel: string;
+            } | undefined;
+        } | null;
+        goalProgress: {
+            label: string;
+            targetText: string;
+            currentText: string;
+            achieved: "hit" | "miss" | "critical";
+            percent: number;
+        }[];
+        bestVersion: {
+            promptRef: string;
+            promptVersion: string;
+            generatedAtRoundLabel: string;
+            metrics: {
+                label: string;
+                value: number;
+                tone?: "ok" | "bad" | "neutral" | undefined;
+            }[];
+            experimentRef: string;
+            generatedAtRoundIndex?: number | null | undefined;
+            promptVersionId?: string | null | undefined;
+            experimentId?: string | null | undefined;
+        } | null;
+        trendHasBaseline?: boolean | undefined;
+    }>;
+    createOptimization: (projectId: string, body: CreateOptimizationDto) => Promise<{
+        id: string;
+        projectId: string;
+        name: string;
+        description: string | null;
+        strategy: string;
+        startingMode: "from_experiment" | "from_prompt_version" | "from_dataset_only";
+        status: "failed" | "running" | "stopped" | "cancelled" | "success";
+        controlState: "stop" | "resume" | "cancel" | null;
+        sourceExperimentId: string | null;
+        sourceExperimentName: string | null;
+        promptId: string | null;
+        promptName: string | null;
+        baseVersionId: string | null;
+        baseVersionNumber: number | null;
+        datasetId: string;
+        datasetName: string;
+        datasetSamples: number;
+        experimentModelId: string;
+        experimentModelName: string;
+        analysisModelId: string;
+        analysisModelName: string;
+        promptLanguage: "zh-CN" | "en-US";
+        goals: {
+            metric: "precision" | "recall" | "f1" | "accuracy" | "fpr";
+            comparator: "gte" | "gt" | "lte";
+            target: number;
+            scope: string;
+        }[];
+        fieldWhitelist: {
+            inputFields: string[];
+            metaFields: string[];
+        } | null;
+        runConfig: {
+            [x: string]: unknown;
+            temperature?: number | undefined;
+            concurrency?: number | undefined;
+            rpmLimit?: number | undefined;
+            tpmLimit?: number | undefined;
+            sampleTimeoutSeconds?: number | undefined;
+            retries?: number | undefined;
+            imageEncoding?: "url" | "base64" | undefined;
+        };
+        maxRounds: number;
+        currentRound: number;
+        bestVersionId: string | null;
+        bestVersionNumber: number | null;
+        bestMetrics: Record<string, number> | null;
+        summary: {
+            kind: "failed" | "running" | "stopped" | "cancelled" | "success";
+            reason: string;
+            finalizedAt: string;
+        } | null;
+        analysisFailureReason: string | null;
+        dbosWorkflowId: string | null;
+        createdBy: string;
+        createdByDisplayName: string | null;
+        createdByUsername: string | null;
+        startedAt: string | null;
+        finishedAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string | null;
+        trend?: number[] | null | undefined;
+        trendHasBaseline?: boolean | undefined;
+    }>;
+    controlOptimization: (projectId: string, optimizationId: string, action: OptimizationControlActionDto) => Promise<{
+        id: string;
+        projectId: string;
+        name: string;
+        description: string | null;
+        strategy: string;
+        startingMode: "from_experiment" | "from_prompt_version" | "from_dataset_only";
+        status: "failed" | "running" | "stopped" | "cancelled" | "success";
+        controlState: "stop" | "resume" | "cancel" | null;
+        sourceExperimentId: string | null;
+        sourceExperimentName: string | null;
+        promptId: string | null;
+        promptName: string | null;
+        baseVersionId: string | null;
+        baseVersionNumber: number | null;
+        datasetId: string;
+        datasetName: string;
+        datasetSamples: number;
+        experimentModelId: string;
+        experimentModelName: string;
+        analysisModelId: string;
+        analysisModelName: string;
+        promptLanguage: "zh-CN" | "en-US";
+        goals: {
+            metric: "precision" | "recall" | "f1" | "accuracy" | "fpr";
+            comparator: "gte" | "gt" | "lte";
+            target: number;
+            scope: string;
+        }[];
+        fieldWhitelist: {
+            inputFields: string[];
+            metaFields: string[];
+        } | null;
+        runConfig: {
+            [x: string]: unknown;
+            temperature?: number | undefined;
+            concurrency?: number | undefined;
+            rpmLimit?: number | undefined;
+            tpmLimit?: number | undefined;
+            sampleTimeoutSeconds?: number | undefined;
+            retries?: number | undefined;
+            imageEncoding?: "url" | "base64" | undefined;
+        };
+        maxRounds: number;
+        currentRound: number;
+        bestVersionId: string | null;
+        bestVersionNumber: number | null;
+        bestMetrics: Record<string, number> | null;
+        summary: {
+            kind: "failed" | "running" | "stopped" | "cancelled" | "success";
+            reason: string;
+            finalizedAt: string;
+        } | null;
+        analysisFailureReason: string | null;
+        dbosWorkflowId: string | null;
+        createdBy: string;
+        createdByDisplayName: string | null;
+        createdByUsername: string | null;
+        startedAt: string | null;
+        finishedAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string | null;
+        trend?: number[] | null | undefined;
+        trendHasBaseline?: boolean | undefined;
+    }>;
+    deleteOptimization: (projectId: string, optimizationId: string) => Promise<undefined>;
+};
+//# sourceMappingURL=optimization.d.ts.map

package/dist/optimization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"optimization.d.ts","sourceRoot":"","sources":["../src/optimization.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,4BAA4B,EAG5B,wBAAwB,EAExB,qBAAqB,EACtB,MAAM,oBAAoB,CAAC;AAG5B,eAAO,MAAM,kBAAkB;mCACE,MAAM,UAAU,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAI1C,MAAM,kBAAkB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAI3B,MAAM,QAAQ,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCAKtD,MAAM,kBACD,MAAM,UACd,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAON,MAAM,kBAAkB,MAAM;CAI/D,CAAC"}

package/dist/optimization.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optimizationClient = void 0;
+const http_1 = require("./http");
+exports.optimizationClient = {
+    listOptimizations: (projectId, query) => http_1.httpClient
+        .get(`/optimizations`, { params: query })
+        .then((r) => r.data),
+    getOptimization: (projectId, optimizationId) => http_1.httpClient
+        .get(`/optimizations/${optimizationId}`)
+        .then((r) => r.data),
+    createOptimization: (projectId, body) => http_1.httpClient
+        .post(`/optimizations`, body)
+        .then((r) => r.data),
+    controlOptimization: (projectId, optimizationId, action) => http_1.httpClient
+        .post(`/optimizations/${optimizationId}/actions/${action}`)
+        .then((r) => r.data),
+    deleteOptimization: (projectId, optimizationId) => http_1.httpClient
+        .delete(`/optimizations/${optimizationId}`)
+        .then(() => undefined),
+};
+//# sourceMappingURL=optimization.js.map

package/dist/optimization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"optimization.js","sourceRoot":"","sources":["../src/optimization.ts"],"names":[],"mappings":";;;AAQA,iCAAoC;AAEvB,QAAA,kBAAkB,GAAG;IAChC,iBAAiB,EAAE,CAAC,SAAiB,EAAE,KAAgC,EAAE,EAAE,CACzE,iBAAU;SACP,GAAG,CAA8B,gBAAgB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;SACrE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACxB,eAAe,EAAE,CAAC,SAAiB,EAAE,cAAsB,EAAE,EAAE,CAC7D,iBAAU;SACP,GAAG,CAAwB,kBAAkB,cAAc,EAAE,CAAC;SAC9D,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACxB,kBAAkB,EAAE,CAAC,SAAiB,EAAE,IAA2B,EAAE,EAAE,CACrE,iBAAU;SACP,IAAI,CAA0B,gBAAgB,EAAE,IAAI,CAAC;SACrD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACxB,mBAAmB,EAAE,CACnB,SAAiB,EACjB,cAAsB,EACtB,MAAoC,EACpC,EAAE,CACF,iBAAU;SACP,IAAI,CACH,kBAAkB,cAAc,YAAY,MAAM,EAAE,CACrD;SACA,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACxB,kBAAkB,EAAE,CAAC,SAAiB,EAAE,cAAsB,EAAE,EAAE,CAChE,iBAAU;SACP,MAAM,CAAO,kBAAkB,cAAc,EAAE,CAAC;SAChD,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;CAC3B,CAAC"}