@memnexus-ai/typescript-sdk 1.10.2 → 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 +209 -119
- package/dist/index.js +526 -355
- package/dist/index.mjs +519 -352
- 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,12 +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 {
|
|
3605
3629
|
idPrefix?: string;
|
|
3606
3630
|
limit?: number;
|
|
3607
3631
|
offset?: number;
|
|
3608
3632
|
page?: number;
|
|
3609
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
|
+
}
|
|
3610
3658
|
interface GetSimilarMemoriesParams {
|
|
3611
3659
|
limit?: number;
|
|
3612
3660
|
}
|
|
@@ -3776,109 +3824,6 @@ declare const createMemoryResponse: z.ZodLazy<z.ZodObject<{
|
|
|
3776
3824
|
*/
|
|
3777
3825
|
type CreateMemoryResponse = z.infer<typeof createMemoryResponse>;
|
|
3778
3826
|
|
|
3779
|
-
/**
|
|
3780
|
-
* Zod schema for the SearchRequest model.
|
|
3781
|
-
* Defines the structure and validation rules for this data type.
|
|
3782
|
-
* This is the shape used in application code - what developers interact with.
|
|
3783
|
-
*/
|
|
3784
|
-
declare const searchRequest: z.ZodLazy<z.ZodObject<{
|
|
3785
|
-
query: z.ZodString;
|
|
3786
|
-
mode: z.ZodOptional<z.ZodString>;
|
|
3787
|
-
searchMethod: z.ZodOptional<z.ZodString>;
|
|
3788
|
-
limit: z.ZodOptional<z.ZodNumber>;
|
|
3789
|
-
offset: z.ZodOptional<z.ZodNumber>;
|
|
3790
|
-
vectorWeight: z.ZodOptional<z.ZodNumber>;
|
|
3791
|
-
fulltextWeight: z.ZodOptional<z.ZodNumber>;
|
|
3792
|
-
threshold: z.ZodOptional<z.ZodNumber>;
|
|
3793
|
-
explain: z.ZodOptional<z.ZodBoolean>;
|
|
3794
|
-
asOfTime: z.ZodOptional<z.ZodString>;
|
|
3795
|
-
validAtTime: z.ZodOptional<z.ZodString>;
|
|
3796
|
-
eventTimeFrom: z.ZodOptional<z.ZodString>;
|
|
3797
|
-
eventTimeTo: z.ZodOptional<z.ZodString>;
|
|
3798
|
-
ingestionTimeFrom: z.ZodOptional<z.ZodString>;
|
|
3799
|
-
ingestionTimeTo: z.ZodOptional<z.ZodString>;
|
|
3800
|
-
includeExpired: z.ZodOptional<z.ZodBoolean>;
|
|
3801
|
-
temporalMode: z.ZodOptional<z.ZodString>;
|
|
3802
|
-
topics: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
3803
|
-
memoryType: z.ZodOptional<z.ZodString>;
|
|
3804
|
-
conversationId: z.ZodOptional<z.ZodString>;
|
|
3805
|
-
includeTopics: z.ZodOptional<z.ZodBoolean>;
|
|
3806
|
-
includeEntities: z.ZodOptional<z.ZodBoolean>;
|
|
3807
|
-
}, "strip", z.ZodTypeAny, {
|
|
3808
|
-
query: string;
|
|
3809
|
-
mode?: string | undefined;
|
|
3810
|
-
searchMethod?: string | undefined;
|
|
3811
|
-
limit?: number | undefined;
|
|
3812
|
-
offset?: number | undefined;
|
|
3813
|
-
vectorWeight?: number | undefined;
|
|
3814
|
-
fulltextWeight?: number | undefined;
|
|
3815
|
-
threshold?: number | undefined;
|
|
3816
|
-
explain?: boolean | undefined;
|
|
3817
|
-
asOfTime?: string | undefined;
|
|
3818
|
-
validAtTime?: string | undefined;
|
|
3819
|
-
eventTimeFrom?: string | undefined;
|
|
3820
|
-
eventTimeTo?: string | undefined;
|
|
3821
|
-
ingestionTimeFrom?: string | undefined;
|
|
3822
|
-
ingestionTimeTo?: string | undefined;
|
|
3823
|
-
includeExpired?: boolean | undefined;
|
|
3824
|
-
temporalMode?: string | undefined;
|
|
3825
|
-
topics?: string[] | undefined;
|
|
3826
|
-
memoryType?: string | undefined;
|
|
3827
|
-
conversationId?: string | undefined;
|
|
3828
|
-
includeTopics?: boolean | undefined;
|
|
3829
|
-
includeEntities?: boolean | undefined;
|
|
3830
|
-
}, {
|
|
3831
|
-
query: string;
|
|
3832
|
-
mode?: string | undefined;
|
|
3833
|
-
searchMethod?: string | undefined;
|
|
3834
|
-
limit?: number | undefined;
|
|
3835
|
-
offset?: number | undefined;
|
|
3836
|
-
vectorWeight?: number | undefined;
|
|
3837
|
-
fulltextWeight?: number | undefined;
|
|
3838
|
-
threshold?: number | undefined;
|
|
3839
|
-
explain?: boolean | undefined;
|
|
3840
|
-
asOfTime?: string | undefined;
|
|
3841
|
-
validAtTime?: string | undefined;
|
|
3842
|
-
eventTimeFrom?: string | undefined;
|
|
3843
|
-
eventTimeTo?: string | undefined;
|
|
3844
|
-
ingestionTimeFrom?: string | undefined;
|
|
3845
|
-
ingestionTimeTo?: string | undefined;
|
|
3846
|
-
includeExpired?: boolean | undefined;
|
|
3847
|
-
temporalMode?: string | undefined;
|
|
3848
|
-
topics?: string[] | undefined;
|
|
3849
|
-
memoryType?: string | undefined;
|
|
3850
|
-
conversationId?: string | undefined;
|
|
3851
|
-
includeTopics?: boolean | undefined;
|
|
3852
|
-
includeEntities?: boolean | undefined;
|
|
3853
|
-
}>>;
|
|
3854
|
-
/**
|
|
3855
|
-
*
|
|
3856
|
-
* @typedef {SearchRequest} searchRequest
|
|
3857
|
-
* @property {string} - Search query
|
|
3858
|
-
* @property {Mode} - Content filtering mode (defaults to unified)
|
|
3859
|
-
* @property {SearchMethod} - Search algorithm: hybrid (combined, default), semantic (vector), or keyword (fulltext).
|
|
3860
|
-
* @property {number} - Maximum number of results (defaults to 20)
|
|
3861
|
-
* @property {number} - Offset for pagination (defaults to 0)
|
|
3862
|
-
* @property {number} - Weight for vector (semantic) results in hybrid search (0-1, defaults to 0.7)
|
|
3863
|
-
* @property {number} - Weight for fulltext (keyword) results in hybrid search (0-1, defaults to 0.3)
|
|
3864
|
-
* @property {number} - Minimum similarity threshold for semantic search (0-1, defaults to 0.5)
|
|
3865
|
-
* @property {boolean} - If true, include detailed explanation of how each result was matched
|
|
3866
|
-
* @property {string} - Point-in-time query: show what the system knew at this time (ISO 8601 format)
|
|
3867
|
-
* @property {string} - Validity query: show facts that were valid at this time (ISO 8601 format)
|
|
3868
|
-
* @property {string} - Event time range start (ISO 8601 format)
|
|
3869
|
-
* @property {string} - Event time range end (ISO 8601 format)
|
|
3870
|
-
* @property {string} - Ingestion time range start (ISO 8601 format)
|
|
3871
|
-
* @property {string} - Ingestion time range end (ISO 8601 format)
|
|
3872
|
-
* @property {boolean} - Include expired facts (defaults to false)
|
|
3873
|
-
* @property {TemporalMode} - Temporal query mode: 'current' (only valid now), 'historical' (as of a point in time), 'evolution' (chronological)
|
|
3874
|
-
* @property {string[]} - Filter by topics - returns memories that have ANY of the specified topics
|
|
3875
|
-
* @property {SearchRequestMemoryType} - Filter by memory type
|
|
3876
|
-
* @property {string} - Filter by conversation ID
|
|
3877
|
-
* @property {boolean} - Include topics associated with matched memories (defaults to false for performance)
|
|
3878
|
-
* @property {boolean} - Include entities mentioned in matched memories (defaults to false for performance)
|
|
3879
|
-
*/
|
|
3880
|
-
type SearchRequest = z.infer<typeof searchRequest>;
|
|
3881
|
-
|
|
3882
3827
|
/**
|
|
3883
3828
|
* Zod schema for the SearchResponse model.
|
|
3884
3829
|
* Defines the structure and validation rules for this data type.
|
|
@@ -4083,10 +4028,9 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4083
4028
|
includeExpired: z.ZodBoolean;
|
|
4084
4029
|
temporalFieldsIncluded: z.ZodBoolean;
|
|
4085
4030
|
}, "strip", z.ZodTypeAny, {
|
|
4031
|
+
temporalMode: string;
|
|
4086
4032
|
asOfTime: string | null;
|
|
4087
4033
|
validAtTime: string | null;
|
|
4088
|
-
includeExpired: boolean;
|
|
4089
|
-
temporalMode: string;
|
|
4090
4034
|
eventTimeRange: {
|
|
4091
4035
|
from: string | null;
|
|
4092
4036
|
to: string | null;
|
|
@@ -4095,12 +4039,12 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4095
4039
|
from: string | null;
|
|
4096
4040
|
to: string | null;
|
|
4097
4041
|
} | null;
|
|
4042
|
+
includeExpired: boolean;
|
|
4098
4043
|
temporalFieldsIncluded: boolean;
|
|
4099
4044
|
}, {
|
|
4045
|
+
temporalMode: string;
|
|
4100
4046
|
asOfTime: string | null;
|
|
4101
4047
|
validAtTime: string | null;
|
|
4102
|
-
includeExpired: boolean;
|
|
4103
|
-
temporalMode: string;
|
|
4104
4048
|
eventTimeRange: {
|
|
4105
4049
|
from: string | null;
|
|
4106
4050
|
to: string | null;
|
|
@@ -4109,6 +4053,7 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4109
4053
|
from: string | null;
|
|
4110
4054
|
to: string | null;
|
|
4111
4055
|
} | null;
|
|
4056
|
+
includeExpired: boolean;
|
|
4112
4057
|
temporalFieldsIncluded: boolean;
|
|
4113
4058
|
}>>>;
|
|
4114
4059
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -4155,10 +4100,9 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4155
4100
|
} | undefined;
|
|
4156
4101
|
}[];
|
|
4157
4102
|
temporalMetadata: {
|
|
4103
|
+
temporalMode: string;
|
|
4158
4104
|
asOfTime: string | null;
|
|
4159
4105
|
validAtTime: string | null;
|
|
4160
|
-
includeExpired: boolean;
|
|
4161
|
-
temporalMode: string;
|
|
4162
4106
|
eventTimeRange: {
|
|
4163
4107
|
from: string | null;
|
|
4164
4108
|
to: string | null;
|
|
@@ -4167,6 +4111,7 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4167
4111
|
from: string | null;
|
|
4168
4112
|
to: string | null;
|
|
4169
4113
|
} | null;
|
|
4114
|
+
includeExpired: boolean;
|
|
4170
4115
|
temporalFieldsIncluded: boolean;
|
|
4171
4116
|
} | null;
|
|
4172
4117
|
searchMethod?: string | undefined;
|
|
@@ -4214,10 +4159,9 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4214
4159
|
} | undefined;
|
|
4215
4160
|
}[];
|
|
4216
4161
|
temporalMetadata: {
|
|
4162
|
+
temporalMode: string;
|
|
4217
4163
|
asOfTime: string | null;
|
|
4218
4164
|
validAtTime: string | null;
|
|
4219
|
-
includeExpired: boolean;
|
|
4220
|
-
temporalMode: string;
|
|
4221
4165
|
eventTimeRange: {
|
|
4222
4166
|
from: string | null;
|
|
4223
4167
|
to: string | null;
|
|
@@ -4226,6 +4170,7 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4226
4170
|
from: string | null;
|
|
4227
4171
|
to: string | null;
|
|
4228
4172
|
} | null;
|
|
4173
|
+
includeExpired: boolean;
|
|
4229
4174
|
temporalFieldsIncluded: boolean;
|
|
4230
4175
|
} | null;
|
|
4231
4176
|
searchMethod?: string | undefined;
|
|
@@ -4240,6 +4185,109 @@ declare const searchResponse: z.ZodLazy<z.ZodObject<{
|
|
|
4240
4185
|
*/
|
|
4241
4186
|
type SearchResponse = z.infer<typeof searchResponse>;
|
|
4242
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
|
+
|
|
4243
4291
|
/**
|
|
4244
4292
|
* Zod schema for the GetSimilarMemoriesOkResponse model.
|
|
4245
4293
|
* Defines the structure and validation rules for this data type.
|
|
@@ -4884,6 +4932,48 @@ declare class MemoriesService extends BaseService {
|
|
|
4884
4932
|
*/
|
|
4885
4933
|
createMemory(body: CreateMemoryRequest, requestConfig?: RequestConfig): Promise<HttpResponse<CreateMemoryResponse>>;
|
|
4886
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
|
+
/**
|
|
4887
4977
|
* Search memories using different search methods:- **hybrid** (default): Combines semantic and keyword search with Reciprocal Rank Fusion
|
|
4888
4978
|
- **semantic**: Vector-based semantic search using OpenAI embeddings
|
|
4889
4979
|
- **keyword**: Traditional fulltext search using Lucene
|
|
@@ -5396,10 +5486,9 @@ declare const temporalMetadata: z.ZodLazy<z.ZodObject<{
|
|
|
5396
5486
|
includeExpired: z.ZodBoolean;
|
|
5397
5487
|
temporalFieldsIncluded: z.ZodBoolean;
|
|
5398
5488
|
}, "strip", z.ZodTypeAny, {
|
|
5489
|
+
temporalMode: string;
|
|
5399
5490
|
asOfTime: string | null;
|
|
5400
5491
|
validAtTime: string | null;
|
|
5401
|
-
includeExpired: boolean;
|
|
5402
|
-
temporalMode: string;
|
|
5403
5492
|
eventTimeRange: {
|
|
5404
5493
|
from: string | null;
|
|
5405
5494
|
to: string | null;
|
|
@@ -5408,12 +5497,12 @@ declare const temporalMetadata: z.ZodLazy<z.ZodObject<{
|
|
|
5408
5497
|
from: string | null;
|
|
5409
5498
|
to: string | null;
|
|
5410
5499
|
} | null;
|
|
5500
|
+
includeExpired: boolean;
|
|
5411
5501
|
temporalFieldsIncluded: boolean;
|
|
5412
5502
|
}, {
|
|
5503
|
+
temporalMode: string;
|
|
5413
5504
|
asOfTime: string | null;
|
|
5414
5505
|
validAtTime: string | null;
|
|
5415
|
-
includeExpired: boolean;
|
|
5416
|
-
temporalMode: string;
|
|
5417
5506
|
eventTimeRange: {
|
|
5418
5507
|
from: string | null;
|
|
5419
5508
|
to: string | null;
|
|
@@ -5422,6 +5511,7 @@ declare const temporalMetadata: z.ZodLazy<z.ZodObject<{
|
|
|
5422
5511
|
from: string | null;
|
|
5423
5512
|
to: string | null;
|
|
5424
5513
|
} | null;
|
|
5514
|
+
includeExpired: boolean;
|
|
5425
5515
|
temporalFieldsIncluded: boolean;
|
|
5426
5516
|
}>>;
|
|
5427
5517
|
/**
|
|
@@ -5483,19 +5573,19 @@ declare const ingestionTimeRange: z.ZodLazy<z.ZodObject<{
|
|
|
5483
5573
|
*/
|
|
5484
5574
|
type IngestionTimeRange = z.infer<typeof ingestionTimeRange>;
|
|
5485
5575
|
|
|
5486
|
-
declare enum
|
|
5576
|
+
declare enum SearchRequestMode {
|
|
5487
5577
|
UNIFIED = "unified",
|
|
5488
5578
|
CONTENT = "content",
|
|
5489
5579
|
FACTS = "facts"
|
|
5490
5580
|
}
|
|
5491
5581
|
|
|
5492
|
-
declare enum
|
|
5582
|
+
declare enum SearchRequestSearchMethod {
|
|
5493
5583
|
KEYWORD = "keyword",
|
|
5494
5584
|
SEMANTIC = "semantic",
|
|
5495
5585
|
HYBRID = "hybrid"
|
|
5496
5586
|
}
|
|
5497
5587
|
|
|
5498
|
-
declare enum
|
|
5588
|
+
declare enum SearchRequestTemporalMode {
|
|
5499
5589
|
CURRENT = "current",
|
|
5500
5590
|
HISTORICAL = "historical",
|
|
5501
5591
|
EVOLUTION = "evolution"
|
|
@@ -8444,4 +8534,4 @@ declare class Memnexus {
|
|
|
8444
8534
|
set token(token: string);
|
|
8445
8535
|
}
|
|
8446
8536
|
|
|
8447
|
-
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 };
|