@orq-ai/node 4.16.0-rc.4 → 4.16.0-rc.40

package/src/models/components/annotationfilter.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 AnnotationFilter = {
+  id?: string | undefined;
+  displayName?: string | undefined;
+  type?: string | undefined;
+  optionValues?: Array<string> | undefined;
+};
+
+/** @internal */
+export const AnnotationFilter$inboundSchema: z.ZodType<
+  AnnotationFilter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  display_name: z.string().optional(),
+  type: z.string().optional(),
+  option_values: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "option_values": "optionValues",
+  });
+});
+
+export function annotationFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<AnnotationFilter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnnotationFilter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnnotationFilter' from JSON`,
+  );
+}

package/src/models/components/apikeyrestresponse.ts

@@ -16,7 +16,7 @@ export type ApiKeyRestResponse = {
   name: string;
   workspaceId: string;
   /**
-   * Raw on create/retrieve and masked in list responses.
+   * Raw on create; the key prefix on retrieve and update; masked in list responses.
    */
   token: string;
   active?: boolean | undefined;

package/src/models/components/budgetlimits.ts

@@ -24,12 +24,10 @@ export type BudgetLimits = {
   period?: BudgetPeriod | undefined;
   amount?: number | undefined;
   /**
-   * Token ceiling. Carried as a double so it serializes as a JSON number
+   * Token ceiling for the budget period. Token counts are whole numbers
    *
    * @remarks
-   *  (proto int64 would serialize as a quoted string); token counts are
-   *  whole and well within double's exact-integer range (2^53). Stored as
-   *  an integer server-side.
+   *  and stored as integers.
    */
   tokenLimit?: number | undefined;
 };

package/src/models/components/budgetlimitsrestresponse.ts

@@ -19,12 +19,10 @@ export type BudgetLimitsRestResponse = {
   period?: BudgetPeriod | undefined;
   amount?: number | undefined;
   /**
-   * Token ceiling. Carried as a double so it serializes as a JSON number
+   * Token ceiling for the budget period. Token counts are whole numbers
    *
    * @remarks
-   *  (proto int64 would serialize as a quoted string); token counts are
-   *  whole and well within double's exact-integer range (2^53). Stored as
-   *  an integer server-side.
+   *  and stored as integers.
    */
   tokenLimit?: number | undefined;
 };

package/src/models/components/budgetrestresponse.ts

@@ -31,23 +31,22 @@ import {
 export type BudgetRestResponse = {
   budgetId: string;
   /**
-   * Denormalized metadata for UI rendering, list filters, and the
+   * Scope the budget was created for, used to group and filter budgets in
    *
    * @remarks
-   *  resolver's prefilter index. Never consulted for matching — the
-   *  `match` expression is the single source of matching semantics.
-   *  Unset for budgets created from a raw CEL expression ("custom").
+   *  the console. Not used for matching: the `match` expression decides
+   *  which requests a budget applies to. Unset for budgets created from a
+   *  raw CEL expression ("custom").
    */
   scope?: BudgetScopeRestResponse | undefined;
   /**
-   * The matching semantics of the budget. The enforcement resolver
+   * The matching semantics of the budget. A budget applies to a request
    *
    * @remarks
-   *  evaluates `match.cel` against the request context; a budget
-   *  applies to a request if and only if the expression evaluates to
-   *  true. Scoped creates derive a canonical expression (e.g.
-   *  `provider == "openai"`); an empty expression always matches
-   *  (workspace-wide).
+   *  when `match.cel` evaluates to true against the request context.
+   *  Creating a budget for a scope derives the expression for that scope
+   *  (e.g. `provider == "openai"`); an empty expression matches every
+   *  request in the workspace.
    */
   match?: BudgetMatch | undefined;
   /**
@@ -59,10 +58,10 @@ export type BudgetRestResponse = {
    */
   limits: BudgetLimitsRestResponse;
   /**
-   * RateLimit is the per-minute request ceiling. Enforced via atomic
+   * Per-minute request ceiling applied to the requests this budget
    *
    * @remarks
-   *  increment-first semantics in the enforcement middleware.
+   *  matches.
    */
   rateLimit?: RateLimitRestResponse | undefined;
   isActive: boolean;

package/src/models/components/budgetscope.ts

@@ -82,7 +82,7 @@ export type BudgetScope = {
    *
    * @remarks
    *  it ("openai/gpt-4o", or "workspaceKey@openai/gpt-4o" for private
-   *  models), rather than an internal identifier.
+   *  models).
    */
   model?: ModelBudgetScope | undefined;
 };

package/src/models/components/budgetscoperestresponse.ts

@@ -69,7 +69,7 @@ export type BudgetScopeRestResponse = {
    *
    * @remarks
    *  it ("openai/gpt-4o", or "workspaceKey@openai/gpt-4o" for private
-   *  models), rather than an internal identifier.
+   *  models).
    */
   model?: ModelBudgetScopeRestResponse | undefined;
 };

package/src/models/components/bulkcreatedatapointsrequest.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  DatapointInput,
+  DatapointInput$Outbound,
+  DatapointInput$outboundSchema,
+} from "./datapointinput.js";
+
+export type BulkCreateDatapointsRequest = {
+  items: Array<DatapointInput>;
+};
+
+/** @internal */
+export type BulkCreateDatapointsRequest$Outbound = {
+  items: Array<DatapointInput$Outbound>;
+};
+
+/** @internal */
+export const BulkCreateDatapointsRequest$outboundSchema: z.ZodType<
+  BulkCreateDatapointsRequest$Outbound,
+  z.ZodTypeDef,
+  BulkCreateDatapointsRequest
+> = z.object({
+  items: z.array(DatapointInput$outboundSchema),
+});
+
+export function bulkCreateDatapointsRequestToJSON(
+  bulkCreateDatapointsRequest: BulkCreateDatapointsRequest,
+): string {
+  return JSON.stringify(
+    BulkCreateDatapointsRequest$outboundSchema.parse(
+      bulkCreateDatapointsRequest,
+    ),
+  );
+}

package/src/models/components/classifyanswer.ts

@@ -27,7 +27,7 @@ export type ClassifyAnswer = {
    */
   choice?: string | undefined;
   /**
-   * Confidence in the selected option or level. Present for choice and score answers.
+   * How sure the model is of the answer it selected: on chat models the largest value in probabilities, so it adds nothing the distribution does not; typesafe/jev-latest returns its own calibrated value, which can sit below the largest probability. Present for choice and score answers.
    */
   confidence?: number | undefined;
   /**
@@ -43,7 +43,7 @@ export type ClassifyAnswer = {
    */
   probabilities?: { [k: string]: number } | undefined;
   /**
-   * The selected level index. Present for score answers.
+   * Position on the scale, not an index: on chat models the weighted index, each level index multiplied by that level probability and summed, so the value is usually fractional; typesafe/jev-latest returns its own score. Present for score answers.
    */
   score?: number | undefined;
   /**

package/src/models/components/classifyusage.ts

@@ -18,11 +18,11 @@ export type ClassifyUsage = {
    */
   inputTokens: number;
   /**
-   * Cost (USD) of output tokens, always 0 for classify. Present when billing was computed for this request.
+   * Cost (USD) of output tokens. 0 for typesafe/jev-latest. Present when billing was computed for this request.
    */
   outputCost?: number | undefined;
   /**
-   * The number of output tokens generated. Not billed.
+   * The number of output tokens generated. Free for typesafe/jev-latest, billed at the model rate for chat models.
    */
   outputTokens: number;
   /**

package/src/models/components/constraints.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type Constraints = {
+  expiresAt?: Date | undefined;
+};
+
+/** @internal */
+export type Constraints$Outbound = {
+  expires_at?: string | undefined;
+};
+
+/** @internal */
+export const Constraints$outboundSchema: z.ZodType<
+  Constraints$Outbound,
+  z.ZodTypeDef,
+  Constraints
+> = z.object({
+  expiresAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    expiresAt: "expires_at",
+  });
+});
+
+export function constraintsToJSON(constraints: Constraints): string {
+  return JSON.stringify(Constraints$outboundSchema.parse(constraints));
+}

package/src/models/components/createdatasetrequest.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type CreateDatasetRequest = {
+  /**
+   * Human-readable dataset name.
+   */
+  displayName: string;
+  /**
+   * Project path where the dataset should be stored, in the format `project/folder/subfolder`. With a project-scoped API key the path is relative to that project. Omit to use the API key project or the workspace default project.
+   */
+  path?: string | undefined;
+};
+
+/** @internal */
+export type CreateDatasetRequest$Outbound = {
+  display_name: string;
+  path?: string | undefined;
+};
+
+/** @internal */
+export const CreateDatasetRequest$outboundSchema: z.ZodType<
+  CreateDatasetRequest$Outbound,
+  z.ZodTypeDef,
+  CreateDatasetRequest
+> = z.object({
+  displayName: z.string(),
+  path: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+  });
+});
+
+export function createDatasetRequestToJSON(
+  createDatasetRequest: CreateDatasetRequest,
+): string {
+  return JSON.stringify(
+    CreateDatasetRequest$outboundSchema.parse(createDatasetRequest),
+  );
+}

package/src/models/components/createenvironmentrequest.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 {
+  Sharing,
+  Sharing$Outbound,
+  Sharing$outboundSchema,
+} from "./sharing.js";
+
+export type CreateEnvironmentRequest = {
+  slug: string;
+  displayName: string;
+  description?: string | undefined;
+  projectId?: string | undefined;
+  /**
+   * Sharing controls which projects in the workspace may use this entity and
+   *
+   * @remarks
+   *  what they may do with it.
+   */
+  sharing?: Sharing | undefined;
+};
+
+/** @internal */
+export type CreateEnvironmentRequest$Outbound = {
+  slug: string;
+  display_name: string;
+  description?: string | undefined;
+  project_id?: string | undefined;
+  sharing?: Sharing$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateEnvironmentRequest$outboundSchema: z.ZodType<
+  CreateEnvironmentRequest$Outbound,
+  z.ZodTypeDef,
+  CreateEnvironmentRequest
+> = z.object({
+  slug: z.string(),
+  displayName: z.string(),
+  description: z.string().optional(),
+  projectId: z.string().optional(),
+  sharing: Sharing$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    projectId: "project_id",
+  });
+});
+
+export function createEnvironmentRequestToJSON(
+  createEnvironmentRequest: CreateEnvironmentRequest,
+): string {
+  return JSON.stringify(
+    CreateEnvironmentRequest$outboundSchema.parse(createEnvironmentRequest),
+  );
+}

package/src/models/components/createenvironmentresponse.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 { Environment, Environment$inboundSchema } from "./environment.js";
+
+export type CreateEnvironmentResponse = {
+  environment: Environment;
+};
+
+/** @internal */
+export const CreateEnvironmentResponse$inboundSchema: z.ZodType<
+  CreateEnvironmentResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  environment: Environment$inboundSchema,
+});
+
+export function createEnvironmentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateEnvironmentResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateEnvironmentResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateEnvironmentResponse' from JSON`,
+  );
+}

package/src/models/components/createmanagementkeyrequest.ts

@@ -15,7 +15,7 @@ export type CreateManagementKeyRequest = {
    * Human-readable name. Required.
    */
   name: string;
-  permissionMode?: ManagementPermissionMode | undefined;
+  permissionMode: ManagementPermissionMode;
   /**
    * Per-domain access map. Required when `permission_mode` =
    *
@@ -39,7 +39,7 @@ export type CreateManagementKeyRequest = {
 /** @internal */
 export type CreateManagementKeyRequest$Outbound = {
   name: string;
-  permission_mode?: string | undefined;
+  permission_mode: string;
   access?: { [k: string]: string } | undefined;
   expires_at?: string | undefined;
 };
@@ -51,7 +51,7 @@ export const CreateManagementKeyRequest$outboundSchema: z.ZodType<
   CreateManagementKeyRequest
 > = z.object({
   name: z.string(),
-  permissionMode: ManagementPermissionMode$outboundSchema.optional(),
+  permissionMode: ManagementPermissionMode$outboundSchema,
   access: z.record(AccessLevel$outboundSchema).optional(),
   expiresAt: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {

package/src/models/components/createmodelfusionrequest.ts

@@ -0,0 +1,95 @@
+/*
+ * 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 {
+  ModelFusionPreset,
+  ModelFusionPreset$outboundSchema,
+} from "./modelfusionpreset.js";
+import {
+  ModelFusionSynthesisMode,
+  ModelFusionSynthesisMode$outboundSchema,
+} from "./modelfusionsynthesismode.js";
+
+export type CreateModelFusionRequest = {
+  /**
+   * Required. Stable lowercase key containing letters, numbers, and hyphens.
+   */
+  key: string;
+  /**
+   * Required. One to eight distinct chat/text model references in provider/model format.
+   */
+  panelModels: Array<string>;
+  /**
+   * Required. Model reference used for strict structured judge output.
+   */
+  judgeModel: string;
+  synthesisMode: ModelFusionSynthesisMode;
+  preset: ModelFusionPreset;
+  /**
+   * Required for analysis mode and invalid for judge_writes_final mode.
+   */
+  orchestratorModel?: string | undefined;
+  /**
+   * Optional. Defaults to true.
+   */
+  webTools?: boolean | undefined;
+  /**
+   * Optional. Defaults to 8 and must be between 0 and 20. Zero disables Fusion-managed tool calls.
+   */
+  maxToolCalls?: number | undefined;
+  /**
+   * Optional. Defaults to true.
+   */
+  feedRawToSynth?: boolean | undefined;
+};
+
+/** @internal */
+export type CreateModelFusionRequest$Outbound = {
+  key: string;
+  panel_models: Array<string>;
+  judge_model: string;
+  synthesis_mode: string;
+  preset: string;
+  orchestrator_model?: string | undefined;
+  web_tools?: boolean | undefined;
+  max_tool_calls?: number | undefined;
+  feed_raw_to_synth?: boolean | undefined;
+};
+
+/** @internal */
+export const CreateModelFusionRequest$outboundSchema: z.ZodType<
+  CreateModelFusionRequest$Outbound,
+  z.ZodTypeDef,
+  CreateModelFusionRequest
+> = z.object({
+  key: z.string(),
+  panelModels: z.array(z.string()),
+  judgeModel: z.string(),
+  synthesisMode: ModelFusionSynthesisMode$outboundSchema,
+  preset: ModelFusionPreset$outboundSchema,
+  orchestratorModel: z.string().optional(),
+  webTools: z.boolean().optional(),
+  maxToolCalls: z.number().int().optional(),
+  feedRawToSynth: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    panelModels: "panel_models",
+    judgeModel: "judge_model",
+    synthesisMode: "synthesis_mode",
+    orchestratorModel: "orchestrator_model",
+    webTools: "web_tools",
+    maxToolCalls: "max_tool_calls",
+    feedRawToSynth: "feed_raw_to_synth",
+  });
+});
+
+export function createModelFusionRequestToJSON(
+  createModelFusionRequest: CreateModelFusionRequest,
+): string {
+  return JSON.stringify(
+    CreateModelFusionRequest$outboundSchema.parse(createModelFusionRequest),
+  );
+}

package/src/models/components/createmodelfusionresponse.ts

@@ -0,0 +1,37 @@
+/*
+ * 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 { ModelFusion, ModelFusion$inboundSchema } from "./modelfusion.js";
+
+export type CreateModelFusionResponse = {
+  modelFusion: ModelFusion;
+};
+
+/** @internal */
+export const CreateModelFusionResponse$inboundSchema: z.ZodType<
+  CreateModelFusionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model_fusion: ModelFusion$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "model_fusion": "modelFusion",
+  });
+});
+
+export function createModelFusionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateModelFusionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateModelFusionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateModelFusionResponse' from JSON`,
+  );
+}

package/src/models/components/createwikirequest.ts

@@ -0,0 +1,67 @@
+/*
+ * 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 {
+  WikiRepository,
+  WikiRepository$Outbound,
+  WikiRepository$outboundSchema,
+} from "./wikirepository.js";
+import {
+  WikiSettings,
+  WikiSettings$Outbound,
+  WikiSettings$outboundSchema,
+} from "./wikisettings.js";
+
+export type CreateWikiRequest = {
+  displayName?: string | undefined;
+  repository?: WikiRepository | undefined;
+  branch?: string | undefined;
+  scmConnectionId?: string | undefined;
+  settings?: WikiSettings | undefined;
+  importExisting?: boolean | undefined;
+  factoryId?: string | undefined;
+};
+
+/** @internal */
+export type CreateWikiRequest$Outbound = {
+  display_name?: string | undefined;
+  repository?: WikiRepository$Outbound | undefined;
+  branch?: string | undefined;
+  scm_connection_id?: string | undefined;
+  settings?: WikiSettings$Outbound | undefined;
+  import_existing?: boolean | undefined;
+  factory_id?: string | undefined;
+};
+
+/** @internal */
+export const CreateWikiRequest$outboundSchema: z.ZodType<
+  CreateWikiRequest$Outbound,
+  z.ZodTypeDef,
+  CreateWikiRequest
+> = z.object({
+  displayName: z.string().optional(),
+  repository: WikiRepository$outboundSchema.optional(),
+  branch: z.string().optional(),
+  scmConnectionId: z.string().optional(),
+  settings: WikiSettings$outboundSchema.optional(),
+  importExisting: z.boolean().optional(),
+  factoryId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    scmConnectionId: "scm_connection_id",
+    importExisting: "import_existing",
+    factoryId: "factory_id",
+  });
+});
+
+export function createWikiRequestToJSON(
+  createWikiRequest: CreateWikiRequest,
+): string {
+  return JSON.stringify(
+    CreateWikiRequest$outboundSchema.parse(createWikiRequest),
+  );
+}

package/src/models/components/createwikiresponse.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 { Wiki, Wiki$inboundSchema } from "./wiki.js";
+
+export type CreateWikiResponse = {
+  wiki?: Wiki | undefined;
+};
+
+/** @internal */
+export const CreateWikiResponse$inboundSchema: z.ZodType<
+  CreateWikiResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  wiki: Wiki$inboundSchema.optional(),
+});
+
+export function createWikiResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateWikiResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateWikiResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateWikiResponse' from JSON`,
+  );
+}

package/src/models/components/datapoint.ts

@@ -9,13 +9,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type DataPoint = {
   /**
-   * Bucket start in UTC, RFC 3339. Clients that need epoch ms can call
+   * Bucket start in UTC, RFC 3339. Clients that need epoch milliseconds
    *
    * @remarks
-   *  `Date.parse(timestamp)` or `new Date(timestamp).getTime()` —
-   *  returning the int64 in JSON would force a string (protojson rule)
-   *  and force callers to coerce anyway, so we ship ISO only. Unset for
-   *  `mode=scalar` rows, which aggregate the whole window.
+   *  can derive them from this value. Unset for `mode=scalar` rows, which
+   *  aggregate the whole window.
    */
   timestamp?: Date | undefined;
   /**