@orq-ai/node 4.15.0-rc.4 → 4.15.0-rc.41

package/src/models/components/redactrequest.ts

@@ -3,11 +3,53 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
 
 export type RedactRequest = {
   text?: string | undefined;
   language?: string | undefined;
   threshold?: number | 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 */
@@ -15,6 +57,9 @@ export type RedactRequest$Outbound = {
   text?: string | undefined;
   language?: string | undefined;
   threshold?: number | undefined;
+  regions?: Array<string> | undefined;
+  entities?: Array<string> | undefined;
+  entity_thresholds?: { [k: string]: number } | undefined;
 };
 
 /** @internal */
@@ -26,6 +71,13 @@ export const RedactRequest$outboundSchema: z.ZodType<
   text: z.string().optional(),
   language: z.string().optional(),
   threshold: z.number().optional(),
+  regions: z.array(z.string()).optional(),
+  entities: z.array(z.string()).optional(),
+  entityThresholds: z.record(z.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    entityThresholds: "entity_thresholds",
+  });
 });
 
 export function redactRequestToJSON(redactRequest: RedactRequest): string {

package/src/models/components/removeannotationqueueitemsrequest.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 RemoveAnnotationQueueItemsRequest = {
+  /**
+   * The unique identifiers of the spans to be removed from the annotation queue.
+   */
+  spanIds: Array<string>;
+};
+
+/** @internal */
+export type RemoveAnnotationQueueItemsRequest$Outbound = {
+  span_ids: Array<string>;
+};
+
+/** @internal */
+export const RemoveAnnotationQueueItemsRequest$outboundSchema: z.ZodType<
+  RemoveAnnotationQueueItemsRequest$Outbound,
+  z.ZodTypeDef,
+  RemoveAnnotationQueueItemsRequest
+> = z.object({
+  spanIds: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    spanIds: "span_ids",
+  });
+});
+
+export function removeAnnotationQueueItemsRequestToJSON(
+  removeAnnotationQueueItemsRequest: RemoveAnnotationQueueItemsRequest,
+): string {
+  return JSON.stringify(
+    RemoveAnnotationQueueItemsRequest$outboundSchema.parse(
+      removeAnnotationQueueItemsRequest,
+    ),
+  );
+}

package/src/models/components/removeannotationqueueitemsresponse.ts

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

package/src/models/components/responsehealingplugin.ts

@@ -4,50 +4,27 @@
 
 import * as z from "zod/v3";
 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";
 
-/**
- * Plugin discriminator. Must be `response_healing`.
- */
-export const ResponseHealingPluginId = {
-  ResponseHealing: "response_healing",
-} as const;
-/**
- * Plugin discriminator. Must be `response_healing`.
- */
-export type ResponseHealingPluginId = ClosedEnum<
-  typeof ResponseHealingPluginId
->;
-
 export type ResponseHealingPlugin = {
   /**
    * Plugin discriminator. Must be `response_healing`.
    */
-  id: ResponseHealingPluginId;
+  id: "response_healing";
 };
 
-/** @internal */
-export const ResponseHealingPluginId$inboundSchema: z.ZodNativeEnum<
-  typeof ResponseHealingPluginId
-> = z.nativeEnum(ResponseHealingPluginId);
-/** @internal */
-export const ResponseHealingPluginId$outboundSchema: z.ZodNativeEnum<
-  typeof ResponseHealingPluginId
-> = ResponseHealingPluginId$inboundSchema;
-
 /** @internal */
 export const ResponseHealingPlugin$inboundSchema: z.ZodType<
   ResponseHealingPlugin,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: ResponseHealingPluginId$inboundSchema,
+  id: z.literal("response_healing"),
 });
 /** @internal */
 export type ResponseHealingPlugin$Outbound = {
-  id: string;
+  id: "response_healing";
 };
 
 /** @internal */
@@ -56,7 +33,7 @@ export const ResponseHealingPlugin$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ResponseHealingPlugin
 > = z.object({
-  id: ResponseHealingPluginId$outboundSchema,
+  id: z.literal("response_healing"),
 });
 
 export function responseHealingPluginToJSON(

package/src/models/components/responsemeta.ts

@@ -25,13 +25,13 @@ export type EffectiveGrain = ClosedEnum<typeof EffectiveGrain>;
 /**
  * ISO 4217 currency code for cost fields. Always `USD` today.
  */
-export const ResponseMetaCurrency = {
+export const Currency = {
   Usd: "USD",
 } as const;
 /**
  * ISO 4217 currency code for cost fields. Always `USD` today.
  */
-export type ResponseMetaCurrency = ClosedEnum<typeof ResponseMetaCurrency>;
+export type Currency = ClosedEnum<typeof Currency>;
 
 export type ResponseMeta = {
   /**
@@ -56,7 +56,7 @@ export type ResponseMeta = {
   /**
    * ISO 4217 currency code for cost fields. Always `USD` today.
    */
-  currency?: ResponseMetaCurrency | undefined;
+  currency?: Currency | undefined;
   /**
    * Non-fatal warnings about the response. May contain `totals_unavailable` when totals were requested but failed.
    */
@@ -69,9 +69,8 @@ export const EffectiveGrain$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(EffectiveGrain);
 
 /** @internal */
-export const ResponseMetaCurrency$inboundSchema: z.ZodNativeEnum<
-  typeof ResponseMetaCurrency
-> = z.nativeEnum(ResponseMetaCurrency);
+export const Currency$inboundSchema: z.ZodNativeEnum<typeof Currency> = z
+  .nativeEnum(Currency);
 
 /** @internal */
 export const ResponseMeta$inboundSchema: z.ZodType<
@@ -82,7 +81,7 @@ export const ResponseMeta$inboundSchema: z.ZodType<
   effective_grain: EffectiveGrain$inboundSchema.optional(),
   row_count: z.number().int().optional(),
   request_id: z.string().optional(),
-  currency: ResponseMetaCurrency$inboundSchema.optional(),
+  currency: Currency$inboundSchema.optional(),
   warnings: z.array(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/routingruleplugin.ts

@@ -13,11 +13,30 @@ export type RoutingRulePlugin = {
    * 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;
   mask?: Array<string> | 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 */
@@ -32,9 +51,12 @@ export const RoutingRulePlugin$inboundSchema: z.ZodType<
   on_failure: z.string().optional(),
   threshold: z.number().optional(),
   mask: z.array(z.string()).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 */
@@ -45,6 +67,8 @@ export type RoutingRulePlugin$Outbound = {
   on_failure?: string | undefined;
   threshold?: number | undefined;
   mask?: Array<string> | undefined;
+  regions?: Array<string> | undefined;
+  entity_thresholds?: { [k: string]: number } | undefined;
 };
 
 /** @internal */
@@ -59,9 +83,12 @@ export const RoutingRulePlugin$outboundSchema: z.ZodType<
   onFailure: z.string().optional(),
   threshold: z.number().optional(),
   mask: z.array(z.string()).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/searchhubitemsresponse.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 { HubSearchHit, HubSearchHit$inboundSchema } from "./hubsearchhit.js";
+
+export type SearchHubItemsResponse = {
+  hits: Array<HubSearchHit>;
+};
+
+/** @internal */
+export const SearchHubItemsResponse$inboundSchema: z.ZodType<
+  SearchHubItemsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hits: z.array(HubSearchHit$inboundSchema),
+});
+
+export function searchHubItemsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchHubItemsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchHubItemsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchHubItemsResponse' from JSON`,
+  );
+}

package/src/models/components/searchknowledgerequest.ts

@@ -296,16 +296,7 @@ export type OneEq = {
   eq: string | number | boolean;
 };
 
-export type FilterBy1 =
-  | OneEq
-  | OneNe
-  | Gt
-  | Gte
-  | Lt
-  | Lte
-  | OneIn
-  | OneNin
-  | Exists;
+export type One = OneEq | OneNe | Gt | Gte | Lt | Lte | OneIn | OneNin | Exists;
 
 /**
  * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information.
@@ -314,7 +305,7 @@ export type FilterBy = FilterByAnd | FilterByOr | {
   [k: string]: OneEq | OneNe | Gt | Gte | Lt | Lte | OneIn | OneNin | Exists;
 };
 
-export type AgenticRagConfig2 = {
+export type Two = {
   /**
    * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models).
    */
@@ -355,9 +346,7 @@ export type AgenticRagConfig1 = {
 /**
  * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
  */
-export type SearchKnowledgeRequestAgenticRagConfig =
-  | AgenticRagConfig2
-  | AgenticRagConfig1;
+export type SearchKnowledgeRequestAgenticRagConfig = Two | AgenticRagConfig1;
 
 /**
  * SearchKnowledgeRequest mirrors the existing public search body and adds the
@@ -396,7 +385,7 @@ export type SearchKnowledgeRequest = {
   /**
    * Override the agentic RAG configuration for this search. If not provided, will use the knowledge base configured agentic RAG settings.
    */
-  agenticRagConfig?: AgenticRagConfig2 | AgenticRagConfig1 | null | undefined;
+  agenticRagConfig?: Two | AgenticRagConfig1 | null | undefined;
   /**
    * Override the stored retrieval configuration for this search. If not provided, the knowledge base configuration is used.
    */
@@ -1211,7 +1200,7 @@ export function oneEqToJSON(oneEq: OneEq): string {
 }
 
 /** @internal */
-export type FilterBy1$Outbound =
+export type One$Outbound =
   | OneEq$Outbound
   | OneNe$Outbound
   | Gt$Outbound
@@ -1223,24 +1212,21 @@ export type FilterBy1$Outbound =
   | Exists$Outbound;
 
 /** @internal */
-export const FilterBy1$outboundSchema: z.ZodType<
-  FilterBy1$Outbound,
-  z.ZodTypeDef,
-  FilterBy1
-> = z.union([
-  z.lazy(() => OneEq$outboundSchema),
-  z.lazy(() => OneNe$outboundSchema),
-  z.lazy(() => Gt$outboundSchema),
-  z.lazy(() => Gte$outboundSchema),
-  z.lazy(() => Lt$outboundSchema),
-  z.lazy(() => Lte$outboundSchema),
-  z.lazy(() => OneIn$outboundSchema),
-  z.lazy(() => OneNin$outboundSchema),
-  z.lazy(() => Exists$outboundSchema),
-]);
+export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
+  .union([
+    z.lazy(() => OneEq$outboundSchema),
+    z.lazy(() => OneNe$outboundSchema),
+    z.lazy(() => Gt$outboundSchema),
+    z.lazy(() => Gte$outboundSchema),
+    z.lazy(() => Lt$outboundSchema),
+    z.lazy(() => Lte$outboundSchema),
+    z.lazy(() => OneIn$outboundSchema),
+    z.lazy(() => OneNin$outboundSchema),
+    z.lazy(() => Exists$outboundSchema),
+  ]);
 
-export function filterBy1ToJSON(filterBy1: FilterBy1): string {
-  return JSON.stringify(FilterBy1$outboundSchema.parse(filterBy1));
+export function oneToJSON(one: One): string {
+  return JSON.stringify(One$outboundSchema.parse(one));
 }
 
 /** @internal */
@@ -1283,7 +1269,7 @@ export function filterByToJSON(filterBy: FilterBy): string {
 }
 
 /** @internal */
-export type AgenticRagConfig2$Outbound = {
+export type Two$Outbound = {
   model?: string | undefined;
   model_db_id: string;
   provider: string;
@@ -1291,28 +1277,21 @@ export type AgenticRagConfig2$Outbound = {
 };
 
 /** @internal */
-export const AgenticRagConfig2$outboundSchema: z.ZodType<
-  AgenticRagConfig2$Outbound,
-  z.ZodTypeDef,
-  AgenticRagConfig2
-> = z.object({
-  model: z.string().optional(),
-  modelDbId: z.string(),
-  provider: z.string(),
-  integrationId: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    modelDbId: "model_db_id",
-    integrationId: "integration_id",
+export const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two> = z
+  .object({
+    model: z.string().optional(),
+    modelDbId: z.string(),
+    provider: z.string(),
+    integrationId: z.nullable(z.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      modelDbId: "model_db_id",
+      integrationId: "integration_id",
+    });
   });
-});
 
-export function agenticRagConfig2ToJSON(
-  agenticRagConfig2: AgenticRagConfig2,
-): string {
-  return JSON.stringify(
-    AgenticRagConfig2$outboundSchema.parse(agenticRagConfig2),
-  );
+export function twoToJSON(two: Two): string {
+  return JSON.stringify(Two$outboundSchema.parse(two));
 }
 
 /** @internal */
@@ -1350,7 +1329,7 @@ export function agenticRagConfig1ToJSON(
 
 /** @internal */
 export type SearchKnowledgeRequestAgenticRagConfig$Outbound =
-  | AgenticRagConfig2$Outbound
+  | Two$Outbound
   | AgenticRagConfig1$Outbound;
 
 /** @internal */
@@ -1359,7 +1338,7 @@ export const SearchKnowledgeRequestAgenticRagConfig$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SearchKnowledgeRequestAgenticRagConfig
 > = z.union([
-  z.lazy(() => AgenticRagConfig2$outboundSchema),
+  z.lazy(() => Two$outboundSchema),
   z.lazy(() => AgenticRagConfig1$outboundSchema),
 ]);
 
@@ -1395,7 +1374,7 @@ export type SearchKnowledgeRequest$Outbound = {
   search_options?: SearchOptions$Outbound | undefined;
   rerank_config?: SearchRerankConfig$Outbound | undefined;
   agentic_rag_config?:
-    | AgenticRagConfig2$Outbound
+    | Two$Outbound
     | AgenticRagConfig1$Outbound
     | null
     | undefined;
@@ -1431,7 +1410,7 @@ export const SearchKnowledgeRequest$outboundSchema: z.ZodType<
   rerankConfig: SearchRerankConfig$outboundSchema.optional(),
   agenticRagConfig: z.nullable(
     z.union([
-      z.lazy(() => AgenticRagConfig2$outboundSchema),
+      z.lazy(() => Two$outboundSchema),
       z.lazy(() => AgenticRagConfig1$outboundSchema),
     ]),
   ).optional(),

package/src/models/components/sessioninterval.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const SessionInterval = {
+  SessionIntervalUnspecified: "SESSION_INTERVAL_UNSPECIFIED",
+  SessionIntervalAllTime: "SESSION_INTERVAL_ALL_TIME",
+  SessionIntervalLast30Minutes: "SESSION_INTERVAL_LAST_30_MINUTES",
+  SessionIntervalLast1Hour: "SESSION_INTERVAL_LAST_1_HOUR",
+  SessionIntervalLast6Hours: "SESSION_INTERVAL_LAST_6_HOURS",
+  SessionIntervalLast24Hours: "SESSION_INTERVAL_LAST_24_HOURS",
+  SessionIntervalLast3Days: "SESSION_INTERVAL_LAST_3_DAYS",
+  SessionIntervalLast7Days: "SESSION_INTERVAL_LAST_7_DAYS",
+  SessionIntervalLast14Days: "SESSION_INTERVAL_LAST_14_DAYS",
+  SessionIntervalLast1Month: "SESSION_INTERVAL_LAST_1_MONTH",
+  SessionIntervalLast3Months: "SESSION_INTERVAL_LAST_3_MONTHS",
+} as const;
+export type SessionInterval = ClosedEnum<typeof SessionInterval>;
+
+/** @internal */
+export const SessionInterval$outboundSchema: z.ZodNativeEnum<
+  typeof SessionInterval
+> = z.nativeEnum(SessionInterval);