IOllamaResource

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /CommunityToolkit.Aspire.Hosting.Ollama
5. /IOllamaResource

Interface

📦 CommunityToolkit.Aspire.Hosting.Ollama v13.5.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

methodaddHuggingFaceModelbuilder

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

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

Parameters

namestring

modelNamestring

Returns

OllamaModelResource

methodaddModelbuilder

Adds a model to the Ollama resource.

addModel(modelName: string): OllamaModelResource

Parameters

modelNamestring

Returns

OllamaModelResource

methodaddNamedModelbuilder

Adds a model to the Ollama resource.

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

Parameters

namestring

modelNamestring

Returns

OllamaModelResource

methodwithOpenWebUIbuilder

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

containerNamestringoptional

Returns

IOllamaResource