Mercurial > repos > bgruening > chatgpt_openai_api
comparison 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 |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:f256dc85e1a0 |
---|---|
1 # ChatGPT Galaxy tool | |
2 | |
3 ## What it does | |
4 | |
5 This tool leverages OpenAI's ChatGPT API to generate responses based on user-provided context and questions. | |
6 Users can upload context data in various formats and ask questions related to that data. | |
7 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. | |
8 | |
9 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. | |
10 | |
11 When you run this tool, your input data is sent to OpenAI's servers using your API-key. | |
12 OpenAI's models process the data and generate a response based on the context and question provided. | |
13 After receiving the response from the OpenAI server, the tool returns it to Galaxy and puts it in your history. | |
14 The files that have been uploaded are then deleted from the OpenAI's server, so they are not stored beyond their necessary use. | |
15 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. | |
16 | |
17 ## Usage | |
18 | |
19 **Input** | |
20 | |
21 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. | |
22 This context data serves as the background information for the question you wish to ask. | |
23 | |
24 2. **Ask a Question**: Once the context data is added, users can pose a question related to the content. | |
25 The more specific the question, the more tailored the response will be. | |
26 | |
27 3. **Select a Model**: Choose the ChatGPT model that best fits your needs. | |
28 Information about different models and their pricing can be found at https://platform.openai.com/docs/models and https://openai.com/api/pricing. | |
29 | |
30 | |
31 **Output** | |
32 | |
33 The output is a response generated by ChatGPT, crafted based on the provided context data and the question posed. | |
34 This response is saved in the `output.txt` file. | |
35 |