Class OllamaProvider

Hierarchy (View Summary)

BaseProvider
- OllamaProvider

Index

Constructors

Properties

_supportedModels baseConfig

Accessors

baseURL providerId providerName supportedModels

Constructors

constructor

new OllamaProvider(config?: OllamaProviderConfig): OllamaProvider
Parameters
- config: OllamaProviderConfig = {}
Returns OllamaProvider
Overrides BaseProvider.constructor
- Defined in providers/ollama-provider.ts:39

Properties

`Protected`_supportedModels

_supportedModels: string[] = []

`Protected` `Readonly`baseConfig

baseConfig: BaseProviderConfig

Accessors

`Protected`baseURL

get baseURL(): string
Origin this provider talks to; shown in PROVIDER_UNREACHABLE hints.

Returns string
Overrides BaseProvider.baseURL
- Defined in providers/ollama-provider.ts:35

providerId

get providerId(): string
Returns string
Overrides BaseProvider.providerId
- Defined in providers/ollama-provider.ts:203

providerName

get providerName(): string
Returns string
Overrides BaseProvider.providerName
- Defined in providers/ollama-provider.ts:207

supportedModels

get supportedModels(): string[]
Returns string[]
Inherited from BaseProvider.supportedModels
- Defined in providers/base-provider.ts:170

Methods

`Protected`cached

cached(): string[] | null
The last successful discovery, while younger than modelCacheTtlMs (default 5 min; 0 disables).

Returns string[] | null
Inherited from BaseProvider.cached
- Defined in providers/base-provider.ts:183

`Protected`classify

classify(_status: number, json: any, text: string): Refinement
Provider-specific reading of an error body. Return the fields you can tell from it (code, providerCode, hint, retryAfterMs); the status code default fills the rest.
Parameters
- _status: number
- json: any
- text: string
Returns Refinement
Overrides BaseProvider.classify
- Defined in providers/ollama-provider.ts:222

create

create(
modelfilePath: string,
options?: OllamaCLIOptions & { name?: string },
): Promise<OllamaCLIResult>
Create a model from a Modelfile using ollama create -f <path> or ollama create <name> -f <path>.
Parameters
- modelfilePath: string
- options: OllamaCLIOptions & { name?: string } = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:171

discoverModels

discoverModels(): Promise<string[]>
Returns Promise<string[]>
Overrides BaseProvider.discoverModels
- Defined in providers/ollama-provider.ts:180

`Protected`error

error(
    code: AIErrorCode,
    message: string,
    extra?: { details?: unknown; hint?: string; model?: string },
): AIError
A fresh AIError for a failure this provider detects itself (no key, no model, blocked answer).
Parameters
- code: AIErrorCode
- message: string
- extra: { details?: unknown; hint?: string; model?: string } = {}
Returns AIError
Inherited from BaseProvider.error
- Defined in providers/base-provider.ts:228

`Protected`errorContext

errorContext(model?: string): ClassifyContext
Parameters
- Optionalmodel: string
Returns ClassifyContext
Inherited from BaseProvider.errorContext
- Defined in providers/base-provider.ts:212

`Protected`fail

fail(error: AIError, modelUsed?: string): AIResponse
Parameters
- error: AIError
- OptionalmodelUsed: string
Returns AIResponse
Inherited from BaseProvider.fail
- Defined in providers/base-provider.ts:293

`Protected`http

http<T = any>(url: string, options?: HttpOptions): Promise<T>
JSON request. Non-2xx throws [HttpError]; the JSON body (if any) is on .json.
Type Parameters
- T = any
Parameters
- url: string
- options: HttpOptions = {}
Returns Promise<T>
Inherited from BaseProvider.http
- Defined in providers/base-provider.ts:238

`Protected`httpFull

httpFull<T = any>(url: string, options?: HttpOptions): Promise<HttpResult<T>>
JSON request with the reply's status and headers (request ids live there).
Type Parameters
- T = any
Parameters
- url: string
- options: HttpOptions = {}
Returns Promise<HttpResult<T>>
Inherited from BaseProvider.httpFull
- Defined in providers/base-provider.ts:243

`Protected`httpStream

httpStream(
url: string,
options?: HttpOptions,
): Promise<AsyncIterable<Uint8Array>>
Streaming request: the body as an async iterable of bytes, idle-guarded. Non-2xx throws [HttpError].
Parameters
- url: string
- options: HttpOptions = {}
Returns Promise<AsyncIterable<Uint8Array>>
Inherited from BaseProvider.httpStream
- Defined in providers/base-provider.ts:248

isCLIAvailable

isCLIAvailable(): Promise<boolean>
Check if the Ollama CLI is available on the system (needs cli in the config).

Returns Promise<boolean>
- Defined in providers/ollama-provider.ts:77

isModelSupported

isModelSupported(modelId: string): boolean
Parameters
- modelId: string
Returns boolean
Inherited from BaseProvider.isModelSupported
- Defined in providers/base-provider.ts:188

list

list(options?: OllamaCLIOptions): Promise<OllamaCLIResult>
List models (API: GET /api/tags, fallback: ollama ls).
Parameters
- options: OllamaCLIOptions = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:98

`Protected`ok

ok(data: string, extra?: OkExtra): AIResponse
Parameters
- data: string
- extra: OkExtra = {}
Returns AIResponse
Inherited from BaseProvider.ok
- Defined in providers/base-provider.ts:270

process

process(request: AIRequest): Promise<AIResponse>
Parameters
- request: AIRequest
Returns Promise<AIResponse>
Overrides BaseProvider.process
- Defined in providers/ollama-provider.ts:345

processStream

processStream(request: AIRequest): AsyncGenerator<AIStreamChunk, void, void>
Ollama's /api/chat with stream: true, which answers in NDJSON: one JSON object per line, the last carrying done and the token counts.
Parameters
- request: AIRequest
Returns AsyncGenerator<AIStreamChunk, void, void>
Overrides BaseProvider.processStream
- Defined in providers/ollama-provider.ts:294

ps

ps(options?: OllamaCLIOptions): Promise<OllamaCLIResult>
List running models (API: GET /api/ps, fallback: ollama ps).
Parameters
- options: OllamaCLIOptions = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:152

pull

pull(model: string, options?: OllamaCLIOptions): Promise<OllamaCLIResult>
Pull a model (API: POST /api/pull, fallback: ollama pull <model>).
Parameters
- model: string
- options: OllamaCLIOptions = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:88

`Protected`requestOptions

requestOptions(
request: AIRequest,
): Pick<HttpOptions, "signal" | "timeout" | "idleTimeout">
The per-request knobs (signal, timeouts) as http options.
Parameters
- request: AIRequest
Returns Pick<HttpOptions, "signal" | "timeout" | "idleTimeout">
Inherited from BaseProvider.requestOptions
- Defined in providers/base-provider.ts:264

rm

rm(model: string, options?: OllamaCLIOptions): Promise<OllamaCLIResult>
Remove a model (API: DELETE /api/delete, fallback: ollama rm <model>).
Parameters
- model: string
- options: OllamaCLIOptions = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:107

run

run(
    model: string,
    prompt?: string,
    options?: OllamaCLIOptions,
): Promise<OllamaCLIResult>
Run a model with an optional prompt (API: POST /api/generate when prompt given, fallback: ollama run).
Parameters
- model: string
- Optionalprompt: string
- options: OllamaCLIOptions = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:136

runCommand

runCommand(
    subcommand: string,
    args?: string[],
    options?: OllamaCLIOptions,
): Promise<OllamaCLIResult>
Run any native ollama CLI command.
Parameters
- subcommand: string
- args: string[] = []
- options: OllamaCLIOptions = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:65

serve

serve(options?: OllamaCLIOptions): Promise<OllamaCLIResult>
Start the Ollama server using ollama serve.
Parameters
- options: OllamaCLIOptions = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:166

`Protected`setDiscovered

setDiscovered(ids: string[]): string[]
Records what discovery found, keeping any seeded models first so the caller's chosen default stays the default.
Parameters
- ids: string[]
Returns string[]
Inherited from BaseProvider.setDiscovered
- Defined in providers/base-provider.ts:175

show

show(
model: string,
options?: OllamaCLIOptions & { modelfile?: boolean },
): Promise<OllamaCLIResult>
Show model info (API: POST /api/show, fallback: ollama show <model>).
Parameters
- model: string
- options: OllamaCLIOptions & { modelfile?: boolean } = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:119

stop

stop(model: string, options?: OllamaCLIOptions): Promise<OllamaCLIResult>
Stop a running model using ollama stop <model>.
Parameters
- model: string
- options: OllamaCLIOptions = {}
Returns Promise<OllamaCLIResult>
- Defined in providers/ollama-provider.ts:161

testConnection

testConnection(): Promise<boolean>
Cheap by default: "up" means at least one model can be listed. No generation is sent.

Returns Promise<boolean>
Overrides BaseProvider.testConnection
- Defined in providers/ollama-provider.ts:211

`Protected`toError

toError(error: unknown, model?: string): AIError
Any thrown value → AIError carrying this provider's classification.
Parameters
- error: unknown
- Optionalmodel: string
Returns AIError
Inherited from BaseProvider.toError
- Defined in providers/base-provider.ts:223