@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
@@ -0,0 +1,96 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+ import { EntityList, EntityList$inboundSchema } from "./entitylist.js";
11
+
12
+ export type CapabilitiesResponse = {
13
+ /**
14
+ * Supported detector languages, e.g. "en", "nl". There is no "auto" value.
15
+ */
16
+ languages?: Array<string> | undefined;
17
+ /**
18
+ * Universal entity types available regardless of region, e.g. PASSPORT,
19
+ *
20
+ * @remarks
21
+ * LICENSE_PLATE, UUID, JWT, BIC.
22
+ */
23
+ baseEntities?: Array<string> | undefined;
24
+ /**
25
+ * Every entity type the service can detect across all regions and the
26
+ *
27
+ * @remarks
28
+ * base catalog.
29
+ */
30
+ allEntities?: Array<string> | undefined;
31
+ /**
32
+ * Region codes the service recognizes, e.g. "nl", "gb", "all".
33
+ */
34
+ regions?: Array<string> | undefined;
35
+ /**
36
+ * Maps each region code to the entity types it gates. Use this to find the
37
+ *
38
+ * @remarks
39
+ * type to name in `entities` when you need a per-entity threshold on a type
40
+ * a region gates.
41
+ */
42
+ regionEntities?: { [k: string]: EntityList } | undefined;
43
+ /**
44
+ * Sparse per-entity default thresholds; entities absent here fall back to
45
+ *
46
+ * @remarks
47
+ * default_threshold.
48
+ */
49
+ entityThresholds?: { [k: string]: number } | undefined;
50
+ /**
51
+ * Confidence cutoff applied when neither `threshold` nor an entity-specific
52
+ *
53
+ * @remarks
54
+ * override is supplied.
55
+ */
56
+ defaultThreshold?: number | undefined;
57
+ /**
58
+ * Maximum number of characters accepted per request.
59
+ */
60
+ maxTextChars?: number | undefined;
61
+ };
62
+
63
+ /** @internal */
64
+ export const CapabilitiesResponse$inboundSchema: z.ZodType<
65
+ CapabilitiesResponse,
66
+ z.ZodTypeDef,
67
+ unknown
68
+ > = z.object({
69
+ languages: z.array(z.string()).optional(),
70
+ base_entities: z.array(z.string()).optional(),
71
+ all_entities: z.array(z.string()).optional(),
72
+ regions: z.array(z.string()).optional(),
73
+ region_entities: z.record(EntityList$inboundSchema).optional(),
74
+ entity_thresholds: z.record(z.number()).optional(),
75
+ default_threshold: z.number().optional(),
76
+ max_text_chars: z.number().int().optional(),
77
+ }).transform((v) => {
78
+ return remap$(v, {
79
+ "base_entities": "baseEntities",
80
+ "all_entities": "allEntities",
81
+ "region_entities": "regionEntities",
82
+ "entity_thresholds": "entityThresholds",
83
+ "default_threshold": "defaultThreshold",
84
+ "max_text_chars": "maxTextChars",
85
+ });
86
+ });
87
+
88
+ export function capabilitiesResponseFromJSON(
89
+ jsonString: string,
90
+ ): SafeParseResult<CapabilitiesResponse, SDKValidationError> {
91
+ return safeParse(
92
+ jsonString,
93
+ (x) => CapabilitiesResponse$inboundSchema.parse(JSON.parse(x)),
94
+ `Failed to parse 'CapabilitiesResponse' from JSON`,
95
+ );
96
+ }
@@ -25,6 +25,47 @@ export type DetectRequest = {
25
25
  * When true, the response includes a per-type entity breakdown.
26
26
  */
27
27
  includeEntities?: boolean | undefined;
28
+ /**
29
+ * Region codes selecting whole regions of coverage, e.g. "nl", "gb". Every
30
+ *
31
+ * @remarks
32
+ * entity type those regions cover is included, alongside the base catalog.
33
+ * ["all"] is exclusive. Leaving this and `entities` both empty also runs every
34
+ * region, so selecting nothing is the widest request rather than the narrowest.
35
+ * Empty alongside a non-empty `entities` stays strict. See the capabilities
36
+ * endpoint for the region list.
37
+ *
38
+ * Combines with `entities`: the detector unions the two selections, so a
39
+ * request carrying both covers the regions plus the named types. Note that
40
+ * `entities` only narrows coverage when it travels alone.
41
+ */
42
+ regions?: Array<string> | undefined;
43
+ /**
44
+ * The entity types to cover. A named type fires even when it belongs to a
45
+ *
46
+ * @remarks
47
+ * region, so a region's types can be selected individually without naming
48
+ * the region. Alone this is a strict allowlist; alongside `regions` it adds
49
+ * to the region coverage instead of narrowing it.
50
+ */
51
+ entities?: Array<string> | undefined;
52
+ /**
53
+ * Per-entity confidence cutoff overrides. An override REPLACES the global
54
+ *
55
+ * @remarks
56
+ * `threshold` for that type and may sit above or below it: the gateway
57
+ * lowers the first-pass floor it sends the detector to the smallest value
58
+ * in the map, and every selected type carries its own cutoff, so a
59
+ * sub-global override detects MORE of that type without widening the rest.
60
+ *
61
+ * This only tunes confidence; it never changes which types are covered.
62
+ * Coverage is decided by `entities` alone, so every key here must also
63
+ * appear in `entities` — a key that does not is rejected, as is any key at
64
+ * all when `entities` is empty.
65
+ *
66
+ * Declarative [0,1] bound mirrors existing constraint on `threshold`.
67
+ */
68
+ entityThresholds?: { [k: string]: number } | undefined;
28
69
  };
29
70
 
30
71
  /** @internal */
@@ -33,6 +74,9 @@ export type DetectRequest$Outbound = {
33
74
  language?: string | undefined;
34
75
  threshold?: number | undefined;
35
76
  include_entities?: boolean | undefined;
77
+ regions?: Array<string> | undefined;
78
+ entities?: Array<string> | undefined;
79
+ entity_thresholds?: { [k: string]: number } | undefined;
36
80
  };
37
81
 
38
82
  /** @internal */
@@ -45,9 +89,13 @@ export const DetectRequest$outboundSchema: z.ZodType<
45
89
  language: z.string().optional(),
46
90
  threshold: z.number().optional(),
47
91
  includeEntities: z.boolean().optional(),
92
+ regions: z.array(z.string()).optional(),
93
+ entities: z.array(z.string()).optional(),
94
+ entityThresholds: z.record(z.number()).optional(),
48
95
  }).transform((v) => {
49
96
  return remap$(v, {
50
97
  includeEntities: "include_entities",
98
+ entityThresholds: "entity_thresholds",
51
99
  });
52
100
  });
53
101
 
@@ -0,0 +1,37 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ /**
11
+ * EntityList wraps a repeated string because proto3 maps cannot hold
12
+ *
13
+ * @remarks
14
+ * repeated values directly.
15
+ */
16
+ export type EntityList = {
17
+ entities?: Array<string> | undefined;
18
+ };
19
+
20
+ /** @internal */
21
+ export const EntityList$inboundSchema: z.ZodType<
22
+ EntityList,
23
+ z.ZodTypeDef,
24
+ unknown
25
+ > = z.object({
26
+ entities: z.array(z.string()).optional(),
27
+ });
28
+
29
+ export function entityListFromJSON(
30
+ jsonString: string,
31
+ ): SafeParseResult<EntityList, SDKValidationError> {
32
+ return safeParse(
33
+ jsonString,
34
+ (x) => EntityList$inboundSchema.parse(JSON.parse(x)),
35
+ `Failed to parse 'EntityList' from JSON`,
36
+ );
37
+ }
@@ -13,10 +13,29 @@ export type GuardrailRulePlugin = {
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;
31
+ /**
32
+ * Regions of coverage by ISO 3166-1 alpha-2 code, or ["all"]. Mutually exclusive with entities.
33
+ */
34
+ regions?: Array<string> | undefined;
35
+ /**
36
+ * Per-entity-type confidence cutoff. Every key must also appear in entities.
37
+ */
38
+ entityThresholds?: { [k: string]: number } | undefined;
20
39
  };
21
40
 
22
41
  /** @internal */
@@ -30,9 +49,12 @@ export const GuardrailRulePlugin$inboundSchema: z.ZodType<
30
49
  entities: z.array(z.string()).optional(),
31
50
  on_failure: z.string().optional(),
32
51
  threshold: z.number().optional(),
52
+ regions: z.array(z.string()).optional(),
53
+ entity_thresholds: z.record(z.number()).optional(),
33
54
  }).transform((v) => {
34
55
  return remap$(v, {
35
56
  "on_failure": "onFailure",
57
+ "entity_thresholds": "entityThresholds",
36
58
  });
37
59
  });
38
60
  /** @internal */
@@ -42,6 +64,8 @@ export type GuardrailRulePlugin$Outbound = {
42
64
  entities?: Array<string> | undefined;
43
65
  on_failure?: string | undefined;
44
66
  threshold?: number | undefined;
67
+ regions?: Array<string> | undefined;
68
+ entity_thresholds?: { [k: string]: number } | undefined;
45
69
  };
46
70
 
47
71
  /** @internal */
@@ -55,9 +79,12 @@ export const GuardrailRulePlugin$outboundSchema: z.ZodType<
55
79
  entities: z.array(z.string()).optional(),
56
80
  onFailure: z.string().optional(),
57
81
  threshold: z.number().optional(),
82
+ regions: z.array(z.string()).optional(),
83
+ entityThresholds: z.record(z.number()).optional(),
58
84
  }).transform((v) => {
59
85
  return remap$(v, {
60
86
  onFailure: "on_failure",
87
+ entityThresholds: "entity_thresholds",
61
88
  });
62
89
  });
63
90
 
@@ -73,6 +73,7 @@ export * from "./budgetsortfield.js";
73
73
  export * from "./budgetusage.js";
74
74
  export * from "./cacheconfig.js";
75
75
  export * from "./callsubagenttoolinput.js";
76
+ export * from "./capabilitiesresponse.js";
76
77
  export * from "./chunk.js";
77
78
  export * from "./chunkingcleanupoptions.js";
78
79
  export * from "./chunkingconfiguration.js";
@@ -177,6 +178,7 @@ export * from "./embeddingretryconfig.js";
177
178
  export * from "./embeddingsconfig.js";
178
179
  export * from "./embeddingsmodelparameters.js";
179
180
  export * from "./embeddingtimeoutconfig.js";
181
+ export * from "./entitylist.js";
180
182
  export * from "./errorpart.js";
181
183
  export * from "./errorstreamingevent.js";
182
184
  export * from "./evaluationcontext.js";
@@ -372,9 +374,7 @@ export * from "./partdoneevent.js";
372
374
  export * from "./permissionmode.js";
373
375
  export * from "./piiredaction.js";
374
376
  export * from "./piiredactionconfig.js";
375
- export * from "./piiredactionpluginauto.js";
376
- export * from "./piiredactionpluginen.js";
377
- export * from "./piiredactionpluginnl.js";
377
+ export * from "./piiredactionplugin.js";
378
378
  export * from "./policy.js";
379
379
  export * from "./policyretryconfig.js";
380
380
  export * from "./previewchunk.js";
@@ -0,0 +1,143 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ /**
13
+ * PII redaction plugin.
14
+ */
15
+ export const Id = {
16
+ PiiRedaction: "pii_redaction",
17
+ } as const;
18
+ /**
19
+ * PII redaction plugin.
20
+ */
21
+ export type Id = ClosedEnum<typeof Id>;
22
+
23
+ /**
24
+ * Behaviour when detection fails.
25
+ */
26
+ export const OnFailure = {
27
+ Block: "block",
28
+ Passthrough: "passthrough",
29
+ } as const;
30
+ /**
31
+ * Behaviour when detection fails.
32
+ */
33
+ export type OnFailure = ClosedEnum<typeof OnFailure>;
34
+
35
+ export type PIIRedactionPlugin = {
36
+ /**
37
+ * PII redaction plugin.
38
+ */
39
+ id: Id;
40
+ /**
41
+ * Detector language. Use "auto" to auto-detect; omitting the field falls back to en.
42
+ */
43
+ language?: string | undefined;
44
+ /**
45
+ * 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.
46
+ */
47
+ regions?: Array<string> | undefined;
48
+ /**
49
+ * 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.
50
+ */
51
+ entities?: Array<string> | undefined;
52
+ /**
53
+ * 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.
54
+ */
55
+ entityThresholds?: { [k: string]: number } | undefined;
56
+ /**
57
+ * Baseline confidence cutoff applied to every entity type without a per-entity override.
58
+ */
59
+ threshold?: number | undefined;
60
+ /**
61
+ * Behaviour when detection fails.
62
+ */
63
+ onFailure?: OnFailure | undefined;
64
+ };
65
+
66
+ /** @internal */
67
+ export const Id$inboundSchema: z.ZodNativeEnum<typeof Id> = z.nativeEnum(Id);
68
+ /** @internal */
69
+ export const Id$outboundSchema: z.ZodNativeEnum<typeof Id> = Id$inboundSchema;
70
+
71
+ /** @internal */
72
+ export const OnFailure$inboundSchema: z.ZodNativeEnum<typeof OnFailure> = z
73
+ .nativeEnum(OnFailure);
74
+ /** @internal */
75
+ export const OnFailure$outboundSchema: z.ZodNativeEnum<typeof OnFailure> =
76
+ OnFailure$inboundSchema;
77
+
78
+ /** @internal */
79
+ export const PIIRedactionPlugin$inboundSchema: z.ZodType<
80
+ PIIRedactionPlugin,
81
+ z.ZodTypeDef,
82
+ unknown
83
+ > = z.object({
84
+ id: Id$inboundSchema,
85
+ language: z.string().optional(),
86
+ regions: z.array(z.string()).optional(),
87
+ entities: z.array(z.string()).optional(),
88
+ entity_thresholds: z.record(z.number()).optional(),
89
+ threshold: z.number().optional(),
90
+ on_failure: OnFailure$inboundSchema.optional(),
91
+ }).transform((v) => {
92
+ return remap$(v, {
93
+ "entity_thresholds": "entityThresholds",
94
+ "on_failure": "onFailure",
95
+ });
96
+ });
97
+ /** @internal */
98
+ export type PIIRedactionPlugin$Outbound = {
99
+ id: string;
100
+ language?: string | undefined;
101
+ regions?: Array<string> | undefined;
102
+ entities?: Array<string> | undefined;
103
+ entity_thresholds?: { [k: string]: number } | undefined;
104
+ threshold?: number | undefined;
105
+ on_failure?: string | undefined;
106
+ };
107
+
108
+ /** @internal */
109
+ export const PIIRedactionPlugin$outboundSchema: z.ZodType<
110
+ PIIRedactionPlugin$Outbound,
111
+ z.ZodTypeDef,
112
+ PIIRedactionPlugin
113
+ > = z.object({
114
+ id: Id$outboundSchema,
115
+ language: z.string().optional(),
116
+ regions: z.array(z.string()).optional(),
117
+ entities: z.array(z.string()).optional(),
118
+ entityThresholds: z.record(z.number()).optional(),
119
+ threshold: z.number().optional(),
120
+ onFailure: OnFailure$outboundSchema.optional(),
121
+ }).transform((v) => {
122
+ return remap$(v, {
123
+ entityThresholds: "entity_thresholds",
124
+ onFailure: "on_failure",
125
+ });
126
+ });
127
+
128
+ export function piiRedactionPluginToJSON(
129
+ piiRedactionPlugin: PIIRedactionPlugin,
130
+ ): string {
131
+ return JSON.stringify(
132
+ PIIRedactionPlugin$outboundSchema.parse(piiRedactionPlugin),
133
+ );
134
+ }
135
+ export function piiRedactionPluginFromJSON(
136
+ jsonString: string,
137
+ ): SafeParseResult<PIIRedactionPlugin, SDKValidationError> {
138
+ return safeParse(
139
+ jsonString,
140
+ (x) => PIIRedactionPlugin$inboundSchema.parse(JSON.parse(x)),
141
+ `Failed to parse 'PIIRedactionPlugin' from JSON`,
142
+ );
143
+ }
@@ -19,18 +19,6 @@ export const PublicPluginId = {
19
19
  */
20
20
  export type PublicPluginId = ClosedEnum<typeof PublicPluginId>;
21
21
 
22
- /**
23
- * pii_redaction only. Detector language. Defaults to en.
24
- */
25
- export const PublicPluginLanguage = {
26
- En: "en",
27
- Nl: "nl",
28
- } as const;
29
- /**
30
- * pii_redaction only. Detector language. Defaults to en.
31
- */
32
- export type PublicPluginLanguage = ClosedEnum<typeof PublicPluginLanguage>;
33
-
34
22
  export const PublicPluginMask = {
35
23
  All: "all",
36
24
  System: "system",
@@ -55,17 +43,21 @@ export type PublicPluginOnFailure = ClosedEnum<typeof PublicPluginOnFailure>;
55
43
 
56
44
  export type PublicPlugin = {
57
45
  /**
58
- * pii_redaction only. Entity types to redact (e.g. EMAIL_ADDRESS, BSN). Omit to redact every type detected for the language.
46
+ * pii_redaction only. Entity types to redact (e.g. EMAIL_ADDRESS, BSN). Omit to redact every type detected for the language and regions. Cannot be combined with regions.
59
47
  */
60
48
  entities?: Array<string> | null | undefined;
49
+ /**
50
+ * pii_redaction only. Per-entity confidence cutoff overrides in [0,1], keyed by entity type. An override replaces threshold for that type and may sit above or below it. Every key must also appear in entities.
51
+ */
52
+ entityThresholds?: { [k: string]: number } | undefined;
61
53
  /**
62
54
  * Plugin discriminator. pii_redaction redacts PII, response_healing repairs malformed JSON, and trace_scrubbing removes selected sensitive fields from exported traces.
63
55
  */
64
56
  id: PublicPluginId;
65
57
  /**
66
- * pii_redaction only. Detector language. Defaults to en.
58
+ * pii_redaction only. Detector language, or "auto" to detect it per request. Defaults to en. The accepted values are whatever GET /v2/pii/capabilities lists, so they are not enumerated here: a fixed enum would reject a language the detector has since added.
67
59
  */
68
- language?: PublicPluginLanguage | undefined;
60
+ language?: string | undefined;
69
61
  /**
70
62
  * trace_scrubbing only. Trace surfaces to scrub. At least one value required.
71
63
  */
@@ -74,6 +66,10 @@ export type PublicPlugin = {
74
66
  * pii_redaction only. Behavior when redaction is unavailable. block (default) fails the request; passthrough sends the original text.
75
67
  */
76
68
  onFailure?: PublicPluginOnFailure | undefined;
69
+ /**
70
+ * pii_redaction only. Region codes gating regional recognizers (e.g. nl, gb). ["all"] is exclusive. Omit for base entities only. Cannot be combined with entities.
71
+ */
72
+ regions?: Array<string> | null | undefined;
77
73
  /**
78
74
  * pii_redaction only. Detector confidence cutoff in [0,1].
79
75
  */
@@ -85,11 +81,6 @@ export const PublicPluginId$outboundSchema: z.ZodNativeEnum<
85
81
  typeof PublicPluginId
86
82
  > = z.nativeEnum(PublicPluginId);
87
83
 
88
- /** @internal */
89
- export const PublicPluginLanguage$outboundSchema: z.ZodNativeEnum<
90
- typeof PublicPluginLanguage
91
- > = z.nativeEnum(PublicPluginLanguage);
92
-
93
84
  /** @internal */
94
85
  export const PublicPluginMask$outboundSchema: z.ZodNativeEnum<
95
86
  typeof PublicPluginMask
@@ -103,10 +94,12 @@ export const PublicPluginOnFailure$outboundSchema: z.ZodNativeEnum<
103
94
  /** @internal */
104
95
  export type PublicPlugin$Outbound = {
105
96
  entities?: Array<string> | null | undefined;
97
+ entity_thresholds?: { [k: string]: number } | undefined;
106
98
  id: string;
107
99
  language?: string | undefined;
108
100
  mask?: Array<string> | null | undefined;
109
101
  on_failure?: string | undefined;
102
+ regions?: Array<string> | null | undefined;
110
103
  threshold?: number | undefined;
111
104
  };
112
105
 
@@ -117,13 +110,16 @@ export const PublicPlugin$outboundSchema: z.ZodType<
117
110
  PublicPlugin
118
111
  > = z.object({
119
112
  entities: z.nullable(z.array(z.string())).optional(),
113
+ entityThresholds: z.record(z.number()).optional(),
120
114
  id: PublicPluginId$outboundSchema,
121
- language: PublicPluginLanguage$outboundSchema.optional(),
115
+ language: z.string().optional(),
122
116
  mask: z.nullable(z.array(PublicPluginMask$outboundSchema)).optional(),
123
117
  onFailure: PublicPluginOnFailure$outboundSchema.optional(),
118
+ regions: z.nullable(z.array(z.string())).optional(),
124
119
  threshold: z.number().optional(),
125
120
  }).transform((v) => {
126
121
  return remap$(v, {
122
+ entityThresholds: "entity_thresholds",
127
123
  onFailure: "on_failure",
128
124
  });
129
125
  });
@@ -40,7 +40,7 @@ export const ReasoningPart$inboundSchema: z.ZodType<
40
40
  z.ZodTypeDef,
41
41
  unknown
42
42
  > = z.object({
43
- _id: z.string().default("reasoning_01m1nq4pk1kaabayp8270qmekq"),
43
+ _id: z.string().default("reasoning_01m1ny970yxt51fwq3537kvmda"),
44
44
  metadata: z.record(z.any()).optional(),
45
45
  kind: z.literal("reasoning"),
46
46
  reasoning: z.string(),
@@ -3,11 +3,53 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
6
7
 
7
8
  export type RedactRequest = {
8
9
  text?: string | undefined;
9
10
  language?: string | undefined;
10
11
  threshold?: number | undefined;
12
+ /**
13
+ * Region codes selecting whole regions of coverage, e.g. "nl", "gb". Every
14
+ *
15
+ * @remarks
16
+ * entity type those regions cover is included, alongside the base catalog.
17
+ * ["all"] is exclusive. Leaving this and `entities` both empty also runs every
18
+ * region, so selecting nothing is the widest request rather than the narrowest.
19
+ * Empty alongside a non-empty `entities` stays strict. See the capabilities
20
+ * endpoint for the region list.
21
+ *
22
+ * Combines with `entities`: the detector unions the two selections, so a
23
+ * request carrying both covers the regions plus the named types. Note that
24
+ * `entities` only narrows coverage when it travels alone.
25
+ */
26
+ regions?: Array<string> | undefined;
27
+ /**
28
+ * The entity types to cover. A named type fires even when it belongs to a
29
+ *
30
+ * @remarks
31
+ * region, so a region's types can be selected individually without naming
32
+ * the region. Alone this is a strict allowlist; alongside `regions` it adds
33
+ * to the region coverage instead of narrowing it.
34
+ */
35
+ entities?: Array<string> | undefined;
36
+ /**
37
+ * Per-entity confidence cutoff overrides. An override REPLACES the global
38
+ *
39
+ * @remarks
40
+ * `threshold` for that type and may sit above or below it: the gateway
41
+ * lowers the first-pass floor it sends the detector to the smallest value
42
+ * in the map, and every selected type carries its own cutoff, so a
43
+ * sub-global override detects MORE of that type without widening the rest.
44
+ *
45
+ * This only tunes confidence; it never changes which types are covered.
46
+ * Coverage is decided by `entities` alone, so every key here must also
47
+ * appear in `entities` — a key that does not is rejected, as is any key at
48
+ * all when `entities` is empty.
49
+ *
50
+ * Declarative [0,1] bound mirrors existing constraint on `threshold`.
51
+ */
52
+ entityThresholds?: { [k: string]: number } | undefined;
11
53
  };
12
54
 
13
55
  /** @internal */
@@ -15,6 +57,9 @@ export type RedactRequest$Outbound = {
15
57
  text?: string | undefined;
16
58
  language?: string | undefined;
17
59
  threshold?: number | undefined;
60
+ regions?: Array<string> | undefined;
61
+ entities?: Array<string> | undefined;
62
+ entity_thresholds?: { [k: string]: number } | undefined;
18
63
  };
19
64
 
20
65
  /** @internal */
@@ -26,6 +71,13 @@ export const RedactRequest$outboundSchema: z.ZodType<
26
71
  text: z.string().optional(),
27
72
  language: z.string().optional(),
28
73
  threshold: z.number().optional(),
74
+ regions: z.array(z.string()).optional(),
75
+ entities: z.array(z.string()).optional(),
76
+ entityThresholds: z.record(z.number()).optional(),
77
+ }).transform((v) => {
78
+ return remap$(v, {
79
+ entityThresholds: "entity_thresholds",
80
+ });
29
81
  });
30
82
 
31
83
  export function redactRequestToJSON(redactRequest: RedactRequest): string {
@@ -4,50 +4,27 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import { safeParse } from "../../lib/schemas.js";
7
- import { ClosedEnum } from "../../types/enums.js";
8
7
  import { Result as SafeParseResult } from "../../types/fp.js";
9
8
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
9
 
11
- /**
12
- * Plugin discriminator. Must be `response_healing`.
13
- */
14
- export const ResponseHealingPluginId = {
15
- ResponseHealing: "response_healing",
16
- } as const;
17
- /**
18
- * Plugin discriminator. Must be `response_healing`.
19
- */
20
- export type ResponseHealingPluginId = ClosedEnum<
21
- typeof ResponseHealingPluginId
22
- >;
23
-
24
10
  export type ResponseHealingPlugin = {
25
11
  /**
26
12
  * Plugin discriminator. Must be `response_healing`.
27
13
  */
28
- id: ResponseHealingPluginId;
14
+ id: "response_healing";
29
15
  };
30
16
 
31
- /** @internal */
32
- export const ResponseHealingPluginId$inboundSchema: z.ZodNativeEnum<
33
- typeof ResponseHealingPluginId
34
- > = z.nativeEnum(ResponseHealingPluginId);
35
- /** @internal */
36
- export const ResponseHealingPluginId$outboundSchema: z.ZodNativeEnum<
37
- typeof ResponseHealingPluginId
38
- > = ResponseHealingPluginId$inboundSchema;
39
-
40
17
  /** @internal */
41
18
  export const ResponseHealingPlugin$inboundSchema: z.ZodType<
42
19
  ResponseHealingPlugin,
43
20
  z.ZodTypeDef,
44
21
  unknown
45
22
  > = z.object({
46
- id: ResponseHealingPluginId$inboundSchema,
23
+ id: z.literal("response_healing"),
47
24
  });
48
25
  /** @internal */
49
26
  export type ResponseHealingPlugin$Outbound = {
50
- id: string;
27
+ id: "response_healing";
51
28
  };
52
29
 
53
30
  /** @internal */
@@ -56,7 +33,7 @@ export const ResponseHealingPlugin$outboundSchema: z.ZodType<
56
33
  z.ZodTypeDef,
57
34
  ResponseHealingPlugin
58
35
  > = z.object({
59
- id: ResponseHealingPluginId$outboundSchema,
36
+ id: z.literal("response_healing"),
60
37
  });
61
38
 
62
39
  export function responseHealingPluginToJSON(