admin/openai-chatbot-ossl
1
0
Fork 0
mirror of https://github.com/GuduleLapointe/openai-chatbot-ossl.git synced 2026-08-14 00:57:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

added README

Browse Source
This commit is contained in:
Olivier van Helden
2023-07-25 09:11:42 -04:00
parent 86c0e3d875
commit 434d89d1f2
2 changed files with 74 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+40
View File
@@ -0,0 +1,40 @@
# OpenAI Chatbot for OpenSimulator Virtual World
![Version](https://badgen.net/badge/Version/0.1.0/grey) ![Language](https://badgen.net/badge/Language/LSL/blue) ![Requires](https://badgen.net/badge/Requires/OSSL/green) ![License](https://badgen.net/badge/License/AGPLv3/blue)
This script acts as an AI assistant, powered by OpenAI's GPT-3.5 Turbo language model, designed to interact with users in an OpenSimulator virtual world. It listens to chat messages, processes user queries, and responds with appropriate answers.
The script is intended for OpenSimulator and requires the following OSSL functions to be enabled:
- `osGetNotecard()`
- `osIsNpc()`
- `osNpcSay()`
## Usage
1. Include this script in an object in your OpenSimulator virtual world.
2. Create a notecard named "~api_key" in the same object containing the API key to access OpenAI's GPT-3.5 Turbo.
3. Create a notecard named "~context" in the same object containing your world specific context for the assistant.
4. After initialization, the assistant will listen to user messages containing its name and respond accordingly.
5. Users can interact with the assistant by addressing it with its name and asking questions or giving commands.
## Special Commands (to be interpreted and handled by the AI)
The script utilizes the AI to recognize certain requests and instructs the AI to include specific keywords in the answers. These keywords enable the script to process the responses differently.
- `%not_for_me%` will inform the script that the message is not intended for it and the answer should not be processed.
- `%quit%` will instruct the script to end the chat and respond with a farewell message.
- `%sit%` or `%follow%` will instruct the script to answer accordingly, assuming the user typed the commands with the appropriate syntax for a third-party script ("use" and "follow me" for NPC Manager). In a future release, the script will forward the appropriate command to an external script (NPC Manager) which will handle the requested NPC actions.
## Notes
- This script requires an API key to access OpenAI's GPT-3.5 Turbo API. Make sure to keep the key secure and to not include it in the version you might reditribute.
- The script keeps a log of user and assistant interactions, limited to the number of messages set by LOG_LIMIT.
- The assistant will listen to chat messages until 180 seconds of inactivity or a request to end talking, after which it will stop listening until it is called by its name again.
- Any message starting with a slash ("/") is ignored as it may indicate a command for other purposes.
- The assistant's responses are subject to the capabilities and limitations of the GPT-3.5 Turbo language model.
- This version is an early release, and improvements or bug fixes may be needed based on user feedback.
## Feedback and Issues
For feedback or issues, please see [GitHub Repository](https://github.com/GuduleLapointe/openai-chatbot-ossl).
openai-chatbot.lsl
+34 -22
View File
@@ -1,46 +1,59 @@
/**
* OpenAI Chatbot (openai-chatbot.lsl)
* OpenAI Chatbot for OpenSimulator Virtual World
* openai-chatbot.lsl
*
* This script acts as an AI assistant, powered by OpenAI's GPT-3.5 Turbo
* language model, designed to interact with users in an OpenSimulator virtual
* world. It listens to chat messages, processes user queries, and responds with
* appropriate answers.
* world. It listens to chat messages, processes user queries, and responds
* with appropriate answers.
*
* @creator Gudule Lapointe
* @creator Gudule Lapointe @speculoos.world:8002
* @version 0.1.0
* @language LSL
* @requires OSSL
* @license AGPLv3
* @link https://github.com/GuduleLapointe/openai-chatbot-ossl
*
* The script is intended for OpenSimulator and requires the following OSSL
* functions to be enabled:
* - osGetNotecard()
* - osIsNpc()
* - osNpcSay()
*
* Usage:
* - Include this script in an object in an OpenSimulator virtual world.
* - Include this script in an object in your OpenSimulator virtual world.
* - Create a notecard named "~api_key" in the same object containing the API
* key to access OpenAI's GPT-3.5 Turbo.
* - Create a notecard named "~context" in the same object containing the
* initial conversation context for the assistant.
* - Create a notecard named "~context" in the same object containing your
* world-specific context for the assistant.
* - After initialization, the assistant will listen to user messages
* containing its name and respond accordingly.
* - Users can interact with the assistant by addressing it with its name and
* asking questions or giving commands.
*
* Special Commands (to be interpreted and handled by the AI):
* - The script utilizes the AI to recognize certain requests and instructs the
* AI to include specific keywords in the answers. These keywords enable the
* script to process the responses differently.
* - "%not_for_me%" will inform the script that the message is not intended
* for it and should not be processed further.
* - The script utilizes the AI to recognize certain requests and instructs
* the AI to include specific keywords in the answers. These keywords enable
* the script to process the responses differently.
* - "%not_for_me%" will inform the script that the message is not intended for
* it and the answer should not be processed.
* - "%quit%" will instruct the script to end the chat and respond with a
* farewell message.
* - "%sit%" or "%follow%" will instruct the script to answer accordingly,
* assuming the user typed the commands with the appropriate syntax for a
* third-party script (e.g., "use" and "follow me" for NPC Manager). In a
* future release, the script could forward the appropriate command to the
* external script which will handle the requested NPC actions.
* third-party script ("use" and "follow me" for NPC Manager). In a future
* release, the script will forward the appropriate command to an external
* script (NPC Manager) which will handle the requested NPC actions.
*
* Note:
* - This script requires an API key to access OpenAI's GPT-3.5 Turbo API. Make
* sure to keep the key secure.
* Notes:
* - This script requires an API key to access OpenAI's GPT-3.5 Turbo API.
* Make sure to keep the key secure and not include it in versions you
* might redistribute.
* - The script keeps a log of user and assistant interactions, limited to the
* number of messages set by LOG_LIMIT.
* - The assistant will listen to chat messages until 180 seconds of
* inactivity or a request to end talking, after which it will stop listening.
* inactivity or a request to end talking, after which it will stop listening
* until it is called by its name again.
* - Any message starting with a slash ("/") is ignored as it may indicate a
* command for other purposes.
* - The assistant's responses are subject to the capabilities and limitations
@@ -48,9 +61,8 @@
* - This version is an early release, and improvements or bug fixes may be
* needed based on user feedback.
*
* For feedback or issues, contact the author at
* https://github.com/gudule-lapointe/ssl_script
*
* For feedback or issues, please see
* https://github.com/GuduleLapointe/openai-chatbot-ossl
**/
string DEFAULT_CONTEXT = "OpenSimulator Virtual World";