@getzep/zep-cloud 2.7.0 → 2.8.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/Client.d.ts +3 -3
- package/Client.js +6 -6
- package/api/resources/document/client/Client.js +13 -13
- package/api/resources/graph/client/Client.d.ts +30 -0
- package/api/resources/graph/client/Client.js +157 -4
- package/api/resources/graph/client/requests/EntityTypeRequest.d.ts +16 -0
- package/api/resources/graph/client/requests/EntityTypeRequest.js +5 -0
- package/api/resources/graph/client/requests/GraphSearchQuery.d.ts +2 -0
- package/api/resources/graph/client/requests/index.d.ts +1 -0
- package/api/resources/graph/resources/edge/client/Client.js +4 -4
- package/api/resources/graph/resources/episode/client/Client.js +5 -5
- package/api/resources/graph/resources/node/client/Client.js +3 -3
- package/api/resources/group/client/Client.js +6 -6
- package/api/resources/index.d.ts +2 -2
- package/api/resources/index.js +3 -3
- package/api/resources/memory/client/Client.js +22 -22
- package/api/resources/user/client/Client.js +8 -8
- package/api/types/EntityProperty.d.ts +9 -0
- package/api/types/EntityProperty.js +5 -0
- package/api/types/EntityPropertyType.d.ts +10 -0
- package/api/types/EntityPropertyType.js +12 -0
- package/api/types/EntityType.d.ts +9 -0
- package/api/types/EntityType.js +5 -0
- package/api/types/EntityTypeResponse.d.ts +7 -0
- package/api/types/EntityTypeResponse.js +5 -0
- package/api/types/index.d.ts +4 -0
- package/api/types/index.js +4 -0
- package/dist/Client.d.ts +3 -3
- package/dist/Client.js +6 -6
- package/dist/api/resources/document/client/Client.js +13 -13
- package/dist/api/resources/graph/client/Client.d.ts +30 -0
- package/dist/api/resources/graph/client/Client.js +157 -4
- package/dist/api/resources/graph/client/requests/EntityTypeRequest.d.ts +16 -0
- package/dist/api/resources/graph/client/requests/EntityTypeRequest.js +5 -0
- package/dist/api/resources/graph/client/requests/GraphSearchQuery.d.ts +2 -0
- package/dist/api/resources/graph/client/requests/index.d.ts +1 -0
- package/dist/api/resources/graph/resources/edge/client/Client.js +4 -4
- package/dist/api/resources/graph/resources/episode/client/Client.js +5 -5
- package/dist/api/resources/graph/resources/node/client/Client.js +3 -3
- package/dist/api/resources/group/client/Client.js +6 -6
- package/dist/api/resources/index.d.ts +2 -2
- package/dist/api/resources/index.js +3 -3
- package/dist/api/resources/memory/client/Client.js +22 -22
- package/dist/api/resources/user/client/Client.js +8 -8
- package/dist/api/types/EntityProperty.d.ts +9 -0
- package/dist/api/types/EntityProperty.js +5 -0
- package/dist/api/types/EntityPropertyType.d.ts +10 -0
- package/dist/api/types/EntityPropertyType.js +12 -0
- package/dist/api/types/EntityType.d.ts +9 -0
- package/dist/api/types/EntityType.js +5 -0
- package/dist/api/types/EntityTypeResponse.d.ts +7 -0
- package/dist/api/types/EntityTypeResponse.js +5 -0
- package/dist/api/types/index.d.ts +4 -0
- package/dist/api/types/index.js +4 -0
- package/dist/serialization/resources/graph/client/requests/EntityTypeRequest.d.ts +13 -0
- package/dist/serialization/resources/graph/client/requests/EntityTypeRequest.js +44 -0
- package/dist/serialization/resources/graph/client/requests/GraphSearchQuery.d.ts +1 -0
- package/dist/serialization/resources/graph/client/requests/GraphSearchQuery.js +1 -0
- package/dist/serialization/resources/graph/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/graph/client/requests/index.js +3 -1
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +1 -1
- package/dist/serialization/types/EntityProperty.d.ts +15 -0
- package/dist/serialization/types/EntityProperty.js +46 -0
- package/dist/serialization/types/EntityPropertyType.d.ts +10 -0
- package/dist/serialization/types/EntityPropertyType.js +41 -0
- package/dist/serialization/types/EntityType.d.ts +15 -0
- package/dist/serialization/types/EntityType.js +46 -0
- package/dist/serialization/types/EntityTypeResponse.d.ts +13 -0
- package/dist/serialization/types/EntityTypeResponse.js +44 -0
- package/dist/serialization/types/index.d.ts +4 -0
- package/dist/serialization/types/index.js +4 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/graph.d.ts +6 -0
- package/dist/wrapper/graph.js +29 -0
- package/dist/wrapper/index.d.ts +2 -0
- package/dist/wrapper/index.js +4 -0
- package/dist/wrapper/ontology.d.ts +312 -0
- package/dist/wrapper/ontology.js +80 -0
- package/examples/graph/entity_type_example.ts +40 -0
- package/package.json +1 -1
- package/reference.md +311 -186
- package/serialization/resources/graph/client/requests/EntityTypeRequest.d.ts +13 -0
- package/serialization/resources/graph/client/requests/EntityTypeRequest.js +44 -0
- package/serialization/resources/graph/client/requests/GraphSearchQuery.d.ts +1 -0
- package/serialization/resources/graph/client/requests/GraphSearchQuery.js +1 -0
- package/serialization/resources/graph/client/requests/index.d.ts +1 -0
- package/serialization/resources/graph/client/requests/index.js +3 -1
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +1 -1
- package/serialization/types/EntityProperty.d.ts +15 -0
- package/serialization/types/EntityProperty.js +46 -0
- package/serialization/types/EntityPropertyType.d.ts +10 -0
- package/serialization/types/EntityPropertyType.js +41 -0
- package/serialization/types/EntityType.d.ts +15 -0
- package/serialization/types/EntityType.js +46 -0
- package/serialization/types/EntityTypeResponse.d.ts +13 -0
- package/serialization/types/EntityTypeResponse.js +44 -0
- package/serialization/types/index.d.ts +4 -0
- package/serialization/types/index.js +4 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/graph.d.ts +6 -0
- package/wrapper/graph.js +29 -0
- package/wrapper/index.d.ts +2 -0
- package/wrapper/index.js +4 -0
- package/wrapper/ontology.d.ts +312 -0
- package/wrapper/ontology.js +80 -0
package/reference.md
CHANGED
|
@@ -909,9 +909,9 @@ await client.document.search("collectionName");
|
|
|
909
909
|
</dl>
|
|
910
910
|
</details>
|
|
911
911
|
|
|
912
|
-
##
|
|
912
|
+
## Graph
|
|
913
913
|
|
|
914
|
-
<details><summary><code>client.
|
|
914
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">listEntityTypes</a>() -> Zep.EntityTypeResponse</code></summary>
|
|
915
915
|
<dl>
|
|
916
916
|
<dd>
|
|
917
917
|
|
|
@@ -923,7 +923,7 @@ await client.document.search("collectionName");
|
|
|
923
923
|
<dl>
|
|
924
924
|
<dd>
|
|
925
925
|
|
|
926
|
-
|
|
926
|
+
Returns all entity types for a project.
|
|
927
927
|
|
|
928
928
|
</dd>
|
|
929
929
|
</dl>
|
|
@@ -939,7 +939,7 @@ Deprecated API: get fact by uuid
|
|
|
939
939
|
<dd>
|
|
940
940
|
|
|
941
941
|
```typescript
|
|
942
|
-
await client.
|
|
942
|
+
await client.graph.listEntityTypes();
|
|
943
943
|
```
|
|
944
944
|
|
|
945
945
|
</dd>
|
|
@@ -955,15 +955,7 @@ await client.memory.getFact("factUUID");
|
|
|
955
955
|
<dl>
|
|
956
956
|
<dd>
|
|
957
957
|
|
|
958
|
-
**
|
|
959
|
-
|
|
960
|
-
</dd>
|
|
961
|
-
</dl>
|
|
962
|
-
|
|
963
|
-
<dl>
|
|
964
|
-
<dd>
|
|
965
|
-
|
|
966
|
-
**requestOptions:** `Memory.RequestOptions`
|
|
958
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
967
959
|
|
|
968
960
|
</dd>
|
|
969
961
|
</dl>
|
|
@@ -974,7 +966,7 @@ await client.memory.getFact("factUUID");
|
|
|
974
966
|
</dl>
|
|
975
967
|
</details>
|
|
976
968
|
|
|
977
|
-
<details><summary><code>client.
|
|
969
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">setEntityTypesInternal</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
978
970
|
<dl>
|
|
979
971
|
<dd>
|
|
980
972
|
|
|
@@ -986,7 +978,7 @@ await client.memory.getFact("factUUID");
|
|
|
986
978
|
<dl>
|
|
987
979
|
<dd>
|
|
988
980
|
|
|
989
|
-
|
|
981
|
+
Sets the entity types for a project, replacing any existing ones.
|
|
990
982
|
|
|
991
983
|
</dd>
|
|
992
984
|
</dl>
|
|
@@ -1002,7 +994,14 @@ Deprecated API: delete a fact
|
|
|
1002
994
|
<dd>
|
|
1003
995
|
|
|
1004
996
|
```typescript
|
|
1005
|
-
await client.
|
|
997
|
+
await client.graph.setEntityTypesInternal({
|
|
998
|
+
entityTypes: [
|
|
999
|
+
{
|
|
1000
|
+
description: "description",
|
|
1001
|
+
name: "name",
|
|
1002
|
+
},
|
|
1003
|
+
],
|
|
1004
|
+
});
|
|
1006
1005
|
```
|
|
1007
1006
|
|
|
1008
1007
|
</dd>
|
|
@@ -1018,7 +1017,7 @@ await client.memory.deleteFact("factUUID");
|
|
|
1018
1017
|
<dl>
|
|
1019
1018
|
<dd>
|
|
1020
1019
|
|
|
1021
|
-
**
|
|
1020
|
+
**request:** `Zep.EntityTypeRequest`
|
|
1022
1021
|
|
|
1023
1022
|
</dd>
|
|
1024
1023
|
</dl>
|
|
@@ -1026,7 +1025,7 @@ await client.memory.deleteFact("factUUID");
|
|
|
1026
1025
|
<dl>
|
|
1027
1026
|
<dd>
|
|
1028
1027
|
|
|
1029
|
-
**requestOptions:** `
|
|
1028
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1030
1029
|
|
|
1031
1030
|
</dd>
|
|
1032
1031
|
</dl>
|
|
@@ -1037,7 +1036,7 @@ await client.memory.deleteFact("factUUID");
|
|
|
1037
1036
|
</dl>
|
|
1038
1037
|
</details>
|
|
1039
1038
|
|
|
1040
|
-
<details><summary><code>client.
|
|
1039
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">add</a>({ ...params }) -> Zep.Episode</code></summary>
|
|
1041
1040
|
<dl>
|
|
1042
1041
|
<dd>
|
|
1043
1042
|
|
|
@@ -1049,7 +1048,7 @@ await client.memory.deleteFact("factUUID");
|
|
|
1049
1048
|
<dl>
|
|
1050
1049
|
<dd>
|
|
1051
1050
|
|
|
1052
|
-
|
|
1051
|
+
Add data to the graph. Note: each subscription tier has different limits on the amount of data that can be added to the graph please refer to the pricing page for more information.
|
|
1053
1052
|
|
|
1054
1053
|
</dd>
|
|
1055
1054
|
</dl>
|
|
@@ -1065,10 +1064,7 @@ Creates a new session.
|
|
|
1065
1064
|
<dd>
|
|
1066
1065
|
|
|
1067
1066
|
```typescript
|
|
1068
|
-
await client.
|
|
1069
|
-
sessionId: "session_id",
|
|
1070
|
-
userId: "user_id",
|
|
1071
|
-
});
|
|
1067
|
+
await client.graph.add();
|
|
1072
1068
|
```
|
|
1073
1069
|
|
|
1074
1070
|
</dd>
|
|
@@ -1084,7 +1080,7 @@ await client.memory.addSession({
|
|
|
1084
1080
|
<dl>
|
|
1085
1081
|
<dd>
|
|
1086
1082
|
|
|
1087
|
-
**request:** `Zep.
|
|
1083
|
+
**request:** `Zep.AddDataRequest`
|
|
1088
1084
|
|
|
1089
1085
|
</dd>
|
|
1090
1086
|
</dl>
|
|
@@ -1092,7 +1088,7 @@ await client.memory.addSession({
|
|
|
1092
1088
|
<dl>
|
|
1093
1089
|
<dd>
|
|
1094
1090
|
|
|
1095
|
-
**requestOptions:** `
|
|
1091
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1096
1092
|
|
|
1097
1093
|
</dd>
|
|
1098
1094
|
</dl>
|
|
@@ -1103,7 +1099,7 @@ await client.memory.addSession({
|
|
|
1103
1099
|
</dl>
|
|
1104
1100
|
</details>
|
|
1105
1101
|
|
|
1106
|
-
<details><summary><code>client.
|
|
1102
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">addFactTriple</a>({ ...params }) -> Zep.AddTripleResponse</code></summary>
|
|
1107
1103
|
<dl>
|
|
1108
1104
|
<dd>
|
|
1109
1105
|
|
|
@@ -1115,7 +1111,7 @@ await client.memory.addSession({
|
|
|
1115
1111
|
<dl>
|
|
1116
1112
|
<dd>
|
|
1117
1113
|
|
|
1118
|
-
|
|
1114
|
+
Add a fact triple for a user or group
|
|
1119
1115
|
|
|
1120
1116
|
</dd>
|
|
1121
1117
|
</dl>
|
|
@@ -1131,7 +1127,11 @@ Returns all sessions.
|
|
|
1131
1127
|
<dd>
|
|
1132
1128
|
|
|
1133
1129
|
```typescript
|
|
1134
|
-
await client.
|
|
1130
|
+
await client.graph.addFactTriple({
|
|
1131
|
+
fact: "fact",
|
|
1132
|
+
factName: "fact_name",
|
|
1133
|
+
targetNodeName: "target_node_name",
|
|
1134
|
+
});
|
|
1135
1135
|
```
|
|
1136
1136
|
|
|
1137
1137
|
</dd>
|
|
@@ -1147,7 +1147,7 @@ await client.memory.listSessions();
|
|
|
1147
1147
|
<dl>
|
|
1148
1148
|
<dd>
|
|
1149
1149
|
|
|
1150
|
-
**request:** `Zep.
|
|
1150
|
+
**request:** `Zep.AddTripleRequest`
|
|
1151
1151
|
|
|
1152
1152
|
</dd>
|
|
1153
1153
|
</dl>
|
|
@@ -1155,7 +1155,7 @@ await client.memory.listSessions();
|
|
|
1155
1155
|
<dl>
|
|
1156
1156
|
<dd>
|
|
1157
1157
|
|
|
1158
|
-
**requestOptions:** `
|
|
1158
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1159
1159
|
|
|
1160
1160
|
</dd>
|
|
1161
1161
|
</dl>
|
|
@@ -1166,7 +1166,7 @@ await client.memory.listSessions();
|
|
|
1166
1166
|
</dl>
|
|
1167
1167
|
</details>
|
|
1168
1168
|
|
|
1169
|
-
<details><summary><code>client.
|
|
1169
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">search</a>({ ...params }) -> Zep.GraphSearchResults</code></summary>
|
|
1170
1170
|
<dl>
|
|
1171
1171
|
<dd>
|
|
1172
1172
|
|
|
@@ -1178,7 +1178,7 @@ await client.memory.listSessions();
|
|
|
1178
1178
|
<dl>
|
|
1179
1179
|
<dd>
|
|
1180
1180
|
|
|
1181
|
-
|
|
1181
|
+
Perform a graph search query.
|
|
1182
1182
|
|
|
1183
1183
|
</dd>
|
|
1184
1184
|
</dl>
|
|
@@ -1194,8 +1194,8 @@ Deprecated API: End multiple sessions by their IDs.
|
|
|
1194
1194
|
<dd>
|
|
1195
1195
|
|
|
1196
1196
|
```typescript
|
|
1197
|
-
await client.
|
|
1198
|
-
|
|
1197
|
+
await client.graph.search({
|
|
1198
|
+
query: "query",
|
|
1199
1199
|
});
|
|
1200
1200
|
```
|
|
1201
1201
|
|
|
@@ -1212,7 +1212,7 @@ await client.memory.endSessions({
|
|
|
1212
1212
|
<dl>
|
|
1213
1213
|
<dd>
|
|
1214
1214
|
|
|
1215
|
-
**request:** `Zep.
|
|
1215
|
+
**request:** `Zep.GraphSearchQuery`
|
|
1216
1216
|
|
|
1217
1217
|
</dd>
|
|
1218
1218
|
</dl>
|
|
@@ -1220,7 +1220,7 @@ await client.memory.endSessions({
|
|
|
1220
1220
|
<dl>
|
|
1221
1221
|
<dd>
|
|
1222
1222
|
|
|
1223
|
-
**requestOptions:** `
|
|
1223
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1224
1224
|
|
|
1225
1225
|
</dd>
|
|
1226
1226
|
</dl>
|
|
@@ -1231,7 +1231,9 @@ await client.memory.endSessions({
|
|
|
1231
1231
|
</dl>
|
|
1232
1232
|
</details>
|
|
1233
1233
|
|
|
1234
|
-
|
|
1234
|
+
## Memory
|
|
1235
|
+
|
|
1236
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">getFact</a>(factUuid) -> Zep.FactResponse</code></summary>
|
|
1235
1237
|
<dl>
|
|
1236
1238
|
<dd>
|
|
1237
1239
|
|
|
@@ -1243,7 +1245,7 @@ await client.memory.endSessions({
|
|
|
1243
1245
|
<dl>
|
|
1244
1246
|
<dd>
|
|
1245
1247
|
|
|
1246
|
-
Deprecated API:
|
|
1248
|
+
Deprecated API: get fact by uuid
|
|
1247
1249
|
|
|
1248
1250
|
</dd>
|
|
1249
1251
|
</dl>
|
|
@@ -1259,9 +1261,7 @@ Deprecated API: Search sessions for the specified query.
|
|
|
1259
1261
|
<dd>
|
|
1260
1262
|
|
|
1261
1263
|
```typescript
|
|
1262
|
-
await client.memory.
|
|
1263
|
-
text: "text",
|
|
1264
|
-
});
|
|
1264
|
+
await client.memory.getFact("factUUID");
|
|
1265
1265
|
```
|
|
1266
1266
|
|
|
1267
1267
|
</dd>
|
|
@@ -1277,7 +1277,7 @@ await client.memory.searchSessions({
|
|
|
1277
1277
|
<dl>
|
|
1278
1278
|
<dd>
|
|
1279
1279
|
|
|
1280
|
-
**
|
|
1280
|
+
**factUuid:** `string` — Fact UUID
|
|
1281
1281
|
|
|
1282
1282
|
</dd>
|
|
1283
1283
|
</dl>
|
|
@@ -1296,7 +1296,7 @@ await client.memory.searchSessions({
|
|
|
1296
1296
|
</dl>
|
|
1297
1297
|
</details>
|
|
1298
1298
|
|
|
1299
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1299
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">deleteFact</a>(factUuid) -> Zep.SuccessResponse</code></summary>
|
|
1300
1300
|
<dl>
|
|
1301
1301
|
<dd>
|
|
1302
1302
|
|
|
@@ -1308,7 +1308,7 @@ await client.memory.searchSessions({
|
|
|
1308
1308
|
<dl>
|
|
1309
1309
|
<dd>
|
|
1310
1310
|
|
|
1311
|
-
|
|
1311
|
+
Deprecated API: delete a fact
|
|
1312
1312
|
|
|
1313
1313
|
</dd>
|
|
1314
1314
|
</dl>
|
|
@@ -1324,7 +1324,7 @@ Returns a session.
|
|
|
1324
1324
|
<dd>
|
|
1325
1325
|
|
|
1326
1326
|
```typescript
|
|
1327
|
-
await client.memory.
|
|
1327
|
+
await client.memory.deleteFact("factUUID");
|
|
1328
1328
|
```
|
|
1329
1329
|
|
|
1330
1330
|
</dd>
|
|
@@ -1340,7 +1340,7 @@ await client.memory.getSession("sessionId");
|
|
|
1340
1340
|
<dl>
|
|
1341
1341
|
<dd>
|
|
1342
1342
|
|
|
1343
|
-
**
|
|
1343
|
+
**factUuid:** `string` — Fact UUID
|
|
1344
1344
|
|
|
1345
1345
|
</dd>
|
|
1346
1346
|
</dl>
|
|
@@ -1359,7 +1359,7 @@ await client.memory.getSession("sessionId");
|
|
|
1359
1359
|
</dl>
|
|
1360
1360
|
</details>
|
|
1361
1361
|
|
|
1362
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1362
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">addSession</a>({ ...params }) -> Zep.Session</code></summary>
|
|
1363
1363
|
<dl>
|
|
1364
1364
|
<dd>
|
|
1365
1365
|
|
|
@@ -1371,7 +1371,7 @@ await client.memory.getSession("sessionId");
|
|
|
1371
1371
|
<dl>
|
|
1372
1372
|
<dd>
|
|
1373
1373
|
|
|
1374
|
-
|
|
1374
|
+
Creates a new session.
|
|
1375
1375
|
|
|
1376
1376
|
</dd>
|
|
1377
1377
|
</dl>
|
|
@@ -1387,10 +1387,9 @@ Update Session Metadata
|
|
|
1387
1387
|
<dd>
|
|
1388
1388
|
|
|
1389
1389
|
```typescript
|
|
1390
|
-
await client.memory.
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
},
|
|
1390
|
+
await client.memory.addSession({
|
|
1391
|
+
sessionId: "session_id",
|
|
1392
|
+
userId: "user_id",
|
|
1394
1393
|
});
|
|
1395
1394
|
```
|
|
1396
1395
|
|
|
@@ -1407,7 +1406,7 @@ await client.memory.updateSession("sessionId", {
|
|
|
1407
1406
|
<dl>
|
|
1408
1407
|
<dd>
|
|
1409
1408
|
|
|
1410
|
-
**
|
|
1409
|
+
**request:** `Zep.CreateSessionRequest`
|
|
1411
1410
|
|
|
1412
1411
|
</dd>
|
|
1413
1412
|
</dl>
|
|
@@ -1415,7 +1414,62 @@ await client.memory.updateSession("sessionId", {
|
|
|
1415
1414
|
<dl>
|
|
1416
1415
|
<dd>
|
|
1417
1416
|
|
|
1418
|
-
**
|
|
1417
|
+
**requestOptions:** `Memory.RequestOptions`
|
|
1418
|
+
|
|
1419
|
+
</dd>
|
|
1420
|
+
</dl>
|
|
1421
|
+
</dd>
|
|
1422
|
+
</dl>
|
|
1423
|
+
|
|
1424
|
+
</dd>
|
|
1425
|
+
</dl>
|
|
1426
|
+
</details>
|
|
1427
|
+
|
|
1428
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">listSessions</a>({ ...params }) -> Zep.SessionListResponse</code></summary>
|
|
1429
|
+
<dl>
|
|
1430
|
+
<dd>
|
|
1431
|
+
|
|
1432
|
+
#### 📝 Description
|
|
1433
|
+
|
|
1434
|
+
<dl>
|
|
1435
|
+
<dd>
|
|
1436
|
+
|
|
1437
|
+
<dl>
|
|
1438
|
+
<dd>
|
|
1439
|
+
|
|
1440
|
+
Returns all sessions.
|
|
1441
|
+
|
|
1442
|
+
</dd>
|
|
1443
|
+
</dl>
|
|
1444
|
+
</dd>
|
|
1445
|
+
</dl>
|
|
1446
|
+
|
|
1447
|
+
#### 🔌 Usage
|
|
1448
|
+
|
|
1449
|
+
<dl>
|
|
1450
|
+
<dd>
|
|
1451
|
+
|
|
1452
|
+
<dl>
|
|
1453
|
+
<dd>
|
|
1454
|
+
|
|
1455
|
+
```typescript
|
|
1456
|
+
await client.memory.listSessions();
|
|
1457
|
+
```
|
|
1458
|
+
|
|
1459
|
+
</dd>
|
|
1460
|
+
</dl>
|
|
1461
|
+
</dd>
|
|
1462
|
+
</dl>
|
|
1463
|
+
|
|
1464
|
+
#### ⚙️ Parameters
|
|
1465
|
+
|
|
1466
|
+
<dl>
|
|
1467
|
+
<dd>
|
|
1468
|
+
|
|
1469
|
+
<dl>
|
|
1470
|
+
<dd>
|
|
1471
|
+
|
|
1472
|
+
**request:** `Zep.MemoryListSessionsRequest`
|
|
1419
1473
|
|
|
1420
1474
|
</dd>
|
|
1421
1475
|
</dl>
|
|
@@ -1434,7 +1488,7 @@ await client.memory.updateSession("sessionId", {
|
|
|
1434
1488
|
</dl>
|
|
1435
1489
|
</details>
|
|
1436
1490
|
|
|
1437
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1491
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">endSessions</a>({ ...params }) -> Zep.EndSessionsResponse</code></summary>
|
|
1438
1492
|
<dl>
|
|
1439
1493
|
<dd>
|
|
1440
1494
|
|
|
@@ -1446,7 +1500,7 @@ await client.memory.updateSession("sessionId", {
|
|
|
1446
1500
|
<dl>
|
|
1447
1501
|
<dd>
|
|
1448
1502
|
|
|
1449
|
-
|
|
1503
|
+
Deprecated API: End multiple sessions by their IDs.
|
|
1450
1504
|
|
|
1451
1505
|
</dd>
|
|
1452
1506
|
</dl>
|
|
@@ -1462,9 +1516,8 @@ Classifies a session.
|
|
|
1462
1516
|
<dd>
|
|
1463
1517
|
|
|
1464
1518
|
```typescript
|
|
1465
|
-
await client.memory.
|
|
1466
|
-
|
|
1467
|
-
name: "name",
|
|
1519
|
+
await client.memory.endSessions({
|
|
1520
|
+
sessionIds: ["session_ids"],
|
|
1468
1521
|
});
|
|
1469
1522
|
```
|
|
1470
1523
|
|
|
@@ -1481,15 +1534,7 @@ await client.memory.classifySession("sessionId", {
|
|
|
1481
1534
|
<dl>
|
|
1482
1535
|
<dd>
|
|
1483
1536
|
|
|
1484
|
-
**
|
|
1485
|
-
|
|
1486
|
-
</dd>
|
|
1487
|
-
</dl>
|
|
1488
|
-
|
|
1489
|
-
<dl>
|
|
1490
|
-
<dd>
|
|
1491
|
-
|
|
1492
|
-
**request:** `Zep.ClassifySessionRequest`
|
|
1537
|
+
**request:** `Zep.EndSessionsRequest`
|
|
1493
1538
|
|
|
1494
1539
|
</dd>
|
|
1495
1540
|
</dl>
|
|
@@ -1508,7 +1553,7 @@ await client.memory.classifySession("sessionId", {
|
|
|
1508
1553
|
</dl>
|
|
1509
1554
|
</details>
|
|
1510
1555
|
|
|
1511
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1556
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">searchSessions</a>({ ...params }) -> Zep.SessionSearchResponse</code></summary>
|
|
1512
1557
|
<dl>
|
|
1513
1558
|
<dd>
|
|
1514
1559
|
|
|
@@ -1520,7 +1565,7 @@ await client.memory.classifySession("sessionId", {
|
|
|
1520
1565
|
<dl>
|
|
1521
1566
|
<dd>
|
|
1522
1567
|
|
|
1523
|
-
Deprecated API:
|
|
1568
|
+
Deprecated API: Search sessions for the specified query.
|
|
1524
1569
|
|
|
1525
1570
|
</dd>
|
|
1526
1571
|
</dl>
|
|
@@ -1536,7 +1581,9 @@ Deprecated API: End a session by ID.
|
|
|
1536
1581
|
<dd>
|
|
1537
1582
|
|
|
1538
1583
|
```typescript
|
|
1539
|
-
await client.memory.
|
|
1584
|
+
await client.memory.searchSessions({
|
|
1585
|
+
text: "text",
|
|
1586
|
+
});
|
|
1540
1587
|
```
|
|
1541
1588
|
|
|
1542
1589
|
</dd>
|
|
@@ -1552,7 +1599,7 @@ await client.memory.endSession("sessionId");
|
|
|
1552
1599
|
<dl>
|
|
1553
1600
|
<dd>
|
|
1554
1601
|
|
|
1555
|
-
**
|
|
1602
|
+
**request:** `Zep.SessionSearchQuery`
|
|
1556
1603
|
|
|
1557
1604
|
</dd>
|
|
1558
1605
|
</dl>
|
|
@@ -1560,7 +1607,62 @@ await client.memory.endSession("sessionId");
|
|
|
1560
1607
|
<dl>
|
|
1561
1608
|
<dd>
|
|
1562
1609
|
|
|
1563
|
-
**
|
|
1610
|
+
**requestOptions:** `Memory.RequestOptions`
|
|
1611
|
+
|
|
1612
|
+
</dd>
|
|
1613
|
+
</dl>
|
|
1614
|
+
</dd>
|
|
1615
|
+
</dl>
|
|
1616
|
+
|
|
1617
|
+
</dd>
|
|
1618
|
+
</dl>
|
|
1619
|
+
</details>
|
|
1620
|
+
|
|
1621
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">getSession</a>(sessionId) -> Zep.Session</code></summary>
|
|
1622
|
+
<dl>
|
|
1623
|
+
<dd>
|
|
1624
|
+
|
|
1625
|
+
#### 📝 Description
|
|
1626
|
+
|
|
1627
|
+
<dl>
|
|
1628
|
+
<dd>
|
|
1629
|
+
|
|
1630
|
+
<dl>
|
|
1631
|
+
<dd>
|
|
1632
|
+
|
|
1633
|
+
Returns a session.
|
|
1634
|
+
|
|
1635
|
+
</dd>
|
|
1636
|
+
</dl>
|
|
1637
|
+
</dd>
|
|
1638
|
+
</dl>
|
|
1639
|
+
|
|
1640
|
+
#### 🔌 Usage
|
|
1641
|
+
|
|
1642
|
+
<dl>
|
|
1643
|
+
<dd>
|
|
1644
|
+
|
|
1645
|
+
<dl>
|
|
1646
|
+
<dd>
|
|
1647
|
+
|
|
1648
|
+
```typescript
|
|
1649
|
+
await client.memory.getSession("sessionId");
|
|
1650
|
+
```
|
|
1651
|
+
|
|
1652
|
+
</dd>
|
|
1653
|
+
</dl>
|
|
1654
|
+
</dd>
|
|
1655
|
+
</dl>
|
|
1656
|
+
|
|
1657
|
+
#### ⚙️ Parameters
|
|
1658
|
+
|
|
1659
|
+
<dl>
|
|
1660
|
+
<dd>
|
|
1661
|
+
|
|
1662
|
+
<dl>
|
|
1663
|
+
<dd>
|
|
1664
|
+
|
|
1665
|
+
**sessionId:** `string` — The unique identifier of the session.
|
|
1564
1666
|
|
|
1565
1667
|
</dd>
|
|
1566
1668
|
</dl>
|
|
@@ -1579,7 +1681,7 @@ await client.memory.endSession("sessionId");
|
|
|
1579
1681
|
</dl>
|
|
1580
1682
|
</details>
|
|
1581
1683
|
|
|
1582
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1684
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">updateSession</a>(sessionId, { ...params }) -> Zep.Session</code></summary>
|
|
1583
1685
|
<dl>
|
|
1584
1686
|
<dd>
|
|
1585
1687
|
|
|
@@ -1591,7 +1693,7 @@ await client.memory.endSession("sessionId");
|
|
|
1591
1693
|
<dl>
|
|
1592
1694
|
<dd>
|
|
1593
1695
|
|
|
1594
|
-
|
|
1696
|
+
Update Session Metadata
|
|
1595
1697
|
|
|
1596
1698
|
</dd>
|
|
1597
1699
|
</dl>
|
|
@@ -1607,9 +1709,10 @@ extract data from a session by session id
|
|
|
1607
1709
|
<dd>
|
|
1608
1710
|
|
|
1609
1711
|
```typescript
|
|
1610
|
-
await client.memory.
|
|
1611
|
-
|
|
1612
|
-
|
|
1712
|
+
await client.memory.updateSession("sessionId", {
|
|
1713
|
+
metadata: {
|
|
1714
|
+
key: "value",
|
|
1715
|
+
},
|
|
1613
1716
|
});
|
|
1614
1717
|
```
|
|
1615
1718
|
|
|
@@ -1626,7 +1729,7 @@ await client.memory.extractData("sessionId", {
|
|
|
1626
1729
|
<dl>
|
|
1627
1730
|
<dd>
|
|
1628
1731
|
|
|
1629
|
-
**sessionId:** `string` —
|
|
1732
|
+
**sessionId:** `string` — The unique identifier of the session.
|
|
1630
1733
|
|
|
1631
1734
|
</dd>
|
|
1632
1735
|
</dl>
|
|
@@ -1634,7 +1737,7 @@ await client.memory.extractData("sessionId", {
|
|
|
1634
1737
|
<dl>
|
|
1635
1738
|
<dd>
|
|
1636
1739
|
|
|
1637
|
-
**request:** `Zep.
|
|
1740
|
+
**request:** `Zep.UpdateSessionRequest`
|
|
1638
1741
|
|
|
1639
1742
|
</dd>
|
|
1640
1743
|
</dl>
|
|
@@ -1653,7 +1756,7 @@ await client.memory.extractData("sessionId", {
|
|
|
1653
1756
|
</dl>
|
|
1654
1757
|
</details>
|
|
1655
1758
|
|
|
1656
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1759
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">classifySession</a>(sessionId, { ...params }) -> Zep.SessionClassification</code></summary>
|
|
1657
1760
|
<dl>
|
|
1658
1761
|
<dd>
|
|
1659
1762
|
|
|
@@ -1665,7 +1768,7 @@ await client.memory.extractData("sessionId", {
|
|
|
1665
1768
|
<dl>
|
|
1666
1769
|
<dd>
|
|
1667
1770
|
|
|
1668
|
-
|
|
1771
|
+
Classifies a session.
|
|
1669
1772
|
|
|
1670
1773
|
</dd>
|
|
1671
1774
|
</dl>
|
|
@@ -1681,7 +1784,10 @@ Deprecated API: get facts for a session
|
|
|
1681
1784
|
<dd>
|
|
1682
1785
|
|
|
1683
1786
|
```typescript
|
|
1684
|
-
await client.memory.
|
|
1787
|
+
await client.memory.classifySession("sessionId", {
|
|
1788
|
+
classes: ["classes"],
|
|
1789
|
+
name: "name",
|
|
1790
|
+
});
|
|
1685
1791
|
```
|
|
1686
1792
|
|
|
1687
1793
|
</dd>
|
|
@@ -1705,7 +1811,7 @@ await client.memory.getSessionFacts("sessionId");
|
|
|
1705
1811
|
<dl>
|
|
1706
1812
|
<dd>
|
|
1707
1813
|
|
|
1708
|
-
**request:** `Zep.
|
|
1814
|
+
**request:** `Zep.ClassifySessionRequest`
|
|
1709
1815
|
|
|
1710
1816
|
</dd>
|
|
1711
1817
|
</dl>
|
|
@@ -1724,7 +1830,7 @@ await client.memory.getSessionFacts("sessionId");
|
|
|
1724
1830
|
</dl>
|
|
1725
1831
|
</details>
|
|
1726
1832
|
|
|
1727
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1833
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">endSession</a>(sessionId, { ...params }) -> Zep.EndSessionResponse</code></summary>
|
|
1728
1834
|
<dl>
|
|
1729
1835
|
<dd>
|
|
1730
1836
|
|
|
@@ -1736,7 +1842,7 @@ await client.memory.getSessionFacts("sessionId");
|
|
|
1736
1842
|
<dl>
|
|
1737
1843
|
<dd>
|
|
1738
1844
|
|
|
1739
|
-
Deprecated API:
|
|
1845
|
+
Deprecated API: End a session by ID.
|
|
1740
1846
|
|
|
1741
1847
|
</dd>
|
|
1742
1848
|
</dl>
|
|
@@ -1752,7 +1858,7 @@ Deprecated API: Adds facts to a session
|
|
|
1752
1858
|
<dd>
|
|
1753
1859
|
|
|
1754
1860
|
```typescript
|
|
1755
|
-
await client.memory.
|
|
1861
|
+
await client.memory.endSession("sessionId");
|
|
1756
1862
|
```
|
|
1757
1863
|
|
|
1758
1864
|
</dd>
|
|
@@ -1776,7 +1882,7 @@ await client.memory.addSessionFacts("sessionId");
|
|
|
1776
1882
|
<dl>
|
|
1777
1883
|
<dd>
|
|
1778
1884
|
|
|
1779
|
-
**request:** `Zep.
|
|
1885
|
+
**request:** `Zep.EndSessionRequest`
|
|
1780
1886
|
|
|
1781
1887
|
</dd>
|
|
1782
1888
|
</dl>
|
|
@@ -1795,7 +1901,7 @@ await client.memory.addSessionFacts("sessionId");
|
|
|
1795
1901
|
</dl>
|
|
1796
1902
|
</details>
|
|
1797
1903
|
|
|
1798
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1904
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">extractData</a>(sessionId, { ...params }) -> Record<string, string></code></summary>
|
|
1799
1905
|
<dl>
|
|
1800
1906
|
<dd>
|
|
1801
1907
|
|
|
@@ -1807,7 +1913,7 @@ await client.memory.addSessionFacts("sessionId");
|
|
|
1807
1913
|
<dl>
|
|
1808
1914
|
<dd>
|
|
1809
1915
|
|
|
1810
|
-
|
|
1916
|
+
extract data from a session by session id
|
|
1811
1917
|
|
|
1812
1918
|
</dd>
|
|
1813
1919
|
</dl>
|
|
@@ -1823,7 +1929,10 @@ Returns a memory for a given session.
|
|
|
1823
1929
|
<dd>
|
|
1824
1930
|
|
|
1825
1931
|
```typescript
|
|
1826
|
-
await client.memory.
|
|
1932
|
+
await client.memory.extractData("sessionId", {
|
|
1933
|
+
lastN: 1,
|
|
1934
|
+
modelSchema: "model_schema",
|
|
1935
|
+
});
|
|
1827
1936
|
```
|
|
1828
1937
|
|
|
1829
1938
|
</dd>
|
|
@@ -1839,7 +1948,7 @@ await client.memory.get("sessionId");
|
|
|
1839
1948
|
<dl>
|
|
1840
1949
|
<dd>
|
|
1841
1950
|
|
|
1842
|
-
**sessionId:** `string` —
|
|
1951
|
+
**sessionId:** `string` — Session ID
|
|
1843
1952
|
|
|
1844
1953
|
</dd>
|
|
1845
1954
|
</dl>
|
|
@@ -1847,7 +1956,7 @@ await client.memory.get("sessionId");
|
|
|
1847
1956
|
<dl>
|
|
1848
1957
|
<dd>
|
|
1849
1958
|
|
|
1850
|
-
**request:** `Zep.
|
|
1959
|
+
**request:** `Zep.ExtractDataRequest`
|
|
1851
1960
|
|
|
1852
1961
|
</dd>
|
|
1853
1962
|
</dl>
|
|
@@ -1866,7 +1975,7 @@ await client.memory.get("sessionId");
|
|
|
1866
1975
|
</dl>
|
|
1867
1976
|
</details>
|
|
1868
1977
|
|
|
1869
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
1978
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">getSessionFacts</a>(sessionId, { ...params }) -> Zep.FactsResponse</code></summary>
|
|
1870
1979
|
<dl>
|
|
1871
1980
|
<dd>
|
|
1872
1981
|
|
|
@@ -1878,7 +1987,7 @@ await client.memory.get("sessionId");
|
|
|
1878
1987
|
<dl>
|
|
1879
1988
|
<dd>
|
|
1880
1989
|
|
|
1881
|
-
|
|
1990
|
+
Deprecated API: get facts for a session
|
|
1882
1991
|
|
|
1883
1992
|
</dd>
|
|
1884
1993
|
</dl>
|
|
@@ -1894,14 +2003,7 @@ Add memory to the specified session.
|
|
|
1894
2003
|
<dd>
|
|
1895
2004
|
|
|
1896
2005
|
```typescript
|
|
1897
|
-
await client.memory.
|
|
1898
|
-
messages: [
|
|
1899
|
-
{
|
|
1900
|
-
content: "content",
|
|
1901
|
-
roleType: "norole",
|
|
1902
|
-
},
|
|
1903
|
-
],
|
|
1904
|
-
});
|
|
2006
|
+
await client.memory.getSessionFacts("sessionId");
|
|
1905
2007
|
```
|
|
1906
2008
|
|
|
1907
2009
|
</dd>
|
|
@@ -1917,7 +2019,7 @@ await client.memory.add("sessionId", {
|
|
|
1917
2019
|
<dl>
|
|
1918
2020
|
<dd>
|
|
1919
2021
|
|
|
1920
|
-
**sessionId:** `string` —
|
|
2022
|
+
**sessionId:** `string` — Session ID
|
|
1921
2023
|
|
|
1922
2024
|
</dd>
|
|
1923
2025
|
</dl>
|
|
@@ -1925,7 +2027,7 @@ await client.memory.add("sessionId", {
|
|
|
1925
2027
|
<dl>
|
|
1926
2028
|
<dd>
|
|
1927
2029
|
|
|
1928
|
-
**request:** `Zep.
|
|
2030
|
+
**request:** `Zep.MemoryGetSessionFactsRequest`
|
|
1929
2031
|
|
|
1930
2032
|
</dd>
|
|
1931
2033
|
</dl>
|
|
@@ -1944,7 +2046,7 @@ await client.memory.add("sessionId", {
|
|
|
1944
2046
|
</dl>
|
|
1945
2047
|
</details>
|
|
1946
2048
|
|
|
1947
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
2049
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">addSessionFacts</a>(sessionId, { ...params }) -> Zep.SuccessResponse</code></summary>
|
|
1948
2050
|
<dl>
|
|
1949
2051
|
<dd>
|
|
1950
2052
|
|
|
@@ -1956,7 +2058,7 @@ await client.memory.add("sessionId", {
|
|
|
1956
2058
|
<dl>
|
|
1957
2059
|
<dd>
|
|
1958
2060
|
|
|
1959
|
-
|
|
2061
|
+
Deprecated API: Adds facts to a session
|
|
1960
2062
|
|
|
1961
2063
|
</dd>
|
|
1962
2064
|
</dl>
|
|
@@ -1972,7 +2074,7 @@ Deletes a session.
|
|
|
1972
2074
|
<dd>
|
|
1973
2075
|
|
|
1974
2076
|
```typescript
|
|
1975
|
-
await client.memory.
|
|
2077
|
+
await client.memory.addSessionFacts("sessionId");
|
|
1976
2078
|
```
|
|
1977
2079
|
|
|
1978
2080
|
</dd>
|
|
@@ -1988,7 +2090,15 @@ await client.memory.delete("sessionId");
|
|
|
1988
2090
|
<dl>
|
|
1989
2091
|
<dd>
|
|
1990
2092
|
|
|
1991
|
-
**sessionId:** `string` —
|
|
2093
|
+
**sessionId:** `string` — Session ID
|
|
2094
|
+
|
|
2095
|
+
</dd>
|
|
2096
|
+
</dl>
|
|
2097
|
+
|
|
2098
|
+
<dl>
|
|
2099
|
+
<dd>
|
|
2100
|
+
|
|
2101
|
+
**request:** `Zep.AddFactsRequest`
|
|
1992
2102
|
|
|
1993
2103
|
</dd>
|
|
1994
2104
|
</dl>
|
|
@@ -2007,7 +2117,7 @@ await client.memory.delete("sessionId");
|
|
|
2007
2117
|
</dl>
|
|
2008
2118
|
</details>
|
|
2009
2119
|
|
|
2010
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
2120
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">get</a>(sessionId, { ...params }) -> Zep.Memory</code></summary>
|
|
2011
2121
|
<dl>
|
|
2012
2122
|
<dd>
|
|
2013
2123
|
|
|
@@ -2019,7 +2129,7 @@ await client.memory.delete("sessionId");
|
|
|
2019
2129
|
<dl>
|
|
2020
2130
|
<dd>
|
|
2021
2131
|
|
|
2022
|
-
Returns
|
|
2132
|
+
Returns a memory for a given session.
|
|
2023
2133
|
|
|
2024
2134
|
</dd>
|
|
2025
2135
|
</dl>
|
|
@@ -2035,7 +2145,7 @@ Returns messages for a session.
|
|
|
2035
2145
|
<dd>
|
|
2036
2146
|
|
|
2037
2147
|
```typescript
|
|
2038
|
-
await client.memory.
|
|
2148
|
+
await client.memory.get("sessionId");
|
|
2039
2149
|
```
|
|
2040
2150
|
|
|
2041
2151
|
</dd>
|
|
@@ -2051,7 +2161,7 @@ await client.memory.getSessionMessages("sessionId");
|
|
|
2051
2161
|
<dl>
|
|
2052
2162
|
<dd>
|
|
2053
2163
|
|
|
2054
|
-
**sessionId:** `string` —
|
|
2164
|
+
**sessionId:** `string` — The ID of the session for which to retrieve memory.
|
|
2055
2165
|
|
|
2056
2166
|
</dd>
|
|
2057
2167
|
</dl>
|
|
@@ -2059,7 +2169,7 @@ await client.memory.getSessionMessages("sessionId");
|
|
|
2059
2169
|
<dl>
|
|
2060
2170
|
<dd>
|
|
2061
2171
|
|
|
2062
|
-
**request:** `Zep.
|
|
2172
|
+
**request:** `Zep.MemoryGetRequest`
|
|
2063
2173
|
|
|
2064
2174
|
</dd>
|
|
2065
2175
|
</dl>
|
|
@@ -2078,7 +2188,7 @@ await client.memory.getSessionMessages("sessionId");
|
|
|
2078
2188
|
</dl>
|
|
2079
2189
|
</details>
|
|
2080
2190
|
|
|
2081
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
2191
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">add</a>(sessionId, { ...params }) -> Zep.AddMemoryResponse</code></summary>
|
|
2082
2192
|
<dl>
|
|
2083
2193
|
<dd>
|
|
2084
2194
|
|
|
@@ -2090,7 +2200,7 @@ await client.memory.getSessionMessages("sessionId");
|
|
|
2090
2200
|
<dl>
|
|
2091
2201
|
<dd>
|
|
2092
2202
|
|
|
2093
|
-
|
|
2203
|
+
Add memory to the specified session.
|
|
2094
2204
|
|
|
2095
2205
|
</dd>
|
|
2096
2206
|
</dl>
|
|
@@ -2106,7 +2216,14 @@ Returns a specific message from a session.
|
|
|
2106
2216
|
<dd>
|
|
2107
2217
|
|
|
2108
2218
|
```typescript
|
|
2109
|
-
await client.memory.
|
|
2219
|
+
await client.memory.add("sessionId", {
|
|
2220
|
+
messages: [
|
|
2221
|
+
{
|
|
2222
|
+
content: "content",
|
|
2223
|
+
roleType: "norole",
|
|
2224
|
+
},
|
|
2225
|
+
],
|
|
2226
|
+
});
|
|
2110
2227
|
```
|
|
2111
2228
|
|
|
2112
2229
|
</dd>
|
|
@@ -2122,7 +2239,7 @@ await client.memory.getSessionMessage("sessionId", "messageUUID");
|
|
|
2122
2239
|
<dl>
|
|
2123
2240
|
<dd>
|
|
2124
2241
|
|
|
2125
|
-
**sessionId:** `string` —
|
|
2242
|
+
**sessionId:** `string` — The ID of the session to which memory should be added.
|
|
2126
2243
|
|
|
2127
2244
|
</dd>
|
|
2128
2245
|
</dl>
|
|
@@ -2130,7 +2247,7 @@ await client.memory.getSessionMessage("sessionId", "messageUUID");
|
|
|
2130
2247
|
<dl>
|
|
2131
2248
|
<dd>
|
|
2132
2249
|
|
|
2133
|
-
**
|
|
2250
|
+
**request:** `Zep.AddMemoryRequest`
|
|
2134
2251
|
|
|
2135
2252
|
</dd>
|
|
2136
2253
|
</dl>
|
|
@@ -2149,7 +2266,7 @@ await client.memory.getSessionMessage("sessionId", "messageUUID");
|
|
|
2149
2266
|
</dl>
|
|
2150
2267
|
</details>
|
|
2151
2268
|
|
|
2152
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
2269
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">delete</a>(sessionId) -> Zep.SuccessResponse</code></summary>
|
|
2153
2270
|
<dl>
|
|
2154
2271
|
<dd>
|
|
2155
2272
|
|
|
@@ -2161,7 +2278,7 @@ await client.memory.getSessionMessage("sessionId", "messageUUID");
|
|
|
2161
2278
|
<dl>
|
|
2162
2279
|
<dd>
|
|
2163
2280
|
|
|
2164
|
-
|
|
2281
|
+
Deletes a session.
|
|
2165
2282
|
|
|
2166
2283
|
</dd>
|
|
2167
2284
|
</dl>
|
|
@@ -2177,11 +2294,7 @@ Updates the metadata of a message.
|
|
|
2177
2294
|
<dd>
|
|
2178
2295
|
|
|
2179
2296
|
```typescript
|
|
2180
|
-
await client.memory.
|
|
2181
|
-
metadata: {
|
|
2182
|
-
key: "value",
|
|
2183
|
-
},
|
|
2184
|
-
});
|
|
2297
|
+
await client.memory.delete("sessionId");
|
|
2185
2298
|
```
|
|
2186
2299
|
|
|
2187
2300
|
</dd>
|
|
@@ -2197,7 +2310,7 @@ await client.memory.updateMessageMetadata("sessionId", "messageUUID", {
|
|
|
2197
2310
|
<dl>
|
|
2198
2311
|
<dd>
|
|
2199
2312
|
|
|
2200
|
-
**sessionId:** `string` — The ID of the session.
|
|
2313
|
+
**sessionId:** `string` — The ID of the session for which memory should be deleted.
|
|
2201
2314
|
|
|
2202
2315
|
</dd>
|
|
2203
2316
|
</dl>
|
|
@@ -2205,37 +2318,36 @@ await client.memory.updateMessageMetadata("sessionId", "messageUUID", {
|
|
|
2205
2318
|
<dl>
|
|
2206
2319
|
<dd>
|
|
2207
2320
|
|
|
2208
|
-
**
|
|
2321
|
+
**requestOptions:** `Memory.RequestOptions`
|
|
2209
2322
|
|
|
2323
|
+
</dd>
|
|
2324
|
+
</dl>
|
|
2210
2325
|
</dd>
|
|
2211
2326
|
</dl>
|
|
2212
2327
|
|
|
2328
|
+
</dd>
|
|
2329
|
+
</dl>
|
|
2330
|
+
</details>
|
|
2331
|
+
|
|
2332
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">getSessionMessages</a>(sessionId, { ...params }) -> Zep.MessageListResponse</code></summary>
|
|
2213
2333
|
<dl>
|
|
2214
2334
|
<dd>
|
|
2215
2335
|
|
|
2216
|
-
|
|
2336
|
+
#### 📝 Description
|
|
2217
2337
|
|
|
2218
|
-
|
|
2219
|
-
|
|
2338
|
+
<dl>
|
|
2339
|
+
<dd>
|
|
2220
2340
|
|
|
2221
2341
|
<dl>
|
|
2222
2342
|
<dd>
|
|
2223
2343
|
|
|
2224
|
-
|
|
2344
|
+
Returns messages for a session.
|
|
2225
2345
|
|
|
2226
2346
|
</dd>
|
|
2227
2347
|
</dl>
|
|
2228
2348
|
</dd>
|
|
2229
2349
|
</dl>
|
|
2230
2350
|
|
|
2231
|
-
</dd>
|
|
2232
|
-
</dl>
|
|
2233
|
-
</details>
|
|
2234
|
-
|
|
2235
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">search</a>(sessionId, { ...params }) -> Zep.MemorySearchResult[]</code></summary>
|
|
2236
|
-
<dl>
|
|
2237
|
-
<dd>
|
|
2238
|
-
|
|
2239
2351
|
#### 🔌 Usage
|
|
2240
2352
|
|
|
2241
2353
|
<dl>
|
|
@@ -2245,7 +2357,7 @@ await client.memory.updateMessageMetadata("sessionId", "messageUUID", {
|
|
|
2245
2357
|
<dd>
|
|
2246
2358
|
|
|
2247
2359
|
```typescript
|
|
2248
|
-
await client.memory.
|
|
2360
|
+
await client.memory.getSessionMessages("sessionId");
|
|
2249
2361
|
```
|
|
2250
2362
|
|
|
2251
2363
|
</dd>
|
|
@@ -2261,7 +2373,7 @@ await client.memory.search("sessionId");
|
|
|
2261
2373
|
<dl>
|
|
2262
2374
|
<dd>
|
|
2263
2375
|
|
|
2264
|
-
**sessionId:** `string` —
|
|
2376
|
+
**sessionId:** `string` — Session ID
|
|
2265
2377
|
|
|
2266
2378
|
</dd>
|
|
2267
2379
|
</dl>
|
|
@@ -2269,7 +2381,7 @@ await client.memory.search("sessionId");
|
|
|
2269
2381
|
<dl>
|
|
2270
2382
|
<dd>
|
|
2271
2383
|
|
|
2272
|
-
**request:** `Zep.
|
|
2384
|
+
**request:** `Zep.MemoryGetSessionMessagesRequest`
|
|
2273
2385
|
|
|
2274
2386
|
</dd>
|
|
2275
2387
|
</dl>
|
|
@@ -2288,7 +2400,7 @@ await client.memory.search("sessionId");
|
|
|
2288
2400
|
</dl>
|
|
2289
2401
|
</details>
|
|
2290
2402
|
|
|
2291
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
2403
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">getSessionMessage</a>(sessionId, messageUuid) -> Zep.Message</code></summary>
|
|
2292
2404
|
<dl>
|
|
2293
2405
|
<dd>
|
|
2294
2406
|
|
|
@@ -2300,7 +2412,7 @@ await client.memory.search("sessionId");
|
|
|
2300
2412
|
<dl>
|
|
2301
2413
|
<dd>
|
|
2302
2414
|
|
|
2303
|
-
|
|
2415
|
+
Returns a specific message from a session.
|
|
2304
2416
|
|
|
2305
2417
|
</dd>
|
|
2306
2418
|
</dl>
|
|
@@ -2316,7 +2428,7 @@ Deprecated API: Get session summaries by ID
|
|
|
2316
2428
|
<dd>
|
|
2317
2429
|
|
|
2318
2430
|
```typescript
|
|
2319
|
-
await client.memory.
|
|
2431
|
+
await client.memory.getSessionMessage("sessionId", "messageUUID");
|
|
2320
2432
|
```
|
|
2321
2433
|
|
|
2322
2434
|
</dd>
|
|
@@ -2332,7 +2444,15 @@ await client.memory.getSummaries("sessionId");
|
|
|
2332
2444
|
<dl>
|
|
2333
2445
|
<dd>
|
|
2334
2446
|
|
|
2335
|
-
**sessionId:** `string` —
|
|
2447
|
+
**sessionId:** `string` — Soon to be deprecated as this is not needed.
|
|
2448
|
+
|
|
2449
|
+
</dd>
|
|
2450
|
+
</dl>
|
|
2451
|
+
|
|
2452
|
+
<dl>
|
|
2453
|
+
<dd>
|
|
2454
|
+
|
|
2455
|
+
**messageUuid:** `string` — The UUID of the message.
|
|
2336
2456
|
|
|
2337
2457
|
</dd>
|
|
2338
2458
|
</dl>
|
|
@@ -2351,7 +2471,7 @@ await client.memory.getSummaries("sessionId");
|
|
|
2351
2471
|
</dl>
|
|
2352
2472
|
</details>
|
|
2353
2473
|
|
|
2354
|
-
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">
|
|
2474
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">updateMessageMetadata</a>(sessionId, messageUuid, { ...params }) -> Zep.Message</code></summary>
|
|
2355
2475
|
<dl>
|
|
2356
2476
|
<dd>
|
|
2357
2477
|
|
|
@@ -2363,7 +2483,7 @@ await client.memory.getSummaries("sessionId");
|
|
|
2363
2483
|
<dl>
|
|
2364
2484
|
<dd>
|
|
2365
2485
|
|
|
2366
|
-
|
|
2486
|
+
Updates the metadata of a message.
|
|
2367
2487
|
|
|
2368
2488
|
</dd>
|
|
2369
2489
|
</dl>
|
|
@@ -2379,7 +2499,11 @@ Deprecated API: Synthesize a question from the last N messages in the chat histo
|
|
|
2379
2499
|
<dd>
|
|
2380
2500
|
|
|
2381
2501
|
```typescript
|
|
2382
|
-
await client.memory.
|
|
2502
|
+
await client.memory.updateMessageMetadata("sessionId", "messageUUID", {
|
|
2503
|
+
metadata: {
|
|
2504
|
+
key: "value",
|
|
2505
|
+
},
|
|
2506
|
+
});
|
|
2383
2507
|
```
|
|
2384
2508
|
|
|
2385
2509
|
</dd>
|
|
@@ -2403,7 +2527,15 @@ await client.memory.synthesizeQuestion("sessionId");
|
|
|
2403
2527
|
<dl>
|
|
2404
2528
|
<dd>
|
|
2405
2529
|
|
|
2406
|
-
**
|
|
2530
|
+
**messageUuid:** `string` — The UUID of the message.
|
|
2531
|
+
|
|
2532
|
+
</dd>
|
|
2533
|
+
</dl>
|
|
2534
|
+
|
|
2535
|
+
<dl>
|
|
2536
|
+
<dd>
|
|
2537
|
+
|
|
2538
|
+
**request:** `Zep.ModelsMessageMetadataUpdate`
|
|
2407
2539
|
|
|
2408
2540
|
</dd>
|
|
2409
2541
|
</dl>
|
|
@@ -2422,13 +2554,11 @@ await client.memory.synthesizeQuestion("sessionId");
|
|
|
2422
2554
|
</dl>
|
|
2423
2555
|
</details>
|
|
2424
2556
|
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">add</a>({ ...params }) -> Zep.Episode</code></summary>
|
|
2557
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">search</a>(sessionId, { ...params }) -> Zep.MemorySearchResult[]</code></summary>
|
|
2428
2558
|
<dl>
|
|
2429
2559
|
<dd>
|
|
2430
2560
|
|
|
2431
|
-
####
|
|
2561
|
+
#### 🔌 Usage
|
|
2432
2562
|
|
|
2433
2563
|
<dl>
|
|
2434
2564
|
<dd>
|
|
@@ -2436,14 +2566,16 @@ await client.memory.synthesizeQuestion("sessionId");
|
|
|
2436
2566
|
<dl>
|
|
2437
2567
|
<dd>
|
|
2438
2568
|
|
|
2439
|
-
|
|
2569
|
+
```typescript
|
|
2570
|
+
await client.memory.search("sessionId");
|
|
2571
|
+
```
|
|
2440
2572
|
|
|
2441
2573
|
</dd>
|
|
2442
2574
|
</dl>
|
|
2443
2575
|
</dd>
|
|
2444
2576
|
</dl>
|
|
2445
2577
|
|
|
2446
|
-
####
|
|
2578
|
+
#### ⚙️ Parameters
|
|
2447
2579
|
|
|
2448
2580
|
<dl>
|
|
2449
2581
|
<dd>
|
|
@@ -2451,24 +2583,15 @@ Add data to the graph. Note: each subscription tier has different limits on the
|
|
|
2451
2583
|
<dl>
|
|
2452
2584
|
<dd>
|
|
2453
2585
|
|
|
2454
|
-
|
|
2455
|
-
await client.graph.add();
|
|
2456
|
-
```
|
|
2586
|
+
**sessionId:** `string` — The ID of the session for which memory should be searched.
|
|
2457
2587
|
|
|
2458
2588
|
</dd>
|
|
2459
2589
|
</dl>
|
|
2460
|
-
</dd>
|
|
2461
|
-
</dl>
|
|
2462
|
-
|
|
2463
|
-
#### ⚙️ Parameters
|
|
2464
2590
|
|
|
2465
2591
|
<dl>
|
|
2466
2592
|
<dd>
|
|
2467
2593
|
|
|
2468
|
-
|
|
2469
|
-
<dd>
|
|
2470
|
-
|
|
2471
|
-
**request:** `Zep.AddDataRequest`
|
|
2594
|
+
**request:** `Zep.MemorySearchPayload`
|
|
2472
2595
|
|
|
2473
2596
|
</dd>
|
|
2474
2597
|
</dl>
|
|
@@ -2476,7 +2599,7 @@ await client.graph.add();
|
|
|
2476
2599
|
<dl>
|
|
2477
2600
|
<dd>
|
|
2478
2601
|
|
|
2479
|
-
**requestOptions:** `
|
|
2602
|
+
**requestOptions:** `Memory.RequestOptions`
|
|
2480
2603
|
|
|
2481
2604
|
</dd>
|
|
2482
2605
|
</dl>
|
|
@@ -2487,7 +2610,7 @@ await client.graph.add();
|
|
|
2487
2610
|
</dl>
|
|
2488
2611
|
</details>
|
|
2489
2612
|
|
|
2490
|
-
<details><summary><code>client.
|
|
2613
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">getSummaries</a>(sessionId) -> Zep.SummaryListResponse</code></summary>
|
|
2491
2614
|
<dl>
|
|
2492
2615
|
<dd>
|
|
2493
2616
|
|
|
@@ -2499,7 +2622,7 @@ await client.graph.add();
|
|
|
2499
2622
|
<dl>
|
|
2500
2623
|
<dd>
|
|
2501
2624
|
|
|
2502
|
-
|
|
2625
|
+
Deprecated API: Get session summaries by ID
|
|
2503
2626
|
|
|
2504
2627
|
</dd>
|
|
2505
2628
|
</dl>
|
|
@@ -2515,11 +2638,7 @@ Add a fact triple for a user or group
|
|
|
2515
2638
|
<dd>
|
|
2516
2639
|
|
|
2517
2640
|
```typescript
|
|
2518
|
-
await client.
|
|
2519
|
-
fact: "fact",
|
|
2520
|
-
factName: "fact_name",
|
|
2521
|
-
targetNodeName: "target_node_name",
|
|
2522
|
-
});
|
|
2641
|
+
await client.memory.getSummaries("sessionId");
|
|
2523
2642
|
```
|
|
2524
2643
|
|
|
2525
2644
|
</dd>
|
|
@@ -2535,7 +2654,7 @@ await client.graph.addFactTriple({
|
|
|
2535
2654
|
<dl>
|
|
2536
2655
|
<dd>
|
|
2537
2656
|
|
|
2538
|
-
**
|
|
2657
|
+
**sessionId:** `string` — Session ID
|
|
2539
2658
|
|
|
2540
2659
|
</dd>
|
|
2541
2660
|
</dl>
|
|
@@ -2543,7 +2662,7 @@ await client.graph.addFactTriple({
|
|
|
2543
2662
|
<dl>
|
|
2544
2663
|
<dd>
|
|
2545
2664
|
|
|
2546
|
-
**requestOptions:** `
|
|
2665
|
+
**requestOptions:** `Memory.RequestOptions`
|
|
2547
2666
|
|
|
2548
2667
|
</dd>
|
|
2549
2668
|
</dl>
|
|
@@ -2554,7 +2673,7 @@ await client.graph.addFactTriple({
|
|
|
2554
2673
|
</dl>
|
|
2555
2674
|
</details>
|
|
2556
2675
|
|
|
2557
|
-
<details><summary><code>client.
|
|
2676
|
+
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">synthesizeQuestion</a>(sessionId, { ...params }) -> Zep.Question</code></summary>
|
|
2558
2677
|
<dl>
|
|
2559
2678
|
<dd>
|
|
2560
2679
|
|
|
@@ -2566,7 +2685,7 @@ await client.graph.addFactTriple({
|
|
|
2566
2685
|
<dl>
|
|
2567
2686
|
<dd>
|
|
2568
2687
|
|
|
2569
|
-
|
|
2688
|
+
Deprecated API: Synthesize a question from the last N messages in the chat history.
|
|
2570
2689
|
|
|
2571
2690
|
</dd>
|
|
2572
2691
|
</dl>
|
|
@@ -2582,9 +2701,7 @@ Perform a graph search query.
|
|
|
2582
2701
|
<dd>
|
|
2583
2702
|
|
|
2584
2703
|
```typescript
|
|
2585
|
-
await client.
|
|
2586
|
-
query: "query",
|
|
2587
|
-
});
|
|
2704
|
+
await client.memory.synthesizeQuestion("sessionId");
|
|
2588
2705
|
```
|
|
2589
2706
|
|
|
2590
2707
|
</dd>
|
|
@@ -2600,7 +2717,7 @@ await client.graph.search({
|
|
|
2600
2717
|
<dl>
|
|
2601
2718
|
<dd>
|
|
2602
2719
|
|
|
2603
|
-
**
|
|
2720
|
+
**sessionId:** `string` — The ID of the session.
|
|
2604
2721
|
|
|
2605
2722
|
</dd>
|
|
2606
2723
|
</dl>
|
|
@@ -2608,7 +2725,15 @@ await client.graph.search({
|
|
|
2608
2725
|
<dl>
|
|
2609
2726
|
<dd>
|
|
2610
2727
|
|
|
2611
|
-
**
|
|
2728
|
+
**request:** `Zep.MemorySynthesizeQuestionRequest`
|
|
2729
|
+
|
|
2730
|
+
</dd>
|
|
2731
|
+
</dl>
|
|
2732
|
+
|
|
2733
|
+
<dl>
|
|
2734
|
+
<dd>
|
|
2735
|
+
|
|
2736
|
+
**requestOptions:** `Memory.RequestOptions`
|
|
2612
2737
|
|
|
2613
2738
|
</dd>
|
|
2614
2739
|
</dl>
|