Upload 2 files

README.md

@@ -1,10 +1,33 @@
----
-title: Openai Assistant Chat
-emoji: 🦀
-colorFrom: blue
-colorTo: indigo
-sdk: docker
-pinned: false
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# OpenAI Assistant
+
+You can deploy your OpenAI assistant with Chainlit using this template.
+![openai-assistant](https://github.com/Chainlit/openai-assistant/assets/13104895/5c095a89-e426-417e-977d-772c4d4974c2)
+
+### Supported Assistant Features
+
+| Streaming | Files | Code Interpreter | File Search | Voice |
+| --------- | ----- | ---------------- | ----------- | ----- |
+| ✅        | ✅    | ✅               | ✅          | ✅    |
+
+### Get an OpenAI API key
+
+Go to OpenAI's [API keys page](https://platform.openai.com/api-keys) and create one if you don't have one already.
+
+### Create an Assistant
+
+Go to OpenAI's [assistant page](https://platform.openai.com/assistants) and click on the `Create` at the top right.
+
+Configure your assistant.
+
+### [Optional] Get a Literal AI API key
+
+> [!NOTE]  
+> Literal AI is an all in one observability, evaluation and analytics platform for building LLM apps.
+
+Go to [Literal AI](https://cloud.getliteral.ai/), create a project and go to Settings to get your API key.
+
+### Deploy
+
+Click on the button below, then set the API keys in the form and click on `Apply`.
+
+[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)

chainlit.md

@@ -0,0 +1,14 @@
+# Welcome to Chainlit! 🚀🤖
+
+Hi there, Developer! 👋 We're excited to have you on board. Chainlit is a powerful tool designed to help you prototype, debug and share applications built on top of LLMs.
+
+## Useful Links 🔗
+
+- **Documentation:** Get started with our comprehensive [Chainlit Documentation](https://docs.chainlit.io) 📚
+- **Discord Community:** Join our friendly [Chainlit Discord](https://discord.gg/k73SQ3FyUh) to ask questions, share your projects, and connect with other developers! 💬
+
+We can't wait to see what you create with Chainlit! Happy coding! 💻😊
+
+## Welcome screen
+
+To modify the welcome screen, edit the `chainlit.md` file at the root of your project. If you do not want a welcome screen, just leave this file empty.