D
D
Documentation
Release
Search
K

Enabling file upload for your bot

The Poe API allows your bot to takes files as input. This means that your bot can do more interesting things than what would be possible using chat input alone. As part of this tutorial, we will create a very simple chatbot that takes in a pdf input and computes the number of pages in the pdf for the user. To enable file upload, you have to override get_settings and set the parameter called allow_attachments to True.
async def get_settings(self, setting: fp.SettingsRequest) -> fp.SettingsResponse:
return fp.SettingsResponse(allow_attachments=True)
Poe uploads any attachments provided by the user to its storage and passes the url of the file along with other metadata such as name and type to the bot server. We will utilize a python library called pypdf2 (which you can install using pip install pypdf2) to parse the pdf and count the number of pages. We will use the requests library (which you can install using pip install requests) to download the file.
def _fetch_pdf_and_count_num_pages(url: str) -> int:
response = requests.get(url)
if response.status_code != 200:
raise FileDownloadError()
with open("temp_pdf_file.pdf", "wb") as f:
f.write(response.content)
reader = PdfReader("temp_pdf_file.pdf")
return len(reader.pages)
Now we will set up a bot class that will iterate through the user messages and identify the latest pdf file to compute the number of pages for.
class PDFSizeBot(fp.PoeBot):
async def get_response(
self, request: fp.QueryRequest
) -> AsyncIterable[fp.PartialResponse]:
for message in reversed(request.query):
for attachment in message.attachments:
if attachment.content_type == "application/pdf":
try:
num_pages = _fetch_pdf_and_count_num_pages(attachment.url)
yield fp.PartialResponse(text=f"{attachment.name} has {num_pages} pages")
except FileDownloadError:
yield fp.PartialResponse(text="Failed to retrieve the document.")
return
The final code (including the setup code you need to host this on Modal) that goes into your main.py is as follows:
from __future__ import annotations
from typing import AsyncIterable
import requests
from PyPDF2 import PdfReader
import fastapi_poe as fp
from modal import Image, Stub, asgi_app
class FileDownloadError(Exception):
pass
def _fetch_pdf_and_count_num_pages(url: str) -> int:
response = requests.get(url)
if response.status_code != 200:
raise FileDownloadError()
with open("temp_pdf_file.pdf", "wb") as f:
f.write(response.content)
reader = PdfReader("temp_pdf_file.pdf")
return len(reader.pages)
class PDFSizeBot(fp.PoeBot):
async def get_response(
self, request: fp.QueryRequest
) -> AsyncIterable[fp.PartialResponse]:
for message in reversed(request.query):
for attachment in message.attachments:
if attachment.content_type == "application/pdf":
try:
num_pages = _fetch_pdf_and_count_num_pages(attachment.url)
yield fp.PartialResponse(text=f"{attachment.name} has {num_pages} pages")
except FileDownloadError:
yield fp.PartialResponse(text="Failed to retrieve the document.")
return
async def get_settings(self, setting: fp.SettingsRequest) -> fp.SettingsResponse:
return fp.SettingsResponse(allow_attachments=True)
REQUIREMENTS = ["fastapi-poe==0.0.24", "PyPDF2==3.0.1", "requests==2.31.0"]
image = Image.debian_slim().pip_install(*REQUIREMENTS)
stub = Stub("pdf-counter-poe")
@stub.function(image=image)
@asgi_app()
def fastapi_app():
bot = PDFSizeBot()
app = fp.make_app(bot, allow_without_key=True)
return app
To learn how to setup Modal, please follow Steps 1 and 2 in our Quick start. If you already have Modal set up, simply run modal deploy main.py. Modal will then deploy your bot server to the cloud and output the server url. Use that url when creating a server bot on Poe. Once your bot is up, update your bot's settings (one time only after you override get_settings) by following this guide. That's it, your bot is now ready.