ai-mocks-openai/dev.mokksy.aimocks.openai.model.chat/ChatCompletionRequestBuilder

ChatCompletionRequestBuilder

class ChatCompletionRequestBuilder(source)

Builder class for creating ChatCompletionRequest instances.

This builder provides a fluent API for creating chat completion requests, making it easier to construct complex requests with many parameters.

Example usage:

val request = ChatCompletionRequestBuilder()
    .model("gpt-4")
    .addSystemMessage("You are a helpful assistant.")
    .addUserMessage("Tell me about Kotlin.")
    .temperature(0.7)
    .build()

Author

Konstantin Pavlov

Constructors

ChatCompletionRequestBuilder

constructor()

Functions

addAssistantMessage

fun addAssistantMessage(content: String): ChatCompletionRequestBuilder

Adds an assistant message to the conversation.

addMessage

fun addMessage(role: ChatCompletionRole, content: MessageContent): ChatCompletionRequestBuilder

Adds a message with structured content parts to the conversation.

fun addMessage(role: ChatCompletionRole, content: String): ChatCompletionRequestBuilder

Adds a message to the conversation.

addSystemMessage

fun addSystemMessage(content: String): ChatCompletionRequestBuilder

Adds a system message to the conversation.

addUserMessage

fun addUserMessage(content: String): ChatCompletionRequestBuilder

Adds a user message to the conversation.

build

fun build(): ChatCompletionRequest

Builds a ChatCompletionRequest instance with the configured parameters.

frequencyPenalty

fun frequencyPenalty(frequencyPenalty: Double): ChatCompletionRequestBuilder

Sets the penalty value for repetitive token usage.

maxCompletionTokens

fun maxCompletionTokens(maxCompletionTokens: Int): ChatCompletionRequestBuilder

Sets the maximum number of tokens allowed in the generated completions.

metadata

fun metadata(metadata: Map<String, String>): ChatCompletionRequestBuilder

Sets the metadata for the request.

model

fun model(model: String): ChatCompletionRequestBuilder

Sets the model to use for the completion.

reasoningEffort

fun reasoningEffort(reasoningEffort: String): ChatCompletionRequestBuilder

Sets the reasoning effort to apply during reasoning.

responseFormat

fun responseFormat(responseFormat: ResponseFormat): ChatCompletionRequestBuilder

Sets the response format.

seed

fun seed(seed: Int): ChatCompletionRequestBuilder

Sets the seed for deterministic responses.

store

fun store(store: Boolean): ChatCompletionRequestBuilder

Sets whether to store the conversation context.

stream

fun stream(stream: Boolean): ChatCompletionRequestBuilder

Sets whether to stream the response.

streamOptions

fun streamOptions(streamOptions: ChatCompletionStreamOptions): ChatCompletionRequestBuilder

Sets the stream options.

temperature

fun temperature(temperature: Double): ChatCompletionRequestBuilder

Sets the temperature for controlling randomness.

tools

fun tools(tools: List<Tool>): ChatCompletionRequestBuilder

Sets the tools available to the model.