You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
refactor: Simplify Dockerfile and README, remove deprecated scripts
- Remove unnecessary environment variables from Dockerfile
- Update README with new dashboard configuration details
- Remove deprecated chunking script
- Update knowledge base upload process in README
- Remove ENCRYPTION.md from utils directory
- Modify knowledgebase file upload API to use credentials from database
Copy file name to clipboardexpand all lines: README.md
+22-16
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ Try the deployed application on the link [here](https://ask.ripeseed.io). "Ask R
46
46
Ask RipeSeed utilizes a modern and efficient tech stack to deliver a robust user experience. Below is an overview of the core libraries and tools used in the project:
| Next.js | Web Framework | v14.2.3 | A powerful React framework for building scalable web applications. |
51
51
| TypeScript | Language | v5 | Provides static type checking to improve code quality and maintainability. |
52
52
| Tailwind CSS | Styling Framework | v3.4.1 | A utility-first CSS framework for rapidly building custom designs. |
@@ -59,7 +59,6 @@ Ask RipeSeed utilizes a modern and efficient tech stack to deliver a robust user
59
59
| Dexie | IndexedDB Wrapper | v4.0.7 | A minimalistic wrapper for IndexedDB to handle local storage effectively. |
60
60
| PDF-parse | Document Parsing | v1.1.1 | Parses and processes PDF documents to extract content. |
61
61
| Radix-ui | UI Components | v1.0.x | Provides a set of accessible and composable UI components for React. |
62
-
| Valtio | State Management | v1.13.2 | A simple and efficient state management library for React. |
63
62
| react-syntax-highlighter | Syntax Highlighting | v15.5.0 | Provides syntax highlighting for code snippets and markdown content. |
64
63
| rehype-highlight | Markdown Parser | v7.0.0 | A plugin for Rehype to highlight code blocks in markdown. |
65
64
| rehype-katex | Math Rendering | v7.0.0 | A plugin for Rehype to render math expressions using KaTeX. ||
@@ -71,18 +70,25 @@ Additional dependencies include several Radix UI components, libraries for state
71
70
72
71
## Documentation
73
72
74
-
### Replacing the RipeSeed Knowledge Base
73
+
### Dashboard Configuration
75
74
76
-
To customize the chatbot's responses with your own knowledge base, follow these steps to create and upload document chunks:
75
+
We are excited to introduce a new dashboard that allows users to easily configure various aspects of the Ask RipeSeed application. You can access the dashboard via the `/dashboard` route.
77
76
78
-
1.**Prepare Your Documents**: We have provided a [template](https://github.com/RipeSeed/ask-ripeseed/blob/main/public/example-docs/knowledgebase.template) and an [example document](https://github.com/RipeSeed/ask-ripeseed/blob/main/public/example-docs/knowledgebase) to start with and give agencies an idea on how should they create their knowledgebase. Use that or create your own document and place that in PDF format in the "Documents" folder located in the same directory as the chunking script.
79
-
2.**Run the Chunking Script**: Use our script located [here](https://github.com/RipeSeed/ask-ripeseed/blob/main/scripts/ask_ripeseed_LC_chunking.ipynb). This script is an `.ipynb` file that can be run locally using Jupyter Notebook or online via Google Colab.
80
-
3.**Configure the Script**: In the `upload_documents_service` function, set up the following variables:
81
-
-`api_key`: Your Pinecone API key.
82
-
-`pinecone.Index()`: Your Pinecone index name.
83
-
-`openai_api_key`: Your OpenAI API key.
84
-
-`id`: A hardcoded identifier in the metadata of vectors for distinguishing your documents in the vector database.
85
-
4.**Run the Script**: Execute all the cells in sequence. This will vectorize your documents and store them in Pinecone with the specified index and metadata.
77
+
If there are no users in the database, you will be first navigated to the registration page. This is a one-time process, and after completing registration, you will not be able to access the registration route again.
78
+
79
+
With this dashboard, you can manage:
80
+
81
+
-**Models**: Select and configure the AI models used for responses.
82
+
-**Pinecone**: Set up and manage your Pinecone index for efficient data storage and retrieval.
83
+
-**Calendly**: Integrate your Calendly link for seamless scheduling.
84
+
-**Prompts**: Customize the prompts used by the AI to tailor responses to your needs.
85
+
-**Knowledge Base**: Upload and manage your knowledge base documents directly from the dashboard.
86
+
87
+
This new feature simplifies the setup process and enhances the overall user experience, making it easier to customize the AI assistant to fit your specific requirements.
88
+
89
+
## Encryption
90
+
91
+
For security purposes, sensitive data is encrypted. For detailed information about the encryption methods implemented in this project, please refer to the [ENCRYPTION.md](ENCRYPTION.md) file located in the root of the project.
86
92
87
93
## Running the Application
88
94
@@ -99,12 +105,12 @@ To run Ask RipeSeed locally, follow these steps:
99
105
100
106
-`MONGO_CONNECTION_STRING`: Your MongoDB connection string.
101
107
-`NEXT_PUBLIC_GA_ID`: Google Analytics ID.
102
-
-`OPENAI_KEY`: Your OpenAI API key.
103
-
-`PINECONE_API_KEY`: Your Pinecone API key.
104
108
-`PINECONE_INDEX`: Your Pinecone index name.
105
-
-`RIPESEED_DOC_INDEX_ID`: The hardcoded ID for your indexed document in Pinecone.
106
-
-`RIPESEED_OPENAI_API_KEY`: OpenAI key for querying the knowledge base.
107
109
-`NEXT_PUBLIC_CALENDLY`: Your calendly link.
110
+
-`ENCRYPTION_KEY`: Your encryption key for securing sensitive data.
111
+
-`JWT_SEC`: Your JSON Web Token secret for authentication.
0 commit comments