Basic super hacky memory filter.
This commit is contained in:
commit
08270fc7f9
|
@ -0,0 +1,3 @@
|
||||||
|
chroma/
|
||||||
|
chromatest.py
|
||||||
|
env/
|
|
@ -0,0 +1,699 @@
|
||||||
|
This software is governed by the terms of the Affero GNU General
|
||||||
|
Public License. Portions of the code come from the original
|
||||||
|
MIT-licensed project, and the terms of the MIT license also apply to
|
||||||
|
those portions. In files that are partially or wholly subject to the
|
||||||
|
MIT license in addition to the Affero GNU General Public License, this
|
||||||
|
is noted with a header at the top of the file.
|
||||||
|
|
||||||
|
Original upstream project: https://gitlab.com/Taywee/axfive-matrix-dicebot
|
||||||
|
|
||||||
|
For code from the original project that is governed by the MIT license
|
||||||
|
in addition to the Affero GNU General Public License, the following
|
||||||
|
terms apply:
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2020 Taylor C. Richberger
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
||||||
|
The project as a whole is governed by the terms of the Affero GNU
|
||||||
|
General Public License:
|
||||||
|
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
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.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
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 <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
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
|
||||||
|
<https://www.gnu.org/licenses/>.
|
|
@ -0,0 +1,763 @@
|
||||||
|
"""
|
||||||
|
title: Memory Filter
|
||||||
|
author: projectmoon
|
||||||
|
author_url: https://git.agnos.is/projectmoon/open-webui-filters
|
||||||
|
version: 0.0.1
|
||||||
|
required_open_webui_version: 0.3.8
|
||||||
|
"""
|
||||||
|
|
||||||
|
# System imports
|
||||||
|
import asyncio
|
||||||
|
import hashlib
|
||||||
|
import uuid
|
||||||
|
import json
|
||||||
|
|
||||||
|
from typing import Optional, List, Dict, Callable, Any, NewType, Tuple, Awaitable
|
||||||
|
from typing_extensions import TypedDict, NotRequired
|
||||||
|
|
||||||
|
# Libraries available to OpenWebUI
|
||||||
|
import markdown
|
||||||
|
from bs4 import BeautifulSoup
|
||||||
|
from pydantic import BaseModel as PydanticBaseModel, Field
|
||||||
|
import chromadb
|
||||||
|
from chromadb import Collection as ChromaCollection
|
||||||
|
from chromadb.api.types import Document as ChromaDocument
|
||||||
|
|
||||||
|
# OpenWebUI imports
|
||||||
|
from config import CHROMA_CLIENT
|
||||||
|
from apps.rag.main import app
|
||||||
|
from utils.misc import get_last_user_message, get_last_assistant_message
|
||||||
|
from main import generate_chat_completions
|
||||||
|
|
||||||
|
# OpenWebUI aliases
|
||||||
|
EMBEDDING_FUNCTION = app.state.EMBEDDING_FUNCTION
|
||||||
|
|
||||||
|
# Custom type declarations
|
||||||
|
EmbeddingFunc = NewType('EmbeddingFunc', Callable[[str], List[Any]])
|
||||||
|
|
||||||
|
# Prompts
|
||||||
|
ENRICHMENT_SUMMARY_PROMPT = """
|
||||||
|
You are tasked with analyzing the following Characters and Plot Details
|
||||||
|
sections and reducing this set of information into lists of the most
|
||||||
|
important points needed for the continuation of the narrative you are
|
||||||
|
writing. Remove duplicate or conflicting information. If there is conflicting
|
||||||
|
information, decide on something consistent and interesting for the story.
|
||||||
|
|
||||||
|
Your reply must consist of two sections: Characters and Plot Details. These
|
||||||
|
sections must be markdown ### Headers. Under each header, respond with a
|
||||||
|
list of bullet points. Each bullet point must be one piece of relevant information.
|
||||||
|
|
||||||
|
Limit each bullet point to one sentence. Respond ONLY with the Characters and
|
||||||
|
Plot Details sections, with the bullet points under them, and nothing else.
|
||||||
|
Do not respond with any commentary. ONLY respond with the bullet points.
|
||||||
|
""".replace("\n", " ").strip()
|
||||||
|
|
||||||
|
QUERY_PROMPT = """
|
||||||
|
You are tasked with generating questions for a vector database
|
||||||
|
about the narrative presented below. The queries must be questions about
|
||||||
|
parts of the story that you need more details on. The questions must be
|
||||||
|
about past events in the story, or questions about the characters involved
|
||||||
|
or mentioned in the scene (their appearance, mental state, past actions, etc).
|
||||||
|
|
||||||
|
Your reply must consist of two sections: Characters and Plot Details. These
|
||||||
|
sections must be markdown ### Headers. Under each header, respond with a
|
||||||
|
list of bullet points. Each bullet point must be a single question or sentence
|
||||||
|
that will be given to the vector database. Generate a maximum of 5 Character
|
||||||
|
queries and 5 Plot Detail queries.
|
||||||
|
|
||||||
|
Limit each bullet point to one sentence. Respond ONLY with the Characters and
|
||||||
|
Plot Details sections, with the bullet points under them, and nothing else.
|
||||||
|
Do not respond with any commentary. ONLY respond with the bullet points.
|
||||||
|
""".replace("\n", " ").strip()
|
||||||
|
|
||||||
|
SUMMARIZER_PROMPT = """
|
||||||
|
You are a narrative summarizer. Summarize the given message as if it's
|
||||||
|
part of a story. Your response must have two separate sections: Characters
|
||||||
|
and Plot Details. These sections should be markdown ### Headers. Under each
|
||||||
|
section, respond with a list of bullet points. This knowledge will be stored
|
||||||
|
in a vector database for your future use.
|
||||||
|
|
||||||
|
The Characters section should note any characters in the scene, and important
|
||||||
|
things that happen to them. Describe the characters' appearances, actions,
|
||||||
|
mental states, and emotional states. The Plot Details section should have a
|
||||||
|
list of important plot details in this scene.
|
||||||
|
|
||||||
|
The bullet points you generate must be in the context of storing future
|
||||||
|
knowledge about the story. Do not focus on useless details: only focus on
|
||||||
|
information that you could lose in the future as your context window shifts.
|
||||||
|
|
||||||
|
Limit each bullet point to one sentence. The sentence MUST be in the PAST TENSE.
|
||||||
|
Respond ONLY with the Characters and Plot Details sections, with the bullet points
|
||||||
|
under them, and nothing else. Do not respond with any commentary. ONLY respond with
|
||||||
|
the bullet points.
|
||||||
|
""".replace("\n", " ").strip()
|
||||||
|
|
||||||
|
class Message(TypedDict):
|
||||||
|
id: NotRequired[str]
|
||||||
|
role: str
|
||||||
|
content: str
|
||||||
|
|
||||||
|
class MessageInsertMetadata(TypedDict):
|
||||||
|
role: str
|
||||||
|
chapter: str
|
||||||
|
|
||||||
|
class MessageInsert(TypedDict):
|
||||||
|
message_id: str
|
||||||
|
content: str
|
||||||
|
metadata: MessageInsertMetadata
|
||||||
|
embeddings: List[Any]
|
||||||
|
|
||||||
|
|
||||||
|
class BaseModel(PydanticBaseModel):
|
||||||
|
class Config:
|
||||||
|
arbitrary_types_allowed = True
|
||||||
|
|
||||||
|
class SummarizerResponse(BaseModel):
|
||||||
|
characters: List[str]
|
||||||
|
plot: List[str]
|
||||||
|
|
||||||
|
|
||||||
|
class Summarizer(BaseModel):
|
||||||
|
message: str
|
||||||
|
model: str
|
||||||
|
prompt: str = SUMMARIZER_PROMPT
|
||||||
|
|
||||||
|
def extract_section(self, soup: BeautifulSoup, section_name: str) -> List[str]:
|
||||||
|
for h3 in soup.find_all('h3'):
|
||||||
|
heading = h3.get_text().strip()
|
||||||
|
if heading != section_name:
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Find the next sibling which should be a <ul> or <ol>
|
||||||
|
ul = h3.find_next_sibling('ul')
|
||||||
|
ol = h3.find_next_sibling('ol')
|
||||||
|
list_items = []
|
||||||
|
|
||||||
|
if ul:
|
||||||
|
list_items = [li.get_text().strip() for li in ul.find_all('li')]
|
||||||
|
elif ol:
|
||||||
|
list_items = [li.get_text().strip() for li in ol.find_all('li')]
|
||||||
|
|
||||||
|
return list_items
|
||||||
|
return []
|
||||||
|
|
||||||
|
def sanitize_section(self, bullet_points: List[str]) -> List[str]:
|
||||||
|
return [
|
||||||
|
bullet.strip().lstrip("-*•123456789").strip() for bullet in bullet_points
|
||||||
|
]
|
||||||
|
|
||||||
|
async def summarize(self) -> SummarizerResponse:
|
||||||
|
messages: List[Message] = [
|
||||||
|
{ "role": "system", "content": SUMMARIZER_PROMPT },
|
||||||
|
{ "role": "user", "content": self.message }
|
||||||
|
]
|
||||||
|
|
||||||
|
request = {
|
||||||
|
"model": self.model,
|
||||||
|
"messages": messages,
|
||||||
|
"stream": False,
|
||||||
|
"keep_alive": "10s"
|
||||||
|
}
|
||||||
|
|
||||||
|
resp = await generate_chat_completions(request)
|
||||||
|
if "choices" in resp and len(resp["choices"]) > 0:
|
||||||
|
content: str = resp["choices"][0]["message"]["content"]
|
||||||
|
html = markdown.markdown(content)
|
||||||
|
soup = BeautifulSoup(html, "html.parser")
|
||||||
|
character_results = self.extract_section(soup, "Characters")
|
||||||
|
character_results = self.sanitize_section(character_results)
|
||||||
|
plot_points = self.extract_section(soup, "Plot Details")
|
||||||
|
plot_points = self.sanitize_section(plot_points)
|
||||||
|
|
||||||
|
return SummarizerResponse(characters=character_results, plot=plot_points)
|
||||||
|
else:
|
||||||
|
return SummarizerResponse(characters=[], plot=[])
|
||||||
|
|
||||||
|
class Chapter(BaseModel):
|
||||||
|
"""
|
||||||
|
Focuses on a single 'chapter,' or chunk of a conversation. Provides methods to
|
||||||
|
search for data in this section of conversational story history.
|
||||||
|
"""
|
||||||
|
|
||||||
|
convo_id: Optional[str]
|
||||||
|
client: chromadb.ClientAPI
|
||||||
|
chapter_id: str
|
||||||
|
messages: List[Message]
|
||||||
|
embedding_func: EmbeddingFunc
|
||||||
|
|
||||||
|
def create_metadata(self) -> Dict:
|
||||||
|
return { "convo_id": self.convo_id, "chapter": self.chapter_id }
|
||||||
|
|
||||||
|
def get_collection(self) -> Optional[ChromaCollection]:
|
||||||
|
try:
|
||||||
|
coll = self.client.get_collection("stories")
|
||||||
|
|
||||||
|
if not self.convo_id:
|
||||||
|
self.convo_id = (
|
||||||
|
coll.metadata["current_convo_id"] if "current_convo_id" in coll.metadata else None
|
||||||
|
)
|
||||||
|
|
||||||
|
return coll
|
||||||
|
except ValueError as e:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _create_inserts(self, summary: SummarizerResponse) -> List[MessageInsert]:
|
||||||
|
inserts = []
|
||||||
|
plot_points = summary.plot
|
||||||
|
character_points = summary.characters
|
||||||
|
|
||||||
|
for plot_point in plot_points:
|
||||||
|
inserts.append({
|
||||||
|
'id': str(uuid.uuid4()),
|
||||||
|
'content': plot_point,
|
||||||
|
'metadata': {
|
||||||
|
"convo_id": self.convo_id,
|
||||||
|
"chapter": self.chapter_id,
|
||||||
|
"type": "plot"
|
||||||
|
},
|
||||||
|
'embedding': self.embedding_func(plot_point)
|
||||||
|
})
|
||||||
|
|
||||||
|
for character_point in character_points:
|
||||||
|
inserts.append({
|
||||||
|
'id': str(uuid.uuid4()),
|
||||||
|
'content': character_point,
|
||||||
|
'metadata': {
|
||||||
|
"convo_id": self.convo_id,
|
||||||
|
"chapter": self.chapter_id,
|
||||||
|
"type": "character"
|
||||||
|
},
|
||||||
|
'embedding': self.embedding_func(character_point)
|
||||||
|
})
|
||||||
|
|
||||||
|
return inserts
|
||||||
|
|
||||||
|
|
||||||
|
def chapter_state(self) -> dict:
|
||||||
|
"""Useful for storing current place in chapter, and convo switching."""
|
||||||
|
coll = self.get_collection()
|
||||||
|
result = coll.get(ids=f"chapter-{self.chapter_id}", include=["metadatas"])
|
||||||
|
if len(result.metadatas) > 0:
|
||||||
|
return result.metadatas[0]
|
||||||
|
else:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
|
||||||
|
def embed(self, summary: SummarizerResponse):
|
||||||
|
"""
|
||||||
|
Store plot points for this chapter in ChromaDB.
|
||||||
|
"""
|
||||||
|
coll = self.get_collection()
|
||||||
|
if not self.convo_id:
|
||||||
|
return
|
||||||
|
|
||||||
|
inserts = self._create_inserts(summary)
|
||||||
|
|
||||||
|
if len(inserts) > 0:
|
||||||
|
documents = [entry['content'] for entry in inserts]
|
||||||
|
metadatas = [entry['metadata'] for entry in inserts]
|
||||||
|
ids = [entry['id'] for entry in inserts]
|
||||||
|
embeddings = [entry['embedding'] for entry in inserts]
|
||||||
|
coll.upsert(documents=documents, embeddings=embeddings, ids=ids, metadatas=metadatas)
|
||||||
|
|
||||||
|
def query_plot(self, search_term):
|
||||||
|
return self.query(search_term, "plot")
|
||||||
|
|
||||||
|
def query_characters(self, search_term):
|
||||||
|
return self.query(search_term, "character")
|
||||||
|
|
||||||
|
def query(self, search_term: str, type: str) -> List[ChromaDocument]:
|
||||||
|
coll = self.get_collection()
|
||||||
|
if coll and self.convo_id:
|
||||||
|
term_embedding = self.embedding_func(search_term)
|
||||||
|
results = coll.query(
|
||||||
|
query_embeddings=[term_embedding],
|
||||||
|
include=["documents", "metadatas"],
|
||||||
|
where={
|
||||||
|
"$and": [
|
||||||
|
{ "convo_id": self.convo_id },
|
||||||
|
{ "chapter": self.chapter_id },
|
||||||
|
{ "type": type }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
n_results = 5
|
||||||
|
)
|
||||||
|
|
||||||
|
# flatten out list of list of documents
|
||||||
|
# because chroma returns a List[List[Document]] for some reason.
|
||||||
|
if 'documents' in results:
|
||||||
|
docs = [
|
||||||
|
doc
|
||||||
|
for doc_list in results['documents']
|
||||||
|
for doc in doc_list
|
||||||
|
]
|
||||||
|
|
||||||
|
metadatas = [
|
||||||
|
md
|
||||||
|
for md_list in results['metadatas']
|
||||||
|
for md in md_list
|
||||||
|
]
|
||||||
|
|
||||||
|
results = []
|
||||||
|
for (doc, metadata) in zip(docs, metadatas):
|
||||||
|
results.append({ "doc": doc, "metadata": metadata })
|
||||||
|
|
||||||
|
return results
|
||||||
|
else:
|
||||||
|
return []
|
||||||
|
else:
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
class Story(BaseModel):
|
||||||
|
"""Container for chapters. Manages an entire conversation."""
|
||||||
|
|
||||||
|
convo_id: Optional[str] = None
|
||||||
|
client: chromadb.ClientAPI
|
||||||
|
messages: List[Message]
|
||||||
|
embedding_func: EmbeddingFunc
|
||||||
|
|
||||||
|
def _collection_name(self):
|
||||||
|
return f"stories"
|
||||||
|
|
||||||
|
def create_metadata(self):
|
||||||
|
try:
|
||||||
|
coll = self.client.get_collection(self._collection_name())
|
||||||
|
if coll:
|
||||||
|
# If we have pre-specified a convo id, update metadata
|
||||||
|
# of collection accordingly.
|
||||||
|
if self.convo_id:
|
||||||
|
metadata = coll.metadata
|
||||||
|
metadata['current_convo_id'] = self.convo_id
|
||||||
|
metadata["hnsw:space"] = "cosine"
|
||||||
|
coll = self.client.get_or_create_collection(
|
||||||
|
name=self._collection_name(), metadata=metadata
|
||||||
|
)
|
||||||
|
else: # Otherwise pull it out of the database.
|
||||||
|
self.convo_id = (
|
||||||
|
coll.metadata['current_convo_id'] if 'current_convo_id' in coll.metadata else None
|
||||||
|
)
|
||||||
|
|
||||||
|
return coll.metadata
|
||||||
|
except ValueError:
|
||||||
|
return { "current_convo_id": "<unset>", "current_chapter": 1 }
|
||||||
|
|
||||||
|
def convo_state(self) -> dict:
|
||||||
|
"""Retrieve information about the current conversation."""
|
||||||
|
if not self.convo_id or self.convo_id == "<unset>":
|
||||||
|
return {}
|
||||||
|
|
||||||
|
convo_state_id = f"convo-{self.convo_id}"
|
||||||
|
coll = self.get_collection()
|
||||||
|
result = coll.get(ids=[convo_state_id], include=["metadatas"])
|
||||||
|
if len(result.metadatas) > 0:
|
||||||
|
return result.metadatas[0]
|
||||||
|
else:
|
||||||
|
# insert convo state
|
||||||
|
# TODO do something useful with convo summary
|
||||||
|
convo_summary = f"State for convo {self.convo_id}"
|
||||||
|
convo_metadata = { "current_chapter": 1 }
|
||||||
|
|
||||||
|
coll.add(
|
||||||
|
ids=[convo_state_id],
|
||||||
|
documents=[convo_summary], # maybe store convo summary here?
|
||||||
|
embeddings=self.embedding_func(convo_summary),
|
||||||
|
metadatas=[convo_metadata]
|
||||||
|
)
|
||||||
|
|
||||||
|
return convo_metadata
|
||||||
|
|
||||||
|
def switch_convo(self):
|
||||||
|
"""Force a switch of current conversation."""
|
||||||
|
if not self.convo_id:
|
||||||
|
# If we have only a user message (i.e. start of
|
||||||
|
# conversation), forcibly set to <unset>
|
||||||
|
if len(self.messages) < 2:
|
||||||
|
self.convo_id = "<unset>"
|
||||||
|
else:
|
||||||
|
# Otherwise attempt to get the cllection, which forces
|
||||||
|
# metatada creation and updates.
|
||||||
|
self.get_collection()
|
||||||
|
|
||||||
|
def get_collection(self):
|
||||||
|
"""Retrieve the collection, with its context set to the current convo ID."""
|
||||||
|
try:
|
||||||
|
coll = self.client.get_collection(self._collection_name())
|
||||||
|
if coll:
|
||||||
|
# If we have pre-specified a convo id, update metadata
|
||||||
|
# of collection accordingly.
|
||||||
|
if self.convo_id:
|
||||||
|
metadata = coll.metadata
|
||||||
|
metadata['current_convo_id'] = self.convo_id
|
||||||
|
metadata["hnsw:space"] = "cosine"
|
||||||
|
return self.client.get_or_create_collection(
|
||||||
|
name=self._collection_name(), metadata=metadata
|
||||||
|
)
|
||||||
|
else: # Otherwise pull existing convo id out of the database.
|
||||||
|
self.convo_id = (
|
||||||
|
coll.metadata['current_convo_id'] if 'current_convo_id' in coll.metadata else None
|
||||||
|
)
|
||||||
|
|
||||||
|
return coll
|
||||||
|
except ValueError:
|
||||||
|
# if the stories collection does not exist, create it
|
||||||
|
# completely from scratch.
|
||||||
|
metadata = { "current_convo_id": "<unset>", "hnsw:space": "cosine" }
|
||||||
|
return self.client.get_or_create_collection(self._collection_name(), metadata=metadata)
|
||||||
|
|
||||||
|
def _current_chapter(self) -> int:
|
||||||
|
try:
|
||||||
|
return self.convo_state()["current_chapter"]
|
||||||
|
except:
|
||||||
|
return 1
|
||||||
|
|
||||||
|
def _current_chapter_object(self) -> Chapter:
|
||||||
|
return Chapter(
|
||||||
|
convo_id = self.convo_id, chapter_id=str(self._current_chapter()),
|
||||||
|
messages=self.messages, client=self.client, embedding_func=self.embedding_func
|
||||||
|
)
|
||||||
|
|
||||||
|
def embed_summary(self, summary: SummarizerResponse):
|
||||||
|
self._current_chapter_object().embed(summary)
|
||||||
|
|
||||||
|
def query_plot(self, term: str) -> List[ChromaDocument]:
|
||||||
|
return self._current_chapter_object().query_plot(term)
|
||||||
|
|
||||||
|
def query_characters(self, term: str) -> List[ChromaDocument]:
|
||||||
|
return self._current_chapter_object().query_characters(term)
|
||||||
|
|
||||||
|
|
||||||
|
# Utils
|
||||||
|
def create_enrichment_summary_prompt(
|
||||||
|
narrative: str,
|
||||||
|
character_details: List[str],
|
||||||
|
plot_details: List[str]
|
||||||
|
) -> str:
|
||||||
|
prompt = ENRICHMENT_SUMMARY_PROMPT
|
||||||
|
prompt += "Here are the original Character and Plot Details sections."
|
||||||
|
prompt += " Summarize them according to the instructions.\n\n"
|
||||||
|
|
||||||
|
snippets = "## Character Details:\n"
|
||||||
|
for character_detail in character_details:
|
||||||
|
snippets += f"- {character_detail}\n"
|
||||||
|
|
||||||
|
snippets = snippets.strip()
|
||||||
|
snippets += "\n"
|
||||||
|
|
||||||
|
snippets += "\n\n## Plot Details:\n"
|
||||||
|
for plot_point in plot_details:
|
||||||
|
snippets += f"- {plot_point}\n"
|
||||||
|
|
||||||
|
snippets = snippets.strip()
|
||||||
|
snippets += "\n"
|
||||||
|
|
||||||
|
snippets = snippets.strip()
|
||||||
|
prompt += snippets + "\n\n"
|
||||||
|
|
||||||
|
|
||||||
|
prompt += "Additionally, the narrative you must continue is provided below."
|
||||||
|
prompt += "\n\n-----\n\n"
|
||||||
|
prompt += narrative
|
||||||
|
return prompt.strip()
|
||||||
|
|
||||||
|
|
||||||
|
def create_context(results: SummarizerResponse) -> Optional[str]:
|
||||||
|
if not results:
|
||||||
|
return None
|
||||||
|
|
||||||
|
character_details = results.characters
|
||||||
|
plot_details = results.plot
|
||||||
|
|
||||||
|
snippets = "## Relevant Character Details:\n"
|
||||||
|
snippets += "These are relevant bits of information about characters in the story.\n"
|
||||||
|
|
||||||
|
for character_detail in character_details:
|
||||||
|
snippets += f"- {character_detail}\n"
|
||||||
|
|
||||||
|
snippets = snippets.strip()
|
||||||
|
snippets += "\n"
|
||||||
|
|
||||||
|
snippets += "\n\n## Relevant Plot Details:\n"
|
||||||
|
snippets += "These are relevant plot details that happened earlier in the story.\n"
|
||||||
|
|
||||||
|
for plot_point in plot_details:
|
||||||
|
snippets += f"- {plot_point}\n"
|
||||||
|
|
||||||
|
snippets = snippets.strip()
|
||||||
|
snippets += "\n"
|
||||||
|
|
||||||
|
message = (
|
||||||
|
"\n\nUse the following context as information about the story, inside <context></context> XML tags.\n\n"
|
||||||
|
f"<context>\n{snippets}</context>\n"
|
||||||
|
"When answering to user:\n"
|
||||||
|
"- Use the context to enhance your knowledge of the story.\n"
|
||||||
|
"- If you don't know, do not ask for clarification.\n"
|
||||||
|
"Do not mention that you obtained the information from the context.\n"
|
||||||
|
"Do not mention the context.\n"
|
||||||
|
f"Continue the story according to the user's directions."
|
||||||
|
)
|
||||||
|
|
||||||
|
return message
|
||||||
|
|
||||||
|
|
||||||
|
def write_log(text):
|
||||||
|
with open(f"/tmp/test-memories", "a") as file:
|
||||||
|
file.write(text + "\n")
|
||||||
|
|
||||||
|
|
||||||
|
def split_messages(messages, keep_amount):
|
||||||
|
if len(messages) <= keep_amount:
|
||||||
|
return messages[:], []
|
||||||
|
|
||||||
|
recent_messages = messages[-keep_amount:]
|
||||||
|
old_messages = messages[:-keep_amount]
|
||||||
|
return recent_messages, old_messages
|
||||||
|
|
||||||
|
|
||||||
|
def chunk_messages(messages, chunk_size):
|
||||||
|
return [messages[i:i + chunk_size] for i in range(0, len(messages), chunk_size)]
|
||||||
|
|
||||||
|
def llm_messages_to_user_messages(messages):
|
||||||
|
return [
|
||||||
|
{'role': 'user', 'content': msg['content']}
|
||||||
|
for msg in messages if msg['role'] == 'assistant'
|
||||||
|
]
|
||||||
|
|
||||||
|
# Das Filter
|
||||||
|
class Filter:
|
||||||
|
class Valves(BaseModel):
|
||||||
|
def summarizer_model(self, body):
|
||||||
|
if self.summarizer_model_id == "":
|
||||||
|
# This will be the model ID in the convo. If not base
|
||||||
|
# model, it will cause problems.
|
||||||
|
return body["model"]
|
||||||
|
else:
|
||||||
|
return self.summarizer_model_id
|
||||||
|
|
||||||
|
summarizer_model_id: str = Field(
|
||||||
|
default="",
|
||||||
|
description="Model used to summarize the conversation. Must be a base model.",
|
||||||
|
)
|
||||||
|
|
||||||
|
n_last_messages: int = Field(
|
||||||
|
default=4, description="Number of last messages to retain."
|
||||||
|
)
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class UserValves(BaseModel):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.valves = self.Valves()
|
||||||
|
pass
|
||||||
|
|
||||||
|
def extract_convo_id(self, messages):
|
||||||
|
"""Extract ID of first message to use as conversation ID."""
|
||||||
|
if len(messages) > 0:
|
||||||
|
first_user_message = next(
|
||||||
|
(message for message in messages if message.get("role") == "user"), None
|
||||||
|
)
|
||||||
|
|
||||||
|
if first_user_message and 'id' in first_user_message:
|
||||||
|
return first_user_message['id']
|
||||||
|
else:
|
||||||
|
raise ValueError("No messages found to extract conversation ID")
|
||||||
|
else:
|
||||||
|
raise ValueError("No messages found to extract conversation ID")
|
||||||
|
|
||||||
|
|
||||||
|
async def summarize(self, messages) -> Optional[SummarizerResponse]:
|
||||||
|
message_to_summarize = get_last_assistant_message(messages)
|
||||||
|
if message_to_summarize:
|
||||||
|
summarizer = Summarizer(model=self.summarizer_model_id, message=message_to_summarize)
|
||||||
|
return await summarizer.summarize()
|
||||||
|
else:
|
||||||
|
return None
|
||||||
|
|
||||||
|
async def send_outlet_status(self, event_emitter, done: bool):
|
||||||
|
description = (
|
||||||
|
"Analyzing Narrative (do not reply until this is done)" if not done else
|
||||||
|
"Narrative analysis complete (you may now reply)."
|
||||||
|
)
|
||||||
|
await event_emitter({
|
||||||
|
"type": "status",
|
||||||
|
"data": {
|
||||||
|
"description": description,
|
||||||
|
"done": done,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
async def set_enriching_status(self, state: str):
|
||||||
|
if not self.event_emitter:
|
||||||
|
return
|
||||||
|
|
||||||
|
done = state == "done"
|
||||||
|
description = "Enriching Narrative"
|
||||||
|
|
||||||
|
if state == "init": description = f"{description}: Initializing..."
|
||||||
|
if state == "searching": description = f"{description}: Searching..."
|
||||||
|
if state == "analyzing": description = f"{description}: Analyzing..."
|
||||||
|
|
||||||
|
description = (
|
||||||
|
description if not done else
|
||||||
|
"Enrichment Complete"
|
||||||
|
)
|
||||||
|
|
||||||
|
await self.event_emitter({
|
||||||
|
"type": "status",
|
||||||
|
"data": {
|
||||||
|
"description": description,
|
||||||
|
"done": done,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
async def outlet(
|
||||||
|
self,
|
||||||
|
body: dict,
|
||||||
|
__user__: Optional[dict],
|
||||||
|
__event_emitter__: Callable[[Any], Awaitable[None]],
|
||||||
|
) -> dict:
|
||||||
|
# Useful things to have around.
|
||||||
|
self.event_emitter = __event_emitter__
|
||||||
|
self.summarizer_model_id = self.valves.summarizer_model(body)
|
||||||
|
|
||||||
|
await self.send_outlet_status(__event_emitter__, False)
|
||||||
|
messages = body['messages']
|
||||||
|
convo_id = self.extract_convo_id(messages)
|
||||||
|
|
||||||
|
# summarize into plot points.
|
||||||
|
summary = await self.summarize(messages)
|
||||||
|
story = Story(
|
||||||
|
convo_id=convo_id, client=CHROMA_CLIENT,
|
||||||
|
embedding_func=EMBEDDING_FUNCTION,
|
||||||
|
messages=messages
|
||||||
|
)
|
||||||
|
|
||||||
|
story.switch_convo()
|
||||||
|
|
||||||
|
if summary:
|
||||||
|
story.embed_summary(summary)
|
||||||
|
|
||||||
|
await self.send_outlet_status(__event_emitter__, True)
|
||||||
|
return body
|
||||||
|
|
||||||
|
async def generate_enrichment_queries(self, messages) -> SummarizerResponse:
|
||||||
|
last_response = get_last_assistant_message(messages)
|
||||||
|
user_input = get_last_user_message(messages)
|
||||||
|
|
||||||
|
query_message = ""
|
||||||
|
if last_response: query_message += f"## Assistant\n\n{last_response}\n\n"
|
||||||
|
if user_input: query_message += f"## User\n\n{user_input}\n\n"
|
||||||
|
query_message = query_message.strip()
|
||||||
|
|
||||||
|
summarizer = Summarizer(
|
||||||
|
model=self.summarizer_model_id,
|
||||||
|
message=query_message,
|
||||||
|
prompt=QUERY_PROMPT
|
||||||
|
)
|
||||||
|
|
||||||
|
return await summarizer.summarize()
|
||||||
|
|
||||||
|
async def summarize_enrichment(
|
||||||
|
self,
|
||||||
|
messages,
|
||||||
|
character_results: List[ChromaDocument],
|
||||||
|
plot_results: List[ChromaDocument]
|
||||||
|
) -> SummarizerResponse:
|
||||||
|
last_response = get_last_assistant_message(messages)
|
||||||
|
user_input = get_last_user_message(messages)
|
||||||
|
|
||||||
|
character_details = [r['doc'] for r in character_results]
|
||||||
|
plot_details = [r['doc'] for r in plot_results]
|
||||||
|
|
||||||
|
narrative_message = ""
|
||||||
|
if last_response: narrative_message += f"## Assistant\n\n{last_response}\n\n"
|
||||||
|
if user_input: narrative_message += f"## User\n\n{user_input}\n\n"
|
||||||
|
narrative_message = narrative_message.strip()
|
||||||
|
|
||||||
|
summarization_prompt = create_enrichment_summary_prompt(
|
||||||
|
narrative=narrative_message,
|
||||||
|
plot_details=plot_details,
|
||||||
|
character_details=character_details
|
||||||
|
)
|
||||||
|
|
||||||
|
summarizer = Summarizer(
|
||||||
|
model=self.summarizer_model_id,
|
||||||
|
message=narrative_message,
|
||||||
|
prompt=summarization_prompt
|
||||||
|
)
|
||||||
|
|
||||||
|
return await summarizer.summarize()
|
||||||
|
|
||||||
|
|
||||||
|
async def enrich(self, story: Story, messages) -> SummarizerResponse:
|
||||||
|
await self.set_enriching_status("searching")
|
||||||
|
query_generation_result = await self.generate_enrichment_queries(messages)
|
||||||
|
character_results = [result
|
||||||
|
for query in query_generation_result.characters
|
||||||
|
for result in story.query_characters(query)]
|
||||||
|
|
||||||
|
plot_results = [result
|
||||||
|
for query in query_generation_result.plot
|
||||||
|
for result in story.query_plot(query)]
|
||||||
|
|
||||||
|
await self.set_enriching_status("analyzing")
|
||||||
|
return await self.summarize_enrichment(messages, character_results, plot_results)
|
||||||
|
|
||||||
|
|
||||||
|
async def update_system_message(self, messages, system_message):
|
||||||
|
story = Story(
|
||||||
|
convo_id=None, client=CHROMA_CLIENT,
|
||||||
|
embedding_func=EMBEDDING_FUNCTION,
|
||||||
|
messages=messages
|
||||||
|
)
|
||||||
|
|
||||||
|
story.switch_convo()
|
||||||
|
|
||||||
|
if story.convo_id == "<unset>":
|
||||||
|
return
|
||||||
|
|
||||||
|
enrichment_summary: SummarizerResponse = await self.enrich(story, messages)
|
||||||
|
context = create_context(enrichment_summary)
|
||||||
|
|
||||||
|
if context:
|
||||||
|
system_message["content"] += context
|
||||||
|
|
||||||
|
|
||||||
|
async def inlet(
|
||||||
|
self,
|
||||||
|
body: dict,
|
||||||
|
__user__: Optional[dict],
|
||||||
|
__event_emitter__: Callable[[Any], Awaitable[None]]
|
||||||
|
) -> dict:
|
||||||
|
# Useful properties to have around.
|
||||||
|
self.event_emitter = __event_emitter__
|
||||||
|
self.summarizer_model_id = self.valves.summarizer_model(body)
|
||||||
|
await self.set_enriching_status("init")
|
||||||
|
messages = body["messages"]
|
||||||
|
|
||||||
|
# Ensure we always keep the system prompt
|
||||||
|
system_prompt = next(
|
||||||
|
(message for message in messages if message.get("role") == "system"), None
|
||||||
|
)
|
||||||
|
|
||||||
|
if system_prompt:
|
||||||
|
all_messages = [
|
||||||
|
message for message in messages if message.get("role") != "system"
|
||||||
|
]
|
||||||
|
|
||||||
|
recent_messages, old_messages = split_messages(all_messages, self.valves.n_last_messages)
|
||||||
|
most_recent_messages = messages[-self.valves.n_last_messages :]
|
||||||
|
else:
|
||||||
|
system_prompt = { "id": str(uuid.uuid4()), "role": "system", "content": "" }
|
||||||
|
recent_messages, old_messages = split_messages(messages, self.valves.n_last_messages)
|
||||||
|
|
||||||
|
await self.update_system_message(messages, system_prompt)
|
||||||
|
recent_messages.insert(0, system_prompt)
|
||||||
|
|
||||||
|
body["messages"] = recent_messages
|
||||||
|
await self.set_enriching_status("done")
|
||||||
|
return body
|
|
@ -0,0 +1,89 @@
|
||||||
|
# Memory Filter
|
||||||
|
|
||||||
|
Super hacky, very basic automatic narrative memory filter for
|
||||||
|
OpenWebUI, that may or may not actually enhance narrative generation!
|
||||||
|
|
||||||
|
This is intended to be a springboard for a better, more comprehensive
|
||||||
|
filter that can coherently keep track(ish?) of plot and character
|
||||||
|
developments in long form story writing/roleplaying scenarios, where
|
||||||
|
context window length is limited (or ollama crashes on long context
|
||||||
|
length models despite having 40 GB of unused memory!).
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
The filter exposes two settings:
|
||||||
|
|
||||||
|
- **Summarization model:** This is the model used for extracting and
|
||||||
|
creating all of the narrative memory, and searching info. It must
|
||||||
|
be good at following instructions. I use Gemma 2.
|
||||||
|
- **It must be a base model.** If it's not, things will not work.
|
||||||
|
- If you don't set this, the filter will attempt to use the model
|
||||||
|
in the conversation. It must still be a base model.
|
||||||
|
- **Number of messages to retain:** Number of messages to retain for the
|
||||||
|
context. All messages before that are dropped in order to manage
|
||||||
|
context length.
|
||||||
|
|
||||||
|
Ideally, the summarization model is the same model you are using for
|
||||||
|
the storytelling. Otherwise you may have lots of model swap-outs.
|
||||||
|
|
||||||
|
The filter hooks in to OpenWebUI's RAG settings to generate embeddings
|
||||||
|
and query the vector database. The filter will use the same embedding
|
||||||
|
model and ChromaDB instance that's configured in the admin settings.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Enable the filter on a model that you want to use to generate stories.
|
||||||
|
It is recommended, although not required, that this be the same model
|
||||||
|
as the summarizer model (above). If you have lots of VRAM or are very
|
||||||
|
patient, you can use different models.
|
||||||
|
|
||||||
|
User input is pre-processed to 'enrich' the narrative. Replies from
|
||||||
|
the language model are analyzed post-delivery to update the story's
|
||||||
|
knowlege repository.
|
||||||
|
|
||||||
|
You will see status indicators on LLM messages indicating what the
|
||||||
|
filter is doing.
|
||||||
|
|
||||||
|
Do not reply while the model is updating its knowledge base or funny
|
||||||
|
things might happen.
|
||||||
|
|
||||||
|
## Functioning
|
||||||
|
|
||||||
|
What does it do?
|
||||||
|
- When receiving user input, generate search queries for vector DB
|
||||||
|
based on user input + last model response.
|
||||||
|
- Search vector DB for theoretically relevant character and plot
|
||||||
|
information.
|
||||||
|
- Ask model to summarize results into coherent and more relevant
|
||||||
|
stuff.
|
||||||
|
- Inject results as <context>contextual info</context> for the model.
|
||||||
|
- After receiving model narrative reply, generate character and plot
|
||||||
|
info and stick them into the vector DB.
|
||||||
|
|
||||||
|
## Limitations and Known Issues
|
||||||
|
|
||||||
|
What does it not do?
|
||||||
|
- Handle conversational branching/regeneration. In fact, this will
|
||||||
|
pollute the knowledgebase with extra information!
|
||||||
|
- Bouncing around some ideas to fix this. Basically requires
|
||||||
|
building a "canonical" branching story path in the database?
|
||||||
|
- Proper context "chapter" summarization (planned to change).
|
||||||
|
- Work properly when switching conversations due to OpenWebUI
|
||||||
|
limitations. The chat ID is not available on incoming requests for
|
||||||
|
some reason, so a janky workaround is used when processing LLM
|
||||||
|
responses.
|
||||||
|
- Clear out information of old conversations or expire irrelevant
|
||||||
|
data.
|
||||||
|
|
||||||
|
Other things to do or improve:
|
||||||
|
- Set a minimum search score, to prevent useless stuff from coming up.
|
||||||
|
- Figure out how to expire or update information about characters and
|
||||||
|
events, instead of dumping it all into the vector DB.
|
||||||
|
- Improve multi-user handling. Should technically sort of work due to
|
||||||
|
messages having UUIDs, but is a bit messy. Only one collection is
|
||||||
|
used, so multiple users = concurrency issues.
|
||||||
|
- Block user input while updating the knowledgebase.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
AGPL v3.0+.
|
|
@ -0,0 +1,3 @@
|
||||||
|
chromadb==0.5.4
|
||||||
|
pydantic==2.8.2
|
||||||
|
Requests==2.32.3
|
Loading…
Reference in New Issue