2023-04-27 04:18:18 +00:00
# Examples
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 )| |
2023-04-27 04:18:18 +00:00
Here is a list of projects that can easily be integrated with the LocalAI backend.
2023-08-06 21:07:06 +00:00
2023-05-06 17:15:22 +00:00
### Projects
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/ )
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/ )
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/ )
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 )
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/ )
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/ )
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/ )
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/ )
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/ )
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/ )
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/ )
2023-05-12 20:20:07 +00:00
### Question answering on documents with llama-index
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/ )
2023-04-27 04:18:18 +00:00
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/ )
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/ )
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 )
2023-04-27 04:18:18 +00:00
## Want to contribute?
2023-04-27 15:46:14 +00:00
Create an issue, and put `Example: <description>` in the title! We will post your examples here.