LocalAI/examples/README.md

# Examples

| [ChatGPT OSS alternative](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui)                                                                                                                | [Image generation](https://localai.io/api-endpoints/index.html#image-generation)                                                                                                              |
|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
|  ![Screenshot from 2023-04-26 23-59-55](https://user-images.githubusercontent.com/2420543/234715439-98d12e03-d3ce-4f94-ab54-2b256808e05e.png)            | ![b6441997879](https://github.com/go-skynet/LocalAI/assets/2420543/d50af51c-51b7-4f39-b6c2-bf04c403894c)                  |

|                                                                    [Telegram bot](https://github.com/go-skynet/LocalAI/tree/master/examples/telegram-bot)   | [Flowise](https://github.com/go-skynet/LocalAI/tree/master/examples/flowise)                                                                                                                     |
|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
![Screenshot from 2023-06-09 00-36-26](https://github.com/go-skynet/LocalAI/assets/2420543/e98b4305-fa2d-41cf-9d2f-1bb2d75ca902)   |  ![Screenshot from 2023-05-30 18-01-03](https://github.com/go-skynet/LocalAI/assets/2420543/02458782-0549-4131-971c-95ee56ec1af8)|    |

Here is a list of projects that can easily be integrated with the LocalAI backend. 


### Projects

### AutoGPT

_by [@mudler](https://github.com/mudler)_

This example shows how to use AutoGPT with LocalAI.

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/autoGPT/)

### Chatbot-UI

_by [@mkellerman](https://github.com/mkellerman)_

![Screenshot from 2023-04-26 23-59-55](https://user-images.githubusercontent.com/2420543/234715439-98d12e03-d3ce-4f94-ab54-2b256808e05e.png)

This integration shows how to use LocalAI with [mckaywrigley/chatbot-ui](https://github.com/mckaywrigley/chatbot-ui).

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui/)

There is also a separate example to show how to manually setup a model: [example](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui-manual/)

### K8sGPT

_by [@mudler](https://github.com/mudler)_

This example show how to use LocalAI inside Kubernetes with [k8sgpt](https://k8sgpt.ai).

![Screenshot from 2023-06-19 23-58-47](https://github.com/go-skynet/go-ggml-transformers.cpp/assets/2420543/cab87409-ee68-44ae-8d53-41627fb49509)

### Fine-tuning a model and convert it to gguf to use it with LocalAI

_by [@mudler](https://github.com/mudler)_

This example is an e2e example on how to fine-tune a model with [axolotl](https://github.com/OpenAccess-AI-Collective/axolotl) and convert it to gguf to use it with LocalAI.

[Check it out here](https://github.com/mudler/LocalAI/tree/master/examples/e2e-fine-tuning/)

### Flowise

_by [@mudler](https://github.com/mudler)_

This example shows how to use [FlowiseAI/Flowise](https://github.com/FlowiseAI/Flowise) with LocalAI.

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/flowise/)

### Discord bot

_by [@mudler](https://github.com/mudler)_

Run a discord bot which lets you talk directly with a model

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/discord-bot/), or for a live demo you can talk with our bot in #random-bot in our discord server.

### Langchain

_by [@dave-gray101](https://github.com/dave-gray101)_

A ready to use example to show e2e how to integrate LocalAI with langchain

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/langchain/)

### Langchain Python

_by [@mudler](https://github.com/mudler)_

A ready to use example to show e2e how to integrate LocalAI with langchain

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/langchain-python/)

### LocalAI functions

_by [@mudler](https://github.com/mudler)_

A ready to use example to show how to use OpenAI functions with LocalAI

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/functions/)

### LocalAI WebUI

_by [@dhruvgera](https://github.com/dhruvgera)_

![image](https://user-images.githubusercontent.com/42107491/235344183-44b5967d-ba22-4331-804c-8da7004a5d35.png)

A light, community-maintained web interface for LocalAI

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/localai-webui/)

### How to run rwkv models

_by [@mudler](https://github.com/mudler)_

A full example on how to run RWKV models with LocalAI

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/rwkv/)

### PrivateGPT

_by [@mudler](https://github.com/mudler)_

A full example on how to run PrivateGPT with LocalAI

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/privateGPT/)

### Slack bot

_by [@mudler](https://github.com/mudler)_

Run a slack bot which lets you talk directly with a model

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/slack-bot/)

### Slack bot (Question answering)

_by [@mudler](https://github.com/mudler)_

Run a slack bot, ideally for teams, which lets you ask questions on a documentation website, or a github repository.

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/slack-qa-bot/)

### Question answering on documents with llama-index

_by [@mudler](https://github.com/mudler)_

Shows how to integrate with [Llama-Index](https://gpt-index.readthedocs.io/en/stable/getting_started/installation.html) to enable question answering on a set of documents.

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/query_data/)

### Question answering on documents with langchain and chroma

_by [@mudler](https://github.com/mudler)_

Shows how to integrate with `Langchain` and `Chroma` to enable question answering on a set of documents.

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/langchain-chroma/)

### Telegram bot

_by [@mudler](https://github.com/mudler)

![Screenshot from 2023-06-09 00-36-26](https://github.com/go-skynet/LocalAI/assets/2420543/e98b4305-fa2d-41cf-9d2f-1bb2d75ca902)

Use LocalAI to power a Telegram bot assistant, with Image generation and audio support!

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/telegram-bot/)

### Template for Runpod.io

_by [@fHachenberg](https://github.com/fHachenberg)_

Allows to run any LocalAI-compatible model as a backend on the servers of https://runpod.io

[Check it out here](https://runpod.io/gsc?template=uv9mtqnrd0&ref=984wlcra)

### Continue

_by [@gruberdev](https://github.com/gruberdev)_

<img src="continue/img/screen.png" width="600" height="200" alt="Screenshot">

Demonstrates how to integrate an open-source copilot alternative that enhances code analysis, completion, and improvements. This approach seamlessly integrates with any LocalAI model, offering a more user-friendly experience.

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/continue/)

### Streamlit bot

_by [@majoshi1](https://github.com/majoshi1)_

![Screenshot](streamlit-bot/streamlit-bot.png)

A chat bot made using `Streamlit` & LocalAI.

[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/streamlit-bot/)

## Want to contribute?

Create an issue, and put `Example: <description>` in the title! We will post your examples here.
feat: config files and SSE (#83) Signed-off-by: mudler <mudler@mocaccino.org> Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> Co-authored-by: Tyler Gillson <tyler.gillson@gmail.com> 2023-04-27 04:18:18 +00:00			`# Examples`

examples: Update README 2023-08-06 21:07:06 +00:00			`\| [ChatGPT OSS alternative](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui) \| [Image generation](https://localai.io/api-endpoints/index.html#image-generation) \|`
			`\|------------------------------------------------------------------------------------------------------------------------\|------------------------------------------------------------------------------------------------------------------------\|`
			`\| ![Screenshot from 2023-04-26 23-59-55](https://user-images.githubusercontent.com/2420543/234715439-98d12e03-d3ce-4f94-ab54-2b256808e05e.png) \| ![b6441997879](https://github.com/go-skynet/LocalAI/assets/2420543/d50af51c-51b7-4f39-b6c2-bf04c403894c) \|`

			`\| [Telegram bot](https://github.com/go-skynet/LocalAI/tree/master/examples/telegram-bot) \| [Flowise](https://github.com/go-skynet/LocalAI/tree/master/examples/flowise) \|`
			`\|------------------------------------------------------------------------------------------------------------------------\|------------------------------------------------------------------------------------------------------------------------\|`
			`![Screenshot from 2023-06-09 00-36-26](https://github.com/go-skynet/LocalAI/assets/2420543/e98b4305-fa2d-41cf-9d2f-1bb2d75ca902) \| ![Screenshot from 2023-05-30 18-01-03](https://github.com/go-skynet/LocalAI/assets/2420543/02458782-0549-4131-971c-95ee56ec1af8)\| \|`

feat: config files and SSE (#83) Signed-off-by: mudler <mudler@mocaccino.org> Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> Co-authored-by: Tyler Gillson <tyler.gillson@gmail.com> 2023-04-27 04:18:18 +00:00			`Here is a list of projects that can easily be integrated with the LocalAI backend.`

examples: Update README 2023-08-06 21:07:06 +00:00
Update readme and examples 2023-05-06 17:15:22 +00:00			`### Projects`

docs(examples): add AutoGPT (#397) 2023-05-27 17:42:24 +00:00			`### AutoGPT`

			`_by [@mudler](https://github.com/mudler)_`

			`This example shows how to use AutoGPT with LocalAI.`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/autoGPT/)`
Update readme and examples 2023-05-06 17:15:22 +00:00
			`### Chatbot-UI`

			`_by [@mkellerman](https://github.com/mkellerman)_`

			`![Screenshot from 2023-04-26 23-59-55](https://user-images.githubusercontent.com/2420543/234715439-98d12e03-d3ce-4f94-ab54-2b256808e05e.png)`

			`This integration shows how to use LocalAI with [mckaywrigley/chatbot-ui](https://github.com/mckaywrigley/chatbot-ui).`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui/)`

examples: keep old example around (#439) 2023-05-30 16:34:43 +00:00			`There is also a separate example to show how to manually setup a model: [example](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui-manual/)`

example(k8sgpt): Add k8sgpt example (#631) Signed-off-by: mudler <mudler@localai.io> 2023-06-19 22:11:01 +00:00			`### K8sGPT`

			`_by [@mudler](https://github.com/mudler)_`

			`This example show how to use LocalAI inside Kubernetes with [k8sgpt](https://k8sgpt.ai).`

			`![Screenshot from 2023-06-19 23-58-47](https://github.com/go-skynet/go-ggml-transformers.cpp/assets/2420543/cab87409-ee68-44ae-8d53-41627fb49509)`

docs: add fine-tuning example (#1374) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> 2023-12-01 18:11:45 +00:00			`### Fine-tuning a model and convert it to gguf to use it with LocalAI`

			`_by [@mudler](https://github.com/mudler)_`

			`This example is an e2e example on how to fine-tune a model with [axolotl](https://github.com/OpenAccess-AI-Collective/axolotl) and convert it to gguf to use it with LocalAI.`

			`[Check it out here](https://github.com/mudler/LocalAI/tree/master/examples/e2e-fine-tuning/)`

examples: use gallery in chatbot-ui, add flowise (#438) Signed-off-by: mudler <mudler@mocaccino.org> 2023-05-30 16:29:28 +00:00			`### Flowise`

			`_by [@mudler](https://github.com/mudler)_`

			`This example shows how to use [FlowiseAI/Flowise](https://github.com/FlowiseAI/Flowise) with LocalAI.`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/flowise/)`

Update readme and examples 2023-05-06 17:15:22 +00:00			`### Discord bot`

			`_by [@mudler](https://github.com/mudler)_`

			`Run a discord bot which lets you talk directly with a model`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/discord-bot/), or for a live demo you can talk with our bot in #random-bot in our discord server.`

			`### Langchain`

			`_by [@dave-gray101](https://github.com/dave-gray101)_`

			`A ready to use example to show e2e how to integrate LocalAI with langchain`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/langchain/)`

			`### Langchain Python`

			`_by [@mudler](https://github.com/mudler)_`

			`A ready to use example to show e2e how to integrate LocalAI with langchain`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/langchain-python/)`

example(functions): Add OpenAI functions example (#767) 2023-07-17 22:04:21 +00:00			`### LocalAI functions`

			`_by [@mudler](https://github.com/mudler)_`

			`A ready to use example to show how to use OpenAI functions with LocalAI`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/functions/)`

Update readme and examples 2023-05-06 17:15:22 +00:00			`### LocalAI WebUI`

			`_by [@dhruvgera](https://github.com/dhruvgera)_`

			`![image](https://user-images.githubusercontent.com/42107491/235344183-44b5967d-ba22-4331-804c-8da7004a5d35.png)`

			`A light, community-maintained web interface for LocalAI`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/localai-webui/)`

			`### How to run rwkv models`

			`_by [@mudler](https://github.com/mudler)_`

			`A full example on how to run RWKV models with LocalAI`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/rwkv/)`

examples: add privateGPT example (#355) 2023-05-23 08:32:34 +00:00			`### PrivateGPT`

			`_by [@mudler](https://github.com/mudler)_`

			`A full example on how to run PrivateGPT with LocalAI`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/privateGPT/)`

Update readme and examples 2023-05-06 17:15:22 +00:00			`### Slack bot`

			`_by [@mudler](https://github.com/mudler)_`

			`Run a slack bot which lets you talk directly with a model`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/slack-bot/)`

example(slack-qa-bot): Add slack QA bot example (#654) Signed-off-by: mudler <mudler@localai.io> 2023-06-22 16:07:15 +00:00			`### Slack bot (Question answering)`

			`_by [@mudler](https://github.com/mudler)_`

			`Run a slack bot, ideally for teams, which lets you ask questions on a documentation website, or a github repository.`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/slack-qa-bot/)`

examples: add langchain-chroma example (#248) 2023-05-12 20:20:07 +00:00			`### Question answering on documents with llama-index`
Update readme and examples 2023-05-06 17:15:22 +00:00
			`_by [@mudler](https://github.com/mudler)_`

			`Shows how to integrate with [Llama-Index](https://gpt-index.readthedocs.io/en/stable/getting_started/installation.html) to enable question answering on a set of documents.`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/query_data/)`
feat: config files and SSE (#83) Signed-off-by: mudler <mudler@mocaccino.org> Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> Co-authored-by: Tyler Gillson <tyler.gillson@gmail.com> 2023-04-27 04:18:18 +00:00
examples: add langchain-chroma example (#248) 2023-05-12 20:20:07 +00:00			`### Question answering on documents with langchain and chroma`

			`_by [@mudler](https://github.com/mudler)_`

			Shows how to integrate with `Langchain` and `Chroma` to enable question answering on a set of documents.

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/langchain-chroma/)`

examples(telegram): add (#547) 2023-06-08 22:45:44 +00:00			`### Telegram bot`

			`_by [@mudler](https://github.com/mudler)`

			`![Screenshot from 2023-06-09 00-36-26](https://github.com/go-skynet/LocalAI/assets/2420543/e98b4305-fa2d-41cf-9d2f-1bb2d75ca902)`

			`Use LocalAI to power a Telegram bot assistant, with Image generation and audio support!`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/telegram-bot/)`

Added runpod.io template for LocalAI to examples (#203) 2023-05-07 08:58:15 +00:00			`### Template for Runpod.io`

			`_by [@fHachenberg](https://github.com/fHachenberg)_`

			`Allows to run any LocalAI-compatible model as a backend on the servers of https://runpod.io`

			`[Check it out here](https://runpod.io/gsc?template=uv9mtqnrd0&ref=984wlcra)`

Example: Continue (dev) (#940) 2023-08-22 16:46:45 +00:00			`### Continue`

			`_by [@gruberdev](https://github.com/gruberdev)_`

1038 - Streamlit bot with LocalAI (#1072) Description This PR fixes #1038 Added Streamlit example and also updated readme for examples. [Signed commits](../CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin) - [X] Yes, I signed my commits. <!-- Thank you for contributing to LocalAI! Contributing Conventions: 1. Include descriptive PR titles with [<component-name>] prepended. 2. Build and test your changes before submitting a PR. 3. Sign your commits By following the community's contribution conventions upfront, the review process will be accelerated and your PR merged more quickly. --> 2023-09-17 06:33:23 +00:00			`<img src="continue/img/screen.png" width="600" height="200" alt="Screenshot">`

Example: Continue (dev) (#940) 2023-08-22 16:46:45 +00:00			`Demonstrates how to integrate an open-source copilot alternative that enhances code analysis, completion, and improvements. This approach seamlessly integrates with any LocalAI model, offering a more user-friendly experience.`

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/continue/)`

1038 - Streamlit bot with LocalAI (#1072) Description This PR fixes #1038 Added Streamlit example and also updated readme for examples. [Signed commits](../CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin) - [X] Yes, I signed my commits. <!-- Thank you for contributing to LocalAI! Contributing Conventions: 1. Include descriptive PR titles with [<component-name>] prepended. 2. Build and test your changes before submitting a PR. 3. Sign your commits By following the community's contribution conventions upfront, the review process will be accelerated and your PR merged more quickly. --> 2023-09-17 06:33:23 +00:00			`### Streamlit bot`

			`_by [@majoshi1](https://github.com/majoshi1)_`

			`![Screenshot](streamlit-bot/streamlit-bot.png)`

			A chat bot made using `Streamlit` & LocalAI.

			`[Check it out here](https://github.com/go-skynet/LocalAI/tree/master/examples/streamlit-bot/)`

feat: config files and SSE (#83) Signed-off-by: mudler <mudler@mocaccino.org> Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> Co-authored-by: Tyler Gillson <tyler.gillson@gmail.com> 2023-04-27 04:18:18 +00:00			`## Want to contribute?`

docs: update example README.md (#104) 2023-04-27 15:46:14 +00:00			Create an issue, and put `Example: <description>` in the title! We will post your examples here.