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

package/src/models/components/agentresponserequest.ts

@@ -145,7 +145,7 @@ export type Contact = {
 /**
  * Thread information to group related requests
  */
-export type Thread = {
+export type AgentResponseRequestThread = {
   /**
    * Unique thread identifier to group related invocations.
    */
@@ -182,7 +182,7 @@ export type Engine = ClosedEnum<typeof Engine>;
 /**
  * Configuration options for the agent invocation
  */
-export type Configuration = {
+export type AgentResponseRequestConfiguration = {
   /**
    * Whether to block until the agent task completes. When true, the response will include the full task with messages. When false (default), returns immediately with task ID and status.
    */
@@ -228,7 +228,7 @@ export type AgentResponseRequest = {
   /**
    * Thread information to group related requests
    */
-  thread?: Thread | undefined;
+  thread?: AgentResponseRequestThread | undefined;
   /**
    * Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
    */
@@ -244,7 +244,7 @@ export type AgentResponseRequest = {
   /**
    * Configuration options for the agent invocation
    */
-  configuration?: Configuration | undefined;
+  configuration?: AgentResponseRequestConfiguration | undefined;
   /**
    * If true, returns immediately without waiting for completion. If false (default), waits until the agent becomes inactive or errors.
    */
@@ -419,23 +419,27 @@ export function contactToJSON(contact: Contact): string {
 }
 
 /** @internal */
-export type Thread$Outbound = {
+export type AgentResponseRequestThread$Outbound = {
   id: string;
   tags?: Array<string> | undefined;
 };
 
 /** @internal */
-export const Thread$outboundSchema: z.ZodType<
-  Thread$Outbound,
+export const AgentResponseRequestThread$outboundSchema: z.ZodType<
+  AgentResponseRequestThread$Outbound,
   z.ZodTypeDef,
-  Thread
+  AgentResponseRequestThread
 > = z.object({
   id: z.string(),
   tags: z.array(z.string()).optional(),
 });
 
-export function threadToJSON(thread: Thread): string {
-  return JSON.stringify(Thread$outboundSchema.parse(thread));
+export function agentResponseRequestThreadToJSON(
+  agentResponseRequestThread: AgentResponseRequestThread,
+): string {
+  return JSON.stringify(
+    AgentResponseRequestThread$outboundSchema.parse(agentResponseRequestThread),
+  );
 }
 
 /** @internal */
@@ -469,21 +473,27 @@ export const Engine$outboundSchema: z.ZodNativeEnum<typeof Engine> = z
   .nativeEnum(Engine);
 
 /** @internal */
-export type Configuration$Outbound = {
+export type AgentResponseRequestConfiguration$Outbound = {
   blocking: boolean;
 };
 
 /** @internal */
-export const Configuration$outboundSchema: z.ZodType<
-  Configuration$Outbound,
+export const AgentResponseRequestConfiguration$outboundSchema: z.ZodType<
+  AgentResponseRequestConfiguration$Outbound,
   z.ZodTypeDef,
-  Configuration
+  AgentResponseRequestConfiguration
 > = z.object({
   blocking: z.boolean().default(false),
 });
 
-export function configurationToJSON(configuration: Configuration): string {
-  return JSON.stringify(Configuration$outboundSchema.parse(configuration));
+export function agentResponseRequestConfigurationToJSON(
+  agentResponseRequestConfiguration: AgentResponseRequestConfiguration,
+): string {
+  return JSON.stringify(
+    AgentResponseRequestConfiguration$outboundSchema.parse(
+      agentResponseRequestConfiguration,
+    ),
+  );
 }
 
 /** @internal */
@@ -515,11 +525,11 @@ export type AgentResponseRequest$Outbound = {
   variables?: { [k: string]: any } | undefined;
   identity?: AgentResponseRequestIdentity$Outbound | undefined;
   contact?: Contact$Outbound | undefined;
-  thread?: Thread$Outbound | undefined;
+  thread?: AgentResponseRequestThread$Outbound | undefined;
   memory?: AgentResponseRequestMemory$Outbound | undefined;
   metadata?: { [k: string]: any } | undefined;
   engine?: string | undefined;
-  configuration?: Configuration$Outbound | undefined;
+  configuration?: AgentResponseRequestConfiguration$Outbound | undefined;
   background: boolean;
   stream: boolean;
   conversation?: Conversation$Outbound | undefined;
@@ -537,11 +547,12 @@ export const AgentResponseRequest$outboundSchema: z.ZodType<
   identity: z.lazy(() => AgentResponseRequestIdentity$outboundSchema)
     .optional(),
   contact: z.lazy(() => Contact$outboundSchema).optional(),
-  thread: z.lazy(() => Thread$outboundSchema).optional(),
+  thread: z.lazy(() => AgentResponseRequestThread$outboundSchema).optional(),
   memory: z.lazy(() => AgentResponseRequestMemory$outboundSchema).optional(),
   metadata: z.record(z.any()).optional(),
   engine: Engine$outboundSchema.optional(),
-  configuration: z.lazy(() => Configuration$outboundSchema).optional(),
+  configuration: z.lazy(() => AgentResponseRequestConfiguration$outboundSchema)
+    .optional(),
   background: z.boolean().default(false),
   stream: z.boolean().default(false),
   conversation: z.lazy(() => Conversation$outboundSchema).optional(),

package/src/models/components/agentstartedstreamingevent.ts

@@ -140,6 +140,10 @@ export type Evaluators = {
    * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
    */
   executeOn: AgentStartedStreamingEventDataExecuteOn;
+  /**
+   * Evaluator-specific configuration, passed through to the evaluator at run time. For orq_pii_detection this carries regions, entities, entity_thresholds, language and threshold, and is validated against PIIDetectionGuardrailOptions: regions and entities are two mutually exclusive coverage modes, and every entity_thresholds key must also appear in entities. on_failure is rejected: an evaluator acting as a guardrail always fails closed.
+   */
+  options?: { [k: string]: any } | undefined;
 };
 
 /**
@@ -169,6 +173,10 @@ export type Guardrails = {
    * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
    */
   executeOn: AgentStartedStreamingEventExecuteOn;
+  /**
+   * Evaluator-specific configuration, passed through to the evaluator at run time. For orq_pii_detection this carries regions, entities, entity_thresholds, language and threshold, and is validated against PIIDetectionGuardrailOptions: regions and entities are two mutually exclusive coverage modes, and every entity_thresholds key must also appear in entities. on_failure is rejected: an evaluator acting as a guardrail always fails closed.
+   */
+  options?: { [k: string]: any } | undefined;
 };
 
 export type Settings = {
@@ -198,7 +206,7 @@ export type Settings = {
    */
   evaluators?: Array<Evaluators> | undefined;
   /**
-   * Configuration for a guardrail applied to the agent
+   * Configuration for a guardrail applied to the agent. sample_rate has no effect here: a guardrail is a gate rather than a measurement, so it runs on every request.
    */
   guardrails?: Array<Guardrails> | undefined;
 };
@@ -376,6 +384,7 @@ export const Evaluators$inboundSchema: z.ZodType<
   id: z.string(),
   sample_rate: z.number().default(50),
   execute_on: AgentStartedStreamingEventDataExecuteOn$inboundSchema,
+  options: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "sample_rate": "sampleRate",
@@ -407,6 +416,7 @@ export const Guardrails$inboundSchema: z.ZodType<
   id: z.string(),
   sample_rate: z.number().default(50),
   execute_on: AgentStartedStreamingEventExecuteOn$inboundSchema,
+  options: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "sample_rate": "sampleRate",

package/src/models/components/annotationqueue.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 {
+  AnnotationQueueMetadata,
+  AnnotationQueueMetadata$inboundSchema,
+} from "./annotationqueuemetadata.js";
+
+export type AnnotationQueue = {
+  /**
+   * Unique annotation queue identifier assigned by ORQ.
+   */
+  id: string;
+  /**
+   * The display name of the annotation queue.
+   */
+  displayName: string;
+  /**
+   * The description of the annotation queue.
+   */
+  description: string;
+  /**
+   * The unique identifier of the workspace it belongs to.
+   */
+  workspaceId: string;
+  /**
+   * The project ID. When set, human reviews are resolved from the project automatically.
+   */
+  projectId?: string | undefined;
+  /**
+   * Legacy: manually selected human review IDs. Used only when project_id is not set.
+   */
+  humanReviewIds: Array<string>;
+  /**
+   * Aggregate counters for the annotation queue.
+   */
+  metadata: AnnotationQueueMetadata;
+  /**
+   * The account that created the annotation queue. Unset when created via API key authentication.
+   */
+  createdById?: string | undefined;
+  /**
+   * The account that last updated the annotation queue. Unset when updated via API key authentication.
+   */
+  updatedById?: string | undefined;
+  /**
+   * The date and time the annotation queue was created.
+   */
+  created?: Date | undefined;
+  /**
+   * The date and time the annotation queue was last updated.
+   */
+  updated?: Date | undefined;
+};
+
+/** @internal */
+export const AnnotationQueue$inboundSchema: z.ZodType<
+  AnnotationQueue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  display_name: z.string(),
+  description: z.string(),
+  workspace_id: z.string(),
+  project_id: z.string().optional(),
+  human_review_ids: z.array(z.string()),
+  metadata: AnnotationQueueMetadata$inboundSchema,
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "display_name": "displayName",
+    "workspace_id": "workspaceId",
+    "project_id": "projectId",
+    "human_review_ids": "humanReviewIds",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+  });
+});
+
+export function annotationQueueFromJSON(
+  jsonString: string,
+): SafeParseResult<AnnotationQueue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnnotationQueue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnnotationQueue' from JSON`,
+  );
+}

package/src/models/components/annotationqueueitem.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 AnnotationQueueItem = {
+  /**
+   * Unique annotation queue item identifier assigned by ORQ.
+   */
+  id: string;
+  /**
+   * The unique identifier of the annotation queue.
+   */
+  annotationQueueId: string;
+  /**
+   * The unique identifier of the workspace it belongs to.
+   */
+  workspaceId: string;
+  /**
+   * The unique identifiers of the human reviews that have been used to annotate the item.
+   */
+  usedHumanReviewIds?: Array<string> | undefined;
+  /**
+   * The item type. Either `span` or `datapoint`.
+   */
+  type: string;
+  /**
+   * The span this item points to. Present when `type` is `span`.
+   */
+  spanId?: string | undefined;
+  /**
+   * The trace identifier this span belongs to.
+   */
+  traceId?: string | undefined;
+  /**
+   * The datapoint this item points to. Present when `type` is `datapoint`.
+   */
+  datapointId?: string | undefined;
+};
+
+/** @internal */
+export const AnnotationQueueItem$inboundSchema: z.ZodType<
+  AnnotationQueueItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  annotation_queue_id: z.string(),
+  workspace_id: z.string(),
+  used_human_review_ids: z.array(z.string()).optional(),
+  type: z.string(),
+  span_id: z.string().optional(),
+  trace_id: z.string().optional(),
+  datapoint_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "annotation_queue_id": "annotationQueueId",
+    "workspace_id": "workspaceId",
+    "used_human_review_ids": "usedHumanReviewIds",
+    "span_id": "spanId",
+    "trace_id": "traceId",
+    "datapoint_id": "datapointId",
+  });
+});
+
+export function annotationQueueItemFromJSON(
+  jsonString: string,
+): SafeParseResult<AnnotationQueueItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnnotationQueueItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnnotationQueueItem' from JSON`,
+  );
+}

package/src/models/components/annotationqueueitemref.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";
+
+/**
+ * Span reference accepted by AddAnnotationQueueItems.
+ */
+export type AnnotationQueueItemRef = {
+  spanId: string;
+  traceId: string;
+};
+
+/** @internal */
+export type AnnotationQueueItemRef$Outbound = {
+  span_id: string;
+  trace_id: string;
+};
+
+/** @internal */
+export const AnnotationQueueItemRef$outboundSchema: z.ZodType<
+  AnnotationQueueItemRef$Outbound,
+  z.ZodTypeDef,
+  AnnotationQueueItemRef
+> = z.object({
+  spanId: z.string(),
+  traceId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    spanId: "span_id",
+    traceId: "trace_id",
+  });
+});
+
+export function annotationQueueItemRefToJSON(
+  annotationQueueItemRef: AnnotationQueueItemRef,
+): string {
+  return JSON.stringify(
+    AnnotationQueueItemRef$outboundSchema.parse(annotationQueueItemRef),
+  );
+}

package/src/models/components/annotationqueuemetadata.ts

@@ -0,0 +1,42 @@
+/*
+ * 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";
+
+/**
+ * Aggregate counters maintained by the service as items are added and removed.
+ */
+export type AnnotationQueueMetadata = {
+  /**
+   * Number of items currently in the annotation queue.
+   */
+  itemsCount: number;
+};
+
+/** @internal */
+export const AnnotationQueueMetadata$inboundSchema: z.ZodType<
+  AnnotationQueueMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items_count: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "items_count": "itemsCount",
+  });
+});
+
+export function annotationQueueMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<AnnotationQueueMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnnotationQueueMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnnotationQueueMetadata' from JSON`,
+  );
+}

package/src/models/components/auditlog.ts

@@ -0,0 +1,122 @@
+/*
+ * 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 { Value, Value$inboundSchema } from "./value.js";
+
+/**
+ * Additional event metadata. The exact shape depends on entity_type and action.
+ */
+export type AuditLogMetadata = {};
+
+/**
+ * An audit log entry for an entity event in the authenticated workspace.
+ */
+export type AuditLog = {
+  /**
+   * Unique identifier for the audit log entry.
+   */
+  auditLogId: string;
+  /**
+   * Project associated with the event, when the audited entity belongs to a project.
+   */
+  projectId?: string | undefined;
+  /**
+   * Identifier of the entity that changed.
+   */
+  entityId: string;
+  entityType: Value;
+  action: Value;
+  /**
+   * User or system actor that caused the event, when available.
+   */
+  actorId?: string | undefined;
+  /**
+   * IP address observed for the actor, when available.
+   */
+  actorIp?: string | undefined;
+  actorType?: Value | undefined;
+  /**
+   * Human readable actor name captured when the action happened.
+   */
+  actorDisplay?: string | undefined;
+  origin?: Value | undefined;
+  /**
+   * Correlates the entry with the originating request.
+   */
+  requestId?: string | undefined;
+  /**
+   * Time when the audit log entry was created.
+   */
+  createdAt: Date;
+  /**
+   * Additional event metadata. The exact shape depends on entity_type and action.
+   */
+  metadata?: AuditLogMetadata | undefined;
+};
+
+/** @internal */
+export const AuditLogMetadata$inboundSchema: z.ZodType<
+  AuditLogMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function auditLogMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditLogMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditLogMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditLogMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuditLog$inboundSchema: z.ZodType<
+  AuditLog,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  audit_log_id: z.string(),
+  project_id: z.string().optional(),
+  entity_id: z.string(),
+  entity_type: Value$inboundSchema,
+  action: Value$inboundSchema,
+  actor_id: z.string().optional(),
+  actor_ip: z.string().optional(),
+  actor_type: Value$inboundSchema.optional(),
+  actor_display: z.string().optional(),
+  origin: Value$inboundSchema.optional(),
+  request_id: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  metadata: z.lazy(() => AuditLogMetadata$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "audit_log_id": "auditLogId",
+    "project_id": "projectId",
+    "entity_id": "entityId",
+    "entity_type": "entityType",
+    "actor_id": "actorId",
+    "actor_ip": "actorIp",
+    "actor_type": "actorType",
+    "actor_display": "actorDisplay",
+    "request_id": "requestId",
+    "created_at": "createdAt",
+  });
+});
+
+export function auditLogFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditLog, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditLog$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditLog' from JSON`,
+  );
+}

package/src/models/components/auditlogfilter.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * A single advanced filter applied to audit logs.
+ */
+export type AuditLogFilter = {
+  /**
+   * Filter value type, such as string, date, number, boolean, or array.
+   */
+  type: string;
+  /**
+   * Audit log field path to filter on. Supported paths include created_at, entity_id, entity_type, action, actor_id, and metadata.display_name.
+   */
+  path: string;
+  /**
+   * Filter operator supported by the selected field type.
+   */
+  operator: string;
+  /**
+   * 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.
+   */
+  value?: any | undefined;
+};
+
+/** @internal */
+export type AuditLogFilter$Outbound = {
+  type: string;
+  path: string;
+  operator: string;
+  value?: any | undefined;
+};
+
+/** @internal */
+export const AuditLogFilter$outboundSchema: z.ZodType<
+  AuditLogFilter$Outbound,
+  z.ZodTypeDef,
+  AuditLogFilter
+> = z.object({
+  type: z.string(),
+  path: z.string(),
+  operator: z.string(),
+  value: z.any().optional(),
+});
+
+export function auditLogFilterToJSON(auditLogFilter: AuditLogFilter): string {
+  return JSON.stringify(AuditLogFilter$outboundSchema.parse(auditLogFilter));
+}

package/src/models/components/auditlogfilterquery.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AuditLogFilter,
+  AuditLogFilter$Outbound,
+  AuditLogFilter$outboundSchema,
+} from "./auditlogfilter.js";
+
+/**
+ * Search and advanced filters for querying audit logs.
+ */
+export type AuditLogFilterQuery = {
+  /**
+   * Optional text search applied to supported display fields.
+   */
+  search?: string | undefined;
+  /**
+   * Logical operator used to combine filters.
+   */
+  operator: string;
+  /**
+   * Advanced filters applied to the query.
+   */
+  filters: Array<AuditLogFilter>;
+};
+
+/** @internal */
+export type AuditLogFilterQuery$Outbound = {
+  search?: string | undefined;
+  operator: string;
+  filters: Array<AuditLogFilter$Outbound>;
+};
+
+/** @internal */
+export const AuditLogFilterQuery$outboundSchema: z.ZodType<
+  AuditLogFilterQuery$Outbound,
+  z.ZodTypeDef,
+  AuditLogFilterQuery
+> = z.object({
+  search: z.string().optional(),
+  operator: z.string(),
+  filters: z.array(AuditLogFilter$outboundSchema),
+});
+
+export function auditLogFilterQueryToJSON(
+  auditLogFilterQuery: AuditLogFilterQuery,
+): string {
+  return JSON.stringify(
+    AuditLogFilterQuery$outboundSchema.parse(auditLogFilterQuery),
+  );
+}