Skip to content

Commit 1161002

Browse files
committed
docs(ui): add Keip Assistant docs
1 parent 7165b72 commit 1161002

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

docs/KEIP-ASSISTANT.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Keip Assistant
2+
3+
The Keip Canvas UI provides experimental support for generative AI models to aid in creating flow diagrams.
4+
5+
The Canvas can integrate with LLMs running locally. As of now, only [Ollama](https://github.com/ollama/ollama) is
6+
supported as the LLM runner.
7+
8+
## Setup Instructions
9+
10+
- Install [Ollama](https://github.com/ollama/ollama?tab=readme-ov-file#ollama)
11+
- To allow the Canvas UI to access the local Ollama server, add the following web origin:
12+
```shell
13+
OLLAMA_ORIGINS="https://octoconsulting.github.io"
14+
```
15+
[See here](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server) for
16+
details on configuring the Ollama server.
17+
18+
19+
- Pull the Mistral model
20+
```shell
21+
ollama pull mistral
22+
```
23+
24+
If you run into issues, check out
25+
Ollama's [troubleshooting suggestions](https://github.com/ollama/ollama/blob/main/docs/troubleshooting.md).
26+
27+
## Try It
28+
29+
In a web browser, navigate to the [Canvas](https://octoconsulting.github.io/keip-canvas/).
30+
The `KeipAssistant` button should be enabled in the bottom toolbar. Click it to open a chat panel.
31+
32+
For an example, try this prompt:
33+
34+
```text
35+
Return a flow that listens to a JMS topic and forwards the message out to a Kafka topic
36+
```
37+
38+
Followed by:
39+
40+
```text
41+
Add a correlation id header to the message before sending to Kafka
42+
```
43+
44+
Note, the existing diagram is included in the chat context.

0 commit comments

Comments
 (0)