@orq-ai/node 4.15.0-rc.21 → 4.15.0-rc.23

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`,
+  );
+}

package/src/models/components/hubsearchhit.ts

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

package/src/models/components/index.ts

@@ -73,6 +73,7 @@ export * from "./budgetsortfield.js";
 export * from "./budgetusage.js";
 export * from "./cacheconfig.js";
 export * from "./callsubagenttoolinput.js";
+export * from "./capabilitiesresponse.js";
 export * from "./chunk.js";
 export * from "./chunkingcleanupoptions.js";
 export * from "./chunkingconfiguration.js";
@@ -130,6 +131,7 @@ export * from "./createskillrequest.js";
 export * from "./createskillresponse.js";
 export * from "./createsmartrouterrequest.js";
 export * from "./createsmartrouterresponse.js";
+export * from "./createthreadrequest.js";
 export * from "./createwebhookrequest.js";
 export * from "./currentdatetoolinput.js";
 export * from "./datapart.js";
@@ -177,6 +179,7 @@ export * from "./embeddingretryconfig.js";
 export * from "./embeddingsconfig.js";
 export * from "./embeddingsmodelparameters.js";
 export * from "./embeddingtimeoutconfig.js";
+export * from "./entitylist.js";
 export * from "./errorpart.js";
 export * from "./errorstreamingevent.js";
 export * from "./evaluationcontext.js";
@@ -213,6 +216,7 @@ export * from "./getevaluatorversionresponse.js";
 export * from "./getfilecontentresponse.js";
 export * from "./getfileresponse.js";
 export * from "./getguardrailruleresponse.js";
+export * from "./gethubitemresponse.js";
 export * from "./getipallowlistresponse.js";
 export * from "./getlogcontextrequest.js";
 export * from "./getlogcontextresponse.js";
@@ -225,6 +229,8 @@ export * from "./getnotifierresponse.js";
 export * from "./getprojectresponse.js";
 export * from "./getskillresponse.js";
 export * from "./getsmartrouterresponse.js";
+export * from "./getthreadcountrequest.js";
+export * from "./getthreadcountresponse.js";
 export * from "./gettraceresponse.js";
 export * from "./gettracespanresponse.js";
 export * from "./getuploadfileurlresponse.js";
@@ -236,6 +242,9 @@ export * from "./guardrailruleexpression.js";
 export * from "./guardrailruleguardrail.js";
 export * from "./guardrailruleplugin.js";
 export * from "./httptoolinput.js";
+export * from "./hubitem.js";
+export * from "./hubitemsummary.js";
+export * from "./hubsearchhit.js";
 export * from "./identity.js";
 export * from "./identitybudgetscope.js";
 export * from "./identitybudgetscoperestresponse.js";
@@ -295,6 +304,8 @@ export * from "./listroutingrulesresponse.js";
 export * from "./listroutingruleusedmodelsresponse.js";
 export * from "./listskillsresponse.js";
 export * from "./listsmartroutersresponse.js";
+export * from "./listthreadsrequest.js";
+export * from "./listthreadsresponse.js";
 export * from "./listtracefacetsresponse.js";
 export * from "./listtracefacetvaluesresponse.js";
 export * from "./listtracefieldsresponse.js";
@@ -361,6 +372,7 @@ export * from "./movefilesystemfilerequest.js";
 export * from "./movefilesystemfileresponse.js";
 export * from "./notifier.js";
 export * from "./notifiertype.js";
+export * from "./openaipromptcacheoptions.js";
 export * from "./orqadvisortool.js";
 export * from "./orqsidekicktool.js";
 export * from "./outputtokensdetails.js";
@@ -372,9 +384,7 @@ export * from "./partdoneevent.js";
 export * from "./permissionmode.js";
 export * from "./piiredaction.js";
 export * from "./piiredactionconfig.js";
-export * from "./piiredactionpluginauto.js";
-export * from "./piiredactionpluginen.js";
-export * from "./piiredactionpluginnl.js";
+export * from "./piiredactionplugin.js";
 export * from "./policy.js";
 export * from "./policyretryconfig.js";
 export * from "./previewchunk.js";
@@ -510,6 +520,7 @@ export * from "./routingrulemodel.js";
 export * from "./routingrulemodelsconfig.js";
 export * from "./routingruleplugin.js";
 export * from "./scopemode.js";
+export * from "./searchhubitemsresponse.js";
 export * from "./searchknowledgematch.js";
 export * from "./searchknowledgerequest.js";
 export * from "./searchknowledgeresponse.js";
@@ -526,6 +537,7 @@ export * from "./security.js";
 export * from "./securityconfig.js";
 export * from "./servertoolusedetails.js";
 export * from "./serviceaccountowner.js";
+export * from "./sessioninterval.js";
 export * from "./sharing.js";
 export * from "./sharingallprojects.js";
 export * from "./sharingselectedprojects.js";
@@ -552,6 +564,11 @@ export * from "./textpart.js";
 export * from "./thinkingconfigadaptiveschema.js";
 export * from "./thinkingconfigdisabledschema.js";
 export * from "./thinkingconfigenabledschema.js";
+export * from "./thread.js";
+export * from "./threadbilling.js";
+export * from "./threadfilters.js";
+export * from "./threadkind.js";
+export * from "./threadusage.js";
 export * from "./timeoutconfig.js";
 export * from "./timeoutstreamingevent.js";
 export * from "./tokenlimit.js";
@@ -614,6 +631,7 @@ export * from "./updateskillrequest.js";
 export * from "./updateskillresponse.js";
 export * from "./updatesmartrouterrequest.js";
 export * from "./updatesmartrouterresponse.js";
+export * from "./updatethreadrequest.js";
 export * from "./updateworkspacerequest.js";
 export * from "./updateworkspaceresponse.js";
 export * from "./updateworkspacesettingsrequest.js";

package/src/models/components/listthreadsrequest.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 ListThreadsRequest = {
+  filters: ThreadFilters;
+  limit?: number | undefined;
+  page?: number | undefined;
+};
+
+/** @internal */
+export type ListThreadsRequest$Outbound = {
+  filters: ThreadFilters$Outbound;
+  limit?: number | undefined;
+  page?: number | undefined;
+};
+
+/** @internal */
+export const ListThreadsRequest$outboundSchema: z.ZodType<
+  ListThreadsRequest$Outbound,
+  z.ZodTypeDef,
+  ListThreadsRequest
+> = z.object({
+  filters: ThreadFilters$outboundSchema,
+  limit: z.number().int().optional(),
+  page: z.number().int().optional(),
+});
+
+export function listThreadsRequestToJSON(
+  listThreadsRequest: ListThreadsRequest,
+): string {
+  return JSON.stringify(
+    ListThreadsRequest$outboundSchema.parse(listThreadsRequest),
+  );
+}

package/src/models/components/listthreadsresponse.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";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Thread, Thread$inboundSchema } from "./thread.js";
+
+export type ListThreadsResponse = {
+  object: string;
+  data: Array<Thread>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export const ListThreadsResponse$inboundSchema: z.ZodType<
+  ListThreadsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  data: z.array(Thread$inboundSchema),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listThreadsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListThreadsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListThreadsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListThreadsResponse' from JSON`,
+  );
+}

package/src/models/components/openaipromptcacheoptions.ts

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+export const OpenAIPromptCacheOptionsMode = {
+  Implicit: "implicit",
+  Explicit: "explicit",
+} as const;
+export type OpenAIPromptCacheOptionsMode = ClosedEnum<
+  typeof OpenAIPromptCacheOptionsMode
+>;
+
+export const Ttl = {
+  Thirtym: "30m",
+} as const;
+export type Ttl = ClosedEnum<typeof Ttl>;
+
+export type OpenAIPromptCacheOptions = {
+  mode?: OpenAIPromptCacheOptionsMode | undefined;
+  ttl?: Ttl | undefined;
+};
+
+/** @internal */
+export const OpenAIPromptCacheOptionsMode$inboundSchema: z.ZodNativeEnum<
+  typeof OpenAIPromptCacheOptionsMode
+> = z.nativeEnum(OpenAIPromptCacheOptionsMode);
+/** @internal */
+export const OpenAIPromptCacheOptionsMode$outboundSchema: z.ZodNativeEnum<
+  typeof OpenAIPromptCacheOptionsMode
+> = OpenAIPromptCacheOptionsMode$inboundSchema;
+
+/** @internal */
+export const Ttl$inboundSchema: z.ZodNativeEnum<typeof Ttl> = z.nativeEnum(Ttl);
+/** @internal */
+export const Ttl$outboundSchema: z.ZodNativeEnum<typeof Ttl> =
+  Ttl$inboundSchema;
+
+/** @internal */
+export const OpenAIPromptCacheOptions$inboundSchema: z.ZodType<
+  OpenAIPromptCacheOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: OpenAIPromptCacheOptionsMode$inboundSchema.optional(),
+  ttl: Ttl$inboundSchema.optional(),
+});
+/** @internal */
+export type OpenAIPromptCacheOptions$Outbound = {
+  mode?: string | undefined;
+  ttl?: string | undefined;
+};
+
+/** @internal */
+export const OpenAIPromptCacheOptions$outboundSchema: z.ZodType<
+  OpenAIPromptCacheOptions$Outbound,
+  z.ZodTypeDef,
+  OpenAIPromptCacheOptions
+> = z.object({
+  mode: OpenAIPromptCacheOptionsMode$outboundSchema.optional(),
+  ttl: Ttl$outboundSchema.optional(),
+});
+
+export function openAIPromptCacheOptionsToJSON(
+  openAIPromptCacheOptions: OpenAIPromptCacheOptions,
+): string {
+  return JSON.stringify(
+    OpenAIPromptCacheOptions$outboundSchema.parse(openAIPromptCacheOptions),
+  );
+}
+export function openAIPromptCacheOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<OpenAIPromptCacheOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OpenAIPromptCacheOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OpenAIPromptCacheOptions' from JSON`,
+  );
+}

package/src/models/components/piiredactionplugin.ts

@@ -0,0 +1,143 @@
+/*
+ * 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";
+
+/**
+ * PII redaction plugin.
+ */
+export const Id = {
+  PiiRedaction: "pii_redaction",
+} as const;
+/**
+ * PII redaction plugin.
+ */
+export type Id = ClosedEnum<typeof Id>;
+
+/**
+ * Behaviour when detection fails.
+ */
+export const OnFailure = {
+  Block: "block",
+  Passthrough: "passthrough",
+} as const;
+/**
+ * Behaviour when detection fails.
+ */
+export type OnFailure = ClosedEnum<typeof OnFailure>;
+
+export type PIIRedactionPlugin = {
+  /**
+   * PII redaction plugin.
+   */
+  id: Id;
+  /**
+   * Detector language. Use "auto" to auto-detect; omitting the field falls back to en.
+   */
+  language?: string | undefined;
+  /**
+   * Region codes selecting whole regions of coverage (e.g. "nl", "gb"). Every entity type those regions cover is redacted, alongside the base catalog. ["all"] is exclusive, and leaving both this and entities empty also runs every region, so selecting nothing is the widest request rather than the narrowest. Combines with entities: the two selections are unioned, so entities adds types on top of the region coverage.
+   */
+  regions?: Array<string> | undefined;
+  /**
+   * The entity types to redact. A named type is redacted even when it belongs to a region, so a region's types can be selected individually without naming the region. On its own this is a strict allowlist; alongside regions it adds to the region coverage. See GET /v2/pii/capabilities for valid types.
+   */
+  entities?: Array<string> | undefined;
+  /**
+   * Per-entity confidence cutoff overrides in [0,1]. Tunes confidence only and never changes which types are redacted, so every key must also appear in entities.
+   */
+  entityThresholds?: { [k: string]: number } | undefined;
+  /**
+   * Baseline confidence cutoff applied to every entity type without a per-entity override.
+   */
+  threshold?: number | undefined;
+  /**
+   * Behaviour when detection fails.
+   */
+  onFailure?: OnFailure | undefined;
+};
+
+/** @internal */
+export const Id$inboundSchema: z.ZodNativeEnum<typeof Id> = z.nativeEnum(Id);
+/** @internal */
+export const Id$outboundSchema: z.ZodNativeEnum<typeof Id> = Id$inboundSchema;
+
+/** @internal */
+export const OnFailure$inboundSchema: z.ZodNativeEnum<typeof OnFailure> = z
+  .nativeEnum(OnFailure);
+/** @internal */
+export const OnFailure$outboundSchema: z.ZodNativeEnum<typeof OnFailure> =
+  OnFailure$inboundSchema;
+
+/** @internal */
+export const PIIRedactionPlugin$inboundSchema: z.ZodType<
+  PIIRedactionPlugin,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: Id$inboundSchema,
+  language: z.string().optional(),
+  regions: z.array(z.string()).optional(),
+  entities: z.array(z.string()).optional(),
+  entity_thresholds: z.record(z.number()).optional(),
+  threshold: z.number().optional(),
+  on_failure: OnFailure$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "entity_thresholds": "entityThresholds",
+    "on_failure": "onFailure",
+  });
+});
+/** @internal */
+export type PIIRedactionPlugin$Outbound = {
+  id: string;
+  language?: string | undefined;
+  regions?: Array<string> | undefined;
+  entities?: Array<string> | undefined;
+  entity_thresholds?: { [k: string]: number } | undefined;
+  threshold?: number | undefined;
+  on_failure?: string | undefined;
+};
+
+/** @internal */
+export const PIIRedactionPlugin$outboundSchema: z.ZodType<
+  PIIRedactionPlugin$Outbound,
+  z.ZodTypeDef,
+  PIIRedactionPlugin
+> = z.object({
+  id: Id$outboundSchema,
+  language: z.string().optional(),
+  regions: z.array(z.string()).optional(),
+  entities: z.array(z.string()).optional(),
+  entityThresholds: z.record(z.number()).optional(),
+  threshold: z.number().optional(),
+  onFailure: OnFailure$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    entityThresholds: "entity_thresholds",
+    onFailure: "on_failure",
+  });
+});
+
+export function piiRedactionPluginToJSON(
+  piiRedactionPlugin: PIIRedactionPlugin,
+): string {
+  return JSON.stringify(
+    PIIRedactionPlugin$outboundSchema.parse(piiRedactionPlugin),
+  );
+}
+export function piiRedactionPluginFromJSON(
+  jsonString: string,
+): SafeParseResult<PIIRedactionPlugin, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PIIRedactionPlugin$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PIIRedactionPlugin' from JSON`,
+  );
+}