diff README.md @ 0:f256dc85e1a0 draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/chatgpt commit 840e66e7f23cf775ebd3083c6e07d1819b17f74c
author bgruening
date Tue, 13 Aug 2024 14:25:19 +0000
parents
children 7770a4bd42e2
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Tue Aug 13 14:25:19 2024 +0000
@@ -0,0 +1,35 @@
+# ChatGPT Galaxy tool
+
+## What it does
+
+This tool leverages OpenAI's ChatGPT API to generate responses based on user-provided context and questions.
+Users can upload context data in various formats and ask questions related to that data.
+The tool then uploads the data to a OpenAI server and processes them using the selected ChatGPT model, returning an AI-generated response tailored to the context provided.
+
+To utilize this tool, users need to input their OpenAI API key in the user preferences. To obtain an API key, visit https://platform.openai.com/account/api-keys.
+
+When you run this tool, your input data is sent to OpenAI's servers using your API-key. 
+OpenAI's models process the data and generate a response based on the context and question provided. 
+After receiving the response from the OpenAI server, the tool returns it to Galaxy and puts it in your history. 
+The files that have been uploaded are then deleted from the OpenAI's server, so they are not stored beyond their necessary use. 
+If the tool fails to delete your uploaded files automatically, you can manually delete them by visiting https://platform.openai.com/storage/. You might want to check your OpenAI storage from time to time as they also have a quota.
+
+## Usage
+
+**Input**
+
+1. **Upload Context Data**: Users can upload up to 500 files in formats such as DOC, DOCX, HTML, JSON, PDF, TXT, JPG, JPEG, PNG, WEBP, or GIF. 
+This context data serves as the background information for the question you wish to ask.
+
+2. **Ask a Question**: Once the context data is added, users can pose a question related to the content. 
+The more specific the question, the more tailored the response will be.
+
+3. **Select a Model**: Choose the ChatGPT model that best fits your needs. 
+Information about different models and their pricing can be found at https://platform.openai.com/docs/models and https://openai.com/api/pricing.
+
+
+**Output**
+
+The output is a response generated by ChatGPT, crafted based on the provided context data and the question posed.
+This response is saved in the `output.txt` file.
+