shukdevdatta123 commited on
Commit
8aaaa32
·
verified ·
1 Parent(s): 5eba22e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +1 -79
README.md CHANGED
@@ -13,82 +13,4 @@ thumbnail: >-
13
  https://cdn-uploads.huggingface.co/production/uploads/65d594d99621f3f1b14d776d/qkXqIgpkcC7J0gXoJp0zU.png
14
  ---
15
 
16
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
17
-
18
- Sure! Here's a sample `README.md` file for your Hugging Face Space project that includes information about the app, installation instructions, usage, and features:
19
-
20
- ```markdown
21
- # Chat with the Streamlit Docs 💬 📚
22
-
23
- This Streamlit application allows users to chat with documents uploaded in PDF or DOCX format using OpenAI's GPT model. The application extracts text from the uploaded documents and enables users to ask questions based on that content.
24
-
25
- ## Features
26
-
27
- - **Upload PDF and DOCX Files**: Users can upload multiple documents to extract text from.
28
- - **Chat Interface**: A simple chat interface to interact with the assistant.
29
- - **Conversation History**: Save, load, and delete previous conversations.
30
- - **OpenAI Integration**: Utilize OpenAI's language model for accurate and context-aware responses.
31
-
32
- ## Requirements
33
-
34
- - Python 3.7 or higher
35
- - Streamlit
36
- - llama_index
37
- - pdfplumber
38
- - python-docx
39
- - python-dotenv
40
-
41
- ## Installation
42
-
43
- 1. Clone the repository or download the files.
44
- 2. Install the required packages:
45
-
46
- ```bash
47
- pip install streamlit llama_index pdfplumber python-docx python-dotenv
48
- ```
49
-
50
- 3. Create a `.env` file in the root directory and add your OpenAI API key:
51
-
52
- ```plaintext
53
- OPENAI_API_KEY=your_openai_api_key_here
54
- ```
55
-
56
- ## Usage
57
-
58
- 1. Run the Streamlit app:
59
-
60
- ```bash
61
- streamlit run app.py
62
- ```
63
-
64
- 2. Open your web browser and go to `http://localhost:8501`.
65
- 3. Enter your OpenAI API key in the sidebar.
66
- 4. Upload your PDF or DOCX files.
67
- 5. Ask questions about the content of the uploaded documents!
68
-
69
- ## Conversation Management
70
-
71
- - **Save Conversation**: You can save the current conversation to a JSON file.
72
- - **Load Previous Conversations**: Review and delete past conversations from the sidebar.
73
-
74
- ## Note
75
-
76
- Make sure to follow the usage guidelines for the OpenAI API, including rate limits and responsible usage policies.
77
-
78
- ## License
79
-
80
- This project is licensed under the MIT License. See the LICENSE file for details.
81
-
82
- ## Acknowledgments
83
-
84
- - [Streamlit](https://streamlit.io/)
85
- - [OpenAI](https://openai.com/)
86
- - [pdfplumber](https://github.com/jsvine/pdfplumber)
87
- - [python-docx](https://python-docx.readthedocs.io/en/latest/)
88
-
89
- ---
90
-
91
- Feel free to reach out if you have any questions or feedback!
92
- ```
93
-
94
- You can adjust any sections as needed to better match your project's specifics!
 
13
  https://cdn-uploads.huggingface.co/production/uploads/65d594d99621f3f1b14d776d/qkXqIgpkcC7J0gXoJp0zU.png
14
  ---
15
 
16
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference