@memnexus-ai/typescript-sdk 1.10.1 → 1.11.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.
- package/README.md +4 -0
- package/dist/index.d.ts +225 -126
- package/dist/index.js +538 -356
- package/dist/index.mjs +531 -353
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -160,6 +160,10 @@ The SDK includes several models that represent the data structures used in API r
|
|
|
160
160
|
| [Entity](documentation/models/Entity.md) | |
|
|
161
161
|
| [TopicReference](documentation/models/TopicReference.md) | |
|
|
162
162
|
| [TemporalMetadata](documentation/models/TemporalMetadata.md) | Temporal query metadata (null for semantic/hybrid search) |
|
|
163
|
+
| [SearchMemoriesGetSearchMethod](documentation/models/SearchMemoriesGetSearchMethod.md) | |
|
|
164
|
+
| [SearchMemoriesGetMode](documentation/models/SearchMemoriesGetMode.md) | |
|
|
165
|
+
| [SearchMemoriesGetMemoryType](documentation/models/SearchMemoriesGetMemoryType.md) | |
|
|
166
|
+
| [SearchMemoriesGetTemporalMode](documentation/models/SearchMemoriesGetTemporalMode.md) | |
|
|
163
167
|
| [SearchRequest](documentation/models/SearchRequest.md) | |
|
|
164
168
|
| [GetSimilarMemoriesOkResponse](documentation/models/GetSimilarMemoriesOkResponse.md) | |
|
|
165
169
|
| [RelatedMemoryResult](documentation/models/RelatedMemoryResult.md) | |
|
package/dist/index.d.ts
CHANGED
|
@@ -3601,11 +3601,60 @@ declare const listMemoriesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
3601
3601
|
*/
|
|
3602
3602
|
type ListMemoriesOkResponse = z.infer<typeof listMemoriesOkResponse>;
|
|
3603
3603
|
|
|
3604
|
+
declare enum SearchMemoriesGetSearchMethod {
|
|
3605
|
+
KEYWORD = "keyword",
|
|
3606
|
+
SEMANTIC = "semantic",
|
|
3607
|
+
HYBRID = "hybrid"
|
|
3608
|
+
}
|
|
3609
|
+
|
|
3610
|
+
declare enum SearchMemoriesGetMode {
|
|
3611
|
+
UNIFIED = "unified",
|
|
3612
|
+
CONTENT = "content",
|
|
3613
|
+
FACTS = "facts"
|
|
3614
|
+
}
|
|
3615
|
+
|
|
3616
|
+
declare enum SearchMemoriesGetMemoryType {
|
|
3617
|
+
EPISODIC = "episodic",
|
|
3618
|
+
SEMANTIC = "semantic",
|
|
3619
|
+
PROCEDURAL = "procedural"
|
|
3620
|
+
}
|
|
3621
|
+
|
|
3622
|
+
declare enum SearchMemoriesGetTemporalMode {
|
|
3623
|
+
CURRENT = "current",
|
|
3624
|
+
HISTORICAL = "historical",
|
|
3625
|
+
EVOLUTION = "evolution"
|
|
3626
|
+
}
|
|
3627
|
+
|
|
3604
3628
|
interface ListMemoriesParams {
|
|
3629
|
+
idPrefix?: string;
|
|
3605
3630
|
limit?: number;
|
|
3606
3631
|
offset?: number;
|
|
3607
3632
|
page?: number;
|
|
3608
3633
|
}
|
|
3634
|
+
interface SearchMemoriesGetParams {
|
|
3635
|
+
q: string;
|
|
3636
|
+
searchMethod?: SearchMemoriesGetSearchMethod;
|
|
3637
|
+
limit?: number;
|
|
3638
|
+
offset?: number;
|
|
3639
|
+
threshold?: number;
|
|
3640
|
+
mode?: SearchMemoriesGetMode;
|
|
3641
|
+
vectorWeight?: number;
|
|
3642
|
+
fulltextWeight?: number;
|
|
3643
|
+
topics?: string;
|
|
3644
|
+
memoryType?: SearchMemoriesGetMemoryType;
|
|
3645
|
+
conversationId?: string;
|
|
3646
|
+
explain?: boolean;
|
|
3647
|
+
includeTopics?: boolean;
|
|
3648
|
+
includeEntities?: boolean;
|
|
3649
|
+
asOfTime?: string;
|
|
3650
|
+
validAtTime?: string;
|
|
3651
|
+
eventTimeFrom?: string;
|
|
3652
|
+
eventTimeTo?: string;
|
|
3653
|
+
ingestionTimeFrom?: string;
|
|
3654
|
+
ingestionTimeTo?: string;
|
|
3655
|
+
includeExpired?: boolean;
|
|
3656
|
+
temporalMode?: SearchMemoriesGetTemporalMode;
|
|
3657
|
+
}
|
|
3609
3658
|
interface GetSimilarMemoriesParams {
|
|
3610
3659
|
limit?: number;
|
|
3611
3660
|
}
|
|
@@ -3775,109 +3824,6 @@ declare const createMemoryResponse: z.ZodLazy<z.ZodObject<{
|
|
|
3775
3824
|
*/
|
|
3776
3825
|
type CreateMemoryResponse = z.infer<typeof createMemoryResponse>;
|
|
3777
3826
|
|
|
3778
|
-
/**
|
|
3779
|
-
* Zod schema for the SearchRequest model.
|
|
3780
|
-
* Defines the structure and validation rules for this data type.
|
|
3781
|
-
* This is the shape used in application code - what developers interact with.
|
|
3782
|
-
*/
|
|
3783
|
-
declare const searchRequest: z.ZodLazy<z.ZodObject<{
|
|
3784
|
-
query: z.ZodString;
|
|
3785
|
-
mode: z.ZodOptional<z.ZodString>;
|
|
3786
|
-
searchMethod: z.ZodOptional<z.ZodString>;
|
|
3787
|
-
limit: z.ZodOptional<z.ZodNumber>;
|
|
3788
|
-
offset: z.ZodOptional<z.ZodNumber>;
|
|
3789
|
-
vectorWeight: z.ZodOptional<z.ZodNumber>;
|
|
3790
|
-
fulltextWeight: z.ZodOptional<z.ZodNumber>;
|
|
3791
|
-
threshold: z.ZodOptional<z.ZodNumber>;
|
|
3792
|
-
explain: z.ZodOptional<z.ZodBoolean>;
|
|
3793
|
-
asOfTime: z.ZodOptional<z.ZodString>;
|
|
3794
|
-
validAtTime: z.ZodOptional<z.ZodString>;
|
|
3795
|
-
eventTimeFrom: z.ZodOptional<z.ZodString>;
|
|
3796
|
-
eventTimeTo: z.ZodOptional<z.ZodString>;
|
|
3797
|
-
ingestionTimeFrom: z.ZodOptional<z.ZodString>;
|
|
3798
|
-
ingestionTimeTo: z.ZodOptional<z.ZodString>;
|
|
3799
|
-
includeExpired: z.ZodOptional<z.ZodBoolean>;
|
|
3800
|
-
temporalMode: z.ZodOptional<z.ZodString>;
|
|
3801
|
-
topics: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
3802
|
-
memoryType: z.ZodOptional<z.ZodString>;
|
|
3803
|
-
conversationId: z.ZodOptional<z.ZodString>;
|
|
3804
|
-
includeTopics: z.ZodOptional<z.ZodBoolean>;
|
|
3805
|
-
includeEntities: z.ZodOptional<z.ZodBoolean>;
|
|
3806
|
-
}, "strip", z.ZodTypeAny, {
|
|
3807
|
-
query: string;
|
|
3808
|
-
mode?: string | undefined;
|
|
3809
|
-
searchMethod?: string | undefined;
|
|
3810
|
-
limit?: number | undefined;
|
|
3811
|
-
offset?: number | undefined;
|
|
3812
|
-
vectorWeight?: number | undefined;
|
|
3813
|
-
fulltextWeight?: number | undefined;
|
|
3814
|
-
threshold?: number | undefined;
|
|
3815
|
-
explain?: boolean | undefined;
|
|
3816
|
-
asOfTime?: string | undefined;
|
|
3817
|
-
validAtTime?: string | undefined;
|
|
3818
|
-
eventTimeFrom?: string | undefined;
|
|
3819
|
-
eventTimeTo?: string | undefined;
|
|
3820
|
-
ingestionTimeFrom?: string | undefined;
|
|
3821
|
-
ingestionTimeTo?: string | undefined;
|
|
3822
|
-
includeExpired?: boolean | undefined;
|
|
3823
|
-
temporalMode?: string | undefined;
|
|
3824
|
-
topics?: string[] | undefined;
|
|
3825
|
-
memoryType?: string | undefined;
|
|
3826
|
-
conversationId?: string | undefined;
|
|
3827
|
-
includeTopics?: boolean | undefined;
|
|
3828
|
-
includeEntities?: boolean | undefined;
|
|
3829
|
-
}, {
|
|
3830
|
-
query: string;
|
|
3831
|
-
mode?: string | undefined;
|
|
3832
|
-
searchMethod?: string | undefined;
|
|
3833
|
-
limit?: number | undefined;
|
|
3834
|
-
offset?: number | undefined;
|
|
3835
|
-
vectorWeight?: number | undefined;
|
|
3836
|
-
fulltextWeight?: number | undefined;
|
|
3837
|
-
threshold?: number | undefined;
|
|
3838
|
-
explain?: boolean | undefined;
|
|
3839
|
-
asOfTime?: string | undefined;
|
|
3840
|
-
validAtTime?: string | undefined;
|
|
3841
|
-
eventTimeFrom?: string | undefined;
|
|
3842
|
-
eventTimeTo?: string | undefined;
|
|
3843
|
-
ingestionTimeFrom?: string | undefined;
|
|
3844
|
-
ingestionTimeTo?: string | undefined;
|
|
3845
|
-
includeExpired?: boolean | undefined;
|
|
3846
|
-
temporalMode?: string | undefined;
|
|
3847
|
-
topics?: string[] | undefined;
|
|
3848
|
-
memoryType?: string | undefined;
|
|
3849
|
-
conversationId?: string | undefined;
|
|
3850
|
-
includeTopics?: boolean | undefined;
|
|
3851
|
-
includeEntities?: boolean | undefined;
|
|
3852
|
-
}>>;
|
|
3853
|
-
/**
|
|
3854
|
-
*
|
|
3855
|
-
* @typedef {SearchRequest} searchRequest
|
|
3856
|
-
* @property {string} - Search query
|
|
3857
|
-
* @property {Mode} - Content filtering mode (defaults to unified)
|
|
3858
|
-
* @property {SearchMethod} - Search algorithm: hybrid (combined, default), semantic (vector), or keyword (fulltext).
|
|
3859
|
-
* @property {number} - Maximum number of results (defaults to 20)
|
|
3860
|
-
* @property {number} - Offset for pagination (defaults to 0)
|
|
3861
|
-
* @property {number} - Weight for vector (semantic) results in hybrid search (0-1, defaults to 0.7)
|
|
3862
|
-
* @property {number} - Weight for fulltext (keyword) results in hybrid search (0-1, defaults to 0.3)
|
|
3863
|
-
* @property {number} - Minimum similarity threshold for semantic search (0-1, defaults to 0.5)
|
|
3864
|
-
* @property {boolean} - If true, include detailed explanation of how each result was matched
|
|
3865
|
-
* @property {string} - Point-in-time query: show what the system knew at this time (ISO 8601 format)
|
|
3866
|
-
* @property {string} - Validity query: show facts that were valid at this time (ISO 8601 format)
|
|
3867
|
-
* @property {string} - Event time range start (ISO 8601 format)
|
|
3868
|
-
* @property {string} - Event time range end (ISO 8601 format)
|
|
3869
|
-
* @property {string} - Ingestion time range start (ISO 8601 format)
|
|
3870
|
-
* @property {string} - Ingestion time range end (ISO 8601 format)
|
|
3871
|
-
* @property {boolean} - Include expired facts (defaults to false)
|
|
3872
|
-
* @property {TemporalMode} - Temporal query mode: 'current' (only valid now), 'historical' (as of a point in time), 'evolution' (chronological)
|
|
3873
|
-
* @property {string[]} - Filter by topics - returns memories that have ANY of the specified topics
|
|
3874
|
-
* @property {SearchRequestMemoryType} - Filter by memory type
|
|
3875
|
-
* @property {string} - Filter by conversation ID
|
|
3876
|
-
* @property {boolean} - Include topics associated with matched memories (defaults to false for performance)
|
|
3877
|
-
* @property {boolean} - Include entities mentioned in matched memories (defaults to false for performance)
|
|
3878
|
-
*/
|
|
3879
|
-
type SearchRequest = z.infer<typeof searchRequest>;
|
|
3880
|
-
|
|
3881
3827
|
/**
|
|
3882
3828
|
* Zod schema for the SearchResponse model.
|
|
3883
3829
|
* Defines the structure and validation rules for this data type.
|
|
@@ -4082,10 +4028,9 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4082
4028
|
includeExpired: z.ZodBoolean;
|
|
4083
4029
|
temporalFieldsIncluded: z.ZodBoolean;
|
|
4084
4030
|
}, "strip", z.ZodTypeAny, {
|
|
4031
|
+
temporalMode: string;
|
|
4085
4032
|
asOfTime: string | null;
|
|
4086
4033
|
validAtTime: string | null;
|
|
4087
|
-
includeExpired: boolean;
|
|
4088
|
-
temporalMode: string;
|
|
4089
4034
|
eventTimeRange: {
|
|
4090
4035
|
from: string | null;
|
|
4091
4036
|
to: string | null;
|
|
@@ -4094,12 +4039,12 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4094
4039
|
from: string | null;
|
|
4095
4040
|
to: string | null;
|
|
4096
4041
|
} | null;
|
|
4042
|
+
includeExpired: boolean;
|
|
4097
4043
|
temporalFieldsIncluded: boolean;
|
|
4098
4044
|
}, {
|
|
4045
|
+
temporalMode: string;
|
|
4099
4046
|
asOfTime: string | null;
|
|
4100
4047
|
validAtTime: string | null;
|
|
4101
|
-
includeExpired: boolean;
|
|
4102
|
-
temporalMode: string;
|
|
4103
4048
|
eventTimeRange: {
|
|
4104
4049
|
from: string | null;
|
|
4105
4050
|
to: string | null;
|
|
@@ -4108,6 +4053,7 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4108
4053
|
from: string | null;
|
|
4109
4054
|
to: string | null;
|
|
4110
4055
|
} | null;
|
|
4056
|
+
includeExpired: boolean;
|
|
4111
4057
|
temporalFieldsIncluded: boolean;
|
|
4112
4058
|
}>>>;
|
|
4113
4059
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -4154,10 +4100,9 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4154
4100
|
} | undefined;
|
|
4155
4101
|
}[];
|
|
4156
4102
|
temporalMetadata: {
|
|
4103
|
+
temporalMode: string;
|
|
4157
4104
|
asOfTime: string | null;
|
|
4158
4105
|
validAtTime: string | null;
|
|
4159
|
-
includeExpired: boolean;
|
|
4160
|
-
temporalMode: string;
|
|
4161
4106
|
eventTimeRange: {
|
|
4162
4107
|
from: string | null;
|
|
4163
4108
|
to: string | null;
|
|
@@ -4166,6 +4111,7 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4166
4111
|
from: string | null;
|
|
4167
4112
|
to: string | null;
|
|
4168
4113
|
} | null;
|
|
4114
|
+
includeExpired: boolean;
|
|
4169
4115
|
temporalFieldsIncluded: boolean;
|
|
4170
4116
|
} | null;
|
|
4171
4117
|
searchMethod?: string | undefined;
|
|
@@ -4213,10 +4159,9 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4213
4159
|
} | undefined;
|
|
4214
4160
|
}[];
|
|
4215
4161
|
temporalMetadata: {
|
|
4162
|
+
temporalMode: string;
|
|
4216
4163
|
asOfTime: string | null;
|
|
4217
4164
|
validAtTime: string | null;
|
|
4218
|
-
includeExpired: boolean;
|
|
4219
|
-
temporalMode: string;
|
|
4220
4165
|
eventTimeRange: {
|
|
4221
4166
|
from: string | null;
|
|
4222
4167
|
to: string | null;
|
|
@@ -4225,6 +4170,7 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4225
4170
|
from: string | null;
|
|
4226
4171
|
to: string | null;
|
|
4227
4172
|
} | null;
|
|
4173
|
+
includeExpired: boolean;
|
|
4228
4174
|
temporalFieldsIncluded: boolean;
|
|
4229
4175
|
} | null;
|
|
4230
4176
|
searchMethod?: string | undefined;
|
|
@@ -4239,6 +4185,109 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4239
4185
|
*/
|
|
4240
4186
|
type SearchResponse = z.infer<typeof searchResponse>;
|
|
4241
4187
|
|
|
4188
|
+
/**
|
|
4189
|
+
* Zod schema for the SearchRequest model.
|
|
4190
|
+
* Defines the structure and validation rules for this data type.
|
|
4191
|
+
* This is the shape used in application code - what developers interact with.
|
|
4192
|
+
*/
|
|
4193
|
+
declare const searchRequest: z.ZodLazy<z.ZodObject<{
|
|
4194
|
+
query: z.ZodString;
|
|
4195
|
+
mode: z.ZodOptional<z.ZodString>;
|
|
4196
|
+
searchMethod: z.ZodOptional<z.ZodString>;
|
|
4197
|
+
limit: z.ZodOptional<z.ZodNumber>;
|
|
4198
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
4199
|
+
vectorWeight: z.ZodOptional<z.ZodNumber>;
|
|
4200
|
+
fulltextWeight: z.ZodOptional<z.ZodNumber>;
|
|
4201
|
+
threshold: z.ZodOptional<z.ZodNumber>;
|
|
4202
|
+
explain: z.ZodOptional<z.ZodBoolean>;
|
|
4203
|
+
asOfTime: z.ZodOptional<z.ZodString>;
|
|
4204
|
+
validAtTime: z.ZodOptional<z.ZodString>;
|
|
4205
|
+
eventTimeFrom: z.ZodOptional<z.ZodString>;
|
|
4206
|
+
eventTimeTo: z.ZodOptional<z.ZodString>;
|
|
4207
|
+
ingestionTimeFrom: z.ZodOptional<z.ZodString>;
|
|
4208
|
+
ingestionTimeTo: z.ZodOptional<z.ZodString>;
|
|
4209
|
+
includeExpired: z.ZodOptional<z.ZodBoolean>;
|
|
4210
|
+
temporalMode: z.ZodOptional<z.ZodString>;
|
|
4211
|
+
topics: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
4212
|
+
memoryType: z.ZodOptional<z.ZodString>;
|
|
4213
|
+
conversationId: z.ZodOptional<z.ZodString>;
|
|
4214
|
+
includeTopics: z.ZodOptional<z.ZodBoolean>;
|
|
4215
|
+
includeEntities: z.ZodOptional<z.ZodBoolean>;
|
|
4216
|
+
}, "strip", z.ZodTypeAny, {
|
|
4217
|
+
query: string;
|
|
4218
|
+
mode?: string | undefined;
|
|
4219
|
+
searchMethod?: string | undefined;
|
|
4220
|
+
limit?: number | undefined;
|
|
4221
|
+
offset?: number | undefined;
|
|
4222
|
+
vectorWeight?: number | undefined;
|
|
4223
|
+
fulltextWeight?: number | undefined;
|
|
4224
|
+
threshold?: number | undefined;
|
|
4225
|
+
explain?: boolean | undefined;
|
|
4226
|
+
asOfTime?: string | undefined;
|
|
4227
|
+
validAtTime?: string | undefined;
|
|
4228
|
+
eventTimeFrom?: string | undefined;
|
|
4229
|
+
eventTimeTo?: string | undefined;
|
|
4230
|
+
ingestionTimeFrom?: string | undefined;
|
|
4231
|
+
ingestionTimeTo?: string | undefined;
|
|
4232
|
+
includeExpired?: boolean | undefined;
|
|
4233
|
+
temporalMode?: string | undefined;
|
|
4234
|
+
topics?: string[] | undefined;
|
|
4235
|
+
memoryType?: string | undefined;
|
|
4236
|
+
conversationId?: string | undefined;
|
|
4237
|
+
includeTopics?: boolean | undefined;
|
|
4238
|
+
includeEntities?: boolean | undefined;
|
|
4239
|
+
}, {
|
|
4240
|
+
query: string;
|
|
4241
|
+
mode?: string | undefined;
|
|
4242
|
+
searchMethod?: string | undefined;
|
|
4243
|
+
limit?: number | undefined;
|
|
4244
|
+
offset?: number | undefined;
|
|
4245
|
+
vectorWeight?: number | undefined;
|
|
4246
|
+
fulltextWeight?: number | undefined;
|
|
4247
|
+
threshold?: number | undefined;
|
|
4248
|
+
explain?: boolean | undefined;
|
|
4249
|
+
asOfTime?: string | undefined;
|
|
4250
|
+
validAtTime?: string | undefined;
|
|
4251
|
+
eventTimeFrom?: string | undefined;
|
|
4252
|
+
eventTimeTo?: string | undefined;
|
|
4253
|
+
ingestionTimeFrom?: string | undefined;
|
|
4254
|
+
ingestionTimeTo?: string | undefined;
|
|
4255
|
+
includeExpired?: boolean | undefined;
|
|
4256
|
+
temporalMode?: string | undefined;
|
|
4257
|
+
topics?: string[] | undefined;
|
|
4258
|
+
memoryType?: string | undefined;
|
|
4259
|
+
conversationId?: string | undefined;
|
|
4260
|
+
includeTopics?: boolean | undefined;
|
|
4261
|
+
includeEntities?: boolean | undefined;
|
|
4262
|
+
}>>;
|
|
4263
|
+
/**
|
|
4264
|
+
*
|
|
4265
|
+
* @typedef {SearchRequest} searchRequest
|
|
4266
|
+
* @property {string} - Search query
|
|
4267
|
+
* @property {SearchRequestMode} - Content filtering mode (defaults to unified)
|
|
4268
|
+
* @property {SearchRequestSearchMethod} - Search algorithm: hybrid (combined, default), semantic (vector), or keyword (fulltext).
|
|
4269
|
+
* @property {number} - Maximum number of results (defaults to 20)
|
|
4270
|
+
* @property {number} - Offset for pagination (defaults to 0)
|
|
4271
|
+
* @property {number} - Weight for vector (semantic) results in hybrid search (0-1, defaults to 0.7)
|
|
4272
|
+
* @property {number} - Weight for fulltext (keyword) results in hybrid search (0-1, defaults to 0.3)
|
|
4273
|
+
* @property {number} - Minimum similarity threshold for semantic search (0-1, defaults to 0.5)
|
|
4274
|
+
* @property {boolean} - If true, include detailed explanation of how each result was matched
|
|
4275
|
+
* @property {string} - Point-in-time query: show what the system knew at this time (ISO 8601 format)
|
|
4276
|
+
* @property {string} - Validity query: show facts that were valid at this time (ISO 8601 format)
|
|
4277
|
+
* @property {string} - Event time range start (ISO 8601 format)
|
|
4278
|
+
* @property {string} - Event time range end (ISO 8601 format)
|
|
4279
|
+
* @property {string} - Ingestion time range start (ISO 8601 format)
|
|
4280
|
+
* @property {string} - Ingestion time range end (ISO 8601 format)
|
|
4281
|
+
* @property {boolean} - Include expired facts (defaults to false)
|
|
4282
|
+
* @property {SearchRequestTemporalMode} - Temporal query mode: 'current' (only valid now), 'historical' (as of a point in time), 'evolution' (chronological)
|
|
4283
|
+
* @property {string[]} - Filter by topics - returns memories that have ANY of the specified topics
|
|
4284
|
+
* @property {SearchRequestMemoryType} - Filter by memory type
|
|
4285
|
+
* @property {string} - Filter by conversation ID
|
|
4286
|
+
* @property {boolean} - Include topics associated with matched memories (defaults to false for performance)
|
|
4287
|
+
* @property {boolean} - Include entities mentioned in matched memories (defaults to false for performance)
|
|
4288
|
+
*/
|
|
4289
|
+
type SearchRequest = z.infer<typeof searchRequest>;
|
|
4290
|
+
|
|
4242
4291
|
/**
|
|
4243
4292
|
* Zod schema for the GetSimilarMemoriesOkResponse model.
|
|
4244
4293
|
* Defines the structure and validation rules for this data type.
|
|
@@ -4847,13 +4896,21 @@ declare class MemoriesService extends BaseService {
|
|
|
4847
4896
|
*/
|
|
4848
4897
|
deleteMemory(id: string, requestConfig?: RequestConfig): Promise<HttpResponse<void>>;
|
|
4849
4898
|
/**
|
|
4850
|
-
|
|
4851
|
-
|
|
4852
|
-
|
|
4853
|
-
|
|
4854
|
-
|
|
4855
|
-
|
|
4856
|
-
|
|
4899
|
+
* List all memories for the authenticated user with pagination.
|
|
4900
|
+
**ID Prefix Search:**
|
|
4901
|
+
Use the `idPrefix` parameter for git-style short ID lookup. This enables efficient
|
|
4902
|
+
server-side filtering instead of fetching all memories and filtering client-side.
|
|
4903
|
+
- Minimum 6 characters required for `idPrefix`
|
|
4904
|
+
- Returns matching memories directly (no need for secondary fetch)
|
|
4905
|
+
- Example: `?idPrefix=2d09116a` finds memories starting with that prefix
|
|
4906
|
+
|
|
4907
|
+
* @param {string} [params.idPrefix] - Filter memories by ID prefix (git-style short ID lookup). Minimum 6 characters.
|
|
4908
|
+
* @param {number} [params.limit] - Maximum number of memories to return
|
|
4909
|
+
* @param {number} [params.offset] - Number of memories to skip
|
|
4910
|
+
* @param {number} [params.page] - Page number (alternative to offset)
|
|
4911
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
4912
|
+
* @returns {Promise<HttpResponse<ListMemoriesOkResponse>>} - List of memories
|
|
4913
|
+
*/
|
|
4857
4914
|
listMemories(params?: ListMemoriesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListMemoriesOkResponse>>;
|
|
4858
4915
|
/**
|
|
4859
4916
|
* Create a new memory for the authenticated user.
|
|
@@ -4875,6 +4932,48 @@ declare class MemoriesService extends BaseService {
|
|
|
4875
4932
|
*/
|
|
4876
4933
|
createMemory(body: CreateMemoryRequest, requestConfig?: RequestConfig): Promise<HttpResponse<CreateMemoryResponse>>;
|
|
4877
4934
|
/**
|
|
4935
|
+
* Search memories using query parameters. Provides the same functionality asPOST /api/memories/search but accepts parameters via query string.
|
|
4936
|
+
|
|
4937
|
+
**Benefits of GET:**
|
|
4938
|
+
- Faster response times (~3x improvement)
|
|
4939
|
+
- Browser/CDN caching support
|
|
4940
|
+
- Simpler integration for read-only clients
|
|
4941
|
+
|
|
4942
|
+
**Search Methods:**
|
|
4943
|
+
- **hybrid** (default): Combines semantic and keyword search with Reciprocal Rank Fusion
|
|
4944
|
+
- **semantic**: Vector-based semantic search using OpenAI embeddings
|
|
4945
|
+
- **keyword**: Traditional fulltext search using Lucene
|
|
4946
|
+
|
|
4947
|
+
**Array Parameters:**
|
|
4948
|
+
- `topics`: Provide as comma-separated values (e.g., `topics=typescript,api-design`)
|
|
4949
|
+
|
|
4950
|
+
* @param {string} params.q - Search query string
|
|
4951
|
+
* @param {SearchMemoriesGetSearchMethod} [params.searchMethod] - Search algorithm to use
|
|
4952
|
+
* @param {number} [params.limit] - Maximum number of results to return
|
|
4953
|
+
* @param {number} [params.offset] - Number of results to skip for pagination
|
|
4954
|
+
* @param {number} [params.threshold] - Minimum similarity threshold for semantic search
|
|
4955
|
+
* @param {SearchMemoriesGetMode} [params.mode] - Content filtering mode
|
|
4956
|
+
* @param {number} [params.vectorWeight] - Weight for vector similarity in hybrid search
|
|
4957
|
+
* @param {number} [params.fulltextWeight] - Weight for fulltext matching in hybrid search
|
|
4958
|
+
* @param {string} [params.topics] - Comma-separated list of topics to filter by
|
|
4959
|
+
* @param {SearchMemoriesGetMemoryType} [params.memoryType] - Filter by memory type
|
|
4960
|
+
* @param {string} [params.conversationId] - Filter by conversation ID
|
|
4961
|
+
* @param {boolean} [params.explain] - Include detailed match explanations in results
|
|
4962
|
+
* @param {boolean} [params.includeTopics] - Include associated topics in results
|
|
4963
|
+
* @param {boolean} [params.includeEntities] - Include mentioned entities in results
|
|
4964
|
+
* @param {string} [params.asOfTime] - Point-in-time query (ISO 8601 datetime)
|
|
4965
|
+
* @param {string} [params.validAtTime] - Filter by validity time (ISO 8601 datetime)
|
|
4966
|
+
* @param {string} [params.eventTimeFrom] - Event time range start (ISO 8601 datetime)
|
|
4967
|
+
* @param {string} [params.eventTimeTo] - Event time range end (ISO 8601 datetime)
|
|
4968
|
+
* @param {string} [params.ingestionTimeFrom] - Ingestion time range start (ISO 8601 datetime)
|
|
4969
|
+
* @param {string} [params.ingestionTimeTo] - Ingestion time range end (ISO 8601 datetime)
|
|
4970
|
+
* @param {boolean} [params.includeExpired] - Include expired memories in results
|
|
4971
|
+
* @param {SearchMemoriesGetTemporalMode} [params.temporalMode] - Temporal query mode
|
|
4972
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
4973
|
+
* @returns {Promise<HttpResponse<SearchResponse>>} - Search results
|
|
4974
|
+
*/
|
|
4975
|
+
searchMemoriesGet(params: SearchMemoriesGetParams, requestConfig?: RequestConfig): Promise<HttpResponse<SearchResponse>>;
|
|
4976
|
+
/**
|
|
4878
4977
|
* Search memories using different search methods:- **hybrid** (default): Combines semantic and keyword search with Reciprocal Rank Fusion
|
|
4879
4978
|
- **semantic**: Vector-based semantic search using OpenAI embeddings
|
|
4880
4979
|
- **keyword**: Traditional fulltext search using Lucene
|
|
@@ -5387,10 +5486,9 @@ declare const temporalMetadata: z.ZodLazy<z.ZodObject<{
|
|
|
5387
5486
|
includeExpired: z.ZodBoolean;
|
|
5388
5487
|
temporalFieldsIncluded: z.ZodBoolean;
|
|
5389
5488
|
}, "strip", z.ZodTypeAny, {
|
|
5489
|
+
temporalMode: string;
|
|
5390
5490
|
asOfTime: string | null;
|
|
5391
5491
|
validAtTime: string | null;
|
|
5392
|
-
includeExpired: boolean;
|
|
5393
|
-
temporalMode: string;
|
|
5394
5492
|
eventTimeRange: {
|
|
5395
5493
|
from: string | null;
|
|
5396
5494
|
to: string | null;
|
|
@@ -5399,12 +5497,12 @@ declare const temporalMetadata: z.ZodLazy<z.ZodObject<{
|
|
|
5399
5497
|
from: string | null;
|
|
5400
5498
|
to: string | null;
|
|
5401
5499
|
} | null;
|
|
5500
|
+
includeExpired: boolean;
|
|
5402
5501
|
temporalFieldsIncluded: boolean;
|
|
5403
5502
|
}, {
|
|
5503
|
+
temporalMode: string;
|
|
5404
5504
|
asOfTime: string | null;
|
|
5405
5505
|
validAtTime: string | null;
|
|
5406
|
-
includeExpired: boolean;
|
|
5407
|
-
temporalMode: string;
|
|
5408
5506
|
eventTimeRange: {
|
|
5409
5507
|
from: string | null;
|
|
5410
5508
|
to: string | null;
|
|
@@ -5413,6 +5511,7 @@ declare const temporalMetadata: z.ZodLazy<z.ZodObject<{
|
|
|
5413
5511
|
from: string | null;
|
|
5414
5512
|
to: string | null;
|
|
5415
5513
|
} | null;
|
|
5514
|
+
includeExpired: boolean;
|
|
5416
5515
|
temporalFieldsIncluded: boolean;
|
|
5417
5516
|
}>>;
|
|
5418
5517
|
/**
|
|
@@ -5474,19 +5573,19 @@ declare const ingestionTimeRange: z.ZodLazy<z.ZodObject<{
|
|
|
5474
5573
|
*/
|
|
5475
5574
|
type IngestionTimeRange = z.infer<typeof ingestionTimeRange>;
|
|
5476
5575
|
|
|
5477
|
-
declare enum
|
|
5576
|
+
declare enum SearchRequestMode {
|
|
5478
5577
|
UNIFIED = "unified",
|
|
5479
5578
|
CONTENT = "content",
|
|
5480
5579
|
FACTS = "facts"
|
|
5481
5580
|
}
|
|
5482
5581
|
|
|
5483
|
-
declare enum
|
|
5582
|
+
declare enum SearchRequestSearchMethod {
|
|
5484
5583
|
KEYWORD = "keyword",
|
|
5485
5584
|
SEMANTIC = "semantic",
|
|
5486
5585
|
HYBRID = "hybrid"
|
|
5487
5586
|
}
|
|
5488
5587
|
|
|
5489
|
-
declare enum
|
|
5588
|
+
declare enum SearchRequestTemporalMode {
|
|
5490
5589
|
CURRENT = "current",
|
|
5491
5590
|
HISTORICAL = "historical",
|
|
5492
5591
|
EVOLUTION = "evolution"
|
|
@@ -8435,4 +8534,4 @@ declare class Memnexus {
|
|
|
8435
8534
|
set token(token: string);
|
|
8436
8535
|
}
|
|
8437
8536
|
|
|
8438
|
-
export { Analysis, AnalyzeMemoryQualityOkResponse, AnalyzeMemoryQualityOkResponseData, AnalyzePatternsOkResponse, AnalyzePatternsOkResponseData, AnalyzePatternsRequest, ApiKey, ApiKeysService, Artifact, ArtifactsService, BehaviorService, CalculateTopicSimilarityOkResponse, CalculateTopicSimilarityOkResponseData, CalculateTopicSimilarityRequest, ClusterTopicsOkResponse, ClusterTopicsOkResponseData, ClusterTopicsRequest, CommunitiesService, Community, CompilePatternsOkResponse, CompilePatternsRequest, Confidence, Conversation, ConversationsService, CreateApiKeyCreatedResponse, CreateApiKeyCreatedResponseData, CreateApiKeyRequest, CreateArtifactCreatedResponse, CreateArtifactRequest, CreateConversationCreatedResponse, CreateConversationRequest, CreateFactCreatedResponse, CreateFactRequest, CreateMemoryRequest, CreateMemoryRequestMemoryType, CreateMemoryResponse, CreateMemoryResponseMeta, DataMemory, DataStatus, DebugUserOkResponse, DebugUserOkResponseData, DetectCommunitiesOkResponse, DetectCommunitiesOkResponseData, DetectCommunitiesRequest, DetectPatternsOkResponse, DetectPatternsOkResponseData, DetectPatternsRequest, DiscoverRelatedTopicsOkResponse, DiscoverRelatedTopicsRequest, Entity, Environment, Error$1 as Error, EvaluateFeatureFlagOkResponse, EvaluateFeatureFlagOkResponseData, EvaluateFeatureFlagRequest, EventTimeRange, ExecuteGraphRagQueryOkResponse, ExplainGraphRagQueryOkResponse, Explanation, Fact, FactSearchRequest, FactsService, FindConversationsByTopicOkResponse, FindConversationsByTopicOkResponseMetadata, FindConversationsByTopicRequest, FindSimilarTopicsOkResponse, FindSimilarTopicsOkResponseData, FindSimilarTopicsRequest, GetArtifactByIdOkResponse, GetBehavioralStateOkResponse, GetCommunityByIdOkResponse, GetContextStatusOkResponse, GetConversationMemoriesOkResponse, GetConversationSummaryOkResponse, GetConversationTimelineOkResponse, GetFactByIdOkResponse, GetFeatureFlagsOkResponse, GetMemoryResponse, GetRelatedMemoriesOkResponse, GetRelatedMemoriesOkResponseData, GetSimilarMemoriesOkResponse, GetSystemHealthOkResponse, GetSystemHealthOkResponseData, GetTopicByIdOkResponse, GraphRagQueryRequest, GraphRagQueryResponse, GraphRagQueryResponseMetadata, GraphRagService, GroupBy, HealthCheck, HealthCheckStatus, HealthService, HttpError, HttpMetadata, HttpMethod, HttpResponse, IngestionTimeRange, ListApiKeysOkResponse, ListArtifactsOkResponse, ListCommunitiesOkResponse, ListCommunitiesOkResponsePagination, ListConversationsOkResponse, ListConversationsOkResponsePagination, ListFactsOkResponse, ListMemoriesOkResponse, ListPatternsOkResponse, ListPatternsOkResponsePagination, ListTopicsOkResponse, ListTopicsOkResponsePagination, Memnexus, MemoriesService, Memory, MemoryMemoryType1, MemoryMemoryType2, MemoryMemoryType3, MemoryMemoryType4, MergeCommunitiesOkResponse, MergeCommunitiesRequest, MergeTopicsOkResponse, MergeTopicsRequest,
|
|
8537
|
+
export { Analysis, AnalyzeMemoryQualityOkResponse, AnalyzeMemoryQualityOkResponseData, AnalyzePatternsOkResponse, AnalyzePatternsOkResponseData, AnalyzePatternsRequest, ApiKey, ApiKeysService, Artifact, ArtifactsService, BehaviorService, CalculateTopicSimilarityOkResponse, CalculateTopicSimilarityOkResponseData, CalculateTopicSimilarityRequest, ClusterTopicsOkResponse, ClusterTopicsOkResponseData, ClusterTopicsRequest, CommunitiesService, Community, CompilePatternsOkResponse, CompilePatternsRequest, Confidence, Conversation, ConversationsService, CreateApiKeyCreatedResponse, CreateApiKeyCreatedResponseData, CreateApiKeyRequest, CreateArtifactCreatedResponse, CreateArtifactRequest, CreateConversationCreatedResponse, CreateConversationRequest, CreateFactCreatedResponse, CreateFactRequest, CreateMemoryRequest, CreateMemoryRequestMemoryType, CreateMemoryResponse, CreateMemoryResponseMeta, DataMemory, DataStatus, DebugUserOkResponse, DebugUserOkResponseData, DetectCommunitiesOkResponse, DetectCommunitiesOkResponseData, DetectCommunitiesRequest, DetectPatternsOkResponse, DetectPatternsOkResponseData, DetectPatternsRequest, DiscoverRelatedTopicsOkResponse, DiscoverRelatedTopicsRequest, Entity, Environment, Error$1 as Error, EvaluateFeatureFlagOkResponse, EvaluateFeatureFlagOkResponseData, EvaluateFeatureFlagRequest, EventTimeRange, ExecuteGraphRagQueryOkResponse, ExplainGraphRagQueryOkResponse, Explanation, Fact, FactSearchRequest, FactsService, FindConversationsByTopicOkResponse, FindConversationsByTopicOkResponseMetadata, FindConversationsByTopicRequest, FindSimilarTopicsOkResponse, FindSimilarTopicsOkResponseData, FindSimilarTopicsRequest, GetArtifactByIdOkResponse, GetBehavioralStateOkResponse, GetCommunityByIdOkResponse, GetContextStatusOkResponse, GetConversationMemoriesOkResponse, GetConversationSummaryOkResponse, GetConversationTimelineOkResponse, GetFactByIdOkResponse, GetFeatureFlagsOkResponse, GetMemoryResponse, GetRelatedMemoriesOkResponse, GetRelatedMemoriesOkResponseData, GetSimilarMemoriesOkResponse, GetSystemHealthOkResponse, GetSystemHealthOkResponseData, GetTopicByIdOkResponse, GraphRagQueryRequest, GraphRagQueryResponse, GraphRagQueryResponseMetadata, GraphRagService, GroupBy, HealthCheck, HealthCheckStatus, HealthService, HttpError, HttpMetadata, HttpMethod, HttpResponse, IngestionTimeRange, ListApiKeysOkResponse, ListArtifactsOkResponse, ListCommunitiesOkResponse, ListCommunitiesOkResponsePagination, ListConversationsOkResponse, ListConversationsOkResponsePagination, ListFactsOkResponse, ListMemoriesOkResponse, ListPatternsOkResponse, ListPatternsOkResponsePagination, ListTopicsOkResponse, ListTopicsOkResponsePagination, Memnexus, MemoriesService, Memory, MemoryMemoryType1, MemoryMemoryType2, MemoryMemoryType3, MemoryMemoryType4, MergeCommunitiesOkResponse, MergeCommunitiesRequest, MergeTopicsOkResponse, MergeTopicsRequest, NoCache, Pagination, Pattern, PatternsService, PruneMemoriesOkResponse, PruneMemoriesOkResponseData, PruneMemoriesRequest, QualityDistribution, QueryCommunitiesOkResponse, QueryCommunitiesRequest, RecordPatternFeedbackOkResponse, RecordPatternFeedbackRequest, RelatedMemoryResult, RelatedMemoryResultMemory, RequestConfig, Results, RetryOptions, Role, SdkConfig, SearchConversationsOkResponse, SearchConversationsRequest, SearchFactsOkResponse, SearchFactsOkResponseMetadata, SearchMemoriesGetMemoryType, SearchMemoriesGetMode, SearchMemoriesGetSearchMethod, SearchMemoriesGetTemporalMode, SearchRequest, SearchRequestMemoryType, SearchRequestMode, SearchRequestSearchMethod, SearchRequestTemporalMode, SearchResponse, SearchResponsePagination, SearchResult, SearchResultMemory, SearchTopicsOkResponse, SearchTopicsRequest, ServiceCheck, ServiceCheckStatus, SystemService, TemporalMetadata, Topic, TopicReference, TopicsService, UpdateArtifactOkResponse, UpdateArtifactRequest, UpdateBehavioralStateOkResponse, UpdateBehavioralStateRequest, UpdateFactOkResponse, UpdateFactRequest, UpdateMemoryOkResponse, UpdateMemoryRequest, UpdateMemoryRequestMemoryType, UpdatePatternOkResponse, UpdatePatternRequest, ValidationOptions };
|