DeepSeek Kotlin SDK/org.oremif.deepseek.client/DeepSeekClient

DeepSeekClient

class DeepSeekClient : DeepSeekClientBase

Client for unary (non-streaming) interactions with the DeepSeek API.

Use the DeepSeekClient top-level function to create instances. The client exposes chat completion, Responses, Fill-In-the-Middle completion, user balance, model listing and Files endpoints as extension functions declared in the org.oremif.deepseek.api package.

The client is designed to be long-lived — create one instance and reuse it. Calling close is usually unnecessary.

Example:

val client = DeepSeekClient(System.getenv("DEEPSEEK_API_KEY"))
val response = client.chat("Hello!")
println(response.choices.first().message.content)

Types

Builder

class Builder(token: String? = null) : DeepSeekClientBase.Builder

Builder for configuring and creating DeepSeekClient instances.

Properties

config

val config: DeepSeekClientConfig

Configuration options for the DeepSeek client

Functions

chat

suspend fun DeepSeekClient.chat(blockMessage: ChatCompletionRequest.MessageBuilder.() -> Unit): ChatCompletion

Sends a chat request with default parameters and a DSL for building messages.

suspend fun DeepSeekClient.chat(message: String): ChatCompletion

Sends a single user message to the chat API.

suspend fun DeepSeekClient.chat(messages: List<ChatMessage>): ChatCompletion

Sends a chat request with default parameters.

suspend fun DeepSeekClient.chat(params: ChatCompletionParams, blockMessage: ChatCompletionRequest.MessageBuilder.() -> Unit): ChatCompletion

Sends a chat request with custom parameters and a DSL for building messages.

suspend fun DeepSeekClient.chat(params: ChatCompletionParams, messages: List<ChatMessage>): ChatCompletion

Sends a chat request with custom parameters and messages.

chatCompletion

suspend fun DeepSeekClient.chatCompletion(block: ChatCompletionRequest.Builder.() -> Unit): ChatCompletion

Sends a fully customizable chat completion request.

suspend fun DeepSeekClientBase.chatCompletion(request: ChatCompletionRequest): ChatCompletion

Sends a chat completion request to the DeepSeek API.

chatCompletionStream

fun DeepSeekClientBase.chatCompletionStream(request: ChatCompletionRequest): Flow<ChatCompletionChunk>

Streams chat completion responses chunk by chunk from the DeepSeek API.

open fun close()

Closes the underlying HTTP client and releases its resources.

closeAndJoin

open suspend fun closeAndJoin()

Closes the underlying HTTP client and suspends until its coroutine scope completes.

createResponse

suspend fun DeepSeekClient.createResponse(block: ResponseRequest.Builder.() -> Unit): ModelResponse

Sends a fully customizable Responses API request.

suspend fun DeepSeekClient.createResponse(input: String): ModelResponse

Sends a single user message to the Responses API with default parameters.

suspend fun DeepSeekClient.createResponse(input: List<ResponseItem>): ModelResponse

Sends a conversation to the Responses API with default parameters.

suspend fun DeepSeekClientBase.createResponse(request: ResponseRequest): ModelResponse

Sends a request to the Responses API.

suspend fun DeepSeekClient.createResponse(params: ResponseParams, block: ResponseRequest.InputBuilder.() -> Unit): ModelResponse

Sends a conversation built by a DSL, with custom parameters.

suspend fun DeepSeekClient.createResponse(params: ResponseParams, input: String): ModelResponse

Sends a single user message to the Responses API with custom parameters.

suspend fun DeepSeekClient.createResponse(params: ResponseParams, input: List<ResponseItem>): ModelResponse

Sends a conversation to the Responses API with custom parameters.

createResponseStream

fun DeepSeekClientBase.createResponseStream(request: ResponseRequest): Flow<ResponseStreamEvent>

Streams a Responses API call as semantic server-sent events.

deleteFile

suspend fun DeepSeekClientBase.deleteFile(fileId: String): FileDeleted

Deletes a stored file.

fim

suspend fun DeepSeekClient.fim(prompt: String): FIMCompletion

Generates a completion using the Fill-In-the-Middle capability with default parameters.

suspend fun DeepSeekClient.fim(params: FIMCompletionParams, prompt: String): FIMCompletion

Generates a completion using the Fill-In-the-Middle capability with custom parameters.

fimCompletion

suspend fun DeepSeekClient.fimCompletion(block: FIMCompletionRequest.Builder.() -> Unit): FIMCompletion

Creates a fully customizable FIM completion request using a builder pattern.

suspend fun DeepSeekClientBase.fimCompletion(request: FIMCompletionRequest): FIMCompletion

Sends a Fill-In-the-Middle (FIM) completion request to the DeepSeek API.

fimCompletionStream

fun DeepSeekClientBase.fimCompletionStream(request: FIMCompletionRequest): Flow<FIMCompletion>

Streams Fill-In-the-Middle (FIM) completions chunk by chunk from the DeepSeek API.

listFiles

suspend fun DeepSeekClientBase.listFiles(after: String? = null, limit: Int? = null, order: SortOrder? = null, purpose: FilePurpose? = null): FileList

Lists stored files, oldest first, one page at a time.

models

suspend fun DeepSeekClientBase.models(): ListsModels

Retrieves the list of DeepSeek models available for the current API key.

retrieveFile

suspend fun DeepSeekClientBase.retrieveFile(fileId: String): FileObject

Fetches the metadata of a single stored file.

uploadFile

suspend fun DeepSeekClientBase.uploadFile(bytes: ByteArray, filename: String, expiresAfterSeconds: Int? = null): FileObject

Uploads an image for a vision model to read, and returns the stored FileObject.

userBalance

suspend fun DeepSeekClientBase.userBalance(): UserBalance

Retrieves the current user's available API balance.