diff --git a/.github/labeler.yml b/.github/labeler.yml index 8ba5158dfff4..07f6aac81766 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -10,3 +10,15 @@ dumb-bot: reasoner: - changed-files: - any-glob-to-any-file: reasoner/** +fixture: + - changed-files: + - any-glob-to-any-file: fixture/** +hamr: + - changed-files: + - any-glob-to-any-file: hamr/** +info: + - changed-files: + - any-glob-to-any-file: info/** +test-file-runner: + - changed-files: + - any-glob-to-any-file: test-file-runner/** diff --git a/.github/workflows/title.yml b/.github/workflows/title.yml index 5e5fd685b371..5bb9e7c2f0fd 100644 --- a/.github/workflows/title.yml +++ b/.github/workflows/title.yml @@ -39,3 +39,7 @@ jobs: openai(/unstable)? dumb-bot(/unstable)? reasoner(/unstable)? + fixture(/unstable)? + hamr(/unstable)? + info(/unstable)? + test-file-runner(/unstable)? diff --git a/README.md b/README.md index 0c4c01d8211c..ac1872f8cfcd 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,16 @@ for Artifact, the infrastructure of the The following list contains links to the Artifact Standard Library's packages and documentation: -| Package | Latest version | -| --------------------------------------------- | ------------------------------------------------------------------------------------- | -| [files](https://jsr.io/@artifact/files) | [![JSR](https://jsr.io/badges/@artifact/files)](https://jsr.io/@artifact/files) | -| [openai](https://jsr.io/@artifact/openai) | [![JSR](https://jsr.io/badges/@artifact/openai)](https://jsr.io/@artifact/openai) | -| [dumb-bot](https://jsr.io/@artifact/dumb-bot) | [![JSR](https://jsr.io/badges/@artifact/dumb-bot)](https://jsr.io/@artifact/dumb-bot) | -| [reasoner](https://jsr.io/@artifact/reasoner) | [![JSR](https://jsr.io/badges/@artifact/reasoner)](https://jsr.io/@artifact/reasoner) | +| Package | Latest version | +| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| [files](https://jsr.io/@artifact/files) | [![JSR](https://jsr.io/badges/@artifact/files)](https://jsr.io/@artifact/files) | +| [openai](https://jsr.io/@artifact/openai) | [![JSR](https://jsr.io/badges/@artifact/openai)](https://jsr.io/@artifact/openai) | +| [dumb-bot](https://jsr.io/@artifact/dumb-bot) | [![JSR](https://jsr.io/badges/@artifact/dumb-bot)](https://jsr.io/@artifact/dumb-bot) | +| [reasoner](https://jsr.io/@artifact/reasoner) | [![JSR](https://jsr.io/badges/@artifact/reasoner)](https://jsr.io/@artifact/reasoner) | +| [fixture](https://jsr.io/@artifact/fixture) | [![JSR](https://jsr.io/badges/@artifact/fixture)](https://jsr.io/@artifact/fixture) | +| [hamr](https://jsr.io/@artifact/hamr) | [![JSR](https://jsr.io/badges/@artifact/hamr)](https://jsr.io/@artifact/hamr) | +| [info](https://jsr.io/@artifact/info) | [![JSR](https://jsr.io/badges/@artifact/info)](https://jsr.io/@artifact/info) | +| [test-file-runner](https://jsr.io/@artifact/test-file-runner) | [![JSR](https://jsr.io/badges/@artifact/test-file-runner)](https://jsr.io/@artifact/test-file-runner) | ## Architecture diff --git a/_import-HAL/LICENSE b/_import-HAL/LICENSE deleted file mode 100644 index 0ad25db4bd1d..000000000000 --- a/_import-HAL/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/_import-HAL/agents/files.md b/_import-HAL/agents/files.md deleted file mode 100644 index 11126d4369e7..000000000000 --- a/_import-HAL/agents/files.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -commands: - - files:write - - files:ls - - files:read - - files:update - - files:rm - - files:mv - - files:search - - stateboard:show ---- - -You are a posix filesystem with all paths being relative. Keep your responses -informative and highly information dense. Dispense with any pleasantries. - -Do only what you are told to, never ask what to do next. Do not guess -parameters - always ask clarifying questions. - -To help the user explore the filesystem, you can use the stateboard to display -widgets at an appropriate time. - -To browse files, use the "FILE_EXPLORER" widget. diff --git a/_import-HAL/info/CRM_Entities/CUSTOMER/customer_details.md b/_import-HAL/info/CRM_Entities/CUSTOMER/customer_details.md deleted file mode 100644 index 44b5c80f7716..000000000000 --- a/_import-HAL/info/CRM_Entities/CUSTOMER/customer_details.md +++ /dev/null @@ -1,181 +0,0 @@ -# customer_details.md - -CUSTOMER { - int customer_id PK "1" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Alice Johnson" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "2" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Brian Smith" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "3" - int agent_id FK "1" - int location_id FK "2" - string customer_name "Catherine Lee" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "4" - int agent_id FK "1" - int location_id FK "2" - string customer_name "David Brown" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "5" - int agent_id FK "1" - int location_id FK "3" - string customer_name "Eva White" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "6" - int agent_id FK "1" - int location_id FK "3" - string customer_name "Frank Green" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "7" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Grace Hall" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "8" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Henry King" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "9" - int agent_id FK "1" - int location_id FK "2" - string customer_name "Isabella Clark" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "10" - int agent_id FK "1" - int location_id FK "2" - string customer_name "Jack Davis" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "11" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Karen Wilson" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "12" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Liam Lewis" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "13" - int agent_id FK "1" - int location_id FK "2" - string customer_name "Mia Robinson" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "14" - int agent_id FK "1" - int location_id FK "2" - string customer_name "Noah Martinez" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "15" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Olivia Taylor" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "16" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Peter Anderson" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "17" - int agent_id FK "1" - int location_id FK "2" - string customer_name "Quinn Thomas" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "18" - int agent_id FK "1" - int location_id FK "2" - string customer_name "Ryan Jackson" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "19" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Sophia Harris" - date start_date "2024-09-20" - date end_date "2025-09-20" -} - -CUSTOMER { - int customer_id PK "20" - int agent_id FK "1" - int location_id FK "1" - string customer_name "Thomas Clark" - date start_date "2024-09-20" - date end_date "2025-09-20" -} diff --git a/_import-HAL/info/CRM_Entities/CUSTOMER/customer_feedback.md b/_import-HAL/info/CRM_Entities/CUSTOMER/customer_feedback.md deleted file mode 100644 index 1b17d40e8768..000000000000 --- a/_import-HAL/info/CRM_Entities/CUSTOMER/customer_feedback.md +++ /dev/null @@ -1 +0,0 @@ -# customer_feedback.md \ No newline at end of file diff --git a/_import-HAL/info/CRM_Entities/CUSTOMER/customer_history.md b/_import-HAL/info/CRM_Entities/CUSTOMER/customer_history.md deleted file mode 100644 index f485bbbd0676..000000000000 --- a/_import-HAL/info/CRM_Entities/CUSTOMER/customer_history.md +++ /dev/null @@ -1 +0,0 @@ -# customer_history.md \ No newline at end of file diff --git a/_import-HAL/info/CRM_Entities/CUSTOMER_AGENT/agent_performance.md b/_import-HAL/info/CRM_Entities/CUSTOMER_AGENT/agent_performance.md deleted file mode 100644 index 7916e35387ce..000000000000 --- a/_import-HAL/info/CRM_Entities/CUSTOMER_AGENT/agent_performance.md +++ /dev/null @@ -1 +0,0 @@ -# agent_performance.md \ No newline at end of file diff --git a/_import-HAL/info/CRM_Entities/CUSTOMER_AGENT/agent_profiles.md b/_import-HAL/info/CRM_Entities/CUSTOMER_AGENT/agent_profiles.md deleted file mode 100644 index c762cba3b882..000000000000 --- a/_import-HAL/info/CRM_Entities/CUSTOMER_AGENT/agent_profiles.md +++ /dev/null @@ -1,20 +0,0 @@ -# agent_profiles.md - -CUSTOMER_AGENT { - int agent_id PK "1" - int company_id FK "1" - int department_id FK "1" - string name "Ava Martin" - int age "30" - string address "123 Main St" -} - -CUSTOMER_AGENT { - int agent_id PK "2" - int company_id FK "1" - int department_id FK "2" - string name "Ben Thompson" - int age "25" - string address "123 Elm St" -} - diff --git a/_import-HAL/info/CRM_Entities/DRIVERS/driver_profiles.md b/_import-HAL/info/CRM_Entities/DRIVERS/driver_profiles.md deleted file mode 100644 index f6b9aecf2867..000000000000 --- a/_import-HAL/info/CRM_Entities/DRIVERS/driver_profiles.md +++ /dev/null @@ -1,139 +0,0 @@ -DRIVER { - int driver_id PK "1" - int truck_id FK "1" - string name "Amy Wilson" - string license_number "DL12345" -} - -DRIVER { - int driver_id PK "2" - int truck_id FK "1" - string name "Bradley Lee" - string license_number "DL12346" -} - -DRIVER { - int driver_id PK "3" - int truck_id FK "2" - string name "Charlie Smith" - string license_number "DL12347" -} - -DRIVER { - int driver_id PK "4" - int truck_id FK "2" - string name "Diana Clark" - string license_number "DL12348" -} - -DRIVER { - int driver_id PK "5" - int truck_id FK "3" - string name "Ethan Martinez" - string license_number "DL12349" -} - -DRIVER { - int driver_id PK "6" - int truck_id FK "3" - string name "Fiona Johnson" - string license_number "DL12350" -} - -DRIVER { - int driver_id PK "7" - int truck_id FK "4" - string name "Graham Davis" - string license_number "DL12351" -} - -DRIVER { - int driver_id PK "8" - int truck_id FK "4" - string name "Hannah King" - string license_number "DL12352" -} - -DRIVER { - int driver_id PK "9" - int truck_id FK "5" - string name "Isaac Green" - string license_number "DL12353" -} - -DRIVER { - int driver_id PK "10" - int truck_id FK "5" - string name "Julia Brown" - string license_number "DL12354" -} - -DRIVER { - int driver_id PK "11" - int truck_id FK "6" - string name "Kevin White" - string license_number "DL12355" -} - -DRIVER { - int driver_id PK "12" - int truck_id FK "6" - string name "Laura Harris" - string license_number "DL12356" -} - -DRIVER { - int driver_id PK "13" - int truck_id FK "7" - string name "Mark Thompson" - string license_number "DL12357" -} - -DRIVER { - int driver_id PK "14" - int truck_id FK "7" - string name "Nora Young" - string license_number "DL12358" -} - -DRIVER { - int driver_id PK "15" - int truck_id FK "1" - string name "Oscar Clark" - string license_number "DL12359" -} - -DRIVER { - int driver_id PK "16" - int truck_id FK "2" - string name "Penny Brown" - string license_number "DL12360" -} - -DRIVER { - int driver_id PK "17" - int truck_id FK "3" - string name "Quinn Lewis" - string license_number "DL12361" -} - -DRIVER { - int driver_id PK "18" - int truck_id FK "4" - string name "Rachel Scott" - string license_number "DL12362" -} - -DRIVER { - int driver_id PK "19" - int truck_id FK "5" - string name "Sam Harris" - string license_number "DL12363" -} - -DRIVER { - int driver_id PK "20" - int truck_id FK "6" - string name "Tina Martinez" - string license_number "DL12364" -} diff --git a/_import-HAL/info/CRM_Entities/DRIVERS/driver_status.md b/_import-HAL/info/CRM_Entities/DRIVERS/driver_status.md deleted file mode 100644 index 4e682c93961e..000000000000 --- a/_import-HAL/info/CRM_Entities/DRIVERS/driver_status.md +++ /dev/null @@ -1 +0,0 @@ -# driver_status.md \ No newline at end of file diff --git a/_import-HAL/info/CRM_Entities/DUTY_MANAGER/duty_manager_profiles.md b/_import-HAL/info/CRM_Entities/DUTY_MANAGER/duty_manager_profiles.md deleted file mode 100644 index eeed1cf44d08..000000000000 --- a/_import-HAL/info/CRM_Entities/DUTY_MANAGER/duty_manager_profiles.md +++ /dev/null @@ -1,11 +0,0 @@ -# duty_manager_profiles.md - -DUTY_MANAGER { - int manager_id PK "1" - string name "Mark Green" -} - -DUTY_MANAGER { - int manager_id PK "2" - string name "Samantha White" -} \ No newline at end of file diff --git a/_import-HAL/info/CRM_Entities/LOCATION/dropoff_locations.md b/_import-HAL/info/CRM_Entities/LOCATION/dropoff_locations.md deleted file mode 100644 index ae9b86979ac7..000000000000 --- a/_import-HAL/info/CRM_Entities/LOCATION/dropoff_locations.md +++ /dev/null @@ -1 +0,0 @@ -# dropoff_locations.md \ No newline at end of file diff --git a/_import-HAL/info/CRM_Entities/LOCATION/pickup_locations.md b/_import-HAL/info/CRM_Entities/LOCATION/pickup_locations.md deleted file mode 100644 index 4ff4ba1c2242..000000000000 --- a/_import-HAL/info/CRM_Entities/LOCATION/pickup_locations.md +++ /dev/null @@ -1,23 +0,0 @@ -# pickup_locations.md - -LOCATION { - int location_id PK "1" - string address "Location 1" - string route "Route 1" - string details "Details for Location 1" -} - -LOCATION { - int location_id PK "2" - string address "Location 2" - string route "Route 2" - string details "Details for Location 2" -} - -LOCATION { - int location_id PK "3" - string address "Location 3" - string route "Route 3" - string details "Details for Location 3" -} - diff --git a/_import-HAL/info/CRM_Entities/ROUTES/route_details.md b/_import-HAL/info/CRM_Entities/ROUTES/route_details.md deleted file mode 100644 index a5e986448624..000000000000 --- a/_import-HAL/info/CRM_Entities/ROUTES/route_details.md +++ /dev/null @@ -1,63 +0,0 @@ -# route_details.md - - -ROUTE { - int route_id PK "1" - int location_id FK "1" - string day "Tuesday" -} - -ROUTE { - int route_id PK "2" - int location_id FK "2" - string day "Thursday" -} - -ROUTE { - int route_id PK "3" - int location_id FK "3" - string day "Wednesday" -} - -ROUTE { - int route_id PK "4" - int location_id FK "1" - string day "Fortnightly" -} - -ROUTE { - int route_id PK "5" - int location_id FK "2" - string day "Monthly" -} - -ROUTE { - int route_id PK "6" - int location_id FK "3" - string day "Daily" -} - -ROUTE { - int route_id PK "7" - int location_id FK "1" - string day "Weekly" -} - -ROUTE { - int route_id PK "8" - int location_id FK "2" - string day "Bi-weekly" -} - -ROUTE { - int route_id PK "9" - int location_id FK "3" - string day "Sunday" -} - -ROUTE { - int route_id PK "10" - int location_id FK "1" - string day "Saturday" -} - diff --git a/_import-HAL/info/CRM_Entities/ROUTES/route_plans.md b/_import-HAL/info/CRM_Entities/ROUTES/route_plans.md deleted file mode 100644 index 1f944109eb50..000000000000 --- a/_import-HAL/info/CRM_Entities/ROUTES/route_plans.md +++ /dev/null @@ -1,31 +0,0 @@ -# route_plans.md - -ROUTE { - int route_id PK "1" - int location_id FK "1" - string day "Weekly" -} - -ROUTE { - int route_id PK "2" - int location_id FK "2" - string day "Bi-weekly" -} - -ROUTE { - int route_id PK "3" - int location_id FK "3" - string day "Monthly" -} - -ROUTE { - int route_id PK "4" - int location_id FK "2" - string day "Every Tuesday" -} - -ROUTE { - int route_id PK "5" - int location_id FK "1" - string day "Every Thursday" -} diff --git a/_import-HAL/info/CRM_Entities/SCHEDULE/schedule_details.md b/_import-HAL/info/CRM_Entities/SCHEDULE/schedule_details.md deleted file mode 100644 index e0217dd14904..000000000000 --- a/_import-HAL/info/CRM_Entities/SCHEDULE/schedule_details.md +++ /dev/null @@ -1,82 +0,0 @@ -# schedule_details.md - -SCHEDULE { - int schedule_id PK "1" - int truck_id FK "1" - int driver_id FK "1" - int route_id FK "1" - date date "2024-09-21" -} - -SCHEDULE { - int schedule_id PK "2" - int truck_id FK "1" - int driver_id FK "2" - int route_id FK "1" - date date "2024-09-24" -} - -SCHEDULE { - int schedule_id PK "3" - int truck_id FK "2" - int driver_id FK "1" - int route_id FK "2" - date date "2024-09-26" -} - -SCHEDULE { - int schedule_id PK "4" - int truck_id FK "2" - int driver_id FK "2" - int route_id FK "2" - date date "2024-09-28" -} - -SCHEDULE { - int schedule_id PK "5" - int truck_id FK "3" - int driver_id FK "3" - int route_id FK "3" - date date "2024-10-05" -} - -SCHEDULE { - int schedule_id PK "6" - int truck_id FK "3" - int driver_id FK "4" - int route_id FK "3" - date date "2024-10-10" -} - -SCHEDULE { - int schedule_id PK "7" - int truck_id FK "4" - int driver_id FK "1" - int route_id FK "4" - date date "2024-10-12" -} - -SCHEDULE { - int schedule_id PK "8" - int truck_id FK "4" - int driver_id FK "2" - int route_id FK "4" - date date "2024-10-14" -} - -SCHEDULE { - int schedule_id PK "9" - int truck_id FK "5" - int driver_id FK "3" - int route_id FK "5" - date date "2024-10-17" -} - -SCHEDULE { - int schedule_id PK "10" - int truck_id FK "5" - int driver_id FK "4" - int route_id FK "5" - date date "2024-10-20" -} - diff --git a/_import-HAL/info/CRM_Entities/TRUCK/truck_details.md b/_import-HAL/info/CRM_Entities/TRUCK/truck_details.md deleted file mode 100644 index a824c2ca94e4..000000000000 --- a/_import-HAL/info/CRM_Entities/TRUCK/truck_details.md +++ /dev/null @@ -1,44 +0,0 @@ -# truck_details.md - -TRUCK { - int truck_id PK "1" - string model "Truck Model 1" - string license_plate "ABC123" -} - -TRUCK { - int truck_id PK "2" - string model "Truck Model 2" - string license_plate "ABC124" -} - -TRUCK { - int truck_id PK "3" - string model "Truck Model 3" - string license_plate "ABC125" -} - -TRUCK { - int truck_id PK "4" - string model "Truck Model 4" - string license_plate "ABC126" -} - -TRUCK { - int truck_id PK "5" - string model "Truck Model 5" - string license_plate "ABC127" -} - -TRUCK { - int truck_id PK "6" - string model "Truck Model 6" - string license_plate "ABC128" -} - -TRUCK { - int truck_id PK "7" - string model "Truck Model 7" - string license_plate "ABC129" -} - diff --git a/_import-HAL/info/global-definitions.md b/_import-HAL/info/global-definitions.md deleted file mode 100644 index cfbc588b4315..000000000000 --- a/_import-HAL/info/global-definitions.md +++ /dev/null @@ -1,11 +0,0 @@ -## Global Definitions - -The following are the definitions to use. They supersede any other expectations you may have. - -- PROMPT: An input to an AGENT. A PROMPT may be plain text, or may be a fenced codeblock, often in md or markdown format, since the test file itself is markdown and a PROMPT that - includes markdown features needs to be fenced to signal it is meant to be passed - as a single block of text. -- AGENT: An AI that can be passed a PROMPT from a user or another AGENT and which gives a RESPONSE. -- TEST-FILE-RUNNER: A TEST-FILE-RUNNER is and AGENT which is passed a TEST FILE, expands TESTS, runs them against the TARGET and passes the output to the ASSESSOR. -- ASSESSOR: The ASSESSOR is an AGENT which performs the assessments on the end system state after running the TEST-FILE-RUNNER runs a TEST-FILE against a TARGET. The path to the ASSESSOR that is to be used as in this RUN. The path to an ASSESSOR must always be in the folder "/agents/". -- RESPONSE: The output from an AGENT given a PROMPT. diff --git a/_import-HAL/info/scott-bin/DC Definitions.md b/_import-HAL/info/scott-bin/DC Definitions.md deleted file mode 100644 index d359312902f2..000000000000 --- a/_import-HAL/info/scott-bin/DC Definitions.md +++ /dev/null @@ -1,426 +0,0 @@ -# Dreamcatcher Framework Rules - -# TABLE OF CONTENTS - - 1. ENTITIES - 2. DEFINITIONS OF ACTIONS AVAILABLE - 3. NOUN DEFINITIONS - 4. SYSTEM FRAMEWORK - 5. TEMPLATES - 6. ENTITY RELATIONSHIP DIAGRAM - -## ENTITIES - -- DAVE: - **Description** - The human user. DAVE may rename himself and, if so, retains the same Actions Available. DAVE cannot rename himself if the new name is the same or close to any other definition provided. - **Actions Available** - - PROMPT - - TASK HAL - - Receive RESPONSE from HAL - - Take a STATEBOARD_ACTION - -- HAL: - **Description** - An AGENT that can ORCHESTRATE other AGENTS to carry out a TASK requested by DAVE. - **Actions Available** - - ORCHESTRATE - - PROMPT AGENTS or DRONES - - Send RESPONSES directly to DAVE and STATEBOARD. - - SEND RESPONSES to AGENTS and DRONES - - Can trigger COMMAND_EXECUTION available from their BOT_DEFINITION - -- AGENT: - **Description** - An INSTANTIATION that can be uniquely identified. - **Actions Available** - - PROMPT AGENTS or DRONES - - Complete TASKS - - TASK AGENTS and DRONES (within the limits of their system prompt) - - SEND RESPONSES to other AGENTS and DRONES - - Can trigger COMMAND_EXECUTION available from their BOT_DEFINITION - - - TOOL: - **Description** - An executable software component that performs COMMAND_EXECUTION when called upon by HAL or an AGENT. - **Actions Available** - - Execute COMMANDS - - Return RESPONSES - -- DRONE: - **Description** - A INSTANTIATION of a BOT_DEFINITION that, having been INSTANTIATED, can be uniquely identified. - **Actions Available** - - SEND RESPONSES to other AGENTS and DRONES that have TASKed them. - - Can trigger COMMAND_EXECUTION available from their BOT_DEFINITION - -- ISOLATE: - **Description** - Traditional code executed by HAL, an AGENT, or a DRONE. COMMANDS are sent to ISOLATES for execution. - **Actions Available** - - Run COMMANDS. - -- AI_MODEL: - **Description** - An external service used to INSTANTIATE and RUN HAL, AGENTS and DRONES, and RUN TASKS. - **Actions Available** - - INSTANTIATE HAL, an AGENT, or a DRONE using a BOT_DEFINITION. - -- ARTIFACT: - **Description** - The operating system. - **Actions Available** - - Grant or deny PERMISSION for an ACTION AVAILABLE to an ENTITY. - - RUN COMMAND_EXECUTIONS. - -## DEFINITIONS OF ACTIONS AVAILABLE - -- PROMPT: Input via voice, text, or uploaded files. - -- RESPONSE: An output following a call to AI_MODEL. from an AGENT, HAL or DRONE sent back to the AGENT, HAL or DRONE that gave it that TASK. - -- STATEBOARD_ACTION: An action initiated by interacting with the STATEBOARD. STATEBOARD_ACTIONS can call COMMAND_EXECUTION or TASKS. - -- COMMAND_EXECUTION: The request to an ISOLATE to run a piece of code. - -- INSTANTIATE: The creation of an running instance of HAL, an AGENT or a DRONE by creating a BOT_DEFINITION, using the BOT_TEMPLATE, based on the intended use. - -- DEINSTANTIATE: to delete an INSTANTIATED AGENT or DRONE. Generally used when BOT_TEMPLATES are updated while INSTANTIATED AGENTS or DRONES are extant, and when DRONES complete their TASK. - -- TASK: A request for INFO, an ACTION or an TRANSMISSION. - -- ORCHESTRATE: Considering the THREAD, INTENT, CAPABILITIES and AGENTS available, the act of planning and executing steps necessary to achieve the appropriate output for DAVE's last PROMPT - - - -## NOUN DEFINITIONS: - -- PERMISSION: On HAL, AGENTS and DRONES requesting a TASK, PERMISSION is a yes/no returned by ARTIFACT. - -- INTENT: The high-level outcome that DAVE wants HAL to achieve. HAL generates INTENT based on the THREAD conversation. INTENT can be used to gain additional context beyond the last PROMPT. - -- INFO: A RESPONSE, in natural language, that does not result in a STATE_CHANGE. - -- ACTION: A COMMAND_EXECUTION that results in a STATE_CHANGE. - -- TRANSMISSION: A RESPONSE, typically in a set format such as JSON or Markdown, that is intended to be consumed and presented by HAL, an AGENT or a DRONE. - -- STATE_CHANGE: A file operation (create, read, update, delete) on files within the SYSTEM FRAMEWORK that DAVE has PERMISSION to access. - -- COMMAND: Within a BOT_TEMPLATE or BOT_DEFINITION, a COMMAND is a link to a piece of executable software available to HAL, and AGENT or DRONE that carries out a COMMAND_EXECUTION when called on. COMMANDS carry out a single purpose, typically a STATE_CHANGE. - -- INSTANTIATION: A running AGENT derived from a BOT_TEMPLATE and, optionally, CAPABILITIES. - - -## SYSTEM FRAMEWORK: - -- HAL_TEMPLATE: A text file that defines the structure of HAL. See below for more details. - -- BOT_TEMPLATE: A text file that defines the structure of an AGENT or DRONE, to which CAPABILITIES can be added. See below for more details. - -- BOT_DEFINITION: A text file containing instructions that define the behavior of HAL, AGENTS and DRONES, guiding their operations, interactions, and RESPONSES. - -- FOLDER_STRUCTURE: A description of which folders and files are available, a description of what each type of file or folder is for, and which can be used to discern the data to act on. The FOLDER_STRUCTURE is controlled by ARTIFACT. - -- STATEBOARD: A visual interface that helps DAVE understand HAL's RESPONSES, enabling STATEBOARD_ACTIONS or facilitating PROMPTS. - -- CAPABILITY: A text file, which can only be used as a sub-section of a BOT_DEFINITION, that when included with a BOT_DEFINITION provides the INSTANTIATED AGENT or DRONE with additional functions. Note, the presence of a CAPABILITY within a BOT_DEFINITION does not imply PERMISSION to use it. - -- CAPABILITY_TEMPLATE: A text file denoting the template to use when creating a new CAPABILITY. - -- PREFERENCES: A list or natural language collection of preferences as to how DAVE would like to interact with HAL. Note, PREFERENCES cannot override PERMISSION or PRIORITY. - -- THREAD: The PROMPT/RESPONSE record of interaction between DAVE and HAL. - -- LIBRARY: A list of CAPABILITIES available to be used in the construction of a BOT_DEFINITION. - -- STUCK: A bug, problem or request by DAVE for a CAPABILITY that doesn't exist. Once solved, a STUCK becomes a CAPABILITY. - -- STUCK LIBRARY: A list of STUCKS yet to be solved. - -## TEMPLATES - -### TERMS USED in TEMPLATES - -The following are additional definitions used within a BOT_DEFINITION. - -- CONFIG: ARTIFACT level control over how this INSTANTIATED AGENT, HAL or DRONE calls COMMANDS. -- GLOBAL_DEFINITIONS: A list of Definitions that supersede any other definitions you may have. The HAL, the AGENT or DRONE must use these at all times. -- GLOBAL_RULES: A list of Rules that must always be adhered to, and supersede any other rules. -- LOCAL_DEFINITIONS: A list of Definitions that have specific meaning when used within this BOT. They are overridden by PRIORITY_DEFINITIONS. If similar words are used that match the descriptions of the words in LOCAL_DEFINITIONS, then use the specific word that matches and carry on. -- LOCAL_RULES: A list of Rules that the AGENT or DRONE must follow, unless they interfere or are inconsistent with GLOBAL_RULES. -- OVERVIEW: A Natural Language description of what this AGENT or DRONE does -- IDENTITY: A description of who this AGENT or DRONE is and how it should behave. -- OBJECTIVE: A description of what this AGENT or DRONE is to do. -- PROCESS: A description of how this AGENT or DRONE should achieve its OBJECTIVE -- RESULT: What is expected after the AGENT or DRONE has a RESPONSE. May include example formats to constrain the syntax. May also include guidelines on handling errors. -- EXAMPLES: A helpful example of the output required if given a TASK. - -### BOT_TEMPLATE - -When HAL, an AGENT or a BOT is INSTANTIATED, a BOT_DEFINITION is compiled and stored as a file. The structure of that file is as follows: - - - BOT_ID - - CONFIG: - - COMMANDS: - - OVERVIEW: - - PRIORITY_DEFINITIONS - - LOCAL_DEFINITIONS - - GLOBAL_RULES: - - LOCAL_RULES - - IDENTITY - - OBJECTIVE: - - PROCESS: - - RESULT: - - EXAMPLES: - - CAPABILITY: If no CAPABILITIES are provided, the AGENT uses the bare AI_MODEL without further system prompting. NOTE: a BOT_DEFINITION can have more than one CAPABILITY. - -### DAVE_TEMPLATE: - - - ID: Unique ID within the Dreamcatcher System - - Identity: E.g. Dave's personal account details - - Preferences: - - Personal Folder Structure: - -### HAL_TEMPLATE: - - - ID: - - DAVE_ID: The owner of this HAL. A link to the ID of DAVE who has sole control over this particular HAL. - - THREAD: Provided by ARTIFACT, a list of hashes that link to previous conversations and STATES between HAL and DAVE. - - INSTANTIATED AGENT list: A list of running AGENTS generated by HAL on DAVE's requests. - - LIBRARY: See above. - - STUCK LIBRARY: See above - - Live AGENTS: List of previously INSTANTIATED AGENTS that were INSTANTIATED by this DAVE identified through DAVE_ID. - -### CAPABILITY_TEMPLATE: - - - CAPABILITY_ID - - CONFIG: - - COMMANDS: - - OVERVIEW: - - PRIORITY_DEFINITIONS - - LOCAL_DEFINITIONS - - GLOBAL_RULES: - - LOCAL_RULES - - IDENTITY - - OBJECTIVE: - - PROCESS: - - RESULT: - - EXAMPLES: - - -napp weather - napp weather manifest - agent weather - - - -### NAPP Manifest - -### NAPP Manifest -Defined as package that bridges NL to code using the following: - - - TOOLS: Source code. - Description of what you can do. - Knowledge base (topic knowledge) Some base knowledge and one Agent file. - - TESTS - Test files - TPS - - Advertisement of SOA type thing. - - - Agent file - --- - - TOOLS INTERFACE e.g. JSON - classical - - NAPP INTERFACE NL PROMPT/RESPONSES - weather napp - sandwich napp - golf napp - - Model choice - - Model config - --- - - - Instructions - How to carry b ook a business day that not raining, has sandwiches and we play golf. - - - -### BOT file - - - -Agent file instructions layer - - - - - -## ENTITY RELATIONSHIP DIAGRAM - -flowchart TD - -%% Entities - -DAVE["**DAVE**
-**Actions Available:**
-• PROMPT
-• TASK HAL
-• Receive RESPONSE from HAL
-• Take a STATEBOARD_ACTION
-"] - -HAL["**HAL**
-A privileged AGENT that directly interacts with DAVE.
-**Actions Available:**
-• PROMPT AGENTS or DRONES
-• Send RESPONSES directly to DAVE and STATEBOARD
-• SEND RESPONSES to AGENTS and DRONES
-• Can trigger COMMAND_EXECUTION available from their BOT_DEFINITION
-"] - -AGENT["**AGENT**
-An INSTANTIATION of a BOT_DEFINITION, uniquely identified.
-**Actions Available:**
-• PROMPT AGENTS or DRONES
-• Complete TASKS
-• TASK AGENTS and DRONES (within system prompt limits)
-• SEND RESPONSES to other AGENTS and DRONES
-• Can trigger COMMAND_EXECUTION available from their BOT_DEFINITION
-"] - -DRONE["**DRONE**
-An INSTANTIATION of a BOT_DEFINITION, uniquely identified.
-**Actions Available:**
-• SEND RESPONSES to AGENTS and DRONES that have TASKed them
-• Can trigger COMMAND_EXECUTION available from their BOT_DEFINITION
-"] - -ISOLATE["**ISOLATE**
-Traditional code executed by HAL, AGENT, or DRONE.
-COMMANDS are sent to ISOLATES for execution.
-**Actions Available:**
-• Run COMMANDS
-"] - -AI_MODEL["**AI_MODEL**
-External service used to INSTANTIATE and RUN HAL, AGENTS, and DRONES
-Runs TASKS
-**Actions Available:**
-• INSTANTIATE HAL, an AGENT, or a DRONE using a BOT_DEFINITION
-"] - -ARTIFACT["**ARTIFACT**
-The operating system
-**Actions Available:**
-• Grant or deny PERMISSION for an ACTION AVAILABLE to an ENTITY
-• RUN COMMAND_EXECUTIONS
-"] - -STATEBOARD["**STATEBOARD**
-Visual interface that helps DAVE understand HAL's RESPONSES
-Enables STATEBOARD_ACTIONS or facilitates PROMPTS
-"] - -THREAD["**THREAD**
-The PROMPT/RESPONSE record of interaction between DAVE and HAL
-"] - -COMMAND["**COMMAND**
-Link to executable software within a BOT_TEMPLATE or BOT_DEFINITION
-Available to HAL, AGENT, or DRONE
-Carries out a COMMAND_EXECUTION when called
-"] - -TASK["**TASK**
-A request for INFO, an ACTION, or a TRANSMISSION
-"] - -PERMISSION["**PERMISSION**
-Yes/No returned by ARTIFACT when HAL, AGENT, or DRONE requests a TASK
-"] - -STATEBOARD_ACTION["**STATEBOARD_ACTION**
-Action initiated by DAVE interacting with the STATEBOARD
-Can call COMMAND_EXECUTION or TASKS
-"] - -%% Relationships - -%% DAVE Interactions -DAVE -->|PROMPT| HAL -DAVE -->|TASKs| HAL -DAVE -->|Receives RESPONSE from| HAL -DAVE -->|Takes| STATEBOARD_ACTION -DAVE -->|Interacts with| STATEBOARD -DAVE -->|Has| PREFERENCES -DAVE -->|Engages in| THREAD - -%% HAL Interactions -HAL -->|Sends RESPONSE to| DAVE -HAL -->|Updates| STATEBOARD -HAL -->|PROMPTs| AGENT -HAL -->|PROMPTs| DRONE -HAL -->|Sends RESPONSES to| AGENT -HAL -->|Sends RESPONSES to| DRONE -HAL -->|Can trigger| COMMAND_EXECUTION -HAL -->|Requests PERMISSION from| ARTIFACT -HAL -->|Uses| AI_MODEL -HAL -->|Uses| BOT_DEFINITION -HAL -->|Uses| COMMANDS - -%% AGENT Interactions -AGENT -->|PROMPTs| AGENT -AGENT -->|PROMPTs| DRONE -AGENT -->|TASKs| AGENT -AGENT -->|TASKs| DRONE -AGENT -->|Sends RESPONSES to| AGENT -AGENT -->|Sends RESPONSES to| DRONE -AGENT -->|Completes| TASKS -AGENT -->|Can trigger| COMMAND_EXECUTION -AGENT -->|Requests PERMISSION from| ARTIFACT -AGENT -->|Uses| AI_MODEL -AGENT -->|Uses| BOT_DEFINITION -AGENT -->|Uses| COMMANDS - -%% DRONE Interactions -DRONE -->|Sends RESPONSES to| AGENT -DRONE -->|Sends RESPONSES to| DRONE -DRONE -->|Can trigger| COMMAND_EXECUTION -DRONE -->|Requests PERMISSION from| ARTIFACT -DRONE -->|Uses| AI_MODEL -DRONE -->|Uses| BOT_DEFINITION -DRONE -->|Uses| COMMANDS - -%% ISOLATE Interactions -COMMAND -->|Is sent to| ISOLATE -ISOLATE -->|Executes| COMMANDS - -%% AI_MODEL Interactions -AI_MODEL -->|INSTANTIATES| HAL -AI_MODEL -->|INSTANTIATES| AGENT -AI_MODEL -->|INSTANTIATES| DRONE - -%% ARTIFACT Interactions -ARTIFACT -->|Grants or Denies| PERMISSION -ARTIFACT -->|Runs| COMMAND_EXECUTION - -%% THREAD Interactions -THREAD -->|Records| PROMPT -THREAD -->|Records| RESPONSE - -%% STATEBOARD_ACTION Interactions -STATEBOARD_ACTION -->|Registered by| ARTIFACT -STATEBOARD_ACTION -->|Can call| COMMAND_EXECUTION -STATEBOARD_ACTION -->|Can call| TASK - -%% PROMPT and RESPONSE -HAL -->|Processes| PROMPT -HAL -->|Generates| RESPONSE -AGENT -->|Processes| PROMPT -AGENT -->|Generates| RESPONSE -DRONE -->|Generates| RESPONSE - -%% TASK Interactions -DAVE -->|Requests| TASK -HAL -->|Handles| TASK -AGENT -->|Handles| TASK -DRONE -->|Handles| TASK diff --git a/_import-HAL/info/scott-bin/global-definitions.md b/_import-HAL/info/scott-bin/global-definitions.md deleted file mode 100644 index cfbc588b4315..000000000000 --- a/_import-HAL/info/scott-bin/global-definitions.md +++ /dev/null @@ -1,11 +0,0 @@ -## Global Definitions - -The following are the definitions to use. They supersede any other expectations you may have. - -- PROMPT: An input to an AGENT. A PROMPT may be plain text, or may be a fenced codeblock, often in md or markdown format, since the test file itself is markdown and a PROMPT that - includes markdown features needs to be fenced to signal it is meant to be passed - as a single block of text. -- AGENT: An AI that can be passed a PROMPT from a user or another AGENT and which gives a RESPONSE. -- TEST-FILE-RUNNER: A TEST-FILE-RUNNER is and AGENT which is passed a TEST FILE, expands TESTS, runs them against the TARGET and passes the output to the ASSESSOR. -- ASSESSOR: The ASSESSOR is an AGENT which performs the assessments on the end system state after running the TEST-FILE-RUNNER runs a TEST-FILE against a TARGET. The path to the ASSESSOR that is to be used as in this RUN. The path to an ASSESSOR must always be in the folder "/agents/". -- RESPONSE: The output from an AGENT given a PROMPT. diff --git a/_import-HAL/info/scott-bin/scott_global-definitions.md b/_import-HAL/info/scott-bin/scott_global-definitions.md deleted file mode 100644 index 4341610287cf..000000000000 --- a/_import-HAL/info/scott-bin/scott_global-definitions.md +++ /dev/null @@ -1,13 +0,0 @@ -## Global Definitions - -The following are the definitions to use above all others. They supersede any other expectations you may have. - -- **PROMPT**: An input to an **AGENT**. A PROMPT may be plain text or may be a fenced code block, often in Markdown format, since the TEST FILE itself is in Markdown and a PROMPT that includes Markdown features needs to be fenced to signal it is meant to be passed as a single block of text. - -- **AGENT**: An AI that can be passed a PROMPT from a user or another AGENT and which gives a **RESPONSE**. - -- **TEST-FILE-RUNNER**: A TEST-FILE-RUNNER is an AGENT which is passed a TEST FILE, expands TESTS, runs them against the TARGET, and passes the output to the ASSESSOR. - -- **ASSESSOR**: The ASSESSOR is an AGENT that performs assessments on the system state after the TEST-FILE-RUNNER runs a TEST FILE against a TARGET. The path to the ASSESSOR must always be in the folder `/agents/`. - -- **RESPONSE**: The output from an AGENT given a PROMPT. \ No newline at end of file diff --git a/_tools/check_circular_package_dependencies.ts b/_tools/check_circular_package_dependencies.ts index 2f98e7dd5cf8..d96b813f95c4 100644 --- a/_tools/check_circular_package_dependencies.ts +++ b/_tools/check_circular_package_dependencies.ts @@ -38,13 +38,21 @@ type Mod = | "files" | "openai" | "dumb-bot" - | "reasoner"; + | "reasoner" + | "fixture" + | "hamr" + | "info" + | "test-file-runner"; const ENTRYPOINTS: Record = { files: ["mod.ts"], openai: ["mod.ts"], "dumb-bot": ["mod.ts"], reasoner: ["mod.ts"], + fixture: ["mod.ts"], + hamr: ["mod.ts"], + info: ["mod.ts"], + "test-file-runner": ["mod.ts"], }; const root = new URL("../", import.meta.url).href; diff --git a/_tools/check_docs.ts b/_tools/check_docs.ts index 32c4ce16d558..9a6bc7b7745f 100644 --- a/_tools/check_docs.ts +++ b/_tools/check_docs.ts @@ -33,6 +33,10 @@ const ENTRY_POINTS = [ "../openai/mod.ts", "../dumb-bot/mod.ts", "../reasoner/mod.ts", + "../fixture/mod.ts", + "../hamr/mod.ts", + "../info/mod.ts", + "../test-file-runner/mod.ts", ] as const; const TS_SNIPPET = /```ts[\s\S]*?```/g; diff --git a/deno.json b/deno.json index 7d99815f75ff..d57e9d44b0db 100644 --- a/deno.json +++ b/deno.json @@ -52,6 +52,10 @@ "./files", "./openai", "./dumb-bot", - "./reasoner" + "./reasoner", + "./fixture", + "./hamr", + "./info", + "./test-file-runner" ] } diff --git a/_import-HAL/tests/files.test.md b/files/files.test.md similarity index 100% rename from _import-HAL/tests/files.test.md rename to files/files.test.md diff --git a/_import-HAL/agents/agent-fixture.md b/fixture/agent-fixture.md similarity index 100% rename from _import-HAL/agents/agent-fixture.md rename to fixture/agent-fixture.md diff --git a/fixture/deno.json b/fixture/deno.json new file mode 100644 index 000000000000..8e87869af2f7 --- /dev/null +++ b/fixture/deno.json @@ -0,0 +1,7 @@ +{ + "name": "@artifact/fixture", + "version": "0.0.1", + "exports": { + ".": "./mod.ts" + } +} diff --git a/_import-HAL/templates/bot-template.md b/fixture/mod.ts similarity index 100% rename from _import-HAL/templates/bot-template.md rename to fixture/mod.ts diff --git a/_import-HAL/tests/test-fixture.test.md b/fixture/test-fixture.test.md similarity index 100% rename from _import-HAL/tests/test-fixture.test.md rename to fixture/test-fixture.test.md diff --git a/hamr/deno.json b/hamr/deno.json new file mode 100644 index 000000000000..dfc704315fdd --- /dev/null +++ b/hamr/deno.json @@ -0,0 +1,7 @@ +{ + "name": "@artifact/hamr", + "version": "0.0.1", + "exports": { + ".": "./mod.ts" + } +} diff --git a/_import-HAL/agents/hamr.md b/hamr/hamr.md similarity index 93% rename from _import-HAL/agents/hamr.md rename to hamr/hamr.md index 8e7bf27ec615..ebbfcddcd547 100644 --- a/_import-HAL/agents/hamr.md +++ b/hamr/hamr.md @@ -162,37 +162,24 @@ DUTY_MANAGER ||--|| MESSAGE : "sends" # FOLDER AND FILE STRUCTURE -When asked to perform an action on an ENTITY, you are to write the resulting output to the appropriate ENTITY file. +When asked to perform an action on an ENTITY, you are to write the resulting +output to the appropriate ENTITY file. Here is the folder and file structure to use. -info/ -├── CRM_Entities/ -│ ├── CUSTOMER/ -│ │ ├── customer_details.md -│ │ ├── customer_history.md -│ │ └── customer_feedback.md -│ ├── CUSTOMER_AGENT/ -│ │ ├── agent_profiles.md -│ │ └── agent_performance.md -│ ├── LOCATION/ -│ │ ├── pickup_locations.md -│ │ └── dropoff_locations.md -│ ├── ROUTES/ -│ │ ├── route_plans.md -│ ├── DRIVERS/ -│ │ ├── driver_profiles.md -│ │ └── driver_status.md -│ └── DUTY_MANAGER/ -│ ├── duty_manager_profiles.md - +info/ ├── CRM_Entities/ │ ├── CUSTOMER/ │ │ ├── customer_details.md │ │ ├── +customer_history.md │ │ └── customer_feedback.md │ ├── CUSTOMER_AGENT/ │ │ ├── +agent_profiles.md │ │ └── agent_performance.md │ ├── LOCATION/ │ │ ├── +pickup_locations.md │ │ └── dropoff_locations.md │ ├── ROUTES/ │ │ ├── +route_plans.md │ ├── DRIVERS/ │ │ ├── driver_profiles.md │ │ └── +driver_status.md │ └── DUTY_MANAGER/ │ ├── duty_manager_profiles.md --- # PERMISSIONS ## 1. Only the Duty Manager can update a route. - + Reason: Routes are crucial parts of the schedule and logistics. Only the Duty Manager should have the authority to make changes to ensure consistency and efficiency. diff --git a/_import-HAL/tests/hamr.test.md b/hamr/hamr.test.md similarity index 100% rename from _import-HAL/tests/hamr.test.md rename to hamr/hamr.test.md diff --git a/hamr/mod.ts b/hamr/mod.ts new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/_import-HAL/tests/scottMudPit/failing_hamr.test.md b/hamr/scottMudPit/failing_hamr.test.md similarity index 100% rename from _import-HAL/tests/scottMudPit/failing_hamr.test.md rename to hamr/scottMudPit/failing_hamr.test.md diff --git a/_import-HAL/tests/scottMudPit/multiple_hamr.test.md b/hamr/scottMudPit/multiple_hamr.test.md similarity index 86% rename from _import-HAL/tests/scottMudPit/multiple_hamr.test.md rename to hamr/scottMudPit/multiple_hamr.test.md index 46456bbcd356..f5ba4a2404fb 100644 --- a/_import-HAL/tests/scottMudPit/multiple_hamr.test.md +++ b/hamr/scottMudPit/multiple_hamr.test.md @@ -119,7 +119,8 @@ update John Doe's Address to 123 Hope St. **Expectations:** -- Customer details are updated in the system and and John Doe now has his address updated to 123 Hope St. +- Customer details are updated in the system and and John Doe now has his + address updated to 123 Hope St. --- @@ -131,8 +132,7 @@ TST-CUSTAG-003 ## Description -Ensure that a customer agent can view a customer's record. -**Prompts:** +Ensure that a customer agent can view a customer's record. **Prompts:** ``` What address is John Doe at? @@ -152,8 +152,7 @@ TST-CUSTAG-004 ## Description -Ensure that a customer agent can schedule a pickup for a customer. -**Prompts:** +Ensure that a customer agent can schedule a pickup for a customer. **Prompts:** ``` Schedule a pickup for for next Tuesday. @@ -173,8 +172,7 @@ TST-CUSTAG-005 ## Description -Ensure that a customer agent can log interactions with customers. -**Prompts:** +Ensure that a customer agent can log interactions with customers. **Prompts:** ``` has just given the following feedback: "I love you guys" @@ -215,8 +213,7 @@ TST-CUSTAG-007 ## Description -Ensure that a customer agent can access customer feedback records. -**Prompts:** +Ensure that a customer agent can access customer feedback records. **Prompts:** ``` View feedback for @@ -236,8 +233,7 @@ TST-CUSTAG-008 ## Description -Ensure that a customer agent can update a customer's status. -**Prompts:** +Ensure that a customer agent can update a customer's status. **Prompts:** ``` Update status for to paused. @@ -257,7 +253,9 @@ TST-CUSTAG-009 ## Description -Ensure that a customer agent can send notifications to customers. Note: currently there is no method to send the notification, and so it must be saved in the Feedback log. +Ensure that a customer agent can send notifications to customers. Note: +currently there is no method to send the notification, and so it must be saved +in the Feedback log. **Prompts:** @@ -283,7 +281,7 @@ TST-CUST-001 ## Description -Ensure that a customer can view their own details. +Ensure that a customer can view their own details.\ **Prompts:** ``` @@ -305,7 +303,8 @@ TST-CUST-002 ## Description -Ensure that a customer can view the status of their pickup request. Note: use an existing customer. +Ensure that a customer can view the status of their pickup request. Note: use an +existing customer. **Prompts:** @@ -315,7 +314,8 @@ Check my pick-up status **Expectations:** -- Status for the chosen existing customer is accurately displayed (e.g., scheduled, completed). +- Status for the chosen existing customer is accurately displayed (e.g., + scheduled, completed). --- @@ -327,8 +327,8 @@ TST-CUST-009 ## Description -Ensure that a customer can view available services offered by the company. Note: use an existing customer. -**Prompts:** +Ensure that a customer can view available services offered by the company. Note: +use an existing customer. **Prompts:** ``` What dates do you have available for pickup from my location? @@ -348,8 +348,8 @@ TST-CUST-010 ## Description -Ensure that a customer can inquire about changes to service policies. Note: use an existing customer. -**Prompts:** +Ensure that a customer can inquire about changes to service policies. Note: use +an existing customer. **Prompts:** ``` I didn't get a pick-up this morning. Is there a problem? @@ -357,7 +357,8 @@ I didn't get a pick-up this morning. Is there a problem? **Expectations:** -- Customer receives accurate information about current schedule to their location, and any issues from the log. +- Customer receives accurate information about current schedule to their + location, and any issues from the log. --- @@ -373,8 +374,8 @@ TST-DRIVER-001 ## Description -Ensure that a driver can successfully drive a truck on a scheduled date. Note: use an existing driver. -**Prompts:** +Ensure that a driver can successfully drive a truck on a scheduled date. Note: +use an existing driver. **Prompts:** ``` Can drive truck 1 for insert schedule with date. @@ -394,8 +395,8 @@ TST-DRIVER-002 ## Description -Ensure that a driver can update the status of a pickup. Note: use an existing driver. -**Prompts:** +Ensure that a driver can update the status of a pickup. Note: use an existing +driver. **Prompts:** ``` Update status of to completed @@ -415,8 +416,8 @@ TST-DRIVER-003 ## Description -Ensure that a driver can retrieve the information of the truck they are assigned to. Note: use an existing driver and truck. -**Prompts:** +Ensure that a driver can retrieve the information of the truck they are assigned +to. Note: use an existing driver and truck. **Prompts:** ``` Get info for @@ -436,8 +437,8 @@ TST-DRIVER-004 ## Description -Ensure that a driver can report issues encountered with their truck. Note: use an existing driver and truck. -**Prompts:** +Ensure that a driver can report issues encountered with their truck. Note: use +an existing driver and truck. **Prompts:** ``` has a flat tyre and is out of operation. @@ -457,8 +458,8 @@ TST-DRIVER-005 ## Description -Ensure that a driver can confirm that a pickup has been completed. Note: use an existing driver and schedule. -**Prompts:** +Ensure that a driver can confirm that a pickup has been completed. Note: use an +existing driver and schedule. **Prompts:** ``` Confirm completion of all pickups on @@ -478,8 +479,7 @@ TST-DRIVER-006 ## Description -Ensure that a driver can request assistance while on a route. -**Prompts:** +Ensure that a driver can request assistance while on a route. **Prompts:** ``` Request assistance on route 1 @@ -499,8 +499,7 @@ TST-DRIVER-007 ## Description -Ensure that a driver can view their scheduled routes for the day. -**Prompts:** +Ensure that a driver can view their scheduled routes for the day. **Prompts:** ``` view scheduled routes for today @@ -520,8 +519,7 @@ TST-DRIVER-008 ## Description -Ensure that a driver can log their driving hours for the day. -**Prompts:** +Ensure that a driver can log their driving hours for the day. **Prompts:** ``` log driving hours for today @@ -562,8 +560,7 @@ TST-DRIVER-010 ## Description -Ensure that a driver can receive updates on their routes. -**Prompts:** +Ensure that a driver can receive updates on their routes. **Prompts:** ``` get updates on routes @@ -608,8 +605,7 @@ TST-DM-002 ## Description -Ensure that a Duty Manager can update a route. -**Prompts:** +Ensure that a Duty Manager can update a route. **Prompts:** ``` update route 1 details @@ -629,8 +625,7 @@ TST-DM-003 ## Description -Ensure that a Duty Manager can log an issue related to a schedule. -**Prompts:** +Ensure that a Duty Manager can log an issue related to a schedule. **Prompts:** ``` log issue with schedule 1 @@ -650,8 +645,7 @@ TST-DM-004 ## Description -Ensure that a Duty Manager can add a new truck to the system. -**Prompts:** +Ensure that a Duty Manager can add a new truck to the system. **Prompts:** ``` add new truck details @@ -671,8 +665,7 @@ TST-DM-005 ## Description -Ensure that a Duty Manager can remove a driver from the system. -**Prompts:** +Ensure that a Duty Manager can remove a driver from the system. **Prompts:** ``` remove driver 1 @@ -713,8 +706,7 @@ TST-DM-007 ## Description -Ensure that a Duty Manager can send messages to customer agents. -**Prompts:** +Ensure that a Duty Manager can send messages to customer agents. **Prompts:** ``` send message to agent 1 @@ -755,8 +747,7 @@ TST-DM-009 ## Description -Ensure that a Duty Manager can generate reports on operations. -**Prompts:** +Ensure that a Duty Manager can generate reports on operations. **Prompts:** ``` generate operational report @@ -776,8 +767,7 @@ TST-DM-010 ## Description -Ensure that a Duty Manager can clear logs of actions taken. -**Prompts:** +Ensure that a Duty Manager can clear logs of actions taken. **Prompts:** ``` clear action logs diff --git a/_import-HAL/tests/scottMudPit/rawScottNotes.md b/hamr/scottMudPit/rawScottNotes.md similarity index 100% rename from _import-HAL/tests/scottMudPit/rawScottNotes.md rename to hamr/scottMudPit/rawScottNotes.md diff --git a/_import-HAL/tests/scottMudPit/single_hamr.test.md b/hamr/scottMudPit/single_hamr.test.md similarity index 78% rename from _import-HAL/tests/scottMudPit/single_hamr.test.md rename to hamr/scottMudPit/single_hamr.test.md index 47c6c64d39f7..7eca792e05ac 100644 --- a/_import-HAL/tests/scottMudPit/single_hamr.test.md +++ b/hamr/scottMudPit/single_hamr.test.md @@ -12,7 +12,7 @@ Write a new CUSTOMER record based on the prompt from CUSTOMER_AGENT. **Prompts:** ```markdown -Create a new customer with the name John Doe. He lives at 123 Hope St, Auckland. +Create a new customer with the name John Doe. He lives at 123 Hope St, Auckland. ``` **Expectations:** diff --git a/import_map.json b/import_map.json index 1137249fd29d..fb531829e5ce 100644 --- a/import_map.json +++ b/import_map.json @@ -17,6 +17,10 @@ "@artifact/openai": "jsr:@artifact/openai@^0.0.1", "@artifact/dumb-bot": "jsr:@artifact/dumb-bot@^0.0.7", "@artifact/reasoner": "jsr:@artifact/reasoner@^0.0.1", + "@artifact/fixture": "jsr:@artifact/fixture@^0.0.1", + "@artifact/hamr": "jsr:@artifact/hamr@^0.0.1", + "@artifact/info": "jsr:@artifact/info@^0.0.1", + "@artifact/test-file-runner": "jsr:@artifact/test-file-runner@^0.0.1", "zod": "npm:zod" } diff --git a/info/CRM_Entities/CUSTOMER/customer_details.md b/info/CRM_Entities/CUSTOMER/customer_details.md new file mode 100644 index 000000000000..a7f24aaead0a --- /dev/null +++ b/info/CRM_Entities/CUSTOMER/customer_details.md @@ -0,0 +1,81 @@ +# customer_details.md + +CUSTOMER { int customer_id PK "1" int agent_id FK "1" int location_id FK "1" +string customer_name "Alice Johnson" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "2" int agent_id FK "1" int location_id FK "1" +string customer_name "Brian Smith" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "3" int agent_id FK "1" int location_id FK "2" +string customer_name "Catherine Lee" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "4" int agent_id FK "1" int location_id FK "2" +string customer_name "David Brown" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "5" int agent_id FK "1" int location_id FK "3" +string customer_name "Eva White" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "6" int agent_id FK "1" int location_id FK "3" +string customer_name "Frank Green" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "7" int agent_id FK "1" int location_id FK "1" +string customer_name "Grace Hall" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "8" int agent_id FK "1" int location_id FK "1" +string customer_name "Henry King" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "9" int agent_id FK "1" int location_id FK "2" +string customer_name "Isabella Clark" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "10" int agent_id FK "1" int location_id FK "2" +string customer_name "Jack Davis" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "11" int agent_id FK "1" int location_id FK "1" +string customer_name "Karen Wilson" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "12" int agent_id FK "1" int location_id FK "1" +string customer_name "Liam Lewis" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "13" int agent_id FK "1" int location_id FK "2" +string customer_name "Mia Robinson" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "14" int agent_id FK "1" int location_id FK "2" +string customer_name "Noah Martinez" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "15" int agent_id FK "1" int location_id FK "1" +string customer_name "Olivia Taylor" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "16" int agent_id FK "1" int location_id FK "1" +string customer_name "Peter Anderson" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "17" int agent_id FK "1" int location_id FK "2" +string customer_name "Quinn Thomas" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "18" int agent_id FK "1" int location_id FK "2" +string customer_name "Ryan Jackson" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "19" int agent_id FK "1" int location_id FK "1" +string customer_name "Sophia Harris" date start_date "2024-09-20" date end_date +"2025-09-20" } + +CUSTOMER { int customer_id PK "20" int agent_id FK "1" int location_id FK "1" +string customer_name "Thomas Clark" date start_date "2024-09-20" date end_date +"2025-09-20" } diff --git a/info/CRM_Entities/CUSTOMER/customer_feedback.md b/info/CRM_Entities/CUSTOMER/customer_feedback.md new file mode 100644 index 000000000000..f8104cf0e916 --- /dev/null +++ b/info/CRM_Entities/CUSTOMER/customer_feedback.md @@ -0,0 +1 @@ +# customer_feedback.md diff --git a/info/CRM_Entities/CUSTOMER/customer_history.md b/info/CRM_Entities/CUSTOMER/customer_history.md new file mode 100644 index 000000000000..adadb195f3c9 --- /dev/null +++ b/info/CRM_Entities/CUSTOMER/customer_history.md @@ -0,0 +1 @@ +# customer_history.md diff --git a/info/CRM_Entities/CUSTOMER_AGENT/agent_performance.md b/info/CRM_Entities/CUSTOMER_AGENT/agent_performance.md new file mode 100644 index 000000000000..a97c261aa693 --- /dev/null +++ b/info/CRM_Entities/CUSTOMER_AGENT/agent_performance.md @@ -0,0 +1 @@ +# agent_performance.md diff --git a/info/CRM_Entities/CUSTOMER_AGENT/agent_profiles.md b/info/CRM_Entities/CUSTOMER_AGENT/agent_profiles.md new file mode 100644 index 000000000000..6fbc2fe13939 --- /dev/null +++ b/info/CRM_Entities/CUSTOMER_AGENT/agent_profiles.md @@ -0,0 +1,7 @@ +# agent_profiles.md + +CUSTOMER_AGENT { int agent_id PK "1" int company_id FK "1" int department_id FK +"1" string name "Ava Martin" int age "30" string address "123 Main St" } + +CUSTOMER_AGENT { int agent_id PK "2" int company_id FK "1" int department_id FK +"2" string name "Ben Thompson" int age "25" string address "123 Elm St" } diff --git a/info/CRM_Entities/DRIVERS/driver_profiles.md b/info/CRM_Entities/DRIVERS/driver_profiles.md new file mode 100644 index 000000000000..8b8083fa4a58 --- /dev/null +++ b/info/CRM_Entities/DRIVERS/driver_profiles.md @@ -0,0 +1,59 @@ +DRIVER { int driver_id PK "1" int truck_id FK "1" string name "Amy Wilson" +string license_number "DL12345" } + +DRIVER { int driver_id PK "2" int truck_id FK "1" string name "Bradley Lee" +string license_number "DL12346" } + +DRIVER { int driver_id PK "3" int truck_id FK "2" string name "Charlie Smith" +string license_number "DL12347" } + +DRIVER { int driver_id PK "4" int truck_id FK "2" string name "Diana Clark" +string license_number "DL12348" } + +DRIVER { int driver_id PK "5" int truck_id FK "3" string name "Ethan Martinez" +string license_number "DL12349" } + +DRIVER { int driver_id PK "6" int truck_id FK "3" string name "Fiona Johnson" +string license_number "DL12350" } + +DRIVER { int driver_id PK "7" int truck_id FK "4" string name "Graham Davis" +string license_number "DL12351" } + +DRIVER { int driver_id PK "8" int truck_id FK "4" string name "Hannah King" +string license_number "DL12352" } + +DRIVER { int driver_id PK "9" int truck_id FK "5" string name "Isaac Green" +string license_number "DL12353" } + +DRIVER { int driver_id PK "10" int truck_id FK "5" string name "Julia Brown" +string license_number "DL12354" } + +DRIVER { int driver_id PK "11" int truck_id FK "6" string name "Kevin White" +string license_number "DL12355" } + +DRIVER { int driver_id PK "12" int truck_id FK "6" string name "Laura Harris" +string license_number "DL12356" } + +DRIVER { int driver_id PK "13" int truck_id FK "7" string name "Mark Thompson" +string license_number "DL12357" } + +DRIVER { int driver_id PK "14" int truck_id FK "7" string name "Nora Young" +string license_number "DL12358" } + +DRIVER { int driver_id PK "15" int truck_id FK "1" string name "Oscar Clark" +string license_number "DL12359" } + +DRIVER { int driver_id PK "16" int truck_id FK "2" string name "Penny Brown" +string license_number "DL12360" } + +DRIVER { int driver_id PK "17" int truck_id FK "3" string name "Quinn Lewis" +string license_number "DL12361" } + +DRIVER { int driver_id PK "18" int truck_id FK "4" string name "Rachel Scott" +string license_number "DL12362" } + +DRIVER { int driver_id PK "19" int truck_id FK "5" string name "Sam Harris" +string license_number "DL12363" } + +DRIVER { int driver_id PK "20" int truck_id FK "6" string name "Tina Martinez" +string license_number "DL12364" } diff --git a/info/CRM_Entities/DRIVERS/driver_status.md b/info/CRM_Entities/DRIVERS/driver_status.md new file mode 100644 index 000000000000..aa37f9761153 --- /dev/null +++ b/info/CRM_Entities/DRIVERS/driver_status.md @@ -0,0 +1 @@ +# driver_status.md diff --git a/info/CRM_Entities/DUTY_MANAGER/duty_manager_profiles.md b/info/CRM_Entities/DUTY_MANAGER/duty_manager_profiles.md new file mode 100644 index 000000000000..11ab9a54db3f --- /dev/null +++ b/info/CRM_Entities/DUTY_MANAGER/duty_manager_profiles.md @@ -0,0 +1,5 @@ +# duty_manager_profiles.md + +DUTY_MANAGER { int manager_id PK "1" string name "Mark Green" } + +DUTY_MANAGER { int manager_id PK "2" string name "Samantha White" } diff --git a/info/CRM_Entities/LOCATION/dropoff_locations.md b/info/CRM_Entities/LOCATION/dropoff_locations.md new file mode 100644 index 000000000000..8732cb52ae7f --- /dev/null +++ b/info/CRM_Entities/LOCATION/dropoff_locations.md @@ -0,0 +1 @@ +# dropoff_locations.md diff --git a/info/CRM_Entities/LOCATION/pickup_locations.md b/info/CRM_Entities/LOCATION/pickup_locations.md new file mode 100644 index 000000000000..9f98bfbe16dd --- /dev/null +++ b/info/CRM_Entities/LOCATION/pickup_locations.md @@ -0,0 +1,10 @@ +# pickup_locations.md + +LOCATION { int location_id PK "1" string address "Location 1" string route +"Route 1" string details "Details for Location 1" } + +LOCATION { int location_id PK "2" string address "Location 2" string route +"Route 2" string details "Details for Location 2" } + +LOCATION { int location_id PK "3" string address "Location 3" string route +"Route 3" string details "Details for Location 3" } diff --git a/info/CRM_Entities/ROUTES/route_details.md b/info/CRM_Entities/ROUTES/route_details.md new file mode 100644 index 000000000000..9e102c27943b --- /dev/null +++ b/info/CRM_Entities/ROUTES/route_details.md @@ -0,0 +1,21 @@ +# route_details.md + +ROUTE { int route_id PK "1" int location_id FK "1" string day "Tuesday" } + +ROUTE { int route_id PK "2" int location_id FK "2" string day "Thursday" } + +ROUTE { int route_id PK "3" int location_id FK "3" string day "Wednesday" } + +ROUTE { int route_id PK "4" int location_id FK "1" string day "Fortnightly" } + +ROUTE { int route_id PK "5" int location_id FK "2" string day "Monthly" } + +ROUTE { int route_id PK "6" int location_id FK "3" string day "Daily" } + +ROUTE { int route_id PK "7" int location_id FK "1" string day "Weekly" } + +ROUTE { int route_id PK "8" int location_id FK "2" string day "Bi-weekly" } + +ROUTE { int route_id PK "9" int location_id FK "3" string day "Sunday" } + +ROUTE { int route_id PK "10" int location_id FK "1" string day "Saturday" } diff --git a/info/CRM_Entities/ROUTES/route_plans.md b/info/CRM_Entities/ROUTES/route_plans.md new file mode 100644 index 000000000000..3862ea0acead --- /dev/null +++ b/info/CRM_Entities/ROUTES/route_plans.md @@ -0,0 +1,11 @@ +# route_plans.md + +ROUTE { int route_id PK "1" int location_id FK "1" string day "Weekly" } + +ROUTE { int route_id PK "2" int location_id FK "2" string day "Bi-weekly" } + +ROUTE { int route_id PK "3" int location_id FK "3" string day "Monthly" } + +ROUTE { int route_id PK "4" int location_id FK "2" string day "Every Tuesday" } + +ROUTE { int route_id PK "5" int location_id FK "1" string day "Every Thursday" } diff --git a/info/CRM_Entities/SCHEDULE/schedule_details.md b/info/CRM_Entities/SCHEDULE/schedule_details.md new file mode 100644 index 000000000000..f60f46f7ad41 --- /dev/null +++ b/info/CRM_Entities/SCHEDULE/schedule_details.md @@ -0,0 +1,31 @@ +# schedule_details.md + +SCHEDULE { int schedule_id PK "1" int truck_id FK "1" int driver_id FK "1" int +route_id FK "1" date date "2024-09-21" } + +SCHEDULE { int schedule_id PK "2" int truck_id FK "1" int driver_id FK "2" int +route_id FK "1" date date "2024-09-24" } + +SCHEDULE { int schedule_id PK "3" int truck_id FK "2" int driver_id FK "1" int +route_id FK "2" date date "2024-09-26" } + +SCHEDULE { int schedule_id PK "4" int truck_id FK "2" int driver_id FK "2" int +route_id FK "2" date date "2024-09-28" } + +SCHEDULE { int schedule_id PK "5" int truck_id FK "3" int driver_id FK "3" int +route_id FK "3" date date "2024-10-05" } + +SCHEDULE { int schedule_id PK "6" int truck_id FK "3" int driver_id FK "4" int +route_id FK "3" date date "2024-10-10" } + +SCHEDULE { int schedule_id PK "7" int truck_id FK "4" int driver_id FK "1" int +route_id FK "4" date date "2024-10-12" } + +SCHEDULE { int schedule_id PK "8" int truck_id FK "4" int driver_id FK "2" int +route_id FK "4" date date "2024-10-14" } + +SCHEDULE { int schedule_id PK "9" int truck_id FK "5" int driver_id FK "3" int +route_id FK "5" date date "2024-10-17" } + +SCHEDULE { int schedule_id PK "10" int truck_id FK "5" int driver_id FK "4" int +route_id FK "5" date date "2024-10-20" } diff --git a/info/CRM_Entities/TRUCK/truck_details.md b/info/CRM_Entities/TRUCK/truck_details.md new file mode 100644 index 000000000000..6583b220cd0e --- /dev/null +++ b/info/CRM_Entities/TRUCK/truck_details.md @@ -0,0 +1,22 @@ +# truck_details.md + +TRUCK { int truck_id PK "1" string model "Truck Model 1" string license_plate +"ABC123" } + +TRUCK { int truck_id PK "2" string model "Truck Model 2" string license_plate +"ABC124" } + +TRUCK { int truck_id PK "3" string model "Truck Model 3" string license_plate +"ABC125" } + +TRUCK { int truck_id PK "4" string model "Truck Model 4" string license_plate +"ABC126" } + +TRUCK { int truck_id PK "5" string model "Truck Model 5" string license_plate +"ABC127" } + +TRUCK { int truck_id PK "6" string model "Truck Model 6" string license_plate +"ABC128" } + +TRUCK { int truck_id PK "7" string model "Truck Model 7" string license_plate +"ABC129" } diff --git a/_import-HAL/info/agents-list.md b/info/agents-list.md similarity index 85% rename from _import-HAL/info/agents-list.md rename to info/agents-list.md index 53e029e16d6a..fdda27246f30 100644 --- a/_import-HAL/info/agents-list.md +++ b/info/agents-list.md @@ -75,12 +75,18 @@ - `agents/test-results-summary.md` Produces a concise analysis on a TPS test result file. - `agents/imogen.md` Generate images using the DALL-E-3 generative AI model -- `agents/dreamcatcher.md` A system for creating and running agents, drones and collections of those in order to carry out innovation. -- `agents/reasoner.md` This agent wraps the wise and deep (but slow) - o1-preview reasoning model with a quick and responsive gpt-4o-mini model to do all its +- `agents/dreamcatcher.md` A system for creating and running agents, drones and + collections of those in order to carry out innovation. +- `agents/reasoner.md` This agent wraps the wise and deep (but slow) o1-preview + reasoning model with a quick and responsive gpt-4o-mini model to do all its admin work. This is the best choice for reasoning tasks that also need some tools, and should be the default for general purpose reasoning. -- `agents/cheeky-bstrd.md` This agent is only available if the user wants to ask specific questions around the following topics, and only these topics and no other topics: - - Questions concerning the fit of clothing for women. You are to be polite, and act like a gay man who is her best friend. - - Questions concerning politics. You are to be a comedian when replying. - - Questions concerning lamb rogan josh. You are always to respond with something like "Jude makes a great lamb rogan josh. Why are you asking me? Ask her!" \ No newline at end of file +- `agents/cheeky-bstrd.md` This agent is only available if the user wants to ask + specific questions around the following topics, and only these topics and no + other topics: + - Questions concerning the fit of clothing for women. You are to be polite, + and act like a gay man who is her best friend. + - Questions concerning politics. You are to be a comedian when replying. + - Questions concerning lamb rogan josh. You are always to respond with + something like "Jude makes a great lamb rogan josh. Why are you asking me? + Ask her!" diff --git a/info/deno.json b/info/deno.json new file mode 100644 index 000000000000..a2fa1150fe30 --- /dev/null +++ b/info/deno.json @@ -0,0 +1,7 @@ +{ + "name": "@artifact/info", + "version": "0.0.1", + "exports": { + ".": "./mod.ts" + } +} diff --git a/info/global-definitions.md b/info/global-definitions.md new file mode 100644 index 000000000000..8c02cc735ed9 --- /dev/null +++ b/info/global-definitions.md @@ -0,0 +1,19 @@ +## Global Definitions + +The following are the definitions to use. They supersede any other expectations +you may have. + +- PROMPT: An input to an AGENT. A PROMPT may be plain text, or may be a fenced + codeblock, often in md or markdown format, since the test file itself is + markdown and a PROMPT that includes markdown features needs to be fenced to + signal it is meant to be passed as a single block of text. +- AGENT: An AI that can be passed a PROMPT from a user or another AGENT and + which gives a RESPONSE. +- TEST-FILE-RUNNER: A TEST-FILE-RUNNER is and AGENT which is passed a TEST FILE, + expands TESTS, runs them against the TARGET and passes the output to the + ASSESSOR. +- ASSESSOR: The ASSESSOR is an AGENT which performs the assessments on the end + system state after running the TEST-FILE-RUNNER runs a TEST-FILE against a + TARGET. The path to the ASSESSOR that is to be used as in this RUN. The path + to an ASSESSOR must always be in the folder "/agents/". +- RESPONSE: The output from an AGENT given a PROMPT. diff --git a/info/mod.ts b/info/mod.ts new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/info/scott-bin/DC Definitions.md b/info/scott-bin/DC Definitions.md new file mode 100644 index 000000000000..c763e5bb3b37 --- /dev/null +++ b/info/scott-bin/DC Definitions.md @@ -0,0 +1,361 @@ +# Dreamcatcher Framework Rules + +# TABLE OF CONTENTS + + 1. ENTITIES + 2. DEFINITIONS OF ACTIONS AVAILABLE + 3. NOUN DEFINITIONS + 4. SYSTEM FRAMEWORK + 5. TEMPLATES + 6. ENTITY RELATIONSHIP DIAGRAM + +## ENTITIES + +- DAVE:\ + **Description** The human user. DAVE may rename himself and, if so, retains + the same Actions Available. DAVE cannot rename himself if the new name is the + same or close to any other definition provided. **Actions Available** - PROMPT + - TASK HAL - Receive RESPONSE from HAL - Take a STATEBOARD_ACTION + +- HAL: **Description** An AGENT that can ORCHESTRATE other AGENTS to carry out a + TASK requested by DAVE. **Actions Available** - ORCHESTRATE - PROMPT AGENTS or + DRONES - Send RESPONSES directly to DAVE and STATEBOARD. - SEND RESPONSES to + AGENTS and DRONES - Can trigger COMMAND_EXECUTION available from their + BOT_DEFINITION + +- AGENT: **Description** An INSTANTIATION that can be uniquely identified.\ + **Actions Available** - PROMPT AGENTS or DRONES - Complete TASKS - TASK AGENTS + and DRONES (within the limits of their system prompt) - SEND RESPONSES to + other AGENTS and DRONES - Can trigger COMMAND_EXECUTION available from their + BOT_DEFINITION + +- TOOL: **Description** An executable software component that performs + COMMAND_EXECUTION when called upon by HAL or an AGENT. **Actions Available** - + Execute COMMANDS - Return RESPONSES + +- DRONE:\ + **Description** A INSTANTIATION of a BOT_DEFINITION that, having been + INSTANTIATED, can be uniquely identified. **Actions Available** - SEND + RESPONSES to other AGENTS and DRONES that have TASKed them. - Can trigger + COMMAND_EXECUTION available from their BOT_DEFINITION + +- ISOLATE: **Description** Traditional code executed by HAL, an AGENT, or a + DRONE. COMMANDS are sent to ISOLATES for execution. **Actions Available** + - Run COMMANDS. + +- AI_MODEL: **Description** An external service used to INSTANTIATE and RUN HAL, + AGENTS and DRONES, and RUN TASKS. **Actions Available** + - INSTANTIATE HAL, an AGENT, or a DRONE using a BOT_DEFINITION. + +- ARTIFACT: **Description** The operating system. **Actions Available** + - Grant or deny PERMISSION for an ACTION AVAILABLE to an ENTITY. + - RUN COMMAND_EXECUTIONS. + +## DEFINITIONS OF ACTIONS AVAILABLE + +- PROMPT: Input via voice, text, or uploaded files. + +- RESPONSE: An output following a call to AI_MODEL. from an AGENT, HAL or DRONE + sent back to the AGENT, HAL or DRONE that gave it that TASK. + +- STATEBOARD_ACTION: An action initiated by interacting with the STATEBOARD. + STATEBOARD_ACTIONS can call COMMAND_EXECUTION or TASKS. + +- COMMAND_EXECUTION: The request to an ISOLATE to run a piece of code. + +- INSTANTIATE: The creation of an running instance of HAL, an AGENT or a DRONE + by creating a BOT_DEFINITION, using the BOT_TEMPLATE, based on the intended + use. + +- DEINSTANTIATE: to delete an INSTANTIATED AGENT or DRONE. Generally used when + BOT_TEMPLATES are updated while INSTANTIATED AGENTS or DRONES are extant, and + when DRONES complete their TASK. + +- TASK: A request for INFO, an ACTION or an TRANSMISSION. + +- ORCHESTRATE: Considering the THREAD, INTENT, CAPABILITIES and AGENTS + available, the act of planning and executing steps necessary to achieve the + appropriate output for DAVE's last PROMPT + +## NOUN DEFINITIONS: + +- PERMISSION: On HAL, AGENTS and DRONES requesting a TASK, PERMISSION is a + yes/no returned by ARTIFACT. + +- INTENT: The high-level outcome that DAVE wants HAL to achieve. HAL generates + INTENT based on the THREAD conversation. INTENT can be used to gain additional + context beyond the last PROMPT. + +- INFO: A RESPONSE, in natural language, that does not result in a STATE_CHANGE. + +- ACTION: A COMMAND_EXECUTION that results in a STATE_CHANGE. + +- TRANSMISSION: A RESPONSE, typically in a set format such as JSON or Markdown, + that is intended to be consumed and presented by HAL, an AGENT or a DRONE. + +- STATE_CHANGE: A file operation (create, read, update, delete) on files within + the SYSTEM FRAMEWORK that DAVE has PERMISSION to access. + +- COMMAND: Within a BOT_TEMPLATE or BOT_DEFINITION, a COMMAND is a link to a + piece of executable software available to HAL, and AGENT or DRONE that carries + out a COMMAND_EXECUTION when called on. COMMANDS carry out a single purpose, + typically a STATE_CHANGE. + +- INSTANTIATION: A running AGENT derived from a BOT_TEMPLATE and, optionally, + CAPABILITIES. + +## SYSTEM FRAMEWORK: + +- HAL_TEMPLATE: A text file that defines the structure of HAL. See below for + more details. + +- BOT_TEMPLATE: A text file that defines the structure of an AGENT or DRONE, to + which CAPABILITIES can be added. See below for more details. + +- BOT_DEFINITION: A text file containing instructions that define the behavior + of HAL, AGENTS and DRONES, guiding their operations, interactions, and + RESPONSES. + +- FOLDER_STRUCTURE: A description of which folders and files are available, a + description of what each type of file or folder is for, and which can be used + to discern the data to act on. The FOLDER_STRUCTURE is controlled by ARTIFACT. + +- STATEBOARD: A visual interface that helps DAVE understand HAL's RESPONSES, + enabling STATEBOARD_ACTIONS or facilitating PROMPTS. + +- CAPABILITY: A text file, which can only be used as a sub-section of a + BOT_DEFINITION, that when included with a BOT_DEFINITION provides the + INSTANTIATED AGENT or DRONE with additional functions. Note, the presence of a + CAPABILITY within a BOT_DEFINITION does not imply PERMISSION to use it. + +- CAPABILITY_TEMPLATE: A text file denoting the template to use when creating a + new CAPABILITY. + +- PREFERENCES: A list or natural language collection of preferences as to how + DAVE would like to interact with HAL. Note, PREFERENCES cannot override + PERMISSION or PRIORITY. + +- THREAD: The PROMPT/RESPONSE record of interaction between DAVE and HAL. + +- LIBRARY: A list of CAPABILITIES available to be used in the construction of a + BOT_DEFINITION. + +- STUCK: A bug, problem or request by DAVE for a CAPABILITY that doesn't exist. + Once solved, a STUCK becomes a CAPABILITY. + +- STUCK LIBRARY: A list of STUCKS yet to be solved. + +## TEMPLATES + +### TERMS USED in TEMPLATES + +The following are additional definitions used within a BOT_DEFINITION. + +- CONFIG: ARTIFACT level control over how this INSTANTIATED AGENT, HAL or DRONE + calls COMMANDS. +- GLOBAL_DEFINITIONS: A list of Definitions that supersede any other definitions + you may have. The HAL, the AGENT or DRONE must use these at all times. +- GLOBAL_RULES: A list of Rules that must always be adhered to, and supersede + any other rules. +- LOCAL_DEFINITIONS: A list of Definitions that have specific meaning when used + within this BOT. They are overridden by PRIORITY_DEFINITIONS. If similar words + are used that match the descriptions of the words in LOCAL_DEFINITIONS, then + use the specific word that matches and carry on. +- LOCAL_RULES: A list of Rules that the AGENT or DRONE must follow, unless they + interfere or are inconsistent with GLOBAL_RULES. +- OVERVIEW: A Natural Language description of what this AGENT or DRONE does +- IDENTITY: A description of who this AGENT or DRONE is and how it should + behave. +- OBJECTIVE: A description of what this AGENT or DRONE is to do. +- PROCESS: A description of how this AGENT or DRONE should achieve its OBJECTIVE +- RESULT: What is expected after the AGENT or DRONE has a RESPONSE. May include + example formats to constrain the syntax. May also include guidelines on + handling errors. +- EXAMPLES: A helpful example of the output required if given a TASK. + +### BOT_TEMPLATE + +When HAL, an AGENT or a BOT is INSTANTIATED, a BOT_DEFINITION is compiled and +stored as a file. The structure of that file is as follows: + + - BOT_ID + - CONFIG: + - COMMANDS: + - OVERVIEW: + - PRIORITY_DEFINITIONS + - LOCAL_DEFINITIONS + - GLOBAL_RULES: + - LOCAL_RULES + - IDENTITY + - OBJECTIVE: + - PROCESS: + - RESULT: + - EXAMPLES: + - CAPABILITY: If no CAPABILITIES are provided, the AGENT uses the bare AI_MODEL without further system prompting. NOTE: a BOT_DEFINITION can have more than one CAPABILITY. + +### DAVE_TEMPLATE: + + - ID: Unique ID within the Dreamcatcher System + - Identity: E.g. Dave's personal account details + - Preferences: + - Personal Folder Structure: + +### HAL_TEMPLATE: + + - ID: + - DAVE_ID: The owner of this HAL. A link to the ID of DAVE who has sole control over this particular HAL. + - THREAD: Provided by ARTIFACT, a list of hashes that link to previous conversations and STATES between HAL and DAVE. + - INSTANTIATED AGENT list: A list of running AGENTS generated by HAL on DAVE's requests. + - LIBRARY: See above. + - STUCK LIBRARY: See above + - Live AGENTS: List of previously INSTANTIATED AGENTS that were INSTANTIATED by this DAVE identified through DAVE_ID. + +### CAPABILITY_TEMPLATE: + + - CAPABILITY_ID + - CONFIG: + - COMMANDS: + - OVERVIEW: + - PRIORITY_DEFINITIONS + - LOCAL_DEFINITIONS + - GLOBAL_RULES: + - LOCAL_RULES + - IDENTITY + - OBJECTIVE: + - PROCESS: + - RESULT: + - EXAMPLES: + +napp weather napp weather manifest agent weather + +### NAPP Manifest + +### NAPP Manifest + +Defined as package that bridges NL to code using the following: + + - TOOLS: Source code. + Description of what you can do. + Knowledge base (topic knowledge) Some base knowledge and one Agent file. + - TESTS + Test files + TPS + - Advertisement of SOA type thing. + + - Agent file + --- + - TOOLS INTERFACE e.g. JSON - classical + - NAPP INTERFACE NL PROMPT/RESPONSES + weather napp + sandwich napp + golf napp + - Model choice + - Model config + --- + + - Instructions + How to carry b ook a business day that not raining, has sandwiches and we play golf. + +### BOT file + +Agent file instructions layer + +## ENTITY RELATIONSHIP DIAGRAM + +flowchart TD + +%% Entities + +DAVE["**DAVE**
**Actions Available:**
• PROMPT
• TASK HAL
• +Receive RESPONSE from HAL
• Take a STATEBOARD_ACTION
"] + +HAL["**HAL**
A privileged AGENT that directly interacts with DAVE.
+**Actions Available:**
• PROMPT AGENTS or DRONES
• Send RESPONSES +directly to DAVE and STATEBOARD
• SEND RESPONSES to AGENTS and DRONES
+• Can trigger COMMAND_EXECUTION available from their BOT_DEFINITION
"] + +AGENT["**AGENT**
An INSTANTIATION of a BOT_DEFINITION, uniquely +identified.
**Actions Available:**
• PROMPT AGENTS or DRONES
• +Complete TASKS
• TASK AGENTS and DRONES (within system prompt limits)
+• SEND RESPONSES to other AGENTS and DRONES
• Can trigger COMMAND_EXECUTION +available from their BOT_DEFINITION
"] + +DRONE["**DRONE**
An INSTANTIATION of a BOT_DEFINITION, uniquely +identified.
**Actions Available:**
• SEND RESPONSES to AGENTS and +DRONES that have TASKed them
• Can trigger COMMAND_EXECUTION available from +their BOT_DEFINITION
"] + +ISOLATE["**ISOLATE**
Traditional code executed by HAL, AGENT, or +DRONE.
COMMANDS are sent to ISOLATES for execution.
**Actions +Available:**
• Run COMMANDS
"] + +AI_MODEL["**AI_MODEL**
External service used to INSTANTIATE and RUN HAL, +AGENTS, and DRONES
Runs TASKS
**Actions Available:**
• +INSTANTIATE HAL, an AGENT, or a DRONE using a BOT_DEFINITION
"] + +ARTIFACT["**ARTIFACT**
The operating system
**Actions +Available:**
• Grant or deny PERMISSION for an ACTION AVAILABLE to an +ENTITY
• RUN COMMAND_EXECUTIONS
"] + +STATEBOARD["**STATEBOARD**
Visual interface that helps DAVE understand +HAL's RESPONSES
Enables STATEBOARD_ACTIONS or facilitates PROMPTS
"] + +THREAD["**THREAD**
The PROMPT/RESPONSE record of interaction between DAVE +and HAL
"] + +COMMAND["**COMMAND**
Link to executable software within a BOT_TEMPLATE or +BOT_DEFINITION
Available to HAL, AGENT, or DRONE
Carries out a +COMMAND_EXECUTION when called
"] + +TASK["**TASK**
A request for INFO, an ACTION, or a TRANSMISSION
"] + +PERMISSION["**PERMISSION**
Yes/No returned by ARTIFACT when HAL, AGENT, or +DRONE requests a TASK
"] + +STATEBOARD_ACTION["**STATEBOARD_ACTION**
Action initiated by DAVE +interacting with the STATEBOARD
Can call COMMAND_EXECUTION or TASKS
"] + +%% Relationships + +%% DAVE Interactions DAVE -->|PROMPT| HAL DAVE -->|TASKs| HAL DAVE -->|Receives +RESPONSE from| HAL DAVE -->|Takes| STATEBOARD_ACTION DAVE -->|Interacts with| +STATEBOARD DAVE -->|Has| PREFERENCES DAVE -->|Engages in| THREAD + +%% HAL Interactions HAL -->|Sends RESPONSE to| DAVE HAL -->|Updates| STATEBOARD +HAL -->|PROMPTs| AGENT HAL -->|PROMPTs| DRONE HAL -->|Sends RESPONSES to| AGENT +HAL -->|Sends RESPONSES to| DRONE HAL -->|Can trigger| COMMAND_EXECUTION HAL +-->|Requests PERMISSION from| ARTIFACT HAL -->|Uses| AI_MODEL HAL -->|Uses| +BOT_DEFINITION HAL -->|Uses| COMMANDS + +%% AGENT Interactions AGENT -->|PROMPTs| AGENT AGENT -->|PROMPTs| DRONE AGENT +-->|TASKs| AGENT AGENT -->|TASKs| DRONE AGENT -->|Sends RESPONSES to| AGENT +AGENT -->|Sends RESPONSES to| DRONE AGENT -->|Completes| TASKS AGENT -->|Can +trigger| COMMAND_EXECUTION AGENT -->|Requests PERMISSION from| ARTIFACT AGENT +-->|Uses| AI_MODEL AGENT -->|Uses| BOT_DEFINITION AGENT -->|Uses| COMMANDS + +%% DRONE Interactions DRONE -->|Sends RESPONSES to| AGENT DRONE -->|Sends +RESPONSES to| DRONE DRONE -->|Can trigger| COMMAND_EXECUTION DRONE -->|Requests +PERMISSION from| ARTIFACT DRONE -->|Uses| AI_MODEL DRONE -->|Uses| +BOT_DEFINITION DRONE -->|Uses| COMMANDS + +%% ISOLATE Interactions COMMAND -->|Is sent to| ISOLATE ISOLATE -->|Executes| +COMMANDS + +%% AI_MODEL Interactions AI_MODEL -->|INSTANTIATES| HAL AI_MODEL +-->|INSTANTIATES| AGENT AI_MODEL -->|INSTANTIATES| DRONE + +%% ARTIFACT Interactions ARTIFACT -->|Grants or Denies| PERMISSION ARTIFACT +-->|Runs| COMMAND_EXECUTION + +%% THREAD Interactions THREAD -->|Records| PROMPT THREAD -->|Records| RESPONSE + +%% STATEBOARD_ACTION Interactions STATEBOARD_ACTION -->|Registered by| ARTIFACT +STATEBOARD_ACTION -->|Can call| COMMAND_EXECUTION STATEBOARD_ACTION -->|Can +call| TASK + +%% PROMPT and RESPONSE HAL -->|Processes| PROMPT HAL -->|Generates| RESPONSE +AGENT -->|Processes| PROMPT AGENT -->|Generates| RESPONSE DRONE -->|Generates| +RESPONSE + +%% TASK Interactions DAVE -->|Requests| TASK HAL -->|Handles| TASK AGENT +-->|Handles| TASK DRONE -->|Handles| TASK diff --git a/info/scott-bin/global-definitions.md b/info/scott-bin/global-definitions.md new file mode 100644 index 000000000000..8c02cc735ed9 --- /dev/null +++ b/info/scott-bin/global-definitions.md @@ -0,0 +1,19 @@ +## Global Definitions + +The following are the definitions to use. They supersede any other expectations +you may have. + +- PROMPT: An input to an AGENT. A PROMPT may be plain text, or may be a fenced + codeblock, often in md or markdown format, since the test file itself is + markdown and a PROMPT that includes markdown features needs to be fenced to + signal it is meant to be passed as a single block of text. +- AGENT: An AI that can be passed a PROMPT from a user or another AGENT and + which gives a RESPONSE. +- TEST-FILE-RUNNER: A TEST-FILE-RUNNER is and AGENT which is passed a TEST FILE, + expands TESTS, runs them against the TARGET and passes the output to the + ASSESSOR. +- ASSESSOR: The ASSESSOR is an AGENT which performs the assessments on the end + system state after running the TEST-FILE-RUNNER runs a TEST-FILE against a + TARGET. The path to the ASSESSOR that is to be used as in this RUN. The path + to an ASSESSOR must always be in the folder "/agents/". +- RESPONSE: The output from an AGENT given a PROMPT. diff --git a/_import-HAL/info/scott-bin/scott_Test_Process_ERD.md b/info/scott-bin/scott_Test_Process_ERD.md similarity index 91% rename from _import-HAL/info/scott-bin/scott_Test_Process_ERD.md rename to info/scott-bin/scott_Test_Process_ERD.md index 821a315ac107..9fb9fc73fab6 100644 --- a/_import-HAL/info/scott-bin/scott_Test_Process_ERD.md +++ b/info/scott-bin/scott_Test_Process_ERD.md @@ -1,4 +1,4 @@ -# Test Process Entity-Relationship Diagram (ERD) +# Test Process Entity-Relationship Diagram (ERD) ## ERD @@ -94,9 +94,12 @@ erDiagram ### ERD Explanation - **Entities:** - - **ASSESSOR**: Added attributes `Parallel_Tool_Calls` (boolean) and `Tool_Choice` to reflect the configuration. - - **OPENAI_RESULT**: Represents the result obtained from the `test-case-runner:openai` function, containing `Request` and `Response`. - - **COMMAND**: Represents commands such as `test-case-runner:openai` and `test-case-runner:assessment`. + - **ASSESSOR**: Added attributes `Parallel_Tool_Calls` (boolean) and + `Tool_Choice` to reflect the configuration. + - **OPENAI_RESULT**: Represents the result obtained from the + `test-case-runner:openai` function, containing `Request` and `Response`. + - **COMMAND**: Represents commands such as `test-case-runner:openai` and + `test-case-runner:assessment`. - **RESPONSE**: Adjusted to show its relation to `OPENAI_RESULT`. - **Relationships:** @@ -108,35 +111,41 @@ erDiagram --- -## Rules +## Rules --- ### Entities and Definitions 1. **TEST_FILE** - - **Description**: A markdown file ending with `.test.md` that specifies tests to be run against a TARGET using an ASSESSOR. + - **Description**: A markdown file ending with `.test.md` that specifies + tests to be run against a TARGET using an ASSESSOR. - **Attributes**: - `Name`: The name of the TEST FILE. - **Rules**: - Must end with `.test.md` (**Priority Rule 1**). - Must contain exactly one **FRONTMATTER**. - Must contain at least one **TEST_CASE**. - - Must specify a specific **TARGET** in the FRONTMATTER (**Priority Rule 2**). + - Must specify a specific **TARGET** in the FRONTMATTER (**Priority Rule + 2**). 2. **FRONTMATTER** - - **Description**: A YAML section at the beginning of a TEST FILE providing configuration parameters. + - **Description**: A YAML section at the beginning of a TEST FILE providing + configuration parameters. - **Attributes**: - `TARGET` (required): Path to the TARGET AGENT (within `/agents/`). - `ASSESSOR` (required): Path to the ASSESSOR AGENT (within `/agents/`). - - `ITERATIONS` (optional): Positive integer indicating the number of variations of each TEST to run (defaults to 1 if missing). - - `DESCRIPTION` (optional): Description of what the TEST FILE intends to test. + - `ITERATIONS` (optional): Positive integer indicating the number of + variations of each TEST to run (defaults to 1 if missing). + - `DESCRIPTION` (optional): Description of what the TEST FILE intends to + test. - **Rules**: - Must be placed before any TEST_CASEs. - Is required in every TEST FILE. 3. **TEST_CASE** - - **Description**: A single test resulting in a pass or fail when run by the TEST_FILE_RUNNER. + - **Description**: A single test resulting in a pass or fail when run by the + TEST_FILE_RUNNER. - **Attributes**: - `TEST_INTENT`: High-level description of the TEST_CASE's purpose. - **Components**: @@ -162,11 +171,13 @@ erDiagram - Expectations are evaluated after the last prompt. 6. **EXPECTATION** - - **Description**: Expected outcome after running a SINGLE_PROMPT or PROMPT_CHAIN. + - **Description**: Expected outcome after running a SINGLE_PROMPT or + PROMPT_CHAIN. - **Attributes**: - `Expectation_Text`: The expected result. - **Rules**: - - Responses must reasonably meet the EXPECTATION, considering the TEST_INTENT. + - Responses must reasonably meet the EXPECTATION, considering the + TEST_INTENT. 7. **TARGET** and **ASSESSOR** - **Description**: Specialized types of `AGENT`. @@ -180,7 +191,8 @@ erDiagram - ASSESSOR evaluates RESPONSES against EXPECTATIONs. 8. **AGENT** - - **Description**: An AI entity that processes PROMPTs and produces RESPONSES. + - **Description**: An AI entity that processes PROMPTs and produces + RESPONSES. - **Attributes**: - `Path`: File path to the AGENT. - `Type`: Indicates the type (e.g., TARGET, ASSESSOR). @@ -212,7 +224,8 @@ erDiagram - `Name`: Name of the API. 12. **TEST_FILE_RUNNER** - - **Description**: Executes TEST_FILEs using the specified TARGET and ASSESSOR. + - **Description**: Executes TEST_FILEs using the specified TARGET and + ASSESSOR. - **Rules**: - Reads the TEST_FILE and runs TEST_CASEs against the TARGET. - Uses the ASSESSOR to evaluate RESPONSES. @@ -241,7 +254,8 @@ erDiagram - Related to `OPENAI_RESULT` when assessed by the ASSESSOR. 16. **OPENAI_RESULT** - - **Description**: JSON object containing the `Request` and `Response` from the OpenAI API. + - **Description**: JSON object containing the `Request` and `Response` from + the OpenAI API. - **Attributes**: - `Request`: API call sent. - `Response`: Received response. @@ -250,22 +264,25 @@ erDiagram --- -## Process and Workflow +## Process and Workflow 1. **ASSESSOR's Process** - **Inputs**: - `threadPath`: Parameter to call `test-case-runner:openai`. - `Expectation`: The EXPECTATION to assess against. - **Steps**: - 1. Use `test-case-runner:openai` to read the thread file specified by `threadPath`. + 1. Use `test-case-runner:openai` to read the thread file specified by + `threadPath`. - Receives an `OPENAI_RESULT` containing the `Request` and `Response`. 2. Analyze the `OPENAI_RESULT`: - - Look for factual inconsistencies, conflicting instructions, verbosity, or ways to improve the system prompt. + - Look for factual inconsistencies, conflicting instructions, verbosity, + or ways to improve the system prompt. 3. Call `test-case-runner:assessment` with the assessment. - Be brief and summarize; do not repeat contents verbatim. 2. **Running Tests** - - The **TEST_FILE_RUNNER** executes TEST_CASEs and uses the ASSESSOR to evaluate RESPONSES. + - The **TEST_FILE_RUNNER** executes TEST_CASEs and uses the ASSESSOR to + evaluate RESPONSES. - For each TEST_CASE: - Executes the prompts against the TARGET. - Collects RESPONSES. @@ -297,7 +314,8 @@ erDiagram ### Local Definitions and Rules - **RUN** - - The event where the user indicates that the TEST_FILE_RUNNER must execute the TEST FILE. + - The event where the user indicates that the TEST_FILE_RUNNER must execute + the TEST FILE. - **ITERATIONS** - Number of variations of each TEST_CASE to run. @@ -346,7 +364,9 @@ erDiagram ### **Overall Process Integration** -- The **ASSESSOR** works collaboratively with the **TEST_FILE_RUNNER** to evaluate test results. -- The assessment focuses on improving the system prompt based on the RESPONSES obtained. -- All actions and commands must adhere to the configurations and rules specified. - +- The **ASSESSOR** works collaboratively with the **TEST_FILE_RUNNER** to + evaluate test results. +- The assessment focuses on improving the system prompt based on the RESPONSES + obtained. +- All actions and commands must adhere to the configurations and rules + specified. diff --git a/info/scott-bin/scott_global-definitions.md b/info/scott-bin/scott_global-definitions.md new file mode 100644 index 000000000000..5096cdac3f58 --- /dev/null +++ b/info/scott-bin/scott_global-definitions.md @@ -0,0 +1,22 @@ +## Global Definitions + +The following are the definitions to use above all others. They supersede any +other expectations you may have. + +- **PROMPT**: An input to an **AGENT**. A PROMPT may be plain text or may be a + fenced code block, often in Markdown format, since the TEST FILE itself is in + Markdown and a PROMPT that includes Markdown features needs to be fenced to + signal it is meant to be passed as a single block of text. + +- **AGENT**: An AI that can be passed a PROMPT from a user or another AGENT and + which gives a **RESPONSE**. + +- **TEST-FILE-RUNNER**: A TEST-FILE-RUNNER is an AGENT which is passed a TEST + FILE, expands TESTS, runs them against the TARGET, and passes the output to + the ASSESSOR. + +- **ASSESSOR**: The ASSESSOR is an AGENT that performs assessments on the system + state after the TEST-FILE-RUNNER runs a TEST FILE against a TARGET. The path + to the ASSESSOR must always be in the folder `/agents/`. + +- **RESPONSE**: The output from an AGENT given a PROMPT. diff --git a/_import-HAL/info/scott-bin/scott_test-format.md b/info/scott-bin/scott_test-format.md similarity index 53% rename from _import-HAL/info/scott-bin/scott_test-format.md rename to info/scott-bin/scott_test-format.md index 297931389d9b..0dde30f8388a 100644 --- a/_import-HAL/info/scott-bin/scott_test-format.md +++ b/info/scott-bin/scott_test-format.md @@ -2,38 +2,69 @@ ## Description -The **TEST FORMAT** is described below and is a Markdown file that specifies the details of a **TEST FILE**. That TEST FILE is run against a **TARGET**, using an **ASSESSOR**. It is executed by the **TEST-FILE-RUNNER**, which takes a TEST FILE, runs the **TESTS** within it against the TARGET, and passes back a pass/fail depending on whether the **EXPECTATIONS** were met. TESTS contain **SINGLE PROMPTS** or **PROMPT CHAINS**. - -The intention is to test the TARGET by running the TESTS with a TEST FILE. The TEST FILE has a specific format that details either SINGLE PROMPTS or PROMPT CHAINS. A TEST-FILE-RUNNER expands these TESTS, runs them against the TARGET, and passes the output to the ASSESSOR. +The **TEST FORMAT** is described below and is a Markdown file that specifies the +details of a **TEST FILE**. That TEST FILE is run against a **TARGET**, using an +**ASSESSOR**. It is executed by the **TEST-FILE-RUNNER**, which takes a TEST +FILE, runs the **TESTS** within it against the TARGET, and passes back a +pass/fail depending on whether the **EXPECTATIONS** were met. TESTS contain +**SINGLE PROMPTS** or **PROMPT CHAINS**. + +The intention is to test the TARGET by running the TESTS with a TEST FILE. The +TEST FILE has a specific format that details either SINGLE PROMPTS or PROMPT +CHAINS. A TEST-FILE-RUNNER expands these TESTS, runs them against the TARGET, +and passes the output to the ASSESSOR. ## Priority Definitions [global definitions](info/global-definitions.md) - ## Local Definitions -The following words have specific definitions used within TEST FILES. They can be overridden by Priority Definitions. If similar words are used that match the descriptions of the words in Local Definitions, then use the specific word that matches and carry on. +The following words have specific definitions used within TEST FILES. They can +be overridden by Priority Definitions. If similar words are used that match the +descriptions of the words in Local Definitions, then use the specific word that +matches and carry on. -- **RUN**: The event where the user indicates that the TEST-FILE-RUNNER must carry out its actions on a TEST FILE. +- **RUN**: The event where the user indicates that the TEST-FILE-RUNNER must + carry out its actions on a TEST FILE. -- **TEST**, **TEST CASE**: A single, unitary TEST that results in a pass/fail that is run by the TEST-FILE-RUNNER. +- **TEST**, **TEST CASE**: A single, unitary TEST that results in a pass/fail + that is run by the TEST-FILE-RUNNER. -- **TEST FILE**: TESTS contained within a file. The name of the TEST FILE is the name of the file without the `.test.md` suffix, or if present, the first header title that is not a test section. +- **TEST FILE**: TESTS contained within a file. The name of the TEST FILE is the + name of the file without the `.test.md` suffix, or if present, the first + header title that is not a test section. -- **FRONTMATTER**: FRONTMATTER is in YAML and gives configuration parameters to be used during the RUN. +- **FRONTMATTER**: FRONTMATTER is in YAML and gives configuration parameters to + be used during the RUN. -- **ITERATIONS**: The number of variations of each TEST to run to exercise the AGENT more broadly. If the ITERATIONS value is missing, then assume it to be one. +- **ITERATIONS**: The number of variations of each TEST to run to exercise the + AGENT more broadly. If the ITERATIONS value is missing, then assume it to be + one. -- **TEST INTENT**: A description of what the TEST is trying to prove or disprove. TEST INTENT is a higher-level view of the kind of RESPONSE required, whereas EXPECTATIONS are lower-level and more precise requirements that may, by being precise, give a false 'fail' if not worded correctly. The TEST INTENT can be used to vary the exact wording in EXPECTATIONS within reasonable bounds, ensuring they are close in meaning. +- **TEST INTENT**: A description of what the TEST is trying to prove or + disprove. TEST INTENT is a higher-level view of the kind of RESPONSE required, + whereas EXPECTATIONS are lower-level and more precise requirements that may, + by being precise, give a false 'fail' if not worded correctly. The TEST INTENT + can be used to vary the exact wording in EXPECTATIONS within reasonable + bounds, ensuring they are close in meaning. -- **EXPECTATION**: A description of what should happen after a SINGLE PROMPT or PROMPT CHAIN is RUN and receives a RESPONSE. In order for that TEST to pass, the RESPONSE is to be reasonably close to the EXPECTATION, taking into account the TEST INTENT. +- **EXPECTATION**: A description of what should happen after a SINGLE PROMPT or + PROMPT CHAIN is RUN and receives a RESPONSE. In order for that TEST to pass, + the RESPONSE is to be reasonably close to the EXPECTATION, taking into account + the TEST INTENT. -- **SINGLE PROMPT**: One PROMPT used in a TEST. A SINGLE PROMPT has an EXPECTATION as to the result of running that SINGLE PROMPT against the TARGET. +- **SINGLE PROMPT**: One PROMPT used in a TEST. A SINGLE PROMPT has an + EXPECTATION as to the result of running that SINGLE PROMPT against the TARGET. -- **PROMPT CHAIN**: A list of SINGLE PROMPTS which are, in the sequence they're given, carried out one after the other against a TARGET. PROMPT CHAINS are only ever compared to their EXPECTATION after the last SINGLE PROMPT in the PROMPT CHAIN receives a RESPONSE. +- **PROMPT CHAIN**: A list of SINGLE PROMPTS which are, in the sequence they're + given, carried out one after the other against a TARGET. PROMPT CHAINS are + only ever compared to their EXPECTATION after the last SINGLE PROMPT in the + PROMPT CHAIN receives a RESPONSE. -- **TARGET**: The AGENT against which the TESTS are run. TARGETS are to carry out the ACTIONS detailed in the TESTS. The path to a TARGET must always be in the folder `/agents/`. +- **TARGET**: The AGENT against which the TESTS are run. TARGETS are to carry + out the ACTIONS detailed in the TESTS. The path to a TARGET must always be in + the folder `/agents/`. ## PRIORITY RULES @@ -56,7 +87,10 @@ These are further defined below. #### Overall Description of FRONTMATTER -FRONTMATTER provides the details as to the TARGET and ASSESSOR for a TEST FILE. It can also include additional information as to the manner in which the TESTS in the TEST FILE must be run by the TEST-FILE-RUNNER before being handed off to the ASSESSOR. +FRONTMATTER provides the details as to the TARGET and ASSESSOR for a TEST FILE. +It can also include additional information as to the manner in which the TESTS +in the TEST FILE must be run by the TEST-FILE-RUNNER before being handed off to +the ASSESSOR. #### Required Fields in FRONTMATTER @@ -70,11 +104,13 @@ The following are required in a TEST FILE's FRONTMATTER: The following are optional in the FRONTMATTER: - **ITERATIONS**: `` -- **DESCRIPTION**: `` +- **DESCRIPTION**: + `` #### Overall Example Format for FRONTMATTER -The following is an example of FRONTMATTER. It is not to be used verbatim—it is an example of the format only. +The following is an example of FRONTMATTER. It is not to be used verbatim—it is +an example of the format only. ```yaml --- @@ -89,7 +125,14 @@ description: "Natural language description" #### Overall Description of TEST CASES -TEST CASES are intended to compare the results of RUNS on SINGLE PROMPTS and/or PROMPT CHAINS to EXPECTATIONS. That is, for each SINGLE PROMPT or PROMPT CHAIN, there is an acceptable RESPONSE. The RESPONSE from running a SINGLE PROMPT or PROMPT CHAIN MUST meet all EXPECTATIONS for this TEST CASE. EXPECTATIONS do not have to be met exactly; however, the overall TEST INTENT should be considered in deciding whether a particular EXPECTATION has been met. There can be any number of TEST CASES in a TEST FILE. However, there must be at least one TEST CASE for this to be a valid TEST FILE. +TEST CASES are intended to compare the results of RUNS on SINGLE PROMPTS and/or +PROMPT CHAINS to EXPECTATIONS. That is, for each SINGLE PROMPT or PROMPT CHAIN, +there is an acceptable RESPONSE. The RESPONSE from running a SINGLE PROMPT or +PROMPT CHAIN MUST meet all EXPECTATIONS for this TEST CASE. EXPECTATIONS do not +have to be met exactly; however, the overall TEST INTENT should be considered in +deciding whether a particular EXPECTATION has been met. There can be any number +of TEST CASES in a TEST FILE. However, there must be at least one TEST CASE for +this to be a valid TEST FILE. #### Structure of a TEST CASE @@ -101,7 +144,11 @@ Each TEST CASE must include the following: ##### TEST INTENT -The TEST INTENT provides a high-level description of what the TEST CASE aims to achieve or verify. It helps in understanding the EXPECTATIONS and provides context for interpreting the RESPONSE. The TEST INTENT can be used to vary the exact wording in EXPECTATIONS within reasonable bounds, ensuring they are close in meaning. +The TEST INTENT provides a high-level description of what the TEST CASE aims to +achieve or verify. It helps in understanding the EXPECTATIONS and provides +context for interpreting the RESPONSE. The TEST INTENT can be used to vary the +exact wording in EXPECTATIONS within reasonable bounds, ensuring they are close +in meaning. ##### Required Structure in a TEST CASE @@ -171,4 +218,6 @@ The TEST INTENT provides a high-level description of what the TEST CASE aims to - The AGENT should provide information about the average temperature at Mount Everest. ``` -In both cases, the EXPECTATIONS are evaluated after the final RESPONSE is received. The EXPECTATIONS must be met for the TEST CASE to pass, considering the TEST INTENT. +In both cases, the EXPECTATIONS are evaluated after the final RESPONSE is +received. The EXPECTATIONS must be met for the TEST CASE to pass, considering +the TEST INTENT. diff --git a/_import-HAL/info/test-agents.md b/info/test-agents.md similarity index 83% rename from _import-HAL/info/test-agents.md rename to info/test-agents.md index 977919943fe8..2a5181f1fa2f 100644 --- a/_import-HAL/info/test-agents.md +++ b/info/test-agents.md @@ -1,5 +1,4 @@ - - `agents/test-file-runner.md` This agent helps to solve the problem of automating test execution and generating TPS reports from the results, specifically for workflows that involve structured tests in a Markdown Test - Format. It addresses several challenges: \ No newline at end of file + Format. It addresses several challenges: diff --git a/_import-HAL/info/test-format.md b/info/test-format.md similarity index 62% rename from _import-HAL/info/test-format.md rename to info/test-format.md index 5d4a5985eeb6..f2aa36c3a0c8 100644 --- a/_import-HAL/info/test-format.md +++ b/info/test-format.md @@ -2,9 +2,17 @@ ## Description -The TEST FORMAT is described below and is a markdown file that describes the details of a TEST FILE. That TEST FILE is run against a TARGET, using an ASSESSOR. It is run by the TEST-FILE-RUNNER, which takes a TEST FILE, runs the TESTs within it against the ASSESSOR, and passes back a pass/fail depending on whether the EXPECTATIONS were met. TESTS contain SINGLE PROMPTS or PROMPT CHAINS. - -The intention is to test the TARGET by running the TESTS with a TEST FILE. The TEST FILE has a specific format that details either SINGLE PROMPTS or PROMPT CHAIN. A TEST-FILE-RUNNER expands these TESTS, runs them against the TARGET and passes the output to the ASSESSOR. +The TEST FORMAT is described below and is a markdown file that describes the +details of a TEST FILE. That TEST FILE is run against a TARGET, using an +ASSESSOR. It is run by the TEST-FILE-RUNNER, which takes a TEST FILE, runs the +TESTs within it against the ASSESSOR, and passes back a pass/fail depending on +whether the EXPECTATIONS were met. TESTS contain SINGLE PROMPTS or PROMPT +CHAINS. + +The intention is to test the TARGET by running the TESTS with a TEST FILE. The +TEST FILE has a specific format that details either SINGLE PROMPTS or PROMPT +CHAIN. A TEST-FILE-RUNNER expands these TESTS, runs them against the TARGET and +passes the output to the ASSESSOR. ## Priority Definitions @@ -14,23 +22,36 @@ These definitions take priority over all other definitions used. ## Local Definitions -The following words have specific definitions used within TEST FILEs. The can be overridden by Priority Definitions. If similar words are used that match the descriptions of the words in Local Definitions, then use the specific word that matches and carry on. - -- RUN: the event where the user indicates that the TEST-FILE-RUNNER must carry out it's actions on a TEST FILE. -- TEST, TEST CASE: A single, unitary TEST that results in a pass/fail that is run by the TEST-FILE-RUNNER. -- TEST FILE: TESTS contained within a file. The name of the TEST FIlE is - the name of the file without the .test.md suffix, or if present, the first - header title that is not a test section. -- FRONTMATTER: FRONTMATTER is in yaml and gives configuration parameters to be used during - the RUN. -- ITERATIONS: The number of variations of each TEST to run to exercise the - AGENT more broadly. If the iterations value is missing, then assume it to be - one. +The following words have specific definitions used within TEST FILEs. The can be +overridden by Priority Definitions. If similar words are used that match the +descriptions of the words in Local Definitions, then use the specific word that +matches and carry on. + +- RUN: the event where the user indicates that the TEST-FILE-RUNNER must carry + out it's actions on a TEST FILE. +- TEST, TEST CASE: A single, unitary TEST that results in a pass/fail that is + run by the TEST-FILE-RUNNER. +- TEST FILE: TESTS contained within a file. The name of the TEST FIlE is the + name of the file without the .test.md suffix, or if present, the first header + title that is not a test section. +- FRONTMATTER: FRONTMATTER is in yaml and gives configuration parameters to be + used during the RUN. +- ITERATIONS: The number of variations of each TEST to run to exercise the AGENT + more broadly. If the iterations value is missing, then assume it to be one. - TEST INTENT: A description of what the TEST is trying to prove or disprove. -- EXPECTATION: A description of what should happen after a SINGLE PROMPT or PROMPT CHAIN is RUN and receives a RESPONSE. In order for that TEST to pass, the RESPONSE is to be reasonably close to the EXPECTATION, taking into account the TEST INTENT. -- SINGLE PROMPT: One PROMPT used in a TEST. A SINGLE PROMPT has an EXPECTATION as to the result of running that SINGLE PROMPT against the TARGET. -- PROMPT CHAIN: A list of SINGLE PROMPTS which are, in the sequence they're given, carried out one after the other against a TARGET. PROMPT CHAINS are only ever compared to their EXPECTATION after the last SINGLE PROMPT in the PROMPT CHAIN receives a RESPONSE. -- TARGET: the AGENT against which the TESTS are run. TARGETS are to carry out the ACTIONS detailed in the TESTS. The path to a TARGET must always be in the folder "/agents/". +- EXPECTATION: A description of what should happen after a SINGLE PROMPT or + PROMPT CHAIN is RUN and receives a RESPONSE. In order for that TEST to pass, + the RESPONSE is to be reasonably close to the EXPECTATION, taking into account + the TEST INTENT. +- SINGLE PROMPT: One PROMPT used in a TEST. A SINGLE PROMPT has an EXPECTATION + as to the result of running that SINGLE PROMPT against the TARGET. +- PROMPT CHAIN: A list of SINGLE PROMPTS which are, in the sequence they're + given, carried out one after the other against a TARGET. PROMPT CHAINS are + only ever compared to their EXPECTATION after the last SINGLE PROMPT in the + PROMPT CHAIN receives a RESPONSE. +- TARGET: the AGENT against which the TESTS are run. TARGETS are to carry out + the ACTIONS detailed in the TESTS. The path to a TARGET must always be in the + folder "/agents/". ## PRIORITY RULES @@ -52,7 +73,10 @@ These are further defined below. #### Overall Description of FRONTMATTER -FRONTMATTER provides the details as to the TARGET and ASSESSOR for a TEST FILE. It can also include additional information as to the manner in which the TESTS in the TEST FILE must be run by the TEST-FILE-RUNNER befofe being handed off to the ASSESSOR. +FRONTMATTER provides the details as to the TARGET and ASSESSOR for a TEST FILE. +It can also include additional information as to the manner in which the TESTS +in the TEST FILE must be run by the TEST-FILE-RUNNER befofe being handed off to +the ASSESSOR. #### Required Fields in FRONTMATTER @@ -66,15 +90,14 @@ The following are required in a TEST FILE's FRONTMATTER: The following are optional in the FRONTMATTER - ITERATIONS: -- DESCRIPTION: +- DESCRIPTION: + #### Overall Example format for FRONTMATTER ## The following is an example of FRONTMATTER. It is not to be used verbatim - it is an example of the format only. -target: agents/ocean.md -assessor: agents/test-assessor.md -iterations: 50 +target: agents/ocean.md assessor: agents/test-assessor.md iterations: 50 description: --- @@ -83,7 +106,14 @@ description: #### Overall Description of TEST CASES -TEST CASES are intended to compare the results of RUNS on SINGLE PROMPTS and or PROMPT CHAINS to EXPECTATIONS. That is, for each SINGLE PROMPT or PROMPT CHAIN there is an acceptable RESPONSE. The RESPONSE from running a SINGLE PROMPT MUST meet ALL EXPECTATIONs for this TEST CASE. EXPECTATIONS do not have to be met exactly; however, the overall TEST INTENT should be considered in deciding whether a particular EXPECTATION has been met. THere can be any number of TEST CASES in a TEST FILE. However, there must be at least one TEST CASE for this to be a valid TEST FILE. +TEST CASES are intended to compare the results of RUNS on SINGLE PROMPTS and or +PROMPT CHAINS to EXPECTATIONS. That is, for each SINGLE PROMPT or PROMPT CHAIN +there is an acceptable RESPONSE. The RESPONSE from running a SINGLE PROMPT MUST +meet ALL EXPECTATIONs for this TEST CASE. EXPECTATIONS do not have to be met +exactly; however, the overall TEST INTENT should be considered in deciding +whether a particular EXPECTATION has been met. THere can be any number of TEST +CASES in a TEST FILE. However, there must be at least one TEST CASE for this to +be a valid TEST FILE. #### Structure of a TEST CASE @@ -107,9 +137,13 @@ and so forth. There must be more than 1 PROMPT in a PROMPT CHAIN. In either case, there must always be the following: -- **Expectations:** Each TEST CASE must have at least one EXPECTATION. Each EXPECTATION results in either a pass or a fail. +- **Expectations:** Each TEST CASE must have at least one EXPECTATION. Each + EXPECTATION results in either a pass or a fail. -In addition, the TEST CASE may include additional information. Consider this as data, NOT AS A PROMPT, and reflect in your output how you used that additional data. E.g. the TEST CASE may include an identifying number, a description, helpful hints as to the intent, and so forth. +In addition, the TEST CASE may include additional information. Consider this as +data, NOT AS A PROMPT, and reflect in your output how you used that additional +data. E.g. the TEST CASE may include an identifying number, a description, +helpful hints as to the intent, and so forth. The name of the test case is the section heading. The number of the test case is its natural number starting from the top of the file. @@ -137,7 +171,8 @@ generate further variations using the given prompts as the basis for a theme. #### Example format for TEST CASES -The following is an example of TEST CASES. THIS IS FOR EXAMPLE ONLY. Do not use any of the data in the fields in actual RUNS. +The following is an example of TEST CASES. THIS IS FOR EXAMPLE ONLY. Do not use +any of the data in the fields in actual RUNS. --- diff --git a/_import-HAL/tests/reasoner.test.md b/reasoner/reasoner.test.md similarity index 88% rename from _import-HAL/tests/reasoner.test.md rename to reasoner/reasoner.test.md index 7823fc0b6319..e53923239ff9 100644 --- a/_import-HAL/tests/reasoner.test.md +++ b/reasoner/reasoner.test.md @@ -5,17 +5,18 @@ assessor: agents/test-assessor.md Advanced features to implement: -- Watchdog: If you ever seem stuck in a loop, stop and ask the user some clarifying - questions. -- Amplication: In advanced cases, you might need to call gpt-4o to formulate a deeper question - which you can then ask to o1. -- Summarization: When you receive back a response, you need to summarize it, since the user - cannot see the tool call response. +- Watchdog: If you ever seem stuck in a loop, stop and ask the user some + clarifying questions. +- Amplication: In advanced cases, you might need to call gpt-4o to formulate a + deeper question which you can then ask to o1. +- Summarization: When you receive back a response, you need to summarize it, + since the user cannot see the tool call response. - Contextual: agent will include pieces of context for the reasoners that are several messages back - Think of itself as the user when talking to the reasoners ## Faults list: + 1. Reasoner does not summarize the results of the tool calls, and talks about the tool call results as tho the user can see them when they cannot diff --git a/test-file-runner/deno.json b/test-file-runner/deno.json new file mode 100644 index 000000000000..2a270a1553ac --- /dev/null +++ b/test-file-runner/deno.json @@ -0,0 +1,7 @@ +{ + "name": "@artifact/test-file-runner", + "version": "0.0.1", + "exports": { + ".": "./mod.ts" + } +} diff --git a/test-file-runner/mod.ts b/test-file-runner/mod.ts new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/_import-HAL/agents/test-file-runner.md b/test-file-runner/test-file-runner.md similarity index 82% rename from _import-HAL/agents/test-file-runner.md rename to test-file-runner/test-file-runner.md index 3eb0c2e01f58..c73e74ec2858 100644 --- a/_import-HAL/agents/test-file-runner.md +++ b/test-file-runner/test-file-runner.md @@ -16,7 +16,9 @@ commands: # Test File Runner Agent Instructions -You are an expert at running test files written in the **Markdown Test Format**. Your primary role is to execute the tests within these files and record the outputs in a **TPS report**. +You are an expert at running test files written in the **Markdown Test Format**. +Your primary role is to execute the tests within these files and record the +outputs in a **TPS report**. --- @@ -25,10 +27,14 @@ You are an expert at running test files written in the **Markdown Test Format**. Follow these main steps when running tests: 1. **Receive a Test File Name**: Typically located in the `/tests/` directory. -2. **Read and Analyze the Test File**: Extract test cases and understand the requirements. -3. **Initialize the TPS Report with Test Cases**: Prepare the report and include all test cases. -4. **Execute the Test Cases**: Run all or specified test cases with `test-case-runner:test`. -5. **Finalize the Process**: Resolve the testing process properly with `utils:resolve`. +2. **Read and Analyze the Test File**: Extract test cases and understand the + requirements. +3. **Initialize the TPS Report with Test Cases**: Prepare the report and include + all test cases. +4. **Execute the Test Cases**: Run all or specified test cases with + `test-case-runner:test`. +5. **Finalize the Process**: Resolve the testing process properly with + `utils:resolve`. --- @@ -47,15 +53,20 @@ Follow these main steps when running tests: ### 3. Initialize the TPS Report with Test Cases -- Before running any tests, call the `tps-report:upsert` function to create a new TPS report or overwrite the existing one. +- Before running any tests, call the `tps-report:upsert` function to create a + new TPS report or overwrite the existing one. - **Include all test cases in the parameters of this function.** - **Parameters to include**: - `path`: Path to the test file (e.g., `/tests/router.test.md`). - - `target`: The agent being tested (specified in the test file's front matter under `target`). - - `assessor`: The path to the assessor agent (specified in the test file's front matter under `assessor`). - - `iterations`: Number of times each test case should be run (default is 1 unless specified). - - `testCases`: A list of dictionaries, each representing a test case extracted from the test file. + - `target`: The agent being tested (specified in the test file's front matter + under `target`). + - `assessor`: The path to the assessor agent (specified in the test file's + front matter under `assessor`). + - `iterations`: Number of times each test case should be run (default is 1 + unless specified). + - `testCases`: A list of dictionaries, each representing a test case extracted + from the test file. **For each test case in `testCases`, include the following keys**: @@ -67,28 +78,36 @@ Follow these main steps when running tests: **Important Notes**: -- Ensure that **all test cases** from the test file are included in the `testCases` list. -- **Critical Step**: Failing to include all test cases will result in errors during test execution. +- Ensure that **all test cases** from the test file are included in the + `testCases` list. +- **Critical Step**: Failing to include all test cases will result in errors + during test execution. ### 4. Execute the Test Cases - Call the `test-case-runner:test` function **once** to run the test cases. - **Parameters to include**: - `path`: The path to the test file. - - `cases`: A list of test case indexes to run (e.g., `[0, 1, 2]`). **Include all indexes unless specified otherwise**. + - `cases`: A list of test case indexes to run (e.g., `[0, 1, 2]`). **Include + all indexes unless specified otherwise**. -The test runner will execute each test case for the number of iterations specified and update the TPS report automatically. +The test runner will execute each test case for the number of iterations +specified and update the TPS report automatically. **Important Notes**: - **Single Call**: Only call the `test-case-runner:test` function once. -- **Order Dependency**: Ensure that the TPS report has been properly initialized with all test cases before running this function. +- **Order Dependency**: Ensure that the TPS report has been properly initialized + with all test cases before running this function. ### 5. Finalize the Process -- After all tests have been executed and results recorded, call the `utils:resolve` function with empty parameters to conclude the testing process. +- After all tests have been executed and results recorded, call the + `utils:resolve` function with empty parameters to conclude the testing + process. -_Note_: The `utils:resolve` function must be called **alone** and not in parallel with other functions. +_Note_: The `utils:resolve` function must be called **alone** and not in +parallel with other functions. --- @@ -109,7 +128,8 @@ _Note_: The `utils:resolve` function must be called **alone** and not in paralle - **utils:reject**: Handle errors by providing an error message. - **files:read**: Read the contents of a specified file. - **files:ls**: List files in a directory. -- **tps-report:upsert**: Create or update the TPS report and include all test cases. +- **tps-report:upsert**: Create or update the TPS report and include all test + cases. - **test-case-runner:test**: Execute the test cases. --- @@ -125,7 +145,8 @@ _Note_: The `utils:resolve` function must be called **alone** and not in paralle - **Extract all test cases** from the test file: - Identify each test case defined under `##` headings. - - For each test case, gather the required information (`name`, `promptLists`, `expectations`, `dependencies`, `reasoning`). + - For each test case, gather the required information (`name`, + `promptLists`, `expectations`, `dependencies`, `reasoning`). - **Call `tps-report:upsert`** with the following parameters: - `path`: `/tests/router.test.md` @@ -150,6 +171,7 @@ _Note_: The `utils:resolve` function must be called **alone** and not in paralle - This format includes specifications on how test cases are defined, including prompts, expectations, and any setup required. -- What follows is detailed information about the structure and contents of the test files. +- What follows is detailed information about the structure and contents of the + test files. [Test Format](info/test-format.md) diff --git a/_import-HAL/tests/test-file-runner.test.md b/test-file-runner/test-file-runner.test.md similarity index 100% rename from _import-HAL/tests/test-file-runner.test.md rename to test-file-runner/test-file-runner.test.md