DeepSeek Kotlin SDK/org.oremif.deepseek.models

Package-level declarations

Types

@Serializable

@SerialName(value = "assistant")

open class AssistantMessage(val content: String?, val name: String? = null, val prefix: Boolean? = null, val reasoningContent: String? = null) : ChatMessage

BalanceInfo

@Serializable

class BalanceInfo(val currency: CurrencyType, val totalBalance: String, val grantedBalance: String, val toppedUpBalance: String)

ChatChoice

@Serializable

class ChatChoice(val finishReason: FinishReason, val index: Long, val message: ChatCompletionMessage, val logprobs: LogProbs? = null)

ChatChoiceChunk

@Serializable

class ChatChoiceChunk(val delta: AssistantMessage, val finishReason: FinishReason?, val index: Long)

ChatCompletion

@Serializable

class ChatCompletion(val id: String, val choices: List<ChatChoice>, val created: Long, val model: String, val systemFingerprint: String? = null, val object: String, val usage: Usage)

Represents the Chat Completion.

ChatCompletionChunk

@Serializable

class ChatCompletionChunk(val id: String, val choices: List<ChatChoiceChunk>, val created: Long, val model: String, val systemFingerprint: String, val object: String, val usage: Usage? = null)

ChatCompletionMessage

@Serializable(with = ChatCompletionMessageSerializer::class)

@SerialName(value = "assistant")

class ChatCompletionMessage(val content: String?, val reasoningContent: String? = null, val toolCalls: List<ToolCall>? = null) : AssistantMessage

ChatCompletionMessageSerializer

object ChatCompletionMessageSerializer : KSerializer<ChatCompletionMessage>

ChatCompletionNamedToolChoice

@Serializable

class ChatCompletionNamedToolChoice : ToolChoice

ChatCompletionParams

class ChatCompletionParams : DeepSeekParams

Parameters for configuring chat completion requests to DeepSeek models.

ChatCompletionRequest

@Serializable

class ChatCompletionRequest(val messages: List<ChatMessage>, val model: ChatModel, val frequencyPenalty: Double? = null, val maxTokens: Int? = null, val presencePenalty: Double? = null, val responseFormat: ResponseFormat? = null, val stop: StopReason? = null, val stream: Boolean? = null, val streamOptions: StreamOptions? = null, val temperature: Double? = null, val topP: Double? = null, val tools: List<Tool>? = null, val toolChoice: ToolChoice? = null, val logprobs: Boolean? = null, val topLogprobs: Int? = null)

Represents the Chat Completion request

ChatCompletionToolChoice

@Serializable

enum ChatCompletionToolChoice : Enum<ChatCompletionToolChoice> , ToolChoice

ChatMessage

@Serializable

sealed interface ChatMessage

ChatModel

enum ChatModel : Enum<ChatModel>

CompletionTokenDetails

@Serializable

class CompletionTokenDetails(val reasoningTokens: Int)

CurrencyType

enum CurrencyType : Enum<CurrencyType>

DeepSeekParams

open class DeepSeekParams

Base class for DeepSeek API parameters.

FIMChoice

@Serializable

class FIMChoice(val text: String, val index: Int, val finishReason: FinishReason? = null, val logprobs: FIMLogProbs? = null)

FIMCompletion

@Serializable

class FIMCompletion(val id: String, val choices: List<FIMChoice>, val created: Long, val model: String, val systemFingerprint: String? = null, val object: String, val usage: Usage? = null)

Represents the FIM (Fill-In-the-Middle) Completion.

FIMCompletionParams

class FIMCompletionParams : DeepSeekParams

Parameters for configuring Fill-in-the-Middle (FIM) completion requests to DeepSeek models.

FIMCompletionRequest

@Serializable

class FIMCompletionRequest(val model: ChatModel, val prompt: String, val echo: Boolean? = null, val frequencyPenalty: Double? = null, val logprobs: Int? = null, val maxTokens: Int? = null, val presencePenalty: Double? = null, val stop: StopReason? = null, val stream: Boolean? = null, val streamOptions: StreamOptions? = null, val suffix: String? = null, val temperature: Double? = null, val topP: Double? = null)

Represents the FIM (Fill-In-the-Middle) Completion request

FIMLogProbs

@Serializable

class FIMLogProbs(val textOffset: List<Int>, val tokenLogprobs: List<Double>, val tokens: List<String>, val topLogprobs: List<TopLogProb>?)

FinishReason

@Serializable

enum FinishReason : Enum<FinishReason>

FunctionRequest

@Serializable

class FunctionRequest(val name: String, val description: String?, val parameters: JsonObject?) : ToolFunction

FunctionResponse

@Serializable

class FunctionResponse(val name: String, val arguments: JsonObject?) : ToolFunction

ListsModels

@Serializable

class ListsModels(val object: String, val data: List<ModelInfo>)

LogProb

@Serializable

class LogProb(val token: String, val logprob: Double, val bytes: List<Int>?, val topLogprobs: List<TopLogProb>)

LogProbs

@Serializable

class LogProbs(val content: List<LogProb>?)

ModelInfo

@Serializable

class ModelInfo(val id: String, val object: ModelObjectType, val ownedBy: String)

ModelObjectType

@Serializable

enum ModelObjectType : Enum<ModelObjectType>

ResponseFormat

@Serializable

class ResponseFormat

StopReason

@Serializable(with = StopReasoningSerializer::class)

class StopReason(val reasons: List<String>)

StreamOptions

@Serializable

class StreamOptions(val includeOptions: Boolean)

Represents options that can be applied to a streaming request.

SystemMessage

@Serializable

@SerialName(value = "system")

class SystemMessage(val content: String, val name: String? = null) : ChatMessage

Tool

@Serializable

class Tool(val type: ToolCallType, val function: FunctionRequest)

ToolCall

@Serializable

class ToolCall(val id: String, val type: ToolCallType, val function: FunctionResponse)

ToolCallType

@Serializable

enum ToolCallType : Enum<ToolCallType>

ToolChoice

@Serializable(with = ToolChoiceSerializer::class)

sealed interface ToolChoice

ToolFunction

@Serializable(with = ToolFunctionSerializer::class)

sealed interface ToolFunction

ToolMessage

@Serializable

@SerialName(value = "tool")

class ToolMessage(val content: String, val toolCallId: String) : ChatMessage

TopLogProb

@Serializable

class TopLogProb(val token: String, val logprob: Double, val bytes: List<Int>?)

Usage

@Serializable

class Usage(val completionTokens: Int, val promptTokens: Int, val promptCacheHitTokens: Int? = null, val promptCacheMissTokens: Int? = null, val totalTokens: Int, val completionTokensDetails: CompletionTokenDetails? = null)

UserBalance

@Serializable

class UserBalance(val isAvailable: Boolean, val balanceInfos: List<BalanceInfo>)

UserMessage

@Serializable

@SerialName(value = "user")