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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (207) hide show
  1. package/README.md +30 -28
  2. package/funcs/piiCapabilities.d.ts +17 -0
  3. package/funcs/piiCapabilities.d.ts.map +1 -0
  4. package/funcs/piiCapabilities.js +105 -0
  5. package/funcs/piiCapabilities.js.map +1 -0
  6. package/jsr.json +1 -1
  7. package/lib/config.d.ts +2 -2
  8. package/lib/config.js +2 -2
  9. package/models/components/agentstartedstreamingevent.d.ts +13 -1
  10. package/models/components/agentstartedstreamingevent.d.ts.map +1 -1
  11. package/models/components/agentstartedstreamingevent.js +2 -0
  12. package/models/components/agentstartedstreamingevent.js.map +1 -1
  13. package/models/components/capabilitiesresponse.d.ts +62 -0
  14. package/models/components/capabilitiesresponse.d.ts.map +1 -0
  15. package/models/components/capabilitiesresponse.js +68 -0
  16. package/models/components/capabilitiesresponse.js.map +1 -0
  17. package/models/components/detectrequest.d.ts +48 -0
  18. package/models/components/detectrequest.d.ts.map +1 -1
  19. package/models/components/detectrequest.js +4 -0
  20. package/models/components/detectrequest.js.map +1 -1
  21. package/models/components/entitylist.d.ts +16 -0
  22. package/models/components/entitylist.d.ts.map +1 -0
  23. package/models/components/entitylist.js +50 -0
  24. package/models/components/entitylist.js.map +1 -0
  25. package/models/components/guardrailruleplugin.d.ts +25 -0
  26. package/models/components/guardrailruleplugin.d.ts.map +1 -1
  27. package/models/components/guardrailruleplugin.js +6 -0
  28. package/models/components/guardrailruleplugin.js.map +1 -1
  29. package/models/components/index.d.ts +3 -3
  30. package/models/components/index.d.ts.map +1 -1
  31. package/models/components/index.js +3 -3
  32. package/models/components/index.js.map +1 -1
  33. package/models/components/piiredactionplugin.d.ts +84 -0
  34. package/models/components/piiredactionplugin.d.ts.map +1 -0
  35. package/models/components/piiredactionplugin.js +103 -0
  36. package/models/components/piiredactionplugin.js.map +1 -0
  37. package/models/components/publicplugin.d.ts +17 -16
  38. package/models/components/publicplugin.d.ts.map +1 -1
  39. package/models/components/publicplugin.js +5 -11
  40. package/models/components/publicplugin.js.map +1 -1
  41. package/models/components/reasoningpart.js +1 -1
  42. package/models/components/redactrequest.d.ts +48 -0
  43. package/models/components/redactrequest.d.ts.map +1 -1
  44. package/models/components/redactrequest.js +8 -0
  45. package/models/components/redactrequest.js.map +1 -1
  46. package/models/components/responsehealingplugin.d.ts +2 -17
  47. package/models/components/responsehealingplugin.d.ts.map +1 -1
  48. package/models/components/responsehealingplugin.js +3 -13
  49. package/models/components/responsehealingplugin.js.map +1 -1
  50. package/models/components/routingruleplugin.d.ts +25 -0
  51. package/models/components/routingruleplugin.d.ts.map +1 -1
  52. package/models/components/routingruleplugin.js +6 -0
  53. package/models/components/routingruleplugin.js.map +1 -1
  54. package/models/components/tracescrubbingplugin.d.ts +2 -16
  55. package/models/components/tracescrubbingplugin.d.ts.map +1 -1
  56. package/models/components/tracescrubbingplugin.js +3 -13
  57. package/models/components/tracescrubbingplugin.js.map +1 -1
  58. package/models/operations/createagentrequest.d.ts +67 -13
  59. package/models/operations/createagentrequest.d.ts.map +1 -1
  60. package/models/operations/createagentrequest.js +20 -32
  61. package/models/operations/createagentrequest.js.map +1 -1
  62. package/models/operations/createchatcompletion.d.ts +12 -4
  63. package/models/operations/createchatcompletion.d.ts.map +1 -1
  64. package/models/operations/createchatcompletion.js +4 -8
  65. package/models/operations/createchatcompletion.js.map +1 -1
  66. package/models/operations/createcompletion.d.ts +2 -8
  67. package/models/operations/createcompletion.d.ts.map +1 -1
  68. package/models/operations/createcompletion.js +3 -17
  69. package/models/operations/createcompletion.js.map +1 -1
  70. package/models/operations/createdataset.js +1 -1
  71. package/models/operations/createdatasetitem.js +5 -5
  72. package/models/operations/createimage.d.ts +2 -8
  73. package/models/operations/createimage.d.ts.map +1 -1
  74. package/models/operations/createimage.js +2 -16
  75. package/models/operations/createimage.js.map +1 -1
  76. package/models/operations/createprompt.d.ts +18 -6
  77. package/models/operations/createprompt.d.ts.map +1 -1
  78. package/models/operations/createprompt.js +8 -16
  79. package/models/operations/createprompt.js.map +1 -1
  80. package/models/operations/creatererank.d.ts +2 -8
  81. package/models/operations/creatererank.d.ts.map +1 -1
  82. package/models/operations/creatererank.js +2 -16
  83. package/models/operations/creatererank.js.map +1 -1
  84. package/models/operations/createtool.js +4 -4
  85. package/models/operations/getallprompts.d.ts +6 -2
  86. package/models/operations/getallprompts.d.ts.map +1 -1
  87. package/models/operations/getallprompts.js +4 -8
  88. package/models/operations/getallprompts.js.map +1 -1
  89. package/models/operations/getalltools.js +4 -4
  90. package/models/operations/getoneprompt.d.ts +6 -2
  91. package/models/operations/getoneprompt.d.ts.map +1 -1
  92. package/models/operations/getoneprompt.js +4 -8
  93. package/models/operations/getoneprompt.js.map +1 -1
  94. package/models/operations/getpromptversion.d.ts +6 -2
  95. package/models/operations/getpromptversion.d.ts.map +1 -1
  96. package/models/operations/getpromptversion.js +4 -8
  97. package/models/operations/getpromptversion.js.map +1 -1
  98. package/models/operations/getv2humanevalsets.js +2 -2
  99. package/models/operations/getv2humanevalsetsid.js +2 -2
  100. package/models/operations/listagents.d.ts +25 -5
  101. package/models/operations/listagents.d.ts.map +1 -1
  102. package/models/operations/listagents.js +10 -16
  103. package/models/operations/listagents.js.map +1 -1
  104. package/models/operations/listdatasetdatapoints.js +5 -5
  105. package/models/operations/listdatasets.js +1 -1
  106. package/models/operations/listpromptversions.d.ts +6 -2
  107. package/models/operations/listpromptversions.d.ts.map +1 -1
  108. package/models/operations/listpromptversions.js +4 -8
  109. package/models/operations/listpromptversions.js.map +1 -1
  110. package/models/operations/patchv2humanevalsetsid.js +2 -2
  111. package/models/operations/postv2feedbackevaluation.js +4 -4
  112. package/models/operations/postv2humanevalsets.js +2 -2
  113. package/models/operations/retrieveagentrequest.d.ts +25 -5
  114. package/models/operations/retrieveagentrequest.d.ts.map +1 -1
  115. package/models/operations/retrieveagentrequest.js +10 -16
  116. package/models/operations/retrieveagentrequest.js.map +1 -1
  117. package/models/operations/retrievedatapoint.js +5 -5
  118. package/models/operations/retrievedataset.js +1 -1
  119. package/models/operations/retrievetool.js +4 -4
  120. package/models/operations/runagent.d.ts +42 -8
  121. package/models/operations/runagent.d.ts.map +1 -1
  122. package/models/operations/runagent.js +11 -17
  123. package/models/operations/runagent.js.map +1 -1
  124. package/models/operations/streamrunagent.d.ts +42 -8
  125. package/models/operations/streamrunagent.d.ts.map +1 -1
  126. package/models/operations/streamrunagent.js +11 -17
  127. package/models/operations/streamrunagent.js.map +1 -1
  128. package/models/operations/updateagent.d.ts +67 -13
  129. package/models/operations/updateagent.d.ts.map +1 -1
  130. package/models/operations/updateagent.js +20 -32
  131. package/models/operations/updateagent.js.map +1 -1
  132. package/models/operations/updatedatapoint.js +5 -5
  133. package/models/operations/updatedataset.js +1 -1
  134. package/models/operations/updateprompt.d.ts +18 -6
  135. package/models/operations/updateprompt.d.ts.map +1 -1
  136. package/models/operations/updateprompt.js +8 -16
  137. package/models/operations/updateprompt.js.map +1 -1
  138. package/models/operations/updatetool.js +4 -4
  139. package/package.json +1 -1
  140. package/sdk/pii.d.ts +7 -0
  141. package/sdk/pii.d.ts.map +1 -1
  142. package/sdk/pii.js +10 -0
  143. package/sdk/pii.js.map +1 -1
  144. package/src/funcs/piiCapabilities.ts +144 -0
  145. package/src/lib/config.ts +2 -2
  146. package/src/models/components/agentstartedstreamingevent.ts +11 -1
  147. package/src/models/components/capabilitiesresponse.ts +96 -0
  148. package/src/models/components/detectrequest.ts +48 -0
  149. package/src/models/components/entitylist.ts +37 -0
  150. package/src/models/components/guardrailruleplugin.ts +27 -0
  151. package/src/models/components/index.ts +3 -3
  152. package/src/models/components/piiredactionplugin.ts +143 -0
  153. package/src/models/components/publicplugin.ts +17 -21
  154. package/src/models/components/reasoningpart.ts +1 -1
  155. package/src/models/components/redactrequest.ts +52 -0
  156. package/src/models/components/responsehealingplugin.ts +4 -27
  157. package/src/models/components/routingruleplugin.ts +27 -0
  158. package/src/models/components/tracescrubbingplugin.ts +4 -24
  159. package/src/models/operations/createagentrequest.ts +85 -87
  160. package/src/models/operations/createchatcompletion.ts +18 -26
  161. package/src/models/operations/createcompletion.ts +3 -51
  162. package/src/models/operations/createdataset.ts +1 -1
  163. package/src/models/operations/createdatasetitem.ts +5 -5
  164. package/src/models/operations/createimage.ts +3 -51
  165. package/src/models/operations/createprompt.ts +31 -43
  166. package/src/models/operations/creatererank.ts +3 -51
  167. package/src/models/operations/createtool.ts +4 -4
  168. package/src/models/operations/getallprompts.ts +13 -17
  169. package/src/models/operations/getalltools.ts +4 -4
  170. package/src/models/operations/getoneprompt.ts +13 -17
  171. package/src/models/operations/getpromptversion.ts +13 -17
  172. package/src/models/operations/getv2humanevalsets.ts +2 -2
  173. package/src/models/operations/getv2humanevalsetsid.ts +2 -2
  174. package/src/models/operations/listagents.ts +37 -35
  175. package/src/models/operations/listdatasetdatapoints.ts +5 -5
  176. package/src/models/operations/listdatasets.ts +1 -1
  177. package/src/models/operations/listpromptversions.ts +13 -17
  178. package/src/models/operations/patchv2humanevalsetsid.ts +2 -2
  179. package/src/models/operations/postv2feedbackevaluation.ts +4 -4
  180. package/src/models/operations/postv2humanevalsets.ts +2 -2
  181. package/src/models/operations/retrieveagentrequest.ts +37 -35
  182. package/src/models/operations/retrievedatapoint.ts +5 -5
  183. package/src/models/operations/retrievedataset.ts +1 -1
  184. package/src/models/operations/retrievetool.ts +4 -4
  185. package/src/models/operations/runagent.ts +49 -53
  186. package/src/models/operations/streamrunagent.ts +49 -53
  187. package/src/models/operations/updateagent.ts +85 -87
  188. package/src/models/operations/updatedatapoint.ts +5 -5
  189. package/src/models/operations/updatedataset.ts +1 -1
  190. package/src/models/operations/updateprompt.ts +31 -43
  191. package/src/models/operations/updatetool.ts +4 -4
  192. package/src/sdk/pii.ts +16 -0
  193. package/models/components/piiredactionpluginauto.d.ts +0 -126
  194. package/models/components/piiredactionpluginauto.d.ts.map +0 -1
  195. package/models/components/piiredactionpluginauto.js +0 -156
  196. package/models/components/piiredactionpluginauto.js.map +0 -1
  197. package/models/components/piiredactionpluginen.d.ts +0 -145
  198. package/models/components/piiredactionpluginen.d.ts.map +0 -1
  199. package/models/components/piiredactionpluginen.js +0 -167
  200. package/models/components/piiredactionpluginen.js.map +0 -1
  201. package/models/components/piiredactionpluginnl.d.ts +0 -137
  202. package/models/components/piiredactionpluginnl.d.ts.map +0 -1
  203. package/models/components/piiredactionpluginnl.js +0 -158
  204. package/models/components/piiredactionpluginnl.js.map +0 -1
  205. package/src/models/components/piiredactionpluginauto.ts +0 -185
  206. package/src/models/components/piiredactionpluginen.ts +0 -222
  207. package/src/models/components/piiredactionpluginnl.ts +0 -218
@@ -13,11 +13,30 @@ export type RoutingRulePlugin = {
13
13
  * Plugin discriminator.
14
14
  */
15
15
  id?: string | undefined;
16
+ /**
17
+ * Languages, regions and entity types are checked against the live
18
+ *
19
+ * @remarks
20
+ * pii-detection capabilities catalog when the rule is saved, not pinned
21
+ * here, so a language or region the detector gains becomes writable without
22
+ * a proto change.
23
+ */
16
24
  language?: string | undefined;
25
+ /**
26
+ * Entity types to redact. Mutually exclusive with regions.
27
+ */
17
28
  entities?: Array<string> | undefined;
18
29
  onFailure?: string | undefined;
19
30
  threshold?: number | undefined;
20
31
  mask?: Array<string> | undefined;
32
+ /**
33
+ * Regions of coverage by ISO 3166-1 alpha-2 code, or ["all"]. Mutually exclusive with entities.
34
+ */
35
+ regions?: Array<string> | undefined;
36
+ /**
37
+ * Per-entity-type confidence cutoff. Every key must also appear in entities.
38
+ */
39
+ entityThresholds?: { [k: string]: number } | undefined;
21
40
  };
22
41
 
23
42
  /** @internal */
@@ -32,9 +51,12 @@ export const RoutingRulePlugin$inboundSchema: z.ZodType<
32
51
  on_failure: z.string().optional(),
33
52
  threshold: z.number().optional(),
34
53
  mask: z.array(z.string()).optional(),
54
+ regions: z.array(z.string()).optional(),
55
+ entity_thresholds: z.record(z.number()).optional(),
35
56
  }).transform((v) => {
36
57
  return remap$(v, {
37
58
  "on_failure": "onFailure",
59
+ "entity_thresholds": "entityThresholds",
38
60
  });
39
61
  });
40
62
  /** @internal */
@@ -45,6 +67,8 @@ export type RoutingRulePlugin$Outbound = {
45
67
  on_failure?: string | undefined;
46
68
  threshold?: number | undefined;
47
69
  mask?: Array<string> | undefined;
70
+ regions?: Array<string> | undefined;
71
+ entity_thresholds?: { [k: string]: number } | undefined;
48
72
  };
49
73
 
50
74
  /** @internal */
@@ -59,9 +83,12 @@ export const RoutingRulePlugin$outboundSchema: z.ZodType<
59
83
  onFailure: z.string().optional(),
60
84
  threshold: z.number().optional(),
61
85
  mask: z.array(z.string()).optional(),
86
+ regions: z.array(z.string()).optional(),
87
+ entityThresholds: z.record(z.number()).optional(),
62
88
  }).transform((v) => {
63
89
  return remap$(v, {
64
90
  onFailure: "on_failure",
91
+ entityThresholds: "entity_thresholds",
65
92
  });
66
93
  });
67
94
 
@@ -8,17 +8,6 @@ import { ClosedEnum } from "../../types/enums.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
- /**
12
- * Plugin discriminator. Must be `trace_scrubbing`.
13
- */
14
- export const TraceScrubbingPluginId = {
15
- TraceScrubbing: "trace_scrubbing",
16
- } as const;
17
- /**
18
- * Plugin discriminator. Must be `trace_scrubbing`.
19
- */
20
- export type TraceScrubbingPluginId = ClosedEnum<typeof TraceScrubbingPluginId>;
21
-
22
11
  export const Mask = {
23
12
  All: "all",
24
13
  System: "system",
@@ -33,22 +22,13 @@ export type TraceScrubbingPlugin = {
33
22
  /**
34
23
  * Plugin discriminator. Must be `trace_scrubbing`.
35
24
  */
36
- id: TraceScrubbingPluginId;
25
+ id: "trace_scrubbing";
37
26
  /**
38
27
  * Trace surfaces to scrub. `all` includes system, input, output, metadata, and variables.
39
28
  */
40
29
  mask: Array<Mask>;
41
30
  };
42
31
 
43
- /** @internal */
44
- export const TraceScrubbingPluginId$inboundSchema: z.ZodNativeEnum<
45
- typeof TraceScrubbingPluginId
46
- > = z.nativeEnum(TraceScrubbingPluginId);
47
- /** @internal */
48
- export const TraceScrubbingPluginId$outboundSchema: z.ZodNativeEnum<
49
- typeof TraceScrubbingPluginId
50
- > = TraceScrubbingPluginId$inboundSchema;
51
-
52
32
  /** @internal */
53
33
  export const Mask$inboundSchema: z.ZodNativeEnum<typeof Mask> = z.nativeEnum(
54
34
  Mask,
@@ -63,12 +43,12 @@ export const TraceScrubbingPlugin$inboundSchema: z.ZodType<
63
43
  z.ZodTypeDef,
64
44
  unknown
65
45
  > = z.object({
66
- id: TraceScrubbingPluginId$inboundSchema,
46
+ id: z.literal("trace_scrubbing"),
67
47
  mask: z.array(Mask$inboundSchema),
68
48
  });
69
49
  /** @internal */
70
50
  export type TraceScrubbingPlugin$Outbound = {
71
- id: string;
51
+ id: "trace_scrubbing";
72
52
  mask: Array<string>;
73
53
  };
74
54
 
@@ -78,7 +58,7 @@ export const TraceScrubbingPlugin$outboundSchema: z.ZodType<
78
58
  z.ZodTypeDef,
79
59
  TraceScrubbingPlugin
80
60
  > = z.object({
81
- id: TraceScrubbingPluginId$outboundSchema,
61
+ id: z.literal("trace_scrubbing"),
82
62
  mask: z.array(Mask$outboundSchema),
83
63
  });
84
64
 
@@ -188,11 +188,9 @@ export type Guardrails = {
188
188
  };
189
189
 
190
190
  export type Plugins =
191
- | components.PIIRedactionPluginEn
192
- | components.PIIRedactionPluginNl
193
- | components.TraceScrubbingPlugin
194
- | components.PIIRedactionPluginAuto
195
- | components.ResponseHealingPlugin;
191
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
192
+ | components.ResponseHealingPlugin
193
+ | components.TraceScrubbingPlugin;
196
194
 
197
195
  export type Fallbacks = {
198
196
  /**
@@ -408,11 +406,9 @@ export type ParametersT = {
408
406
  */
409
407
  plugins?:
410
408
  | Array<
411
- | components.PIIRedactionPluginEn
412
- | components.PIIRedactionPluginNl
413
- | components.TraceScrubbingPlugin
414
- | components.PIIRedactionPluginAuto
409
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
415
410
  | components.ResponseHealingPlugin
411
+ | components.TraceScrubbingPlugin
416
412
  >
417
413
  | undefined;
418
414
  /**
@@ -673,11 +669,9 @@ export type FallbackModelConfigurationGuardrails = {
673
669
  };
674
670
 
675
671
  export type FallbackModelConfigurationPlugins =
676
- | components.PIIRedactionPluginEn
677
- | components.PIIRedactionPluginNl
678
- | components.TraceScrubbingPlugin
679
- | components.PIIRedactionPluginAuto
680
- | components.ResponseHealingPlugin;
672
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
673
+ | components.ResponseHealingPlugin
674
+ | components.TraceScrubbingPlugin;
681
675
 
682
676
  export type FallbackModelConfigurationFallbacks = {
683
677
  /**
@@ -907,11 +901,9 @@ export type FallbackModelConfigurationParameters = {
907
901
  */
908
902
  plugins?:
909
903
  | Array<
910
- | components.PIIRedactionPluginEn
911
- | components.PIIRedactionPluginNl
912
- | components.TraceScrubbingPlugin
913
- | components.PIIRedactionPluginAuto
904
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
914
905
  | components.ResponseHealingPlugin
906
+ | components.TraceScrubbingPlugin
915
907
  >
916
908
  | undefined;
917
909
  /**
@@ -1017,6 +1009,10 @@ export type Evaluators = {
1017
1009
  * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
1018
1010
  */
1019
1011
  executeOn: CreateAgentRequestExecuteOn;
1012
+ /**
1013
+ * 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.
1014
+ */
1015
+ options?: { [k: string]: any } | undefined;
1020
1016
  };
1021
1017
 
1022
1018
  /**
@@ -1046,6 +1042,10 @@ export type CreateAgentRequestGuardrails = {
1046
1042
  * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
1047
1043
  */
1048
1044
  executeOn: CreateAgentRequestAgentsExecuteOn;
1045
+ /**
1046
+ * 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.
1047
+ */
1048
+ options?: { [k: string]: any } | undefined;
1049
1049
  };
1050
1050
 
1051
1051
  /**
@@ -1340,6 +1340,10 @@ export type CreateAgentRequestEvaluators = {
1340
1340
  * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
1341
1341
  */
1342
1342
  executeOn: CreateAgentRequestAgentsResponseExecuteOn;
1343
+ /**
1344
+ * 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.
1345
+ */
1346
+ options?: { [k: string]: any } | undefined;
1343
1347
  };
1344
1348
 
1345
1349
  /**
@@ -1369,6 +1373,10 @@ export type CreateAgentRequestAgentsGuardrails = {
1369
1373
  * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
1370
1374
  */
1371
1375
  executeOn: CreateAgentRequestAgentsResponse201ExecuteOn;
1376
+ /**
1377
+ * 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.
1378
+ */
1379
+ options?: { [k: string]: any } | undefined;
1372
1380
  };
1373
1381
 
1374
1382
  export type CreateAgentRequestSettings = {
@@ -1398,7 +1406,7 @@ export type CreateAgentRequestSettings = {
1398
1406
  */
1399
1407
  evaluators?: Array<CreateAgentRequestEvaluators> | undefined;
1400
1408
  /**
1401
- * Configuration for a guardrail applied to the agent
1409
+ * 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.
1402
1410
  */
1403
1411
  guardrails?: Array<CreateAgentRequestAgentsGuardrails> | undefined;
1404
1412
  };
@@ -1599,11 +1607,9 @@ export type CreateAgentRequestAgentsResponseGuardrails = {
1599
1607
  };
1600
1608
 
1601
1609
  export type CreateAgentRequestPlugins =
1602
- | components.PIIRedactionPluginEn
1603
- | components.PIIRedactionPluginNl
1604
- | components.TraceScrubbingPlugin
1605
- | components.PIIRedactionPluginAuto
1606
- | components.ResponseHealingPlugin;
1610
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
1611
+ | components.ResponseHealingPlugin
1612
+ | components.TraceScrubbingPlugin;
1607
1613
 
1608
1614
  export type CreateAgentRequestFallbacks = {
1609
1615
  /**
@@ -1831,11 +1837,9 @@ export type CreateAgentRequestParameters = {
1831
1837
  */
1832
1838
  plugins?:
1833
1839
  | Array<
1834
- | components.PIIRedactionPluginEn
1835
- | components.PIIRedactionPluginNl
1836
- | components.TraceScrubbingPlugin
1837
- | components.PIIRedactionPluginAuto
1840
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
1838
1841
  | components.ResponseHealingPlugin
1842
+ | components.TraceScrubbingPlugin
1839
1843
  >
1840
1844
  | undefined;
1841
1845
  /**
@@ -2081,11 +2085,9 @@ export type CreateAgentRequestFallbackModelConfigurationGuardrails = {
2081
2085
  };
2082
2086
 
2083
2087
  export type CreateAgentRequestFallbackModelConfigurationPlugins =
2084
- | components.PIIRedactionPluginEn
2085
- | components.PIIRedactionPluginNl
2086
- | components.TraceScrubbingPlugin
2087
- | components.PIIRedactionPluginAuto
2088
- | components.ResponseHealingPlugin;
2088
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
2089
+ | components.ResponseHealingPlugin
2090
+ | components.TraceScrubbingPlugin;
2089
2091
 
2090
2092
  export type CreateAgentRequestFallbackModelConfigurationFallbacks = {
2091
2093
  /**
@@ -2323,11 +2325,9 @@ export type CreateAgentRequestFallbackModelConfigurationParameters = {
2323
2325
  */
2324
2326
  plugins?:
2325
2327
  | Array<
2326
- | components.PIIRedactionPluginEn
2327
- | components.PIIRedactionPluginNl
2328
- | components.TraceScrubbingPlugin
2329
- | components.PIIRedactionPluginAuto
2328
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
2330
2329
  | components.ResponseHealingPlugin
2330
+ | components.TraceScrubbingPlugin
2331
2331
  >
2332
2332
  | undefined;
2333
2333
  /**
@@ -2756,11 +2756,9 @@ export function guardrailsToJSON(guardrails: Guardrails): string {
2756
2756
 
2757
2757
  /** @internal */
2758
2758
  export type Plugins$Outbound =
2759
- | components.PIIRedactionPluginEn$Outbound
2760
- | components.PIIRedactionPluginNl$Outbound
2761
- | components.TraceScrubbingPlugin$Outbound
2762
- | components.PIIRedactionPluginAuto$Outbound
2763
- | components.ResponseHealingPlugin$Outbound;
2759
+ | (components.PIIRedactionPlugin$Outbound & { id: "pii_redaction" })
2760
+ | components.ResponseHealingPlugin$Outbound
2761
+ | components.TraceScrubbingPlugin$Outbound;
2764
2762
 
2765
2763
  /** @internal */
2766
2764
  export const Plugins$outboundSchema: z.ZodType<
@@ -2768,11 +2766,11 @@ export const Plugins$outboundSchema: z.ZodType<
2768
2766
  z.ZodTypeDef,
2769
2767
  Plugins
2770
2768
  > = z.union([
2771
- components.PIIRedactionPluginEn$outboundSchema,
2772
- components.PIIRedactionPluginNl$outboundSchema,
2773
- components.TraceScrubbingPlugin$outboundSchema,
2774
- components.PIIRedactionPluginAuto$outboundSchema,
2769
+ components.PIIRedactionPlugin$outboundSchema.and(
2770
+ z.object({ id: z.literal("pii_redaction") }),
2771
+ ),
2775
2772
  components.ResponseHealingPlugin$outboundSchema,
2773
+ components.TraceScrubbingPlugin$outboundSchema,
2776
2774
  ]);
2777
2775
 
2778
2776
  export function pluginsToJSON(plugins: Plugins): string {
@@ -2969,11 +2967,9 @@ export type ParametersT$Outbound = {
2969
2967
  guardrails?: Array<Guardrails$Outbound> | undefined;
2970
2968
  plugins?:
2971
2969
  | Array<
2972
- | components.PIIRedactionPluginEn$Outbound
2973
- | components.PIIRedactionPluginNl$Outbound
2974
- | components.TraceScrubbingPlugin$Outbound
2975
- | components.PIIRedactionPluginAuto$Outbound
2970
+ | (components.PIIRedactionPlugin$Outbound & { id: "pii_redaction" })
2976
2971
  | components.ResponseHealingPlugin$Outbound
2972
+ | components.TraceScrubbingPlugin$Outbound
2977
2973
  >
2978
2974
  | undefined;
2979
2975
  fallbacks?: Array<Fallbacks$Outbound> | undefined;
@@ -3021,11 +3017,11 @@ export const ParametersT$outboundSchema: z.ZodType<
3021
3017
  guardrails: z.array(z.lazy(() => Guardrails$outboundSchema)).optional(),
3022
3018
  plugins: z.array(
3023
3019
  z.union([
3024
- components.PIIRedactionPluginEn$outboundSchema,
3025
- components.PIIRedactionPluginNl$outboundSchema,
3026
- components.TraceScrubbingPlugin$outboundSchema,
3027
- components.PIIRedactionPluginAuto$outboundSchema,
3020
+ components.PIIRedactionPlugin$outboundSchema.and(
3021
+ z.object({ id: z.literal("pii_redaction") }),
3022
+ ),
3028
3023
  components.ResponseHealingPlugin$outboundSchema,
3024
+ components.TraceScrubbingPlugin$outboundSchema,
3029
3025
  ]),
3030
3026
  ).optional(),
3031
3027
  fallbacks: z.array(z.lazy(() => Fallbacks$outboundSchema)).optional(),
@@ -3469,11 +3465,9 @@ export function fallbackModelConfigurationGuardrailsToJSON(
3469
3465
 
3470
3466
  /** @internal */
3471
3467
  export type FallbackModelConfigurationPlugins$Outbound =
3472
- | components.PIIRedactionPluginEn$Outbound
3473
- | components.PIIRedactionPluginNl$Outbound
3474
- | components.TraceScrubbingPlugin$Outbound
3475
- | components.PIIRedactionPluginAuto$Outbound
3476
- | components.ResponseHealingPlugin$Outbound;
3468
+ | (components.PIIRedactionPlugin$Outbound & { id: "pii_redaction" })
3469
+ | components.ResponseHealingPlugin$Outbound
3470
+ | components.TraceScrubbingPlugin$Outbound;
3477
3471
 
3478
3472
  /** @internal */
3479
3473
  export const FallbackModelConfigurationPlugins$outboundSchema: z.ZodType<
@@ -3481,11 +3475,11 @@ export const FallbackModelConfigurationPlugins$outboundSchema: z.ZodType<
3481
3475
  z.ZodTypeDef,
3482
3476
  FallbackModelConfigurationPlugins
3483
3477
  > = z.union([
3484
- components.PIIRedactionPluginEn$outboundSchema,
3485
- components.PIIRedactionPluginNl$outboundSchema,
3486
- components.TraceScrubbingPlugin$outboundSchema,
3487
- components.PIIRedactionPluginAuto$outboundSchema,
3478
+ components.PIIRedactionPlugin$outboundSchema.and(
3479
+ z.object({ id: z.literal("pii_redaction") }),
3480
+ ),
3488
3481
  components.ResponseHealingPlugin$outboundSchema,
3482
+ components.TraceScrubbingPlugin$outboundSchema,
3489
3483
  ]);
3490
3484
 
3491
3485
  export function fallbackModelConfigurationPluginsToJSON(
@@ -3725,11 +3719,9 @@ export type FallbackModelConfigurationParameters$Outbound = {
3725
3719
  guardrails?: Array<FallbackModelConfigurationGuardrails$Outbound> | undefined;
3726
3720
  plugins?:
3727
3721
  | Array<
3728
- | components.PIIRedactionPluginEn$Outbound
3729
- | components.PIIRedactionPluginNl$Outbound
3730
- | components.TraceScrubbingPlugin$Outbound
3731
- | components.PIIRedactionPluginAuto$Outbound
3722
+ | (components.PIIRedactionPlugin$Outbound & { id: "pii_redaction" })
3732
3723
  | components.ResponseHealingPlugin$Outbound
3724
+ | components.TraceScrubbingPlugin$Outbound
3733
3725
  >
3734
3726
  | undefined;
3735
3727
  fallbacks?: Array<FallbackModelConfigurationFallbacks$Outbound> | undefined;
@@ -3782,11 +3774,11 @@ export const FallbackModelConfigurationParameters$outboundSchema: z.ZodType<
3782
3774
  ).optional(),
3783
3775
  plugins: z.array(
3784
3776
  z.union([
3785
- components.PIIRedactionPluginEn$outboundSchema,
3786
- components.PIIRedactionPluginNl$outboundSchema,
3787
- components.TraceScrubbingPlugin$outboundSchema,
3788
- components.PIIRedactionPluginAuto$outboundSchema,
3777
+ components.PIIRedactionPlugin$outboundSchema.and(
3778
+ z.object({ id: z.literal("pii_redaction") }),
3779
+ ),
3789
3780
  components.ResponseHealingPlugin$outboundSchema,
3781
+ components.TraceScrubbingPlugin$outboundSchema,
3790
3782
  ]),
3791
3783
  ).optional(),
3792
3784
  fallbacks: z.array(
@@ -3928,6 +3920,7 @@ export type Evaluators$Outbound = {
3928
3920
  id: string;
3929
3921
  sample_rate: number;
3930
3922
  execute_on: string;
3923
+ options?: { [k: string]: any } | undefined;
3931
3924
  };
3932
3925
 
3933
3926
  /** @internal */
@@ -3939,6 +3932,7 @@ export const Evaluators$outboundSchema: z.ZodType<
3939
3932
  id: z.string(),
3940
3933
  sampleRate: z.number().default(50),
3941
3934
  executeOn: CreateAgentRequestExecuteOn$outboundSchema,
3935
+ options: z.record(z.any()).optional(),
3942
3936
  }).transform((v) => {
3943
3937
  return remap$(v, {
3944
3938
  sampleRate: "sample_rate",
@@ -3960,6 +3954,7 @@ export type CreateAgentRequestGuardrails$Outbound = {
3960
3954
  id: string;
3961
3955
  sample_rate: number;
3962
3956
  execute_on: string;
3957
+ options?: { [k: string]: any } | undefined;
3963
3958
  };
3964
3959
 
3965
3960
  /** @internal */
@@ -3971,6 +3966,7 @@ export const CreateAgentRequestGuardrails$outboundSchema: z.ZodType<
3971
3966
  id: z.string(),
3972
3967
  sampleRate: z.number().default(50),
3973
3968
  executeOn: CreateAgentRequestAgentsExecuteOn$outboundSchema,
3969
+ options: z.record(z.any()).optional(),
3974
3970
  }).transform((v) => {
3975
3971
  return remap$(v, {
3976
3972
  sampleRate: "sample_rate",
@@ -4316,6 +4312,7 @@ export const CreateAgentRequestEvaluators$inboundSchema: z.ZodType<
4316
4312
  id: z.string(),
4317
4313
  sample_rate: z.number().default(50),
4318
4314
  execute_on: CreateAgentRequestAgentsResponseExecuteOn$inboundSchema,
4315
+ options: z.record(z.any()).optional(),
4319
4316
  }).transform((v) => {
4320
4317
  return remap$(v, {
4321
4318
  "sample_rate": "sampleRate",
@@ -4347,6 +4344,7 @@ export const CreateAgentRequestAgentsGuardrails$inboundSchema: z.ZodType<
4347
4344
  id: z.string(),
4348
4345
  sample_rate: z.number().default(50),
4349
4346
  execute_on: CreateAgentRequestAgentsResponse201ExecuteOn$inboundSchema,
4347
+ options: z.record(z.any()).optional(),
4350
4348
  }).transform((v) => {
4351
4349
  return remap$(v, {
4352
4350
  "sample_rate": "sampleRate",
@@ -4718,11 +4716,11 @@ export const CreateAgentRequestPlugins$inboundSchema: z.ZodType<
4718
4716
  z.ZodTypeDef,
4719
4717
  unknown
4720
4718
  > = z.union([
4721
- components.PIIRedactionPluginEn$inboundSchema,
4722
- components.PIIRedactionPluginNl$inboundSchema,
4723
- components.TraceScrubbingPlugin$inboundSchema,
4724
- components.PIIRedactionPluginAuto$inboundSchema,
4719
+ components.PIIRedactionPlugin$inboundSchema.and(
4720
+ z.object({ id: z.literal("pii_redaction") }),
4721
+ ),
4725
4722
  components.ResponseHealingPlugin$inboundSchema,
4723
+ components.TraceScrubbingPlugin$inboundSchema,
4726
4724
  ]);
4727
4725
 
4728
4726
  export function createAgentRequestPluginsFromJSON(
@@ -4941,11 +4939,11 @@ export const CreateAgentRequestParameters$inboundSchema: z.ZodType<
4941
4939
  ).optional(),
4942
4940
  plugins: z.array(
4943
4941
  z.union([
4944
- components.PIIRedactionPluginEn$inboundSchema,
4945
- components.PIIRedactionPluginNl$inboundSchema,
4946
- components.TraceScrubbingPlugin$inboundSchema,
4947
- components.PIIRedactionPluginAuto$inboundSchema,
4942
+ components.PIIRedactionPlugin$inboundSchema.and(
4943
+ z.object({ id: z.literal("pii_redaction") }),
4944
+ ),
4948
4945
  components.ResponseHealingPlugin$inboundSchema,
4946
+ components.TraceScrubbingPlugin$inboundSchema,
4949
4947
  ]),
4950
4948
  ).optional(),
4951
4949
  fallbacks: z.array(z.lazy(() => CreateAgentRequestFallbacks$inboundSchema))
@@ -5382,11 +5380,11 @@ export const CreateAgentRequestFallbackModelConfigurationPlugins$inboundSchema:
5382
5380
  z.ZodTypeDef,
5383
5381
  unknown
5384
5382
  > = z.union([
5385
- components.PIIRedactionPluginEn$inboundSchema,
5386
- components.PIIRedactionPluginNl$inboundSchema,
5387
- components.TraceScrubbingPlugin$inboundSchema,
5388
- components.PIIRedactionPluginAuto$inboundSchema,
5383
+ components.PIIRedactionPlugin$inboundSchema.and(
5384
+ z.object({ id: z.literal("pii_redaction") }),
5385
+ ),
5389
5386
  components.ResponseHealingPlugin$inboundSchema,
5387
+ components.TraceScrubbingPlugin$inboundSchema,
5390
5388
  ]);
5391
5389
 
5392
5390
  export function createAgentRequestFallbackModelConfigurationPluginsFromJSON(
@@ -5669,11 +5667,11 @@ export const CreateAgentRequestFallbackModelConfigurationParameters$inboundSchem
5669
5667
  ).optional(),
5670
5668
  plugins: z.array(
5671
5669
  z.union([
5672
- components.PIIRedactionPluginEn$inboundSchema,
5673
- components.PIIRedactionPluginNl$inboundSchema,
5674
- components.TraceScrubbingPlugin$inboundSchema,
5675
- components.PIIRedactionPluginAuto$inboundSchema,
5670
+ components.PIIRedactionPlugin$inboundSchema.and(
5671
+ z.object({ id: z.literal("pii_redaction") }),
5672
+ ),
5676
5673
  components.ResponseHealingPlugin$inboundSchema,
5674
+ components.TraceScrubbingPlugin$inboundSchema,
5677
5675
  ]),
5678
5676
  ).optional(),
5679
5677
  fallbacks: z.array(
@@ -681,11 +681,9 @@ export type CreateChatCompletionGuardrails = {
681
681
  };
682
682
 
683
683
  export type CreateChatCompletionPlugins =
684
- | components.PIIRedactionPluginEn
685
- | components.PIIRedactionPluginNl
686
- | components.TraceScrubbingPlugin
687
- | components.PIIRedactionPluginAuto
688
- | components.ResponseHealingPlugin;
684
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
685
+ | components.ResponseHealingPlugin
686
+ | components.TraceScrubbingPlugin;
689
687
 
690
688
  export type CreateChatCompletionFallbacks = {
691
689
  /**
@@ -1580,11 +1578,9 @@ export type CreateChatCompletionRequestBody = {
1580
1578
  */
1581
1579
  plugins?:
1582
1580
  | Array<
1583
- | components.PIIRedactionPluginEn
1584
- | components.PIIRedactionPluginNl
1585
- | components.TraceScrubbingPlugin
1586
- | components.PIIRedactionPluginAuto
1581
+ | (components.PIIRedactionPlugin & { id: "pii_redaction" })
1587
1582
  | components.ResponseHealingPlugin
1583
+ | components.TraceScrubbingPlugin
1588
1584
  >
1589
1585
  | undefined;
1590
1586
  /**
@@ -3409,11 +3405,9 @@ export function createChatCompletionGuardrailsToJSON(
3409
3405
 
3410
3406
  /** @internal */
3411
3407
  export type CreateChatCompletionPlugins$Outbound =
3412
- | components.PIIRedactionPluginEn$Outbound
3413
- | components.PIIRedactionPluginNl$Outbound
3414
- | components.TraceScrubbingPlugin$Outbound
3415
- | components.PIIRedactionPluginAuto$Outbound
3416
- | components.ResponseHealingPlugin$Outbound;
3408
+ | (components.PIIRedactionPlugin$Outbound & { id: "pii_redaction" })
3409
+ | components.ResponseHealingPlugin$Outbound
3410
+ | components.TraceScrubbingPlugin$Outbound;
3417
3411
 
3418
3412
  /** @internal */
3419
3413
  export const CreateChatCompletionPlugins$outboundSchema: z.ZodType<
@@ -3421,11 +3415,11 @@ export const CreateChatCompletionPlugins$outboundSchema: z.ZodType<
3421
3415
  z.ZodTypeDef,
3422
3416
  CreateChatCompletionPlugins
3423
3417
  > = z.union([
3424
- components.PIIRedactionPluginEn$outboundSchema,
3425
- components.PIIRedactionPluginNl$outboundSchema,
3426
- components.TraceScrubbingPlugin$outboundSchema,
3427
- components.PIIRedactionPluginAuto$outboundSchema,
3418
+ components.PIIRedactionPlugin$outboundSchema.and(
3419
+ z.object({ id: z.literal("pii_redaction") }),
3420
+ ),
3428
3421
  components.ResponseHealingPlugin$outboundSchema,
3422
+ components.TraceScrubbingPlugin$outboundSchema,
3429
3423
  ]);
3430
3424
 
3431
3425
  export function createChatCompletionPluginsToJSON(
@@ -5290,11 +5284,9 @@ export type CreateChatCompletionRequestBody$Outbound = {
5290
5284
  guardrails?: Array<CreateChatCompletionGuardrails$Outbound> | undefined;
5291
5285
  plugins?:
5292
5286
  | Array<
5293
- | components.PIIRedactionPluginEn$Outbound
5294
- | components.PIIRedactionPluginNl$Outbound
5295
- | components.TraceScrubbingPlugin$Outbound
5296
- | components.PIIRedactionPluginAuto$Outbound
5287
+ | (components.PIIRedactionPlugin$Outbound & { id: "pii_redaction" })
5297
5288
  | components.ResponseHealingPlugin$Outbound
5289
+ | components.TraceScrubbingPlugin$Outbound
5298
5290
  >
5299
5291
  | undefined;
5300
5292
  fallbacks?: Array<CreateChatCompletionFallbacks$Outbound> | undefined;
@@ -5373,11 +5365,11 @@ export const CreateChatCompletionRequestBody$outboundSchema: z.ZodType<
5373
5365
  ).optional(),
5374
5366
  plugins: z.array(
5375
5367
  z.union([
5376
- components.PIIRedactionPluginEn$outboundSchema,
5377
- components.PIIRedactionPluginNl$outboundSchema,
5378
- components.TraceScrubbingPlugin$outboundSchema,
5379
- components.PIIRedactionPluginAuto$outboundSchema,
5368
+ components.PIIRedactionPlugin$outboundSchema.and(
5369
+ z.object({ id: z.literal("pii_redaction") }),
5370
+ ),
5380
5371
  components.ResponseHealingPlugin$outboundSchema,
5372
+ components.TraceScrubbingPlugin$outboundSchema,
5381
5373
  ]),
5382
5374
  ).optional(),
5383
5375
  fallbacks: z.array(z.lazy(() => CreateChatCompletionFallbacks$outboundSchema))