@getzep/zep-cloud 3.17.0 → 3.18.0

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 (56) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/graph/client/Client.d.ts +6 -0
  3. package/dist/cjs/api/resources/graph/client/Client.js +38 -0
  4. package/dist/cjs/api/resources/graph/client/requests/DetectPatternsRequest.d.ts +12 -4
  5. package/dist/cjs/api/resources/user/client/Client.d.ts +3 -0
  6. package/dist/cjs/api/resources/user/client/Client.js +27 -0
  7. package/dist/cjs/api/types/DateFilter.d.ts +1 -1
  8. package/dist/cjs/api/types/DetectPatternsResponse.d.ts +2 -0
  9. package/dist/cjs/api/types/PatternResult.d.ts +5 -2
  10. package/dist/cjs/api/types/PropertyFilter.d.ts +1 -1
  11. package/dist/cjs/api/types/SearchFilters.d.ts +8 -8
  12. package/dist/cjs/api/types/index.d.ts +0 -1
  13. package/dist/cjs/api/types/index.js +0 -1
  14. package/dist/cjs/serialization/resources/graph/client/requests/DetectPatternsRequest.d.ts +3 -1
  15. package/dist/cjs/serialization/resources/graph/client/requests/DetectPatternsRequest.js +3 -1
  16. package/dist/cjs/serialization/types/DetectPatternsResponse.d.ts +2 -0
  17. package/dist/cjs/serialization/types/DetectPatternsResponse.js +2 -0
  18. package/dist/cjs/serialization/types/PatternResult.d.ts +2 -2
  19. package/dist/cjs/serialization/types/PatternResult.js +2 -2
  20. package/dist/cjs/serialization/types/index.d.ts +0 -1
  21. package/dist/cjs/serialization/types/index.js +0 -1
  22. package/dist/cjs/version.d.ts +1 -1
  23. package/dist/cjs/version.js +1 -1
  24. package/dist/esm/Client.mjs +2 -2
  25. package/dist/esm/api/resources/graph/client/Client.d.mts +6 -0
  26. package/dist/esm/api/resources/graph/client/Client.mjs +38 -0
  27. package/dist/esm/api/resources/graph/client/requests/DetectPatternsRequest.d.mts +12 -4
  28. package/dist/esm/api/resources/user/client/Client.d.mts +3 -0
  29. package/dist/esm/api/resources/user/client/Client.mjs +27 -0
  30. package/dist/esm/api/types/DateFilter.d.mts +1 -1
  31. package/dist/esm/api/types/DetectPatternsResponse.d.mts +2 -0
  32. package/dist/esm/api/types/PatternResult.d.mts +5 -2
  33. package/dist/esm/api/types/PropertyFilter.d.mts +1 -1
  34. package/dist/esm/api/types/SearchFilters.d.mts +8 -8
  35. package/dist/esm/api/types/index.d.mts +0 -1
  36. package/dist/esm/api/types/index.mjs +0 -1
  37. package/dist/esm/serialization/resources/graph/client/requests/DetectPatternsRequest.d.mts +3 -1
  38. package/dist/esm/serialization/resources/graph/client/requests/DetectPatternsRequest.mjs +3 -1
  39. package/dist/esm/serialization/types/DetectPatternsResponse.d.mts +2 -0
  40. package/dist/esm/serialization/types/DetectPatternsResponse.mjs +2 -0
  41. package/dist/esm/serialization/types/PatternResult.d.mts +2 -2
  42. package/dist/esm/serialization/types/PatternResult.mjs +2 -2
  43. package/dist/esm/serialization/types/index.d.mts +0 -1
  44. package/dist/esm/serialization/types/index.mjs +0 -1
  45. package/dist/esm/version.d.mts +1 -1
  46. package/dist/esm/version.mjs +1 -1
  47. package/package.json +1 -1
  48. package/reference.md +2 -0
  49. package/dist/cjs/api/types/PatternExample.d.ts +0 -9
  50. package/dist/cjs/api/types/PatternExample.js +0 -5
  51. package/dist/cjs/serialization/types/PatternExample.d.ts +0 -13
  52. package/dist/cjs/serialization/types/PatternExample.js +0 -44
  53. package/dist/esm/api/types/PatternExample.d.mts +0 -9
  54. package/dist/esm/api/types/PatternExample.mjs +0 -4
  55. package/dist/esm/serialization/types/PatternExample.d.mts +0 -13
  56. package/dist/esm/serialization/types/PatternExample.mjs +0 -8
@@ -50,8 +50,8 @@ class ZepClient {
50
50
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
51
51
  "X-Fern-Language": "JavaScript",
52
52
  "X-Fern-SDK-Name": "zep-cloud",
53
- "X-Fern-SDK-Version": "3.17.0",
54
- "User-Agent": "zep-cloud/3.17.0",
53
+ "X-Fern-SDK-Version": "3.18.0",
54
+ "User-Agent": "zep-cloud/3.18.0",
55
55
  "X-Fern-Runtime": core.RUNTIME.type,
56
56
  "X-Fern-Runtime-Version": core.RUNTIME.version,
57
57
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -44,6 +44,7 @@ export declare class Graph {
44
44
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
45
45
  *
46
46
  * @throws {@link Zep.BadRequestError}
47
+ * @throws {@link Zep.NotFoundError}
47
48
  * @throws {@link Zep.InternalServerError}
48
49
  *
49
50
  * @example
@@ -61,6 +62,7 @@ export declare class Graph {
61
62
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
62
63
  *
63
64
  * @throws {@link Zep.BadRequestError}
65
+ * @throws {@link Zep.NotFoundError}
64
66
  * @throws {@link Zep.InternalServerError}
65
67
  *
66
68
  * @example
@@ -80,6 +82,7 @@ export declare class Graph {
80
82
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
81
83
  *
82
84
  * @throws {@link Zep.BadRequestError}
85
+ * @throws {@link Zep.NotFoundError}
83
86
  * @throws {@link Zep.InternalServerError}
84
87
  *
85
88
  * @example
@@ -112,6 +115,7 @@ export declare class Graph {
112
115
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
113
116
  *
114
117
  * @throws {@link Zep.BadRequestError}
118
+ * @throws {@link Zep.NotFoundError}
115
119
  * @throws {@link Zep.InternalServerError}
116
120
  *
117
121
  * @example
@@ -224,6 +228,8 @@ export declare class Graph {
224
228
  /**
225
229
  * Detects structural patterns in a knowledge graph including relationship frequencies,
226
230
  * multi-hop paths, co-occurrences, hubs, and clusters.
231
+ * When a query is provided, uses hybrid search to discover seed nodes,
232
+ * detects triple-frequency patterns, and returns resolved edges ranked by relevance.
227
233
  *
228
234
  * @param {Zep.DetectPatternsRequest} request
229
235
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
@@ -78,6 +78,7 @@ class Graph {
78
78
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
79
79
  *
80
80
  * @throws {@link Zep.BadRequestError}
81
+ * @throws {@link Zep.NotFoundError}
81
82
  * @throws {@link Zep.InternalServerError}
82
83
  *
83
84
  * @example
@@ -131,6 +132,14 @@ class Graph {
131
132
  skipValidation: true,
132
133
  breadcrumbsPrefix: ["response"],
133
134
  }), _response.rawResponse);
135
+ case 404:
136
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
137
+ unrecognizedObjectKeys: "passthrough",
138
+ allowUnrecognizedUnionMembers: true,
139
+ allowUnrecognizedEnumValues: true,
140
+ skipValidation: true,
141
+ breadcrumbsPrefix: ["response"],
142
+ }), _response.rawResponse);
134
143
  case 500:
135
144
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
136
145
  unrecognizedObjectKeys: "passthrough",
@@ -171,6 +180,7 @@ class Graph {
171
180
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
172
181
  *
173
182
  * @throws {@link Zep.BadRequestError}
183
+ * @throws {@link Zep.NotFoundError}
174
184
  * @throws {@link Zep.InternalServerError}
175
185
  *
176
186
  * @example
@@ -223,6 +233,14 @@ class Graph {
223
233
  skipValidation: true,
224
234
  breadcrumbsPrefix: ["response"],
225
235
  }), _response.rawResponse);
236
+ case 404:
237
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
238
+ unrecognizedObjectKeys: "passthrough",
239
+ allowUnrecognizedUnionMembers: true,
240
+ allowUnrecognizedEnumValues: true,
241
+ skipValidation: true,
242
+ breadcrumbsPrefix: ["response"],
243
+ }), _response.rawResponse);
226
244
  case 500:
227
245
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
228
246
  unrecognizedObjectKeys: "passthrough",
@@ -263,6 +281,7 @@ class Graph {
263
281
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
264
282
  *
265
283
  * @throws {@link Zep.BadRequestError}
284
+ * @throws {@link Zep.NotFoundError}
266
285
  * @throws {@link Zep.InternalServerError}
267
286
  *
268
287
  * @example
@@ -310,6 +329,14 @@ class Graph {
310
329
  skipValidation: true,
311
330
  breadcrumbsPrefix: ["response"],
312
331
  }), _response.rawResponse);
332
+ case 404:
333
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
334
+ unrecognizedObjectKeys: "passthrough",
335
+ allowUnrecognizedUnionMembers: true,
336
+ allowUnrecognizedEnumValues: true,
337
+ skipValidation: true,
338
+ breadcrumbsPrefix: ["response"],
339
+ }), _response.rawResponse);
313
340
  case 500:
314
341
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
315
342
  unrecognizedObjectKeys: "passthrough",
@@ -452,6 +479,7 @@ class Graph {
452
479
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
453
480
  *
454
481
  * @throws {@link Zep.BadRequestError}
482
+ * @throws {@link Zep.NotFoundError}
455
483
  * @throws {@link Zep.InternalServerError}
456
484
  *
457
485
  * @example
@@ -499,6 +527,14 @@ class Graph {
499
527
  skipValidation: true,
500
528
  breadcrumbsPrefix: ["response"],
501
529
  }), _response.rawResponse);
530
+ case 404:
531
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
532
+ unrecognizedObjectKeys: "passthrough",
533
+ allowUnrecognizedUnionMembers: true,
534
+ allowUnrecognizedEnumValues: true,
535
+ skipValidation: true,
536
+ breadcrumbsPrefix: ["response"],
537
+ }), _response.rawResponse);
502
538
  case 500:
503
539
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
504
540
  unrecognizedObjectKeys: "passthrough",
@@ -1084,6 +1120,8 @@ class Graph {
1084
1120
  /**
1085
1121
  * Detects structural patterns in a knowledge graph including relationship frequencies,
1086
1122
  * multi-hop paths, co-occurrences, hubs, and clusters.
1123
+ * When a query is provided, uses hybrid search to discover seed nodes,
1124
+ * detects triple-frequency patterns, and returns resolved edges ranked by relevance.
1087
1125
  *
1088
1126
  * @param {Zep.DetectPatternsRequest} request
1089
1127
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
@@ -9,17 +9,25 @@ import * as Zep from "../../../../index.js";
9
9
  export interface DetectPatternsRequest {
10
10
  /**
11
11
  * Which pattern types to detect with type-specific configuration.
12
- * Omit to detect all types with defaults.
12
+ * Omit to detect all types with defaults. Ignored when query is set.
13
13
  */
14
14
  detect?: Zep.DetectConfig;
15
+ /** Max resolved edges per pattern. Default: 10, Max: 100. Only used with query. */
16
+ edgeLimit?: number;
15
17
  /** Graph ID when detecting patterns on a named graph */
16
18
  graphId?: string;
17
- /** Include example node/edge UUIDs per pattern. Default: false */
18
- includeExamples?: boolean;
19
19
  /** Max patterns to return. Default: 50, Max: 200 */
20
20
  limit?: number;
21
21
  /** Minimum occurrence count to report a pattern. Default: 2 */
22
22
  minOccurrences?: number;
23
+ /**
24
+ * Search query for discovering seed nodes via hybrid search.
25
+ * When set, forces triple-frequency detection only and enables edge resolution
26
+ * with cross-encoder reranking. Mutually exclusive with seeds.
27
+ */
28
+ query?: string;
29
+ /** Max seed nodes from search. Default: 10, Max: 50. Only used with query. */
30
+ queryLimit?: number;
23
31
  /**
24
32
  * Exponential half-life decay applied to edge created_at timestamps.
25
33
  * Valid values: none, 7_days, 30_days, 90_days. Default: none
@@ -30,7 +38,7 @@ export interface DetectPatternsRequest {
30
38
  * Reuses the same filter format as /graph/search.
31
39
  */
32
40
  searchFilters?: Zep.SearchFilters;
33
- /** Seed selection. If omitted, analyzes the entire graph. */
41
+ /** Seed selection. If omitted, analyzes the entire graph. Mutually exclusive with query. */
34
42
  seeds?: Zep.PatternSeeds;
35
43
  /** User ID when detecting patterns on a user graph */
36
44
  userId?: string;
@@ -35,6 +35,7 @@ export declare class User {
35
35
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
36
36
  *
37
37
  * @throws {@link Zep.BadRequestError}
38
+ * @throws {@link Zep.NotFoundError}
38
39
  * @throws {@link Zep.InternalServerError}
39
40
  *
40
41
  * @example
@@ -51,6 +52,7 @@ export declare class User {
51
52
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
52
53
  *
53
54
  * @throws {@link Zep.BadRequestError}
55
+ * @throws {@link Zep.NotFoundError}
54
56
  * @throws {@link Zep.InternalServerError}
55
57
  *
56
58
  * @example
@@ -70,6 +72,7 @@ export declare class User {
70
72
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
71
73
  *
72
74
  * @throws {@link Zep.BadRequestError}
75
+ * @throws {@link Zep.NotFoundError}
73
76
  * @throws {@link Zep.InternalServerError}
74
77
  *
75
78
  * @example
@@ -63,6 +63,7 @@ class User {
63
63
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
64
64
  *
65
65
  * @throws {@link Zep.BadRequestError}
66
+ * @throws {@link Zep.NotFoundError}
66
67
  * @throws {@link Zep.InternalServerError}
67
68
  *
68
69
  * @example
@@ -112,6 +113,14 @@ class User {
112
113
  skipValidation: true,
113
114
  breadcrumbsPrefix: ["response"],
114
115
  }), _response.rawResponse);
116
+ case 404:
117
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
118
+ unrecognizedObjectKeys: "passthrough",
119
+ allowUnrecognizedUnionMembers: true,
120
+ allowUnrecognizedEnumValues: true,
121
+ skipValidation: true,
122
+ breadcrumbsPrefix: ["response"],
123
+ }), _response.rawResponse);
115
124
  case 500:
116
125
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
117
126
  unrecognizedObjectKeys: "passthrough",
@@ -152,6 +161,7 @@ class User {
152
161
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
153
162
  *
154
163
  * @throws {@link Zep.BadRequestError}
164
+ * @throws {@link Zep.NotFoundError}
155
165
  * @throws {@link Zep.InternalServerError}
156
166
  *
157
167
  * @example
@@ -204,6 +214,14 @@ class User {
204
214
  skipValidation: true,
205
215
  breadcrumbsPrefix: ["response"],
206
216
  }), _response.rawResponse);
217
+ case 404:
218
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
219
+ unrecognizedObjectKeys: "passthrough",
220
+ allowUnrecognizedUnionMembers: true,
221
+ allowUnrecognizedEnumValues: true,
222
+ skipValidation: true,
223
+ breadcrumbsPrefix: ["response"],
224
+ }), _response.rawResponse);
207
225
  case 500:
208
226
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
209
227
  unrecognizedObjectKeys: "passthrough",
@@ -244,6 +262,7 @@ class User {
244
262
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
245
263
  *
246
264
  * @throws {@link Zep.BadRequestError}
265
+ * @throws {@link Zep.NotFoundError}
247
266
  * @throws {@link Zep.InternalServerError}
248
267
  *
249
268
  * @example
@@ -291,6 +310,14 @@ class User {
291
310
  skipValidation: true,
292
311
  breadcrumbsPrefix: ["response"],
293
312
  }), _response.rawResponse);
313
+ case 404:
314
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
315
+ unrecognizedObjectKeys: "passthrough",
316
+ allowUnrecognizedUnionMembers: true,
317
+ allowUnrecognizedEnumValues: true,
318
+ skipValidation: true,
319
+ breadcrumbsPrefix: ["response"],
320
+ }), _response.rawResponse);
294
321
  case 500:
295
322
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
296
323
  unrecognizedObjectKeys: "passthrough",
@@ -6,7 +6,7 @@ export interface DateFilter {
6
6
  /** Comparison operator for date filter */
7
7
  comparisonOperator: Zep.ComparisonOperator;
8
8
  /**
9
- * Date to filter on. Required for non-null operators (=, <>, >, <, >=, <=).
9
+ * Date to filter on. Required for non-null operators (=, \<\>, \>, \<, \>=, \<=).
10
10
  * Should be omitted for IS NULL and IS NOT NULL operators.
11
11
  */
12
12
  date?: string;
@@ -5,6 +5,8 @@ import * as Zep from "../index.js";
5
5
  export interface DetectPatternsResponse {
6
6
  /** Statistics about the detection run */
7
7
  metadata?: Zep.PatternMetadata;
8
+ /** Resolved nodes referenced by pattern edges (deduplicated). Only populated when query is set. */
9
+ nodes?: Zep.EntityNode[];
8
10
  /** Detected patterns, sorted by weighted_score descending */
9
11
  patterns?: Zep.PatternResult[];
10
12
  }
@@ -7,8 +7,11 @@ export interface PatternResult {
7
7
  description?: string;
8
8
  /** Edge types in the pattern structure */
9
9
  edgeTypes?: string[];
10
- /** Example instances (only populated when include_examples is true) */
11
- examples?: Zep.PatternExample[];
10
+ /**
11
+ * Resolved edges for this pattern, sorted by cross-encoder relevance.
12
+ * Only populated when query is set.
13
+ */
14
+ edges?: Zep.EntityEdge[];
12
15
  /** Node labels in the pattern structure */
13
16
  nodeLabels?: string[];
14
17
  /** Raw occurrence count (always unweighted) */
@@ -10,7 +10,7 @@ export interface PropertyFilter {
10
10
  /**
11
11
  * Property value to match on. Accepted types: string, int, float64, bool, or nil.
12
12
  * Invalid types (e.g., arrays, objects) will be rejected by validation.
13
- * Must be non-nil for non-null operators (=, <>, >, <, >=, <=).
13
+ * Must be non-nil for non-null operators (=, \<\>, \>, \<, \>=, \<=).
14
14
  */
15
15
  propertyValue?: unknown;
16
16
  }
@@ -7,8 +7,8 @@ export interface SearchFilters {
7
7
  * 2D array of date filters for the created_at field.
8
8
  * The outer array elements are combined with OR logic.
9
9
  * The inner array elements are combined with AND logic.
10
- * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
11
- * This translates to: (created_at > date1 AND created_at < date2) OR (created_at = date3)
10
+ * Example: [[\{"\>", date1\}, \{"\<", date2\}], [\{"=", date3\}]]
11
+ * This translates to: (created_at \> date1 AND created_at \< date2) OR (created_at = date3)
12
12
  */
13
13
  createdAt?: Zep.DateFilter[][];
14
14
  /** List of edge types to filter on */
@@ -23,16 +23,16 @@ export interface SearchFilters {
23
23
  * 2D array of date filters for the expired_at field.
24
24
  * The outer array elements are combined with OR logic.
25
25
  * The inner array elements are combined with AND logic.
26
- * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
27
- * This translates to: (expired_at > date1 AND expired_at < date2) OR (expired_at = date3)
26
+ * Example: [[\{"\>", date1\}, \{"\<", date2\}], [\{"=", date3\}]]
27
+ * This translates to: (expired_at \> date1 AND expired_at \< date2) OR (expired_at = date3)
28
28
  */
29
29
  expiredAt?: Zep.DateFilter[][];
30
30
  /**
31
31
  * 2D array of date filters for the invalid_at field.
32
32
  * The outer array elements are combined with OR logic.
33
33
  * The inner array elements are combined with AND logic.
34
- * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
35
- * This translates to: (invalid_at > date1 AND invalid_at < date2) OR (invalid_at = date3)
34
+ * Example: [[\{"\>", date1\}, \{"\<", date2\}], [\{"=", date3\}]]
35
+ * This translates to: (invalid_at \> date1 AND invalid_at \< date2) OR (invalid_at = date3)
36
36
  */
37
37
  invalidAt?: Zep.DateFilter[][];
38
38
  /** List of node labels to filter on */
@@ -43,8 +43,8 @@ export interface SearchFilters {
43
43
  * 2D array of date filters for the valid_at field.
44
44
  * The outer array elements are combined with OR logic.
45
45
  * The inner array elements are combined with AND logic.
46
- * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
47
- * This translates to: (valid_at > date1 AND valid_at < date2) OR (valid_at = date3)
46
+ * Example: [[\{"\>", date1\}, \{"\<", date2\}], [\{"=", date3\}]]
47
+ * This translates to: (valid_at \> date1 AND valid_at \< date2) OR (valid_at = date3)
48
48
  */
49
49
  validAt?: Zep.DateFilter[][];
50
50
  }
@@ -28,7 +28,6 @@ export * from "./ListContextTemplatesResponse.js";
28
28
  export * from "./ListCustomInstructionsResponse.js";
29
29
  export * from "./ListUserInstructionsResponse.js";
30
30
  export * from "./PathDetectConfig.js";
31
- export * from "./PatternExample.js";
32
31
  export * from "./PatternMetadata.js";
33
32
  export * from "./PatternResult.js";
34
33
  export * from "./PatternSeeds.js";
@@ -44,7 +44,6 @@ __exportStar(require("./ListContextTemplatesResponse.js"), exports);
44
44
  __exportStar(require("./ListCustomInstructionsResponse.js"), exports);
45
45
  __exportStar(require("./ListUserInstructionsResponse.js"), exports);
46
46
  __exportStar(require("./PathDetectConfig.js"), exports);
47
- __exportStar(require("./PatternExample.js"), exports);
48
47
  __exportStar(require("./PatternMetadata.js"), exports);
49
48
  __exportStar(require("./PatternResult.js"), exports);
50
49
  __exportStar(require("./PatternSeeds.js"), exports);
@@ -12,10 +12,12 @@ export declare const DetectPatternsRequest: core.serialization.Schema<serializer
12
12
  export declare namespace DetectPatternsRequest {
13
13
  interface Raw {
14
14
  detect?: DetectConfig.Raw | null;
15
+ edge_limit?: number | null;
15
16
  graph_id?: string | null;
16
- include_examples?: boolean | null;
17
17
  limit?: number | null;
18
18
  min_occurrences?: number | null;
19
+ query?: string | null;
20
+ query_limit?: number | null;
19
21
  recency_weight?: RecencyWeight.Raw | null;
20
22
  search_filters?: SearchFilters.Raw | null;
21
23
  seeds?: PatternSeeds.Raw | null;
@@ -44,10 +44,12 @@ const SearchFilters_js_1 = require("../../../../types/SearchFilters.js");
44
44
  const PatternSeeds_js_1 = require("../../../../types/PatternSeeds.js");
45
45
  exports.DetectPatternsRequest = core.serialization.object({
46
46
  detect: DetectConfig_js_1.DetectConfig.optional(),
47
+ edgeLimit: core.serialization.property("edge_limit", core.serialization.number().optional()),
47
48
  graphId: core.serialization.property("graph_id", core.serialization.string().optional()),
48
- includeExamples: core.serialization.property("include_examples", core.serialization.boolean().optional()),
49
49
  limit: core.serialization.number().optional(),
50
50
  minOccurrences: core.serialization.property("min_occurrences", core.serialization.number().optional()),
51
+ query: core.serialization.string().optional(),
52
+ queryLimit: core.serialization.property("query_limit", core.serialization.number().optional()),
51
53
  recencyWeight: core.serialization.property("recency_weight", RecencyWeight_js_1.RecencyWeight.optional()),
52
54
  searchFilters: core.serialization.property("search_filters", SearchFilters_js_1.SearchFilters.optional()),
53
55
  seeds: PatternSeeds_js_1.PatternSeeds.optional(),
@@ -5,11 +5,13 @@ import * as serializers from "../index.js";
5
5
  import * as Zep from "../../api/index.js";
6
6
  import * as core from "../../core/index.js";
7
7
  import { PatternMetadata } from "./PatternMetadata.js";
8
+ import { EntityNode } from "./EntityNode.js";
8
9
  import { PatternResult } from "./PatternResult.js";
9
10
  export declare const DetectPatternsResponse: core.serialization.ObjectSchema<serializers.DetectPatternsResponse.Raw, Zep.DetectPatternsResponse>;
10
11
  export declare namespace DetectPatternsResponse {
11
12
  interface Raw {
12
13
  metadata?: PatternMetadata.Raw | null;
14
+ nodes?: EntityNode.Raw[] | null;
13
15
  patterns?: PatternResult.Raw[] | null;
14
16
  }
15
17
  }
@@ -39,8 +39,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
39
39
  exports.DetectPatternsResponse = void 0;
40
40
  const core = __importStar(require("../../core/index.js"));
41
41
  const PatternMetadata_js_1 = require("./PatternMetadata.js");
42
+ const EntityNode_js_1 = require("./EntityNode.js");
42
43
  const PatternResult_js_1 = require("./PatternResult.js");
43
44
  exports.DetectPatternsResponse = core.serialization.object({
44
45
  metadata: PatternMetadata_js_1.PatternMetadata.optional(),
46
+ nodes: core.serialization.list(EntityNode_js_1.EntityNode).optional(),
45
47
  patterns: core.serialization.list(PatternResult_js_1.PatternResult).optional(),
46
48
  });
@@ -4,13 +4,13 @@
4
4
  import * as serializers from "../index.js";
5
5
  import * as Zep from "../../api/index.js";
6
6
  import * as core from "../../core/index.js";
7
- import { PatternExample } from "./PatternExample.js";
7
+ import { EntityEdge } from "./EntityEdge.js";
8
8
  export declare const PatternResult: core.serialization.ObjectSchema<serializers.PatternResult.Raw, Zep.PatternResult>;
9
9
  export declare namespace PatternResult {
10
10
  interface Raw {
11
11
  description?: string | null;
12
12
  edge_types?: string[] | null;
13
- examples?: PatternExample.Raw[] | null;
13
+ edges?: EntityEdge.Raw[] | null;
14
14
  node_labels?: string[] | null;
15
15
  occurrences?: number | null;
16
16
  type?: string | null;
@@ -38,11 +38,11 @@ var __importStar = (this && this.__importStar) || (function () {
38
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
39
  exports.PatternResult = void 0;
40
40
  const core = __importStar(require("../../core/index.js"));
41
- const PatternExample_js_1 = require("./PatternExample.js");
41
+ const EntityEdge_js_1 = require("./EntityEdge.js");
42
42
  exports.PatternResult = core.serialization.object({
43
43
  description: core.serialization.string().optional(),
44
44
  edgeTypes: core.serialization.property("edge_types", core.serialization.list(core.serialization.string()).optional()),
45
- examples: core.serialization.list(PatternExample_js_1.PatternExample).optional(),
45
+ edges: core.serialization.list(EntityEdge_js_1.EntityEdge).optional(),
46
46
  nodeLabels: core.serialization.property("node_labels", core.serialization.list(core.serialization.string()).optional()),
47
47
  occurrences: core.serialization.number().optional(),
48
48
  type: core.serialization.string().optional(),
@@ -28,7 +28,6 @@ export * from "./ListContextTemplatesResponse.js";
28
28
  export * from "./ListCustomInstructionsResponse.js";
29
29
  export * from "./ListUserInstructionsResponse.js";
30
30
  export * from "./PathDetectConfig.js";
31
- export * from "./PatternExample.js";
32
31
  export * from "./PatternMetadata.js";
33
32
  export * from "./PatternResult.js";
34
33
  export * from "./PatternSeeds.js";
@@ -44,7 +44,6 @@ __exportStar(require("./ListContextTemplatesResponse.js"), exports);
44
44
  __exportStar(require("./ListCustomInstructionsResponse.js"), exports);
45
45
  __exportStar(require("./ListUserInstructionsResponse.js"), exports);
46
46
  __exportStar(require("./PathDetectConfig.js"), exports);
47
- __exportStar(require("./PatternExample.js"), exports);
48
47
  __exportStar(require("./PatternMetadata.js"), exports);
49
48
  __exportStar(require("./PatternResult.js"), exports);
50
49
  __exportStar(require("./PatternSeeds.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "3.17.0";
1
+ export declare const SDK_VERSION = "3.18.0";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "3.17.0";
4
+ exports.SDK_VERSION = "3.18.0";
@@ -14,8 +14,8 @@ export class ZepClient {
14
14
  this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
15
15
  "X-Fern-Language": "JavaScript",
16
16
  "X-Fern-SDK-Name": "zep-cloud",
17
- "X-Fern-SDK-Version": "3.17.0",
18
- "User-Agent": "zep-cloud/3.17.0",
17
+ "X-Fern-SDK-Version": "3.18.0",
18
+ "User-Agent": "zep-cloud/3.18.0",
19
19
  "X-Fern-Runtime": core.RUNTIME.type,
20
20
  "X-Fern-Runtime-Version": core.RUNTIME.version,
21
21
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -44,6 +44,7 @@ export declare class Graph {
44
44
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
45
45
  *
46
46
  * @throws {@link Zep.BadRequestError}
47
+ * @throws {@link Zep.NotFoundError}
47
48
  * @throws {@link Zep.InternalServerError}
48
49
  *
49
50
  * @example
@@ -61,6 +62,7 @@ export declare class Graph {
61
62
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
62
63
  *
63
64
  * @throws {@link Zep.BadRequestError}
65
+ * @throws {@link Zep.NotFoundError}
64
66
  * @throws {@link Zep.InternalServerError}
65
67
  *
66
68
  * @example
@@ -80,6 +82,7 @@ export declare class Graph {
80
82
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
81
83
  *
82
84
  * @throws {@link Zep.BadRequestError}
85
+ * @throws {@link Zep.NotFoundError}
83
86
  * @throws {@link Zep.InternalServerError}
84
87
  *
85
88
  * @example
@@ -112,6 +115,7 @@ export declare class Graph {
112
115
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
113
116
  *
114
117
  * @throws {@link Zep.BadRequestError}
118
+ * @throws {@link Zep.NotFoundError}
115
119
  * @throws {@link Zep.InternalServerError}
116
120
  *
117
121
  * @example
@@ -224,6 +228,8 @@ export declare class Graph {
224
228
  /**
225
229
  * Detects structural patterns in a knowledge graph including relationship frequencies,
226
230
  * multi-hop paths, co-occurrences, hubs, and clusters.
231
+ * When a query is provided, uses hybrid search to discover seed nodes,
232
+ * detects triple-frequency patterns, and returns resolved edges ranked by relevance.
227
233
  *
228
234
  * @param {Zep.DetectPatternsRequest} request
229
235
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
@@ -42,6 +42,7 @@ export class Graph {
42
42
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
43
43
  *
44
44
  * @throws {@link Zep.BadRequestError}
45
+ * @throws {@link Zep.NotFoundError}
45
46
  * @throws {@link Zep.InternalServerError}
46
47
  *
47
48
  * @example
@@ -95,6 +96,14 @@ export class Graph {
95
96
  skipValidation: true,
96
97
  breadcrumbsPrefix: ["response"],
97
98
  }), _response.rawResponse);
99
+ case 404:
100
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
101
+ unrecognizedObjectKeys: "passthrough",
102
+ allowUnrecognizedUnionMembers: true,
103
+ allowUnrecognizedEnumValues: true,
104
+ skipValidation: true,
105
+ breadcrumbsPrefix: ["response"],
106
+ }), _response.rawResponse);
98
107
  case 500:
99
108
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
100
109
  unrecognizedObjectKeys: "passthrough",
@@ -135,6 +144,7 @@ export class Graph {
135
144
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
136
145
  *
137
146
  * @throws {@link Zep.BadRequestError}
147
+ * @throws {@link Zep.NotFoundError}
138
148
  * @throws {@link Zep.InternalServerError}
139
149
  *
140
150
  * @example
@@ -187,6 +197,14 @@ export class Graph {
187
197
  skipValidation: true,
188
198
  breadcrumbsPrefix: ["response"],
189
199
  }), _response.rawResponse);
200
+ case 404:
201
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
202
+ unrecognizedObjectKeys: "passthrough",
203
+ allowUnrecognizedUnionMembers: true,
204
+ allowUnrecognizedEnumValues: true,
205
+ skipValidation: true,
206
+ breadcrumbsPrefix: ["response"],
207
+ }), _response.rawResponse);
190
208
  case 500:
191
209
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
192
210
  unrecognizedObjectKeys: "passthrough",
@@ -227,6 +245,7 @@ export class Graph {
227
245
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
228
246
  *
229
247
  * @throws {@link Zep.BadRequestError}
248
+ * @throws {@link Zep.NotFoundError}
230
249
  * @throws {@link Zep.InternalServerError}
231
250
  *
232
251
  * @example
@@ -274,6 +293,14 @@ export class Graph {
274
293
  skipValidation: true,
275
294
  breadcrumbsPrefix: ["response"],
276
295
  }), _response.rawResponse);
296
+ case 404:
297
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
298
+ unrecognizedObjectKeys: "passthrough",
299
+ allowUnrecognizedUnionMembers: true,
300
+ allowUnrecognizedEnumValues: true,
301
+ skipValidation: true,
302
+ breadcrumbsPrefix: ["response"],
303
+ }), _response.rawResponse);
277
304
  case 500:
278
305
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
279
306
  unrecognizedObjectKeys: "passthrough",
@@ -416,6 +443,7 @@ export class Graph {
416
443
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
417
444
  *
418
445
  * @throws {@link Zep.BadRequestError}
446
+ * @throws {@link Zep.NotFoundError}
419
447
  * @throws {@link Zep.InternalServerError}
420
448
  *
421
449
  * @example
@@ -463,6 +491,14 @@ export class Graph {
463
491
  skipValidation: true,
464
492
  breadcrumbsPrefix: ["response"],
465
493
  }), _response.rawResponse);
494
+ case 404:
495
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
496
+ unrecognizedObjectKeys: "passthrough",
497
+ allowUnrecognizedUnionMembers: true,
498
+ allowUnrecognizedEnumValues: true,
499
+ skipValidation: true,
500
+ breadcrumbsPrefix: ["response"],
501
+ }), _response.rawResponse);
466
502
  case 500:
467
503
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
468
504
  unrecognizedObjectKeys: "passthrough",
@@ -1048,6 +1084,8 @@ export class Graph {
1048
1084
  /**
1049
1085
  * Detects structural patterns in a knowledge graph including relationship frequencies,
1050
1086
  * multi-hop paths, co-occurrences, hubs, and clusters.
1087
+ * When a query is provided, uses hybrid search to discover seed nodes,
1088
+ * detects triple-frequency patterns, and returns resolved edges ranked by relevance.
1051
1089
  *
1052
1090
  * @param {Zep.DetectPatternsRequest} request
1053
1091
  * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
@@ -9,17 +9,25 @@ import * as Zep from "../../../../index.mjs";
9
9
  export interface DetectPatternsRequest {
10
10
  /**
11
11
  * Which pattern types to detect with type-specific configuration.
12
- * Omit to detect all types with defaults.
12
+ * Omit to detect all types with defaults. Ignored when query is set.
13
13
  */
14
14
  detect?: Zep.DetectConfig;
15
+ /** Max resolved edges per pattern. Default: 10, Max: 100. Only used with query. */
16
+ edgeLimit?: number;
15
17
  /** Graph ID when detecting patterns on a named graph */
16
18
  graphId?: string;
17
- /** Include example node/edge UUIDs per pattern. Default: false */
18
- includeExamples?: boolean;
19
19
  /** Max patterns to return. Default: 50, Max: 200 */
20
20
  limit?: number;
21
21
  /** Minimum occurrence count to report a pattern. Default: 2 */
22
22
  minOccurrences?: number;
23
+ /**
24
+ * Search query for discovering seed nodes via hybrid search.
25
+ * When set, forces triple-frequency detection only and enables edge resolution
26
+ * with cross-encoder reranking. Mutually exclusive with seeds.
27
+ */
28
+ query?: string;
29
+ /** Max seed nodes from search. Default: 10, Max: 50. Only used with query. */
30
+ queryLimit?: number;
23
31
  /**
24
32
  * Exponential half-life decay applied to edge created_at timestamps.
25
33
  * Valid values: none, 7_days, 30_days, 90_days. Default: none
@@ -30,7 +38,7 @@ export interface DetectPatternsRequest {
30
38
  * Reuses the same filter format as /graph/search.
31
39
  */
32
40
  searchFilters?: Zep.SearchFilters;
33
- /** Seed selection. If omitted, analyzes the entire graph. */
41
+ /** Seed selection. If omitted, analyzes the entire graph. Mutually exclusive with query. */
34
42
  seeds?: Zep.PatternSeeds;
35
43
  /** User ID when detecting patterns on a user graph */
36
44
  userId?: string;
@@ -35,6 +35,7 @@ export declare class User {
35
35
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
36
36
  *
37
37
  * @throws {@link Zep.BadRequestError}
38
+ * @throws {@link Zep.NotFoundError}
38
39
  * @throws {@link Zep.InternalServerError}
39
40
  *
40
41
  * @example
@@ -51,6 +52,7 @@ export declare class User {
51
52
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
52
53
  *
53
54
  * @throws {@link Zep.BadRequestError}
55
+ * @throws {@link Zep.NotFoundError}
54
56
  * @throws {@link Zep.InternalServerError}
55
57
  *
56
58
  * @example
@@ -70,6 +72,7 @@ export declare class User {
70
72
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
71
73
  *
72
74
  * @throws {@link Zep.BadRequestError}
75
+ * @throws {@link Zep.NotFoundError}
73
76
  * @throws {@link Zep.InternalServerError}
74
77
  *
75
78
  * @example
@@ -27,6 +27,7 @@ export class User {
27
27
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
28
28
  *
29
29
  * @throws {@link Zep.BadRequestError}
30
+ * @throws {@link Zep.NotFoundError}
30
31
  * @throws {@link Zep.InternalServerError}
31
32
  *
32
33
  * @example
@@ -76,6 +77,14 @@ export class User {
76
77
  skipValidation: true,
77
78
  breadcrumbsPrefix: ["response"],
78
79
  }), _response.rawResponse);
80
+ case 404:
81
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
82
+ unrecognizedObjectKeys: "passthrough",
83
+ allowUnrecognizedUnionMembers: true,
84
+ allowUnrecognizedEnumValues: true,
85
+ skipValidation: true,
86
+ breadcrumbsPrefix: ["response"],
87
+ }), _response.rawResponse);
79
88
  case 500:
80
89
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
81
90
  unrecognizedObjectKeys: "passthrough",
@@ -116,6 +125,7 @@ export class User {
116
125
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
117
126
  *
118
127
  * @throws {@link Zep.BadRequestError}
128
+ * @throws {@link Zep.NotFoundError}
119
129
  * @throws {@link Zep.InternalServerError}
120
130
  *
121
131
  * @example
@@ -168,6 +178,14 @@ export class User {
168
178
  skipValidation: true,
169
179
  breadcrumbsPrefix: ["response"],
170
180
  }), _response.rawResponse);
181
+ case 404:
182
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
183
+ unrecognizedObjectKeys: "passthrough",
184
+ allowUnrecognizedUnionMembers: true,
185
+ allowUnrecognizedEnumValues: true,
186
+ skipValidation: true,
187
+ breadcrumbsPrefix: ["response"],
188
+ }), _response.rawResponse);
171
189
  case 500:
172
190
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
173
191
  unrecognizedObjectKeys: "passthrough",
@@ -208,6 +226,7 @@ export class User {
208
226
  * @param {User.RequestOptions} requestOptions - Request-specific configuration.
209
227
  *
210
228
  * @throws {@link Zep.BadRequestError}
229
+ * @throws {@link Zep.NotFoundError}
211
230
  * @throws {@link Zep.InternalServerError}
212
231
  *
213
232
  * @example
@@ -255,6 +274,14 @@ export class User {
255
274
  skipValidation: true,
256
275
  breadcrumbsPrefix: ["response"],
257
276
  }), _response.rawResponse);
277
+ case 404:
278
+ throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
279
+ unrecognizedObjectKeys: "passthrough",
280
+ allowUnrecognizedUnionMembers: true,
281
+ allowUnrecognizedEnumValues: true,
282
+ skipValidation: true,
283
+ breadcrumbsPrefix: ["response"],
284
+ }), _response.rawResponse);
258
285
  case 500:
259
286
  throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
260
287
  unrecognizedObjectKeys: "passthrough",
@@ -6,7 +6,7 @@ export interface DateFilter {
6
6
  /** Comparison operator for date filter */
7
7
  comparisonOperator: Zep.ComparisonOperator;
8
8
  /**
9
- * Date to filter on. Required for non-null operators (=, <>, >, <, >=, <=).
9
+ * Date to filter on. Required for non-null operators (=, \<\>, \>, \<, \>=, \<=).
10
10
  * Should be omitted for IS NULL and IS NOT NULL operators.
11
11
  */
12
12
  date?: string;
@@ -5,6 +5,8 @@ import * as Zep from "../index.mjs";
5
5
  export interface DetectPatternsResponse {
6
6
  /** Statistics about the detection run */
7
7
  metadata?: Zep.PatternMetadata;
8
+ /** Resolved nodes referenced by pattern edges (deduplicated). Only populated when query is set. */
9
+ nodes?: Zep.EntityNode[];
8
10
  /** Detected patterns, sorted by weighted_score descending */
9
11
  patterns?: Zep.PatternResult[];
10
12
  }
@@ -7,8 +7,11 @@ export interface PatternResult {
7
7
  description?: string;
8
8
  /** Edge types in the pattern structure */
9
9
  edgeTypes?: string[];
10
- /** Example instances (only populated when include_examples is true) */
11
- examples?: Zep.PatternExample[];
10
+ /**
11
+ * Resolved edges for this pattern, sorted by cross-encoder relevance.
12
+ * Only populated when query is set.
13
+ */
14
+ edges?: Zep.EntityEdge[];
12
15
  /** Node labels in the pattern structure */
13
16
  nodeLabels?: string[];
14
17
  /** Raw occurrence count (always unweighted) */
@@ -10,7 +10,7 @@ export interface PropertyFilter {
10
10
  /**
11
11
  * Property value to match on. Accepted types: string, int, float64, bool, or nil.
12
12
  * Invalid types (e.g., arrays, objects) will be rejected by validation.
13
- * Must be non-nil for non-null operators (=, <>, >, <, >=, <=).
13
+ * Must be non-nil for non-null operators (=, \<\>, \>, \<, \>=, \<=).
14
14
  */
15
15
  propertyValue?: unknown;
16
16
  }
@@ -7,8 +7,8 @@ export interface SearchFilters {
7
7
  * 2D array of date filters for the created_at field.
8
8
  * The outer array elements are combined with OR logic.
9
9
  * The inner array elements are combined with AND logic.
10
- * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
11
- * This translates to: (created_at > date1 AND created_at < date2) OR (created_at = date3)
10
+ * Example: [[\{"\>", date1\}, \{"\<", date2\}], [\{"=", date3\}]]
11
+ * This translates to: (created_at \> date1 AND created_at \< date2) OR (created_at = date3)
12
12
  */
13
13
  createdAt?: Zep.DateFilter[][];
14
14
  /** List of edge types to filter on */
@@ -23,16 +23,16 @@ export interface SearchFilters {
23
23
  * 2D array of date filters for the expired_at field.
24
24
  * The outer array elements are combined with OR logic.
25
25
  * The inner array elements are combined with AND logic.
26
- * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
27
- * This translates to: (expired_at > date1 AND expired_at < date2) OR (expired_at = date3)
26
+ * Example: [[\{"\>", date1\}, \{"\<", date2\}], [\{"=", date3\}]]
27
+ * This translates to: (expired_at \> date1 AND expired_at \< date2) OR (expired_at = date3)
28
28
  */
29
29
  expiredAt?: Zep.DateFilter[][];
30
30
  /**
31
31
  * 2D array of date filters for the invalid_at field.
32
32
  * The outer array elements are combined with OR logic.
33
33
  * The inner array elements are combined with AND logic.
34
- * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
35
- * This translates to: (invalid_at > date1 AND invalid_at < date2) OR (invalid_at = date3)
34
+ * Example: [[\{"\>", date1\}, \{"\<", date2\}], [\{"=", date3\}]]
35
+ * This translates to: (invalid_at \> date1 AND invalid_at \< date2) OR (invalid_at = date3)
36
36
  */
37
37
  invalidAt?: Zep.DateFilter[][];
38
38
  /** List of node labels to filter on */
@@ -43,8 +43,8 @@ export interface SearchFilters {
43
43
  * 2D array of date filters for the valid_at field.
44
44
  * The outer array elements are combined with OR logic.
45
45
  * The inner array elements are combined with AND logic.
46
- * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
47
- * This translates to: (valid_at > date1 AND valid_at < date2) OR (valid_at = date3)
46
+ * Example: [[\{"\>", date1\}, \{"\<", date2\}], [\{"=", date3\}]]
47
+ * This translates to: (valid_at \> date1 AND valid_at \< date2) OR (valid_at = date3)
48
48
  */
49
49
  validAt?: Zep.DateFilter[][];
50
50
  }
@@ -28,7 +28,6 @@ export * from "./ListContextTemplatesResponse.mjs";
28
28
  export * from "./ListCustomInstructionsResponse.mjs";
29
29
  export * from "./ListUserInstructionsResponse.mjs";
30
30
  export * from "./PathDetectConfig.mjs";
31
- export * from "./PatternExample.mjs";
32
31
  export * from "./PatternMetadata.mjs";
33
32
  export * from "./PatternResult.mjs";
34
33
  export * from "./PatternSeeds.mjs";
@@ -28,7 +28,6 @@ export * from "./ListContextTemplatesResponse.mjs";
28
28
  export * from "./ListCustomInstructionsResponse.mjs";
29
29
  export * from "./ListUserInstructionsResponse.mjs";
30
30
  export * from "./PathDetectConfig.mjs";
31
- export * from "./PatternExample.mjs";
32
31
  export * from "./PatternMetadata.mjs";
33
32
  export * from "./PatternResult.mjs";
34
33
  export * from "./PatternSeeds.mjs";
@@ -12,10 +12,12 @@ export declare const DetectPatternsRequest: core.serialization.Schema<serializer
12
12
  export declare namespace DetectPatternsRequest {
13
13
  interface Raw {
14
14
  detect?: DetectConfig.Raw | null;
15
+ edge_limit?: number | null;
15
16
  graph_id?: string | null;
16
- include_examples?: boolean | null;
17
17
  limit?: number | null;
18
18
  min_occurrences?: number | null;
19
+ query?: string | null;
20
+ query_limit?: number | null;
19
21
  recency_weight?: RecencyWeight.Raw | null;
20
22
  search_filters?: SearchFilters.Raw | null;
21
23
  seeds?: PatternSeeds.Raw | null;
@@ -8,10 +8,12 @@ import { SearchFilters } from "../../../../types/SearchFilters.mjs";
8
8
  import { PatternSeeds } from "../../../../types/PatternSeeds.mjs";
9
9
  export const DetectPatternsRequest = core.serialization.object({
10
10
  detect: DetectConfig.optional(),
11
+ edgeLimit: core.serialization.property("edge_limit", core.serialization.number().optional()),
11
12
  graphId: core.serialization.property("graph_id", core.serialization.string().optional()),
12
- includeExamples: core.serialization.property("include_examples", core.serialization.boolean().optional()),
13
13
  limit: core.serialization.number().optional(),
14
14
  minOccurrences: core.serialization.property("min_occurrences", core.serialization.number().optional()),
15
+ query: core.serialization.string().optional(),
16
+ queryLimit: core.serialization.property("query_limit", core.serialization.number().optional()),
15
17
  recencyWeight: core.serialization.property("recency_weight", RecencyWeight.optional()),
16
18
  searchFilters: core.serialization.property("search_filters", SearchFilters.optional()),
17
19
  seeds: PatternSeeds.optional(),
@@ -5,11 +5,13 @@ import * as serializers from "../index.mjs";
5
5
  import * as Zep from "../../api/index.mjs";
6
6
  import * as core from "../../core/index.mjs";
7
7
  import { PatternMetadata } from "./PatternMetadata.mjs";
8
+ import { EntityNode } from "./EntityNode.mjs";
8
9
  import { PatternResult } from "./PatternResult.mjs";
9
10
  export declare const DetectPatternsResponse: core.serialization.ObjectSchema<serializers.DetectPatternsResponse.Raw, Zep.DetectPatternsResponse>;
10
11
  export declare namespace DetectPatternsResponse {
11
12
  interface Raw {
12
13
  metadata?: PatternMetadata.Raw | null;
14
+ nodes?: EntityNode.Raw[] | null;
13
15
  patterns?: PatternResult.Raw[] | null;
14
16
  }
15
17
  }
@@ -3,8 +3,10 @@
3
3
  */
4
4
  import * as core from "../../core/index.mjs";
5
5
  import { PatternMetadata } from "./PatternMetadata.mjs";
6
+ import { EntityNode } from "./EntityNode.mjs";
6
7
  import { PatternResult } from "./PatternResult.mjs";
7
8
  export const DetectPatternsResponse = core.serialization.object({
8
9
  metadata: PatternMetadata.optional(),
10
+ nodes: core.serialization.list(EntityNode).optional(),
9
11
  patterns: core.serialization.list(PatternResult).optional(),
10
12
  });
@@ -4,13 +4,13 @@
4
4
  import * as serializers from "../index.mjs";
5
5
  import * as Zep from "../../api/index.mjs";
6
6
  import * as core from "../../core/index.mjs";
7
- import { PatternExample } from "./PatternExample.mjs";
7
+ import { EntityEdge } from "./EntityEdge.mjs";
8
8
  export declare const PatternResult: core.serialization.ObjectSchema<serializers.PatternResult.Raw, Zep.PatternResult>;
9
9
  export declare namespace PatternResult {
10
10
  interface Raw {
11
11
  description?: string | null;
12
12
  edge_types?: string[] | null;
13
- examples?: PatternExample.Raw[] | null;
13
+ edges?: EntityEdge.Raw[] | null;
14
14
  node_labels?: string[] | null;
15
15
  occurrences?: number | null;
16
16
  type?: string | null;
@@ -2,11 +2,11 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as core from "../../core/index.mjs";
5
- import { PatternExample } from "./PatternExample.mjs";
5
+ import { EntityEdge } from "./EntityEdge.mjs";
6
6
  export const PatternResult = core.serialization.object({
7
7
  description: core.serialization.string().optional(),
8
8
  edgeTypes: core.serialization.property("edge_types", core.serialization.list(core.serialization.string()).optional()),
9
- examples: core.serialization.list(PatternExample).optional(),
9
+ edges: core.serialization.list(EntityEdge).optional(),
10
10
  nodeLabels: core.serialization.property("node_labels", core.serialization.list(core.serialization.string()).optional()),
11
11
  occurrences: core.serialization.number().optional(),
12
12
  type: core.serialization.string().optional(),
@@ -28,7 +28,6 @@ export * from "./ListContextTemplatesResponse.mjs";
28
28
  export * from "./ListCustomInstructionsResponse.mjs";
29
29
  export * from "./ListUserInstructionsResponse.mjs";
30
30
  export * from "./PathDetectConfig.mjs";
31
- export * from "./PatternExample.mjs";
32
31
  export * from "./PatternMetadata.mjs";
33
32
  export * from "./PatternResult.mjs";
34
33
  export * from "./PatternSeeds.mjs";
@@ -28,7 +28,6 @@ export * from "./ListContextTemplatesResponse.mjs";
28
28
  export * from "./ListCustomInstructionsResponse.mjs";
29
29
  export * from "./ListUserInstructionsResponse.mjs";
30
30
  export * from "./PathDetectConfig.mjs";
31
- export * from "./PatternExample.mjs";
32
31
  export * from "./PatternMetadata.mjs";
33
32
  export * from "./PatternResult.mjs";
34
33
  export * from "./PatternSeeds.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "3.17.0";
1
+ export declare const SDK_VERSION = "3.18.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "3.17.0";
1
+ export const SDK_VERSION = "3.18.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getzep/zep-cloud",
3
- "version": "3.17.0",
3
+ "version": "3.18.0",
4
4
  "private": false,
5
5
  "repository": "https://github.com/getzep/zep-js",
6
6
  "description": "Zep: Fast, scalable building blocks for production LLM apps",
package/reference.md CHANGED
@@ -1064,6 +1064,8 @@ await client.graph.listAll({
1064
1064
 
1065
1065
  Detects structural patterns in a knowledge graph including relationship frequencies,
1066
1066
  multi-hop paths, co-occurrences, hubs, and clusters.
1067
+ When a query is provided, uses hybrid search to discover seed nodes,
1068
+ detects triple-frequency patterns, and returns resolved edges ranked by relevance.
1067
1069
 
1068
1070
  </dd>
1069
1071
  </dl>
@@ -1,9 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- export interface PatternExample {
5
- /** Edge UUIDs involved in this instance */
6
- edgeUuids?: string[];
7
- /** Node UUIDs involved in this instance */
8
- nodeUuids?: string[];
9
- }
@@ -1,5 +0,0 @@
1
- "use strict";
2
- /**
3
- * This file was auto-generated by Fern from our API Definition.
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,13 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as serializers from "../index.js";
5
- import * as Zep from "../../api/index.js";
6
- import * as core from "../../core/index.js";
7
- export declare const PatternExample: core.serialization.ObjectSchema<serializers.PatternExample.Raw, Zep.PatternExample>;
8
- export declare namespace PatternExample {
9
- interface Raw {
10
- edge_uuids?: string[] | null;
11
- node_uuids?: string[] | null;
12
- }
13
- }
@@ -1,44 +0,0 @@
1
- "use strict";
2
- /**
3
- * This file was auto-generated by Fern from our API Definition.
4
- */
5
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
- if (k2 === undefined) k2 = k;
7
- var desc = Object.getOwnPropertyDescriptor(m, k);
8
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
- desc = { enumerable: true, get: function() { return m[k]; } };
10
- }
11
- Object.defineProperty(o, k2, desc);
12
- }) : (function(o, m, k, k2) {
13
- if (k2 === undefined) k2 = k;
14
- o[k2] = m[k];
15
- }));
16
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
- Object.defineProperty(o, "default", { enumerable: true, value: v });
18
- }) : function(o, v) {
19
- o["default"] = v;
20
- });
21
- var __importStar = (this && this.__importStar) || (function () {
22
- var ownKeys = function(o) {
23
- ownKeys = Object.getOwnPropertyNames || function (o) {
24
- var ar = [];
25
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
- return ar;
27
- };
28
- return ownKeys(o);
29
- };
30
- return function (mod) {
31
- if (mod && mod.__esModule) return mod;
32
- var result = {};
33
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
- __setModuleDefault(result, mod);
35
- return result;
36
- };
37
- })();
38
- Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.PatternExample = void 0;
40
- const core = __importStar(require("../../core/index.js"));
41
- exports.PatternExample = core.serialization.object({
42
- edgeUuids: core.serialization.property("edge_uuids", core.serialization.list(core.serialization.string()).optional()),
43
- nodeUuids: core.serialization.property("node_uuids", core.serialization.list(core.serialization.string()).optional()),
44
- });
@@ -1,9 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- export interface PatternExample {
5
- /** Edge UUIDs involved in this instance */
6
- edgeUuids?: string[];
7
- /** Node UUIDs involved in this instance */
8
- nodeUuids?: string[];
9
- }
@@ -1,4 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- export {};
@@ -1,13 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as serializers from "../index.mjs";
5
- import * as Zep from "../../api/index.mjs";
6
- import * as core from "../../core/index.mjs";
7
- export declare const PatternExample: core.serialization.ObjectSchema<serializers.PatternExample.Raw, Zep.PatternExample>;
8
- export declare namespace PatternExample {
9
- interface Raw {
10
- edge_uuids?: string[] | null;
11
- node_uuids?: string[] | null;
12
- }
13
- }
@@ -1,8 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as core from "../../core/index.mjs";
5
- export const PatternExample = core.serialization.object({
6
- edgeUuids: core.serialization.property("edge_uuids", core.serialization.list(core.serialization.string()).optional()),
7
- nodeUuids: core.serialization.property("node_uuids", core.serialization.list(core.serialization.string()).optional()),
8
- });