http4k-connect-ai-ollama/org.http4k.connect.ollama

Package-level declarations

Types

@JsonSerializable

data class Message(val role: Role, val content: String, val images: List<Base64Blob>? = null)

interface Ollama

Docs: https://github.com/ollama/ollama/blob/main/docs/api.md

interface OllamaAction<R> : Action<Result<R, RemoteFailure>>

OllamaJsonAdapterFactory

@KotshiJsonAdapterFactory

object OllamaJsonAdapterFactory : JsonAdapter.Factory

object OllamaMoshi : ConfigurableMoshi

typealias ~~Prompt~~ = UserPrompt

enum ResponseFormat : Enum<ResponseFormat>

typealias ~~SystemMessage~~ = SystemPrompt

class Template : AbstractValue<String>

Functions

fun Ollama.chatCompletion(model: ModelName, messages: List<Message>, stream: Boolean? = null, format: ResponseFormat? = null, keep_alive: String? = null, options: ModelOptions? = null): Result<Sequence<ChatCompletionResponse>, RemoteFailure>

fun Ollama.chatCompletion(model: ModelName, messages: Message, stream: Boolean? = null, format: ResponseFormat? = null, keep_alive: String? = null, options: ModelOptions? = null): Result<Sequence<ChatCompletionResponse>, RemoteFailure>

fun Ollama.completion(model: ModelName, prompt: UserPrompt, images: List<Base64Blob>? = null, stream: Boolean? = null, system: SystemPrompt? = null, format: ResponseFormat? = null, template: Template? = null, raw: Boolean? = null, keep_alive: String? = null, options: ModelOptions? = null): Result<Sequence<CompletionResponse>, RemoteFailure>

createEmbeddings

fun Ollama.createEmbeddings(model: ModelName, prompt: UserPrompt, keep_alive: String? = null, options: ModelOptions? = null): Result<EmbeddingsResponse, RemoteFailure>

fun Ollama.getModels(): Result<ModelList, RemoteFailure>

fun Ollama.Companion.Http(http: HttpHandler = JavaHttpClient()): Ollama

fun Ollama.pullModel(name: ModelName, stream: Boolean? = null): Result<Sequence<PullResponse>, RemoteFailure>