Skip to content

Commit

Permalink
Auto-translate README
Browse files Browse the repository at this point in the history
  • Loading branch information
Continuous Integration committed Nov 2, 2023
1 parent e0ba45c commit e27d97a
Show file tree
Hide file tree
Showing 4 changed files with 162 additions and 199 deletions.
119 changes: 35 additions & 84 deletions README.Arabic.md
View file
Original file line number Diff line number Diff line change
@@ -1,106 +1,57 @@
# ChatGPT Line Bot
```markdown
# بوت ChatGPT Line

* [الإنجليزية](README.md)
* [النسخة باللغة الصينية التقليدية README.md](README.zh-TW.md)
* [الصينية البسيطة](README.zh-CN.md)
* [الصينية التقليدية](README.zh-TW.md)
* [الصينية المبسطة](README.zh-CN.md)
* [الفرنسية](README.French.md)
* [عربى](README.Arabic.md)

* [العربية](README.Arabic.md)

## مقدمة

في Line ، يمكنك إضافة ChatGPT Bot ببساطة عن طريق كتابة النصوص مباشرة في مربع الإدخال لبدء التفاعل مع ChatGPT.
لنقدم بوت ChatGPT في Line ، كل ما عليك فعله هو إدخال النص مباشرة في مربع الإدخال لبدء التفاعل مع ChatGPT.

<img src="img/2023-10-25-10-03-47.png" width="30%" />

## الأدوات والميزات

* `Python FastAPI`: إنشاء API استجابة ChatGPT
* `gpt4free`: **استخدام مجاني لخدمة OpenAI API**
* `Line messaging API channel`: تكامل مع API ChatGPT
* `Python FastAPI`: إنشاء واجهة برمجة تطبيقات ChatGPT
* `gpt4free`: **استخدام مجاني لواجهة برمجة تطبيقات OpenAI**
* `قناة واجهة الرسائل Line`: ربط واجهة برمجة تطبيقات ChatGPT
* `Github`: تخزين الشيفرة
* `replit`: **نشر مجاني لتطبيق FastAPI الخاص بك**
* `CronJob`: إرسال طلبات دورية مجانية لتجنب انقطاع الخدمة

* `replit`: **نشر مجاني لواجهة برمجة تطبيقات FastAPI الخاصة بك**
* `CronJob`: إرسال طلبات بانتظام مجاناً لتجنب انقطاع واجهة برمجة تطبيقات

## خطوات التثبيت

### الحصول على الرموز
### الحصول على الرمز المميز

1. الحصول على رمز Line:
1. قم بتسجيل الدخول إلى [Line Developer](https://developers.line.biz/zh-hant/)
2. إنشاء الروبوت:
1. إنشاء `مزود` -> انقر فوق `Create`
2. إنشاء `قناة` -> حدد `Create a Messaging API channel`
3. قم بإدخال المعلومات الأساسية الضرورية
4. بمجرد الانتهاء من الإدخال ، في الجزء السفلي من `Basic Settings` ، هناك `Channel Secret` -> انقر على `Issue` ، بعد ذلك سيتم توليد `LINE_CHANNEL_SECRET` (سيتم استخدامه قريبًا)
5. في `Messaging API` في الجزء السفلي ، هناك `Channel access token` -> انقر على `Issue` ، بعد ذلك سيتم توليد `LINE_CHANNEL_ACCESS_TOKEN` (سيتم استخدامه قريبًا)
1. احصل على رمز مميز Line:
1. تسجيل الدخول إلى [مطوري Line](https://developers.line.biz/zh-hant/)
2. إنشاء روبوت:
1. إنشاء مزود (Provider) -> انقر فوق "إنشاء"
2. إنشاء قناة (Channel) -> اختر "إنشاء قناة واجهة برمجة تطبيقات الرسائل"
3. أدخل المعلومات الأساسية المطلوبة بالكامل
4. بعد الانتهاء من الإدخال ، في أسفل "الإعدادات الأساسية"، ستجد "السر الخاص بالقناة" -> انقر فوق "إصدار" للحصول على "LINE_CHANNEL_SECRET" (ستحتاج إليها لاحقًا)
5. في "واجهة برمجة التراسل" أسفل الصفحة، ستجد "رمز الوصول للقناة" -> انقر فوق "إصدار" للحصول على "LINE_CHANNEL_ACCESS_TOKEN" (ستحتاج إليها لاحقًا)

### إعداد المشروع
1. إنشاء Fork لمشروع Github:
1. سجل الدخول / سجل الدخول إلى [GitHub](https://github.com/)
1. إنشاء نسخة من مشروع Github:
1. قم بالتسجيل / تسجيل الدخول إلى [GitHub](https://github.com/)
2. انتقل إلى [ChatGPT-Line-Bot](https://github.com/Lin-jun-xiang/ChatGPT-Line-Bot)
3. انقر على `Star` لدعم المطور
4. انقر على `Fork` لنسخ جميع الشيفرة إلى مستودعك
2. النشر (في مساحة مجانية):
3. انقر على "Star" لدعم المطور
4. انقر على "Fork" لنسخ جميع رموز المشروع إلى مستودعك الخاص
2. النشر (مساحة مجانية):
1. انتقل إلى [replit](https://replit.com/)
2. انقر فوق `Sign Up` وقم بتسجيل الدخول باستخدام حساب `Github` الخاص بك ومن ثم قم بالتفويض -> انقر فوق `Skip` لتجاوز الإعداد الأولي
3. بمجرد الوصول ، انقر على `Create` في الوسط -> انقر على `Import from Github` في الزر الأيمن العلوي
4. إذا لم تكن قد قمت بإضافة مستودع Github بعد ، انقر على الارتباط `Connect GitHub to import your private repos.` -> حدد `Only select repositories` -> اختر `ChatGPT-Line-Bot`
5. عد إلى الخطوة الرابعة ، في هذا الوقت يمكنك اختيار `ChatGPT-Line-Bot` في المشروع URL أعلاه -> انقر فوق `Import from Github`.
2. انقر على "Sign Up" وقم بتسجيل الدخول باستخدام حسابك في Github ومنح الإذن -> انقر على "Skip" لتخطي الإعداد الأولي
3. بمجرد الدخول، انقر على "Create" في الصفحة الرئيسية في الجزء الأوسط -> سيظهر نافذة منبثقة، انقر على "Import from Github" في الزاوية اليمنى العلوية
4. إذا لم تكن قد قمت بإضافة مستودع Github بعد، انقر على الرابط "Connect GitHub to import your private repos." -> حدد "Only select repositories" -> اختر "ChatGPT-Line-Bot"
5. ارجع إلى الخطوة الرابعة، في هذا الوقت، يمكنك اختيار "ChatGPT-Line-Bot" كمشروع Github URL -> انقر فوق "Import from Github".

### تشغيل المشروع
1. تكوين المتغيرات البيئية
1. بعد الانتهاء من الخطوة السابقة ، انتقل إلى `Secrets` في أسفل الشاشة في صفحة إدارة المشروع الرئيسية في `Replit`.
2. بعد النقر فوق `Got it` على اليمين ، يمكنك إضافة متغيرات البيئة ، والتي يجب أن تتضمن:
1. Line Channel Secret:
- key: `LINE_CHANNEL_SECRET`
- value: `[الذي تم الحصول عليه في الخطوة الأولى]`
2. Line Channel Access Token:
- key: `LINE_CHANNEL_ACCESS_TOKEN`
- value: `[الذي تم الحصول عليه في الخطوة الأولى]`

<img src="img/2023-10-25-10-00-59.png" width="60%" />

2. بدء التشغيل
1. انقر فوق `Run` في الأعلى
2. بمجرد النجاح ، ستظهر `Hello World` في الزاوية العليا اليمنى للشاشة ، ويمكنك نسخ العنوان في الأعلى للتو
3. عد إلى Line Developer ، وفي `Messaging API` في الجزء السفلي ، يمكنك لصق العنوان الذي نسخته مع إضافة `/callback` مثل: `https://ChatGPT-Line-Bot.jimmylin.repl.co/callback`
4. قم بتمكين `Use webhook` من الأسفل
5. قم بإيقاف تشغيل `Auto-reply messages`
- ملاحظة: إذا لم يتم استلام أي طلب في ساعة واحدة ، سيؤدي ذلك إلى إيقاف تشغيل البرنامج ، لذا يجب إتباع الخطوات التالية

<img src="img/2023-10-25-10-01-21.png" width="60%" />

3. CronJob إرسال طلبات دورية
1. سجل الدخول / سجل الدخول إلى [cron-job.org](https://cron-job.org/en/)
2. بعد الدخول ، انتقل إلى الجهة العليا اليمنى واختر `CREATE CRONJOB`
3. قم بإدخال `Title` ChatGPT-Line-Bot` ، وأدخل العنوان الذي نسخته في الخطوة السابقة ، مثل: `https://ChatGPT-Line-Bot.jimmylin.repl.co/`
4. في الأسفل ، اضغط على كل `5 دقائق` مرة واحدة
5. انقر فوق `CREATE`

### ربط الخدمة بـ Line Bot

ارجع إلى [Line Developer](https://manager.line.biz/account) الصفحة الرئيسية وانقر على `دليل إضافة الأصدقاء` ، ثم قم بمسح رمز الاستجابة السريعة للانضمام إلى LINE Bot:

الصفحة الرئيسية -> انقر على bot الخاص بك -> انقر على أدوات زيادة الأصدقاء -> إنشاء رمز استجابة سريعة للأصدقاء (https://manager.line.biz/account/<yourBotId>/gainfriends)

تهانينا! لقد أكملت أول LINE Bot خاص بك! جرب التحدث معه وشاهد كيف يرد عليك!

### تقدم - تخصيص الروبوت

بالإضافة إلى ذلك ، يمكننا استخدام الطريقة `prompt` للسماح لـ Line Bot بالرد بطريقة شخصية ، في `./chatgpt_linebot/prompts/template.py` يمكننا تعريف `template` ، مثل:

<img src="img/2023-10-27-10-09-17.png" width="60%" />

**سؤال**: ماذا تأكل في الفطور اليوم؟

**رد الروبوت**: حبيبي ، هل استيقظت صباح اليوم؟ لقد كنت في السرير في انتظارك ، أشعر بالجوع عند التفكير في جسمك الجميل. ماذا يجب أن أتناول في الفطور اليوم؟ هل يجب أن أحضر لك بيض مقلي حار ، مثل لياقتك الجسدية المثيرة؟ 😏🍳

---

## المراجع

[Line_Bot_Tutorial](https://github.com/FawenYo/LINE_Bot_Tutorial)

[ChatGPT-Line-Bot](https://github.com/TheExplainthis/ChatGPT-Line-Bot)
1. تكوين متغيرات البيئة
1. بعد الانتهاء من الخطوة السابقة "Import" في Replit، انتقل إلى الزاوية السفلى اليسرى لصفحة إدارة المشروع وانقر على "Secrets".
2. بعد النقر على "Got it" على اليمين، يمكنك الآن إضافة متغيرات البيئة. يجب أن تضيف:
1. السر الخاص بالقناة Line:
- المفتاح: "LINE_CHANNEL_SECRET"
- القيمة: "[الحصول عليها من الخط
72 changes: 41 additions & 31 deletions README.French.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@

## Introduction

Integrate ChatGPT Bot in Line by simply entering text in the input box to start interacting with ChatGPT.
Integrate ChatGPT Bot into Line, simply enter text in the input box to start interacting with ChatGPT.

<img src="img/2023-10-25-10-03-47.png" width="30%" />

## Tools and Features

* `Python FastAPI`: Create ChatGPT response API
* `gpt4free`: **Free to use OpenAI API**
* `gpt4free`: **Use OpenAI API for free**
* `Line messaging API channel`: Connect to ChatGPT API
* `Github`: Store the code
* `replit`: **Free deployment of your own FastAPI**
* `CronJob`: Free scheduled requests to prevent API interruption
* `replit`: **Deploy your own FastAPI for free**
* `CronJob`: Send requests periodically for free to prevent API interruption


## Installation Steps
Expand All @@ -30,72 +30,82 @@ Integrate ChatGPT Bot in Line by simply entering text in the input box to start
1. Get Line Token:
1. Log in to [Line Developer](https://developers.line.biz/zh-hant/)
2. Create a bot:
1. Create `Provider` -> Click `Create`
2. Create `Channel` -> Choose `Create a Messaging API channel`
1. Create `Provider` -> click `Create`
2. Create `Channel` -> choose `Create a Messaging API channel`
3. Fill in the required basic information
4. After filling in, under `Basic Settings`, there is a `Channel Secret` -> Click `Issue`, and the generated value is `LINE_CHANNEL_SECRET` (will be used later)
5. Under `Messaging API`, there is a `Channel access token` -> Click `Issue`, and the generated value is `LINE_CHANNEL_ACCESS_TOKEN` (will be used later)
4. After completing the input, under `Basic Settings`, there is a `Channel Secret` -> click `Issue`, the generated value is `LINE_CHANNEL_SECRET` (will be used later)
5. Under `Messaging API`, there is a `Channel access token` -> click `Issue`, the generated value is `LINE_CHANNEL_ACCESS_TOKEN` (will be used later)

### Project Setup
1. Fork the Github project:
1. Register/Log in to [GitHub](https://github.com/)
1. Register/Login to [GitHub](https://github.com/)
2. Go to [ChatGPT-Line-Bot](https://github.com/Lin-jun-xiang/ChatGPT-Line-Bot)
3. Click `Star` to support the developer
4. Click `Fork` to copy all the code to your own repository
2. Deployment (Free Space):
2. Deployment (free space):
1. Go to [replit](https://replit.com/)
2. Click `Sign Up` to log in with your `Github` account and authorize it -> Click `Skip` to skip the initial setup
3. On the main page in the middle, click `Create` -> A pop-up window will appear, click the top-right corner `Import from Github`
4. If you haven't added the Github repository, click the link `Connect GitHub to import your private repos.` -> Check `Only select repositories` -> Choose `ChatGPT-Line-Bot`
5. Go back to step four, at this time, the `Github URL` can choose the `ChatGPT-Line-Bot` project -> Click `Import from Github`.
2. Click `Sign Up` to login with your `Github` account and authorize it -> click `Skip` to skip the initial setup
3. After logging in, click `Create` on the main page in the middle -> a pop-up box will appear, click `Import from Github` in the top right corner
4. If you haven't added your Github repository, click the link `Connect GitHub to import your private repos.` -> check `Only select repositories` -> choose `ChatGPT-Line-Bot`
5. Go back to step 4, at this point, you can choose the `ChatGPT-Line-Bot` project for `Github URL` -> click `Import from Github`.

### Project Execution
1. Environment Variable Setup
1. After completing the previous `Import` step, click `Tools` at the bottom left of the project management page in `Replit` and click `Secrets`.
2. After clicking `Got it` on the right, you can add environment variables. You need to add:
1. Environment variable configuration
1. After completing the previous step of `Import` in `Replit`, click `Tools` at the bottom left corner of the project management page.
2. After clicking `Got it` on the right side, you can add environment variables, you need to add:
1. Line Channel Secret:
- key: `LINE_CHANNEL_SECRET`
- value: `[Obtained from step one]`
- value: `[obtained from step 1]`
2. Line Channel Access Token:
- key: `LINE_CHANNEL_ACCESS_TOKEN`
- value: `[Obtained from step one]`
- value: `[obtained from step 1]`

<img src="img/2023-10-25-10-00-59.png" width="60%"/>

2. Start Execution
2. Start execution
1. Click `Run` at the top
2. After successful execution, the right panel will display `Hello World`, and copy the URL in the upper right corner of the panel
3. Go back to Line Developer, in `Messaging API`, paste the above URL in `Webhook URL`, and add `/callback` to it, for example: `https://ChatGPT-Line-Bot.jimmylin.repl.co/callback`
2. After successful execution, the right side of the screen will display `Hello World`, and copy the **URL** at the top of the screen
3. Go back to Line Developer, in `Messaging API`, paste the URL from the previous step, and add `/callback` to it, for example: `https://ChatGPT-Line-Bot.jimmylin.repl.co/callback`
4. Turn on `Use webhook`
5. Turn off `Auto-reply messages` below
- Note: If there are no requests within an hour, the program will be interrupted, so the next step is needed

<img src="img/2023-10-25-10-01-21.png" width="60%"/>

3. CronJob Scheduled Requests
1. Register/Log in to [cron-job.org](https://cron-job.org/en/)
2. After logging in, choose `CREATE CRONJOB` at the top right of the panel
3. CronJob for periodic requests
1. Register/Login to [cron-job.org](https://cron-job.org/en/)
2. After logging in, choose `CREATE CRONJOB` in the upper right corner of the dashboard
3. Enter `ChatGPT-Line-Bot` for `Title`, enter the URL from the previous step, for example: `https://ChatGPT-Line-Bot.jimmylin.repl.co/`
4. Set it to run every `5 minutes` below
5. Click `CREATE`

### Connect Services and Line Bot
### Connect Service and Line Bot

Go back to [Line Developer](https://manager.line.biz/account) homepage and click `Add Friend Guide` to scan and add the LINE Bot:
Go back to [Line Developer](https://manager.line.biz/account) homepage and click `Add friend guide` to scan the LINE Bot QR code:

Homepage -> Click on your bot -> Click `Add Friend Tools` -> Create Friend QR Code (https://manager.line.biz/account/<yourBotId>/gainfriends)
Homepage -> Click your bot -> Click `Add friend tools` -> Create friend action barcode (https://manager.line.biz/account/<yourBotId>/gainfriends)

Congratulations on creating your first LINE Bot! Try talking to it and it will reply to you!

### Special Commands

| Command | Description |
| --- | ----- |
| `@chat` | Enter `@chat` + message in the input box to call chatgpt in the Line group |
| `@chat 星座運勢 <星座名稱>` | Enter `@chat 星座運勢 天蠍座` in the input box to get the weekly horoscope for Scorpio (any constellation can be used), this function is only available in Traditional Chinese |



### Advanced - Personalized Bot

In addition, we can make the Line Bot answer more personalized by using the `prompt` method. In `./chatgpt_linebot/prompts/template.py`, we can define a `template`, for example:
In addition, we can use the `prompt` method to allow the Line Bot to provide personalized answers. In `./chatgpt_linebot/prompts/template.py`, we can define `template`, for example:

<img src="img/2023-10-27-10-09-17.png" width="60%" />

**Question**: What did you have for breakfast today?
**Question**: What should I have for breakfast today?

**Bot's answer**: Darling, are you awake this morning? I've been waiting for you in bed, and thinking about your body makes me hungry. What should we have for breakfast today? How about some spicy scrambled eggs, as hot as your charming figure? 😏🍳

**Bot Answer**: Darling, are you awake yet? I've been waiting for you in bed and I'm feeling so hungry just thinking about your body. What should we have for breakfast today? How about some spicy scrambled eggs, as hot as your charming figure? 😏🍳

---

Expand Down
Loading

0 comments on commit e27d97a

Please sign in to comment.