view chatgpt.xml @ 1:08c658e9aa9e draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/chatgpt commit 13c168a7d6a2d5050c04253754fb86321ad57d54

<tool id="chatgpt_openai_api" name="chatGPT" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="23.0">
    <description>Integrating OpenAI's ChatGPT into Galaxy</description>
    <macros>
        <token name="@TOOL_VERSION@">2024</token>
        <token name="@VERSION_SUFFIX@">0</token>
    </macros>
    <requirements>
        <requirement type="package" version="3.12">python</requirement>
        <requirement type="package" version="1.35.13">openai</requirement>
    </requirements>
    <command detect_errors="exit_code"><![CDATA[
#set LINK_LIST = ''
#for $count, $input in enumerate($context):
    #set LINK = 'input' + str($count) + '.' + $input.ext
    ln -s '$input' '$LINK' &&
    #if count == 0
        #set LINK_LIST = $LINK
    #else
        #set LINK_LIST = $LINK_LIST + ',' + $LINK
    #end if
#end for

python '$__tool_directory__/chatgpt.py'
'$LINK_LIST'
'$question'
'$model'
'$openai_api_key_file'
    ]]></command>
    <configfiles>
        <configfile name="openai_api_key_file"><![CDATA[
$__user__.extra_preferences.get('chatgpt|api_key', "")
        ]]></configfile>
    </configfiles>
    <inputs>
        <param name="context" type="data" multiple="true" optional="false" format="doc,docx,html,json,pdf,txt,jpg,jpeg,png,webp,gif" label="Context" max="500" help="This data will be uploaded to OpenAI's servers for processing."/>
        <param name="question" type="text" optional="false" label="Question" help="Question about the text provided" area="true">
            <validator type="empty_field"/>
        </param>
        <param name="model" type="select" optional="false" label="Model" help="Select the model you want to use">
            <option value="gpt-4o-mini" selected="true">Affordable and intelligent small model for fast, lightweight tasks (gpt-4o-mini)</option>
            <option value="gpt-4o">High-intelligence flagship model for complex, multi-step tasks (gpt-4o)</option>
            <option value="gpt-4-turbo">The previous set of high-intelligence model with vision capabilities (gpt-4-turbo)</option>
            <option value="gpt-4">The previous set of high-intelligence model (gpt-4) (not supporting images)</option>
            <option value="gpt-3.5-turbo">A fast, inexpensive model for simple tasks (GPT-3.5-turbo) (not supporting images)</option>
        </param>
    </inputs>
    <outputs>
        <data name="output" format="txt" label="${tool.name} on ${on_string}" from_work_dir="./output.txt"/>
    </outputs>
    <tests>
        <test expect_failure="true" expect_exit_code="1">
            <param name="context" value="chatgpt_test.txt" ftype="txt"/>
            <param name="question" value="What is this?"/>
            <param name="model" value="gpt-4o-mini"/>
            <assert_stdout>
                <has_text text="OpenAI API key is not provided in user preferences!"/>
            </assert_stdout>
        </test>
    </tests>
    <help><![CDATA[

.. class:: infomark

**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 API keys page in your OpenAI Dashboard.

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 in your openai account page. You might want to check your OpenAI storage from time to time as they also have a quota.

For more information on the tool refer to GitHub README_ file.

.. _README: https://github.com/bgruening/galaxytools/blob/master/tools/chatgpt/README.md

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 on the OpenAI website.


**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.


    ]]></help>
    <citations>
        <citation type="bibtex">
            @misc{openai,
                author = {OpenAI},
                title = {OpenAI's ChatGPT},
                howpublished = {\url{https://openai.com/chatgpt}},
                year = {2024},
                note = {Accessed: 2024-07-26}
            }
        </citation>
    </citations>
</tool>