Package-level declarations

Types

Link copied to clipboard
data class CopyModelRequest(val source: String, val destination: String)

Represents a request to copy a model.

Link copied to clipboard

Represents a response from the copy model endpoint.

Link copied to clipboard
data class CreateModelRequest(val name: String, val modelfile: String, val stream: Boolean = true)

Represents a request to create a model.

Link copied to clipboard
data class CreateModelResponse(val status: String, val digest: String? = null, val total: Long? = null, val completed: Long? = null)

Represents a response from the create model endpoint.

Link copied to clipboard
data class DeleteModelRequest(val name: String)

Represents a request to delete a model.

Link copied to clipboard

Represents a response from the delete model endpoint.

Link copied to clipboard

Represents the format field in the GenerateRequest. This can be either a string "json" or a JSON schema object.

Link copied to clipboard

Represents a request to list all local models.

Link copied to clipboard

Represents a response from the list models endpoint.

Link copied to clipboard

Represents a request to list running models.

Link copied to clipboard

Represents a response from the list running models endpoint.

Link copied to clipboard
data class ModelDetails(val format: String? = null, val family: String? = null, val families: List<String>? = null, val parameterSize: String? = null, val quantizationLevel: String? = null)

Represents detailed information about a model.

Link copied to clipboard
data class ModelInfo(val name: String, val modified: String? = null, val size: Long? = null, val digest: String? = null, val details: ModelDetails? = null)

Represents information about a model.

Link copied to clipboard
data class ModelOptions(val numCtx: Int = 4096, val repeatLastN: Int? = null, val repeatPenalty: Double? = null, val temperature: Double? = null, val seed: Int? = null, val stop: List<String>? = null, val numPredict: Int? = null, val topK: Int? = null, val topP: Double? = null, val minP: Double? = null)

Configuration options for model text generation behavior.

Link copied to clipboard
data class PullModelRequest(val name: String, val insecure: Boolean? = null, val stream: Boolean = true)

Represents a request to pull a model.

Link copied to clipboard
data class PullModelResponse(val status: String, val digest: String? = null, val total: Long? = null, val completed: Long? = null)

Represents a response from the pull model endpoint.

Link copied to clipboard
data class PushModelRequest(val name: String, val insecure: Boolean? = null, val stream: Boolean = true)

Represents a request to push a model.

Link copied to clipboard
data class PushModelResponse(val status: String, val digest: String? = null, val total: Long? = null, val completed: Long? = null)

Represents a response from the push model endpoint.

Link copied to clipboard
data class RunningModelInfo(val name: String, val id: String, val created: String)

Represents information about a running model.

Link copied to clipboard
data class ShowModelRequest(val name: String)

Represents a request to show information about a model.

Link copied to clipboard
data class ShowModelResponse(val modelfile: String? = null, val parameters: Map<String, String>? = null, val template: String? = null, val system: String? = null, val license: String? = null)

Represents a response from the show model endpoint.

Link copied to clipboard

Represents a request to get the version of the Ollama server.

Link copied to clipboard
data class VersionResponse(val version: String)

Represents a response from the version endpoint.