ChatGPT-Java-API/com.cjcrafter.openai.completions/CompletionRequest/Builder

Builder

class Builder

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

Usage:

val completionRequest = CompletionRequest.builder()
     .model("davinci")
     .prompt("The wheels on the bus go")
     .build()
Content copied to clipboard

Functions

Link copied to clipboard
fun bestOf(bestOf: Int?): CompletionRequest.Builder

Sets the best_of option for the CompletionRequest.

Link copied to clipboard
fun build(): CompletionRequest

Builds the CompletionRequest instance with the provided parameters.

Link copied to clipboard
fun echo(echo: Boolean?): CompletionRequest.Builder

Sets the echo option for the CompletionRequest.

Link copied to clipboard
fun frequencyPenalty(frequencyPenalty: Number?): CompletionRequest.Builder

Sets the frequency penalty for the CompletionRequest.

Link copied to clipboard
fun logitBias(logitBias: Map<String, Int>?): CompletionRequest.Builder

Sets the logit bias for the CompletionRequest.

Link copied to clipboard
fun logprobs(logprobs: Int?): CompletionRequest.Builder

Sets the logprobs for the CompletionRequest.

Link copied to clipboard
fun maxTokens(maxTokens: Int?): CompletionRequest.Builder

Sets the maximum number of tokens for the CompletionRequest.

Link copied to clipboard
fun model(model: String): CompletionRequest.Builder

Sets the model for the CompletionRequest.

Link copied to clipboard
fun n(n: Int?): CompletionRequest.Builder

Sets the number of completions for the CompletionRequest.

Link copied to clipboard
fun presencePenalty(presencePenalty: Number?): CompletionRequest.Builder

Sets the presence penalty for the CompletionRequest.

Link copied to clipboard
fun prompt(prompt: String?): CompletionRequest.Builder

Sets the prompt for the CompletionRequest.

Link copied to clipboard
fun prompts(prompts: Array<String>?): CompletionRequest.Builder

Sets the array of prompts for the CompletionRequest.

fun prompts(prompts: List<String>?): CompletionRequest.Builder

Sets the list of prompts for the CompletionRequest.

Link copied to clipboard
fun stop(stop: Any?): CompletionRequest.Builder

Sets the stop sequences for the CompletionRequest.

Link copied to clipboard
fun stream(stream: Boolean?): CompletionRequest.Builder

Sets the stream option for the CompletionRequest.

Link copied to clipboard
fun suffix(suffix: String?): CompletionRequest.Builder

Sets the suffix for the CompletionRequest.

Link copied to clipboard
fun temperature(temperature: Number?): CompletionRequest.Builder

Sets the temperature for the CompletionRequest.

Link copied to clipboard
fun topP(topP: Number?): CompletionRequest.Builder

Sets the top_p for the CompletionRequest.

Link copied to clipboard
fun user(user: String?): CompletionRequest.Builder

Sets the user identifier for the CompletionRequest.