Dracomoth commited on
Commit
2cf4081
·
1 Parent(s): ff0a01c

Update instructions.py

Browse files
Files changed (1) hide show
  1. instructions.py +4 -4
instructions.py CHANGED
@@ -1,5 +1,5 @@
1
- prerequisites_text = "In order to be able to use the Setting Creator, you will need two prerquisites:<br><ol><li> You need an Open AI account, properly set up to use the Open AI API, and obtain a propet Open AI API key (go to <a href=\"https://openai.com\">Open AI</a>).<li> You need a Pinecone account, with a project created, and a Pinecone Key (go to <a href=\"https://www.pinecone.io\">Pinecone</a></ol>)In the first case you will need a proper payment method, fr the second one you can either obtain a subscription or use it for free. After you obtain all these, you need to input the values in the Settings Tab."
2
  discussion_text = "Here is the chatbot where you will have a conversation with Chat GPT in order to create your story setting. there are several components:<ol><li>Chatbot box: This is where your messages and Chat GPT answers are displayed.<li>Token counter: this is an indicator of how many tokens long is your current memory. This is important because when the max token value is surpassed, you won't be able to send any more messages to Chat GPT. The max token value depends on the selected model.<li>Prompt box: Located Under the chatbot box, this is were you write your prompts to Chat GPT.<li>Send button: You click this button to send yur prompt to Chat GPT. Adittionally, you can just press the ENTER key if you ahve the prompt box in focus.<li>Clear button: this button will clear the chatbox and the underlying memory of the chat. This is useful if you want to start a new conversation. This will not delete the data stored in the vector database (Pinecone).<li>Index Memory button: In case you reach the max token value (or you can do it beforehand) you can use this button to save the ongoing conversation into the vector database, and clear the underlying memory of the chat (but not the chatbox).</ol>"
3
- input_text = "In this tab you are allowed to upload a series of documents with information that will then be indexed and stored in the previously indicated vector database in pinecone (see Settings tab). There are only two components:<br><ol><li>The file box, where you can either drop or click to search a number of files you want to upload. Currently only HTML files are supported.<li>The upload button, which you will click once the files you want to upload are all in the foile box.</ol><br>A message will be shown to confirm that the files have been properly stored."
4
- output_text = "In this tab you will be able to use Chat GPT to generate one or more documents with the setting information you created in the discussion. The documents will need one or more HTML templates to be able to generate proper documents. In the document you will need to put sections and placeholders for the text in those sections.<br>Example:<br>Geography<br>{place geography information here}<br>Pantheon<br>{place deities and religion information here}<br>It is important to notice that, because the templates are HTML documents, you can use html tags to enhance the way the document looks. But also is important to remind you that the documents will be generated by Chat GPT, so i cannot guarantee strict adherence to the templates. The compomnents are<br><ol><li>The template file box: Where you can either drop or click to search a number of template files you want to upload. Currently only HTML files are supported.<li>The Generated Files box: Here all generated files will be show once the process ends, so you can download them. It will generate one document per template uploaded.<li>The Generate button: Once you finish uploading the templates, you can click this button to start the generation process.</ol>"
5
- settings_text = "In order to properly use the Setting Creator, you must first set the values in this tab. The values to set are:<br><h4>Open AI settings</h4><ol><li>Model: Here you can select the ChatGPT model to use.<li>Temperature: Indicates the \"creative freedom\" of the ChatGPT engine. The higher, it will give more creative answers but will obey your instructions less.<li>API key: Your Open AI key</ol><br><h4>Pinecone settings</h4><ol><li>Environment Name: The name of your created environment. If it is a free account, it will be \"gcp-starter\"<li>Index Name: Here you put the name of the index (vector database) where you want your vectors to be stored. You don\'t need to have it created in Pinecone beforehand.<li>API key: Your pinecone key for the selected environment.</ol>"
 
1
+ prerequisites_text = "In order to be able to use the Setting Creator, you will need two prerquisites:<br><ol><li> You need an Open AI account, properly set up to use the Open AI API, and obtain a propet Open AI API key (go to <a href=\"https://openai.com\">Open AI</a>).<li> You need a Pinecone account, with a project created, and a Pinecone Key (go to <a href=\"https://www.pinecone.io\">Pinecone</a>)</ol>In the first case you will need a proper payment method, fr the second one you can either obtain a subscription or use it for free. After you obtain all these, you need to input the values in the Settings Tab."
2
  discussion_text = "Here is the chatbot where you will have a conversation with Chat GPT in order to create your story setting. there are several components:<ol><li>Chatbot box: This is where your messages and Chat GPT answers are displayed.<li>Token counter: this is an indicator of how many tokens long is your current memory. This is important because when the max token value is surpassed, you won't be able to send any more messages to Chat GPT. The max token value depends on the selected model.<li>Prompt box: Located Under the chatbot box, this is were you write your prompts to Chat GPT.<li>Send button: You click this button to send yur prompt to Chat GPT. Adittionally, you can just press the ENTER key if you ahve the prompt box in focus.<li>Clear button: this button will clear the chatbox and the underlying memory of the chat. This is useful if you want to start a new conversation. This will not delete the data stored in the vector database (Pinecone).<li>Index Memory button: In case you reach the max token value (or you can do it beforehand) you can use this button to save the ongoing conversation into the vector database, and clear the underlying memory of the chat (but not the chatbox).</ol>"
3
+ input_text = "In this tab you are allowed to upload a series of documents with information that will then be indexed and stored in the previously indicated vector database in pinecone (see Settings tab). There are only two components:<br><ol><li>The file box, where you can either drop or click to search a number of files you want to upload. Currently only HTML files are supported.<li>The upload button, which you will click once the files you want to upload are all in the foile box.</ol>A message will be shown to confirm that the files have been properly stored."
4
+ output_text = "In this tab you will be able to use Chat GPT to generate one or more documents with the setting information you created in the discussion. The documents will need one or more HTML templates to be able to generate proper documents. In the document you will need to put sections and placeholders for the text in those sections.<br><br>Example:<br><br>Geography<br><br>{place geography information here}<br><br>Pantheon<br><br>{place deities and religion information here}<br><br>It is important to notice that, because the templates are HTML documents, you can use html tags to enhance the way the document looks. But also is important to remind you that the documents will be generated by Chat GPT, so i cannot guarantee strict adherence to the templates. The compomnents are<br><ol><li>The template file box: Where you can either drop or click to search a number of template files you want to upload. Currently only HTML files are supported.<li>The Generated Files box: Here all generated files will be show once the process ends, so you can download them. It will generate one document per template uploaded.<li>The Generate button: Once you finish uploading the templates, you can click this button to start the generation process.</ol>"
5
+ settings_text = "In order to properly use the Setting Creator, you must first set the values in this tab. The values to set are:<br><h4>Open AI settings</h4><ol><li>Model: Here you can select the ChatGPT model to use.<li>Temperature: Indicates the \"creative freedom\" of the ChatGPT engine. The higher, it will give more creative answers but will obey your instructions less.<li>API key: Your Open AI key</ol><h4>Pinecone settings</h4><ol><li>Environment Name: The name of your created environment. If it is a free account, it will be \"gcp-starter\"<li>Index Name: Here you put the name of the index (vector database) where you want your vectors to be stored. You don\'t need to have it created in Pinecone beforehand.<li>API key: Your pinecone key for the selected environment.</ol>"