@orq-ai/node 4.12.5 → 4.12.6

package/packages/orq-rc/src/models/components/alert.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AlertCondition,
+  AlertCondition$inboundSchema,
+} from "./alertcondition.js";
+import { AlertQuery, AlertQuery$inboundSchema } from "./alertquery.js";
+import { AlertRun, AlertRun$inboundSchema } from "./alertrun.js";
+
+/**
+ * UI signal preset the alert was created from.
+ */
+export const Signal = {
+  Cost: "cost",
+  Latency: "latency",
+  Errors: "errors",
+  Evals: "evals",
+  Custom: "custom",
+} as const;
+/**
+ * UI signal preset the alert was created from.
+ */
+export type Signal = ClosedEnum<typeof Signal>;
+
+/**
+ * Current runtime status, maintained by the evaluation engine.
+ */
+export const AlertStatus = {
+  Ok: "ok",
+  Degraded: "degraded",
+  Triggered: "triggered",
+} as const;
+/**
+ * Current runtime status, maintained by the evaluation engine.
+ */
+export type AlertStatus = ClosedEnum<typeof AlertStatus>;
+
+export type Alert = {
+  /**
+   * Unique alert identifier assigned by ORQ, for example `alert_01H...`.
+   *
+   * @remarks
+   *  Use this value in retrieve, update, and delete requests.
+   */
+  alertId: string;
+  /**
+   * Workspace-unique display name.
+   */
+  displayName: string;
+  /**
+   * Short human-readable summary of what the alert watches.
+   */
+  description: string;
+  /**
+   * Project that owns the alert. Immutable after creation.
+   */
+  projectId: string;
+  /**
+   * UI signal preset the alert was created from.
+   */
+  signal: Signal;
+  /**
+   * Metric query evaluated on each tick.
+   */
+  query: AlertQuery;
+  /**
+   * Threshold condition applied to the query result.
+   */
+  condition: AlertCondition;
+  /**
+   * Notifiers that receive trigger-open and trigger-resolve
+   *
+   * @remarks
+   *  notifications.
+   */
+  notifierIds: Array<string>;
+  /**
+   * Whether the alert is evaluated. Disabled alerts keep their trigger
+   *
+   * @remarks
+   *  history but stop firing.
+   */
+  enabled: boolean;
+  /**
+   * Current runtime status, maintained by the evaluation engine.
+   */
+  status: AlertStatus;
+  /**
+   * Time when the alert last opened a trigger.
+   */
+  lastTriggeredAt?: Date | undefined;
+  /**
+   * Rolling window of the most recent evaluation ticks, oldest first.
+   *
+   * @remarks
+   *  Maintained by the evaluation engine; read-only.
+   */
+  recentRuns?: Array<AlertRun> | undefined;
+  /**
+   * Time when the alert was created.
+   */
+  createdAt: Date;
+  /**
+   * Time when the alert was last updated.
+   */
+  updatedAt: Date;
+  /**
+   * User ID that created the alert.
+   */
+  createdById: string;
+  /**
+   * User ID that last updated the alert.
+   */
+  updatedById: string;
+};
+
+/** @internal */
+export const Signal$inboundSchema: z.ZodNativeEnum<typeof Signal> = z
+  .nativeEnum(Signal);
+
+/** @internal */
+export const AlertStatus$inboundSchema: z.ZodNativeEnum<typeof AlertStatus> = z
+  .nativeEnum(AlertStatus);
+
+/** @internal */
+export const Alert$inboundSchema: z.ZodType<Alert, z.ZodTypeDef, unknown> = z
+  .object({
+    alert_id: z.string(),
+    display_name: z.string(),
+    description: z.string(),
+    project_id: z.string(),
+    signal: Signal$inboundSchema,
+    query: AlertQuery$inboundSchema,
+    condition: AlertCondition$inboundSchema,
+    notifier_ids: z.array(z.string()),
+    enabled: z.boolean(),
+    status: AlertStatus$inboundSchema,
+    last_triggered_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+    recent_runs: z.array(AlertRun$inboundSchema).optional(),
+    created_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    updated_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    created_by_id: z.string(),
+    updated_by_id: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "alert_id": "alertId",
+      "display_name": "displayName",
+      "project_id": "projectId",
+      "notifier_ids": "notifierIds",
+      "last_triggered_at": "lastTriggeredAt",
+      "recent_runs": "recentRuns",
+      "created_at": "createdAt",
+      "updated_at": "updatedAt",
+      "created_by_id": "createdById",
+      "updated_by_id": "updatedById",
+    });
+  });
+
+export function alertFromJSON(
+  jsonString: string,
+): SafeParseResult<Alert, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Alert$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Alert' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/alertcondition.ts

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Comparison applied as `value <comparator> threshold`.
+ */
+export const Comparator = {
+  Gt: "gt",
+  Gte: "gte",
+  Lt: "lt",
+  Lte: "lte",
+  Eq: "eq",
+} as const;
+/**
+ * Comparison applied as `value <comparator> threshold`.
+ */
+export type Comparator = ClosedEnum<typeof Comparator>;
+
+/**
+ * Look-back window aggregated on each evaluation tick.
+ */
+export const Window = {
+  Fivem: "5m",
+  Fifteenm: "15m",
+  Thirtym: "30m",
+  Oneh: "1h",
+  Fourh: "4h",
+  Oned: "1d",
+} as const;
+/**
+ * Look-back window aggregated on each evaluation tick.
+ */
+export type Window = ClosedEnum<typeof Window>;
+
+/**
+ * How often the alert is evaluated. `30s` is a testing cadence.
+ */
+export const Interval = {
+  Thirtys: "30s",
+  Fivem: "5m",
+  Fifteenm: "15m",
+  Oneh: "1h",
+  Oned: "1d",
+} as const;
+/**
+ * How often the alert is evaluated. `30s` is a testing cadence.
+ */
+export type Interval = ClosedEnum<typeof Interval>;
+
+/**
+ * Ingestion delay subtracted from the evaluation window. Defaults to `120s`.
+ */
+export const Delay = {
+  Thirtys: "30s",
+  Sixtys: "60s",
+  OneHundredAndTwentys: "120s",
+  ThreeHundreds: "300s",
+  SixHundreds: "600s",
+} as const;
+/**
+ * Ingestion delay subtracted from the evaluation window. Defaults to `120s`.
+ */
+export type Delay = ClosedEnum<typeof Delay>;
+
+export type AlertCondition = {
+  /**
+   * Comparison applied as `value <comparator> threshold`.
+   */
+  comparator: Comparator;
+  /**
+   * Critical-tier threshold. Breaching it opens (or escalates) a
+   *
+   * @remarks
+   *  trigger at critical severity.
+   */
+  threshold: number;
+  /**
+   * Optional degraded-tier threshold. Values past it but short of
+   *
+   * @remarks
+   *  `threshold` open a trigger at degraded severity. Must sit on the
+   *  recovery side of `threshold` for the chosen comparator and is not
+   *  supported with `eq`.
+   */
+  degradedThreshold?: number | undefined;
+  /**
+   * Optional custom resolve bound (hysteresis). An open trigger
+   *
+   * @remarks
+   *  resolves only once the value recovers past this bound; defaults to
+   *  the lowest configured tier. Must sit at or past that tier on the
+   *  recovery side. Not supported with `eq`.
+   */
+  resolveThreshold?: number | undefined;
+  /**
+   * Look-back window aggregated on each evaluation tick.
+   */
+  window: Window;
+  /**
+   * How often the alert is evaluated. `30s` is a testing cadence.
+   */
+  interval: Interval;
+  /**
+   * Ingestion delay subtracted from the evaluation window. Defaults to `120s`.
+   */
+  delay?: Delay | undefined;
+};
+
+/** @internal */
+export const Comparator$inboundSchema: z.ZodNativeEnum<typeof Comparator> = z
+  .nativeEnum(Comparator);
+/** @internal */
+export const Comparator$outboundSchema: z.ZodNativeEnum<typeof Comparator> =
+  Comparator$inboundSchema;
+
+/** @internal */
+export const Window$inboundSchema: z.ZodNativeEnum<typeof Window> = z
+  .nativeEnum(Window);
+/** @internal */
+export const Window$outboundSchema: z.ZodNativeEnum<typeof Window> =
+  Window$inboundSchema;
+
+/** @internal */
+export const Interval$inboundSchema: z.ZodNativeEnum<typeof Interval> = z
+  .nativeEnum(Interval);
+/** @internal */
+export const Interval$outboundSchema: z.ZodNativeEnum<typeof Interval> =
+  Interval$inboundSchema;
+
+/** @internal */
+export const Delay$inboundSchema: z.ZodNativeEnum<typeof Delay> = z.nativeEnum(
+  Delay,
+);
+/** @internal */
+export const Delay$outboundSchema: z.ZodNativeEnum<typeof Delay> =
+  Delay$inboundSchema;
+
+/** @internal */
+export const AlertCondition$inboundSchema: z.ZodType<
+  AlertCondition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  comparator: Comparator$inboundSchema,
+  threshold: z.number(),
+  degraded_threshold: z.number().optional(),
+  resolve_threshold: z.number().optional(),
+  window: Window$inboundSchema,
+  interval: Interval$inboundSchema,
+  delay: Delay$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "degraded_threshold": "degradedThreshold",
+    "resolve_threshold": "resolveThreshold",
+  });
+});
+/** @internal */
+export type AlertCondition$Outbound = {
+  comparator: string;
+  threshold: number;
+  degraded_threshold?: number | undefined;
+  resolve_threshold?: number | undefined;
+  window: string;
+  interval: string;
+  delay?: string | undefined;
+};
+
+/** @internal */
+export const AlertCondition$outboundSchema: z.ZodType<
+  AlertCondition$Outbound,
+  z.ZodTypeDef,
+  AlertCondition
+> = z.object({
+  comparator: Comparator$outboundSchema,
+  threshold: z.number(),
+  degradedThreshold: z.number().optional(),
+  resolveThreshold: z.number().optional(),
+  window: Window$outboundSchema,
+  interval: Interval$outboundSchema,
+  delay: Delay$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    degradedThreshold: "degraded_threshold",
+    resolveThreshold: "resolve_threshold",
+  });
+});
+
+export function alertConditionToJSON(alertCondition: AlertCondition): string {
+  return JSON.stringify(AlertCondition$outboundSchema.parse(alertCondition));
+}
+export function alertConditionFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertCondition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertCondition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertCondition' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/alertevidence.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AlertEvidence = {
+  /**
+   * Trace the exemplar span belongs to.
+   */
+  traceId: string;
+  /**
+   * Exemplar span ID.
+   */
+  spanId: string;
+  /**
+   * Start time of the exemplar span.
+   */
+  startTime: Date;
+  /**
+   * Metric contribution of the exemplar (e.g. cost or duration).
+   */
+  value: number;
+};
+
+/** @internal */
+export const AlertEvidence$inboundSchema: z.ZodType<
+  AlertEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trace_id: z.string(),
+  span_id: z.string(),
+  start_time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  value: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "trace_id": "traceId",
+    "span_id": "spanId",
+    "start_time": "startTime",
+  });
+});
+
+export function alertEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertEvidence' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/alertquery.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  MonitorFilter,
+  MonitorFilter$inboundSchema,
+  MonitorFilter$Outbound,
+  MonitorFilter$outboundSchema,
+} from "./monitorfilter.js";
+
+export type AlertQuery = {
+  /**
+   * Reporting API catalogue metric, e.g. `genai.cost` or
+   *
+   * @remarks
+   *  `genai.latency.avg`. Validated against the catalogue when the alert
+   *  is saved.
+   */
+  metric: string;
+  /**
+   * Reporting filters combined with AND.
+   */
+  filters?: Array<MonitorFilter> | undefined;
+};
+
+/** @internal */
+export const AlertQuery$inboundSchema: z.ZodType<
+  AlertQuery,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metric: z.string(),
+  filters: z.array(MonitorFilter$inboundSchema).optional(),
+});
+/** @internal */
+export type AlertQuery$Outbound = {
+  metric: string;
+  filters?: Array<MonitorFilter$Outbound> | undefined;
+};
+
+/** @internal */
+export const AlertQuery$outboundSchema: z.ZodType<
+  AlertQuery$Outbound,
+  z.ZodTypeDef,
+  AlertQuery
+> = z.object({
+  metric: z.string(),
+  filters: z.array(MonitorFilter$outboundSchema).optional(),
+});
+
+export function alertQueryToJSON(alertQuery: AlertQuery): string {
+  return JSON.stringify(AlertQuery$outboundSchema.parse(alertQuery));
+}
+export function alertQueryFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertQuery, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertQuery$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertQuery' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/alertrun.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Tier the value landed in when breached. Empty when not breached.
+ */
+export const Severity = {
+  Critical: "critical",
+  Degraded: "degraded",
+} as const;
+/**
+ * Tier the value landed in when breached. Empty when not breached.
+ */
+export type Severity = ClosedEnum<typeof Severity>;
+
+export type AlertRun = {
+  /**
+   * Time of the evaluation tick.
+   */
+  at: Date;
+  /**
+   * Observed metric value. Zero when `has_data` is false.
+   */
+  value: number;
+  /**
+   * Whether the value breached the alert condition.
+   */
+  breached: boolean;
+  /**
+   * Whether the evaluation window contained any data.
+   */
+  hasData: boolean;
+  /**
+   * Tier the value landed in when breached. Empty when not breached.
+   */
+  severity?: Severity | undefined;
+};
+
+/** @internal */
+export const Severity$inboundSchema: z.ZodNativeEnum<typeof Severity> = z
+  .nativeEnum(Severity);
+
+/** @internal */
+export const AlertRun$inboundSchema: z.ZodType<
+  AlertRun,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  value: z.number(),
+  breached: z.boolean(),
+  has_data: z.boolean(),
+  severity: Severity$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_data": "hasData",
+  });
+});
+
+export function alertRunFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertRun, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertRun$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertRun' from JSON`,
+  );
+}