Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ej52/hass-ollama-conversation
Ollama conversation integration for Home Assistant
https://github.com/ej52/hass-ollama-conversation
ai hacs hass ollama
Last synced: about 1 month ago
JSON representation
Ollama conversation integration for Home Assistant
- Host: GitHub
- URL: https://github.com/ej52/hass-ollama-conversation
- Owner: ej52
- License: mit
- Created: 2023-11-03T14:48:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-17T19:19:19.000Z (5 months ago)
- Last Synced: 2024-09-30T05:26:34.265Z (about 1 month ago)
- Topics: ai, hacs, hass, ollama
- Language: Python
- Homepage:
- Size: 89.8 KB
- Stars: 139
- Watchers: 3
- Forks: 6
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ej52/hass-ollama-conversation/releases)
[](https://github.com/ej52/hass-ollama-conversation/releases)
[](https://github.com/ej52/hass-ollama-conversation/actions/workflows/validate.yaml)
[](LICENSE)
[](https://hacs.xyz)
# Ollama Conversation
The Ollama integration adds a conversation agent powered by [Ollama][ollama] in Home Assistant.
This conversation agent is unable to control your house. The Ollama conversation agent can be used in automations, but not as a [sentence trigger][sentence-trigger]. It can only query information that has been provided by Home Assistant. To be able to answer questions about your house, Home Assistant will need to provide Ollama with the details of your house, which include areas, devices and their states.
## Installation
To install the __Ollama Conversation__ integration to your Home Assistant instance, use this My button:
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=ej52&repository=hass-ollama-conversation&category=integration)
#### Manual Insallation
If the above My button doesn’t work, you can also perform the following steps manually:
* Browse to your Home Assistant instance.
* Go to HACS > Integrations > Custom Repositories.
* Add custom repository.
* Repository is `ej52/hass-ollama-conversation`.
* Category is `Integration`.
* Click ___Explore & Download Repositories___.
* From the list, select Ollama Conversation.
* In the bottom right corner, click the ___Download___ button.
* Follow the instructions on screen to complete the installation.
#### Note:
HACS does not "configure" the integration for you, You must add Ollama Conversation after installing via HACS.
* Browse to your Home Assistant instance.
* Go to Settings > Devices & Services.
* In the bottom right corner, select the ___Add Integration___ button.
* From the list, select Ollama Conversation.
* Follow the instructions on screen to complete the setup.
## Options
Options for Ollama Conversation can be set via the user interface, by taking the following steps:
* Browse to your Home Assistant instance.
* Go to Settings > Devices & Services.
* If multiple instances of Ollama Conversation are configured, choose the instance you want to configure.
* Select the integration, then select ___Configure___.
#### General Settings
Settings relating to the integration itself.
| Option | Description |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Timeout | The maximum amount of time to wait for a response from the API in seconds |
#### System Prompt
The starting text for the AI language model to generate new text from. This text can include information about your Home Assistant instance, devices, and areas and is written using Home Assistant Templating.
#### Model Configuration
The language model and additional parameters to fine tune the responses.
| Option | Description |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Model | The model used to generate response. |
| Context Size | Sets the size of the context window used to generate the next token. |
| Maximum Tokens | The maximum number of words or “tokens” that the AI model should generate in its completion of the prompt. |
| Mirostat Mode | Enable Mirostat sampling for controlling perplexity. |
| Mirostat ETA | Influences how quickly the algorithm responds to feedback from the generated text. A lower learning rate will result in slower adjustments, while a higher learning rate will make the algorithm more responsive. |
| Mirostat TAU | Controls the balance between coherence and diversity of the output. A lower value will result in more focused and coherent text. |
| Temperature | The temperature of the model. A higher value (e.g., 0.95) will lead to more unexpected results, while a lower value (e.g. 0.5) will be more deterministic results. |
| Repeat Penalty | Sets how strongly to penalize repetitions. A higher value (e.g., 1.5) will penalize repetitions more strongly, while a lower value (e.g., 0.9) will be more lenient. |
| Top K | Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative. |
| Top P | Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text. |
## Contributions are welcome!
If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)
### Discussions
Discussions for this integration over on [Home Assistant Community][discussions]
***
[ollama]: https://ollama.ai/
[ollama-github]: https://github.com/jmorganca/ollama
[sentence-trigger]: https://www.home-assistant.io/docs/automation/trigger/#sentence-trigger
[discussions]: https://community.home-assistant.io/t/custom-integration-ollama-conversation-local-ai-agent/636103