fix: update poe bot creation docs (#500)

This commit is contained in:
Taranjeet Singh
2023-08-28 11:29:34 -07:00
committed by GitHub
parent fc633dadeb
commit b0ae3e95c7

View File

@@ -10,22 +10,28 @@ title: '🔮 Poe Bot'
pip install embedchain[poe] pip install embedchain[poe]
``` ```
2. Create a free account on [Poe](https://www.poe.com). 2. Create a free account on [Poe](https://www.poe.com?utm_source=embedchain).
3. Click "create bot". 3. Click "Create Bot" button on top left
4. Give it a handle and an optional description. 4. Give it a handle and an optional description.
5. Select `Use API`. 5. Select `Use API`.
6. Under `API URL` enter your server or ngrok address. You can use your machine's public IP or DNS. Otherwise, employ a proxy server like [ngrok](https://ngrok.com/) to make your local bot accessible. 6. Under `API URL` enter your server or ngrok address. You can use your machine's public IP or DNS. Otherwise, employ a proxy server like [ngrok](https://ngrok.com/) to make your local bot accessible.
7. Copy your api key and paste it in `.env` as `POE_API_KEY`. 7. Copy your api key and paste it in `.env` as `POE_API_KEY`.
8. Start the bot. 8. Start the bot.
```bash
python -m embedchain.bots.poe
```
If you want to run the bot on another port, you can pass `--port option` like
```bash ```bash
python -m embedchain.bots.poe --port 5000 python -m embedchain.bots.poe --port 5000
``` ```
9. Click `Run check` to make sure your machine can be reached. 9. Click `Run check` to make sure your machine can be reached.
10. Make sure your bot is private if that's what you want. 10. Make sure your bot is private if that's what you want.
11. Click `Create bot`. 11. Click `Create bot` at the bottom to finally create the bot
12. Happy chatting! 12. Now you bot is created.
### 💬 How to use ### 💬 How to use
@@ -34,6 +40,8 @@ python -m embedchain.bots.poe --port 5000
/add <url_or_text> /add <url_or_text>
``` ```
- You can refer the [Supported Data formats](https://docs.embedchain.ai/advanced/data_types) section to refer the supported data types in embedchain.
- To ask the bot questions, just type your query: - To ask the bot questions, just type your query:
```text ```text
<your-question-here> <your-question-here>