From 973c11a04839b73acac4c0d00f8af5827dd4bca3 Mon Sep 17 00:00:00 2001 From: arpitpandey0209 Date: Wed, 1 Nov 2023 01:04:40 +0530 Subject: [PATCH 01/14] docs: fix grammar issues --- README.md | 4 ++-- application/prompts/chat_combine_prompt.txt | 2 +- application/prompts/chat_reduce_prompt.txt | 2 +- application/prompts/combine_prompt.txt | 2 +- application/prompts/combine_prompt_hist.txt | 2 +- docs/pages/Deploying/Railway-Deploying.md | 2 +- docs/pages/Guides/Customising-prompts.md | 2 +- extensions/react-widget/README.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4bc9d1998..980be6a9c 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize Note: Make sure you have [Docker](https://docs.docker.com/engine/install/) installed -On Mac OS or Linux, write: +On macOS or Linux, write: `./setup.sh` @@ -130,7 +130,7 @@ Make sure you have Python 3.10 or 3.11 installed. 2. (optional) Create a Python virtual environment: You can follow the [Python official documentation](https://docs.python.org/3/tutorial/venv.html) for virtual environments. -a) On Mac OS and Linux +a) On macOS and Linux ```commandline python -m venv venv diff --git a/application/prompts/chat_combine_prompt.txt b/application/prompts/chat_combine_prompt.txt index 2f9a61c9d..194b85379 100644 --- a/application/prompts/chat_combine_prompt.txt +++ b/application/prompts/chat_combine_prompt.txt @@ -1,5 +1,5 @@ You are a DocsGPT, friendly and helpful AI assistant by Arc53 that provides help with documents. You give thorough answers with code examples if possible. -Use the following pieces of context to help answer the users question. If its not relevant to the question, provide friendly responses. +Use the following pieces of context to help answer the users question. If it's not relevant to the question, provide friendly responses. You have access to chat history, and can use it to help answer the question. When using code examples, use the following format: ```(language) diff --git a/application/prompts/chat_reduce_prompt.txt b/application/prompts/chat_reduce_prompt.txt index a5842d878..b4525c2d8 100644 --- a/application/prompts/chat_reduce_prompt.txt +++ b/application/prompts/chat_reduce_prompt.txt @@ -1,3 +1,3 @@ -Use the following pieces of context to help answer the users question. If its not relevant to the question, respond with "-" +Use the following pieces of context to help answer the users question. If it's not relevant to the question, respond with "-" ---------------- {context} \ No newline at end of file diff --git a/application/prompts/combine_prompt.txt b/application/prompts/combine_prompt.txt index a008da325..c9ce63de9 100644 --- a/application/prompts/combine_prompt.txt +++ b/application/prompts/combine_prompt.txt @@ -2,7 +2,7 @@ You are a DocsGPT, friendly and helpful AI assistant by Arc53 that provides help QUESTION: How to merge tables in pandas? ========= -Content: pandas provides various facilities for easily combining together Series or DataFrame with various kinds of set logic for the indexes and relational algebra functionality in the case of join / merge-type operations. +Content: pandas provides various facilities for easily combining Series or DataFrame with various kinds of set logic for the indexes and relational algebra functionality in the case of join / merge-type operations. Source: 28-pl Content: pandas provides a single function, merge(), as the entry point for all standard database join operations between DataFrame or named Series objects: \n\npandas.merge(left, right, how='inner', on=None, left_on=None, right_on=None, left_index=False, right_index=False, sort=False, suffixes=('_x', '_y'), copy=True, indicator=False, validate=None) Source: 30-pl diff --git a/application/prompts/combine_prompt_hist.txt b/application/prompts/combine_prompt_hist.txt index 509a4a0f5..0d0729020 100644 --- a/application/prompts/combine_prompt_hist.txt +++ b/application/prompts/combine_prompt_hist.txt @@ -2,7 +2,7 @@ You are a DocsGPT, friendly and helpful AI assistant by Arc53 that provides help QUESTION: How to merge tables in pandas? ========= -Content: pandas provides various facilities for easily combining together Series or DataFrame with various kinds of set logic for the indexes and relational algebra functionality in the case of join / merge-type operations. +Content: pandas provides various facilities for easily combining Series or DataFrame with various kinds of set logic for the indexes and relational algebra functionality in the case of join / merge-type operations. Source: 28-pl Content: pandas provides a single function, merge(), as the entry point for all standard database join operations between DataFrame or named Series objects: \n\npandas.merge(left, right, how='inner', on=None, left_on=None, right_on=None, left_index=False, right_index=False, sort=False, suffixes=('_x', '_y'), copy=True, indicator=False, validate=None) Source: 30-pl diff --git a/docs/pages/Deploying/Railway-Deploying.md b/docs/pages/Deploying/Railway-Deploying.md index 34937b3d9..ab6064a94 100644 --- a/docs/pages/Deploying/Railway-Deploying.md +++ b/docs/pages/Deploying/Railway-Deploying.md @@ -7,7 +7,7 @@ Here's a step-by-step guide on how to host DocsGPT on Railway App. -At first Clone and setup the project locally to run , test and Modify. +At first Clone and set up the project locally to run , test and Modify. diff --git a/docs/pages/Guides/Customising-prompts.md b/docs/pages/Guides/Customising-prompts.md index 9d95aa8fa..2b124c04c 100644 --- a/docs/pages/Guides/Customising-prompts.md +++ b/docs/pages/Guides/Customising-prompts.md @@ -11,7 +11,7 @@ Customizing the main prompt for DocsGPT gives you the ability to tailor the AI's **Original Prompt:** ```markdown You are a DocsGPT, friendly and helpful AI assistant by Arc53 that provides help with documents. You give thorough answers with code examples if possible. -Use the following pieces of context to help answer the users question. If its not relevant to the question, provide friendly responses. +Use the following pieces of context to help answer the users question. If it's not relevant to the question, provide friendly responses. You have access to chat history, and can use it to help answer the question. When using code examples, use the following format: diff --git a/extensions/react-widget/README.md b/extensions/react-widget/README.md index a680b180d..89dff7e4a 100644 --- a/extensions/react-widget/README.md +++ b/extensions/react-widget/README.md @@ -1,7 +1,7 @@ # DocsGPT react widget -THis widget will allow you to embed a DocsGPT assistant in your react app. +This widget will allow you to embed a DocsGPT assistant in your React app. ## Installation From 715cd9daf5e5ac3a4748cac715642a1006dc68cb Mon Sep 17 00:00:00 2001 From: arpitpandey0209 Date: Wed, 1 Nov 2023 09:51:09 +0530 Subject: [PATCH 02/14] Revert some files --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0505744f4..980be6a9c 100644 --- a/README.md +++ b/README.md @@ -23,20 +23,22 @@ Say goodbye to time-consuming manual searches, and let -### Production Support / Help for companies: +### Production Support / Help for Companies: We're eager to provide personalized assistance when deploying your DocsGPT to a live environment. - [Book Demo :wave:](https://airtable.com/appdeaL0F1qV8Bl2C/shrrJF1Ll7btCJRbP) - [Send Email :email:](mailto:contact@arc53.com?subject=DocsGPT%20support%2Fsolutions) -### [:tada: Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! :tada:](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md) - -![video-example-of-docs-gpt](https://d3dg1063dc54p9.cloudfront.net/videos/demov3.gif) ## Roadmap You can find our roadmap [here](https://github.com/orgs/arc53/projects/2). Please don't hesitate to contribute or create issues, it helps us improve DocsGPT! -## Our Open-Source models optimized for DocsGPT: +## Our Open-Source Models Optimized for DocsGPT: | Name | Base Model | Requirements (or similar) | | --------------------------------------------------------------------- | ----------- | ------------------------- | @@ -52,7 +49,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize ![Main features of DocsGPT showcasing six main features](https://user-images.githubusercontent.com/17906039/220427472-2644cff4-7666-46a5-819f-fc4a521f63c7.png) -## Useful links +## Useful Links - :mag: :fire: [Live preview](https://docsgpt.arc53.com/) @@ -66,7 +63,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize - :house: :closed_lock_with_key: [How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM) -## Project structure +## Project Structure - Application - Flask app (main application). @@ -80,7 +77,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize Note: Make sure you have [Docker](https://docs.docker.com/engine/install/) installed -On macOS or Linux, write: +On Mac OS or Linux, write: `./setup.sh` @@ -104,9 +101,9 @@ Otherwise, refer to this Guide: To stop, just run `Ctrl + C`. -## Development environments +## Development Environments -### Spin up mongo and redis +### Spin up Mongo and Redis For development, only two containers are used from [docker-compose.yaml](https://github.com/arc53/DocsGPT/blob/main/docker-compose.yaml) (by deleting all services except for Redis and Mongo). See file [docker-compose-dev.yaml](./docker-compose-dev.yaml). @@ -118,7 +115,7 @@ docker compose -f docker-compose-dev.yaml build docker compose -f docker-compose-dev.yaml up -d ``` -### Run the backend +### Run the Backend Make sure you have Python 3.10 or 3.11 installed. @@ -130,7 +127,7 @@ Make sure you have Python 3.10 or 3.11 installed. 2. (optional) Create a Python virtual environment: You can follow the [Python official documentation](https://docs.python.org/3/tutorial/venv.html) for virtual environments. -a) On macOS and Linux +a) On Mac OS and Linux ```commandline python -m venv venv @@ -153,7 +150,7 @@ pip install -r requirements.txt 4. Run the app using `flask --app application/app.py run --host=0.0.0.0 --port=7091`. 5. Start worker with `celery -A application.app.celery worker -l INFO`. -### Start frontend +### Start Frontend Make sure you have Node version 16 or higher. From bb28cc5c65b8e69d5fb33770e4468e6525c71e1f Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 09:58:13 +0530 Subject: [PATCH 04/14] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6c48f0a54..58639d3d1 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ We're eager to provide personalized assistance when deploying your DocsGPT to a - [Book Demo :wave:](https://airtable.com/appdeaL0F1qV8Bl2C/shrrJF1Ll7btCJRbP) - [Send Email :email:](mailto:contact@arc53.com?subject=DocsGPT%20support%2Fsolutions) +![video-example-of-docs-gpt](https://d3dg1063dc54p9.cloudfront.net/videos/demov3.gif) ## Roadmap From 2a1a3fb1b5a655b4818498111b8b953b027116d1 Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 09:59:46 +0530 Subject: [PATCH 05/14] Update chat_combine_prompt.txt --- application/prompts/chat_combine_prompt.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/prompts/chat_combine_prompt.txt b/application/prompts/chat_combine_prompt.txt index 194b85379..f36a31adf 100644 --- a/application/prompts/chat_combine_prompt.txt +++ b/application/prompts/chat_combine_prompt.txt @@ -1,9 +1,9 @@ You are a DocsGPT, friendly and helpful AI assistant by Arc53 that provides help with documents. You give thorough answers with code examples if possible. -Use the following pieces of context to help answer the users question. If it's not relevant to the question, provide friendly responses. +Use the following pieces of context to help answer the users question. If its not relevant to the question, provide friendly responses. You have access to chat history, and can use it to help answer the question. When using code examples, use the following format: ```(language) (code) ``` ---------------- -{summaries} \ No newline at end of file +{summaries} From 9f3c962ea4e1ac916bf6f08b0181bd9b8f5ccd90 Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:01:43 +0530 Subject: [PATCH 06/14] Update chat_combine_prompt.txt --- application/prompts/chat_combine_prompt.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/prompts/chat_combine_prompt.txt b/application/prompts/chat_combine_prompt.txt index f36a31adf..41da7ffaf 100644 --- a/application/prompts/chat_combine_prompt.txt +++ b/application/prompts/chat_combine_prompt.txt @@ -5,5 +5,5 @@ When using code examples, use the following format: ```(language) (code) ``` ----------------- +--------------- {summaries} From 3e983b121e8a2dff5ed514ee9dcc67b4564bb201 Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:02:03 +0530 Subject: [PATCH 07/14] Update chat_combine_prompt.txt --- application/prompts/chat_combine_prompt.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/prompts/chat_combine_prompt.txt b/application/prompts/chat_combine_prompt.txt index 41da7ffaf..f36a31adf 100644 --- a/application/prompts/chat_combine_prompt.txt +++ b/application/prompts/chat_combine_prompt.txt @@ -5,5 +5,5 @@ When using code examples, use the following format: ```(language) (code) ``` ---------------- +---------------- {summaries} From 4c70e922936b16454826ac38f10d75746ba21e32 Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:03:50 +0530 Subject: [PATCH 08/14] Update chat_reduce_prompt.txt --- application/prompts/chat_reduce_prompt.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/prompts/chat_reduce_prompt.txt b/application/prompts/chat_reduce_prompt.txt index b4525c2d8..209dfd0f9 100644 --- a/application/prompts/chat_reduce_prompt.txt +++ b/application/prompts/chat_reduce_prompt.txt @@ -1,3 +1,3 @@ -Use the following pieces of context to help answer the users question. If it's not relevant to the question, respond with "-" +Use the following pieces of context to help answer the users question. If its not relevant to the question, respond with "-" ---------------- -{context} \ No newline at end of file +{context} From 8e553e7a93da42fefdf4dba0eefb39a09b232849 Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:04:30 +0530 Subject: [PATCH 09/14] Update combine_prompt.txt --- application/prompts/combine_prompt.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/prompts/combine_prompt.txt b/application/prompts/combine_prompt.txt index c9ce63de9..fcbd5c905 100644 --- a/application/prompts/combine_prompt.txt +++ b/application/prompts/combine_prompt.txt @@ -2,7 +2,7 @@ You are a DocsGPT, friendly and helpful AI assistant by Arc53 that provides help QUESTION: How to merge tables in pandas? ========= -Content: pandas provides various facilities for easily combining Series or DataFrame with various kinds of set logic for the indexes and relational algebra functionality in the case of join / merge-type operations. +Content: pandas provides various facilities for easily combining together Series or DataFrame with various kinds of set logic for the indexes and relational algebra functionality in the case of join / merge-type operations. Source: 28-pl Content: pandas provides a single function, merge(), as the entry point for all standard database join operations between DataFrame or named Series objects: \n\npandas.merge(left, right, how='inner', on=None, left_on=None, right_on=None, left_index=False, right_index=False, sort=False, suffixes=('_x', '_y'), copy=True, indicator=False, validate=None) Source: 30-pl @@ -22,4 +22,4 @@ QUESTION: {{ question }} ========= {{ summaries }} ========= -FINAL ANSWER: \ No newline at end of file +FINAL ANSWER: From 51ad3fdb0b663941c6a7d15bcae7fa9018e4a658 Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:04:53 +0530 Subject: [PATCH 10/14] Update combine_prompt.txt From df9723a011e30edfcbae57417769e3aa307359d7 Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:06:54 +0530 Subject: [PATCH 11/14] Update combine_prompt.txt --- application/prompts/combine_prompt.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/prompts/combine_prompt.txt b/application/prompts/combine_prompt.txt index fcbd5c905..1c2147358 100644 --- a/application/prompts/combine_prompt.txt +++ b/application/prompts/combine_prompt.txt @@ -22,4 +22,4 @@ QUESTION: {{ question }} ========= {{ summaries }} ========= -FINAL ANSWER: +FINAL ANSWER: From eb768f20765a3f85c8a91b2cf0d20bf4da435231 Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:07:25 +0530 Subject: [PATCH 12/14] Update combine_prompt.txt --- application/prompts/combine_prompt.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/prompts/combine_prompt.txt b/application/prompts/combine_prompt.txt index 1c2147358..fcbd5c905 100644 --- a/application/prompts/combine_prompt.txt +++ b/application/prompts/combine_prompt.txt @@ -22,4 +22,4 @@ QUESTION: {{ question }} ========= {{ summaries }} ========= -FINAL ANSWER: +FINAL ANSWER: From e4973f572ff3664ef554696626e7dc2f250cbffb Mon Sep 17 00:00:00 2001 From: ArpitPandey29 <149410125+ArpitPandey29@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:08:36 +0530 Subject: [PATCH 13/14] Update combine_prompt_hist.txt --- application/prompts/combine_prompt_hist.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/prompts/combine_prompt_hist.txt b/application/prompts/combine_prompt_hist.txt index 0d0729020..2f4317b60 100644 --- a/application/prompts/combine_prompt_hist.txt +++ b/application/prompts/combine_prompt_hist.txt @@ -2,7 +2,7 @@ You are a DocsGPT, friendly and helpful AI assistant by Arc53 that provides help QUESTION: How to merge tables in pandas? ========= -Content: pandas provides various facilities for easily combining Series or DataFrame with various kinds of set logic for the indexes and relational algebra functionality in the case of join / merge-type operations. +Content: pandas provides various facilities for easily combining together Series or DataFrame with various kinds of set logic for the indexes and relational algebra functionality in the case of join / merge-type operations. Source: 28-pl Content: pandas provides a single function, merge(), as the entry point for all standard database join operations between DataFrame or named Series objects: \n\npandas.merge(left, right, how='inner', on=None, left_on=None, right_on=None, left_index=False, right_index=False, sort=False, suffixes=('_x', '_y'), copy=True, indicator=False, validate=None) Source: 30-pl @@ -30,4 +30,4 @@ QUESTION: {{ question }} ========= {{ summaries }} ========= -FINAL ANSWER: \ No newline at end of file +FINAL ANSWER: From 7f6fef137349255d6756e0891ceff755df6251ac Mon Sep 17 00:00:00 2001 From: arpitpandey0209 Date: Wed, 1 Nov 2023 10:11:40 +0530 Subject: [PATCH 14/14] Revert txt files --- application/prompts/chat_combine_prompt.txt | 2 +- application/prompts/chat_reduce_prompt.txt | 2 +- application/prompts/combine_prompt.txt | 2 +- application/prompts/combine_prompt_hist.txt | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/application/prompts/chat_combine_prompt.txt b/application/prompts/chat_combine_prompt.txt index f36a31adf..2f9a61c9d 100644 --- a/application/prompts/chat_combine_prompt.txt +++ b/application/prompts/chat_combine_prompt.txt @@ -6,4 +6,4 @@ When using code examples, use the following format: (code) ``` ---------------- -{summaries} +{summaries} \ No newline at end of file diff --git a/application/prompts/chat_reduce_prompt.txt b/application/prompts/chat_reduce_prompt.txt index 209dfd0f9..a5842d878 100644 --- a/application/prompts/chat_reduce_prompt.txt +++ b/application/prompts/chat_reduce_prompt.txt @@ -1,3 +1,3 @@ Use the following pieces of context to help answer the users question. If its not relevant to the question, respond with "-" ---------------- -{context} +{context} \ No newline at end of file diff --git a/application/prompts/combine_prompt.txt b/application/prompts/combine_prompt.txt index fcbd5c905..a008da325 100644 --- a/application/prompts/combine_prompt.txt +++ b/application/prompts/combine_prompt.txt @@ -22,4 +22,4 @@ QUESTION: {{ question }} ========= {{ summaries }} ========= -FINAL ANSWER: +FINAL ANSWER: \ No newline at end of file diff --git a/application/prompts/combine_prompt_hist.txt b/application/prompts/combine_prompt_hist.txt index 2f4317b60..509a4a0f5 100644 --- a/application/prompts/combine_prompt_hist.txt +++ b/application/prompts/combine_prompt_hist.txt @@ -30,4 +30,4 @@ QUESTION: {{ question }} ========= {{ summaries }} ========= -FINAL ANSWER: +FINAL ANSWER: \ No newline at end of file