DeepSeek Kotlin SDK/org.oremif.deepseek.models

Package-level declarations

Types

@Serializable

@SerialName(value = "assistant")

class AssistantMessage(val content: String?, val name: String? = null, val prefix: Boolean? = null, val reasoningContent: String? = null, val toolCalls: List<ToolCall>? = null) : ChatMessage

Assistant-role message — a model response, whether produced by the API or replayed as context.

BalanceInfo

@Serializable

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

Per-currency balance breakdown returned inside a UserBalance.

ChatChoice

@Serializable

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

One completion alternative returned inside a ChatCompletion.

ChatChoiceChunk

@Serializable

class ChatChoiceChunk(val delta: ChatCompletionDelta, val finishReason: FinishReason?, val index: Long, val logprobs: LogProbs? = null)

One choice slice carried by a streamed ChatCompletionChunk.

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? = null, val object: String, val usage: Usage? = null)

One chunk of a streamed chat completion response.

ChatCompletionDelta

@Serializable

class ChatCompletionDelta(val role: String? = null, val content: String? = null, val reasoningContent: String? = null, val toolCalls: List<ToolCallDelta>? = null)

A chat completion delta generated by streamed model responses.

ChatCompletionNamedToolChoice

@Serializable

class ChatCompletionNamedToolChoice : ToolChoice

Forces the model to call a specific tool.

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, val thinking: Thinking? = null, val reasoningEffort: ReasoningEffort? = null, val userId: String? = null)

Represents the Chat Completion request

ChatCompletionToolChoice

@Serializable

enum ChatCompletionToolChoice : ToolChoice, Enum<ChatCompletionToolChoice>

Coarse tool-selection strategy.

ChatMessage

@Serializable

sealed interface ChatMessage

One turn in a chat conversation.

ChatModel

@Serializable

@JvmInline

value class ChatModel(val id: String)

Identifier of a DeepSeek model, serialized as the raw slug the API expects.

CompletionTokenDetails

@Serializable

class CompletionTokenDetails(val reasoningTokens: Int)

Breakdown of how the completion_tokens count in Usage was spent.

ContentPart

@Serializable

sealed interface ContentPart

One element of a UserMessage's multimodal content array.

CurrencyType

enum CurrencyType : Enum<CurrencyType>

Currency used to denominate a BalanceInfo entry.

DeepSeekParams

open class DeepSeekParams

Shared sampling parameters for the DeepSeek chat and FIM endpoints.

FileDeleted

@Serializable

class FileDeleted(val id: String, val object: String, val deleted: Boolean)

Outcome of removing a file from the Files API.

FileList

@Serializable

class FileList(val object: String, val data: List<FileObject>, val hasMore: Boolean, val firstId: String? = null, val lastId: String? = null)

One page of the files stored by the Files API.

FileObject

@Serializable

class FileObject(val id: String, val object: String, val bytes: Long, val createdAt: Long, val filename: String, val purpose: FilePurpose, val expiresAt: Long? = null)

A file stored by the DeepSeek Files API.

FilePart

@Serializable

@SerialName(value = "file")

class FilePart(val fileId: String? = null, val fileData: String? = null, val filename: String? = null) : ContentPart

Image passed to the model as a file — either one already uploaded to the Files API, or one inlined as base64.

FilePurpose

@Serializable

@JvmInline

value class FilePurpose(val value: String)

What an uploaded file may be used for, serialized as the raw value the API expects.

FIMChoice

@Serializable

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

One completion alternative returned inside a FIMCompletion.

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)

Response payload of a 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

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<Map<String, Double>>? = null)

Log-probability information attached to a FIMChoice.

FinishReason

@Serializable

enum FinishReason : Enum<FinishReason>

Reason the model stopped producing tokens for a ChatChoice or FIMChoice.

FunctionDelta

@Serializable

class FunctionDelta(val name: String? = null, val arguments: String? = null)

A partial function call carried inside a ToolCallDelta.

FunctionRequest

@Serializable

class FunctionRequest(val name: String, val description: String?, val parameters: JsonObject?, val strict: Boolean? = null) : ToolFunction

Function signature declared in a chat completion request.

FunctionResponse

@Serializable

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

Function invocation emitted by the model inside a ToolCall.

ImageDetail

@Serializable

enum ImageDetail : Enum<ImageDetail>

Values accepted by ImageUrl.detail.

ImageUrl

@Serializable

class ImageUrl(val url: String, val detail: ImageDetail? = null)

Location of an image referenced by an ImageUrlPart.

ImageUrlPart

@Serializable

@SerialName(value = "image_url")

class ImageUrlPart(val imageUrl: ImageUrl) : ContentPart

Image passed to the model by URL, either remote or inline.

ListsModels

@Serializable

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

Response payload of org.oremif.deepseek.api.models — a list of DeepSeek models available to the current API key.

LogProb

@Serializable

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

Log-probability information for a single chat-completion token.

LogProbs

@Serializable

class LogProbs(val content: List<LogProb>? = null, val reasoningContent: List<LogProb>? = null)

Log-probability information attached to a ChatChoice or ChatChoiceChunk.

ModelInfo

@Serializable

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

Metadata for a single DeepSeek model entry returned by org.oremif.deepseek.api.models.

ModelObjectType

@Serializable

enum ModelObjectType : Enum<ModelObjectType>

Discriminator value returned in the object field of a ModelInfo entry.

PromptTokensDetails

@Serializable

class PromptTokensDetails(val cachedTokens: Int? = null)

Breakdown of the prompt tokens counted by Usage, decoded from the OpenAI-compatible prompt_tokens_details key.

ReasoningEffort

@Serializable

@JvmInline

value class ReasoningEffort(val value: String)

How much reasoning a thinking model spends before it answers, serialized as the raw value the API expects.

ResponseFormat

@Serializable

class ResponseFormat

Format the model must use for its response.

SortOrder

@Serializable

enum SortOrder : Enum<SortOrder>

Direction a listing endpoint sorts by.

StopReason

@Serializable(with = StopReasoningSerializer::class)

class StopReason(val reasons: List<String>)

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

StreamOptions

@Serializable

class StreamOptions(val includeUsage: 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

System-role message — sets the assistant's behavior for the rest of the conversation.

TextPart

@Serializable

@SerialName(value = "text")

class TextPart(val text: String) : ContentPart

Text fragment of a multimodal user message.

Thinking

@Serializable

class Thinking(val type: ThinkingType)

Switches a model between its thinking and non-thinking mode.

ThinkingType

@Serializable

enum ThinkingType : Enum<ThinkingType>

Values accepted by Thinking.type.

Tool

@Serializable

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

Declaration of a tool the model may call during a chat completion.

ToolCall

@Serializable

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

A tool invocation emitted by the model inside an AssistantMessage.

ToolCallDelta

@Serializable

class ToolCallDelta(val index: Int, val id: String? = null, val type: ToolCallType? = null, val function: FunctionDelta? = null)

An incremental tool call update sent in a streaming chat completion response.

ToolCallType

@Serializable

enum ToolCallType : Enum<ToolCallType>

Type discriminator for a tool that the model can call.

ToolChoice

@Serializable(with = ToolChoiceSerializer::class)

sealed interface ToolChoice

Controls how the model picks a tool to call.

ToolFunction

@Serializable(with = ToolFunctionSerializer::class)

sealed interface ToolFunction

A function referenced by a tool.

ToolMessage

@Serializable

@SerialName(value = "tool")

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

Tool-role message — the result of executing a ToolCall produced by the model.

TopLogProb

@Serializable

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

One of the top alternatives considered at a given token position in LogProb.topLogprobs.

Usage

@Serializable

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

Token usage statistics for a single chat or FIM request.

UserBalance

@Serializable

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

Snapshot of the current user's account balance, as returned by org.oremif.deepseek.api.userBalance.

UserContent

@Serializable(with = UserContentSerializer::class)

sealed interface UserContent

The two shapes the content of a UserMessage takes on the wire: a bare string, or an array of ContentParts.

UserMessage

@Serializable

@SerialName(value = "user")

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

User-role message — the end-user's input to the conversation.

Functions

argumentsAsJsonOrNull

fun FunctionResponse.argumentsAsJsonOrNull(json: Json = Json): JsonObject?

Parses FunctionResponse.arguments into a JsonObject, or returns null when the model produced no arguments, malformed JSON, or a JSON value that is not an object.

chatCompletionParams

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

Creates chat completion parameters using a builder pattern.

chatCompletionStreamParams

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

Creates streaming chat completion parameters using a builder pattern.

fimCompletionParams

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

Creates FIM completion parameters using a builder pattern.

fimCompletionStreamParams

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

Creates streaming FIM completion parameters using a builder pattern.