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

Package-level declarations

Types

class ContentPartAddedEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val contentIndex: Int, val part: ResponseContentPart) : ContentPartEvent

A new content part has started inside an output item.

ContentPartDoneEvent

class ContentPartDoneEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val contentIndex: Int, val part: ResponseContentPart) : ContentPartEvent

A content part is complete; part holds its final form.

ContentPartEvent

sealed class ContentPartEvent : ResponseStreamEvent

An event marking the start or the end of one content part inside an output item.

CustomTool

@Serializable

class CustomTool(val name: String) : ResponseTool

A free-form tool that takes raw text instead of JSON arguments.

CustomToolCallInputDeltaEvent

class CustomToolCallInputDeltaEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val delta: String) : ToolInputDeltaEvent

A fragment of the free-form input the model is generating for a CustomToolCallItem.

CustomToolCallInputDoneEvent

class CustomToolCallInputDoneEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val input: String) : ToolInputDoneEvent

The finished input of a custom tool call.

CustomToolCallItem

@Serializable

class CustomToolCallItem(val callId: String, val name: String, val input: String, val id: String? = null, val status: ResponseStatus? = null) : ResponseItem

A call to the apply_patch custom tool, which takes free-form input instead of JSON arguments.

CustomToolCallOutputItem

@Serializable

class CustomToolCallOutputItem(val callId: String, val output: ResponseContent) : ResponseItem

The result of running a CustomToolCallItem.

FunctionCallArgumentsDeltaEvent

class FunctionCallArgumentsDeltaEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val delta: String) : ToolInputDeltaEvent

A fragment of the JSON arguments the model is generating for a FunctionCallItem.

FunctionCallArgumentsDoneEvent

class FunctionCallArgumentsDoneEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val arguments: String) : ToolInputDoneEvent

The finished JSON arguments of a function call.

FunctionCallItem

@Serializable

class FunctionCallItem(val callId: String, val name: String, val arguments: String, val id: String? = null, val status: ResponseStatus? = null) : ResponseItem

A function the model asked to call.

FunctionCallOutputItem

@Serializable

class FunctionCallOutputItem(val callId: String, val output: ResponseContent) : ResponseItem

The result of running a function the model called.

FunctionTool

@Serializable

class FunctionTool(val name: String, val description: String? = null, val parameters: JsonObject? = null) : ResponseTool

A function the model may call, described by its JSON Schema.

IncompleteDetails

@Serializable

class IncompleteDetails(val reason: IncompleteReason? = null)

Why a ResponseStatus.INCOMPLETE response stopped short.

IncompleteReason

@Serializable

@JvmInline

value class IncompleteReason(val value: String)

Reason a response was truncated, serialized as the raw value the API sends.

InputImagePart

@Serializable

class InputImagePart(val imageUrl: String? = null, val fileId: String? = null, val detail: ImageDetail? = null) : ResponseContentPart

Image sent to the model, as input_image.

InputTextPart

@Serializable

class InputTextPart(val text: String) : TextContentPart

Text sent to the model, as input_text.

InputTokensDetails

@Serializable

class InputTokensDetails(val cachedTokens: Int? = null)

Breakdown of the input tokens counted in ResponseUsage.inputTokens.

MessageItem

@Serializable

class MessageItem(val role: ResponseRole, val content: ResponseContent?, val id: String? = null, val status: ResponseStatus? = null) : ResponseItem

A message turn: text, or multimodal parts, attributed to a ResponseRole.

ModelResponse

@Serializable

class ModelResponse(val id: String, val object: String, val createdAt: Long, val status: ResponseStatus, val error: ResponseError? = null, val incompleteDetails: IncompleteDetails? = null, val model: String, val output: List<ResponseItem> = emptyList(), val usage: ResponseUsage? = null)

A response produced by the Responses API.

NamedResponseToolChoice

@Serializable

class NamedResponseToolChoice : ResponseToolChoice

Forces the model to call one specific tool.

OutputItemAddedEvent

class OutputItemAddedEvent(val sequenceNumber: Int, val outputIndex: Int, val item: ResponseItem) : OutputItemEvent

A new output item — reasoning, message, tool call — has started.

OutputItemDoneEvent

class OutputItemDoneEvent(val sequenceNumber: Int, val outputIndex: Int, val item: ResponseItem) : OutputItemEvent

An output item is complete; item holds its final form.

OutputItemEvent

sealed class OutputItemEvent : ResponseStreamEvent

An event marking the start or the end of one item of ModelResponse.output.

OutputTextDeltaEvent

class OutputTextDeltaEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val contentIndex: Int, val delta: String) : TextDeltaEvent

A fragment of the visible answer. This is the event most callers print as it arrives.

OutputTextDoneEvent

class OutputTextDoneEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val contentIndex: Int, val text: String) : TextDoneEvent

The visible answer of one content part, complete.

OutputTextPart

@Serializable

class OutputTextPart(val text: String) : TextContentPart

Text produced by the model, as output_text.

OutputTokensDetails

@Serializable

class OutputTokensDetails(val reasoningTokens: Int? = null)

Breakdown of the output tokens counted in ResponseUsage.outputTokens.

ReasoningConfig

@Serializable

class ReasoningConfig(val effort: ReasoningEffort? = null)

Thinking-mode configuration of a Responses API request.

ReasoningItem

@Serializable

class ReasoningItem(val content: List<ResponseContentPart> = emptyList(), val id: String? = null, val status: ResponseStatus? = null) : ResponseItem

The chain-of-thought a thinking model produced before its answer.

ReasoningTextDeltaEvent

class ReasoningTextDeltaEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val contentIndex: Int, val delta: String) : TextDeltaEvent

A fragment of the chain-of-thought a thinking model produces before its answer.

ReasoningTextDoneEvent

class ReasoningTextDoneEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int, val contentIndex: Int, val text: String) : TextDoneEvent

The chain-of-thought of one content part, complete.

ReasoningTextPart

@Serializable

class ReasoningTextPart(val text: String) : TextContentPart

Chain-of-thought produced by the model in thinking mode, as reasoning_text.

ResponseCompletedEvent

class ResponseCompletedEvent(val sequenceNumber: Int, val response: ModelResponse) : ResponseSnapshotEvent

Terminal event of a response that finished normally, carrying its output and usage.

ResponseContent

@Serializable(with = ResponseContentSerializer::class)

sealed interface ResponseContent

The two shapes a content or output field takes on the wire: a bare string, or an array of ResponseContentParts.

ResponseContentPart

@Serializable(with = ResponseContentPartSerializer::class)

sealed interface ResponseContentPart

One element of the content array of a ResponseItem.

ResponseCreatedEvent

class ResponseCreatedEvent(val sequenceNumber: Int, val response: ModelResponse) : ResponseSnapshotEvent

The first event of the stream: the response exists and generation has started.

ResponseError

@Serializable

class ResponseError(val code: String? = null, val message: String? = null)

What went wrong on a ResponseStatus.FAILED response.

ResponseFailedEvent

class ResponseFailedEvent(val sequenceNumber: Int, val response: ModelResponse) : ResponseSnapshotEvent

Terminal event of a response that failed; see ModelResponse.error.

ResponseIncompleteEvent

class ResponseIncompleteEvent(val sequenceNumber: Int, val response: ModelResponse) : ResponseSnapshotEvent

Terminal event of a response that was cut short — by max_output_tokens or the content filter; see ModelResponse.incompleteDetails.

ResponseInProgressEvent

class ResponseInProgressEvent(val sequenceNumber: Int, val response: ModelResponse) : ResponseSnapshotEvent

Progress ping: the response is still being generated.

ResponseInput

@Serializable(with = ResponseInputSerializer::class)

sealed interface ResponseInput

The two shapes the input of a ResponseRequest takes on the wire: a bare string, treated by the API as a single user message, or an array of ResponseItems.

ResponseItem

@Serializable(with = ResponseItemSerializer::class)

sealed interface ResponseItem

One entry of the conversation handed to — or produced by — the Responses API.

ResponseParams

class ResponseParams

Everything about a Responses API call except the conversation itself.

ResponseRequest

@Serializable

class ResponseRequest(val model: ChatModel, val input: ResponseInput? = null, val instructions: String? = null, val reasoning: ReasoningConfig? = null, val maxOutputTokens: Int? = null, val stream: Boolean? = null, val temperature: Double? = null, val topP: Double? = null, val text: TextConfig? = null, val tools: List<ResponseTool>? = null, val toolChoice: ResponseToolChoice? = null, val topLogprobs: Int? = null, val user: String? = null)

A request to the Responses API.

ResponseRole

@Serializable

@JvmInline

value class ResponseRole(val value: String)

Author of a MessageItem.

ResponseSnapshotEvent

sealed class ResponseSnapshotEvent : ResponseStreamEvent

An event carrying a snapshot of the whole response.

ResponseStatus

@Serializable

@JvmInline

value class ResponseStatus(val value: String)

State of a ModelResponse or of a single ResponseItem, serialized as the raw value the API sends.

ResponseStreamEvent

@Serializable(with = ResponseStreamEventSerializer::class)

sealed interface ResponseStreamEvent

One semantic server-sent event of a streamed Responses API call.

ResponseTool

@Serializable(with = ResponseToolSerializer::class)

sealed interface ResponseTool

A tool the model may use while producing a response.

ResponseToolChoice

@Serializable(with = ResponseToolChoiceSerializer::class)

sealed interface ResponseToolChoice

Controls which tool, if any, the model calls.

ResponseToolChoiceMode

@Serializable

enum ResponseToolChoiceMode : ResponseToolChoice, Enum<ResponseToolChoiceMode>

Coarse tool-selection strategy.

ResponseUsage

@Serializable

class ResponseUsage(val inputTokens: Int, val inputTokensDetails: InputTokensDetails? = null, val outputTokens: Int, val outputTokensDetails: OutputTokensDetails? = null, val totalTokens: Int)

Token usage statistics of a ModelResponse.

TextConfig

@Serializable

class TextConfig(val format: TextFormat)

Shape of the text the model must produce.

TextContentPart

sealed class TextContentPart : ResponseContentPart

Base of the three content parts that carry nothing but text, so they can be matched at once:

TextDeltaEvent

sealed class TextDeltaEvent : ResponseStreamEvent

An incremental piece of text produced inside a content part.

TextDoneEvent

sealed class TextDoneEvent : ResponseStreamEvent

The complete text of a content part, sent once its deltas are done.

TextFormat

@Serializable

class TextFormat

Wire form of TextConfig.format. Build it through the TextConfig factories rather than directly.

ToolInputDeltaEvent

sealed class ToolInputDeltaEvent : ResponseStreamEvent

An incremental piece of the input the model is generating for a tool call.

ToolInputDoneEvent

sealed class ToolInputDoneEvent : ResponseStreamEvent

The complete input of a tool call, sent once its deltas are done.

UnknownItem

class UnknownItem(val type: String, val raw: JsonObject) : ResponseItem

An item whose type this version of the SDK does not model.

UnknownResponseContentPart

class UnknownResponseContentPart(val type: String, val raw: JsonObject) : ResponseContentPart

A content part whose type this version of the SDK does not model.

UnknownResponseStreamEvent

class UnknownResponseStreamEvent(val type: String, val sequenceNumber: Int, val raw: JsonObject) : ResponseStreamEvent

An event this version of the SDK cannot map: an unknown type, or a known one whose payload does not fit the expected shape.

UnknownTool

class UnknownTool(val type: String, val raw: JsonObject) : ResponseTool

A tool whose type this version of the SDK does not model, kept verbatim so it round-trips.

WebSearchCallCompletedEvent

class WebSearchCallCompletedEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int) : WebSearchCallEvent

The web search has finished and its results are feeding back into the model.

WebSearchCallEvent

sealed class WebSearchCallEvent : ResponseStreamEvent

A status update of a web search the API is running server-side.

WebSearchCallInProgressEvent

class WebSearchCallInProgressEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int) : WebSearchCallEvent

A web search call has been created and is about to run.

WebSearchCallItem

@Serializable

class WebSearchCallItem(val action: JsonObject? = null, val id: String? = null, val status: ResponseStatus? = null) : ResponseItem

A web search the API ran on its own, server side.

WebSearchCallSearchingEvent

class WebSearchCallSearchingEvent(val sequenceNumber: Int, val itemId: String, val outputIndex: Int) : WebSearchCallEvent

The web search is running.

WebSearchTool

class WebSearchTool : ResponseTool

The built-in web search, executed on the API's side.

Functions

argumentsAsJsonOrNull

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

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

responseParams

fun responseParams(block: ResponseParams.Builder.() -> Unit): ResponseParams

Creates Responses API parameters using a builder.

responseStreamParams

fun responseStreamParams(block: ResponseParams.StreamBuilder.() -> Unit): ResponseParams

Creates streaming Responses API parameters using a builder.