This is the companion repository to the Poe server bot quick start. Please follow that guide for instructions on how to use this repository.
#AddedFromPage. Saved you a click. - Cybersooulja
In this quick start guide, we will build a bot server in Python and then integrate it with Poe. Once you have created a Poe bot powered by your server, any Poe user can interact with it. The following diagram might be useful in visualizing how your bot server fits into Poe. For more information on Poe server bots, check out the . Deploying your bot We recommend using to deploy your bot, but you can also use any cloud provider of your choice; all you need to do is to make the bot server available at a publicly available URL and once you have that, you can skip to . In order to use Modal to deploy your bot, do the following. Step 1: Install the Modal client Make sure you have Python installed. Open a terminal and run pip install modal-client You might have to use pip3 instead of pip depending on your version of Python. Step 2: Setup your Modal token This step involves setting up access to modal from your terminal. You only need to do this once for your computer. In the terminal, run modal token new --source poe. If you run into a "command not found" error, try . If that command runs successfully, you will taken to your web browser where you will be asked to log into modal using your Github account. After you login, click on "create token". You will be prompted to close the browser window after that. Step 3: Clone the starter code and deploy to Modal In your terminal, run: git clone https://github.com/poe-platform/server-bot-quick-start cd server-bot-quick-start pip install -r requirements.txt modal deploy main.py Modal will now deploy your app and output two urls: a) the endpoint at which your app is hosted b) an internal page where you can monitor your app. You will be using the former to integrate your bot into Poe. Integrating with Poe Once you have a bot running under a publicly accessible URL, it is time to connect it to Poe. You can do that on your desktop by going to the bot creation . You can customize how your bot looks by providing a picture, name and description. After you fill out the server URL and click "create bot", your bot should be ready for use on all Poe clients. Iterating on your bot For faster iteration on your bot, we recommend using modal serve main.py. On running that command, Modal will deploy an ephemeral version of your app which live updates in response to any code change. In addition, any print/debug statements will output to your terminal. Feel free to comment/uncomment any of the other example bots in main.py to try them out or build off of them. Where to go from here One of the advantages of building a bot on Poe is the ability to invoke other Poe bots. In order to learn how to do that check out: . Check out other detailed guides that show you how to enable specific features Refer to the to understand the full capabilities offered by Poe server bots. Check out the library, which you can use as a base for creating Poe bots.
Welcome to the Poe server bot quick start. This repository serves as a companion to our tutorial and contains starter code that allows you to quickly get a bot running. The following are some of the examples included in this repo. Note that the starter code assumes you have Modal setup for deployment (the instructions for which are described in the aforementioned tutorial)
This bot simply repeats the user's query in the response and provides a good starting
point to build any type of bot. To deploy, run modal deploy echobot.py
A correct implementation would look like https://poe.com/EchoBotDemonstration
- This bot responds to the user's query using GPT-3.5-Turbo. It demonstrates how to use
the Poe platform to cover the inference costs for your chatbot. To deploy, run
modal deploy turbo_allcapsbot.py. - Before you are able to use the bot, you also need to synchronize the bot's settings with the Poe Platform, the instructions for which are specified here.
A correct implementation would look like https://poe.com/AllCapsBotDemo
A sample bot that demonstrates the Markdown capabilities of the Poe API. To deploy, run
modal deploy catbot/__init__.py
A correct implementation would look like https://poe.com/CatBotDemo
A bot that demonstrates how to render an image in the response using Markdown. To
deploy, run modal deploy image_response_bot.py
A correct implementation would look like https://poe.com/ImageResponseBotDemo
- A bot that demonstrates how to enable file upload for the users of your bot.
- Before you are able to use the bot, you also need to synchronize the bot's settings with the Poe Platform, the instructions for which are specified here.
- To deploy, run
modal deploy pdf_counter_bot.py
A correct implementation would look like https://poe.com/PDFCounterBotDemo
- A bot that demonstrates how to attach files to your bot response. This example specifically uses video, but outputting other file types is fairly similar.
- Before you are able to use this bot, you do need to set your access key. You can get yours from the create bot page.
- To deploy, run
modal deploy video_bot.py
- A bot that demonstrates how to use the Poe API for function calling.
- Before you are able to use the bot, you also need to synchronize the bot's settings with the Poe Platform, the instructions for which are specified here.
- To deploy, run
modal deploy function_calling_bot.py
Provides an example of how to access HTTP request information in your bot. To deploy,
run modal deploy http_request_bot.py
Provides an example of a bot powered by a model hosted on HuggingFace. To deploy, run
modal deploy huggingface_bot.py
Provides an example of a bot powered by Langchain. This bot requires you to provide your
OpenAI key. To deploy, run modal deploy langchain_openai.py
- This is a more advanced example that demonstrates how to render output in realtime
comparing two different bots. To deploy, run
modal deploy turbo_vs_claude.py - Before you are able to use the bot, you also need to synchronize the bot's settings with the Poe Platform, the instructions for which are specified here.
A correct implementation would look like https://poe.com/TurboVsClaudeBotDemo