com.profesorfalken.jwopr.aiprovider.ChatGptProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jWOPR Show documentation
Simple Java API that interacts with AI providers
The newest version!
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.profesorfalken.jwopr.aiprovider;

import com.profesorfalken.jwopr.configuration.ConfigurationReader;
import com.profesorfalken.jwopr.connection.ConnectionClient;
import com.profesorfalken.jwopr.connection.ConnectionUtil;
import com.profesorfalken.jwopr.mapper.ChatGptWOPRResponseMapper;
import com.profesorfalken.jwopr.mapper.WOPRResponseMapper;
import com.profesorfalken.jwopr.response.WOPRResponse;

import java.util.HashMap;
import java.util.Map;

/**
 * AI provider based in ChatGPT API.
 *
 * @author Javier Garcia Alonso
 */
public class ChatGptProvider implements AIProvider {

    //The URL to the ChatGPT API
    private static final String OPEN_API_COMPLETION_URL = "https://api.openai.com/v1/completions";

    //Template for a completion payload
    private static final String ASK_PAYLOAD = "{\"model\": \"{model}\",\"prompt\": \"{prompt}\",\"temperature\": {temperature},\"max_tokens\": {maxTokens}}";

    //Reference to the client used to send the payload
    protected ConnectionClient connectionClient;

    //The configuration of the provider
    protected Map configuration;

    //Constructor
    public ChatGptProvider(ConnectionClient connectionClient) {
        this.connectionClient = connectionClient;

        this.configuration = ConfigurationReader.getChatGptConfiguration();
    }

    /**
     * Ask something to the AI
     *
     * @param prompt the message to send to the AI
     * @return {{@link WOPRResponse}} object encapsulating the response of the AI
     */
    @Override
    public WOPRResponse ask(String prompt) {
        //Set auth key in Authorization header
        Map headers = new HashMap<>();
        headers.put("Authorization", ConnectionUtil.createBearerAuthHeaderValue(getAuthToken()));

        return this.connectionClient.post(OPEN_API_COMPLETION_URL, computeAskPayload(prompt), getMapper(), headers);
    }

    /**
     * Computes the payload that will be sent to AI provider
     *
     * @param prompt the message to send to the AI
     * @return the computed payload
     */
    @Override
    public String computeAskPayload(String prompt) {
        return ASK_PAYLOAD.replaceAll("\\{prompt\\}", prompt)
                .replaceAll("\\{model\\}", this.configuration.get("model"))
                .replaceAll("\\{temperature\\}", this.configuration.get("temperature"))
                .replaceAll("\\{maxTokens\\}", this.configuration.get("maxTokens"));
    }

    /**
     * Sets a custom configuration for the current provider
     *
     * @param configuration {{@link Map}} with the configuration field to override
     */
    @Override
    public void setConfiguration(Map configuration) {
        this.configuration.putAll(configuration);
    }

    /**
     * Get the mapper used to produce the WOPR response
     *
     * @return {{@link WOPRResponse}} object encapsulating the response of the AI
     */
    @Override
    public WOPRResponseMapper getMapper() {
        return new ChatGptWOPRResponseMapper();
    }

    //Get the authorization token for Chat GPT API session
    private String getAuthToken() {
        String authToken = System.getenv("CHATGPT_AUTHTOKEN");

        //Override by configuration
        if (this.configuration.get("authToken") != null) {
            authToken = this.configuration.get("authToken");
        }

        return authToken;
    }
}