IOllamaResource

Interface

📦 CommunityToolkit.Aspire.Hosting.Ollama v13.4.0

interface IOllamaResource {
  addHuggingFaceModel(
      name: string,
      modelName: string): OllamaModelResource;
  addModel(modelName: string): OllamaModelResource;
  addNamedModel(
      name: string,
      modelName: string): OllamaModelResource;
  withOpenWebUI(configureContainer?: (obj: OpenWebUIResource) => Promise<void>, containerName?: string): IOllamaResource;
}

Methods

method addHuggingFaceModel builder

Adds a model from Hugging Face to the Ollama resource. Only models in GGUF format are supported.

addHuggingFaceModel(
    name: string,
    modelName: string): OllamaModelResource

Parameters

name string

modelName string

Returns

OllamaModelResource

method addModel builder

Adds a model to the Ollama resource.

addModel(modelName: string): OllamaModelResource

Parameters

modelName string

Returns

OllamaModelResource

method addNamedModel builder

Adds a model to the Ollama resource.

addNamedModel(
    name: string,
    modelName: string): OllamaModelResource

Parameters

name string

modelName string

Returns

OllamaModelResource

method withOpenWebUI builder

Adds an Open WebUI container to the application model for administering Ollama. This version of the package defaults to the main tag of the Open WebUI container image.

withOpenWebUI(configureContainer?: (obj: OpenWebUIResource) => Promise<void>, containerName?: string): IOllamaResource

Parameters

configureContainer (obj: OpenWebUIResource) => Promise<void> optional

containerName string optional

Returns

IOllamaResource