@buildinternet/releases-api-types 0.58.3 → 0.60.0

package/dist/schemas/classifications.d.ts

@@ -0,0 +1,134 @@
+import { z } from "zod";
+/** `GET /v1/admin/classifications/summary`. */
+export declare const ClassificationSummarySchema: z.ZodObject<{
+    after: z.ZodString;
+    before: z.ZodString;
+    bucket: z.ZodEnum<{
+        day: "day";
+        hour: "hour";
+    }>;
+    origin: z.ZodEnum<{
+        all: "all";
+        eval: "eval";
+        ingest: "ingest";
+        manual: "manual";
+    }>;
+    totals: z.ZodObject<{
+        classified: z.ZodNumber;
+        kept: z.ZodNumber;
+        suppressed: z.ZodNumber;
+        failed: z.ZodNumber;
+        skipped: z.ZodNumber;
+        costUsd: z.ZodNumber;
+        suppressionRate: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>;
+    series: z.ZodArray<z.ZodObject<{
+        t: z.ZodString;
+        kept: z.ZodNumber;
+        suppressed: z.ZodNumber;
+        failed: z.ZodNumber;
+        skipped: z.ZodNumber;
+    }, z.core.$strip>>;
+    choices: z.ZodArray<z.ZodObject<{
+        choice: z.ZodString;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+    choiceSeries: z.ZodArray<z.ZodObject<{
+        t: z.ZodString;
+        choices: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    }, z.core.$strip>>;
+    models: z.ZodArray<z.ZodObject<{
+        provider: z.ZodString;
+        model: z.ZodString;
+        count: z.ZodNumber;
+        costUsd: z.ZodNumber;
+    }, z.core.$strip>>;
+    probability: z.ZodObject<{
+        threshold: z.ZodNumber;
+        selected: z.ZodObject<{
+            bins: z.ZodArray<z.ZodObject<{
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+                count: z.ZodNumber;
+            }, z.core.$strip>>;
+            missing: z.ZodNumber;
+        }, z.core.$strip>;
+        confidence: z.ZodObject<{
+            bins: z.ZodArray<z.ZodObject<{
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+                count: z.ZodNumber;
+            }, z.core.$strip>>;
+            missing: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    meta: z.ZodObject<{
+        dataset: z.ZodString;
+        retentionDays: z.ZodLiteral<90>;
+        sampled: z.ZodLiteral<true>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/** One sampled decision from `GET /v1/admin/classifications/recent`. */
+export declare const ClassificationRecentItemSchema: z.ZodObject<{
+    timestamp: z.ZodString;
+    origin: z.ZodEnum<{
+        eval: "eval";
+        ingest: "ingest";
+        manual: "manual";
+    }>;
+    sourceId: z.ZodNullable<z.ZodString>;
+    sourceName: z.ZodNullable<z.ZodString>;
+    sourceSlug: z.ZodNullable<z.ZodString>;
+    orgSlug: z.ZodNullable<z.ZodString>;
+    releaseId: z.ZodNullable<z.ZodString>;
+    releaseTitle: z.ZodNullable<z.ZodString>;
+    provider: z.ZodString;
+    model: z.ZodString;
+    choice: z.ZodString;
+    selectedChoiceProbability: z.ZodNullable<z.ZodNumber>;
+    providerConfidence: z.ZodNullable<z.ZodNumber>;
+    disposition: z.ZodEnum<{
+        failed: "failed";
+        kept: "kept";
+        skipped: "skipped";
+        suppressed: "suppressed";
+    }>;
+    reason: z.ZodString;
+    failureCategory: z.ZodString;
+    costUsd: z.ZodNullable<z.ZodNumber>;
+    durationMs: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/** `GET /v1/admin/classifications/recent` — newest sampled rows, not weighted. */
+export declare const ClassificationRecentResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        timestamp: z.ZodString;
+        origin: z.ZodEnum<{
+            eval: "eval";
+            ingest: "ingest";
+            manual: "manual";
+        }>;
+        sourceId: z.ZodNullable<z.ZodString>;
+        sourceName: z.ZodNullable<z.ZodString>;
+        sourceSlug: z.ZodNullable<z.ZodString>;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        releaseId: z.ZodNullable<z.ZodString>;
+        releaseTitle: z.ZodNullable<z.ZodString>;
+        provider: z.ZodString;
+        model: z.ZodString;
+        choice: z.ZodString;
+        selectedChoiceProbability: z.ZodNullable<z.ZodNumber>;
+        providerConfidence: z.ZodNullable<z.ZodNumber>;
+        disposition: z.ZodEnum<{
+            failed: "failed";
+            kept: "kept";
+            skipped: "skipped";
+            suppressed: "suppressed";
+        }>;
+        reason: z.ZodString;
+        failureCategory: z.ZodString;
+        costUsd: z.ZodNullable<z.ZodNumber>;
+        durationMs: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+//# sourceMappingURL=classifications.d.ts.map

package/dist/schemas/classifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classifications.d.ts","sourceRoot":"","sources":["../../src/schemas/classifications.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AA2BxB,+CAA+C;AAC/C,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoDtC,CAAC;AAEH,wEAAwE;AACxE,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmBzC,CAAC;AAEH,kFAAkF;AAClF,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAG7C,CAAC"}

package/dist/schemas/classifications.js

@@ -0,0 +1,96 @@
+import { z } from "zod";
+/**
+ * Admin classification analytics (`GET /v1/admin/classifications/summary`
+ * and `/recent`). Decisions live in Analytics Engine; these shapes are the
+ * hydrated read model, not the positional point schema.
+ */
+const ClassificationOriginSchema = z.enum(["ingest", "manual", "eval"]);
+const ClassificationOriginFilterSchema = z.enum(["ingest", "manual", "eval", "all"]);
+const ClassificationDispositionSchema = z.enum(["kept", "suppressed", "failed", "skipped"]);
+const ProbabilityBinSchema = z.object({
+    /** Inclusive. Width is 0.1. See `probability.threshold` for the current
+     *  effective suppression threshold and which bin it falls in. */
+    start: z.number(),
+    /** Exclusive, except the last bin (`0.9`–`1`) which includes `1`. */
+    end: z.number(),
+    count: z.number(),
+});
+const ProbabilityHistogramSchema = z.object({
+    bins: z.array(ProbabilityBinSchema),
+    /** Sampled rows whose double is `< 0` (the absent sentinel). */
+    missing: z.number(),
+});
+/** `GET /v1/admin/classifications/summary`. */
+export const ClassificationSummarySchema = z.object({
+    after: z.string(),
+    before: z.string(),
+    bucket: z.enum(["hour", "day"]),
+    origin: ClassificationOriginFilterSchema,
+    totals: z.object({
+        classified: z.number(),
+        kept: z.number(),
+        suppressed: z.number(),
+        failed: z.number(),
+        skipped: z.number(),
+        costUsd: z.number(),
+        /** `suppressed / (kept + suppressed)`, or null when the denominator is 0. */
+        suppressionRate: z.number().nullable(),
+    }),
+    series: z.array(z.object({
+        t: z.string(),
+        kept: z.number(),
+        suppressed: z.number(),
+        failed: z.number(),
+        skipped: z.number(),
+    })),
+    choices: z.array(z.object({ choice: z.string(), count: z.number() })),
+    choiceSeries: z.array(z.object({
+        t: z.string(),
+        choices: z.record(z.string(), z.number()),
+    })),
+    models: z.array(z.object({
+        provider: z.string(),
+        model: z.string(),
+        count: z.number(),
+        costUsd: z.number(),
+    })),
+    probability: z.object({
+        /** Current effective suppression threshold (operator override, else the
+         *  code default) — no longer a fixed literal now that it's editable via
+         *  `GET/PUT /v1/admin/marketing-classifier`. */
+        threshold: z.number(),
+        selected: ProbabilityHistogramSchema,
+        confidence: ProbabilityHistogramSchema,
+    }),
+    meta: z.object({
+        dataset: z.string(),
+        retentionDays: z.literal(90),
+        sampled: z.literal(true),
+    }),
+});
+/** One sampled decision from `GET /v1/admin/classifications/recent`. */
+export const ClassificationRecentItemSchema = z.object({
+    timestamp: z.string(),
+    origin: ClassificationOriginSchema,
+    sourceId: z.string().nullable(),
+    sourceName: z.string().nullable(),
+    sourceSlug: z.string().nullable(),
+    orgSlug: z.string().nullable(),
+    releaseId: z.string().nullable(),
+    releaseTitle: z.string().nullable(),
+    provider: z.string(),
+    model: z.string(),
+    choice: z.string(),
+    selectedChoiceProbability: z.number().nullable(),
+    providerConfidence: z.number().nullable(),
+    disposition: ClassificationDispositionSchema,
+    reason: z.string(),
+    failureCategory: z.string(),
+    costUsd: z.number().nullable(),
+    durationMs: z.number().nullable(),
+});
+/** `GET /v1/admin/classifications/recent` — newest sampled rows, not weighted. */
+export const ClassificationRecentResponseSchema = z.object({
+    items: z.array(ClassificationRecentItemSchema),
+    nextCursor: z.string().nullable(),
+});