@getzep/zep-cloud 2.6.1 → 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.d.ts +13 -0
- package/api/resources/graph/resources/episode/client/Client.js +78 -4
- 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.d.ts +13 -0
- package/dist/api/resources/graph/resources/episode/client/Client.js +78 -4
- 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 +385 -197
- 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,6 +909,328 @@ await client.document.search("collectionName");
|
|
|
909
909
|
</dl>
|
|
910
910
|
</details>
|
|
911
911
|
|
|
912
|
+
## Graph
|
|
913
|
+
|
|
914
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">listEntityTypes</a>() -> Zep.EntityTypeResponse</code></summary>
|
|
915
|
+
<dl>
|
|
916
|
+
<dd>
|
|
917
|
+
|
|
918
|
+
#### 📝 Description
|
|
919
|
+
|
|
920
|
+
<dl>
|
|
921
|
+
<dd>
|
|
922
|
+
|
|
923
|
+
<dl>
|
|
924
|
+
<dd>
|
|
925
|
+
|
|
926
|
+
Returns all entity types for a project.
|
|
927
|
+
|
|
928
|
+
</dd>
|
|
929
|
+
</dl>
|
|
930
|
+
</dd>
|
|
931
|
+
</dl>
|
|
932
|
+
|
|
933
|
+
#### 🔌 Usage
|
|
934
|
+
|
|
935
|
+
<dl>
|
|
936
|
+
<dd>
|
|
937
|
+
|
|
938
|
+
<dl>
|
|
939
|
+
<dd>
|
|
940
|
+
|
|
941
|
+
```typescript
|
|
942
|
+
await client.graph.listEntityTypes();
|
|
943
|
+
```
|
|
944
|
+
|
|
945
|
+
</dd>
|
|
946
|
+
</dl>
|
|
947
|
+
</dd>
|
|
948
|
+
</dl>
|
|
949
|
+
|
|
950
|
+
#### ⚙️ Parameters
|
|
951
|
+
|
|
952
|
+
<dl>
|
|
953
|
+
<dd>
|
|
954
|
+
|
|
955
|
+
<dl>
|
|
956
|
+
<dd>
|
|
957
|
+
|
|
958
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
959
|
+
|
|
960
|
+
</dd>
|
|
961
|
+
</dl>
|
|
962
|
+
</dd>
|
|
963
|
+
</dl>
|
|
964
|
+
|
|
965
|
+
</dd>
|
|
966
|
+
</dl>
|
|
967
|
+
</details>
|
|
968
|
+
|
|
969
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">setEntityTypesInternal</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
970
|
+
<dl>
|
|
971
|
+
<dd>
|
|
972
|
+
|
|
973
|
+
#### 📝 Description
|
|
974
|
+
|
|
975
|
+
<dl>
|
|
976
|
+
<dd>
|
|
977
|
+
|
|
978
|
+
<dl>
|
|
979
|
+
<dd>
|
|
980
|
+
|
|
981
|
+
Sets the entity types for a project, replacing any existing ones.
|
|
982
|
+
|
|
983
|
+
</dd>
|
|
984
|
+
</dl>
|
|
985
|
+
</dd>
|
|
986
|
+
</dl>
|
|
987
|
+
|
|
988
|
+
#### 🔌 Usage
|
|
989
|
+
|
|
990
|
+
<dl>
|
|
991
|
+
<dd>
|
|
992
|
+
|
|
993
|
+
<dl>
|
|
994
|
+
<dd>
|
|
995
|
+
|
|
996
|
+
```typescript
|
|
997
|
+
await client.graph.setEntityTypesInternal({
|
|
998
|
+
entityTypes: [
|
|
999
|
+
{
|
|
1000
|
+
description: "description",
|
|
1001
|
+
name: "name",
|
|
1002
|
+
},
|
|
1003
|
+
],
|
|
1004
|
+
});
|
|
1005
|
+
```
|
|
1006
|
+
|
|
1007
|
+
</dd>
|
|
1008
|
+
</dl>
|
|
1009
|
+
</dd>
|
|
1010
|
+
</dl>
|
|
1011
|
+
|
|
1012
|
+
#### ⚙️ Parameters
|
|
1013
|
+
|
|
1014
|
+
<dl>
|
|
1015
|
+
<dd>
|
|
1016
|
+
|
|
1017
|
+
<dl>
|
|
1018
|
+
<dd>
|
|
1019
|
+
|
|
1020
|
+
**request:** `Zep.EntityTypeRequest`
|
|
1021
|
+
|
|
1022
|
+
</dd>
|
|
1023
|
+
</dl>
|
|
1024
|
+
|
|
1025
|
+
<dl>
|
|
1026
|
+
<dd>
|
|
1027
|
+
|
|
1028
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1029
|
+
|
|
1030
|
+
</dd>
|
|
1031
|
+
</dl>
|
|
1032
|
+
</dd>
|
|
1033
|
+
</dl>
|
|
1034
|
+
|
|
1035
|
+
</dd>
|
|
1036
|
+
</dl>
|
|
1037
|
+
</details>
|
|
1038
|
+
|
|
1039
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">add</a>({ ...params }) -> Zep.Episode</code></summary>
|
|
1040
|
+
<dl>
|
|
1041
|
+
<dd>
|
|
1042
|
+
|
|
1043
|
+
#### 📝 Description
|
|
1044
|
+
|
|
1045
|
+
<dl>
|
|
1046
|
+
<dd>
|
|
1047
|
+
|
|
1048
|
+
<dl>
|
|
1049
|
+
<dd>
|
|
1050
|
+
|
|
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.
|
|
1052
|
+
|
|
1053
|
+
</dd>
|
|
1054
|
+
</dl>
|
|
1055
|
+
</dd>
|
|
1056
|
+
</dl>
|
|
1057
|
+
|
|
1058
|
+
#### 🔌 Usage
|
|
1059
|
+
|
|
1060
|
+
<dl>
|
|
1061
|
+
<dd>
|
|
1062
|
+
|
|
1063
|
+
<dl>
|
|
1064
|
+
<dd>
|
|
1065
|
+
|
|
1066
|
+
```typescript
|
|
1067
|
+
await client.graph.add();
|
|
1068
|
+
```
|
|
1069
|
+
|
|
1070
|
+
</dd>
|
|
1071
|
+
</dl>
|
|
1072
|
+
</dd>
|
|
1073
|
+
</dl>
|
|
1074
|
+
|
|
1075
|
+
#### ⚙️ Parameters
|
|
1076
|
+
|
|
1077
|
+
<dl>
|
|
1078
|
+
<dd>
|
|
1079
|
+
|
|
1080
|
+
<dl>
|
|
1081
|
+
<dd>
|
|
1082
|
+
|
|
1083
|
+
**request:** `Zep.AddDataRequest`
|
|
1084
|
+
|
|
1085
|
+
</dd>
|
|
1086
|
+
</dl>
|
|
1087
|
+
|
|
1088
|
+
<dl>
|
|
1089
|
+
<dd>
|
|
1090
|
+
|
|
1091
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1092
|
+
|
|
1093
|
+
</dd>
|
|
1094
|
+
</dl>
|
|
1095
|
+
</dd>
|
|
1096
|
+
</dl>
|
|
1097
|
+
|
|
1098
|
+
</dd>
|
|
1099
|
+
</dl>
|
|
1100
|
+
</details>
|
|
1101
|
+
|
|
1102
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">addFactTriple</a>({ ...params }) -> Zep.AddTripleResponse</code></summary>
|
|
1103
|
+
<dl>
|
|
1104
|
+
<dd>
|
|
1105
|
+
|
|
1106
|
+
#### 📝 Description
|
|
1107
|
+
|
|
1108
|
+
<dl>
|
|
1109
|
+
<dd>
|
|
1110
|
+
|
|
1111
|
+
<dl>
|
|
1112
|
+
<dd>
|
|
1113
|
+
|
|
1114
|
+
Add a fact triple for a user or group
|
|
1115
|
+
|
|
1116
|
+
</dd>
|
|
1117
|
+
</dl>
|
|
1118
|
+
</dd>
|
|
1119
|
+
</dl>
|
|
1120
|
+
|
|
1121
|
+
#### 🔌 Usage
|
|
1122
|
+
|
|
1123
|
+
<dl>
|
|
1124
|
+
<dd>
|
|
1125
|
+
|
|
1126
|
+
<dl>
|
|
1127
|
+
<dd>
|
|
1128
|
+
|
|
1129
|
+
```typescript
|
|
1130
|
+
await client.graph.addFactTriple({
|
|
1131
|
+
fact: "fact",
|
|
1132
|
+
factName: "fact_name",
|
|
1133
|
+
targetNodeName: "target_node_name",
|
|
1134
|
+
});
|
|
1135
|
+
```
|
|
1136
|
+
|
|
1137
|
+
</dd>
|
|
1138
|
+
</dl>
|
|
1139
|
+
</dd>
|
|
1140
|
+
</dl>
|
|
1141
|
+
|
|
1142
|
+
#### ⚙️ Parameters
|
|
1143
|
+
|
|
1144
|
+
<dl>
|
|
1145
|
+
<dd>
|
|
1146
|
+
|
|
1147
|
+
<dl>
|
|
1148
|
+
<dd>
|
|
1149
|
+
|
|
1150
|
+
**request:** `Zep.AddTripleRequest`
|
|
1151
|
+
|
|
1152
|
+
</dd>
|
|
1153
|
+
</dl>
|
|
1154
|
+
|
|
1155
|
+
<dl>
|
|
1156
|
+
<dd>
|
|
1157
|
+
|
|
1158
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1159
|
+
|
|
1160
|
+
</dd>
|
|
1161
|
+
</dl>
|
|
1162
|
+
</dd>
|
|
1163
|
+
</dl>
|
|
1164
|
+
|
|
1165
|
+
</dd>
|
|
1166
|
+
</dl>
|
|
1167
|
+
</details>
|
|
1168
|
+
|
|
1169
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">search</a>({ ...params }) -> Zep.GraphSearchResults</code></summary>
|
|
1170
|
+
<dl>
|
|
1171
|
+
<dd>
|
|
1172
|
+
|
|
1173
|
+
#### 📝 Description
|
|
1174
|
+
|
|
1175
|
+
<dl>
|
|
1176
|
+
<dd>
|
|
1177
|
+
|
|
1178
|
+
<dl>
|
|
1179
|
+
<dd>
|
|
1180
|
+
|
|
1181
|
+
Perform a graph search query.
|
|
1182
|
+
|
|
1183
|
+
</dd>
|
|
1184
|
+
</dl>
|
|
1185
|
+
</dd>
|
|
1186
|
+
</dl>
|
|
1187
|
+
|
|
1188
|
+
#### 🔌 Usage
|
|
1189
|
+
|
|
1190
|
+
<dl>
|
|
1191
|
+
<dd>
|
|
1192
|
+
|
|
1193
|
+
<dl>
|
|
1194
|
+
<dd>
|
|
1195
|
+
|
|
1196
|
+
```typescript
|
|
1197
|
+
await client.graph.search({
|
|
1198
|
+
query: "query",
|
|
1199
|
+
});
|
|
1200
|
+
```
|
|
1201
|
+
|
|
1202
|
+
</dd>
|
|
1203
|
+
</dl>
|
|
1204
|
+
</dd>
|
|
1205
|
+
</dl>
|
|
1206
|
+
|
|
1207
|
+
#### ⚙️ Parameters
|
|
1208
|
+
|
|
1209
|
+
<dl>
|
|
1210
|
+
<dd>
|
|
1211
|
+
|
|
1212
|
+
<dl>
|
|
1213
|
+
<dd>
|
|
1214
|
+
|
|
1215
|
+
**request:** `Zep.GraphSearchQuery`
|
|
1216
|
+
|
|
1217
|
+
</dd>
|
|
1218
|
+
</dl>
|
|
1219
|
+
|
|
1220
|
+
<dl>
|
|
1221
|
+
<dd>
|
|
1222
|
+
|
|
1223
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1224
|
+
|
|
1225
|
+
</dd>
|
|
1226
|
+
</dl>
|
|
1227
|
+
</dd>
|
|
1228
|
+
</dl>
|
|
1229
|
+
|
|
1230
|
+
</dd>
|
|
1231
|
+
</dl>
|
|
1232
|
+
</details>
|
|
1233
|
+
|
|
912
1234
|
## Memory
|
|
913
1235
|
|
|
914
1236
|
<details><summary><code>client.memory.<a href="/src/api/resources/memory/client/Client.ts">getFact</a>(factUuid) -> Zep.FactResponse</code></summary>
|
|
@@ -2422,203 +2744,6 @@ await client.memory.synthesizeQuestion("sessionId");
|
|
|
2422
2744
|
</dl>
|
|
2423
2745
|
</details>
|
|
2424
2746
|
|
|
2425
|
-
## Graph
|
|
2426
|
-
|
|
2427
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">add</a>({ ...params }) -> Zep.Episode</code></summary>
|
|
2428
|
-
<dl>
|
|
2429
|
-
<dd>
|
|
2430
|
-
|
|
2431
|
-
#### 📝 Description
|
|
2432
|
-
|
|
2433
|
-
<dl>
|
|
2434
|
-
<dd>
|
|
2435
|
-
|
|
2436
|
-
<dl>
|
|
2437
|
-
<dd>
|
|
2438
|
-
|
|
2439
|
-
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.
|
|
2440
|
-
|
|
2441
|
-
</dd>
|
|
2442
|
-
</dl>
|
|
2443
|
-
</dd>
|
|
2444
|
-
</dl>
|
|
2445
|
-
|
|
2446
|
-
#### 🔌 Usage
|
|
2447
|
-
|
|
2448
|
-
<dl>
|
|
2449
|
-
<dd>
|
|
2450
|
-
|
|
2451
|
-
<dl>
|
|
2452
|
-
<dd>
|
|
2453
|
-
|
|
2454
|
-
```typescript
|
|
2455
|
-
await client.graph.add();
|
|
2456
|
-
```
|
|
2457
|
-
|
|
2458
|
-
</dd>
|
|
2459
|
-
</dl>
|
|
2460
|
-
</dd>
|
|
2461
|
-
</dl>
|
|
2462
|
-
|
|
2463
|
-
#### ⚙️ Parameters
|
|
2464
|
-
|
|
2465
|
-
<dl>
|
|
2466
|
-
<dd>
|
|
2467
|
-
|
|
2468
|
-
<dl>
|
|
2469
|
-
<dd>
|
|
2470
|
-
|
|
2471
|
-
**request:** `Zep.AddDataRequest`
|
|
2472
|
-
|
|
2473
|
-
</dd>
|
|
2474
|
-
</dl>
|
|
2475
|
-
|
|
2476
|
-
<dl>
|
|
2477
|
-
<dd>
|
|
2478
|
-
|
|
2479
|
-
**requestOptions:** `Graph.RequestOptions`
|
|
2480
|
-
|
|
2481
|
-
</dd>
|
|
2482
|
-
</dl>
|
|
2483
|
-
</dd>
|
|
2484
|
-
</dl>
|
|
2485
|
-
|
|
2486
|
-
</dd>
|
|
2487
|
-
</dl>
|
|
2488
|
-
</details>
|
|
2489
|
-
|
|
2490
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">addFactTriple</a>({ ...params }) -> Zep.AddTripleResponse</code></summary>
|
|
2491
|
-
<dl>
|
|
2492
|
-
<dd>
|
|
2493
|
-
|
|
2494
|
-
#### 📝 Description
|
|
2495
|
-
|
|
2496
|
-
<dl>
|
|
2497
|
-
<dd>
|
|
2498
|
-
|
|
2499
|
-
<dl>
|
|
2500
|
-
<dd>
|
|
2501
|
-
|
|
2502
|
-
Add a fact triple for a user or group
|
|
2503
|
-
|
|
2504
|
-
</dd>
|
|
2505
|
-
</dl>
|
|
2506
|
-
</dd>
|
|
2507
|
-
</dl>
|
|
2508
|
-
|
|
2509
|
-
#### 🔌 Usage
|
|
2510
|
-
|
|
2511
|
-
<dl>
|
|
2512
|
-
<dd>
|
|
2513
|
-
|
|
2514
|
-
<dl>
|
|
2515
|
-
<dd>
|
|
2516
|
-
|
|
2517
|
-
```typescript
|
|
2518
|
-
await client.graph.addFactTriple({
|
|
2519
|
-
fact: "fact",
|
|
2520
|
-
factName: "fact_name",
|
|
2521
|
-
targetNodeName: "target_node_name",
|
|
2522
|
-
});
|
|
2523
|
-
```
|
|
2524
|
-
|
|
2525
|
-
</dd>
|
|
2526
|
-
</dl>
|
|
2527
|
-
</dd>
|
|
2528
|
-
</dl>
|
|
2529
|
-
|
|
2530
|
-
#### ⚙️ Parameters
|
|
2531
|
-
|
|
2532
|
-
<dl>
|
|
2533
|
-
<dd>
|
|
2534
|
-
|
|
2535
|
-
<dl>
|
|
2536
|
-
<dd>
|
|
2537
|
-
|
|
2538
|
-
**request:** `Zep.AddTripleRequest`
|
|
2539
|
-
|
|
2540
|
-
</dd>
|
|
2541
|
-
</dl>
|
|
2542
|
-
|
|
2543
|
-
<dl>
|
|
2544
|
-
<dd>
|
|
2545
|
-
|
|
2546
|
-
**requestOptions:** `Graph.RequestOptions`
|
|
2547
|
-
|
|
2548
|
-
</dd>
|
|
2549
|
-
</dl>
|
|
2550
|
-
</dd>
|
|
2551
|
-
</dl>
|
|
2552
|
-
|
|
2553
|
-
</dd>
|
|
2554
|
-
</dl>
|
|
2555
|
-
</details>
|
|
2556
|
-
|
|
2557
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">search</a>({ ...params }) -> Zep.GraphSearchResults</code></summary>
|
|
2558
|
-
<dl>
|
|
2559
|
-
<dd>
|
|
2560
|
-
|
|
2561
|
-
#### 📝 Description
|
|
2562
|
-
|
|
2563
|
-
<dl>
|
|
2564
|
-
<dd>
|
|
2565
|
-
|
|
2566
|
-
<dl>
|
|
2567
|
-
<dd>
|
|
2568
|
-
|
|
2569
|
-
Perform a graph search query.
|
|
2570
|
-
|
|
2571
|
-
</dd>
|
|
2572
|
-
</dl>
|
|
2573
|
-
</dd>
|
|
2574
|
-
</dl>
|
|
2575
|
-
|
|
2576
|
-
#### 🔌 Usage
|
|
2577
|
-
|
|
2578
|
-
<dl>
|
|
2579
|
-
<dd>
|
|
2580
|
-
|
|
2581
|
-
<dl>
|
|
2582
|
-
<dd>
|
|
2583
|
-
|
|
2584
|
-
```typescript
|
|
2585
|
-
await client.graph.search({
|
|
2586
|
-
query: "query",
|
|
2587
|
-
});
|
|
2588
|
-
```
|
|
2589
|
-
|
|
2590
|
-
</dd>
|
|
2591
|
-
</dl>
|
|
2592
|
-
</dd>
|
|
2593
|
-
</dl>
|
|
2594
|
-
|
|
2595
|
-
#### ⚙️ Parameters
|
|
2596
|
-
|
|
2597
|
-
<dl>
|
|
2598
|
-
<dd>
|
|
2599
|
-
|
|
2600
|
-
<dl>
|
|
2601
|
-
<dd>
|
|
2602
|
-
|
|
2603
|
-
**request:** `Zep.GraphSearchQuery`
|
|
2604
|
-
|
|
2605
|
-
</dd>
|
|
2606
|
-
</dl>
|
|
2607
|
-
|
|
2608
|
-
<dl>
|
|
2609
|
-
<dd>
|
|
2610
|
-
|
|
2611
|
-
**requestOptions:** `Graph.RequestOptions`
|
|
2612
|
-
|
|
2613
|
-
</dd>
|
|
2614
|
-
</dl>
|
|
2615
|
-
</dd>
|
|
2616
|
-
</dl>
|
|
2617
|
-
|
|
2618
|
-
</dd>
|
|
2619
|
-
</dl>
|
|
2620
|
-
</details>
|
|
2621
|
-
|
|
2622
2747
|
## Group
|
|
2623
2748
|
|
|
2624
2749
|
<details><summary><code>client.group.<a href="/src/api/resources/group/client/Client.ts">add</a>({ ...params }) -> Zep.Group</code></summary>
|
|
@@ -4047,6 +4172,69 @@ await client.graph.episode.delete("uuid");
|
|
|
4047
4172
|
</dl>
|
|
4048
4173
|
</details>
|
|
4049
4174
|
|
|
4175
|
+
<details><summary><code>client.graph.episode.<a href="/src/api/resources/graph/resources/episode/client/Client.ts">getNodesAndEdges</a>(uuid) -> Zep.GraphSearchResults</code></summary>
|
|
4176
|
+
<dl>
|
|
4177
|
+
<dd>
|
|
4178
|
+
|
|
4179
|
+
#### 📝 Description
|
|
4180
|
+
|
|
4181
|
+
<dl>
|
|
4182
|
+
<dd>
|
|
4183
|
+
|
|
4184
|
+
<dl>
|
|
4185
|
+
<dd>
|
|
4186
|
+
|
|
4187
|
+
Returns nodes and edges mentioned in an episode
|
|
4188
|
+
|
|
4189
|
+
</dd>
|
|
4190
|
+
</dl>
|
|
4191
|
+
</dd>
|
|
4192
|
+
</dl>
|
|
4193
|
+
|
|
4194
|
+
#### 🔌 Usage
|
|
4195
|
+
|
|
4196
|
+
<dl>
|
|
4197
|
+
<dd>
|
|
4198
|
+
|
|
4199
|
+
<dl>
|
|
4200
|
+
<dd>
|
|
4201
|
+
|
|
4202
|
+
```typescript
|
|
4203
|
+
await client.graph.episode.getNodesAndEdges("uuid");
|
|
4204
|
+
```
|
|
4205
|
+
|
|
4206
|
+
</dd>
|
|
4207
|
+
</dl>
|
|
4208
|
+
</dd>
|
|
4209
|
+
</dl>
|
|
4210
|
+
|
|
4211
|
+
#### ⚙️ Parameters
|
|
4212
|
+
|
|
4213
|
+
<dl>
|
|
4214
|
+
<dd>
|
|
4215
|
+
|
|
4216
|
+
<dl>
|
|
4217
|
+
<dd>
|
|
4218
|
+
|
|
4219
|
+
**uuid:** `string` — Episode uuid
|
|
4220
|
+
|
|
4221
|
+
</dd>
|
|
4222
|
+
</dl>
|
|
4223
|
+
|
|
4224
|
+
<dl>
|
|
4225
|
+
<dd>
|
|
4226
|
+
|
|
4227
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
4228
|
+
|
|
4229
|
+
</dd>
|
|
4230
|
+
</dl>
|
|
4231
|
+
</dd>
|
|
4232
|
+
</dl>
|
|
4233
|
+
|
|
4234
|
+
</dd>
|
|
4235
|
+
</dl>
|
|
4236
|
+
</details>
|
|
4237
|
+
|
|
4050
4238
|
## Graph Node
|
|
4051
4239
|
|
|
4052
4240
|
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">getByGroupId</a>(groupId) -> Zep.EntityNode[]</code></summary>
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as serializers from "../../../../index";
|
|
5
|
+
import * as Zep from "../../../../../api/index";
|
|
6
|
+
import * as core from "../../../../../core";
|
|
7
|
+
import { EntityType } from "../../../../types/EntityType";
|
|
8
|
+
export declare const EntityTypeRequest: core.serialization.Schema<serializers.EntityTypeRequest.Raw, Zep.EntityTypeRequest>;
|
|
9
|
+
export declare namespace EntityTypeRequest {
|
|
10
|
+
interface Raw {
|
|
11
|
+
entity_types: EntityType.Raw[];
|
|
12
|
+
}
|
|
13
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
+
var ownKeys = function(o) {
|
|
23
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
+
var ar = [];
|
|
25
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
28
|
+
return ownKeys(o);
|
|
29
|
+
};
|
|
30
|
+
return function (mod) {
|
|
31
|
+
if (mod && mod.__esModule) return mod;
|
|
32
|
+
var result = {};
|
|
33
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
+
__setModuleDefault(result, mod);
|
|
35
|
+
return result;
|
|
36
|
+
};
|
|
37
|
+
})();
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.EntityTypeRequest = void 0;
|
|
40
|
+
const core = __importStar(require("../../../../../core"));
|
|
41
|
+
const EntityType_1 = require("../../../../types/EntityType");
|
|
42
|
+
exports.EntityTypeRequest = core.serialization.object({
|
|
43
|
+
entityTypes: core.serialization.property("entity_types", core.serialization.list(EntityType_1.EntityType)),
|
|
44
|
+
});
|
|
@@ -45,6 +45,7 @@ exports.GraphSearchQuery = core.serialization.object({
|
|
|
45
45
|
centerNodeUuid: core.serialization.property("center_node_uuid", core.serialization.string().optional()),
|
|
46
46
|
groupId: core.serialization.property("group_id", core.serialization.string().optional()),
|
|
47
47
|
limit: core.serialization.number().optional(),
|
|
48
|
+
minFactRating: core.serialization.property("min_fact_rating", core.serialization.number().optional()),
|
|
48
49
|
minScore: core.serialization.property("min_score", core.serialization.number().optional()),
|
|
49
50
|
mmrLambda: core.serialization.property("mmr_lambda", core.serialization.number().optional()),
|
|
50
51
|
query: core.serialization.string(),
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.GraphSearchQuery = exports.AddTripleRequest = exports.AddDataRequest = void 0;
|
|
3
|
+
exports.GraphSearchQuery = exports.AddTripleRequest = exports.AddDataRequest = exports.EntityTypeRequest = void 0;
|
|
4
|
+
var EntityTypeRequest_1 = require("./EntityTypeRequest");
|
|
5
|
+
Object.defineProperty(exports, "EntityTypeRequest", { enumerable: true, get: function () { return EntityTypeRequest_1.EntityTypeRequest; } });
|
|
4
6
|
var AddDataRequest_1 = require("./AddDataRequest");
|
|
5
7
|
Object.defineProperty(exports, "AddDataRequest", { enumerable: true, get: function () { return AddDataRequest_1.AddDataRequest; } });
|
|
6
8
|
var AddTripleRequest_1 = require("./AddTripleRequest");
|
|
@@ -3,8 +3,8 @@ export * as memory from "./memory";
|
|
|
3
3
|
export * as user from "./user";
|
|
4
4
|
export * as graph from "./graph";
|
|
5
5
|
export * from "./document/client/requests";
|
|
6
|
-
export * from "./memory/client/requests";
|
|
7
6
|
export * from "./graph/client/requests";
|
|
7
|
+
export * from "./memory/client/requests";
|
|
8
8
|
export * as group from "./group";
|
|
9
9
|
export * from "./group/client/requests";
|
|
10
10
|
export * from "./user/client/requests";
|
|
@@ -42,8 +42,8 @@ exports.memory = __importStar(require("./memory"));
|
|
|
42
42
|
exports.user = __importStar(require("./user"));
|
|
43
43
|
exports.graph = __importStar(require("./graph"));
|
|
44
44
|
__exportStar(require("./document/client/requests"), exports);
|
|
45
|
-
__exportStar(require("./memory/client/requests"), exports);
|
|
46
45
|
__exportStar(require("./graph/client/requests"), exports);
|
|
46
|
+
__exportStar(require("./memory/client/requests"), exports);
|
|
47
47
|
exports.group = __importStar(require("./group"));
|
|
48
48
|
__exportStar(require("./group/client/requests"), exports);
|
|
49
49
|
__exportStar(require("./user/client/requests"), exports);
|