telitairos-bot 0.2.0

A fully funcional AI Powered assistant Telegram Bot
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

<div align="center">
  <a href="https://imgbb.com/"><img src="https://i.ibb.co/5kmL1Yj/photo-2024-04-08-10-51-03-removebg-preview.png" alt="photo-2024-04-08-10-51-03-removebg-preview" border="0" width="200"></a>
  <h1><code>Telitairos Bot</code></h1>
  <a href="https://docs.rs/telitairos-bot/">
    <img src="https://docs.rs/telitairos-bot/badge.svg">
  </a>
   <a href="https://github.com/SharliBeicon/telitairos-bot/actions/workflows/rust.yml">
    <img src="https://github.com/SharliBeicon/telitairos-bot/actions/workflows/rust.yml/badge.svg">
  </a>
  <a href="https://crates.io/crates/telitairos-bot">
    <img src="https://img.shields.io/crates/v/telitairos-bot.svg">
  </a>
</br>

   A fully functional AI Powered Telegram bot.

 🦀  
</div>

## Setup guide
1. Install Rust with [rustup](http://rustup.rs/).
2. Create a Telegram bot with [@BotFather](https://t.me/botfather) and get the token
3. Create an [OpenAI API Platform account](https://openai.com/api/) and get both API Token and Organization Id
4. Add environment variables
```bash
- TELOXIDE_TOKEN= "/* Your Telegram Bot API Key */"
- OPENAI_API_KEY= "/* Your OpenAI API Key */"
- OPENAI_ORG_ID= "/* Your OpenAI Organization ID */"
```
5. Put these lines into your Cargo.toml
```toml
[dependencies]
telitairos-bot = "0.1.2"
teloxide = { version = "0.12", features = ["macros"] }
log = "0.4"
pretty_env_logger = "0.4"
tokio = { version =  "1.8", features = ["rt-multi-thread", "macros"] }
```

## Supported commands
You can do either:

### 👮🚨 ADMIN Commands
- `/mute X {h/m/s/p}` -> Mute an User from the Chat Group the selected time. 'p' is for 'permanent'
- `/ban X {h/m/s/p}` -> Ban an User from the Chat Group the selected time. 'p' is for 'permanent'
### 🦀 AI Commands
- `/ask` for a specified question.
- `/mediate` to read the last N messages of a chat group and mitigate an argument.


## Basic usage

TelitairoBot struct implements Default trait, so you can start a bot with a generic personality
by just doing this:

```rust
let telitairo_bot = TelitairoBot::default();
```

Or partially initialize it like this:

```rust
let telitairo_bot = TelitairoBot {
  personality: String::from("You are a Victorian era, tea addicted assistant"),
  ..Default::default(),
}
```

If you want to set your own parameters, you need to specify the personality of the bot as well as its criteria when mitigating an argument.
A size for the context of the N last messages of the chat group is also needed.

For a detailed example go to [TelitairoBot](https://docs.rs/telitairos-bot/latest/telitairos_bot/struct.TelitairoBot.html)
### Example

```rust
#[tokio::main]
async fn main() {
   pretty_env_logger::init();
   log::info!("Starting bot");

   let telitairo_bot = TelitairoBot::new(
       String::from(/*Personality */),
       String::from(/* Mediation criteria */),
       /*size */,
   );

   telitairo_bot.dispatch().await;
}