@orq-ai/node 4.11.0-rc.9 → 4.12.0-rc.1

package/src/models/components/evaluatorresponsehttp.ts

@@ -0,0 +1,71 @@
+/*
+ * 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";
+
+export const Method = {
+  Get: "GET",
+  Post: "POST",
+} as const;
+export type Method = ClosedEnum<typeof Method>;
+
+export type EvaluatorResponseHttp = {
+  id: string;
+  description: string;
+  created: string;
+  updated: string;
+  updatedById?: string | null | undefined;
+  guardrailConfig?: any | undefined;
+  type: "http_eval";
+  url: string;
+  method: Method;
+  headers: { [k: string]: string };
+  payload: { [k: string]: any };
+  key: string;
+};
+
+/** @internal */
+export const Method$inboundSchema: z.ZodNativeEnum<typeof Method> = z
+  .nativeEnum(Method);
+
+/** @internal */
+export const EvaluatorResponseHttp$inboundSchema: z.ZodType<
+  EvaluatorResponseHttp,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  description: z.string(),
+  created: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated_by_id: z.nullable(z.string()).optional(),
+  guardrail_config: z.any().optional(),
+  type: z.literal("http_eval"),
+  url: z.string(),
+  method: Method$inboundSchema,
+  headers: z.record(z.string()),
+  payload: z.record(z.any()),
+  key: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "updated_by_id": "updatedById",
+    "guardrail_config": "guardrailConfig",
+  });
+});
+
+export function evaluatorResponseHttpFromJSON(
+  jsonString: string,
+): SafeParseResult<EvaluatorResponseHttp, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvaluatorResponseHttp$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvaluatorResponseHttp' from JSON`,
+  );
+}

package/src/models/components/evaluatorresponsejsonschema.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 EvaluatorResponseJsonSchema = {
+  id: string;
+  description: string;
+  created: string;
+  updated: string;
+  updatedById?: string | null | undefined;
+  guardrailConfig?: any | undefined;
+  type: "json_schema";
+  schema: string;
+  key: string;
+};
+
+/** @internal */
+export const EvaluatorResponseJsonSchema$inboundSchema: z.ZodType<
+  EvaluatorResponseJsonSchema,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  description: z.string(),
+  created: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated_by_id: z.nullable(z.string()).optional(),
+  guardrail_config: z.any().optional(),
+  type: z.literal("json_schema"),
+  schema: z.string(),
+  key: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "updated_by_id": "updatedById",
+    "guardrail_config": "guardrailConfig",
+  });
+});
+
+export function evaluatorResponseJsonSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<EvaluatorResponseJsonSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvaluatorResponseJsonSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvaluatorResponseJsonSchema' from JSON`,
+  );
+}

package/src/models/components/evaluatorresponsellm.ts

@@ -0,0 +1,304 @@
+/*
+ * 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";
+
+export type CategoricalLabels = {
+  value: string;
+  description?: string | undefined;
+};
+
+export const Mode = {
+  Single: "single",
+  Jury: "jury",
+} as const;
+export type Mode = ClosedEnum<typeof Mode>;
+
+export type Retry = {
+  count: number;
+  onCodes?: Array<number> | undefined;
+};
+
+export type Fallbacks = {
+  model: string;
+};
+
+export type Judges = {
+  model: string;
+  retry?: Retry | undefined;
+  fallbacks?: Array<Fallbacks> | undefined;
+};
+
+export type EvaluatorResponseLlmRetry = {
+  count: number;
+  onCodes?: Array<number> | undefined;
+};
+
+export type EvaluatorResponseLlmFallbacks = {
+  model: string;
+};
+
+export type ReplacementJudges = {
+  model: string;
+  retry?: EvaluatorResponseLlmRetry | undefined;
+  fallbacks?: Array<EvaluatorResponseLlmFallbacks> | undefined;
+};
+
+export const TieValue = {
+  Tie: "Tie",
+} as const;
+export type TieValue = ClosedEnum<typeof TieValue>;
+
+export type Jury = {
+  judges: Array<Judges>;
+  replacementJudges?: Array<ReplacementJudges> | undefined;
+  minSuccessfulJudges: number;
+  tieValue: TieValue;
+};
+
+export type EvaluatorResponseLlm = {
+  id: string;
+  description: string;
+  created: string;
+  updated: string;
+  updatedById?: string | null | undefined;
+  guardrailConfig?: any | undefined;
+  type: "llm_eval";
+  repetitions?: number | null | undefined;
+  prompt: string;
+  categories?: Array<string> | null | undefined;
+  categoricalLabels?: Array<CategoricalLabels> | null | undefined;
+  datasetId?: string | undefined;
+  key: string;
+  mode: Mode;
+  model?: string | undefined;
+  jury?: Jury | undefined;
+};
+
+/** @internal */
+export const CategoricalLabels$inboundSchema: z.ZodType<
+  CategoricalLabels,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  value: z.string(),
+  description: z.string().optional(),
+});
+
+export function categoricalLabelsFromJSON(
+  jsonString: string,
+): SafeParseResult<CategoricalLabels, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CategoricalLabels$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CategoricalLabels' from JSON`,
+  );
+}
+
+/** @internal */
+export const Mode$inboundSchema: z.ZodNativeEnum<typeof Mode> = z.nativeEnum(
+  Mode,
+);
+
+/** @internal */
+export const Retry$inboundSchema: z.ZodType<Retry, z.ZodTypeDef, unknown> = z
+  .object({
+    count: z.number().int().default(2),
+    on_codes: z.array(z.number().int()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "on_codes": "onCodes",
+    });
+  });
+
+export function retryFromJSON(
+  jsonString: string,
+): SafeParseResult<Retry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Retry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Retry' from JSON`,
+  );
+}
+
+/** @internal */
+export const Fallbacks$inboundSchema: z.ZodType<
+  Fallbacks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+});
+
+export function fallbacksFromJSON(
+  jsonString: string,
+): SafeParseResult<Fallbacks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Fallbacks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Fallbacks' from JSON`,
+  );
+}
+
+/** @internal */
+export const Judges$inboundSchema: z.ZodType<Judges, z.ZodTypeDef, unknown> = z
+  .object({
+    model: z.string(),
+    retry: z.lazy(() => Retry$inboundSchema).optional(),
+    fallbacks: z.array(z.lazy(() => Fallbacks$inboundSchema)).optional(),
+  });
+
+export function judgesFromJSON(
+  jsonString: string,
+): SafeParseResult<Judges, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Judges$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Judges' from JSON`,
+  );
+}
+
+/** @internal */
+export const EvaluatorResponseLlmRetry$inboundSchema: z.ZodType<
+  EvaluatorResponseLlmRetry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int().default(2),
+  on_codes: z.array(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "on_codes": "onCodes",
+  });
+});
+
+export function evaluatorResponseLlmRetryFromJSON(
+  jsonString: string,
+): SafeParseResult<EvaluatorResponseLlmRetry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvaluatorResponseLlmRetry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvaluatorResponseLlmRetry' from JSON`,
+  );
+}
+
+/** @internal */
+export const EvaluatorResponseLlmFallbacks$inboundSchema: z.ZodType<
+  EvaluatorResponseLlmFallbacks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+});
+
+export function evaluatorResponseLlmFallbacksFromJSON(
+  jsonString: string,
+): SafeParseResult<EvaluatorResponseLlmFallbacks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvaluatorResponseLlmFallbacks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvaluatorResponseLlmFallbacks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReplacementJudges$inboundSchema: z.ZodType<
+  ReplacementJudges,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+  retry: z.lazy(() => EvaluatorResponseLlmRetry$inboundSchema).optional(),
+  fallbacks: z.array(z.lazy(() => EvaluatorResponseLlmFallbacks$inboundSchema))
+    .optional(),
+});
+
+export function replacementJudgesFromJSON(
+  jsonString: string,
+): SafeParseResult<ReplacementJudges, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReplacementJudges$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReplacementJudges' from JSON`,
+  );
+}
+
+/** @internal */
+export const TieValue$inboundSchema: z.ZodNativeEnum<typeof TieValue> = z
+  .nativeEnum(TieValue);
+
+/** @internal */
+export const Jury$inboundSchema: z.ZodType<Jury, z.ZodTypeDef, unknown> = z
+  .object({
+    judges: z.array(z.lazy(() => Judges$inboundSchema)),
+    replacement_judges: z.array(z.lazy(() => ReplacementJudges$inboundSchema))
+      .optional(),
+    min_successful_judges: z.number().int().default(2),
+    tie_value: TieValue$inboundSchema.default("Tie"),
+  }).transform((v) => {
+    return remap$(v, {
+      "replacement_judges": "replacementJudges",
+      "min_successful_judges": "minSuccessfulJudges",
+      "tie_value": "tieValue",
+    });
+  });
+
+export function juryFromJSON(
+  jsonString: string,
+): SafeParseResult<Jury, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Jury$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Jury' from JSON`,
+  );
+}
+
+/** @internal */
+export const EvaluatorResponseLlm$inboundSchema: z.ZodType<
+  EvaluatorResponseLlm,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  description: z.string(),
+  created: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated_by_id: z.nullable(z.string()).optional(),
+  guardrail_config: z.any().optional(),
+  type: z.literal("llm_eval"),
+  repetitions: z.nullable(z.number().int()).optional(),
+  prompt: z.string(),
+  categories: z.nullable(z.array(z.string())).optional(),
+  categorical_labels: z.nullable(
+    z.array(z.lazy(() => CategoricalLabels$inboundSchema)),
+  ).optional(),
+  dataset_id: z.string().optional(),
+  key: z.string(),
+  mode: Mode$inboundSchema,
+  model: z.string().optional(),
+  jury: z.lazy(() => Jury$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "updated_by_id": "updatedById",
+    "guardrail_config": "guardrailConfig",
+    "categorical_labels": "categoricalLabels",
+    "dataset_id": "datasetId",
+  });
+});
+
+export function evaluatorResponseLlmFromJSON(
+  jsonString: string,
+): SafeParseResult<EvaluatorResponseLlm, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvaluatorResponseLlm$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvaluatorResponseLlm' from JSON`,
+  );
+}

package/src/models/components/evaluatorresponsepython.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 EvaluatorResponsePython = {
+  id: string;
+  description: string;
+  created: string;
+  updated: string;
+  updatedById?: string | null | undefined;
+  guardrailConfig?: any | undefined;
+  code: string;
+  type: "python_eval";
+  key: string;
+};
+
+/** @internal */
+export const EvaluatorResponsePython$inboundSchema: z.ZodType<
+  EvaluatorResponsePython,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  description: z.string(),
+  created: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated_by_id: z.nullable(z.string()).optional(),
+  guardrail_config: z.any().optional(),
+  code: z.string(),
+  type: z.literal("python_eval"),
+  key: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "updated_by_id": "updatedById",
+    "guardrail_config": "guardrailConfig",
+  });
+});
+
+export function evaluatorResponsePythonFromJSON(
+  jsonString: string,
+): SafeParseResult<EvaluatorResponsePython, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvaluatorResponsePython$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvaluatorResponsePython' from JSON`,
+  );
+}

package/src/models/components/evaluatorresponseragas.ts

@@ -0,0 +1,78 @@
+/*
+ * 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";
+
+export const RagasMetric = {
+  ContextPrecision: "context_precision",
+  ContextRecall: "context_recall",
+  ContextEntitiesRecall: "context_entities_recall",
+  Harmfulness: "harmfulness",
+  Maliciousness: "maliciousness",
+  Coherence: "coherence",
+  Correctness: "correctness",
+  Conciseness: "conciseness",
+  ResponseRelevancy: "response_relevancy",
+  Faithfulness: "faithfulness",
+  Summarization: "summarization",
+  NoiseSensitivity: "noise_sensitivity",
+} as const;
+export type RagasMetric = ClosedEnum<typeof RagasMetric>;
+
+export type EvaluatorResponseRagas = {
+  id: string;
+  description: string;
+  created: string;
+  updated: string;
+  updatedById?: string | null | undefined;
+  guardrailConfig?: any | undefined;
+  type: "ragas";
+  ragasMetric: RagasMetric;
+  key: string;
+  model: string;
+};
+
+/** @internal */
+export const RagasMetric$inboundSchema: z.ZodNativeEnum<typeof RagasMetric> = z
+  .nativeEnum(RagasMetric);
+
+/** @internal */
+export const EvaluatorResponseRagas$inboundSchema: z.ZodType<
+  EvaluatorResponseRagas,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  description: z.string(),
+  created: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated_by_id: z.nullable(z.string()).optional(),
+  guardrail_config: z.any().optional(),
+  type: z.literal("ragas"),
+  ragas_metric: RagasMetric$inboundSchema,
+  key: z.string(),
+  model: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "updated_by_id": "updatedById",
+    "guardrail_config": "guardrailConfig",
+    "ragas_metric": "ragasMetric",
+  });
+});
+
+export function evaluatorResponseRagasFromJSON(
+  jsonString: string,
+): SafeParseResult<EvaluatorResponseRagas, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvaluatorResponseRagas$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvaluatorResponseRagas' from JSON`,
+  );
+}

package/src/models/components/evaluatorresponsetypescript.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 EvaluatorResponseTypescript = {
+  id: string;
+  description: string;
+  created: string;
+  updated: string;
+  updatedById?: string | null | undefined;
+  guardrailConfig?: any | undefined;
+  code: string;
+  type: "typescript_eval";
+  key: string;
+};
+
+/** @internal */
+export const EvaluatorResponseTypescript$inboundSchema: z.ZodType<
+  EvaluatorResponseTypescript,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  description: z.string(),
+  created: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated: z.string().default("2026-07-05T09:16:21.671Z"),
+  updated_by_id: z.nullable(z.string()).optional(),
+  guardrail_config: z.any().optional(),
+  code: z.string(),
+  type: z.literal("typescript_eval"),
+  key: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "updated_by_id": "updatedById",
+    "guardrail_config": "guardrailConfig",
+  });
+});
+
+export function evaluatorResponseTypescriptFromJSON(
+  jsonString: string,
+): SafeParseResult<EvaluatorResponseTypescript, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvaluatorResponseTypescript$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvaluatorResponseTypescript' from JSON`,
+  );
+}

package/src/models/components/getbudgetconsumptionresponse.ts

@@ -0,0 +1,71 @@
+/*
+ * 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";
+import { BudgetPeriod, BudgetPeriod$inboundSchema } from "./budgetperiod.js";
+
+export type GetBudgetConsumptionResponse = {
+  /**
+   * Budget id whose counters are reported.
+   */
+  budgetId?: string | undefined;
+  period?: BudgetPeriod | undefined;
+  /**
+   * Period bucket label (e.g. "2025-05-27" for DAILY, "2025-05" for
+   *
+   * @remarks
+   *  MONTHLY). Empty when no counters exist for the current period.
+   */
+  periodDate?: string | undefined;
+  /**
+   * Cost accumulated in the current period, in USD.
+   */
+  cost?: number | undefined;
+  /**
+   * Tokens accumulated in the current period. Carried as a double (not
+   *
+   * @remarks
+   *  int64) so it serializes as a JSON number rather than a quoted
+   *  string, matching BudgetUsage.tokens and limits.token_limit.
+   */
+  tokens?: number | undefined;
+  /**
+   * Requests counted in the current 60-second rolling window.
+   */
+  requestsInWindow?: number | undefined;
+};
+
+/** @internal */
+export const GetBudgetConsumptionResponse$inboundSchema: z.ZodType<
+  GetBudgetConsumptionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  budget_id: z.string().optional(),
+  period: BudgetPeriod$inboundSchema.optional(),
+  period_date: z.string().optional(),
+  cost: z.number().optional(),
+  tokens: z.number().optional(),
+  requests_in_window: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "budget_id": "budgetId",
+    "period_date": "periodDate",
+    "requests_in_window": "requestsInWindow",
+  });
+});
+
+export function getBudgetConsumptionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetBudgetConsumptionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetBudgetConsumptionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetBudgetConsumptionResponse' from JSON`,
+  );
+}