ChatGPT-Java-API/com.cjcrafter.openai.chat/ChatRequest/Builder

Builder

Builder is a helper class to build a ChatRequest instance with a stable API. It provides methods for setting the properties of the ChatRequest object. The build method returns a new ChatRequest instance with the specified properties.

Usage:

val chatRequest = ChatRequest.builder()
    .model("gpt-3.5-turbo")
    .messages(mutableListOf("Be as helpful as possible".toSystemMessage()))
    .build()

Functions

fun addMessage(message: ChatMessage): ChatRequest.Builder

Adds a message to the end of the list.

fun addTool(tool: Tool): ChatRequest.Builder

Adds a tool to the end of the list.

fun build(): ChatRequest

frequencyPenalty

fun frequencyPenalty(frequencyPenalty: Float): ChatRequest.Builder

fun ChatRequest.Builder.function(block: Function.Builder.() -> Unit): ChatRequest.Builder

Adds a Tool.FunctionTool to the ChatRequest using Kotlin DSL.

fun logitBias(logitBias: MutableMap<String, Float>): ChatRequest.Builder

fun maxTokens(maxTokens: Int): ChatRequest.Builder

fun messages(messages: MutableList<ChatMessage>): ChatRequest.Builder

fun model(model: String): ChatRequest.Builder

fun n(n: Int): ChatRequest.Builder

presencePenalty

fun presencePenalty(presencePenalty: Float): ChatRequest.Builder

fun responseFormat(responseFormat: ChatResponseFormat): ChatRequest.Builder

fun seed(seed: Int): ChatRequest.Builder

fun stop(stop: String): ChatRequest.Builder

fun temperature(temperature: Float): ChatRequest.Builder

fun toolChoice(toolChoice: ToolChoice): ChatRequest.Builder

fun tools(tools: MutableList<Tool>): ChatRequest.Builder

fun topP(topP: Float): ChatRequest.Builder

fun useAutoTool(): ChatRequest.Builder

Lets ChatGPT decide whether to use tools.

useFunctionTool

fun useFunctionTool(name: String): ChatRequest.Builder

Forces ChatGPT to call the specified function.

fun useNoTool(): ChatRequest.Builder

Blocks ChatGPT from using any tools.

fun user(user: String): ChatRequest.Builder