add a cookbook for ChatGPT Bot #961
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
localvar
reviewed
Mar 17, 2023
doc/cookbook/chatgpt-bot.md
Outdated
| Since the bot needs to receive Telegram message notifications and call third-party APIs, we must prepare the following in advance: | ||
|
|
||
| * Install the latest version of Easegress according to [this document](https://github.com/megaease/easegress#setting-up-easegress) and make sure that external applications can access the Easegress instance on at least one of ports 80, 88, 443, or 8443. | ||
| * Create a Telegram bot by following [this document](https://core.telegram.org/bots#3-how-do-i-create-a-bot), set its name (EaseTranslateBot is used in this article), write down its token, and [set up a Webhook](https://core.telegram.org/bots/api#setwebhook) that points to the Easegress instance installed in the previous step. Our bot will receive notifications of new messages through this Webhook. |
There was a problem hiding this comment.
The bot is not for translation, so better use another name instead of EaseTranslateBot.
doc/cookbook/chatgpt-bot.md
Outdated
|
|
||
| ## 1. Prerequisites | ||
|
|
||
| Since the bot needs to receive Telegram message notifications and call third-party APIs, we must prepare the following in advance: |
There was a problem hiding this comment.
Suggested change
| Since the bot needs to receive Telegram message notifications and call third-party APIs, we must prepare the following in advance: | |
| Since the bot needs to receive Telegram message notifications and call ChatGPT APIs, we must prepare the following in advance: |
doc/cookbook/chatgpt-bot.md
Outdated
|
|
||
| Before reading this article, please read the [Multiple API Orchestration](./translation-bot.md) article to ensure understanding of Easegress API orchestration and Telegram robot. | ||
|
|
||
| In this article, we will introduce how to build a Telegram ChatGPT robot with Easegress. This robot can generate a response based on the user's input. |
There was a problem hiding this comment.
Both bot and robot are used in this article, per telegram, we should only use bot.
doc/cookbook/chatgpt-bot.md
Outdated
| @@ -0,0 +1,190 @@ | |||
| # Build A Telegram ChatGPT Bot With Easegress | |||
|
|
|||
| Before reading this article, please read the [Multiple API Orchestration](./translation-bot.md) article to ensure understanding of Easegress API orchestration and Telegram robot. | |||
There was a problem hiding this comment.
Suggested change
| Before reading this article, please read the [Multiple API Orchestration](./translation-bot.md) article to ensure understanding of Easegress API orchestration and Telegram robot. | |
| Before reading this article, please read the [Multiple API Orchestration](./translation-bot.md) article to ensure an understanding of Easegress API orchestration and Telegram robot. |
doc/cookbook/chatgpt-bot.md
Outdated
|
|
||
| ## 3. Pipeline | ||
|
|
||
| First, let's check the overall flow that Pipeline orchestrates: |
There was a problem hiding this comment.
Suggested change
| First, let's check the overall flow that Pipeline orchestrates: | |
| First, let's check the overall flow of the Pipeline: |
doc/cookbook/chatgpt-bot.md
Outdated
|
|
||
| ### 4.1 Backend Proxies | ||
|
|
||
| We need to create two proxies to send requests to the ChatGPT API and Telegram API. The configuration of the two proxies is as follows: |
There was a problem hiding this comment.
Suggested change
| We need to create two proxies to send requests to the ChatGPT API and Telegram API. The configuration of the two proxies is as follows: | |
| We need to create two proxies to send requests to the ChatGPT API server and the Telegram API server. The configuration of the two proxies is as follows: |
doc/cookbook/chatgpt-bot.md
Outdated
|
|
||
| ### 4.2 Check and Extract Text | ||
|
|
||
| The processing details is consistent with that in [Multiple API Orchestration](./translation-bot.md) and will not be described again. |
There was a problem hiding this comment.
Suggested change
| The processing details is consistent with that in [Multiple API Orchestration](./translation-bot.md) and will not be described again. | |
| The processing details are the same as that in [Multiple API Orchestration](./translation-bot.md). |
doc/cookbook/chatgpt-bot.md
Outdated
|
|
||
| ### 4.3 Send Request to ChatGPT | ||
|
|
||
| Build a request to send to the ChatGPT API. See more details in [OpenAI API](https://platform.openai.com/docs/guides/chate). Make sure to replace the `{Your OpenAI API Key}` with your own API key. |
There was a problem hiding this comment.
Suggested change
| Build a request to send to the ChatGPT API. See more details in [OpenAI API](https://platform.openai.com/docs/guides/chate). Make sure to replace the `{Your OpenAI API Key}` with your own API key. | |
| Build a request to send to ChatGPT. See more details in [OpenAI API](https://platform.openai.com/docs/guides/chate). Make sure to replace the `{Your OpenAI API Key}` with your own API key. |
localvar
approved these changes
Mar 17, 2023
grootpiano
reviewed
Mar 17, 2023
doc/cookbook/chatgpt-bot.md
Outdated
|
|
||
| ### 4.3 Send Request to ChatGPT | ||
|
|
||
| Build a request to send to ChatGPT. See more details in [OpenAI API](https://platform.openai.com/docs/guides/chate). Make sure to replace the `{Your OpenAI API Key}` with your own API key. |
There was a problem hiding this comment.
Suggested change
| Build a request to send to ChatGPT. See more details in [OpenAI API](https://platform.openai.com/docs/guides/chate). Make sure to replace the `{Your OpenAI API Key}` with your own API key. | |
| Build a request to send to ChatGPT. See more details in [OpenAI API](https://platform.openai.com/docs/guides/chat). Make sure to replace the `{Your OpenAI API Key}` with your own API key. |
suchen-sci
approved these changes
Mar 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a cookbook for ChatGPT Bot