Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kbeaugrand committed Jan 27, 2024
1 parent 5f06b38 commit 546ce9f
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ proprietary data.
To install this memory store, you need to add the required nuget package to your project:

```dotnetcli
dotnet add package SemanticKernel.Assistants --version 1.1.1-preview
dotnet add package SemanticKernel.Assistants --version 1.2.0-preview
```

## Usage
Expand Down Expand Up @@ -89,6 +89,31 @@ dotnet add package SemanticKernel.Assistants --version 1.1.1-preview
await thread.InvokeAsync("Your ask to the assistant.");
```

## Ollama Suport

This assistant supports the [Ollama](https://ollama.ai/) platform, giving you the ability to use the assistant by hosting easyly your LLM models locally.

To use Ollama, install the Ollama extension package:

```dotnetcli
dotnet add package SemanticKernel.Assistants --version 1.2.0-preview
```

Then, instanciate your assistant with the Ollama extension:

```csharp
var mathematician = AssistantBuilder.FromTemplate("./Assistants/Mathematician.yaml",
plugins: new List<IKernelPlugin>()
{
KernelPluginFactory.CreateFromObject(new MathPlugin(), "math")
})
.WithOllamaChatCompletion(ollamaEndpoint, client => {
client.Timeout = TimeSpan.FromMinutes(5);
})
.Build();
```

## License

This project is licensed under the [MIT License](LICENSE).

0 comments on commit 546ce9f

Please sign in to comment.