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

Tool

@Serializable

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

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

The DeepSeek API currently supports function tools only; provide the schema via FunctionRequest.parameters so the model can emit matching arguments.

Example:

val weather = Tool(
    type = ToolCallType.FUNCTION,
    function = FunctionRequest(
        name = "get_weather",
        description = "Get the current weather for a city",
        parameters = buildJsonObject {
            put("type", "object")
            putJsonObject("properties") {
                putJsonObject("city") { put("type", "string") }
            }
            putJsonArray("required") { add("city") }
        },
    ),
)

Constructors

Tool

constructor(type: ToolCallType, function: FunctionRequest)

Properties

function

val function: FunctionRequest

Function signature the model can call.

type

val type: ToolCallType

Tool type discriminator; currently always ToolCallType.FUNCTION.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String