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

DeepSeekClientStream

class DeepSeekClientStream : DeepSeekClientBase

Client for streaming interactions with the DeepSeek API.

Use the DeepSeekClientStream top-level function to create instances. The client layers the Ktor SSE plugin on top of the default HTTP client configuration and exposes streaming chat and FIM endpoints as extension functions that return a kotlinx.coroutines.flow.Flow of response chunks.

Example:

val client = DeepSeekClientStream(System.getenv("DEEPSEEK_API_KEY"))
client.chat("Write a haiku").collect { chunk ->
    print(chunk.choices.firstOrNull()?.delta?.content ?: "")
}

Types

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

Builder for configuring and creating DeepSeekClientStream instances.

Properties

val config: DeepSeekClientConfig

Configuration options for the DeepSeek client

Functions

fun DeepSeekClientStream.chat(blockMessage: ChatCompletionRequest.MessageBuilder.() -> Unit): Flow<ChatCompletionChunk>

Streams chat responses using default parameters and a message builder DSL.

fun DeepSeekClientStream.chat(message: String): Flow<ChatCompletionChunk>

Streams chat responses for a single user message.

fun DeepSeekClientStream.chat(messages: List<ChatMessage>): Flow<ChatCompletionChunk>

Streams chat responses using default parameters.

fun DeepSeekClientStream.chat(params: ChatCompletionParams, blockMessage: ChatCompletionRequest.MessageBuilder.() -> Unit): Flow<ChatCompletionChunk>

Streams chat responses using custom parameters and a message builder DSL.

fun DeepSeekClientStream.chat(params: ChatCompletionParams, messages: List<ChatMessage>): Flow<ChatCompletionChunk>

Streams chat responses using custom parameters and messages.

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

Sends a chat completion request to the DeepSeek API.

fun DeepSeekClientStream.chatCompletion(block: ChatCompletionRequest.StreamBuilder.() -> Unit): Flow<ChatCompletionChunk>

Streams a fully customizable chat completion request.

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.

open suspend fun closeAndJoin()

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

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

Sends a request to the Responses API.

fun DeepSeekClientStream.createResponse(block: ResponseRequest.StreamBuilder.() -> Unit): Flow<ResponseStreamEvent>

Streams a fully customizable Responses API request.

fun DeepSeekClientStream.createResponse(input: String): Flow<ResponseStreamEvent>

Streams a single user message through the Responses API with default parameters.

fun DeepSeekClientStream.createResponse(input: List<ResponseItem>): Flow<ResponseStreamEvent>

Streams a conversation through the Responses API with default parameters.

fun DeepSeekClientStream.createResponse(params: ResponseParams, block: ResponseRequest.InputBuilder.() -> Unit): Flow<ResponseStreamEvent>

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

fun DeepSeekClientStream.createResponse(params: ResponseParams, input: String): Flow<ResponseStreamEvent>

Streams a single user message through the Responses API with custom parameters.

fun DeepSeekClientStream.createResponse(params: ResponseParams, input: List<ResponseItem>): Flow<ResponseStreamEvent>

Streams a conversation through the Responses API with custom parameters.

createResponseStream

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

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

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

Deletes a stored file.

fun DeepSeekClientStream.fim(prompt: String): Flow<FIMCompletion>

Streams FIM completions with default parameters.

fun DeepSeekClientStream.fim(params: FIMCompletionParams, prompt: String): Flow<FIMCompletion>

Streams FIM completions using custom parameters and a prompt.

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

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

fun DeepSeekClientStream.fimCompletion(block: FIMCompletionRequest.StreamBuilder.() -> Unit): Flow<FIMCompletion>

Streams a fully customizable FIM completion using a builder pattern.

fimCompletionStream

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

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

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.

suspend fun DeepSeekClientBase.models(): ListsModels

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

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

Fetches the metadata of a single stored file.

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.

suspend fun DeepSeekClientBase.userBalance(): UserBalance

Retrieves the current user's available API balance.