webscout 1.2.3__tar.gz → 1.2.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of webscout might be problematic. Click here for more details.

Files changed (40) hide show
  1. {webscout-1.2.3 → webscout-1.2.4}/PKG-INFO +35 -1
  2. {webscout-1.2.3 → webscout-1.2.4}/README.md +32 -0
  3. {webscout-1.2.3 → webscout-1.2.4}/setup.py +3 -1
  4. {webscout-1.2.3 → webscout-1.2.4}/webscout/DWEBS.py +197 -197
  5. {webscout-1.2.3 → webscout-1.2.4}/webscout/__init__.py +1 -0
  6. webscout-1.2.4/webscout/offlineAI.py +206 -0
  7. webscout-1.2.4/webscout/version.py +2 -0
  8. {webscout-1.2.3 → webscout-1.2.4}/webscout.egg-info/PKG-INFO +35 -1
  9. {webscout-1.2.3 → webscout-1.2.4}/webscout.egg-info/SOURCES.txt +1 -0
  10. {webscout-1.2.3 → webscout-1.2.4}/webscout.egg-info/requires.txt +2 -0
  11. webscout-1.2.3/webscout/version.py +0 -2
  12. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/__init__.py +0 -0
  13. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/documents/__init__.py +0 -0
  14. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/documents/query_results_extractor.py +0 -0
  15. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/documents/webpage_content_extractor.py +0 -0
  16. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/networks/__init__.py +0 -0
  17. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/networks/filepath_converter.py +0 -0
  18. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/networks/google_searcher.py +0 -0
  19. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/networks/network_configs.py +0 -0
  20. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/networks/webpage_fetcher.py +0 -0
  21. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/utilsdw/__init__.py +0 -0
  22. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/utilsdw/enver.py +0 -0
  23. {webscout-1.2.3 → webscout-1.2.4}/DeepWEBS/utilsdw/logger.py +0 -0
  24. {webscout-1.2.3 → webscout-1.2.4}/LICENSE.md +0 -0
  25. {webscout-1.2.3 → webscout-1.2.4}/setup.cfg +0 -0
  26. {webscout-1.2.3 → webscout-1.2.4}/webscout/AI.py +0 -0
  27. {webscout-1.2.3 → webscout-1.2.4}/webscout/AIbase.py +0 -0
  28. {webscout-1.2.3 → webscout-1.2.4}/webscout/AIutel.py +0 -0
  29. {webscout-1.2.3 → webscout-1.2.4}/webscout/HelpingAI.py +0 -0
  30. {webscout-1.2.3 → webscout-1.2.4}/webscout/LLM.py +0 -0
  31. {webscout-1.2.3 → webscout-1.2.4}/webscout/__main__.py +0 -0
  32. {webscout-1.2.3 → webscout-1.2.4}/webscout/cli.py +0 -0
  33. {webscout-1.2.3 → webscout-1.2.4}/webscout/exceptions.py +0 -0
  34. {webscout-1.2.3 → webscout-1.2.4}/webscout/models.py +0 -0
  35. {webscout-1.2.3 → webscout-1.2.4}/webscout/utils.py +0 -0
  36. {webscout-1.2.3 → webscout-1.2.4}/webscout/webscout_search.py +0 -0
  37. {webscout-1.2.3 → webscout-1.2.4}/webscout/webscout_search_async.py +0 -0
  38. {webscout-1.2.3 → webscout-1.2.4}/webscout.egg-info/dependency_links.txt +0 -0
  39. {webscout-1.2.3 → webscout-1.2.4}/webscout.egg-info/entry_points.txt +0 -0
  40. {webscout-1.2.3 → webscout-1.2.4}/webscout.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: webscout
3
- Version: 1.2.3
3
+ Version: 1.2.4
4
4
  Summary: Search for words, documents, images, videos, news, maps and text translation using the Google, DuckDuckGo.com, yep.com, phind.com, you.com, etc Also containes AI models
5
5
  Author: OEvortex
6
6
  Author-email: helpingai5@gmail.com
@@ -45,6 +45,8 @@ Requires-Dist: sse_starlette
45
45
  Requires-Dist: termcolor
46
46
  Requires-Dist: tiktoken
47
47
  Requires-Dist: tldextract
48
+ Requires-Dist: gpt4all
49
+ Requires-Dist: orjson
48
50
  Provides-Extra: dev
49
51
  Requires-Dist: ruff>=0.1.6; extra == "dev"
50
52
  Requires-Dist: pytest>=7.4.2; extra == "dev"
@@ -92,6 +94,7 @@ Also containes AI models that you can use
92
94
  - [6. `BlackBox` - Search/chat With BlackBox](#6-blackbox---searchchat-with-blackbox)
93
95
  - [7. `PERPLEXITY` - Search With PERPLEXITY](#7-perplexity---search-with-perplexity)
94
96
  - [8. `OpenGPT` - chat With OPENGPT](#8-opengpt---chat-with-opengpt)
97
+ - [9. `GPT4ALL` - chat offline with Language models using gpt4all from webscout](#9-gpt4all---chat-offline-with-language-models-using-gpt4all-from-webscout)
95
98
  - [usage of special .LLM file from webscout (webscout.LLM)](#usage-of-special-llm-file-from-webscout-webscoutllm)
96
99
  - [`LLM`](#llm)
97
100
 
@@ -605,6 +608,37 @@ prompt = "tell me about india"
605
608
  response_str = opengpt.chat(prompt)
606
609
  print(response_str)
607
610
  ```
611
+ ### 9. `GPT4ALL` - chat offline with Language models using gpt4all from webscout
612
+ ```python
613
+ from webscout import GPT4ALL
614
+
615
+ # Initialize the GPT4ALL class with your model path and other optional parameters
616
+ gpt4all_instance = GPT4ALL(
617
+ model="path/to/your/model/file", # Replace with the actual path to your model file
618
+ is_conversation=True,
619
+ max_tokens=800,
620
+ temperature=0.7,
621
+ presence_penalty=0,
622
+ frequency_penalty=1.18,
623
+ top_p=0.4,
624
+ intro="Hello, how can I assist you today?",
625
+ filepath="path/to/conversation/history/file", # Optional, for conversation history
626
+ update_file=True,
627
+ history_offset=10250,
628
+ act=None # Optional, for using an awesome prompt as intro
629
+ )
630
+
631
+ # Generate a response from the AI model
632
+ response = gpt4all_instance.chat(
633
+ prompt="What is the weather like today?",
634
+ stream=False, # Set to True if you want to stream the response
635
+ optimizer=None, # Optional, specify an optimizer if needed
636
+ conversationally=False # Set to True for conversationally generated responses
637
+ )
638
+
639
+ # Print the generated response
640
+ print(response)
641
+ ```
608
642
 
609
643
  ## usage of special .LLM file from webscout (webscout.LLM)
610
644
 
@@ -41,6 +41,7 @@ Also containes AI models that you can use
41
41
  - [6. `BlackBox` - Search/chat With BlackBox](#6-blackbox---searchchat-with-blackbox)
42
42
  - [7. `PERPLEXITY` - Search With PERPLEXITY](#7-perplexity---search-with-perplexity)
43
43
  - [8. `OpenGPT` - chat With OPENGPT](#8-opengpt---chat-with-opengpt)
44
+ - [9. `GPT4ALL` - chat offline with Language models using gpt4all from webscout](#9-gpt4all---chat-offline-with-language-models-using-gpt4all-from-webscout)
44
45
  - [usage of special .LLM file from webscout (webscout.LLM)](#usage-of-special-llm-file-from-webscout-webscoutllm)
45
46
  - [`LLM`](#llm)
46
47
 
@@ -554,6 +555,37 @@ prompt = "tell me about india"
554
555
  response_str = opengpt.chat(prompt)
555
556
  print(response_str)
556
557
  ```
558
+ ### 9. `GPT4ALL` - chat offline with Language models using gpt4all from webscout
559
+ ```python
560
+ from webscout import GPT4ALL
561
+
562
+ # Initialize the GPT4ALL class with your model path and other optional parameters
563
+ gpt4all_instance = GPT4ALL(
564
+ model="path/to/your/model/file", # Replace with the actual path to your model file
565
+ is_conversation=True,
566
+ max_tokens=800,
567
+ temperature=0.7,
568
+ presence_penalty=0,
569
+ frequency_penalty=1.18,
570
+ top_p=0.4,
571
+ intro="Hello, how can I assist you today?",
572
+ filepath="path/to/conversation/history/file", # Optional, for conversation history
573
+ update_file=True,
574
+ history_offset=10250,
575
+ act=None # Optional, for using an awesome prompt as intro
576
+ )
577
+
578
+ # Generate a response from the AI model
579
+ response = gpt4all_instance.chat(
580
+ prompt="What is the weather like today?",
581
+ stream=False, # Set to True if you want to stream the response
582
+ optimizer=None, # Optional, specify an optimizer if needed
583
+ conversationally=False # Set to True for conversationally generated responses
584
+ )
585
+
586
+ # Print the generated response
587
+ print(response)
588
+ ```
557
589
 
558
590
  ## usage of special .LLM file from webscout (webscout.LLM)
559
591
 
@@ -9,7 +9,7 @@ with open("README.md", encoding="utf-8") as f:
9
9
 
10
10
  setup(
11
11
  name="webscout",
12
- version="1.2.3", # Use the version variable from the version.py file
12
+ version="1.2.4", # Use the version variable from the version.py file
13
13
  description="Search for words, documents, images, videos, news, maps and text translation using the Google, DuckDuckGo.com, yep.com, phind.com, you.com, etc Also containes AI models",
14
14
  long_description=README,
15
15
  long_description_content_type="text/markdown",
@@ -53,6 +53,8 @@ setup(
53
53
  "termcolor",
54
54
  "tiktoken",
55
55
  "tldextract",
56
+ "gpt4all",
57
+ "orjson",
56
58
  ],
57
59
  entry_points={
58
60
  "console_scripts": [
@@ -1,197 +1,197 @@
1
-
2
- from pydantic import BaseModel, Field
3
- from typing import Union
4
-
5
- from DeepWEBS.utilsdw.logger import logger
6
- from DeepWEBS.networks.google_searcher import GoogleSearcher
7
- from DeepWEBS.networks.webpage_fetcher import BatchWebpageFetcher
8
- from DeepWEBS.documents.query_results_extractor import QueryResultsExtractor
9
- from DeepWEBS.documents.webpage_content_extractor import BatchWebpageContentExtractor
10
- from DeepWEBS.utilsdw.logger import logger
11
- import argparse
12
-
13
- class DeepWEBS:
14
- def __init__(self):
15
- pass
16
-
17
- class DeepSearch(BaseModel):
18
- queries: list = Field(
19
- default=[""],
20
- description="(list[str]) Queries to search",
21
- )
22
- result_num: int = Field(
23
- default=10,
24
- description="(int) Number of search results",
25
- )
26
- safe: bool = Field(
27
- default=False,
28
- description="(bool) Enable SafeSearch",
29
- )
30
- types: list = Field(
31
- default=["web"],
32
- description="(list[str]) Types of search results: `web`, `image`, `videos`, `news`",
33
- )
34
- extract_webpage: bool = Field(
35
- default=False,
36
- description="(bool) Enable extracting main text contents from webpage, will add `text` filed in each `query_result` dict",
37
- )
38
- overwrite_query_html: bool = Field(
39
- default=False,
40
- description="(bool) Overwrite HTML file of query results",
41
- )
42
- overwrite_webpage_html: bool = Field(
43
- default=False,
44
- description="(bool) Overwrite HTML files of webpages from query results",
45
- )
46
-
47
- def queries_to_search_results(self, item: DeepSearch):
48
- google_searcher = GoogleSearcher()
49
- queries_search_results = []
50
- for query in item.queries:
51
- query_results_extractor = QueryResultsExtractor()
52
- if not query.strip():
53
- continue
54
- try:
55
- query_html_path = google_searcher.search(
56
- query=query,
57
- result_num=item.result_num,
58
- safe=item.safe,
59
- overwrite=item.overwrite_query_html,
60
- )
61
- except Exception as e:
62
- logger.error(f"Failed to search for query '{query}': {e}")
63
- continue
64
-
65
- try:
66
- query_search_results = query_results_extractor.extract(query_html_path)
67
- except Exception as e:
68
- logger.error(f"Failed to extract search results for query '{query}': {e}")
69
- continue
70
-
71
- queries_search_results.append(query_search_results)
72
- logger.note(queries_search_results)
73
-
74
- if item.extract_webpage:
75
- queries_search_results = self.extract_webpages(
76
- queries_search_results,
77
- overwrite_webpage_html=item.overwrite_webpage_html,
78
- )
79
- return queries_search_results
80
-
81
- def extract_webpages(self, queries_search_results, overwrite_webpage_html=False):
82
- for query_idx, query_search_results in enumerate(queries_search_results):
83
- try:
84
- # Fetch webpages with urls
85
- batch_webpage_fetcher = BatchWebpageFetcher()
86
- urls = [
87
- query_result["url"]
88
- for query_result in query_search_results["query_results"]
89
- ]
90
- url_and_html_path_list = batch_webpage_fetcher.fetch(
91
- urls,
92
- overwrite=overwrite_webpage_html,
93
- output_parent=query_search_results["query"],
94
- )
95
- except Exception as e:
96
- logger.error(f"Failed to fetch webpages for query '{query_search_results['query']}': {e}")
97
- continue
98
-
99
- # Extract webpage contents from htmls
100
- html_paths = [
101
- str(url_and_html_path["html_path"])
102
- for url_and_html_path in url_and_html_path_list
103
- ]
104
- batch_webpage_content_extractor = BatchWebpageContentExtractor()
105
- try:
106
- html_path_and_extracted_content_list = (
107
- batch_webpage_content_extractor.extract(html_paths)
108
- )
109
- except Exception as e:
110
- logger.error(f"Failed to extract webpage contents for query '{query_search_results['query']}': {e}")
111
- continue
112
-
113
- # Build the map of url to extracted_content
114
- html_path_to_url_dict = {
115
- str(url_and_html_path["html_path"]): url_and_html_path["url"]
116
- for url_and_html_path in url_and_html_path_list
117
- }
118
- url_to_extracted_content_dict = {
119
- html_path_to_url_dict[
120
- html_path_and_extracted_content["html_path"]
121
- ]: html_path_and_extracted_content["extracted_content"]
122
- for html_path_and_extracted_content in html_path_and_extracted_content_list
123
- }
124
-
125
- # Write extracted contents (as 'text' field) to query_search_results
126
- for query_result_idx, query_result in enumerate(
127
- query_search_results["query_results"]
128
- ):
129
- url = query_result["url"]
130
- extracted_content = url_to_extracted_content_dict.get(url, "")
131
- queries_search_results[query_idx]["query_results"][query_result_idx][
132
- "text"
133
- ] = extracted_content
134
-
135
- return queries_search_results
136
-
137
-
138
- class ArgParser(argparse.ArgumentParser):
139
- def __init__(self, *args, **kwargs):
140
- super(ArgParser, self).__init__(*args, **kwargs)
141
-
142
- self.add_argument(
143
- "-q",
144
- "--queries",
145
- type=str,
146
- nargs="+",
147
- required=True,
148
- help="Queries to search",
149
- )
150
- self.add_argument(
151
- "-n",
152
- "--result_num",
153
- type=int,
154
- default=10,
155
- help="Number of search results",
156
- )
157
- self.add_argument(
158
- "-s",
159
- "--safe",
160
- default=False,
161
- action="store_true",
162
- help="Enable SafeSearch",
163
- )
164
- self.add_argument(
165
- "-t",
166
- "--types",
167
- type=str,
168
- nargs="+",
169
- default=["web"],
170
- choices=["web", "image", "videos", "news"],
171
- help="Types of search results",
172
- )
173
- self.add_argument(
174
- "-e",
175
- "--extract_webpage",
176
- default=False,
177
- action="store_true",
178
- help="Enable extracting main text contents from webpage",
179
- )
180
- self.add_argument(
181
- "-o",
182
- "--overwrite_query_html",
183
- default=False,
184
- action="store_true",
185
- help="Overwrite HTML file of query results",
186
- )
187
- self.add_argument(
188
- "-w",
189
- "--overwrite_webpage_html",
190
- default=False,
191
- action="store_true",
192
- help="Overwrite HTML files of webpages from query results",
193
- )
194
-
195
- self.args = self.parse_args()
196
-
197
-
1
+
2
+ from pydantic import BaseModel, Field
3
+ from typing import Union
4
+
5
+ from DeepWEBS.utilsdw.logger import logger
6
+ from DeepWEBS.networks.google_searcher import GoogleSearcher
7
+ from DeepWEBS.networks.webpage_fetcher import BatchWebpageFetcher
8
+ from DeepWEBS.documents.query_results_extractor import QueryResultsExtractor
9
+ from DeepWEBS.documents.webpage_content_extractor import BatchWebpageContentExtractor
10
+ from DeepWEBS.utilsdw.logger import logger
11
+ import argparse
12
+
13
+ class DeepWEBS:
14
+ def __init__(self):
15
+ pass
16
+
17
+ class DeepSearch(BaseModel):
18
+ queries: list = Field(
19
+ default=[""],
20
+ description="(list[str]) Queries to search",
21
+ )
22
+ result_num: int = Field(
23
+ default=10,
24
+ description="(int) Number of search results",
25
+ )
26
+ safe: bool = Field(
27
+ default=False,
28
+ description="(bool) Enable SafeSearch",
29
+ )
30
+ types: list = Field(
31
+ default=["web"],
32
+ description="(list[str]) Types of search results: `web`, `image`, `videos`, `news`",
33
+ )
34
+ extract_webpage: bool = Field(
35
+ default=False,
36
+ description="(bool) Enable extracting main text contents from webpage, will add `text` filed in each `query_result` dict",
37
+ )
38
+ overwrite_query_html: bool = Field(
39
+ default=False,
40
+ description="(bool) Overwrite HTML file of query results",
41
+ )
42
+ overwrite_webpage_html: bool = Field(
43
+ default=False,
44
+ description="(bool) Overwrite HTML files of webpages from query results",
45
+ )
46
+
47
+ def queries_to_search_results(self, item: DeepSearch):
48
+ google_searcher = GoogleSearcher()
49
+ queries_search_results = []
50
+ for query in item.queries:
51
+ query_results_extractor = QueryResultsExtractor()
52
+ if not query.strip():
53
+ continue
54
+ try:
55
+ query_html_path = google_searcher.search(
56
+ query=query,
57
+ result_num=item.result_num,
58
+ safe=item.safe,
59
+ overwrite=item.overwrite_query_html,
60
+ )
61
+ except Exception as e:
62
+ logger.error(f"Failed to search for query '{query}': {e}")
63
+ continue
64
+
65
+ try:
66
+ query_search_results = query_results_extractor.extract(query_html_path)
67
+ except Exception as e:
68
+ logger.error(f"Failed to extract search results for query '{query}': {e}")
69
+ continue
70
+
71
+ queries_search_results.append(query_search_results)
72
+ logger.note(queries_search_results)
73
+
74
+ if item.extract_webpage:
75
+ queries_search_results = self.extract_webpages(
76
+ queries_search_results,
77
+ overwrite_webpage_html=item.overwrite_webpage_html,
78
+ )
79
+ return queries_search_results
80
+
81
+ def extract_webpages(self, queries_search_results, overwrite_webpage_html=False):
82
+ for query_idx, query_search_results in enumerate(queries_search_results):
83
+ try:
84
+ # Fetch webpages with urls
85
+ batch_webpage_fetcher = BatchWebpageFetcher()
86
+ urls = [
87
+ query_result["url"]
88
+ for query_result in query_search_results["query_results"]
89
+ ]
90
+ url_and_html_path_list = batch_webpage_fetcher.fetch(
91
+ urls,
92
+ overwrite=overwrite_webpage_html,
93
+ output_parent=query_search_results["query"],
94
+ )
95
+ except Exception as e:
96
+ logger.error(f"Failed to fetch webpages for query '{query_search_results['query']}': {e}")
97
+ continue
98
+
99
+ # Extract webpage contents from htmls
100
+ html_paths = [
101
+ str(url_and_html_path["html_path"])
102
+ for url_and_html_path in url_and_html_path_list
103
+ ]
104
+ batch_webpage_content_extractor = BatchWebpageContentExtractor()
105
+ try:
106
+ html_path_and_extracted_content_list = (
107
+ batch_webpage_content_extractor.extract(html_paths)
108
+ )
109
+ except Exception as e:
110
+ logger.error(f"Failed to extract webpage contents for query '{query_search_results['query']}': {e}")
111
+ continue
112
+
113
+ # Build the map of url to extracted_content
114
+ html_path_to_url_dict = {
115
+ str(url_and_html_path["html_path"]): url_and_html_path["url"]
116
+ for url_and_html_path in url_and_html_path_list
117
+ }
118
+ url_to_extracted_content_dict = {
119
+ html_path_to_url_dict[
120
+ html_path_and_extracted_content["html_path"]
121
+ ]: html_path_and_extracted_content["extracted_content"]
122
+ for html_path_and_extracted_content in html_path_and_extracted_content_list
123
+ }
124
+
125
+ # Write extracted contents (as 'text' field) to query_search_results
126
+ for query_result_idx, query_result in enumerate(
127
+ query_search_results["query_results"]
128
+ ):
129
+ url = query_result["url"]
130
+ extracted_content = url_to_extracted_content_dict.get(url, "")
131
+ queries_search_results[query_idx]["query_results"][query_result_idx][
132
+ "text"
133
+ ] = extracted_content
134
+
135
+ return queries_search_results
136
+
137
+
138
+ class ArgParser(argparse.ArgumentParser):
139
+ def __init__(self, *args, **kwargs):
140
+ super(ArgParser, self).__init__(*args, **kwargs)
141
+
142
+ self.add_argument(
143
+ "-q",
144
+ "--queries",
145
+ type=str,
146
+ nargs="+",
147
+ required=True,
148
+ help="Queries to search",
149
+ )
150
+ self.add_argument(
151
+ "-n",
152
+ "--result_num",
153
+ type=int,
154
+ default=10,
155
+ help="Number of search results",
156
+ )
157
+ self.add_argument(
158
+ "-s",
159
+ "--safe",
160
+ default=False,
161
+ action="store_true",
162
+ help="Enable SafeSearch",
163
+ )
164
+ self.add_argument(
165
+ "-t",
166
+ "--types",
167
+ type=str,
168
+ nargs="+",
169
+ default=["web"],
170
+ choices=["web", "image", "videos", "news"],
171
+ help="Types of search results",
172
+ )
173
+ self.add_argument(
174
+ "-e",
175
+ "--extract_webpage",
176
+ default=False,
177
+ action="store_true",
178
+ help="Enable extracting main text contents from webpage",
179
+ )
180
+ self.add_argument(
181
+ "-o",
182
+ "--overwrite_query_html",
183
+ default=False,
184
+ action="store_true",
185
+ help="Overwrite HTML file of query results",
186
+ )
187
+ self.add_argument(
188
+ "-w",
189
+ "--overwrite_webpage_html",
190
+ default=False,
191
+ action="store_true",
192
+ help="Overwrite HTML files of webpages from query results",
193
+ )
194
+
195
+ self.args = self.parse_args()
196
+
197
+
@@ -9,6 +9,7 @@ from .webscout_search import WEBS
9
9
  from .webscout_search_async import AsyncWEBS
10
10
  from .version import __version__
11
11
  from .DWEBS import DeepWEBS
12
+ from .offlineAI import GPT4ALL
12
13
  __all__ = ["WEBS", "AsyncWEBS", "__version__", "cli"]
13
14
 
14
15
  logging.getLogger("webscout").addHandler(logging.NullHandler())
@@ -0,0 +1,206 @@
1
+ from webscout.AIutel import Optimizers
2
+ from webscout.AIutel import Conversation
3
+ from webscout.AIutel import AwesomePrompts
4
+ from webscout.AIbase import Provider
5
+ from gpt4all import GPT4All
6
+ from gpt4all.gpt4all import empty_chat_session
7
+ from gpt4all.gpt4all import append_extension_if_missing
8
+
9
+
10
+ import logging
11
+
12
+ my_logger = logging.getLogger("gpt4all")
13
+ my_logger.setLevel(logging.CRITICAL)
14
+
15
+
16
+ class GPT4ALL(Provider):
17
+ def __init__(
18
+ self,
19
+ model: str,
20
+ is_conversation: bool = True,
21
+ max_tokens: int = 800,
22
+ temperature: float = 0.7,
23
+ presence_penalty: int = 0,
24
+ frequency_penalty: int = 1.18,
25
+ top_p: float = 0.4,
26
+ intro: str = None,
27
+ filepath: str = None,
28
+ update_file: bool = True,
29
+ history_offset: int = 10250,
30
+ act: str = None,
31
+ ):
32
+ """Instantiates GPT4ALL
33
+
34
+ Args:
35
+ model (str, optional): Path to LLM model (.gguf or .bin).
36
+ is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
37
+ max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 800.
38
+ temperature (float, optional): Charge of the generated text's randomness. Defaults to 0.7.
39
+ presence_penalty (int, optional): Chances of topic being repeated. Defaults to 0.
40
+ frequency_penalty (int, optional): Chances of word being repeated. Defaults to 1.18.
41
+ top_p (float, optional): Sampling threshold during inference time. Defaults to 0.4.
42
+ intro (str, optional): Conversation introductory prompt. Defaults to None.
43
+ filepath (str, optional): Path to file containing conversation history. Defaults to None.
44
+ update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
45
+ history_offset (int, optional): Limit conversation history to this number of last texts. Defaults to 10250.
46
+ act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
47
+ """
48
+ self.is_conversation = is_conversation
49
+ self.max_tokens_to_sample = max_tokens
50
+ self.model = model
51
+ self.temperature = temperature
52
+ self.presence_penalty = presence_penalty
53
+ self.frequency_penalty = frequency_penalty
54
+ self.top_p = top_p
55
+ self.last_response = {}
56
+
57
+ self.__available_optimizers = (
58
+ method
59
+ for method in dir(Optimizers)
60
+ if callable(getattr(Optimizers, method)) and not method.startswith("__")
61
+ )
62
+ Conversation.intro = (
63
+ AwesomePrompts().get_act(
64
+ act, raise_not_found=True, default=None, case_insensitive=True
65
+ )
66
+ if act
67
+ else intro or Conversation.intro
68
+ )
69
+ self.conversation = Conversation(
70
+ is_conversation, self.max_tokens_to_sample, filepath, update_file
71
+ )
72
+ self.conversation.history_offset = history_offset
73
+
74
+ def get_model_name_path():
75
+ import os
76
+ from pathlib import Path
77
+
78
+ initial_model_path = Path(append_extension_if_missing(model))
79
+ if initial_model_path.exists:
80
+ if not initial_model_path.is_absolute():
81
+ initial_model_path = Path(os.getcwd()) / initial_model_path
82
+ return os.path.split(initial_model_path.as_posix())
83
+ else:
84
+ raise FileNotFoundError(
85
+ "File does not exist " + initial_model_path.as_posix()
86
+ )
87
+
88
+ model_dir, model_name = get_model_name_path()
89
+
90
+ self.gpt4all = GPT4All(
91
+ model_name=model_name,
92
+ model_path=model_dir,
93
+ allow_download=False,
94
+ verbose=False,
95
+ )
96
+
97
+ def ask(
98
+ self,
99
+ prompt: str,
100
+ stream: bool = False,
101
+ raw: bool = False,
102
+ optimizer: str = None,
103
+ conversationally: bool = False,
104
+ ) -> dict:
105
+ """Chat with AI
106
+
107
+ Args:
108
+ prompt (str): Prompt to be send.
109
+ stream (bool, optional): Flag for streaming response. Defaults to False.
110
+ raw (bool, optional): Stream back raw response as received. Defaults to False.
111
+ optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
112
+ conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
113
+ Returns:
114
+ dict : {}
115
+ ```json
116
+ {
117
+ "text" : "How may I help you today?"
118
+ }
119
+ ```
120
+ """
121
+ conversation_prompt = self.conversation.gen_complete_prompt(prompt)
122
+ if optimizer:
123
+ if optimizer in self.__available_optimizers:
124
+ conversation_prompt = getattr(Optimizers, optimizer)(
125
+ conversation_prompt if conversationally else prompt
126
+ )
127
+ else:
128
+ raise Exception(
129
+ f"Optimizer is not one of {self.__available_optimizers}"
130
+ )
131
+
132
+ def for_stream():
133
+ response = self.gpt4all.generate(
134
+ prompt=conversation_prompt,
135
+ max_tokens=self.max_tokens_to_sample,
136
+ temp=self.temperature,
137
+ top_p=self.top_p,
138
+ repeat_penalty=self.frequency_penalty,
139
+ streaming=True,
140
+ )
141
+
142
+ message_load: str = ""
143
+ for token in response:
144
+ message_load += token
145
+ resp: dict = dict(text=message_load)
146
+ yield token if raw else resp
147
+ self.last_response.update(resp)
148
+
149
+ self.conversation.update_chat_history(
150
+ prompt, self.get_message(self.last_response)
151
+ )
152
+ self.gpt4all.current_chat_session = empty_chat_session()
153
+
154
+ def for_non_stream():
155
+ for _ in for_stream():
156
+ pass
157
+ return self.last_response
158
+
159
+ return for_stream() if stream else for_non_stream()
160
+
161
+ def chat(
162
+ self,
163
+ prompt: str,
164
+ stream: bool = False,
165
+ optimizer: str = None,
166
+ conversationally: bool = False,
167
+ ) -> str:
168
+ """Generate response `str`
169
+ Args:
170
+ prompt (str): Prompt to be send.
171
+ stream (bool, optional): Flag for streaming response. Defaults to False.
172
+ optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
173
+ conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
174
+ Returns:
175
+ str: Response generated
176
+ """
177
+
178
+ def for_stream():
179
+ for response in self.ask(
180
+ prompt, True, optimizer=optimizer, conversationally=conversationally
181
+ ):
182
+ yield self.get_message(response)
183
+
184
+ def for_non_stream():
185
+ return self.get_message(
186
+ self.ask(
187
+ prompt,
188
+ False,
189
+ optimizer=optimizer,
190
+ conversationally=conversationally,
191
+ )
192
+ )
193
+
194
+ return for_stream() if stream else for_non_stream()
195
+
196
+ def get_message(self, response: dict) -> str:
197
+ """Retrieves message only from response
198
+
199
+ Args:
200
+ response (str): Response generated by `self.ask`
201
+
202
+ Returns:
203
+ str: Message extracted
204
+ """
205
+ assert isinstance(response, dict), "Response should be of dict data-type only"
206
+ return response["text"]
@@ -0,0 +1,2 @@
1
+ __version__ = "1.2.4"
2
+
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: webscout
3
- Version: 1.2.3
3
+ Version: 1.2.4
4
4
  Summary: Search for words, documents, images, videos, news, maps and text translation using the Google, DuckDuckGo.com, yep.com, phind.com, you.com, etc Also containes AI models
5
5
  Author: OEvortex
6
6
  Author-email: helpingai5@gmail.com
@@ -45,6 +45,8 @@ Requires-Dist: sse_starlette
45
45
  Requires-Dist: termcolor
46
46
  Requires-Dist: tiktoken
47
47
  Requires-Dist: tldextract
48
+ Requires-Dist: gpt4all
49
+ Requires-Dist: orjson
48
50
  Provides-Extra: dev
49
51
  Requires-Dist: ruff>=0.1.6; extra == "dev"
50
52
  Requires-Dist: pytest>=7.4.2; extra == "dev"
@@ -92,6 +94,7 @@ Also containes AI models that you can use
92
94
  - [6. `BlackBox` - Search/chat With BlackBox](#6-blackbox---searchchat-with-blackbox)
93
95
  - [7. `PERPLEXITY` - Search With PERPLEXITY](#7-perplexity---search-with-perplexity)
94
96
  - [8. `OpenGPT` - chat With OPENGPT](#8-opengpt---chat-with-opengpt)
97
+ - [9. `GPT4ALL` - chat offline with Language models using gpt4all from webscout](#9-gpt4all---chat-offline-with-language-models-using-gpt4all-from-webscout)
95
98
  - [usage of special .LLM file from webscout (webscout.LLM)](#usage-of-special-llm-file-from-webscout-webscoutllm)
96
99
  - [`LLM`](#llm)
97
100
 
@@ -605,6 +608,37 @@ prompt = "tell me about india"
605
608
  response_str = opengpt.chat(prompt)
606
609
  print(response_str)
607
610
  ```
611
+ ### 9. `GPT4ALL` - chat offline with Language models using gpt4all from webscout
612
+ ```python
613
+ from webscout import GPT4ALL
614
+
615
+ # Initialize the GPT4ALL class with your model path and other optional parameters
616
+ gpt4all_instance = GPT4ALL(
617
+ model="path/to/your/model/file", # Replace with the actual path to your model file
618
+ is_conversation=True,
619
+ max_tokens=800,
620
+ temperature=0.7,
621
+ presence_penalty=0,
622
+ frequency_penalty=1.18,
623
+ top_p=0.4,
624
+ intro="Hello, how can I assist you today?",
625
+ filepath="path/to/conversation/history/file", # Optional, for conversation history
626
+ update_file=True,
627
+ history_offset=10250,
628
+ act=None # Optional, for using an awesome prompt as intro
629
+ )
630
+
631
+ # Generate a response from the AI model
632
+ response = gpt4all_instance.chat(
633
+ prompt="What is the weather like today?",
634
+ stream=False, # Set to True if you want to stream the response
635
+ optimizer=None, # Optional, specify an optimizer if needed
636
+ conversationally=False # Set to True for conversationally generated responses
637
+ )
638
+
639
+ # Print the generated response
640
+ print(response)
641
+ ```
608
642
 
609
643
  ## usage of special .LLM file from webscout (webscout.LLM)
610
644
 
@@ -24,6 +24,7 @@ webscout/__main__.py
24
24
  webscout/cli.py
25
25
  webscout/exceptions.py
26
26
  webscout/models.py
27
+ webscout/offlineAI.py
27
28
  webscout/utils.py
28
29
  webscout/version.py
29
30
  webscout/webscout_search.py
@@ -19,6 +19,8 @@ sse_starlette
19
19
  termcolor
20
20
  tiktoken
21
21
  tldextract
22
+ gpt4all
23
+ orjson
22
24
 
23
25
  [dev]
24
26
  ruff>=0.1.6
@@ -1,2 +0,0 @@
1
- __version__ = "1.2.3"
2
-
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes