Skip to content

Commit

Permalink
extending README
Browse files Browse the repository at this point in the history
  • Loading branch information
chr-hertel committed Nov 27, 2023
1 parent 21ad57e commit bc86a00
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
SymfonyCon Bot 2023
===================

Chatbot for SymfonyCon 2023
Chatbot for SymfonyCon 2023 with Telegram integration.

Use it on Telegram: [@SymfonyConBot](https://t.me/SymfonyConBot)

What's it about?
----------------

This bot is a small demo app for the SymfonyCon 2023 conference.
It's a simple bot that can be used to get information about the conference.
It knows a few things about the conference, like the dates, the location, and
the schedule.

The bot demonstrates a simple way to implement Retrieval Augmented Generation
(RAG) with Symfony and OpenAI's API.

Requirements
------------

* PHP 8.2
* Doctrine compatible database engine
* [Symfony CLI](https://symfony.com/doc/master/cloud/getting-started#installing-the-cli-tool) (or sth similar)
* [Ngrok](https://ngrok.com/download) (or sth similar)
* [Telegram Bot Token](https://core.telegram.org/bots#6-botfather)
* [OpenAI API Key](https://platform.openai.com/docs/overview)
* [Pinecone API](https://www.pinecone.io/)

0 comments on commit bc86a00

Please sign in to comment.