DeepSeek Kotlin SDK/org.oremif.deepseek.models/ChatCompletionParams

ChatCompletionParams

class ChatCompletionParams : DeepSeekParams

Parameters for configuring chat completion requests to DeepSeek models.

This class encapsulates all the options available when sending chat completion requests, allowing fine-grained control over the model's behavior and output.

Example:

val params = chatCompletionParams {
    model = ChatModel.DEEPSEEK_FLASH
    temperature = 0.7
    maxTokens = 1000
}

client.chat(params, messages)

Types

Builder

class Builder

Builder for creating ChatCompletionParams with standard (non-streaming) configuration.

StreamBuilder

class StreamBuilder

Builder for creating ChatCompletionParams specifically configured for streaming responses.

Properties

frequencyPenalty

val ~~frequencyPenalty~~: Double?

Sent as frequency_penalty, ignored by the API.

logprobs

val logprobs: Boolean?

Whether to return log probabilities of output tokens

maxTokens

val maxTokens: Int?

Maximum number of tokens to generate in the response. At least 1, and otherwise bounded by the model's context length.

model

val model: ChatModel

The DeepSeek model to use for chat completion; defaults to ChatModel.DEEPSEEK_FLASH

presencePenalty

val ~~presencePenalty~~: Double?

Sent as presence_penalty, ignored by the API.

reasoningEffort

val reasoningEffort: ReasoningEffort?

How much reasoning the model spends before answering, while thinking mode is on; defaults to the API's own high. See ReasoningEffort.

responseFormat

val responseFormat: ResponseFormat?

Format specification for the model's output

stop

val stop: StopReason?

Custom stop sequences that cause the model to stop generating further tokens.

stream

val stream: Boolean?

Whether to stream the response back piece by piece

streamOptions

val streamOptions: StreamOptions?

Configuration options for streaming responses

temperature

val temperature: Double?

Controls randomness in output generation (higher = more random). Expected range: 0.0..2.0.

thinking

val thinking: Thinking?

Switches the model between thinking and non-thinking mode. See Thinking.

toolChoice

val toolChoice: ToolChoice?

Controls how the model selects tools to use

tools

val tools: List<Tool>?

List of tools that the model may use during chat completion

topLogprobs

val topLogprobs: Int?

How many most likely tokens to return at each position (max 20)

topP

val topP: Double?

Controls diversity via nucleus sampling (consider only tokens with top_p probability mass). Expected range: 0.0..1.0.

userId

val userId: String?

Custom identifier of the end user behind the request; 1 to 512 characters from [a-zA-Z0-9\-_]. Must not carry personal data.

Functions

chat

fun chat(block: ChatCompletionParams.Builder.() -> Unit): ChatCompletionParams

Shortcut to chatCompletionParams, available on any existing DeepSeekParams.

chatStream

fun chatStream(block: ChatCompletionParams.StreamBuilder.() -> Unit): ChatCompletionParams

Shortcut to chatCompletionStreamParams, available on any existing DeepSeekParams.

copy

fun copy(model: ChatModel = this.model, frequencyPenalty: Double? = this.frequencyPenalty, maxTokens: Int? = this.maxTokens, presencePenalty: Double? = this.presencePenalty, responseFormat: ResponseFormat? = this.responseFormat, stop: StopReason? = this.stop, stream: Boolean? = this.stream, streamOptions: StreamOptions? = this.streamOptions, temperature: Double? = this.temperature, topP: Double? = this.topP, tools: List<Tool>? = this.tools, toolChoice: ToolChoice? = this.toolChoice, logprobs: Boolean? = this.logprobs, topLogprobs: Int? = this.topLogprobs, thinking: Thinking? = this.thinking, reasoningEffort: ReasoningEffort? = this.reasoningEffort, userId: String? = this.userId): ChatCompletionParams

Creates a copy of these parameters with optional changes to specific properties.

createRequest

fun createRequest(messages: List<ChatMessage>): ChatCompletionRequest

Creates a ChatCompletionRequest from these parameters and the provided messages.

equals

open operator override fun equals(other: Any?): Boolean

fim

fun fim(block: FIMCompletionParams.Builder.() -> Unit): FIMCompletionParams

Shortcut to fimCompletionParams, available on any existing DeepSeekParams.

fimStream

fun fimStream(block: FIMCompletionParams.StreamBuilder.() -> Unit): FIMCompletionParams

Shortcut to fimCompletionStreamParams, available on any existing DeepSeekParams.

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String