Spaces:
Paused
Paused
File size: 136,018 Bytes
f6686e1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 | <!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>tinytroupe.agent.memory API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>tinytroupe.agent.memory</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import json
from tinytroupe.agent import logger
from tinytroupe.agent.mental_faculty import TinyMentalFaculty
from tinytroupe.agent.grounding import BaseSemanticGroundingConnector
import tinytroupe.utils as utils
from llama_index.core import Document
from typing import Any
import copy
from typing import Union
#######################################################################################################################
# Memory mechanisms
#######################################################################################################################
class TinyMemory(TinyMentalFaculty):
"""
Base class for different types of memory.
"""
def _preprocess_value_for_storage(self, value: Any) -> Any:
"""
Preprocesses a value before storing it in memory.
"""
# by default, we don't preprocess the value
return value
def _store(self, value: Any) -> None:
"""
Stores a value in memory.
"""
raise NotImplementedError("Subclasses must implement this method.")
def store(self, value: dict) -> None:
"""
Stores a value in memory.
"""
self._store(self._preprocess_value_for_storage(value))
def store_all(self, values: list) -> None:
"""
Stores a list of values in memory.
"""
logger.debug(f"Storing {len(values)} values in memory: {values}")
for i, value in enumerate(values):
logger.debug(f"Storing value #{i}: {value}")
self.store(value)
def retrieve(self, first_n: int, last_n: int, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the first n and/or last n values from memory. If n is None, all values are retrieved.
Args:
first_n (int): The number of first values to retrieve.
last_n (int): The number of last values to retrieve.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
Returns:
list: The retrieved values.
"""
raise NotImplementedError("Subclasses must implement this method.")
def retrieve_recent(self, item_type:str=None) -> list:
"""
Retrieves the n most recent values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
raise NotImplementedError("Subclasses must implement this method.")
def retrieve_all(self, item_type:str=None) -> list:
"""
Retrieves all values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
raise NotImplementedError("Subclasses must implement this method.")
def retrieve_relevant(self, relevance_target:str, top_k=20) -> list:
"""
Retrieves all values from memory that are relevant to a given target.
"""
raise NotImplementedError("Subclasses must implement this method.")
def summarize_relevant_via_full_scan(self, relevance_target: str, batch_size: int = 20, item_type: str = None) -> str:
"""
Performs a full scan of the memory, extracting and accumulating information relevant to a query.
This function processes all memories (or memories of a specific type if provided),
extracts information relevant to the query from each memory, and accumulates this
information into a coherent response.
Args:
relevance_target (str): The query specifying what information to extract from memories.
item_type (str, optional): If provided, only process memories of this type.
batch_size (int): The number of memories to process in each extraction step. The larger it is, the faster the scan, but possibly less accurate.
Also, a too large value may lead to prompt length overflows, though current models can handle quite large prompts.
Returns:
str: The accumulated information relevant to the query.
"""
logger.debug(f"Starting FULL SCAN for relevance target: {relevance_target}, item type: {item_type}")
# Retrieve all memories of the specified type
memories = self.retrieve_all(item_type=item_type)
# Initialize accumulation
accumulated_info = ""
# Process memories in batches of qty_of_memories_per_extraction
for i in range(0, len(memories), batch_size):
batch = memories[i:i + batch_size]
logger.debug(f"Processing memory batch #{i} in full scan")
# Concatenate memory texts for the batch
batch_text = "# Memories to be processed\n\n"
batch_text += "\n\n ".join(str(memory) for memory in batch)
# Extract information relevant to the query from the batch
extracted_info = utils.semantics.extract_information_from_text(
relevance_target,
batch_text,
context="""
You are extracting information from the an agent's memory,
which might include actions, stimuli, and other types of events. You want to focus on the agent's experience, NOT on the agent's cognition or internal processes.
Assume that:
- "actions" refer to behaviors produced by the agent,
- "stimulus" refer to events or information from the environment or other agents that the agent perceived.
If you read about "assistant" and "user" roles, you can ignore them, as they refer to the agent's internal implementation mechanisms, not to the agent's experience.
In any case, anything related to "assistant" is the agent's output, and anything related to "user" is the agent's input. But you never refer to these roles in the report,
as they are an internal implementation detail of the agent, not part of the agent's experience.
"""
)
logger.debug(f"Extracted information from memory batch: {extracted_info}")
# Skip if no relevant information was found
if not extracted_info:
continue
# Accumulate the extracted information
accumulated_info = utils.semantics.accumulate_based_on_query(
query=relevance_target,
new_entry=extracted_info,
current_accumulation=accumulated_info,
context="""
You are producing a report based on information from an agent's memory.
You will put together all facts and experiences found that are relevant for the query, as a kind of summary of the agent's experience.
The report will later be used to guide further agent action. You focus on the agent's experience, NOT on the agent's cognition or internal processes.
Assume that:
- "actions" refer to behaviors produced by the agent,
- "stimulus" refer to events or information from the environment or other agents that the agent perceived.
- if you read about "assistant" and "user" roles, you can ignore them, as they refer to the agent's internal implementation mechanisms, not to the agent's experience.
In any case, anything related to "assistant" is the agent's output, and anything related to "user" is the agent's input. But you never refer to these roles in the report,
as they are an internal implementation detail of the agent, not part of the agent's experience.
Additional instructions for the accumulation process:
- If the new entry is redundant with respect to some information in the current accumulation, you update the current accumulation by adding to a special counter right by
the side of where the redundant information is found, so that the final report can later be used to guide further agent action (i.e., know which elements appeared more often).
The special counter **must** be formated like this: "[NOTE: this information appeared X times in the memory in different forms]". If the counter was not there originally, you add it. If it was there, you update
it with the new count.
* Example (first element was found 3 times, the second element only once, so no counter):
"I play with and feed my cat [NOTE: this information appeared 3 times in the memory in different forms]. Cats are proud animals descendant from big feline hunters.".
"""
)
logger.debug(f"Accumulated information so far: {accumulated_info}")
logger.debug(f"Total accumulated information after full scan: {accumulated_info}")
return accumulated_info
###################################
# Auxiliary methods
###################################
def filter_by_item_type(self, memories:list, item_type:str) -> list:
"""
Filters a list of memories by item type.
Args:
memories (list): The list of memories to filter.
item_type (str): The item type to filter by.
Returns:
list: The filtered list of memories.
"""
return [memory for memory in memories if memory["type"] == item_type]
def filter_by_item_types(self, memories:list, item_types:list) -> list:
"""
Filters a list of memories by multiple item types.
Args:
memories (list): The list of memories to filter.
item_types (list): The list of item types to filter by.
Returns:
list: The filtered list of memories containing any of the specified types.
"""
return [memory for memory in memories if memory["type"] in item_types]
class EpisodicMemory(TinyMemory):
"""
Provides episodic memory capabilities to an agent. Cognitively, episodic memory is the ability to remember specific events,
or episodes, in the past. This class provides a simple implementation of episodic memory, where the agent can store and retrieve
messages from memory.
Subclasses of this class can be used to provide different memory implementations.
"""
MEMORY_BLOCK_OMISSION_INFO = {'role': 'assistant', 'content': "Info: there were other messages here, but they were omitted for brevity.", 'simulation_timestamp': None}
def __init__(
self, fixed_prefix_length: int = 20, lookback_length: int = 100
) -> None:
"""
Initializes the memory.
Args:
fixed_prefix_length (int): The fixed prefix length. Defaults to 20.
lookback_length (int): The lookback length. Defaults to 100.
"""
self.fixed_prefix_length = fixed_prefix_length
self.lookback_length = lookback_length
# the definitive memory that records all episodic events
self.memory = []
# the current episode buffer, which is used to store messages during an episode
self.episodic_buffer = []
def commit_episode(self):
"""
Ends the current episode, storing the episodic buffer in memory.
"""
self.memory.extend(self.episodic_buffer)
self.episodic_buffer = []
def get_current_episode(self, item_types:list=None) -> list:
"""
Returns the current episode buffer, which is used to store messages during an episode.
Args:
item_types (list, optional): If provided, only retrieve memories of these types. Defaults to None, which retrieves all types.
Returns:
list: The current episode buffer.
"""
result = copy.copy(self.episodic_buffer)
result = self.filter_by_item_types(result, item_types) if item_types is not None else result
return result
def count(self) -> int:
"""
Returns the number of values in memory.
"""
return len(self._memory_with_current_buffer())
def clear(self, max_prefix_to_clear:int=None, max_suffix_to_clear:int=None):
"""
Clears the memory, generating a permanent "episodic amnesia".
If max_prefix_to_clear is not None, it clears the first n values from memory.
If max_suffix_to_clear is not None, it clears the last n values from memory. If both are None,
it clears all values from memory.
Args:
max_prefix_to_clear (int): The number of first values to clear.
max_suffix_to_clear (int): The number of last values to clear.
"""
# clears all episodic buffer messages
self.episodic_buffer = []
# then clears the memory according to the parameters
if max_prefix_to_clear is not None:
self.memory = self.memory[max_prefix_to_clear:]
if max_suffix_to_clear is not None:
self.memory = self.memory[:-max_suffix_to_clear]
if max_prefix_to_clear is None and max_suffix_to_clear is None:
self.memory = []
def _memory_with_current_buffer(self) -> list:
"""
Returns the current memory, including the episodic buffer.
This is useful for retrieving the most recent memories, including the current episode.
"""
return self.memory + self.episodic_buffer
######################################
# General memory methods
######################################
def _store(self, value: Any) -> None:
"""
Stores a value in memory.
"""
self.episodic_buffer.append(value)
def retrieve(self, first_n: int, last_n: int, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the first n and/or last n values from memory. If n is None, all values are retrieved.
Args:
first_n (int): The number of first values to retrieve.
last_n (int): The number of last values to retrieve.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
Returns:
list: The retrieved values.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
# use the other methods in the class to implement
if first_n is not None and last_n is not None:
return self.retrieve_first(first_n, include_omission_info=False, item_type=item_type) + omisssion_info + self.retrieve_last(last_n, include_omission_info=False, item_type=item_type)
elif first_n is not None:
return self.retrieve_first(first_n, include_omission_info, item_type=item_type)
elif last_n is not None:
return self.retrieve_last(last_n, include_omission_info, item_type=item_type)
else:
return self.retrieve_all(item_type=item_type)
def retrieve_recent(self, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the n most recent values from memory.
Args:
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
# Filter memories if item_type is provided
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
# compute fixed prefix
fixed_prefix = memories[: self.fixed_prefix_length] + omisssion_info
# how many lookback values remain?
remaining_lookback = min(
len(memories) - len(fixed_prefix) + (1 if include_omission_info else 0), self.lookback_length
)
# compute the remaining lookback values and return the concatenation
if remaining_lookback <= 0:
return fixed_prefix
else:
return fixed_prefix + memories[-remaining_lookback:]
def retrieve_all(self, item_type:str=None) -> list:
"""
Retrieves all values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
return copy.copy(memories)
def retrieve_relevant(self, relevance_target: str, top_k:int) -> list:
"""
Retrieves top-k values from memory that are most relevant to a given target.
"""
raise NotImplementedError("Subclasses must implement this method.")
def retrieve_first(self, n: int, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the first n values from memory.
Args:
n (int): The number of values to retrieve.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
return memories[:n] + omisssion_info
def retrieve_last(self, n: int=None, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the last n values from memory.
Args:
n (int): The number of values to retrieve, or None to retrieve all values.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
memories = memories[-n:] if n is not None else memories
return omisssion_info + memories
@utils.post_init
class SemanticMemory(TinyMemory):
"""
In Cognitive Psychology, semantic memory is the memory of meanings, understandings, and other concept-based knowledge unrelated to specific
experiences. It is not ordered temporally, and it is not about remembering specific events or episodes. This class provides a simple implementation
of semantic memory, where the agent can store and retrieve semantic information.
"""
serializable_attributes = ["memories", "semantic_grounding_connector"]
def __init__(self, memories: list=None) -> None:
self.memories = memories
self.semantic_grounding_connector = None
# @post_init ensures that _post_init is called after the __init__ method
def _post_init(self):
"""
This will run after __init__, since the class has the @post_init decorator.
It is convenient to separate some of the initialization processes to make deserialize easier.
"""
if not hasattr(self, 'memories') or self.memories is None:
self.memories = []
if not hasattr(self, 'semantic_grounding_connector') or self.semantic_grounding_connector is None:
self.semantic_grounding_connector = BaseSemanticGroundingConnector("Semantic Memory Storage")
# TODO remove?
#self.semantic_grounding_connector.add_documents(self._build_documents_from(self.memories))
def _preprocess_value_for_storage(self, value: dict) -> Any:
logger.debug(f"Preprocessing value for storage: {value}")
if isinstance(value, dict):
engram = {"role": "assistant",
"content": value['content'],
"type": value.get("type", "information"), # Default to 'information' if type is not specified
"simulation_timestamp": value.get("simulation_timestamp", None)}
# Refine the content of the engram is built based on the type of the value to make it more meaningful.
if value['type'] == 'action':
engram['content'] = f"# Action performed\n" +\
f"I have performed the following action at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
elif value['type'] == 'stimulus':
engram['content'] = f"# Stimulus\n" +\
f"I have received the following stimulus at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
elif value['type'] == 'feedback':
engram['content'] = f"# Feedback\n" +\
f"I have received the following feedback at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
elif value['type'] == 'consolidated':
engram['content'] = f"# Consolidated Memory\n" +\
f"I have consolidated the following memory at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
elif value['type'] == 'reflection':
engram['content'] = f"# Reflection\n" +\
f"I have reflected on the following memory at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
else:
engram['content'] = f"# Information\n" +\
f"I have obtained following information at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
# else: # Anything else here?
else:
# If the value is not a dictionary, we just store it as is, but we still wrap it in an engram
engram = {"role": "assistant",
"content": value,
"type": "information", # Default to 'information' if type is not specified
"simulation_timestamp": None}
logger.debug(f"Engram created for storage: {engram}")
return engram
def _store(self, value: Any) -> None:
logger.debug(f"Preparing engram for semantic memory storage, input value: {value}")
self.memories.append(value) # Store the value in the local memory list
# then econduct the value to a Document and store it in the semantic grounding connector
# This is the actual storage in the semantic memory to allow semantic retrieval
engram_doc = self._build_document_from(value)
logger.debug(f"Storing engram in semantic memory: {engram_doc}")
self.semantic_grounding_connector.add_document(engram_doc)
def retrieve_relevant(self, relevance_target:str, top_k=20) -> list:
"""
Retrieves all values from memory that are relevant to a given target.
"""
return self.semantic_grounding_connector.retrieve_relevant(relevance_target, top_k)
def retrieve_all(self, item_type:str=None) -> list:
"""
Retrieves all values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
memories = []
logger.debug(f"Retrieving all documents from semantic memory connector, a total of {len(self.semantic_grounding_connector.documents)} documents.")
for document in self.semantic_grounding_connector.documents:
logger.debug(f"Retrieving document from semantic memory: {document}")
memory_text = document.text
logger.debug(f"Document text retrieved: {memory_text}")
try:
memory = json.loads(memory_text)
logger.debug(f"Memory retrieved: {memory}")
memories.append(memory)
except json.JSONDecodeError as e:
logger.warning(f"Could not decode memory from document text: {memory_text}. Error: {e}")
if item_type is not None:
memories = self.filter_by_item_type(memories, item_type)
return memories
#####################################
# Auxiliary compatibility methods
#####################################
def _build_document_from(self, memory) -> Document:
# TODO: add any metadata as well?
# make sure we are dealing with a dictionary
if not isinstance(memory, dict):
memory = {"content": memory, "type": "information"}
# ensures double quotes are used for JSON serialization, and maybe other formatting details
memory_txt = json.dumps(memory, ensure_ascii=False)
logger.debug(f"Building document from memory: {memory_txt}")
return Document(text=memory_txt)
def _build_documents_from(self, memories: list) -> list:
return [self._build_document_from(memory) for memory in memories]
###################################################################################################
# Memory consolidation and optimization mechanisms
###################################################################################################
class MemoryProcessor:
"""
Base class for memory consolidation and optimization mechanisms.
"""
def process(self, memories: list, timestamp: str=None, context:Union[str, list, dict] = None, persona:Union[str, dict] = None, sequential: bool = True) -> list:
"""
Transforms the given memories. Transformation can be anything from consolidation to optimization, depending on the implementation.
Each memory is a dictionary of the form:
{
'role': role,
'content': content,
'type': 'action'/'stimulus'/'feedback',
'simulation_timestamp': timestamp
}
Args:
memories (list): The list of memories to consolidate.
sequential (bool): Whether the provided memories are to be interpreted sequentially (e.g., episodes in sequence) or not (e.g., abstract facts).
Returns:
list: A list with the consolidated memories, following the same format as the input memories, but different in content.
"""
raise NotImplementedError("Subclasses must implement this method.")
class EpisodicConsolidator(MemoryProcessor):
"""
Consolidates episodic memories into a more abstract representation, such as a summary or an abstract fact.
"""
def process(self, memories: list, timestamp: str=None, context:Union[str, list, dict] = None, persona:Union[str, dict] = None, sequential: bool = True) -> list:
logger.debug(f"STARTING MEMORY CONSOLIDATION: {len(memories)} memories to consolidate")
enriched_context = f"CURRENT COGNITIVE CONTEXT OF THE AGENT: {context}" if context else "No specific context provided for consolidation."
result = self._consolidate(memories, timestamp, enriched_context, persona)
logger.debug(f"Consolidated {len(memories)} memories into: {result}")
return result
@utils.llm(enable_json_output_format=True, enable_justification_step=False)
def _consolidate(self, memories: list, timestamp: str, context:str, persona:str) -> dict:
"""
Given a list of input episodic memories, this method consolidates them into more organized structured representations, which however preserve all information and important details.
For this process, you assume:
- This consolidation is being carried out by an agent, so the memories are from the agent's perspective. "Actions" refer to behaviors produced by the agent,
while "stimulus" refer to events or information from the environment or other agents that the agent has perceived.
* Thus, in the consoldation you write "I have done X" or "I have perceived Y", not "the agent has done X" or "the agent has perceived Y".
- The purpose of consolidation is to restructure and organize the most relevant information from the episodic memories, so that any facts learned therein can be used in future reasoning processes.
* If a `context` is provided, you can use it to guide the consolidation process, making sure that the memories are consolidated in the most useful way under the given context.
For example, if the agent is looking for a specific type of information, you can focus the consolidation on that type of information, preserving more details about it
than you would otherwise.
* If a `persona` is provided, you can use it to guide the consolidation process, making sure that the memories are consolidated in a way that is consistent with the persona.
For example, if the persona is that of a cat lover, you can focus the consolidation on the agent's experiences with cats, preserving more details about them than you would otherwise.
- If the memory contians a `content` field, that's where the relevant information is found. Otherwise, consider the whole memory as relevant information.
The consolidation process follows these rules:
- Each consolidated memory groups together all similar entries: so actions are grouped together, stimuli go together, facts are grouped together, impressions are grouped together,
learned processes are grouped together, and ad-hoc elements go together too. Noise, minor details and irrelevant elements are discarded.
In all, you will produce at most the following consolidated entries (you can avoid some if appropriate, but not add more):
* Actions: all actions are grouped together, giving an account of what the agent has done.
* Stimuli: all stimuli are grouped together, giving an account of what the agent has perceived.
* Facts: facts are extracted from the actions and stimuli, and then grouped together in a single entry, consolidating learning of objective facts.
* Impressions: impressions, feelings, or other subjective experiences are also extracted, and then grouped together in a single entry, consolidating subjective experiences.
* Procedural: learned processes (e.g., how to do certain things) are also extracted, formatted in an algorithmic way (i.e., pseudo-code that is self-explanatory), and then grouped together in a
single entry, consolidating learned processes.
* Ad-Hoc: important elements that do not correspond to these options are also grouped together in an ad-hoc single entry, consolidating other types of information.
- Each consolidated memory is a comprehensive report of the relevant information from the input memories, preserving all details. The consolidation merely reorganizes the information,
but does not remove any relevant information. The consolidated memories are not summaries, but rather a more organized and structured representation of the information in the input memories.
Each input memory is a dictionary of the form:
```
{
"role": role,
"content": content,
"type": "action"/"stimulus"/"feedback"/"reflection",
"simulation_timestamp": timestamp
}
```
Each consolidated output memory is a dictionary of the form:
```
{
"content": content,
"type": "consolidated",
"simulation_timestamp": timestamp of the consolidation
}
```
So the final value outputed **must** be a JSON composed of a list of dictionaries, each representing a consolidated memory, **always** with the following structure:
```
{"consolidation":
[
{
"content": content_1,
"type": "consolidated",
"simulation_timestamp": timestamp of the consolidation
},
{
"content": content_2,
"type": "consolidated",
"simulation_timestamp": timestamp of the consolidation
},
...
]
}
```
Note:
- because the output is a JSON, you must use double quotes for the keys and string values.
## Example (simplified)
Here's a simplified example. Suppose the following memory contents are provided as input (simplifying here as just a bullet list of contents):
- stimulus: "I have seen a cat, walking beautifully in the street"
- stimulus: "I have seen a dog, barking loudly at a passerby, looking very aggressive"
- action: "I have petted the cat, run around with him (or her?), saying a thousand times how cute it is, and how much I seem to like cats"
- action: "I just realized that I like cats more than dogs. For example, look at this one, it is so cute, so civilized, so noble, so elegant, an inspiring animal! I had never noted this before! "
- stimulus: "The cat is meowing very loudly, it seems to be hungry"
- stimulus: "Somehow a big capivara has appeared in the room, it is looking at me with curiosity"
Then, this would be a possible CORRECT output of the consolidation process (again, simplified, showing only contents in bullet list format):
- consolidated actions: "I have petted the cat, run around with it, and expressed my admiration for cats."
- consolidated stimuli: "I have seen a beautiful but hungry cat, a loud and agressive-looking dog, and - surprisingly - a capivara"
- consolidated impressions: "I felt great admiration for the cat, they look like such noble and elegant animals."
- consolidated facts: "I like cats more than dogs because they are cute and noble creatures."
These are correct because they focus on the agent's experience. In contrast, this would be an INCORRECT output of the consolidation process:
- consolidated actions: "the user sent messages about a cat, a dog and a capivara, and about playing with the cat."
- consolidated facts: "the assistant has received various messages at different times, and has performed actions in response to them."
These are incorrect because they focus on the agent's cognition and internal implementation mechanisms, not on the agent's experience.
Args:
memories (list): The list of memories to consolidate.
timestamp (str): The timestamp of the consolidation, which will be used in the consolidated memories instead of any original timestamp.
context (str, optional): Additional context to guide the consolidation process. This can be used to provide specific instructions or constraints for the consolidation.
persona (str, optional): The persona of the agent, which can be used to guide the consolidation process. This can be used to provide specific instructions or constraints for the consolidation.
Returns:
dict: A dictionary with a single key "consolidation", whose value is a list of consolidated memories, each represented as a dictionary with the structure described above.
"""
# llm annotation will handle the implementation
# TODO work in progress below
class ReflectionConsolidator(MemoryProcessor):
"""
Memory reflection mechanism.
"""
def process(self, memories: list, timestamp: str=None, context:Union[str, list, dict] = None, persona:Union[str, dict] = None, sequential: bool = True) -> list:
return self._reflect(memories, timestamp)
def _reflect(self, memories: list, timestamp: str) -> list:
"""
Given a list of input episodic memories, this method reflects on them and produces a more abstract representation, such as a summary or an abstract fact.
The reflection process follows these rules:
- Objective facts or knowledge that are present in the set of memories are grouped together, abstracted (if necessary) and summarized. The aim is to
produce a semantic memory.
- Impressions, feelings, or other subjective experiences are summarized into a more abstract representation, such as a summary or an abstract subjective fact.
- Timestamps in the consolidated memories refer to the moment of the reflection, not to the source events that produced the original episodic memories.
- No episodic memory is generated, all memories are consolidated as more abstract semantic memories.
- In general, the reflection process aims to reduce the number of memories while preserving the most relevant information and removing redundant or less relevant information.
"""
pass # TODO
def _reflect(self, memories: list, timestamp: str) -> list:
"""
Given a list of input episodic memories, this method reflects on them and produces a more abstract representation, such as a summary or an abstract fact.
The reflection process follows these rules:
- Objective facts or knowledge that are present in the set of memories are grouped together, abstracted (if necessary) and summarized. The aim is to
produce a semantic memory.
- Impressions, feelings, or other subjective experiences are summarized into a more abstract representation, such as a summary or an abstract subjective fact.
- Timestamps in the consolidated memories refer to the moment of the reflection, not to the source events that produced the original episodic memories.
- No episodic memory is generated, all memories are consolidated as more abstract semantic memories.
- In general, the reflection process aims to reduce the number of memories while preserving the most relevant information and removing redundant or less relevant information.
"""
pass # TODO</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="tinytroupe.agent.memory.EpisodicConsolidator"><code class="flex name class">
<span>class <span class="ident">EpisodicConsolidator</span></span>
</code></dt>
<dd>
<div class="desc"><p>Consolidates episodic memories into a more abstract representation, such as a summary or an abstract fact.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class EpisodicConsolidator(MemoryProcessor):
"""
Consolidates episodic memories into a more abstract representation, such as a summary or an abstract fact.
"""
def process(self, memories: list, timestamp: str=None, context:Union[str, list, dict] = None, persona:Union[str, dict] = None, sequential: bool = True) -> list:
logger.debug(f"STARTING MEMORY CONSOLIDATION: {len(memories)} memories to consolidate")
enriched_context = f"CURRENT COGNITIVE CONTEXT OF THE AGENT: {context}" if context else "No specific context provided for consolidation."
result = self._consolidate(memories, timestamp, enriched_context, persona)
logger.debug(f"Consolidated {len(memories)} memories into: {result}")
return result
@utils.llm(enable_json_output_format=True, enable_justification_step=False)
def _consolidate(self, memories: list, timestamp: str, context:str, persona:str) -> dict:
"""
Given a list of input episodic memories, this method consolidates them into more organized structured representations, which however preserve all information and important details.
For this process, you assume:
- This consolidation is being carried out by an agent, so the memories are from the agent's perspective. "Actions" refer to behaviors produced by the agent,
while "stimulus" refer to events or information from the environment or other agents that the agent has perceived.
* Thus, in the consoldation you write "I have done X" or "I have perceived Y", not "the agent has done X" or "the agent has perceived Y".
- The purpose of consolidation is to restructure and organize the most relevant information from the episodic memories, so that any facts learned therein can be used in future reasoning processes.
* If a `context` is provided, you can use it to guide the consolidation process, making sure that the memories are consolidated in the most useful way under the given context.
For example, if the agent is looking for a specific type of information, you can focus the consolidation on that type of information, preserving more details about it
than you would otherwise.
* If a `persona` is provided, you can use it to guide the consolidation process, making sure that the memories are consolidated in a way that is consistent with the persona.
For example, if the persona is that of a cat lover, you can focus the consolidation on the agent's experiences with cats, preserving more details about them than you would otherwise.
- If the memory contians a `content` field, that's where the relevant information is found. Otherwise, consider the whole memory as relevant information.
The consolidation process follows these rules:
- Each consolidated memory groups together all similar entries: so actions are grouped together, stimuli go together, facts are grouped together, impressions are grouped together,
learned processes are grouped together, and ad-hoc elements go together too. Noise, minor details and irrelevant elements are discarded.
In all, you will produce at most the following consolidated entries (you can avoid some if appropriate, but not add more):
* Actions: all actions are grouped together, giving an account of what the agent has done.
* Stimuli: all stimuli are grouped together, giving an account of what the agent has perceived.
* Facts: facts are extracted from the actions and stimuli, and then grouped together in a single entry, consolidating learning of objective facts.
* Impressions: impressions, feelings, or other subjective experiences are also extracted, and then grouped together in a single entry, consolidating subjective experiences.
* Procedural: learned processes (e.g., how to do certain things) are also extracted, formatted in an algorithmic way (i.e., pseudo-code that is self-explanatory), and then grouped together in a
single entry, consolidating learned processes.
* Ad-Hoc: important elements that do not correspond to these options are also grouped together in an ad-hoc single entry, consolidating other types of information.
- Each consolidated memory is a comprehensive report of the relevant information from the input memories, preserving all details. The consolidation merely reorganizes the information,
but does not remove any relevant information. The consolidated memories are not summaries, but rather a more organized and structured representation of the information in the input memories.
Each input memory is a dictionary of the form:
```
{
"role": role,
"content": content,
"type": "action"/"stimulus"/"feedback"/"reflection",
"simulation_timestamp": timestamp
}
```
Each consolidated output memory is a dictionary of the form:
```
{
"content": content,
"type": "consolidated",
"simulation_timestamp": timestamp of the consolidation
}
```
So the final value outputed **must** be a JSON composed of a list of dictionaries, each representing a consolidated memory, **always** with the following structure:
```
{"consolidation":
[
{
"content": content_1,
"type": "consolidated",
"simulation_timestamp": timestamp of the consolidation
},
{
"content": content_2,
"type": "consolidated",
"simulation_timestamp": timestamp of the consolidation
},
...
]
}
```
Note:
- because the output is a JSON, you must use double quotes for the keys and string values.
## Example (simplified)
Here's a simplified example. Suppose the following memory contents are provided as input (simplifying here as just a bullet list of contents):
- stimulus: "I have seen a cat, walking beautifully in the street"
- stimulus: "I have seen a dog, barking loudly at a passerby, looking very aggressive"
- action: "I have petted the cat, run around with him (or her?), saying a thousand times how cute it is, and how much I seem to like cats"
- action: "I just realized that I like cats more than dogs. For example, look at this one, it is so cute, so civilized, so noble, so elegant, an inspiring animal! I had never noted this before! "
- stimulus: "The cat is meowing very loudly, it seems to be hungry"
- stimulus: "Somehow a big capivara has appeared in the room, it is looking at me with curiosity"
Then, this would be a possible CORRECT output of the consolidation process (again, simplified, showing only contents in bullet list format):
- consolidated actions: "I have petted the cat, run around with it, and expressed my admiration for cats."
- consolidated stimuli: "I have seen a beautiful but hungry cat, a loud and agressive-looking dog, and - surprisingly - a capivara"
- consolidated impressions: "I felt great admiration for the cat, they look like such noble and elegant animals."
- consolidated facts: "I like cats more than dogs because they are cute and noble creatures."
These are correct because they focus on the agent's experience. In contrast, this would be an INCORRECT output of the consolidation process:
- consolidated actions: "the user sent messages about a cat, a dog and a capivara, and about playing with the cat."
- consolidated facts: "the assistant has received various messages at different times, and has performed actions in response to them."
These are incorrect because they focus on the agent's cognition and internal implementation mechanisms, not on the agent's experience.
Args:
memories (list): The list of memories to consolidate.
timestamp (str): The timestamp of the consolidation, which will be used in the consolidated memories instead of any original timestamp.
context (str, optional): Additional context to guide the consolidation process. This can be used to provide specific instructions or constraints for the consolidation.
persona (str, optional): The persona of the agent, which can be used to guide the consolidation process. This can be used to provide specific instructions or constraints for the consolidation.
Returns:
dict: A dictionary with a single key "consolidation", whose value is a list of consolidated memories, each represented as a dictionary with the structure described above.
"""
# llm annotation will handle the implementation</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.memory.MemoryProcessor" href="#tinytroupe.agent.memory.MemoryProcessor">MemoryProcessor</a></li>
</ul>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.memory.MemoryProcessor" href="#tinytroupe.agent.memory.MemoryProcessor">MemoryProcessor</a></b></code>:
<ul class="hlist">
<li><code><a title="tinytroupe.agent.memory.MemoryProcessor.process" href="#tinytroupe.agent.memory.MemoryProcessor.process">process</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="tinytroupe.agent.memory.EpisodicMemory"><code class="flex name class">
<span>class <span class="ident">EpisodicMemory</span></span>
<span>(</span><span>fixed_prefix_length: int = 20, lookback_length: int = 100)</span>
</code></dt>
<dd>
<div class="desc"><p>Provides episodic memory capabilities to an agent. Cognitively, episodic memory is the ability to remember specific events,
or episodes, in the past. This class provides a simple implementation of episodic memory, where the agent can store and retrieve
messages from memory.</p>
<p>Subclasses of this class can be used to provide different memory implementations.</p>
<p>Initializes the memory.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>fixed_prefix_length</code></strong> : <code>int</code></dt>
<dd>The fixed prefix length. Defaults to 20.</dd>
<dt><strong><code>lookback_length</code></strong> : <code>int</code></dt>
<dd>The lookback length. Defaults to 100.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class EpisodicMemory(TinyMemory):
"""
Provides episodic memory capabilities to an agent. Cognitively, episodic memory is the ability to remember specific events,
or episodes, in the past. This class provides a simple implementation of episodic memory, where the agent can store and retrieve
messages from memory.
Subclasses of this class can be used to provide different memory implementations.
"""
MEMORY_BLOCK_OMISSION_INFO = {'role': 'assistant', 'content': "Info: there were other messages here, but they were omitted for brevity.", 'simulation_timestamp': None}
def __init__(
self, fixed_prefix_length: int = 20, lookback_length: int = 100
) -> None:
"""
Initializes the memory.
Args:
fixed_prefix_length (int): The fixed prefix length. Defaults to 20.
lookback_length (int): The lookback length. Defaults to 100.
"""
self.fixed_prefix_length = fixed_prefix_length
self.lookback_length = lookback_length
# the definitive memory that records all episodic events
self.memory = []
# the current episode buffer, which is used to store messages during an episode
self.episodic_buffer = []
def commit_episode(self):
"""
Ends the current episode, storing the episodic buffer in memory.
"""
self.memory.extend(self.episodic_buffer)
self.episodic_buffer = []
def get_current_episode(self, item_types:list=None) -> list:
"""
Returns the current episode buffer, which is used to store messages during an episode.
Args:
item_types (list, optional): If provided, only retrieve memories of these types. Defaults to None, which retrieves all types.
Returns:
list: The current episode buffer.
"""
result = copy.copy(self.episodic_buffer)
result = self.filter_by_item_types(result, item_types) if item_types is not None else result
return result
def count(self) -> int:
"""
Returns the number of values in memory.
"""
return len(self._memory_with_current_buffer())
def clear(self, max_prefix_to_clear:int=None, max_suffix_to_clear:int=None):
"""
Clears the memory, generating a permanent "episodic amnesia".
If max_prefix_to_clear is not None, it clears the first n values from memory.
If max_suffix_to_clear is not None, it clears the last n values from memory. If both are None,
it clears all values from memory.
Args:
max_prefix_to_clear (int): The number of first values to clear.
max_suffix_to_clear (int): The number of last values to clear.
"""
# clears all episodic buffer messages
self.episodic_buffer = []
# then clears the memory according to the parameters
if max_prefix_to_clear is not None:
self.memory = self.memory[max_prefix_to_clear:]
if max_suffix_to_clear is not None:
self.memory = self.memory[:-max_suffix_to_clear]
if max_prefix_to_clear is None and max_suffix_to_clear is None:
self.memory = []
def _memory_with_current_buffer(self) -> list:
"""
Returns the current memory, including the episodic buffer.
This is useful for retrieving the most recent memories, including the current episode.
"""
return self.memory + self.episodic_buffer
######################################
# General memory methods
######################################
def _store(self, value: Any) -> None:
"""
Stores a value in memory.
"""
self.episodic_buffer.append(value)
def retrieve(self, first_n: int, last_n: int, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the first n and/or last n values from memory. If n is None, all values are retrieved.
Args:
first_n (int): The number of first values to retrieve.
last_n (int): The number of last values to retrieve.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
Returns:
list: The retrieved values.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
# use the other methods in the class to implement
if first_n is not None and last_n is not None:
return self.retrieve_first(first_n, include_omission_info=False, item_type=item_type) + omisssion_info + self.retrieve_last(last_n, include_omission_info=False, item_type=item_type)
elif first_n is not None:
return self.retrieve_first(first_n, include_omission_info, item_type=item_type)
elif last_n is not None:
return self.retrieve_last(last_n, include_omission_info, item_type=item_type)
else:
return self.retrieve_all(item_type=item_type)
def retrieve_recent(self, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the n most recent values from memory.
Args:
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
# Filter memories if item_type is provided
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
# compute fixed prefix
fixed_prefix = memories[: self.fixed_prefix_length] + omisssion_info
# how many lookback values remain?
remaining_lookback = min(
len(memories) - len(fixed_prefix) + (1 if include_omission_info else 0), self.lookback_length
)
# compute the remaining lookback values and return the concatenation
if remaining_lookback <= 0:
return fixed_prefix
else:
return fixed_prefix + memories[-remaining_lookback:]
def retrieve_all(self, item_type:str=None) -> list:
"""
Retrieves all values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
return copy.copy(memories)
def retrieve_relevant(self, relevance_target: str, top_k:int) -> list:
"""
Retrieves top-k values from memory that are most relevant to a given target.
"""
raise NotImplementedError("Subclasses must implement this method.")
def retrieve_first(self, n: int, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the first n values from memory.
Args:
n (int): The number of values to retrieve.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
return memories[:n] + omisssion_info
def retrieve_last(self, n: int=None, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the last n values from memory.
Args:
n (int): The number of values to retrieve, or None to retrieve all values.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
memories = memories[-n:] if n is not None else memories
return omisssion_info + memories </code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.memory.TinyMemory" href="#tinytroupe.agent.memory.TinyMemory">TinyMemory</a></li>
<li><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty">TinyMentalFaculty</a></li>
<li><a title="tinytroupe.utils.json.JsonSerializableRegistry" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry">JsonSerializableRegistry</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="tinytroupe.agent.memory.EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO"><code class="name">var <span class="ident">MEMORY_BLOCK_OMISSION_INFO</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="tinytroupe.agent.memory.EpisodicMemory.clear"><code class="name flex">
<span>def <span class="ident">clear</span></span>(<span>self, max_prefix_to_clear: int = None, max_suffix_to_clear: int = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Clears the memory, generating a permanent "episodic amnesia".
If max_prefix_to_clear is not None, it clears the first n values from memory.
If max_suffix_to_clear is not None, it clears the last n values from memory. If both are None,
it clears all values from memory.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>max_prefix_to_clear</code></strong> : <code>int</code></dt>
<dd>The number of first values to clear.</dd>
<dt><strong><code>max_suffix_to_clear</code></strong> : <code>int</code></dt>
<dd>The number of last values to clear.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def clear(self, max_prefix_to_clear:int=None, max_suffix_to_clear:int=None):
"""
Clears the memory, generating a permanent "episodic amnesia".
If max_prefix_to_clear is not None, it clears the first n values from memory.
If max_suffix_to_clear is not None, it clears the last n values from memory. If both are None,
it clears all values from memory.
Args:
max_prefix_to_clear (int): The number of first values to clear.
max_suffix_to_clear (int): The number of last values to clear.
"""
# clears all episodic buffer messages
self.episodic_buffer = []
# then clears the memory according to the parameters
if max_prefix_to_clear is not None:
self.memory = self.memory[max_prefix_to_clear:]
if max_suffix_to_clear is not None:
self.memory = self.memory[:-max_suffix_to_clear]
if max_prefix_to_clear is None and max_suffix_to_clear is None:
self.memory = []</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.EpisodicMemory.commit_episode"><code class="name flex">
<span>def <span class="ident">commit_episode</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Ends the current episode, storing the episodic buffer in memory.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def commit_episode(self):
"""
Ends the current episode, storing the episodic buffer in memory.
"""
self.memory.extend(self.episodic_buffer)
self.episodic_buffer = []</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.EpisodicMemory.count"><code class="name flex">
<span>def <span class="ident">count</span></span>(<span>self) ‑> int</span>
</code></dt>
<dd>
<div class="desc"><p>Returns the number of values in memory.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def count(self) -> int:
"""
Returns the number of values in memory.
"""
return len(self._memory_with_current_buffer())</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.EpisodicMemory.get_current_episode"><code class="name flex">
<span>def <span class="ident">get_current_episode</span></span>(<span>self, item_types: list = None) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Returns the current episode buffer, which is used to store messages during an episode.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>item_types</code></strong> : <code>list</code>, optional</dt>
<dd>If provided, only retrieve memories of these types. Defaults to None, which retrieves all types.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>The current episode buffer.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_current_episode(self, item_types:list=None) -> list:
"""
Returns the current episode buffer, which is used to store messages during an episode.
Args:
item_types (list, optional): If provided, only retrieve memories of these types. Defaults to None, which retrieves all types.
Returns:
list: The current episode buffer.
"""
result = copy.copy(self.episodic_buffer)
result = self.filter_by_item_types(result, item_types) if item_types is not None else result
return result</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.EpisodicMemory.retrieve_first"><code class="name flex">
<span>def <span class="ident">retrieve_first</span></span>(<span>self, n: int, include_omission_info: bool = True, item_type: str = None) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Retrieves the first n values from memory.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>n</code></strong> : <code>int</code></dt>
<dd>The number of values to retrieve.</dd>
<dt><strong><code>include_omission_info</code></strong> : <code>bool</code></dt>
<dd>Whether to include an information message when some values are omitted.</dd>
<dt><strong><code>item_type</code></strong> : <code>str</code>, optional</dt>
<dd>If provided, only retrieve memories of this type.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_first(self, n: int, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the first n values from memory.
Args:
n (int): The number of values to retrieve.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
return memories[:n] + omisssion_info</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.EpisodicMemory.retrieve_last"><code class="name flex">
<span>def <span class="ident">retrieve_last</span></span>(<span>self, n: int = None, include_omission_info: bool = True, item_type: str = None) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Retrieves the last n values from memory.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>n</code></strong> : <code>int</code></dt>
<dd>The number of values to retrieve, or None to retrieve all values.</dd>
<dt><strong><code>include_omission_info</code></strong> : <code>bool</code></dt>
<dd>Whether to include an information message when some values are omitted.</dd>
<dt><strong><code>item_type</code></strong> : <code>str</code>, optional</dt>
<dd>If provided, only retrieve memories of this type.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_last(self, n: int=None, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the last n values from memory.
Args:
n (int): The number of values to retrieve, or None to retrieve all values.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
memories = memories[-n:] if n is not None else memories
return omisssion_info + memories </code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.EpisodicMemory.retrieve_recent"><code class="name flex">
<span>def <span class="ident">retrieve_recent</span></span>(<span>self, include_omission_info: bool = True, item_type: str = None) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Retrieves the n most recent values from memory.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>include_omission_info</code></strong> : <code>bool</code></dt>
<dd>Whether to include an information message when some values are omitted.</dd>
<dt><strong><code>item_type</code></strong> : <code>str</code>, optional</dt>
<dd>If provided, only retrieve memories of this type.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_recent(self, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the n most recent values from memory.
Args:
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
"""
omisssion_info = [EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO] if include_omission_info else []
# Filter memories if item_type is provided
memories = self._memory_with_current_buffer() if item_type is None else self.filter_by_item_type(self._memory_with_current_buffer(), item_type)
# compute fixed prefix
fixed_prefix = memories[: self.fixed_prefix_length] + omisssion_info
# how many lookback values remain?
remaining_lookback = min(
len(memories) - len(fixed_prefix) + (1 if include_omission_info else 0), self.lookback_length
)
# compute the remaining lookback values and return the concatenation
if remaining_lookback <= 0:
return fixed_prefix
else:
return fixed_prefix + memories[-remaining_lookback:]</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.EpisodicMemory.retrieve_relevant"><code class="name flex">
<span>def <span class="ident">retrieve_relevant</span></span>(<span>self, relevance_target: str, top_k: int) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Retrieves top-k values from memory that are most relevant to a given target.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_relevant(self, relevance_target: str, top_k:int) -> list:
"""
Retrieves top-k values from memory that are most relevant to a given target.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.memory.TinyMemory" href="#tinytroupe.agent.memory.TinyMemory">TinyMemory</a></b></code>:
<ul class="hlist">
<li><code><a title="tinytroupe.agent.memory.TinyMemory.actions_constraints_prompt" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_constraints_prompt">actions_constraints_prompt</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.actions_definitions_prompt" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_definitions_prompt">actions_definitions_prompt</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.filter_by_item_type" href="#tinytroupe.agent.memory.TinyMemory.filter_by_item_type">filter_by_item_type</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.filter_by_item_types" href="#tinytroupe.agent.memory.TinyMemory.filter_by_item_types">filter_by_item_types</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.from_json" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry.from_json">from_json</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.process_action" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.process_action">process_action</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve" href="#tinytroupe.agent.memory.TinyMemory.retrieve">retrieve</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve_all" href="#tinytroupe.agent.memory.TinyMemory.retrieve_all">retrieve_all</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.store" href="#tinytroupe.agent.memory.TinyMemory.store">store</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.store_all" href="#tinytroupe.agent.memory.TinyMemory.store_all">store_all</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.summarize_relevant_via_full_scan" href="#tinytroupe.agent.memory.TinyMemory.summarize_relevant_via_full_scan">summarize_relevant_via_full_scan</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.to_json" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry.to_json">to_json</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="tinytroupe.agent.memory.MemoryProcessor"><code class="flex name class">
<span>class <span class="ident">MemoryProcessor</span></span>
</code></dt>
<dd>
<div class="desc"><p>Base class for memory consolidation and optimization mechanisms.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class MemoryProcessor:
"""
Base class for memory consolidation and optimization mechanisms.
"""
def process(self, memories: list, timestamp: str=None, context:Union[str, list, dict] = None, persona:Union[str, dict] = None, sequential: bool = True) -> list:
"""
Transforms the given memories. Transformation can be anything from consolidation to optimization, depending on the implementation.
Each memory is a dictionary of the form:
{
'role': role,
'content': content,
'type': 'action'/'stimulus'/'feedback',
'simulation_timestamp': timestamp
}
Args:
memories (list): The list of memories to consolidate.
sequential (bool): Whether the provided memories are to be interpreted sequentially (e.g., episodes in sequence) or not (e.g., abstract facts).
Returns:
list: A list with the consolidated memories, following the same format as the input memories, but different in content.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.memory.EpisodicConsolidator" href="#tinytroupe.agent.memory.EpisodicConsolidator">EpisodicConsolidator</a></li>
<li><a title="tinytroupe.agent.memory.ReflectionConsolidator" href="#tinytroupe.agent.memory.ReflectionConsolidator">ReflectionConsolidator</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="tinytroupe.agent.memory.MemoryProcessor.process"><code class="name flex">
<span>def <span class="ident">process</span></span>(<span>self, memories: list, timestamp: str = None, context: Union[str, list, dict] = None, persona: Union[str, dict] = None, sequential: bool = True) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Transforms the given memories. Transformation can be anything from consolidation to optimization, depending on the implementation.</p>
<p>Each memory is a dictionary of the form:
{
'role': role,
'content': content,
'type': 'action'/'stimulus'/'feedback',
'simulation_timestamp': timestamp
}</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>memories</code></strong> : <code>list</code></dt>
<dd>The list of memories to consolidate.</dd>
<dt><strong><code>sequential</code></strong> : <code>bool</code></dt>
<dd>Whether the provided memories are to be interpreted sequentially (e.g., episodes in sequence) or not (e.g., abstract facts).</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>A list with the consolidated memories, following the same format as the input memories, but different in content.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def process(self, memories: list, timestamp: str=None, context:Union[str, list, dict] = None, persona:Union[str, dict] = None, sequential: bool = True) -> list:
"""
Transforms the given memories. Transformation can be anything from consolidation to optimization, depending on the implementation.
Each memory is a dictionary of the form:
{
'role': role,
'content': content,
'type': 'action'/'stimulus'/'feedback',
'simulation_timestamp': timestamp
}
Args:
memories (list): The list of memories to consolidate.
sequential (bool): Whether the provided memories are to be interpreted sequentially (e.g., episodes in sequence) or not (e.g., abstract facts).
Returns:
list: A list with the consolidated memories, following the same format as the input memories, but different in content.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
</dd>
</dl>
</dd>
<dt id="tinytroupe.agent.memory.ReflectionConsolidator"><code class="flex name class">
<span>class <span class="ident">ReflectionConsolidator</span></span>
</code></dt>
<dd>
<div class="desc"><p>Memory reflection mechanism.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ReflectionConsolidator(MemoryProcessor):
"""
Memory reflection mechanism.
"""
def process(self, memories: list, timestamp: str=None, context:Union[str, list, dict] = None, persona:Union[str, dict] = None, sequential: bool = True) -> list:
return self._reflect(memories, timestamp)
def _reflect(self, memories: list, timestamp: str) -> list:
"""
Given a list of input episodic memories, this method reflects on them and produces a more abstract representation, such as a summary or an abstract fact.
The reflection process follows these rules:
- Objective facts or knowledge that are present in the set of memories are grouped together, abstracted (if necessary) and summarized. The aim is to
produce a semantic memory.
- Impressions, feelings, or other subjective experiences are summarized into a more abstract representation, such as a summary or an abstract subjective fact.
- Timestamps in the consolidated memories refer to the moment of the reflection, not to the source events that produced the original episodic memories.
- No episodic memory is generated, all memories are consolidated as more abstract semantic memories.
- In general, the reflection process aims to reduce the number of memories while preserving the most relevant information and removing redundant or less relevant information.
"""
pass # TODO
def _reflect(self, memories: list, timestamp: str) -> list:
"""
Given a list of input episodic memories, this method reflects on them and produces a more abstract representation, such as a summary or an abstract fact.
The reflection process follows these rules:
- Objective facts or knowledge that are present in the set of memories are grouped together, abstracted (if necessary) and summarized. The aim is to
produce a semantic memory.
- Impressions, feelings, or other subjective experiences are summarized into a more abstract representation, such as a summary or an abstract subjective fact.
- Timestamps in the consolidated memories refer to the moment of the reflection, not to the source events that produced the original episodic memories.
- No episodic memory is generated, all memories are consolidated as more abstract semantic memories.
- In general, the reflection process aims to reduce the number of memories while preserving the most relevant information and removing redundant or less relevant information.
"""
pass # TODO</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.memory.MemoryProcessor" href="#tinytroupe.agent.memory.MemoryProcessor">MemoryProcessor</a></li>
</ul>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.memory.MemoryProcessor" href="#tinytroupe.agent.memory.MemoryProcessor">MemoryProcessor</a></b></code>:
<ul class="hlist">
<li><code><a title="tinytroupe.agent.memory.MemoryProcessor.process" href="#tinytroupe.agent.memory.MemoryProcessor.process">process</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="tinytroupe.agent.memory.SemanticMemory"><code class="flex name class">
<span>class <span class="ident">SemanticMemory</span></span>
<span>(</span><span>*args, **kwargs)</span>
</code></dt>
<dd>
<div class="desc"><p>In Cognitive Psychology, semantic memory is the memory of meanings, understandings, and other concept-based knowledge unrelated to specific
experiences. It is not ordered temporally, and it is not about remembering specific events or episodes. This class provides a simple implementation
of semantic memory, where the agent can store and retrieve semantic information.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@utils.post_init
class SemanticMemory(TinyMemory):
"""
In Cognitive Psychology, semantic memory is the memory of meanings, understandings, and other concept-based knowledge unrelated to specific
experiences. It is not ordered temporally, and it is not about remembering specific events or episodes. This class provides a simple implementation
of semantic memory, where the agent can store and retrieve semantic information.
"""
serializable_attributes = ["memories", "semantic_grounding_connector"]
def __init__(self, memories: list=None) -> None:
self.memories = memories
self.semantic_grounding_connector = None
# @post_init ensures that _post_init is called after the __init__ method
def _post_init(self):
"""
This will run after __init__, since the class has the @post_init decorator.
It is convenient to separate some of the initialization processes to make deserialize easier.
"""
if not hasattr(self, 'memories') or self.memories is None:
self.memories = []
if not hasattr(self, 'semantic_grounding_connector') or self.semantic_grounding_connector is None:
self.semantic_grounding_connector = BaseSemanticGroundingConnector("Semantic Memory Storage")
# TODO remove?
#self.semantic_grounding_connector.add_documents(self._build_documents_from(self.memories))
def _preprocess_value_for_storage(self, value: dict) -> Any:
logger.debug(f"Preprocessing value for storage: {value}")
if isinstance(value, dict):
engram = {"role": "assistant",
"content": value['content'],
"type": value.get("type", "information"), # Default to 'information' if type is not specified
"simulation_timestamp": value.get("simulation_timestamp", None)}
# Refine the content of the engram is built based on the type of the value to make it more meaningful.
if value['type'] == 'action':
engram['content'] = f"# Action performed\n" +\
f"I have performed the following action at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
elif value['type'] == 'stimulus':
engram['content'] = f"# Stimulus\n" +\
f"I have received the following stimulus at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
elif value['type'] == 'feedback':
engram['content'] = f"# Feedback\n" +\
f"I have received the following feedback at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
elif value['type'] == 'consolidated':
engram['content'] = f"# Consolidated Memory\n" +\
f"I have consolidated the following memory at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
elif value['type'] == 'reflection':
engram['content'] = f"# Reflection\n" +\
f"I have reflected on the following memory at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
else:
engram['content'] = f"# Information\n" +\
f"I have obtained following information at date and time {value['simulation_timestamp']}:\n\n"+\
f" {value['content']}"
# else: # Anything else here?
else:
# If the value is not a dictionary, we just store it as is, but we still wrap it in an engram
engram = {"role": "assistant",
"content": value,
"type": "information", # Default to 'information' if type is not specified
"simulation_timestamp": None}
logger.debug(f"Engram created for storage: {engram}")
return engram
def _store(self, value: Any) -> None:
logger.debug(f"Preparing engram for semantic memory storage, input value: {value}")
self.memories.append(value) # Store the value in the local memory list
# then econduct the value to a Document and store it in the semantic grounding connector
# This is the actual storage in the semantic memory to allow semantic retrieval
engram_doc = self._build_document_from(value)
logger.debug(f"Storing engram in semantic memory: {engram_doc}")
self.semantic_grounding_connector.add_document(engram_doc)
def retrieve_relevant(self, relevance_target:str, top_k=20) -> list:
"""
Retrieves all values from memory that are relevant to a given target.
"""
return self.semantic_grounding_connector.retrieve_relevant(relevance_target, top_k)
def retrieve_all(self, item_type:str=None) -> list:
"""
Retrieves all values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
memories = []
logger.debug(f"Retrieving all documents from semantic memory connector, a total of {len(self.semantic_grounding_connector.documents)} documents.")
for document in self.semantic_grounding_connector.documents:
logger.debug(f"Retrieving document from semantic memory: {document}")
memory_text = document.text
logger.debug(f"Document text retrieved: {memory_text}")
try:
memory = json.loads(memory_text)
logger.debug(f"Memory retrieved: {memory}")
memories.append(memory)
except json.JSONDecodeError as e:
logger.warning(f"Could not decode memory from document text: {memory_text}. Error: {e}")
if item_type is not None:
memories = self.filter_by_item_type(memories, item_type)
return memories
#####################################
# Auxiliary compatibility methods
#####################################
def _build_document_from(self, memory) -> Document:
# TODO: add any metadata as well?
# make sure we are dealing with a dictionary
if not isinstance(memory, dict):
memory = {"content": memory, "type": "information"}
# ensures double quotes are used for JSON serialization, and maybe other formatting details
memory_txt = json.dumps(memory, ensure_ascii=False)
logger.debug(f"Building document from memory: {memory_txt}")
return Document(text=memory_txt)
def _build_documents_from(self, memories: list) -> list:
return [self._build_document_from(memory) for memory in memories]</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.memory.TinyMemory" href="#tinytroupe.agent.memory.TinyMemory">TinyMemory</a></li>
<li><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty">TinyMentalFaculty</a></li>
<li><a title="tinytroupe.utils.json.JsonSerializableRegistry" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry">JsonSerializableRegistry</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="tinytroupe.agent.memory.SemanticMemory.serializable_attributes"><code class="name">var <span class="ident">serializable_attributes</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.memory.TinyMemory" href="#tinytroupe.agent.memory.TinyMemory">TinyMemory</a></b></code>:
<ul class="hlist">
<li><code><a title="tinytroupe.agent.memory.TinyMemory.actions_constraints_prompt" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_constraints_prompt">actions_constraints_prompt</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.actions_definitions_prompt" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_definitions_prompt">actions_definitions_prompt</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.filter_by_item_type" href="#tinytroupe.agent.memory.TinyMemory.filter_by_item_type">filter_by_item_type</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.filter_by_item_types" href="#tinytroupe.agent.memory.TinyMemory.filter_by_item_types">filter_by_item_types</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.from_json" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry.from_json">from_json</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.process_action" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.process_action">process_action</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve" href="#tinytroupe.agent.memory.TinyMemory.retrieve">retrieve</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve_all" href="#tinytroupe.agent.memory.TinyMemory.retrieve_all">retrieve_all</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve_recent" href="#tinytroupe.agent.memory.TinyMemory.retrieve_recent">retrieve_recent</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve_relevant" href="#tinytroupe.agent.memory.TinyMemory.retrieve_relevant">retrieve_relevant</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.store" href="#tinytroupe.agent.memory.TinyMemory.store">store</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.store_all" href="#tinytroupe.agent.memory.TinyMemory.store_all">store_all</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.summarize_relevant_via_full_scan" href="#tinytroupe.agent.memory.TinyMemory.summarize_relevant_via_full_scan">summarize_relevant_via_full_scan</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.to_json" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry.to_json">to_json</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory"><code class="flex name class">
<span>class <span class="ident">TinyMemory</span></span>
<span>(</span><span>name: str, requires_faculties: list = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Base class for different types of memory.</p>
<p>Initializes the mental faculty.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>name</code></strong> : <code>str</code></dt>
<dd>The name of the mental faculty.</dd>
<dt><strong><code>requires_faculties</code></strong> : <code>list</code></dt>
<dd>A list of mental faculties that this faculty requires to function properly.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class TinyMemory(TinyMentalFaculty):
"""
Base class for different types of memory.
"""
def _preprocess_value_for_storage(self, value: Any) -> Any:
"""
Preprocesses a value before storing it in memory.
"""
# by default, we don't preprocess the value
return value
def _store(self, value: Any) -> None:
"""
Stores a value in memory.
"""
raise NotImplementedError("Subclasses must implement this method.")
def store(self, value: dict) -> None:
"""
Stores a value in memory.
"""
self._store(self._preprocess_value_for_storage(value))
def store_all(self, values: list) -> None:
"""
Stores a list of values in memory.
"""
logger.debug(f"Storing {len(values)} values in memory: {values}")
for i, value in enumerate(values):
logger.debug(f"Storing value #{i}: {value}")
self.store(value)
def retrieve(self, first_n: int, last_n: int, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the first n and/or last n values from memory. If n is None, all values are retrieved.
Args:
first_n (int): The number of first values to retrieve.
last_n (int): The number of last values to retrieve.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
Returns:
list: The retrieved values.
"""
raise NotImplementedError("Subclasses must implement this method.")
def retrieve_recent(self, item_type:str=None) -> list:
"""
Retrieves the n most recent values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
raise NotImplementedError("Subclasses must implement this method.")
def retrieve_all(self, item_type:str=None) -> list:
"""
Retrieves all values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
raise NotImplementedError("Subclasses must implement this method.")
def retrieve_relevant(self, relevance_target:str, top_k=20) -> list:
"""
Retrieves all values from memory that are relevant to a given target.
"""
raise NotImplementedError("Subclasses must implement this method.")
def summarize_relevant_via_full_scan(self, relevance_target: str, batch_size: int = 20, item_type: str = None) -> str:
"""
Performs a full scan of the memory, extracting and accumulating information relevant to a query.
This function processes all memories (or memories of a specific type if provided),
extracts information relevant to the query from each memory, and accumulates this
information into a coherent response.
Args:
relevance_target (str): The query specifying what information to extract from memories.
item_type (str, optional): If provided, only process memories of this type.
batch_size (int): The number of memories to process in each extraction step. The larger it is, the faster the scan, but possibly less accurate.
Also, a too large value may lead to prompt length overflows, though current models can handle quite large prompts.
Returns:
str: The accumulated information relevant to the query.
"""
logger.debug(f"Starting FULL SCAN for relevance target: {relevance_target}, item type: {item_type}")
# Retrieve all memories of the specified type
memories = self.retrieve_all(item_type=item_type)
# Initialize accumulation
accumulated_info = ""
# Process memories in batches of qty_of_memories_per_extraction
for i in range(0, len(memories), batch_size):
batch = memories[i:i + batch_size]
logger.debug(f"Processing memory batch #{i} in full scan")
# Concatenate memory texts for the batch
batch_text = "# Memories to be processed\n\n"
batch_text += "\n\n ".join(str(memory) for memory in batch)
# Extract information relevant to the query from the batch
extracted_info = utils.semantics.extract_information_from_text(
relevance_target,
batch_text,
context="""
You are extracting information from the an agent's memory,
which might include actions, stimuli, and other types of events. You want to focus on the agent's experience, NOT on the agent's cognition or internal processes.
Assume that:
- "actions" refer to behaviors produced by the agent,
- "stimulus" refer to events or information from the environment or other agents that the agent perceived.
If you read about "assistant" and "user" roles, you can ignore them, as they refer to the agent's internal implementation mechanisms, not to the agent's experience.
In any case, anything related to "assistant" is the agent's output, and anything related to "user" is the agent's input. But you never refer to these roles in the report,
as they are an internal implementation detail of the agent, not part of the agent's experience.
"""
)
logger.debug(f"Extracted information from memory batch: {extracted_info}")
# Skip if no relevant information was found
if not extracted_info:
continue
# Accumulate the extracted information
accumulated_info = utils.semantics.accumulate_based_on_query(
query=relevance_target,
new_entry=extracted_info,
current_accumulation=accumulated_info,
context="""
You are producing a report based on information from an agent's memory.
You will put together all facts and experiences found that are relevant for the query, as a kind of summary of the agent's experience.
The report will later be used to guide further agent action. You focus on the agent's experience, NOT on the agent's cognition or internal processes.
Assume that:
- "actions" refer to behaviors produced by the agent,
- "stimulus" refer to events or information from the environment or other agents that the agent perceived.
- if you read about "assistant" and "user" roles, you can ignore them, as they refer to the agent's internal implementation mechanisms, not to the agent's experience.
In any case, anything related to "assistant" is the agent's output, and anything related to "user" is the agent's input. But you never refer to these roles in the report,
as they are an internal implementation detail of the agent, not part of the agent's experience.
Additional instructions for the accumulation process:
- If the new entry is redundant with respect to some information in the current accumulation, you update the current accumulation by adding to a special counter right by
the side of where the redundant information is found, so that the final report can later be used to guide further agent action (i.e., know which elements appeared more often).
The special counter **must** be formated like this: "[NOTE: this information appeared X times in the memory in different forms]". If the counter was not there originally, you add it. If it was there, you update
it with the new count.
* Example (first element was found 3 times, the second element only once, so no counter):
"I play with and feed my cat [NOTE: this information appeared 3 times in the memory in different forms]. Cats are proud animals descendant from big feline hunters.".
"""
)
logger.debug(f"Accumulated information so far: {accumulated_info}")
logger.debug(f"Total accumulated information after full scan: {accumulated_info}")
return accumulated_info
###################################
# Auxiliary methods
###################################
def filter_by_item_type(self, memories:list, item_type:str) -> list:
"""
Filters a list of memories by item type.
Args:
memories (list): The list of memories to filter.
item_type (str): The item type to filter by.
Returns:
list: The filtered list of memories.
"""
return [memory for memory in memories if memory["type"] == item_type]
def filter_by_item_types(self, memories:list, item_types:list) -> list:
"""
Filters a list of memories by multiple item types.
Args:
memories (list): The list of memories to filter.
item_types (list): The list of item types to filter by.
Returns:
list: The filtered list of memories containing any of the specified types.
"""
return [memory for memory in memories if memory["type"] in item_types]</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty">TinyMentalFaculty</a></li>
<li><a title="tinytroupe.utils.json.JsonSerializableRegistry" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry">JsonSerializableRegistry</a></li>
</ul>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.memory.EpisodicMemory" href="#tinytroupe.agent.memory.EpisodicMemory">EpisodicMemory</a></li>
<li><a title="tinytroupe.agent.memory.SemanticMemory" href="#tinytroupe.agent.memory.SemanticMemory">SemanticMemory</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="tinytroupe.agent.memory.TinyMemory.filter_by_item_type"><code class="name flex">
<span>def <span class="ident">filter_by_item_type</span></span>(<span>self, memories: list, item_type: str) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Filters a list of memories by item type.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>memories</code></strong> : <code>list</code></dt>
<dd>The list of memories to filter.</dd>
<dt><strong><code>item_type</code></strong> : <code>str</code></dt>
<dd>The item type to filter by.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>The filtered list of memories.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def filter_by_item_type(self, memories:list, item_type:str) -> list:
"""
Filters a list of memories by item type.
Args:
memories (list): The list of memories to filter.
item_type (str): The item type to filter by.
Returns:
list: The filtered list of memories.
"""
return [memory for memory in memories if memory["type"] == item_type]</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory.filter_by_item_types"><code class="name flex">
<span>def <span class="ident">filter_by_item_types</span></span>(<span>self, memories: list, item_types: list) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Filters a list of memories by multiple item types.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>memories</code></strong> : <code>list</code></dt>
<dd>The list of memories to filter.</dd>
<dt><strong><code>item_types</code></strong> : <code>list</code></dt>
<dd>The list of item types to filter by.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>The filtered list of memories containing any of the specified types.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def filter_by_item_types(self, memories:list, item_types:list) -> list:
"""
Filters a list of memories by multiple item types.
Args:
memories (list): The list of memories to filter.
item_types (list): The list of item types to filter by.
Returns:
list: The filtered list of memories containing any of the specified types.
"""
return [memory for memory in memories if memory["type"] in item_types]</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory.retrieve"><code class="name flex">
<span>def <span class="ident">retrieve</span></span>(<span>self, first_n: int, last_n: int, include_omission_info: bool = True, item_type: str = None) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Retrieves the first n and/or last n values from memory. If n is None, all values are retrieved.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>first_n</code></strong> : <code>int</code></dt>
<dd>The number of first values to retrieve.</dd>
<dt><strong><code>last_n</code></strong> : <code>int</code></dt>
<dd>The number of last values to retrieve.</dd>
<dt><strong><code>include_omission_info</code></strong> : <code>bool</code></dt>
<dd>Whether to include an information message when some values are omitted.</dd>
<dt><strong><code>item_type</code></strong> : <code>str</code>, optional</dt>
<dd>If provided, only retrieve memories of this type.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>The retrieved values.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve(self, first_n: int, last_n: int, include_omission_info:bool=True, item_type:str=None) -> list:
"""
Retrieves the first n and/or last n values from memory. If n is None, all values are retrieved.
Args:
first_n (int): The number of first values to retrieve.
last_n (int): The number of last values to retrieve.
include_omission_info (bool): Whether to include an information message when some values are omitted.
item_type (str, optional): If provided, only retrieve memories of this type.
Returns:
list: The retrieved values.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory.retrieve_all"><code class="name flex">
<span>def <span class="ident">retrieve_all</span></span>(<span>self, item_type: str = None) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Retrieves all values from memory.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>item_type</code></strong> : <code>str</code>, optional</dt>
<dd>If provided, only retrieve memories of this type.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_all(self, item_type:str=None) -> list:
"""
Retrieves all values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory.retrieve_recent"><code class="name flex">
<span>def <span class="ident">retrieve_recent</span></span>(<span>self, item_type: str = None) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Retrieves the n most recent values from memory.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>item_type</code></strong> : <code>str</code>, optional</dt>
<dd>If provided, only retrieve memories of this type.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_recent(self, item_type:str=None) -> list:
"""
Retrieves the n most recent values from memory.
Args:
item_type (str, optional): If provided, only retrieve memories of this type.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory.retrieve_relevant"><code class="name flex">
<span>def <span class="ident">retrieve_relevant</span></span>(<span>self, relevance_target: str, top_k=20) ‑> list</span>
</code></dt>
<dd>
<div class="desc"><p>Retrieves all values from memory that are relevant to a given target.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_relevant(self, relevance_target:str, top_k=20) -> list:
"""
Retrieves all values from memory that are relevant to a given target.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory.store"><code class="name flex">
<span>def <span class="ident">store</span></span>(<span>self, value: dict) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Stores a value in memory.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def store(self, value: dict) -> None:
"""
Stores a value in memory.
"""
self._store(self._preprocess_value_for_storage(value))</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory.store_all"><code class="name flex">
<span>def <span class="ident">store_all</span></span>(<span>self, values: list) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Stores a list of values in memory.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def store_all(self, values: list) -> None:
"""
Stores a list of values in memory.
"""
logger.debug(f"Storing {len(values)} values in memory: {values}")
for i, value in enumerate(values):
logger.debug(f"Storing value #{i}: {value}")
self.store(value)</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.memory.TinyMemory.summarize_relevant_via_full_scan"><code class="name flex">
<span>def <span class="ident">summarize_relevant_via_full_scan</span></span>(<span>self, relevance_target: str, batch_size: int = 20, item_type: str = None) ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Performs a full scan of the memory, extracting and accumulating information relevant to a query.</p>
<p>This function processes all memories (or memories of a specific type if provided),
extracts information relevant to the query from each memory, and accumulates this
information into a coherent response.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>relevance_target</code></strong> : <code>str</code></dt>
<dd>The query specifying what information to extract from memories.</dd>
<dt><strong><code>item_type</code></strong> : <code>str</code>, optional</dt>
<dd>If provided, only process memories of this type.</dd>
<dt><strong><code>batch_size</code></strong> : <code>int</code></dt>
<dd>The number of memories to process in each extraction step. The larger it is, the faster the scan, but possibly less accurate.
Also, a too large value may lead to prompt length overflows, though current models can handle quite large prompts.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>str</code></dt>
<dd>The accumulated information relevant to the query.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def summarize_relevant_via_full_scan(self, relevance_target: str, batch_size: int = 20, item_type: str = None) -> str:
"""
Performs a full scan of the memory, extracting and accumulating information relevant to a query.
This function processes all memories (or memories of a specific type if provided),
extracts information relevant to the query from each memory, and accumulates this
information into a coherent response.
Args:
relevance_target (str): The query specifying what information to extract from memories.
item_type (str, optional): If provided, only process memories of this type.
batch_size (int): The number of memories to process in each extraction step. The larger it is, the faster the scan, but possibly less accurate.
Also, a too large value may lead to prompt length overflows, though current models can handle quite large prompts.
Returns:
str: The accumulated information relevant to the query.
"""
logger.debug(f"Starting FULL SCAN for relevance target: {relevance_target}, item type: {item_type}")
# Retrieve all memories of the specified type
memories = self.retrieve_all(item_type=item_type)
# Initialize accumulation
accumulated_info = ""
# Process memories in batches of qty_of_memories_per_extraction
for i in range(0, len(memories), batch_size):
batch = memories[i:i + batch_size]
logger.debug(f"Processing memory batch #{i} in full scan")
# Concatenate memory texts for the batch
batch_text = "# Memories to be processed\n\n"
batch_text += "\n\n ".join(str(memory) for memory in batch)
# Extract information relevant to the query from the batch
extracted_info = utils.semantics.extract_information_from_text(
relevance_target,
batch_text,
context="""
You are extracting information from the an agent's memory,
which might include actions, stimuli, and other types of events. You want to focus on the agent's experience, NOT on the agent's cognition or internal processes.
Assume that:
- "actions" refer to behaviors produced by the agent,
- "stimulus" refer to events or information from the environment or other agents that the agent perceived.
If you read about "assistant" and "user" roles, you can ignore them, as they refer to the agent's internal implementation mechanisms, not to the agent's experience.
In any case, anything related to "assistant" is the agent's output, and anything related to "user" is the agent's input. But you never refer to these roles in the report,
as they are an internal implementation detail of the agent, not part of the agent's experience.
"""
)
logger.debug(f"Extracted information from memory batch: {extracted_info}")
# Skip if no relevant information was found
if not extracted_info:
continue
# Accumulate the extracted information
accumulated_info = utils.semantics.accumulate_based_on_query(
query=relevance_target,
new_entry=extracted_info,
current_accumulation=accumulated_info,
context="""
You are producing a report based on information from an agent's memory.
You will put together all facts and experiences found that are relevant for the query, as a kind of summary of the agent's experience.
The report will later be used to guide further agent action. You focus on the agent's experience, NOT on the agent's cognition or internal processes.
Assume that:
- "actions" refer to behaviors produced by the agent,
- "stimulus" refer to events or information from the environment or other agents that the agent perceived.
- if you read about "assistant" and "user" roles, you can ignore them, as they refer to the agent's internal implementation mechanisms, not to the agent's experience.
In any case, anything related to "assistant" is the agent's output, and anything related to "user" is the agent's input. But you never refer to these roles in the report,
as they are an internal implementation detail of the agent, not part of the agent's experience.
Additional instructions for the accumulation process:
- If the new entry is redundant with respect to some information in the current accumulation, you update the current accumulation by adding to a special counter right by
the side of where the redundant information is found, so that the final report can later be used to guide further agent action (i.e., know which elements appeared more often).
The special counter **must** be formated like this: "[NOTE: this information appeared X times in the memory in different forms]". If the counter was not there originally, you add it. If it was there, you update
it with the new count.
* Example (first element was found 3 times, the second element only once, so no counter):
"I play with and feed my cat [NOTE: this information appeared 3 times in the memory in different forms]. Cats are proud animals descendant from big feline hunters.".
"""
)
logger.debug(f"Accumulated information so far: {accumulated_info}")
logger.debug(f"Total accumulated information after full scan: {accumulated_info}")
return accumulated_info</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty">TinyMentalFaculty</a></b></code>:
<ul class="hlist">
<li><code><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_constraints_prompt" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_constraints_prompt">actions_constraints_prompt</a></code></li>
<li><code><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_definitions_prompt" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_definitions_prompt">actions_definitions_prompt</a></code></li>
<li><code><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty.from_json" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry.from_json">from_json</a></code></li>
<li><code><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty.process_action" href="mental_faculty.html#tinytroupe.agent.mental_faculty.TinyMentalFaculty.process_action">process_action</a></code></li>
<li><code><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty.to_json" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry.to_json">to_json</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="tinytroupe.agent" href="index.html">tinytroupe.agent</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="tinytroupe.agent.memory.EpisodicConsolidator" href="#tinytroupe.agent.memory.EpisodicConsolidator">EpisodicConsolidator</a></code></h4>
</li>
<li>
<h4><code><a title="tinytroupe.agent.memory.EpisodicMemory" href="#tinytroupe.agent.memory.EpisodicMemory">EpisodicMemory</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO" href="#tinytroupe.agent.memory.EpisodicMemory.MEMORY_BLOCK_OMISSION_INFO">MEMORY_BLOCK_OMISSION_INFO</a></code></li>
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.clear" href="#tinytroupe.agent.memory.EpisodicMemory.clear">clear</a></code></li>
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.commit_episode" href="#tinytroupe.agent.memory.EpisodicMemory.commit_episode">commit_episode</a></code></li>
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.count" href="#tinytroupe.agent.memory.EpisodicMemory.count">count</a></code></li>
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.get_current_episode" href="#tinytroupe.agent.memory.EpisodicMemory.get_current_episode">get_current_episode</a></code></li>
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.retrieve_first" href="#tinytroupe.agent.memory.EpisodicMemory.retrieve_first">retrieve_first</a></code></li>
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.retrieve_last" href="#tinytroupe.agent.memory.EpisodicMemory.retrieve_last">retrieve_last</a></code></li>
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.retrieve_recent" href="#tinytroupe.agent.memory.EpisodicMemory.retrieve_recent">retrieve_recent</a></code></li>
<li><code><a title="tinytroupe.agent.memory.EpisodicMemory.retrieve_relevant" href="#tinytroupe.agent.memory.EpisodicMemory.retrieve_relevant">retrieve_relevant</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="tinytroupe.agent.memory.MemoryProcessor" href="#tinytroupe.agent.memory.MemoryProcessor">MemoryProcessor</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.agent.memory.MemoryProcessor.process" href="#tinytroupe.agent.memory.MemoryProcessor.process">process</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="tinytroupe.agent.memory.ReflectionConsolidator" href="#tinytroupe.agent.memory.ReflectionConsolidator">ReflectionConsolidator</a></code></h4>
</li>
<li>
<h4><code><a title="tinytroupe.agent.memory.SemanticMemory" href="#tinytroupe.agent.memory.SemanticMemory">SemanticMemory</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.agent.memory.SemanticMemory.serializable_attributes" href="#tinytroupe.agent.memory.SemanticMemory.serializable_attributes">serializable_attributes</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="tinytroupe.agent.memory.TinyMemory" href="#tinytroupe.agent.memory.TinyMemory">TinyMemory</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.agent.memory.TinyMemory.filter_by_item_type" href="#tinytroupe.agent.memory.TinyMemory.filter_by_item_type">filter_by_item_type</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.filter_by_item_types" href="#tinytroupe.agent.memory.TinyMemory.filter_by_item_types">filter_by_item_types</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve" href="#tinytroupe.agent.memory.TinyMemory.retrieve">retrieve</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve_all" href="#tinytroupe.agent.memory.TinyMemory.retrieve_all">retrieve_all</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve_recent" href="#tinytroupe.agent.memory.TinyMemory.retrieve_recent">retrieve_recent</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.retrieve_relevant" href="#tinytroupe.agent.memory.TinyMemory.retrieve_relevant">retrieve_relevant</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.store" href="#tinytroupe.agent.memory.TinyMemory.store">store</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.store_all" href="#tinytroupe.agent.memory.TinyMemory.store_all">store_all</a></code></li>
<li><code><a title="tinytroupe.agent.memory.TinyMemory.summarize_relevant_via_full_scan" href="#tinytroupe.agent.memory.TinyMemory.summarize_relevant_via_full_scan">summarize_relevant_via_full_scan</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html> |