Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aitorllj93/the-artificial-agent
GPT powered personal assistant running on Telegram
https://github.com/aitorllj93/the-artificial-agent
gpt obsidian-md telegram-bot
Last synced: 7 days ago
JSON representation
GPT powered personal assistant running on Telegram
- Host: GitHub
- URL: https://github.com/aitorllj93/the-artificial-agent
- Owner: aitorllj93
- Created: 2023-02-05T23:52:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-17T20:32:01.000Z (about 1 year ago)
- Last Synced: 2024-05-01T17:49:04.513Z (8 months ago)
- Topics: gpt, obsidian-md, telegram-bot
- Language: Python
- Homepage:
- Size: 1.15 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The Artificial Agent
Telegram bot that uses OpenAI's GPT-3 to generate responses to your messages with personality and personal assistant capabilities.
In Obsidian:
## Features
- Answers to your messages with [configurable](https://github.com/aitorllj93/the-artificial-agent/blob/main/config/config.example.yml) personality.
- Adds notes to your [Digital Brain (Obsidian)](#obsidian).
## Roadmap
- LangChain & LlamaIndex integration.
- Integrate with ChatGPT API once it is released.
- Calendar meetings reminders.
- Mail notifications.
- Todo list.
- Digital Brain queries with gpt_index.
## Getting Started
### Prerequisites
- [Python v3.8](https://www.python.org/downloads/)
** For Node.js version (unmaintained) check the [nodejs branch](https://github.com/aitorllj93/the-artificial-agent/nodejs) **
### Installing
1. Clone the repo
```sh
git clone https://github.com/aitorllj93/the-artificial-agent.git
```
2. Install NPM packages
```sh
pip install -r requirements.txt
```
### Configuration
1. Create a `config.yml` inside the config folder. You can use the `config.example.yml` as a template.
2. Add your Telegram bot token and (optionally) the Telegram chat id you will use. You can get your token [here](https://t.me/BotFather).
3. Add your OpenAI API key. You can get your key [here](https://platform.openai.com/account/api-keys).
### Usage
1. Run the bot
```sh
yarn start
```
2. Send a message to your bot and wait for the response. (/start will be ignored)
### Integrations
#### [Obsidian](https://obsidian.md/)
##### Daily Notes
- Every time you ask the assistant to add a note, it will include it in your daily notes file. You can configure the path to your daily notes file in the config file.