openai-core/com.aallam.openai.api.chat/ChatCompletionRequestBuilder

ChatCompletionRequestBuilder

class ChatCompletionRequestBuilder

Creates a completion for the chat message.

Constructors

constructor()

Properties

frequencyPenalty

var frequencyPenalty: Double?

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

functionCall

var ~~functionCall~~: FunctionMode?

Controls how the model responds to function calls. FunctionMode.None means the model does not call a function, and responds to the end-user. FunctionMode.Auto means the model can pick between an end-user or calling a function. Specifying a particular function via FunctionMode.Named forces the model to call that function. FunctionMode.None is the default when no functions are present. FunctionMode.Auto is the default if functions are present.

functions

var ~~functions~~: List<ChatCompletionFunction>?

A list of functions the model may generate JSON inputs for.

logitBias

var logitBias: Map<String, Int>?

Modify the likelihood of specified tokens appearing in the completion.

logprobs

var logprobs: Boolean?

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

maxTokens

var maxTokens: Int?

The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens).

messages

var messages: List<ChatMessage>?

The messages to generate chat completions for.

model

var model: ModelId?

ID of the model to use.

var n: Int?

How many chat completion choices to generate for each input message.

presencePenalty

var presencePenalty: Double?

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

responseFormat

var responseFormat: ChatResponseFormat?

An object specifying the format that the model must output.

stop

var stop: List<String>?

Up to 4 sequences where the API will stop generating further tokens.

temperature

var temperature: Double?

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

toolChoice

var toolChoice: ToolChoice?

Controls which (if any) function is called by the model.

tools

var tools: List<Tool>?

A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.

topLogprobs

var topLogprobs: Int?

An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

topP

var topP: Double?

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

user

var user: String?

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Functions

build

fun build(): ChatCompletionRequest

Builder of ChatCompletionRequest instances.

functions

fun ~~functions~~(block: FunctionsBuilder.() -> Unit)

A list of functions the model may generate JSON inputs for.

messages

fun messages(block: ChatMessagesBuilder.() -> Unit)

The messages to generate chat completions for.

tools

fun tools(block: ToolBuilder.() -> Unit)

A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.