Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AI-generated written text content #800

Draft
wants to merge 13 commits into
base: master
Choose a base branch
from
Draft

AI-generated written text content #800

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0ae4c13
add plugin that generates written content using artificial intelligen…
Aug 13, 2023
6fa6a3a
Prevent remote connections
Aug 13, 2023
e73719b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 13, 2023
bfab83c
Merge branch 'master' into gpt
gistya Aug 13, 2023
b7b86ed
update docs, move gptserver under srv directory
Aug 14, 2023
de481e0
Add period to pacify parser
Aug 14, 2023
4edbfbb
PR comments, fixes
Aug 14, 2023
ca5f44c
pr comments and ensure proper error if server helper is offline
Aug 14, 2023
9274c61
PR comments
Aug 14, 2023
b737d2a
Apply suggestions from code review
gistya Aug 14, 2023
c81f2e8
Merge branch 'master' into gpt
Aug 14, 2023
0f9a648
pr comment
Aug 15, 2023
329e4ba
Merge branch '50.13r2' into gpt
Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions docs/gpt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
gpt
===

.. dfhack-tool::
:summary: AI-generated written content.
:tags: fort gameplay

Enables a UI for submitting knowledge item descriptions to OpenAI for generating
poetry, star charts, and excerpts from longer works such as biographies, dictionaries,
treatises on technological evolution, comparative biographies, cultural histories,
autobiographies, cultural comparisons, essays, guides, manuals, and more.
gistya marked this conversation as resolved.
Show resolved Hide resolved

``enable gpt``
==============
Enables the plugin. The overlay will be shown when a knowledge item or unit view sheet is open.

``disable gpt``
===============
Disables the plugin.

Setup:
gistya marked this conversation as resolved.
Show resolved Hide resolved

1. [Register for a free trial or paid OpenAI API account](https://openai.com/product).
2. Generate an API token for your account.
3. Save your OpenAI API token to a file at the root of your DF directory, `oaak.txt`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we try not to put any user data in the DF root directory. I suggest putting it in dfhack-config/.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, makes sense

4. Install python. We used version 3.11 installed from the Microsoft Store.
5. Install python dependencies Flask and OpenAI: `pip install Flask` and `pip install OpenAI`.
6. Start the local helper python app: cd into dfhack/scripts directory & run `python srv/gptserver.py`.

Once the python helper is running, you may now enable and use the gpt plugin.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest having the overlay display a message like "cannot contact server -- do you have the Python helper running?" instead of requiring the player to remember to start the server first

Copy link
Author

@gistya gistya Aug 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The overlay doesn't try to contact the server. It waits until you press the button and then, when there is something to submit, then it tries submitting. At that point, if it can't reach the server, the UI displays a message that says what you suggest (more or less).

The UI becomes fairly unresponsive though, since if the server can't be reached, the exiting luasocket library throws a C++ exception, and Lua's lack of modern error handling means we have to resort to pcall, which seems to carry a nasty performance penalty, perhaps exacerbated by how often updateLayout is being called. Still looking into this one, but it seems to have a workaround at least, and isn't expected to happen very often.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pcall shouldn't really be introducing much of a penalty, although errors themselves might... how often are you calling it?


The python script defaults to using the fast, cheap, legacy model `text-davinci-003`.
If you wish to use the slower, more expensive `gpt-3.5-turbo` or `gpt-4` models, you
can start the script with `python srv/gptserver.py -gpt3` or `python srv/gptserver.py -gpt4`.
Tweaking additional OpenAI API parameters will require modifying `gptserver.py` to suit
your particular needs.

Please refer to https://openai.com/pricing for current pricing information. As of Aug. 2023,
the price for a request/response using `-gpt3` mode would be expected to be two to three cents, &
OpenAI offers a free $5 trial API credit for 90 days when you first register.

Versions of python dependencies tested with:

Package Version
------------------ ---------
aiohttp 3.8.5
aiosignal 1.3.1
async-timeout 4.0.2
attrs 23.1.0
blinker 1.6.2
certifi 2023.7.22
charset-normalizer 3.2.0
click 8.1.6
colorama 0.4.6
Flask 2.3.2
frozenlist 1.4.0
idna 3.4
itsdangerous 2.1.2
Jinja2 3.1.2
MarkupSafe 2.1.3
multidict 6.0.4
openai 0.27.8
requests 2.31.0
tqdm 4.65.0
urllib3 2.0.4
Werkzeug 2.3.6
yarl 1.9.2
Loading