@orq-ai/node 4.15.0-rc.5 → 4.15.0-rc.50

package/src/models/components/detectrequest.ts

@@ -25,6 +25,47 @@ export type DetectRequest = {
    * When true, the response includes a per-type entity breakdown.
    */
   includeEntities?: boolean | undefined;
+  /**
+   * Region codes selecting whole regions of coverage, e.g. "nl", "gb". Every
+   *
+   * @remarks
+   *  entity type those regions cover is included, alongside the base catalog.
+   *  ["all"] is exclusive. Leaving this and `entities` both empty also runs every
+   *  region, so selecting nothing is the widest request rather than the narrowest.
+   *  Empty alongside a non-empty `entities` stays strict. See the capabilities
+   *  endpoint for the region list.
+   *
+   *  Combines with `entities`: the detector unions the two selections, so a
+   *  request carrying both covers the regions plus the named types. Note that
+   *  `entities` only narrows coverage when it travels alone.
+   */
+  regions?: Array<string> | undefined;
+  /**
+   * The entity types to cover. A named type fires even when it belongs to a
+   *
+   * @remarks
+   *  region, so a region's types can be selected individually without naming
+   *  the region. Alone this is a strict allowlist; alongside `regions` it adds
+   *  to the region coverage instead of narrowing it.
+   */
+  entities?: Array<string> | undefined;
+  /**
+   * Per-entity confidence cutoff overrides. An override REPLACES the global
+   *
+   * @remarks
+   *  `threshold` for that type and may sit above or below it: the gateway
+   *  lowers the first-pass floor it sends the detector to the smallest value
+   *  in the map, and every selected type carries its own cutoff, so a
+   *  sub-global override detects MORE of that type without widening the rest.
+   *
+   *  This only tunes confidence; it never changes which types are covered.
+   *  Coverage is decided by `entities` alone, so every key here must also
+   *  appear in `entities` — a key that does not is rejected, as is any key at
+   *  all when `entities` is empty.
+   *
+   *  Declarative [0,1] bound mirrors existing constraint on `threshold`.
+   */
+  entityThresholds?: { [k: string]: number } | undefined;
 };
 
 /** @internal */
@@ -33,6 +74,9 @@ export type DetectRequest$Outbound = {
   language?: string | undefined;
   threshold?: number | undefined;
   include_entities?: boolean | undefined;
+  regions?: Array<string> | undefined;
+  entities?: Array<string> | undefined;
+  entity_thresholds?: { [k: string]: number } | undefined;
 };
 
 /** @internal */
@@ -45,9 +89,13 @@ export const DetectRequest$outboundSchema: z.ZodType<
   language: z.string().optional(),
   threshold: z.number().optional(),
   includeEntities: z.boolean().optional(),
+  regions: z.array(z.string()).optional(),
+  entities: z.array(z.string()).optional(),
+  entityThresholds: z.record(z.number()).optional(),
 }).transform((v) => {
   return remap$(v, {
     includeEntities: "include_entities",
+    entityThresholds: "entity_thresholds",
   });
 });
 

package/src/models/components/entitylist.ts

@@ -0,0 +1,37 @@
+/*
+ * 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";
+
+/**
+ * EntityList wraps a repeated string because proto3 maps cannot hold
+ *
+ * @remarks
+ *  repeated values directly.
+ */
+export type EntityList = {
+  entities?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EntityList$inboundSchema: z.ZodType<
+  EntityList,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entities: z.array(z.string()).optional(),
+});
+
+export function entityListFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityList, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityList$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityList' from JSON`,
+  );
+}

package/src/models/components/evaluationcontext.ts

@@ -14,17 +14,15 @@ import {
   StructuredOutput$outboundSchema,
 } from "./structuredoutput.js";
 
-export type Messages = {};
-
 /**
  * The data to grade. When `messages` is present it is the conversation and
  *
  * @remarks
  *  `input.user_query` is ignored; `output.response` is appended only when the
- *  conversation carries no assistant turn. Mirrors graders-api buildGraderRequest.
+ *  conversation carries no assistant turn.
  */
 export type EvaluationContext = {
-  messages?: Array<Messages> | undefined;
+  messages?: Array<{ [k: string]: any }> | undefined;
   /**
    * StructuredInput names its fields after the template variables they feed, so
    *
@@ -36,23 +34,9 @@ export type EvaluationContext = {
   variables?: { [k: string]: any } | undefined;
 };
 
-/** @internal */
-export type Messages$Outbound = {};
-
-/** @internal */
-export const Messages$outboundSchema: z.ZodType<
-  Messages$Outbound,
-  z.ZodTypeDef,
-  Messages
-> = z.object({});
-
-export function messagesToJSON(messages: Messages): string {
-  return JSON.stringify(Messages$outboundSchema.parse(messages));
-}
-
 /** @internal */
 export type EvaluationContext$Outbound = {
-  messages?: Array<Messages$Outbound> | undefined;
+  messages?: Array<{ [k: string]: any }> | undefined;
   input?: StructuredInput$Outbound | undefined;
   output?: StructuredOutput$Outbound | undefined;
   variables?: { [k: string]: any } | undefined;
@@ -64,7 +48,7 @@ export const EvaluationContext$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EvaluationContext
 > = z.object({
-  messages: z.array(z.lazy(() => Messages$outboundSchema)).optional(),
+  messages: z.array(z.record(z.any())).optional(),
   input: StructuredInput$outboundSchema.optional(),
   output: StructuredOutput$outboundSchema.optional(),
   variables: z.record(z.any()).optional(),

package/src/models/components/evaluationresult.ts

@@ -9,14 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * The verdict. Shaped to match WorkflowRunMinifiedEvalSchema, the body the
- *
- * @remarks
- *  TypeScript route returned, so existing consumers read the same JSON.
+ * The verdict. Its shape is fixed so existing consumers read the same JSON.
  */
 export type EvaluationResult = {
   /**
-   * Discriminator, matching the legacy union: "string", "number", "boolean",
+   * Discriminator for the verdict shape: "string", "number", "boolean",
    *
    * @remarks
    *  "string_array", "rouge_n", "bert_score", "llm_evaluator", "http_eval".
@@ -34,17 +31,16 @@ export type EvaluationResult = {
    * Trace reference of the evaluator's own span. Optional so an absent
    *
    * @remarks
-   *  reference is omitted rather than emitted as an empty string, matching the
-   *  legacy body.
+   *  reference is omitted rather than emitted as an empty string.
    */
   traceId?: string | undefined;
   spanId?: string | undefined;
   evaluatorId?: string | undefined;
   /**
-   * How the run ended, as distinct from `passed`: "passed", "condition_failed"
+   * How the run ended, as distinct from `passed`: "passed", "condition_failed",
    *
    * @remarks
-   *  or "timed_out". A string, not an enum, because the engine owns the
+   *  "failed" or "timed_out". A string, not an enum, because the engine owns the
    *  vocabulary.
    */
   status?: string | undefined;
@@ -52,8 +48,8 @@ export type EvaluationResult = {
    * The guardrail's decision when the evaluator has one, the grader's own
    *
    * @remarks
-   *  judgement otherwise. Always present — the endpoint this replaces omitted it
-   *  without a guardrail, so read `guardrail_config` to detect one, not this.
+   *  judgement otherwise. Always present, so read `guardrail_config` to detect
+   *  a guardrail, not this.
    */
   passed?: boolean | undefined;
   explanation?: string | undefined;

package/src/models/components/filter.ts

@@ -56,7 +56,7 @@ export type Field = ClosedEnum<typeof Field>;
 /**
  * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
  */
-export const FilterOp = {
+export const Op = {
   Eq: "eq",
   Neq: "neq",
   In: "in",
@@ -65,7 +65,7 @@ export const FilterOp = {
 /**
  * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
  */
-export type FilterOp = ClosedEnum<typeof FilterOp>;
+export type Op = ClosedEnum<typeof Op>;
 
 export type Filter = {
   /**
@@ -75,7 +75,7 @@ export type Filter = {
   /**
    * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
    */
-  op?: FilterOp | undefined;
+  op?: Op | undefined;
   /**
    * Values compared against the selected field. Values are interpreted
    *
@@ -94,17 +94,15 @@ export const Field$outboundSchema: z.ZodNativeEnum<typeof Field> =
   Field$inboundSchema;
 
 /** @internal */
-export const FilterOp$inboundSchema: z.ZodNativeEnum<typeof FilterOp> = z
-  .nativeEnum(FilterOp);
+export const Op$inboundSchema: z.ZodNativeEnum<typeof Op> = z.nativeEnum(Op);
 /** @internal */
-export const FilterOp$outboundSchema: z.ZodNativeEnum<typeof FilterOp> =
-  FilterOp$inboundSchema;
+export const Op$outboundSchema: z.ZodNativeEnum<typeof Op> = Op$inboundSchema;
 
 /** @internal */
 export const Filter$inboundSchema: z.ZodType<Filter, z.ZodTypeDef, unknown> = z
   .object({
     field: Field$inboundSchema.optional(),
-    op: FilterOp$inboundSchema.optional(),
+    op: Op$inboundSchema.optional(),
     values: z.array(z.string()).optional(),
   });
 /** @internal */
@@ -121,7 +119,7 @@ export const Filter$outboundSchema: z.ZodType<
   Filter
 > = z.object({
   field: Field$outboundSchema.optional(),
-  op: FilterOp$outboundSchema.optional(),
+  op: Op$outboundSchema.optional(),
   values: z.array(z.string()).optional(),
 });
 

package/src/models/components/gethubitemresponse.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 { HubItem, HubItem$inboundSchema } from "./hubitem.js";
+
+export type GetHubItemResponse = {
+  hubItem: HubItem;
+};
+
+/** @internal */
+export const GetHubItemResponse$inboundSchema: z.ZodType<
+  GetHubItemResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hub_item: HubItem$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "hub_item": "hubItem",
+  });
+});
+
+export function getHubItemResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetHubItemResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetHubItemResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetHubItemResponse' from JSON`,
+  );
+}

package/src/models/components/getthreadcountrequest.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ThreadFilters,
+  ThreadFilters$Outbound,
+  ThreadFilters$outboundSchema,
+} from "./threadfilters.js";
+
+export type GetThreadCountRequest = {
+  filters: ThreadFilters;
+  limit?: number | undefined;
+  page?: number | undefined;
+};
+
+/** @internal */
+export type GetThreadCountRequest$Outbound = {
+  filters: ThreadFilters$Outbound;
+  limit?: number | undefined;
+  page?: number | undefined;
+};
+
+/** @internal */
+export const GetThreadCountRequest$outboundSchema: z.ZodType<
+  GetThreadCountRequest$Outbound,
+  z.ZodTypeDef,
+  GetThreadCountRequest
+> = z.object({
+  filters: ThreadFilters$outboundSchema,
+  limit: z.number().int().optional(),
+  page: z.number().int().optional(),
+});
+
+export function getThreadCountRequestToJSON(
+  getThreadCountRequest: GetThreadCountRequest,
+): string {
+  return JSON.stringify(
+    GetThreadCountRequest$outboundSchema.parse(getThreadCountRequest),
+  );
+}

package/src/models/components/getthreadcountresponse.ts

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

package/src/models/components/getuploadfileurlresponse.ts

@@ -14,6 +14,10 @@ import {
 export type GetUploadFileUrlResponse = {
   objectName: string;
   postPolicy: UploadPostPolicy;
+  /**
+   * Identifier of the file record registered for this upload
+   */
+  fileId: string;
 };
 
 /** @internal */
@@ -24,6 +28,7 @@ export const GetUploadFileUrlResponse$inboundSchema: z.ZodType<
 > = z.object({
   objectName: z.string(),
   postPolicy: UploadPostPolicy$inboundSchema,
+  fileId: z.string(),
 });
 
 export function getUploadFileUrlResponseFromJSON(

package/src/models/components/getworkspaceresponse.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 { Workspace, Workspace$inboundSchema } from "./workspace.js";
+
+export type GetWorkspaceResponse = {
+  workspace: Workspace;
+};
+
+/** @internal */
+export const GetWorkspaceResponse$inboundSchema: z.ZodType<
+  GetWorkspaceResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  workspace: Workspace$inboundSchema,
+});
+
+export function getWorkspaceResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetWorkspaceResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetWorkspaceResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetWorkspaceResponse' from JSON`,
+  );
+}

package/src/models/components/guardrailruleplugin.ts

@@ -13,10 +13,29 @@ export type GuardrailRulePlugin = {
    * Plugin discriminator.
    */
   id?: string | undefined;
+  /**
+   * Languages, regions and entity types are checked against the live
+   *
+   * @remarks
+   *  pii-detection capabilities catalog when the rule is saved, not pinned
+   *  here, so a language or region the detector gains becomes writable without
+   *  a proto change.
+   */
   language?: string | undefined;
+  /**
+   * Entity types to redact. Mutually exclusive with regions.
+   */
   entities?: Array<string> | undefined;
   onFailure?: string | undefined;
   threshold?: number | undefined;
+  /**
+   * Regions of coverage by ISO 3166-1 alpha-2 code, or ["all"]. Mutually exclusive with entities.
+   */
+  regions?: Array<string> | undefined;
+  /**
+   * Per-entity-type confidence cutoff. Every key must also appear in entities.
+   */
+  entityThresholds?: { [k: string]: number } | undefined;
 };
 
 /** @internal */
@@ -30,9 +49,12 @@ export const GuardrailRulePlugin$inboundSchema: z.ZodType<
   entities: z.array(z.string()).optional(),
   on_failure: z.string().optional(),
   threshold: z.number().optional(),
+  regions: z.array(z.string()).optional(),
+  entity_thresholds: z.record(z.number()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "on_failure": "onFailure",
+    "entity_thresholds": "entityThresholds",
   });
 });
 /** @internal */
@@ -42,6 +64,8 @@ export type GuardrailRulePlugin$Outbound = {
   entities?: Array<string> | undefined;
   on_failure?: string | undefined;
   threshold?: number | undefined;
+  regions?: Array<string> | undefined;
+  entity_thresholds?: { [k: string]: number } | undefined;
 };
 
 /** @internal */
@@ -55,9 +79,12 @@ export const GuardrailRulePlugin$outboundSchema: z.ZodType<
   entities: z.array(z.string()).optional(),
   onFailure: z.string().optional(),
   threshold: z.number().optional(),
+  regions: z.array(z.string()).optional(),
+  entityThresholds: z.record(z.number()).optional(),
 }).transform((v) => {
   return remap$(v, {
     onFailure: "on_failure",
+    entityThresholds: "entity_thresholds",
   });
 });
 

package/src/models/components/hubitem.ts

@@ -0,0 +1,136 @@
+/*
+ * 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";
+
+/**
+ * Evaluator template payload.
+ */
+export type Evaluator = {};
+
+/**
+ * Prompt template payload.
+ */
+export type Prompt = {};
+
+export type HubItem = {
+  /**
+   * Unique hub item ID.
+   */
+  id?: string | undefined;
+  /**
+   * ID of the workspace entity represented by this hub item.
+   */
+  entityId: string;
+  /**
+   * Human-readable hub item name.
+   */
+  displayName: string;
+  /**
+   * Hub item description.
+   */
+  description: string;
+  /**
+   * Hub item type.
+   */
+  type: string;
+  /**
+   * Whether a vendor hub item is active.
+   */
+  isActive?: boolean | undefined;
+  /**
+   * Whether a vendor hub item is private.
+   */
+  isPrivate?: boolean | undefined;
+  /**
+   * Whether the hub item is provided by orq.
+   */
+  isProvidedByOrq?: boolean | undefined;
+  /**
+   * Execution engine for vendor hub item templates.
+   */
+  engine?: string | undefined;
+  /**
+   * Stable vendor template key.
+   */
+  key?: string | undefined;
+  /**
+   * Evaluator template payload.
+   */
+  evaluator?: Evaluator | undefined;
+  /**
+   * Prompt template payload.
+   */
+  prompt?: Prompt | undefined;
+};
+
+/** @internal */
+export const Evaluator$inboundSchema: z.ZodType<
+  Evaluator,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function evaluatorFromJSON(
+  jsonString: string,
+): SafeParseResult<Evaluator, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Evaluator$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Evaluator' from JSON`,
+  );
+}
+
+/** @internal */
+export const Prompt$inboundSchema: z.ZodType<Prompt, z.ZodTypeDef, unknown> = z
+  .object({});
+
+export function promptFromJSON(
+  jsonString: string,
+): SafeParseResult<Prompt, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Prompt$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Prompt' from JSON`,
+  );
+}
+
+/** @internal */
+export const HubItem$inboundSchema: z.ZodType<HubItem, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string().optional(),
+    entity_id: z.string(),
+    display_name: z.string(),
+    description: z.string(),
+    type: z.string(),
+    is_active: z.boolean().optional(),
+    is_private: z.boolean().optional(),
+    is_provided_by_orq: z.boolean().optional(),
+    engine: z.string().optional(),
+    key: z.string().optional(),
+    evaluator: z.lazy(() => Evaluator$inboundSchema).optional(),
+    prompt: z.lazy(() => Prompt$inboundSchema).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "entity_id": "entityId",
+      "display_name": "displayName",
+      "is_active": "isActive",
+      "is_private": "isPrivate",
+      "is_provided_by_orq": "isProvidedByOrq",
+    });
+  });
+
+export function hubItemFromJSON(
+  jsonString: string,
+): SafeParseResult<HubItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HubItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HubItem' from JSON`,
+  );
+}

package/src/models/components/hubitemsummary.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 { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type HubItemSummary = {
+  /**
+   * Unique hub search item ID.
+   */
+  id: string;
+  /**
+   * ID of the workspace entity represented by this hub item. Empty on search results: the field is not part of the Typesense index.
+   */
+  entityId?: string | undefined;
+  /**
+   * Human-readable hub item name.
+   */
+  displayName: string;
+  /**
+   * Hub item description.
+   */
+  description: string;
+  /**
+   * Hub item type.
+   */
+  type: string;
+};
+
+/** @internal */
+export const HubItemSummary$inboundSchema: z.ZodType<
+  HubItemSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  entity_id: z.string().optional(),
+  display_name: z.string(),
+  description: z.string(),
+  type: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "entity_id": "entityId",
+    "display_name": "displayName",
+  });
+});
+
+export function hubItemSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<HubItemSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HubItemSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HubItemSummary' from JSON`,
+  );
+}