Spaces:
Paused
Paused
File size: 71,392 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 | <!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.mental_faculty 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.mental_faculty</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from tinytroupe.agent import logger
from tinytroupe.agent.grounding import LocalFilesGroundingConnector, WebPagesGroundingConnector
from tinytroupe.utils import JsonSerializableRegistry
import tinytroupe.utils as utils
import tinytroupe.agent as agent
from typing import Callable
import textwrap # to dedent strings
#######################################################################################################################
# Mental faculties
#######################################################################################################################
class TinyMentalFaculty(JsonSerializableRegistry):
"""
Represents a mental faculty of an agent. Mental faculties are the cognitive abilities that an agent has.
"""
def __init__(self, name: str, requires_faculties: list=None) -> None:
"""
Initializes the mental faculty.
Args:
name (str): The name of the mental faculty.
requires_faculties (list): A list of mental faculties that this faculty requires to function properly.
"""
self.name = name
if requires_faculties is None:
self.requires_faculties = []
else:
self.requires_faculties = requires_faculties
def __str__(self) -> str:
return f"Mental Faculty: {self.name}"
def __eq__(self, other):
if isinstance(other, TinyMentalFaculty):
return self.name == other.name
return False
def process_action(self, agent, action: dict) -> bool:
"""
Processes an action related to this faculty.
Args:
action (dict): The action to process.
Returns:
bool: True if the action was successfully processed, False otherwise.
"""
raise NotImplementedError("Subclasses must implement this method.")
def actions_definitions_prompt(self) -> str:
"""
Returns the prompt for defining a actions related to this faculty.
"""
raise NotImplementedError("Subclasses must implement this method.")
def actions_constraints_prompt(self) -> str:
"""
Returns the prompt for defining constraints on actions related to this faculty.
"""
raise NotImplementedError("Subclasses must implement this method.")
class CustomMentalFaculty(TinyMentalFaculty):
"""
Represents a custom mental faculty of an agent. Custom mental faculties are the cognitive abilities that an agent has
and that are defined by the user just by specifying the actions that the faculty can perform or the constraints that
the faculty introduces. Constraints might be related to the actions that the faculty can perform or be independent,
more general constraints that the agent must follow.
"""
def __init__(self, name: str, requires_faculties: list = None,
actions_configs: dict = None, constraints: dict = None):
"""
Initializes the custom mental faculty.
Args:
name (str): The name of the mental faculty.
requires_faculties (list): A list of mental faculties that this faculty requires to function properly.
Format is ["faculty1", "faculty2", ...]
actions_configs (dict): A dictionary with the configuration of actions that this faculty can perform.
Format is {<action_name>: {"description": <description>, "function": <function>}}
constraints (dict): A list with the constraints introduced by this faculty.
Format is [<constraint1>, <constraint2>, ...]
"""
super().__init__(name, requires_faculties)
# {<action_name>: {"description": <description>, "function": <function>}}
if actions_configs is None:
self.actions_configs = {}
else:
self.actions_configs = actions_configs
# [<constraint1>, <constraint2>, ...]
if constraints is None:
self.constraints = {}
else:
self.constraints = constraints
def add_action(self, action_name: str, description: str, function: Callable=None):
self.actions_configs[action_name] = {"description": description, "function": function}
def add_actions(self, actions: dict):
for action_name, action_config in actions.items():
self.add_action(action_name, action_config['description'], action_config['function'])
def add_action_constraint(self, constraint: str):
self.constraints.append(constraint)
def add_actions_constraints(self, constraints: list):
for constraint in constraints:
self.add_action_constraint(constraint)
def process_action(self, agent, action: dict) -> bool:
logger.debug(f"Processing action: {action}")
action_type = action['type']
if action_type in self.actions_configs:
action_config = self.actions_configs[action_type]
action_function = action_config.get("function", None)
if action_function is not None:
action_function(agent, action)
# one way or another, the action was processed
return True
else:
return False
def actions_definitions_prompt(self) -> str:
prompt = ""
for action_name, action_config in self.actions_configs.items():
prompt += f" - {action_name.upper()}: {action_config['description']}\n"
return prompt
def actions_constraints_prompt(self) -> str:
prompt = ""
for constraint in self.constraints:
prompt += f" - {constraint}\n"
return prompt
class RecallFaculty(TinyMentalFaculty):
def __init__(self):
super().__init__("Memory Recall")
def process_action(self, agent, action: dict) -> bool:
logger.debug(f"Processing action: {action}")
if action['type'] == "RECALL" and action['content'] is not None:
content = action['content']
semantic_memories = agent.retrieve_relevant_memories(relevance_target=content)
logger.info(f"Recalling information related to '{content}'. Found {len(semantic_memories)} relevant memories.")
if len(semantic_memories) > 0:
# a string with each element in the list in a new line starting with a bullet point
agent.think("I have remembered the following information from my semantic memory and will use it to guide me in my subsequent actions: \n" + \
"\n".join([f" - {item}" for item in semantic_memories]))
else:
agent.think(f"I can't remember anything additional about '{content}'. I'll just use what I already currently have in mind to proceed as well as I can.")
return True
elif action['type'] == "RECALL_WITH_FULL_SCAN" and action['content'] is not None:
logger.debug(f"Processing RECALL_WITH_FULL_SCAN action. Recalling and summarizing information related to '{action['content']}' with full scan.")
content = action['content']
memories_summary = agent.summarize_relevant_memories_via_full_scan(relevance_target=content)
logger.debug(f"Summary produced via full scan: {memories_summary}")
if len(memories_summary) > 0:
# the summary is presented as a block of text
agent.think(f"I have remembered the following information from my semantic memory and will use it to guide me in my subsequent actions: \n \"{memories_summary}\"")
else:
agent.think(f"I can't remember anything additional about '{content}'. I'll just use what I already currently have in mind to proceed as well as I can.")
return True
else:
return False
def actions_definitions_prompt(self) -> str:
prompt = \
"""
- RECALL: you can recall information that relates to specific topics from your memory. To do, you must specify a "mental query" to locate the desired memory. If the memory is found, it is brought to your conscience.
- RECALL_WITH_FULL_SCAN: you can recall information from your memory in an exhaustive way, scanning all your memories. To do, you must specify a "mental query" that will be used to extract the relevant information from each memory.
All the information found will be brought to your conscience. This action is more expensive than RECALL, and is meant to be used when you want to ensure that you are not missing any relevant information.
"""
return textwrap.dedent(prompt)
def actions_constraints_prompt(self) -> str:
prompt = \
"""
- Before concluding you don't know something or don't have access to some information, you **must** try to RECALL or RECALL_WITH_FULL_SCAN it from your memory.
- If you you know precisely what you are looking for, you can use RECALL to retrieve it. If you are not sure, or if you want to ensure that you are not missing any relevant information, you should use RECALL_WITH_FULL_SCAN instead.
* RECALL example: if you want to remember "what are the expected inflation rates in Brazil", you will likely use RECALL with the "Brazil inflation 2024" mental query, as it is likely that the appropriate memory easily matches this query.
* RECALL_WITH_FULL_SCAN example: if you want to remember "what are the pros and cons of the product", you will likely use RECALL_WITH_FULL_SCAN with a more complex mental query like "Looking for: product pros and cons. Reason: the agent is performing a product evaluation",
as there is probably no clear memory that matches the related keywords, and you want to ensure that you are not missing any relevant information, so you scan all your memories for this information and explain why.
- You try to RECALL information from your memory, so that you can have more relevant elements to think and talk about, whenever such an action would be likely
to enrich the current interaction. To do so, you must specify able "mental query" that is related to the things you've been thinking, listening and talking about.
Example:
```
<THINK A>
<RECALL / RECALL_WITH_FULL_SCAN B, which is something related to A>
<THINK about A and B>
<TALK about A and B>
DONE
```
- You can try to RECALL_WITH_FULL_SCAN information from your memory when you want or are tasked with finding all relevant information about a topic, and you want to ensure that you are not missing any relevant information.
In other words, you "try hard" to remember.
Example:
```
<LISTEN what are the main pros and cons of the product>
<RECALL_WITH_FULL_SCAN Looking for: product pros and cons. Reason: the agent is performing a product evaluation.>
<THINK about all the pros and cons found>
<TALK about the pros and cons recalled>
DONE
```
- If you RECALL:
* you use a "mental query" that describe the elements you are looking for, you do not use a question. It is like a keyword-based search query.
For example, instead of "What are the symptoms of COVID-19?", you would use "COVID-19 symptoms".
* you use keywords likely to be found in the text you are looking for. For example, instead of "Brazil economic outlook", you would use "Brazil economy", "Brazil GPD", "Brazil inflation", etc.
- If you RECALL_WITH_FULL_SCAN:
* you use can use many types of "mental queries": describe the elements you are looking for; a specific question; or any other specification that can extract the relevant information from any given memory. It is NOT like a keyword-based search query,
but instead a specification of what is important to the agent at the moment.
* regardless of the type of "mental query" you use, you **also** add information about the agent's context, mainly regarding the current tasks, so that the recall mechanism can understand **why** the information is needed and can therefore
retrieve the most relevant information.
* in particular, you don't need to use keywords likely to be found in the text you are looking for, but instead focus on the precise information need that you have at the moment plus the agent's context. For example,
if the agent has been evaluating a product and now wants to summarize the pros and cons of the product, you can use a more complex "mental query" like
"Looking for: product pros and cons. Reason: the agent was asked to perform a product evaluation and has examined many of the product features already.".
- It may take several tries of RECALL to get the relevant information you need. If you don't find what you are looking for, you can try again with a **very** different "mental query".
Be creative: you can use synonyms, related concepts, or any other strategy you think might help you to find the information you need. Avoid using the same terms in different queries, as it is likely to return the same results. Whenever necessary, you should retry RECALL a couple of times before giving up the location of more information.
Example:
```
<THINK something>
<RECALL "cat products">
<THINK something>
<RECALL "feline artifacts">
<THINK something>
<RECALL "pet store">
<THINK something>
<TALK something>
DONE
```
- If you did not find what you needed using RECALL after a few attempts, you can try RECALL_WITH_FULL_SCAN instead.
- You **may** interleave THINK and RECALL / RECALL_WITH_FULL_SCAN so that you can better reflect on the information you are trying to recall.
- If you need information about a specific document, you **must** use CONSULT instead of RECALL / RECALL_WITH_FULL_SCAN. This is because RECALL / RECALL_WITH_FULL_SCAN **does not** allow you to select the specific document, and only brings small
relevant parts of variious documents - while CONSULT brings the precise document requested for your inspection, with its full content.
Example:
```
LIST_DOCUMENTS
<CONSULT some document name>
<THINK something about the retrieved document>
<TALK something>
DONE
```
"""
return textwrap.dedent(prompt)
class FilesAndWebGroundingFaculty(TinyMentalFaculty):
"""
Allows the agent to access local files and web pages to ground its knowledge.
"""
def __init__(self, folders_paths: list=None, web_urls: list=None):
super().__init__("Local Files and Web Grounding")
self.local_files_grounding_connector = LocalFilesGroundingConnector(folders_paths=folders_paths)
self.web_grounding_connector = WebPagesGroundingConnector(web_urls=web_urls)
def process_action(self, agent, action: dict) -> bool:
if action['type'] == "CONSULT" and action['content'] is not None:
target_name = action['content']
results = []
results.append(self.local_files_grounding_connector.retrieve_by_name(target_name))
results.append(self.web_grounding_connector.retrieve_by_name(target_name))
if len(results) > 0:
agent.think(f"I have read the following document: \n{results}")
else:
agent.think(f"I can't find any document with the name '{target_name}'.")
return True
elif action['type'] == "LIST_DOCUMENTS" and action['content'] is not None:
available_names = []
available_names += self.local_files_grounding_connector.list_sources()
available_names += self.web_grounding_connector.list_sources()
if len(available_names) > 0:
agent.think(f"I have the following documents available to me: {available_names}")
else:
agent.think(f"I don't have any documents available for inspection.")
return True
else:
return False
def actions_definitions_prompt(self) -> str:
prompt = \
"""
- LIST_DOCUMENTS: you can list the names of the documents you have access to, so that you can decide which to access, if any, to accomplish your goals. Documents is a generic term and includes any
kind of "packaged" information you can access, such as emails, files, chat messages, calendar events, etc. It also includes, in particular, web pages.
The order of in which the documents are listed is not relevant.
- CONSULT: you can retrieve and consult a specific document, so that you can access its content and accomplish your goals. To do so, you specify the name of the document you want to consult.
"""
return textwrap.dedent(prompt)
def actions_constraints_prompt(self) -> str:
prompt = \
"""
- You are aware that you have documents available to you to help in your tasks. Even if you already have knowledge about a topic, you
should believe that the documents can provide you with additional information that can be useful to you.
- If you want information that might be in documents, you first LIST_DOCUMENTS to see what is available and decide if you want to access any of them.
- You LIST_DOCUMENTS when you suspect that relevant information might be in some document, but you are not sure which one.
- You only CONSULT the relevant documents for your present goals and context. You should **not** CONSULT documents that are not relevant to the current situation.
You use the name of the document to determine its relevance before accessing it.
- If you need information about a specific document, you **must** use CONSULT instead of RECALL. This is because RECALL **does not** allow you to select the specific document, and only brings small
relevant parts of variious documents - while CONSULT brings the precise document requested for your inspection, with its full content.
Example:
```
LIST_DOCUMENTS
<CONSULT some document name>
<THINK something about the retrieved document>
<TALK something>
DONE
```
- If you need information from specific documents, you **always** CONSULT it, **never** RECALL it.
- You can only CONSULT few documents before issuing DONE.
Example:
```
<CONSULT some document name>
<THINK something about the retrieved document>
<TALK something>
<CONSULT some document name>
<THINK something about the retrieved document>
<TALK something>
DONE
```
- When deciding whether to use RECALL or CONSULT, you should consider whether you are looking for any information about some topic (use RECALL) or if you are looking for information from
specific documents (use CONSULT). To know if you have potentially relevant documents available, use LIST_DOCUMENTS first.
"""
return textwrap.dedent(prompt)
class TinyToolUse(TinyMentalFaculty):
"""
Allows the agent to use tools to accomplish tasks. Tool usage is one of the most important cognitive skills
humans and primates have as we know.
"""
def __init__(self, tools:list) -> None:
super().__init__("Tool Use")
self.tools = tools
def process_action(self, agent, action: dict) -> bool:
for tool in self.tools:
if tool.process_action(agent, action):
return True
return False
def actions_definitions_prompt(self) -> str:
# each tool should provide its own actions definitions prompt
prompt = ""
for tool in self.tools:
prompt += tool.actions_definitions_prompt()
return prompt
def actions_constraints_prompt(self) -> str:
# each tool should provide its own actions constraints prompt
prompt = ""
for tool in self.tools:
prompt += tool.actions_constraints_prompt()
return prompt</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.mental_faculty.CustomMentalFaculty"><code class="flex name class">
<span>class <span class="ident">CustomMentalFaculty</span></span>
<span>(</span><span>name: str, requires_faculties: list = None, actions_configs: dict = None, constraints: dict = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Represents a custom mental faculty of an agent. Custom mental faculties are the cognitive abilities that an agent has
and that are defined by the user just by specifying the actions that the faculty can perform or the constraints that
the faculty introduces. Constraints might be related to the actions that the faculty can perform or be independent,
more general constraints that the agent must follow.</p>
<p>Initializes the custom 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.
Format is ["faculty1", "faculty2", …]</dd>
<dt><strong><code>actions_configs</code></strong> : <code>dict</code></dt>
<dd>A dictionary with the configuration of actions that this faculty can perform.
Format is {<action_name>: {"description": <description>, "function": <function>}}</dd>
<dt><strong><code>constraints</code></strong> : <code>dict</code></dt>
<dd>A list with the constraints introduced by this faculty.
Format is [<constraint1>, <constraint2>, …]</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class CustomMentalFaculty(TinyMentalFaculty):
"""
Represents a custom mental faculty of an agent. Custom mental faculties are the cognitive abilities that an agent has
and that are defined by the user just by specifying the actions that the faculty can perform or the constraints that
the faculty introduces. Constraints might be related to the actions that the faculty can perform or be independent,
more general constraints that the agent must follow.
"""
def __init__(self, name: str, requires_faculties: list = None,
actions_configs: dict = None, constraints: dict = None):
"""
Initializes the custom mental faculty.
Args:
name (str): The name of the mental faculty.
requires_faculties (list): A list of mental faculties that this faculty requires to function properly.
Format is ["faculty1", "faculty2", ...]
actions_configs (dict): A dictionary with the configuration of actions that this faculty can perform.
Format is {<action_name>: {"description": <description>, "function": <function>}}
constraints (dict): A list with the constraints introduced by this faculty.
Format is [<constraint1>, <constraint2>, ...]
"""
super().__init__(name, requires_faculties)
# {<action_name>: {"description": <description>, "function": <function>}}
if actions_configs is None:
self.actions_configs = {}
else:
self.actions_configs = actions_configs
# [<constraint1>, <constraint2>, ...]
if constraints is None:
self.constraints = {}
else:
self.constraints = constraints
def add_action(self, action_name: str, description: str, function: Callable=None):
self.actions_configs[action_name] = {"description": description, "function": function}
def add_actions(self, actions: dict):
for action_name, action_config in actions.items():
self.add_action(action_name, action_config['description'], action_config['function'])
def add_action_constraint(self, constraint: str):
self.constraints.append(constraint)
def add_actions_constraints(self, constraints: list):
for constraint in constraints:
self.add_action_constraint(constraint)
def process_action(self, agent, action: dict) -> bool:
logger.debug(f"Processing action: {action}")
action_type = action['type']
if action_type in self.actions_configs:
action_config = self.actions_configs[action_type]
action_function = action_config.get("function", None)
if action_function is not None:
action_function(agent, action)
# one way or another, the action was processed
return True
else:
return False
def actions_definitions_prompt(self) -> str:
prompt = ""
for action_name, action_config in self.actions_configs.items():
prompt += f" - {action_name.upper()}: {action_config['description']}\n"
return prompt
def actions_constraints_prompt(self) -> str:
prompt = ""
for constraint in self.constraints:
prompt += f" - {constraint}\n"
return prompt</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#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>Methods</h3>
<dl>
<dt id="tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_action"><code class="name flex">
<span>def <span class="ident">add_action</span></span>(<span>self, action_name: str, description: str, function: Callable = None)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def add_action(self, action_name: str, description: str, function: Callable=None):
self.actions_configs[action_name] = {"description": description, "function": function}</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_action_constraint"><code class="name flex">
<span>def <span class="ident">add_action_constraint</span></span>(<span>self, constraint: str)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def add_action_constraint(self, constraint: str):
self.constraints.append(constraint)</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_actions"><code class="name flex">
<span>def <span class="ident">add_actions</span></span>(<span>self, actions: dict)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def add_actions(self, actions: dict):
for action_name, action_config in actions.items():
self.add_action(action_name, action_config['description'], action_config['function'])</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_actions_constraints"><code class="name flex">
<span>def <span class="ident">add_actions_constraints</span></span>(<span>self, constraints: list)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def add_actions_constraints(self, constraints: list):
for constraint in constraints:
self.add_action_constraint(constraint)</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#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="#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="#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="#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>
<dt id="tinytroupe.agent.mental_faculty.FilesAndWebGroundingFaculty"><code class="flex name class">
<span>class <span class="ident">FilesAndWebGroundingFaculty</span></span>
<span>(</span><span>folders_paths: list = None, web_urls: list = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Allows the agent to access local files and web pages to ground its knowledge.</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 FilesAndWebGroundingFaculty(TinyMentalFaculty):
"""
Allows the agent to access local files and web pages to ground its knowledge.
"""
def __init__(self, folders_paths: list=None, web_urls: list=None):
super().__init__("Local Files and Web Grounding")
self.local_files_grounding_connector = LocalFilesGroundingConnector(folders_paths=folders_paths)
self.web_grounding_connector = WebPagesGroundingConnector(web_urls=web_urls)
def process_action(self, agent, action: dict) -> bool:
if action['type'] == "CONSULT" and action['content'] is not None:
target_name = action['content']
results = []
results.append(self.local_files_grounding_connector.retrieve_by_name(target_name))
results.append(self.web_grounding_connector.retrieve_by_name(target_name))
if len(results) > 0:
agent.think(f"I have read the following document: \n{results}")
else:
agent.think(f"I can't find any document with the name '{target_name}'.")
return True
elif action['type'] == "LIST_DOCUMENTS" and action['content'] is not None:
available_names = []
available_names += self.local_files_grounding_connector.list_sources()
available_names += self.web_grounding_connector.list_sources()
if len(available_names) > 0:
agent.think(f"I have the following documents available to me: {available_names}")
else:
agent.think(f"I don't have any documents available for inspection.")
return True
else:
return False
def actions_definitions_prompt(self) -> str:
prompt = \
"""
- LIST_DOCUMENTS: you can list the names of the documents you have access to, so that you can decide which to access, if any, to accomplish your goals. Documents is a generic term and includes any
kind of "packaged" information you can access, such as emails, files, chat messages, calendar events, etc. It also includes, in particular, web pages.
The order of in which the documents are listed is not relevant.
- CONSULT: you can retrieve and consult a specific document, so that you can access its content and accomplish your goals. To do so, you specify the name of the document you want to consult.
"""
return textwrap.dedent(prompt)
def actions_constraints_prompt(self) -> str:
prompt = \
"""
- You are aware that you have documents available to you to help in your tasks. Even if you already have knowledge about a topic, you
should believe that the documents can provide you with additional information that can be useful to you.
- If you want information that might be in documents, you first LIST_DOCUMENTS to see what is available and decide if you want to access any of them.
- You LIST_DOCUMENTS when you suspect that relevant information might be in some document, but you are not sure which one.
- You only CONSULT the relevant documents for your present goals and context. You should **not** CONSULT documents that are not relevant to the current situation.
You use the name of the document to determine its relevance before accessing it.
- If you need information about a specific document, you **must** use CONSULT instead of RECALL. This is because RECALL **does not** allow you to select the specific document, and only brings small
relevant parts of variious documents - while CONSULT brings the precise document requested for your inspection, with its full content.
Example:
```
LIST_DOCUMENTS
<CONSULT some document name>
<THINK something about the retrieved document>
<TALK something>
DONE
```
- If you need information from specific documents, you **always** CONSULT it, **never** RECALL it.
- You can only CONSULT few documents before issuing DONE.
Example:
```
<CONSULT some document name>
<THINK something about the retrieved document>
<TALK something>
<CONSULT some document name>
<THINK something about the retrieved document>
<TALK something>
DONE
```
- When deciding whether to use RECALL or CONSULT, you should consider whether you are looking for any information about some topic (use RECALL) or if you are looking for information from
specific documents (use CONSULT). To know if you have potentially relevant documents available, use LIST_DOCUMENTS first.
"""
return textwrap.dedent(prompt)</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#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>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#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="#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="#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="#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>
<dt id="tinytroupe.agent.mental_faculty.RecallFaculty"><code class="flex name class">
<span>class <span class="ident">RecallFaculty</span></span>
</code></dt>
<dd>
<div class="desc"><p>Represents a mental faculty of an agent. Mental faculties are the cognitive abilities that an agent has.</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 RecallFaculty(TinyMentalFaculty):
def __init__(self):
super().__init__("Memory Recall")
def process_action(self, agent, action: dict) -> bool:
logger.debug(f"Processing action: {action}")
if action['type'] == "RECALL" and action['content'] is not None:
content = action['content']
semantic_memories = agent.retrieve_relevant_memories(relevance_target=content)
logger.info(f"Recalling information related to '{content}'. Found {len(semantic_memories)} relevant memories.")
if len(semantic_memories) > 0:
# a string with each element in the list in a new line starting with a bullet point
agent.think("I have remembered the following information from my semantic memory and will use it to guide me in my subsequent actions: \n" + \
"\n".join([f" - {item}" for item in semantic_memories]))
else:
agent.think(f"I can't remember anything additional about '{content}'. I'll just use what I already currently have in mind to proceed as well as I can.")
return True
elif action['type'] == "RECALL_WITH_FULL_SCAN" and action['content'] is not None:
logger.debug(f"Processing RECALL_WITH_FULL_SCAN action. Recalling and summarizing information related to '{action['content']}' with full scan.")
content = action['content']
memories_summary = agent.summarize_relevant_memories_via_full_scan(relevance_target=content)
logger.debug(f"Summary produced via full scan: {memories_summary}")
if len(memories_summary) > 0:
# the summary is presented as a block of text
agent.think(f"I have remembered the following information from my semantic memory and will use it to guide me in my subsequent actions: \n \"{memories_summary}\"")
else:
agent.think(f"I can't remember anything additional about '{content}'. I'll just use what I already currently have in mind to proceed as well as I can.")
return True
else:
return False
def actions_definitions_prompt(self) -> str:
prompt = \
"""
- RECALL: you can recall information that relates to specific topics from your memory. To do, you must specify a "mental query" to locate the desired memory. If the memory is found, it is brought to your conscience.
- RECALL_WITH_FULL_SCAN: you can recall information from your memory in an exhaustive way, scanning all your memories. To do, you must specify a "mental query" that will be used to extract the relevant information from each memory.
All the information found will be brought to your conscience. This action is more expensive than RECALL, and is meant to be used when you want to ensure that you are not missing any relevant information.
"""
return textwrap.dedent(prompt)
def actions_constraints_prompt(self) -> str:
prompt = \
"""
- Before concluding you don't know something or don't have access to some information, you **must** try to RECALL or RECALL_WITH_FULL_SCAN it from your memory.
- If you you know precisely what you are looking for, you can use RECALL to retrieve it. If you are not sure, or if you want to ensure that you are not missing any relevant information, you should use RECALL_WITH_FULL_SCAN instead.
* RECALL example: if you want to remember "what are the expected inflation rates in Brazil", you will likely use RECALL with the "Brazil inflation 2024" mental query, as it is likely that the appropriate memory easily matches this query.
* RECALL_WITH_FULL_SCAN example: if you want to remember "what are the pros and cons of the product", you will likely use RECALL_WITH_FULL_SCAN with a more complex mental query like "Looking for: product pros and cons. Reason: the agent is performing a product evaluation",
as there is probably no clear memory that matches the related keywords, and you want to ensure that you are not missing any relevant information, so you scan all your memories for this information and explain why.
- You try to RECALL information from your memory, so that you can have more relevant elements to think and talk about, whenever such an action would be likely
to enrich the current interaction. To do so, you must specify able "mental query" that is related to the things you've been thinking, listening and talking about.
Example:
```
<THINK A>
<RECALL / RECALL_WITH_FULL_SCAN B, which is something related to A>
<THINK about A and B>
<TALK about A and B>
DONE
```
- You can try to RECALL_WITH_FULL_SCAN information from your memory when you want or are tasked with finding all relevant information about a topic, and you want to ensure that you are not missing any relevant information.
In other words, you "try hard" to remember.
Example:
```
<LISTEN what are the main pros and cons of the product>
<RECALL_WITH_FULL_SCAN Looking for: product pros and cons. Reason: the agent is performing a product evaluation.>
<THINK about all the pros and cons found>
<TALK about the pros and cons recalled>
DONE
```
- If you RECALL:
* you use a "mental query" that describe the elements you are looking for, you do not use a question. It is like a keyword-based search query.
For example, instead of "What are the symptoms of COVID-19?", you would use "COVID-19 symptoms".
* you use keywords likely to be found in the text you are looking for. For example, instead of "Brazil economic outlook", you would use "Brazil economy", "Brazil GPD", "Brazil inflation", etc.
- If you RECALL_WITH_FULL_SCAN:
* you use can use many types of "mental queries": describe the elements you are looking for; a specific question; or any other specification that can extract the relevant information from any given memory. It is NOT like a keyword-based search query,
but instead a specification of what is important to the agent at the moment.
* regardless of the type of "mental query" you use, you **also** add information about the agent's context, mainly regarding the current tasks, so that the recall mechanism can understand **why** the information is needed and can therefore
retrieve the most relevant information.
* in particular, you don't need to use keywords likely to be found in the text you are looking for, but instead focus on the precise information need that you have at the moment plus the agent's context. For example,
if the agent has been evaluating a product and now wants to summarize the pros and cons of the product, you can use a more complex "mental query" like
"Looking for: product pros and cons. Reason: the agent was asked to perform a product evaluation and has examined many of the product features already.".
- It may take several tries of RECALL to get the relevant information you need. If you don't find what you are looking for, you can try again with a **very** different "mental query".
Be creative: you can use synonyms, related concepts, or any other strategy you think might help you to find the information you need. Avoid using the same terms in different queries, as it is likely to return the same results. Whenever necessary, you should retry RECALL a couple of times before giving up the location of more information.
Example:
```
<THINK something>
<RECALL "cat products">
<THINK something>
<RECALL "feline artifacts">
<THINK something>
<RECALL "pet store">
<THINK something>
<TALK something>
DONE
```
- If you did not find what you needed using RECALL after a few attempts, you can try RECALL_WITH_FULL_SCAN instead.
- You **may** interleave THINK and RECALL / RECALL_WITH_FULL_SCAN so that you can better reflect on the information you are trying to recall.
- If you need information about a specific document, you **must** use CONSULT instead of RECALL / RECALL_WITH_FULL_SCAN. This is because RECALL / RECALL_WITH_FULL_SCAN **does not** allow you to select the specific document, and only brings small
relevant parts of variious documents - while CONSULT brings the precise document requested for your inspection, with its full content.
Example:
```
LIST_DOCUMENTS
<CONSULT some document name>
<THINK something about the retrieved document>
<TALK something>
DONE
```
"""
return textwrap.dedent(prompt)</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#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>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#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="#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="#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="#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>
<dt id="tinytroupe.agent.mental_faculty.TinyMentalFaculty"><code class="flex name class">
<span>class <span class="ident">TinyMentalFaculty</span></span>
<span>(</span><span>name: str, requires_faculties: list = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Represents a mental faculty of an agent. Mental faculties are the cognitive abilities that an agent has.</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 TinyMentalFaculty(JsonSerializableRegistry):
"""
Represents a mental faculty of an agent. Mental faculties are the cognitive abilities that an agent has.
"""
def __init__(self, name: str, requires_faculties: list=None) -> None:
"""
Initializes the mental faculty.
Args:
name (str): The name of the mental faculty.
requires_faculties (list): A list of mental faculties that this faculty requires to function properly.
"""
self.name = name
if requires_faculties is None:
self.requires_faculties = []
else:
self.requires_faculties = requires_faculties
def __str__(self) -> str:
return f"Mental Faculty: {self.name}"
def __eq__(self, other):
if isinstance(other, TinyMentalFaculty):
return self.name == other.name
return False
def process_action(self, agent, action: dict) -> bool:
"""
Processes an action related to this faculty.
Args:
action (dict): The action to process.
Returns:
bool: True if the action was successfully processed, False otherwise.
"""
raise NotImplementedError("Subclasses must implement this method.")
def actions_definitions_prompt(self) -> str:
"""
Returns the prompt for defining a actions related to this faculty.
"""
raise NotImplementedError("Subclasses must implement this method.")
def actions_constraints_prompt(self) -> str:
"""
Returns the prompt for defining constraints on actions related to this faculty.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<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.TinyMemory" href="memory.html#tinytroupe.agent.memory.TinyMemory">TinyMemory</a></li>
<li><a title="tinytroupe.agent.mental_faculty.CustomMentalFaculty" href="#tinytroupe.agent.mental_faculty.CustomMentalFaculty">CustomMentalFaculty</a></li>
<li><a title="tinytroupe.agent.mental_faculty.FilesAndWebGroundingFaculty" href="#tinytroupe.agent.mental_faculty.FilesAndWebGroundingFaculty">FilesAndWebGroundingFaculty</a></li>
<li><a title="tinytroupe.agent.mental_faculty.RecallFaculty" href="#tinytroupe.agent.mental_faculty.RecallFaculty">RecallFaculty</a></li>
<li><a title="tinytroupe.agent.mental_faculty.TinyToolUse" href="#tinytroupe.agent.mental_faculty.TinyToolUse">TinyToolUse</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_constraints_prompt"><code class="name flex">
<span>def <span class="ident">actions_constraints_prompt</span></span>(<span>self) ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Returns the prompt for defining constraints on actions related to this faculty.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def actions_constraints_prompt(self) -> str:
"""
Returns the prompt for defining constraints on actions related to this faculty.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_definitions_prompt"><code class="name flex">
<span>def <span class="ident">actions_definitions_prompt</span></span>(<span>self) ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Returns the prompt for defining a actions related to this faculty.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def actions_definitions_prompt(self) -> str:
"""
Returns the prompt for defining a actions related to this faculty.
"""
raise NotImplementedError("Subclasses must implement this method.")</code></pre>
</details>
</dd>
<dt id="tinytroupe.agent.mental_faculty.TinyMentalFaculty.process_action"><code class="name flex">
<span>def <span class="ident">process_action</span></span>(<span>self, agent, action: dict) ‑> bool</span>
</code></dt>
<dd>
<div class="desc"><p>Processes an action related to this faculty.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>action</code></strong> : <code>dict</code></dt>
<dd>The action to process.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>bool</code></dt>
<dd>True if the action was successfully processed, False otherwise.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def process_action(self, agent, action: dict) -> bool:
"""
Processes an action related to this faculty.
Args:
action (dict): The action to process.
Returns:
bool: True if the action was successfully processed, False otherwise.
"""
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.utils.json.JsonSerializableRegistry" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry">JsonSerializableRegistry</a></b></code>:
<ul class="hlist">
<li><code><a title="tinytroupe.utils.json.JsonSerializableRegistry.from_json" href="../utils/json.html#tinytroupe.utils.json.JsonSerializableRegistry.from_json">from_json</a></code></li>
<li><code><a title="tinytroupe.utils.json.JsonSerializableRegistry.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.mental_faculty.TinyToolUse"><code class="flex name class">
<span>class <span class="ident">TinyToolUse</span></span>
<span>(</span><span>tools: list)</span>
</code></dt>
<dd>
<div class="desc"><p>Allows the agent to use tools to accomplish tasks. Tool usage is one of the most important cognitive skills
humans and primates have as we know.</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 TinyToolUse(TinyMentalFaculty):
"""
Allows the agent to use tools to accomplish tasks. Tool usage is one of the most important cognitive skills
humans and primates have as we know.
"""
def __init__(self, tools:list) -> None:
super().__init__("Tool Use")
self.tools = tools
def process_action(self, agent, action: dict) -> bool:
for tool in self.tools:
if tool.process_action(agent, action):
return True
return False
def actions_definitions_prompt(self) -> str:
# each tool should provide its own actions definitions prompt
prompt = ""
for tool in self.tools:
prompt += tool.actions_definitions_prompt()
return prompt
def actions_constraints_prompt(self) -> str:
# each tool should provide its own actions constraints prompt
prompt = ""
for tool in self.tools:
prompt += tool.actions_constraints_prompt()
return prompt</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#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>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#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="#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="#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="#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.mental_faculty.CustomMentalFaculty" href="#tinytroupe.agent.mental_faculty.CustomMentalFaculty">CustomMentalFaculty</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_action" href="#tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_action">add_action</a></code></li>
<li><code><a title="tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_action_constraint" href="#tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_action_constraint">add_action_constraint</a></code></li>
<li><code><a title="tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_actions" href="#tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_actions">add_actions</a></code></li>
<li><code><a title="tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_actions_constraints" href="#tinytroupe.agent.mental_faculty.CustomMentalFaculty.add_actions_constraints">add_actions_constraints</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="tinytroupe.agent.mental_faculty.FilesAndWebGroundingFaculty" href="#tinytroupe.agent.mental_faculty.FilesAndWebGroundingFaculty">FilesAndWebGroundingFaculty</a></code></h4>
</li>
<li>
<h4><code><a title="tinytroupe.agent.mental_faculty.RecallFaculty" href="#tinytroupe.agent.mental_faculty.RecallFaculty">RecallFaculty</a></code></h4>
</li>
<li>
<h4><code><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty" href="#tinytroupe.agent.mental_faculty.TinyMentalFaculty">TinyMentalFaculty</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_constraints_prompt" href="#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="#tinytroupe.agent.mental_faculty.TinyMentalFaculty.actions_definitions_prompt">actions_definitions_prompt</a></code></li>
<li><code><a title="tinytroupe.agent.mental_faculty.TinyMentalFaculty.process_action" href="#tinytroupe.agent.mental_faculty.TinyMentalFaculty.process_action">process_action</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="tinytroupe.agent.mental_faculty.TinyToolUse" href="#tinytroupe.agent.mental_faculty.TinyToolUse">TinyToolUse</a></code></h4>
</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> |