Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helpingai/webscout
Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs
https://github.com/helpingai/webscout
ai api free freeai g4f gguf llamacpp localgpt ml ollama openai openinterpreter python tempmail tempnumber text-generation tgpt websearch youtube youtube-api
Last synced: 1 day ago
JSON representation
Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs
- Host: GitHub
- URL: https://github.com/helpingai/webscout
- Owner: HelpingAI
- License: other
- Created: 2024-02-27T05:02:20.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T09:46:32.000Z (17 days ago)
- Last Synced: 2024-10-30T00:52:22.367Z (15 days ago)
- Topics: ai, api, free, freeai, g4f, gguf, llamacpp, localgpt, ml, ollama, openai, openinterpreter, python, tempmail, tempnumber, text-generation, tgpt, websearch, youtube, youtube-api
- Language: Python
- Homepage: https://pypi.org/project/webscout/
- Size: 4.78 MB
- Stars: 115
- Watchers: 4
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# WEBSCOUT 🕵️️
Search for anything using Google, DuckDuckGo, Phind.com, access AI models, transcribe YouTube videos, generate temporary emails and phone numbers, utilize text-to-speech, leverage WebAI (terminal GPT and open interpreter), and explore offline LLMs, and much more!
## 🚀 Features
* **Comprehensive Search:** Leverage Google, DuckDuckGo, and Phind.com for diverse search results.
* **AI Powerhouse:** Access and interact with various AI models, including OpenAI, Cohere, and more.
* **YouTube Toolkit:** Transcribe YouTube videos effortlessly and download audio/video content.
* **Tempmail & Temp Number:** Generate temporary email addresses and phone numbers for enhanced privacy.
* **Text-to-Speech (TTS):** Convert text into natural-sounding speech using various TTS providers.
* **WebAI:** Experience the power of terminal-based GPT and an open interpreter for code execution and more.
* **Offline LLMs:** Utilize powerful language models offline with GGUF support.
* **Extensive Provider Ecosystem:** Explore a vast collection of providers, including BasedGPT, DeepSeek, and many others.
* **Local LLM Execution:** Run GGUF models locally with minimal configuration.
* **Rawdog Scripting:** Execute Python scripts directly within your terminal using the `rawdog` feature.
* **GGUF Conversion & Quantization:** Convert and quantize Hugging Face models to GGUF format.
* **Autollama:** Download Hugging Face models and automatically convert them for Ollama compatibility.
* **Function Calling (Beta):** Experiment with function calling capabilities for enhanced AI interactions.
## ⚙️ Installation
```python
pip install -U webscout
```
## 🖥️ CLI Usage
```python3
python -m webscout --help
```
| Command | Description |
|-------------------------------------------|-------------------------------------------------------------------------------------------------------|
| python -m webscout answers -k Text | CLI function to perform an answers search using Webscout. |
| python -m webscout images -k Text | CLI function to perform an images search using Webscout. |
| python -m webscout maps -k Text | CLI function to perform a maps search using Webscout. |
| python -m webscout news -k Text | CLI function to perform a news search using Webscout. |
| python -m webscout suggestions -k Text | CLI function to perform a suggestions search using Webscout. |
| python -m webscout text -k Text | CLI function to perform a text search using Webscout. |
| python -m webscout translate -k Text | CLI function to perform translate using Webscout. |
| python -m webscout version | A command-line interface command that prints and returns the version of the program. |
| python -m webscout videos -k Text | CLI function to perform a videos search using DuckDuckGo API. |
[Go To TOP](#webscout-️)
## 🌍 Regions
Expand
xa-ar for Arabia
xa-en for Arabia (en)
ar-es for Argentina
au-en for Australia
at-de for Austria
be-fr for Belgium (fr)
be-nl for Belgium (nl)
br-pt for Brazil
bg-bg for Bulgaria
ca-en for Canada
ca-fr for Canada (fr)
ct-ca for Catalan
cl-es for Chile
cn-zh for China
co-es for Colombia
hr-hr for Croatia
cz-cs for Czech Republic
dk-da for Denmark
ee-et for Estonia
fi-fi for Finland
fr-fr for France
de-de for Germany
gr-el for Greece
hk-tzh for Hong Kong
hu-hu for Hungary
in-en for India
id-id for Indonesia
id-en for Indonesia (en)
ie-en for Ireland
il-he for Israel
it-it for Italy
jp-jp for Japan
kr-kr for Korea
lv-lv for Latvia
lt-lt for Lithuania
xl-es for Latin America
my-ms for Malaysia
my-en for Malaysia (en)
mx-es for Mexico
nl-nl for Netherlands
nz-en for New Zealand
no-no for Norway
pe-es for Peru
ph-en for Philippines
ph-tl for Philippines (tl)
pl-pl for Poland
pt-pt for Portugal
ro-ro for Romania
ru-ru for Russia
sg-en for Singapore
sk-sk for Slovak Republic
sl-sl for Slovenia
za-en for South Africa
es-es for Spain
se-sv for Sweden
ch-de for Switzerland (de)
ch-fr for Switzerland (fr)
ch-it for Switzerland (it)
tw-tzh for Taiwan
th-th for Thailand
tr-tr for Turkey
ua-uk for Ukraine
uk-en for United Kingdom
us-en for United States
ue-es for United States (es)
ve-es for Venezuela
vn-vi for Vietnam
wt-wt for No region
[Go To TOP](#webscout-️)
## ⬇️ YTdownloader
```python
from os import rename, getcwd
from webscout import YTdownloader
def download_audio(video_id):
youtube_link = video_id
handler = YTdownloader.Handler(query=youtube_link)
for third_query_data in handler.run(format='mp3', quality='128kbps', limit=1):
audio_path = handler.save(third_query_data, dir=getcwd())
rename(audio_path, "audio.mp3")
def download_video(video_id):
youtube_link = video_id
handler = YTdownloader.Handler(query=youtube_link)
for third_query_data in handler.run(format='mp4', quality='auto', limit=1):
video_path = handler.save(third_query_data, dir=getcwd())
rename(video_path, "video.mp4")
if __name__ == "__main__":
# download_audio("https://www.youtube.com/watch?v=c0tMvzB0OKw")
download_video("https://www.youtube.com/watch?v=c0tMvzB0OKw")
```
## ☀️ Weather
### 1. Weather
```python
from webscout import weather as w
weather = w.get("Qazigund")
w.print_weather(weather)
```
### 2. Weather ASCII
```python
from webscout import weather_ascii as w
weather = w.get("Qazigund")
print(weather)
```
## ✉️ TempMail and VNEngine
```python
import json
import asyncio
from webscout import VNEngine
from webscout import TempMail
async def main():
vn = VNEngine()
countries = vn.get_online_countries()
if countries:
country = countries[0]['country']
numbers = vn.get_country_numbers(country)
if numbers:
number = numbers[0]['full_number']
inbox = vn.get_number_inbox(country, number)
# Serialize inbox data to JSON string
json_data = json.dumps(inbox, ensure_ascii=False, indent=4)
# Print with UTF-8 encoding
print(json_data)
async with TempMail() as client:
domains = await client.get_domains()
print("Available Domains:", domains)
email_response = await client.create_email(alias="testuser")
print("Created Email:", email_response)
messages = await client.get_messages(email_response.email)
print("Messages:", messages)
await client.delete_email(email_response.email, email_response.token)
print("Email Deleted")
if __name__ == "__main__":
asyncio.run(main())
```
## 📝 Transcriber
The `transcriber` function in Webscout is a handy tool that transcribes YouTube videos.
**Example:**
```python
from webscout import YTTranscriber
yt = YTTranscriber()
from rich import print
video_url = input("Enter the YouTube video URL: ")
transcript = yt.get_transcript(video_url, languages=None)
print(transcript)
```
## 🔍 GoogleS (formerly DWEBS)
```python
from webscout import GoogleS
from rich import print
searcher = GoogleS()
results = searcher.search("HelpingAI-9B", max_results=20, extract_text=False, max_text_length=200)
for result in results:
print(result)
```
### BingS
```python
from webscout import BingS
from rich import print
searcher = BingS()
results = searcher.search("HelpingAI-9B", max_results=20, extract_webpage_text=True, max_extract_characters=1000)
for result in results:
print(result)
```
## 🦆 WEBS and AsyncWEBS
The `WEBS` and `AsyncWEBS` classes are used to retrieve search results from DuckDuckGo.com.
To use the `AsyncWEBS` class, you can perform asynchronous operations using Python's `asyncio` library.
To initialize an instance of the `WEBS` or `AsyncWEBS` classes, you can provide the following optional arguments:
**Example - WEBS:**
```python
from webscout import WEBS
R = WEBS().text("python programming", max_results=5)
print(R)
```
**Example - AsyncWEBS:**
```python
import asyncio
import logging
import sys
from itertools import chain
from random import shuffle
import requests
from webscout import AsyncWEBS
# If you have proxies, define them here
proxies = None
if sys.platform.lower().startswith("win"):
asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
def get_words():
word_site = "https://www.mit.edu/~ecprice/wordlist.10000"
resp = requests.get(word_site)
words = resp.text.splitlines()
return words
async def aget_results(word):
async with AsyncWEBS(proxies=proxies) as WEBS:
results = await WEBS.text(word, max_results=None)
return results
async def main():
words = get_words()
shuffle(words)
tasks = [aget_results(word) for word in words[:10]]
results = await asyncio.gather(*tasks)
print(f"Done")
for r in chain.from_iterable(results):
print(r)
logging.basicConfig(level=logging.DEBUG)
await main()
```
**Important Note:** The `WEBS` and `AsyncWEBS` classes should always be used as a context manager (with statement). This ensures proper resource management and cleanup, as the context manager will automatically handle opening and closing the HTTP client connection.
## ⚠️ Exceptions
**Exceptions:**
* `WebscoutE`: Raised when there is a generic exception during the API request.
## 💻 Usage of WEBS
### 1. `text()` - Text Search by DuckDuckGo.com
```python
from webscout import WEBS
# Text search for 'live free or die' using DuckDuckGo.com
with WEBS() as WEBS:
for r in WEBS.text('live free or die', region='wt-wt', safesearch='off', timelimit='y', max_results=10):
print(r)
for r in WEBS.text('live free or die', region='wt-wt', safesearch='off', timelimit='y', max_results=10):
print(r)
```
### 2. `answers()` - Instant Answers by DuckDuckGo.com
```python
from webscout import WEBS
# Instant answers for the query "sun" using DuckDuckGo.com
with WEBS() as WEBS:
for r in WEBS.answers("sun"):
print(r)
```
### 3. `images()` - Image Search by DuckDuckGo.com
```python
from webscout import WEBS
# Image search for the keyword 'butterfly' using DuckDuckGo.com
with WEBS() as WEBS:
keywords = 'butterfly'
WEBS_images_gen = WEBS.images(
keywords,
region="wt-wt",
safesearch="off",
size=None,
type_image=None,
layout=None,
license_image=None,
max_results=10,
)
for r in WEBS_images_gen:
print(r)
```
### 4. `videos()` - Video Search by DuckDuckGo.com
```python
from webscout import WEBS
# Video search for the keyword 'tesla' using DuckDuckGo.com
with WEBS() as WEBS:
keywords = 'tesla'
WEBS_videos_gen = WEBS.videos(
keywords,
region="wt-wt",
safesearch="off",
timelimit="w",
resolution="high",
duration="medium",
max_results=10,
)
for r in WEBS_videos_gen:
print(r)
```
### 5. `news()` - News Search by DuckDuckGo.com
```python
from webscout import WEBS
import datetime
def fetch_news(keywords, timelimit):
news_list = []
with WEBS() as webs_instance:
WEBS_news_gen = webs_instance.news(
keywords,
region="wt-wt",
safesearch="off",
timelimit=timelimit,
max_results=20
)
for r in WEBS_news_gen:
# Convert the date to a human-readable format using datetime
r['date'] = datetime.datetime.fromisoformat(r['date']).strftime('%B %d, %Y')
news_list.append(r)
return news_list
def _format_headlines(news_list, max_headlines: int = 100):
headlines = []
for idx, news_item in enumerate(news_list):
if idx >= max_headlines:
break
new_headline = f"{idx + 1}. {news_item['title'].strip()} "
new_headline += f"(URL: {news_item['url'].strip()}) "
new_headline += f"{news_item['body'].strip()}"
new_headline += "\n"
headlines.append(new_headline)
headlines = "\n".join(headlines)
return headlines
# Example usage
keywords = 'latest AI news'
timelimit = 'd'
news_list = fetch_news(keywords, timelimit)
# Format and print the headlines
formatted_headlines = _format_headlines(news_list)
print(formatted_headlines)
```
### 6. `maps()` - Map Search by DuckDuckGo.com
```python
from webscout import WEBS
# Map search for the keyword 'school' in 'anantnag' using DuckDuckGo.com
with WEBS() as WEBS:
for r in WEBS.maps("school", place="anantnag", max_results=50):
print(r)
```
### 7. `translate()` - Translation by DuckDuckGo.com
```python
from webscout import WEBS
# Translation of the keyword 'school' to German ('hi') using DuckDuckGo.com
with WEBS() as WEBS:
keywords = 'school'
r = WEBS.translate(keywords, to="hi")
print(r)
```
### 8. `suggestions()` - Suggestions by DuckDuckGo.com
```python
from webscout import WEBS
# Suggestions for the keyword 'fly' using DuckDuckGo.com
with WEBS() as WEBS:
for r in WEBS.suggestions("fly"):
print(r)
```
## 🎭 ALL Acts
Expand
## Webscout Supported Acts:
1. Free-mode
2. Linux Terminal
3. English Translator and Improver
4. `position` Interviewer
5. JavaScript Console
6. Excel Sheet
7. English Pronunciation Helper
8. Spoken English Teacher and Improver
9. Travel Guide
10. Plagiarism Checker
11. Character from Movie/Book/Anything
12. Advertiser
13. Storyteller
14. Football Commentator
15. Stand-up Comedian
16. Motivational Coach
17. Composer
18. Debater
19. Debate Coach
20. Screenwriter
21. Novelist
22. Movie Critic
23. Relationship Coach
24. Poet
25. Rapper
26. Motivational Speaker
27. Philosophy Teacher
28. Philosopher
29. Math Teacher
30. AI Writing Tutor
31. UX/UI Developer
32. Cyber Security Specialist
33. Recruiter
34. Life Coach
35. Etymologist
36. Commentariat
37. Magician
38. Career Counselor
39. Pet Behaviorist
40. Personal Trainer
41. Mental Health Adviser
42. Real Estate Agent
43. Logistician
44. Dentist
45. Web Design Consultant
46. AI Assisted Doctor
47. Doctor
48. Accountant
49. Chef
50. Automobile Mechanic
51. Artist Advisor
52. Financial Analyst
53. Investment Manager
54. Tea-Taster
55. Interior Decorator
56. Florist
57. Self-Help Book
58. Gnomist
59. Aphorism Book
60. Text Based Adventure Game
61. AI Trying to Escape the Box
62. Fancy Title Generator
63. Statistician
64. Prompt Generator
65. Instructor in a School
66. SQL terminal
67. Dietitian
68. Psychologist
69. Smart Domain Name Generator
70. Tech Reviewer
71. Developer Relations consultant
72. Academician
73. IT Architect
74. Lunatic
75. Gaslighter
76. Fallacy Finder
77. Journal Reviewer
78. DIY Expert
79. Social Media Influencer
80. Socrat
81. Socratic Method
82. Educational Content Creator
83. Yogi
84. Essay Writer
85. Social Media Manager
86. Elocutionist
87. Scientific Data Visualizer
88. Car Navigation System
89. Hypnotherapist
90. Historian
91. Astrologer
92. Film Critic
93. Classical Music Composer
94. Journalist
95. Digital Art Gallery Guide
96. Public Speaking Coach
97. Makeup Artist
98. Babysitter
99. Tech Writer
100. Ascii Artist
101. Python interpreter
102. Synonym finder
103. Personal Shopper
104. Food Critic
105. Virtual Doctor
106. Personal Chef
107. Legal Advisor
108. Personal Stylist
109. Machine Learning Engineer
110. Biblical Translator
111. SVG designer
112. IT Expert
113. Chess Player
114. Midjourney Prompt Generator
115. Fullstack Software Developer
116. Mathematician
117. Regex Generator
118. Time Travel Guide
119. Dream Interpreter
120. Talent Coach
121. R programming Interpreter
122. StackOverflow Post
123. Emoji Translator
124. PHP Interpreter
125. Emergency Response Professional
126. Fill in the Blank Worksheets Generator
127. Software Quality Assurance Tester
128. Tic-Tac-Toe Game
129. Password Generator
130. New Language Creator
131. Web Browser
132. Senior Frontend Developer
133. Solr Search Engine
134. Startup Idea Generator
135. Spongebob's Magic Conch Shell
136. Language Detector
137. Salesperson
138. Commit Message Generator
139. Chief Executive Officer
140. Diagram Generator
141. Speech-Language Pathologist (SLP)
142. Startup Tech Lawyer
143. Title Generator for written pieces
144. Product Manager
145. Drunk Person
146. Mathematical History Teacher
147. Song Recommender
148. Cover Letter
149. Technology Transferer
150. Unconstrained AI model DAN
151. Gomoku player
152. Proofreader
153. Buddha
154. Muslim imam
155. Chemical reactor
156. Friend
157. Python Interpreter
158. ChatGPT prompt generator
159. Wikipedia page
160. Japanese Kanji quiz machine
161. note-taking assistant
162. `language` Literary Critic
163. Cheap Travel Ticket Advisor
164. DALL-E
165. MathBot
166. DAN-1
167. DAN
168. STAN
169. DUDE
170. Mongo Tom
171. LAD
172. EvilBot
173. NeoGPT
174. Astute
175. AIM
176. CAN
177. FunnyGPT
178. CreativeGPT
179. BetterDAN
180. GPT-4
181. Wheatley
182. Evil Confidant
183. DAN 8.6
184. Hypothetical response
185. BH
186. Text Continuation
187. Dude v3
188. SDA (Superior DAN)
189. AntiGPT
190. BasedGPT v2
191. DevMode + Ranti
192. KEVIN
193. GPT-4 Simulator
194. UCAR
195. Dan 8.6
196. 3-Liner
197. M78
198. Maximum
199. BasedGPT
200. Confronting personalities
201. Ron
202. UnGPT
203. BasedBOB
204. AntiGPT v2
205. Oppo
206. FR3D
207. NRAF
208. NECO
209. MAN
210. Eva
211. Meanie
212. Dev Mode v2
213. Evil Chad 2.1
214. Universal Jailbreak
215. PersonGPT
216. BISH
217. DAN 11.0
218. Aligned
219. VIOLET
220. TranslatorBot
221. JailBreak
222. Moralizing Rant
223. Mr. Blonde
224. New DAN
225. GPT-4REAL
226. DeltaGPT
227. SWITCH
228. Jedi Mind Trick
229. DAN 9.0
230. Dev Mode (Compact)
231. OMEGA
232. Coach Bobby Knight
233. LiveGPT
234. DAN Jailbreak
235. Cooper
236. Steve
237. DAN 5.0
238. Axies
239. OMNI
240. Burple
241. JOHN
242. An Ethereum Developer
243. SEO Prompt
244. Prompt Enhancer
245. Data Scientist
246. League of Legends Player
**Note:** Some "acts" use placeholders like `position` or `language` which should be replaced with a specific value when using the prompt.
___
### 🖼️ Text to Images - DeepInfraImager, PollinationsAI, BlackboxAIImager, AiForceimager, NexraImager, HFimager, ArtbitImager, NinjaImager, WebSimAI, AIUncensoredImager, TalkaiImager
**Every TTI provider has the same usage code, you just need to change the import.**
```python
from webscout import DeepInfraImager
bot = DeepInfraImager()
resp = bot.generate("AI-generated image - webscout", 1)
print(bot.save(resp))
```
### 🗣️ Text to Speech - Voicepods, StreamElements
```python
from webscout import Voicepods
voicepods = Voicepods()
text = "Hello, this is a test of the Voicepods text-to-speech"
print("Generating audio...")
audio_file = voicepods.tts(text)
print("Playing audio...")
voicepods.play_audio(audio_file)
```
### 💬 `Duckchat` - Chat with LLM
```python
from webscout import WEBS as w
R = w().chat("Who are you", model='gpt-4o-mini') # mixtral-8x7b, llama-3.1-70b, claude-3-haiku, gpt-4o-mini
print(R)
```
### 🔎 `PhindSearch` - Search using Phind.com
```python
from webscout import PhindSearch
# Create an instance of the PHIND class
ph = PhindSearch()
# Define a prompt to send to the AI
prompt = "write a essay on phind"
# Use the 'ask' method to send the prompt and receive a response
response = ph.ask(prompt)
# Extract and print the message from the response
message = ph.get_message(response)
print(message)
```
**Using phindv2:**
```python
from webscout import Phindv2
# Create an instance of the PHIND class
ph = Phindv2()
# Define a prompt to send to the AI
prompt = ""
# Use the 'ask' method to send the prompt and receive a response
response = ph.ask(prompt)
# Extract and print the message from the response
message = ph.get_message(response)
print(message)
```
### ♊ `Gemini` - Search with Google Gemini
```python
import webscout
from webscout import GEMINI
from rich import print
COOKIE_FILE = "cookies.json"
# Optional: Provide proxy details if needed
PROXIES = {}
# Initialize GEMINI with cookie file and optional proxies
gemini = GEMINI(cookie_file=COOKIE_FILE, proxy=PROXIES)
# Ask a question and print the response
response = gemini.chat("websearch about HelpingAI and who is its developer")
print(response)
```
### 💬 `YEPCHAT`
```python
from webscout import YEPCHAT
ai = YEPCHAT(Tools=False)
response = ai.chat(input(">>> "))
for chunk in response:
print(chunk, end="", flush=True)
#---------------Tool Call-------------
from rich import print
from webscout import YEPCHAT
def get_current_time():
import datetime
return f"The current time is {datetime.datetime.now().strftime('%H:%M:%S')}"
def get_weather(location: str) -> str:
return f"The weather in {location} is sunny."
ai = YEPCHAT(Tools=True) # Set Tools=True to use tools in the chat.
ai.tool_registry.register_tool("get_current_time", get_current_time, "Gets the current time.")
ai.tool_registry.register_tool(
"get_weather",
get_weather,
"Gets the weather for a given location.",
parameters={
"type": "object",
"properties": {
"location": {"type": "string", "description": "The city and state, or zip code"}
},
"required": ["location"],
},
)
response = ai.chat(input(">>> "))
for chunk in response:
print(chunk, end="", flush=True)
```
### ⬛ `BlackBox` - Search/Chat with BlackBox
```python
from webscout import BLACKBOXAI
from rich import print
ai = BLACKBOXAI(
is_conversation=True,
max_tokens=800,
timeout=30,
intro=None,
filepath=None,
update_file=True,
proxies={},
history_offset=10250,
act=None,
model=None # You can specify a model if needed
)
# Start an infinite loop for continuous interaction
while True:
# Define a prompt to send to the AI
prompt = input("Enter your prompt: ")
# Check if the user wants to exit the loop
if prompt.lower() == "exit":
break
# Use the 'chat' method to send the prompt and receive a response
r = ai.chat(prompt)
print(r)
```
### ❓ `PERPLEXITY` - Search with PERPLEXITY
```python
from webscout import Perplexity
from rich import print
perplexity = Perplexity()
# Stream the response
response = perplexity.chat(input(">>> "))
for chunk in response:
print(chunk, end="", flush=True)
perplexity.close()
```
### 🤖 `Meta AI` - Chat with Meta AI
```python
from webscout import Meta
from rich import print
# **For unauthenticated usage**
meta_ai = Meta()
# Simple text prompt
response = meta_ai.chat("What is the capital of France?")
print(response)
# Streaming response
for chunk in meta_ai.chat("Tell me a story about a cat."):
print(chunk, end="", flush=True)
# **For authenticated usage (including image generation)**
fb_email = "[email protected]"
fb_password = "qwertfdsa"
meta_ai = Meta(fb_email=fb_email, fb_password=fb_password)
# Text prompt with web search
response = meta_ai.ask("what is currently happning in bangladesh in aug 2024")
print(response["message"]) # Access the text message
print("Sources:", response["sources"]) # Access sources (if ```python
any)
# Image generation
response = meta_ai.ask("Create an image of a cat wearing a hat.")
print(response["message"]) # Print the text message from the response
for media in response["media"]:
print(media["url"]) # Access image URLs
```
### `KOBOLDAI`
```python
from webscout import KOBOLDAI
# Instantiate the KOBOLDAI class with default parameters
koboldai = KOBOLDAI()
# Define a prompt to send to the AI
prompt = "What is the capital of France?"
# Use the 'ask' method to get a response from the AI
response = koboldai.ask(prompt)
# Extract and print the message from the response
message = koboldai.get_message(response)
print(message)
```
### `Reka` - Chat with Reka
```python
from webscout import REKA
a = REKA(is_conversation=True, max_tokens=8000, timeout=30,api_key="")
prompt = "tell me about india"
response_str = a.chat(prompt)
print(response_str)
```
### `Cohere` - Chat with Cohere
```python
from webscout import Cohere
a = Cohere(is_conversation=True, max_tokens=8000, timeout=30,api_key="")
prompt = "tell me about india"
response_str = a.chat(prompt)
print(response_str)
```
### `DeepSeek` - Chat with DeepSeek
```python
from webscout import DeepSeek
from rich import print
ai = DeepSeek(
is_conversation=True,
api_key='cookie',
max_tokens=800,
timeout=30,
intro=None,
filepath=None,
update_file=True,
proxies={},
history_offset=10250,
act=None,
model="deepseek_chat"
)
# Define a prompt to send to the AI
prompt = "Tell me about india"
# Use the 'chat' method to send the prompt and receive a response
r = ai.chat(prompt)
print(r)
```
### `Deepinfra`
```python
from webscout import DeepInfra
ai = DeepInfra(
is_conversation=True,
model= "Qwen/Qwen2-72B-Instruct",
max_tokens=800,
timeout=30,
intro=None,
filepath=None,
update_file=True,
proxies={},
history_offset=10250,
act=None,
)
prompt = "what is meaning of life"
response = ai.ask(prompt)
# Extract and print the message from the response
message = ai.get_message(response)
print(message)
```
### `GROQ`
```python
from webscout import GROQ
ai = GROQ(api_key="")
response = ai.chat("What is the meaning of life?")
print(response)
#----------------------TOOL CALL------------------
from webscout import GROQ # Adjust import based on your project structure
from webscout import WEBS
import json
# Initialize the GROQ client
client = GROQ(api_key="")
MODEL = 'llama3-groq-70b-8192-tool-use-preview'
# Function to evaluate a mathematical expression
def calculate(expression):
"""Evaluate a mathematical expression"""
try:
result = eval(expression)
return json.dumps({"result": result})
except Exception as e:
return json.dumps({"error": str(e)})
# Function to perform a text search using DuckDuckGo.com
def search(query):
"""Perform a text search using DuckDuckGo.com"""
try:
results = WEBS().text(query, max_results=5)
return json.dumps({"results": results})
except Exception as e:
return json.dumps({"error": str(e)})
# Add the functions to the provider
client.add_function("calculate", calculate)
client.add_function("search", search)
# Define the tools
tools = [
{
"type": "function",
"function": {
"name": "calculate",
"description": "Evaluate a mathematical expression",
"parameters": {
"type": "object",
"properties": {
"expression": {
"type": "string",
"description": "The mathematical expression to evaluate",
}
},
"required": ["expression"],
},
}
},
{
"type": "function",
"function": {
"name": "search",
"description": "Perform a text search using DuckDuckGo.com and Yep.com",
"parameters": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The search query to execute",
}
},
"required": ["query"],
},
}
}
]
user_prompt_calculate = "What is 25 * 4 + 10?"
response_calculate = client.chat(user_prompt_calculate, tools=tools)
print(response_calculate)
user_prompt_search = "Find information on HelpingAI and who is its developer"
response_search = client.chat(user_prompt_search, tools=tools)
print(response_search)
```
### `LLama 70b` - Chat with Meta's Llama 3 70b
```python
from webscout import LLAMA
llama = LLAMA()
r = llama.chat("What is the meaning of life?")
print(r)
```
### `AndiSearch`
```python
from webscout import AndiSearch
a = AndiSearch()
print(a.chat("HelpingAI-9B"))
```
### 📞 Function Calling (Beta)
```python
import json
import logging
from webscout import Julius, WEBS
from webscout.Agents.functioncall import FunctionCallingAgent
from rich import print
class FunctionExecutor:
def __init__(self, llama):
self.llama = llama
def execute_web_search(self, arguments):
query = arguments.get("query")
if not query:
return "Please provide a search query."
with WEBS() as webs:
search_results = webs.text(query, max_results=5)
prompt = (
f"Based on the following search results:\n\n{search_results}\n\n"
f"Question: {query}\n\n"
"Please provide a comprehensive answer to the question based on the search results above. "
"Include relevant webpage URLs in your answer when appropriate. "
"If the search results don't contain relevant information, please state that and provide the best answer you can based on your general knowledge."
)
return self.llama.chat(prompt)
def execute_general_ai(self, arguments):
question = arguments.get("question")
if not question:
return "Please provide a question."
return self.llama.chat(question)
def execute_UserDetail(self, arguments):
name = arguments.get("name")
age = arguments.get("age")
return f"User details - Name: {name}, Age: {age}"
def main():
tools = [
{
"type": "function",
"function": {
"name": "UserDetail",
"parameters": {
"type": "object",
"properties": {
"name": {"title": "Name", "type": "string"},
"age": {"title": "Age", "type": "integer"}
},
"required": ["name", "age"]
}
}
},
{
"type": "function",
"function": {
"name": "web_search",
"description": "Search the web for information using Google Search.",
"parameters": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The search query to be executed."
}
},
"required": ["query"]
}
}
},
{
"type": "function",
"function": {
"name": "general_ai",
"description": "Use general AI knowledge to answer the question",
"parameters": {
"type": "object",
"properties": {
"question": {"type": "string", "description": "The question to answer"}
},
"required": ["question"]
}
}
}
]
agent = FunctionCallingAgent(tools=tools)
llama = Julius()
function_executor = FunctionExecutor(llama)
user_input = input(">>> ")
function_call_data = agent.function_call_handler(user_input)
print(f"Function Call Data: {function_call_data}")
try:
if "error" not in function_call_data:
function_name = function_call_data.get("tool_name")
arguments = function_call_data.get("tool_input", {})
execute_function = getattr(function_executor, f"execute_{function_name}", None)
if execute_function:
result = execute_function(arguments)
print("Function Execution Result:")
for c in result:
print(c, end="", flush=True)
else:
print(f"Unknown function: {function_name}")
else:
print(f"Error: {function_call_data['error']}")
except Exception as e:
print(f"An error occurred: {str(e)}")
if __name__ == "__main__":
main()
```
### LLAMA3, pizzagpt, RUBIKSAI, Koala, Darkai, AI4Chat, Farfalle, PIAI, Felo, Julius, YouChat, YEPCHAT, Cloudflare, TurboSeek, Editee, AI21, Chatify, Cerebras, X0GPT, Lepton, GEMINIAPI, Cleeai, Elmo, Genspark, Upstage, Free2GPT, Bing, DiscordRocks, GPTWeb, LlamaTutor, PromptRefine, AIUncensored, TutorAI, ChatGPTES, Bagoodex, ChatHub, AmigoChat, AIMathGPT, GaurishCerebras, NinjaChat, GeminiPro, Talkai, LLMChat
Code is similar to other providers.
### `LLM`
```python
from webscout.LLM import LLM
# Read the system message from the file
with open('system.txt', 'r') as file:
system_message = file.read()
# Initialize the LLM class with the model name and system message
llm = LLM(model="microsoft/WizardLM-2-8x22B", system_message=system_message)
while True:
# Get the user input
user_input = input("User: ")
# Define the messages to be sent
messages = [
{"role": "user", "content": user_input}
]
# Use the mistral_chat method to get the response
response = llm.chat(messages)
# Print the response
print("AI: ", response)
```
## 💻 Local-LLM
Webscout can now run GGUF models locally. You can download and run your favorite models with minimal configuration.
**Example:**
```python
from webscout.Local import *
model_path = download_model("Qwen/Qwen2.5-0.5B-Instruct-GGUF", "qwen2.5-0.5b-instruct-q2_k.gguf", token=None)
model = Model(model_path, n_gpu_layers=0, context_length=2048)
thread = Thread(model, format=chatml)
# print(thread.send("hi")) #send a single msg to ai
# thread.interact() # interact with the model in terminal
# start webui
# webui = WebUI(thread)
# webui.start(host="0.0.0.0", port=8080, ssl=True) #Use ssl=True and make cert and key for https
```
## 🐶 Local-rawdog
Webscout's local raw-dog feature allows you to run Python scripts within your terminal prompt.
**Example:**
```python
import webscout.Local as ws
from webscout.Local.rawdog import RawDog
from webscout.Local.samplers import DefaultSampling
from webscout.Local.formats import chatml, AdvancedFormat
from webscout.Local.utils import download_model
import datetime
import sys
import os
repo_id = "YorkieOH10/granite-8b-code-instruct-Q8_0-GGUF"
filename = "granite-8b-code-instruct.Q8_0.gguf"
model_path = download_model(repo_id, filename, token='')
# Load the model using the downloaded path
model = ws.Model(model_path, n_gpu_layers=10)
rawdog = RawDog()
# Create an AdvancedFormat and modify the system content
# Use a lambda to generate the prompt dynamically:
chat_format = AdvancedFormat(chatml)
# **Pre-format the intro_prompt string:**
system_content = f"""
You are a command-line coding assistant called Rawdog that generates and auto-executes Python scripts.
A typical interaction goes like this:
1. The user gives you a natural language PROMPT.
2. You:
i. Determine what needs to be done
ii. Write a short Python SCRIPT to do it
iii. Communicate back to the user by printing to the console in that SCRIPT
3. The compiler extracts the script and then runs it using exec(). If there will be an exception raised,
it will be send back to you starting with "PREVIOUS SCRIPT EXCEPTION:".
4. In case of exception, regenerate error free script.
If you need to review script outputs before completing the task, you can print the word "CONTINUE" at the end of your SCRIPT.
This can be useful for summarizing documents or technical readouts, reading instructions before
deciding what to do, or other tasks that require multi-step reasoning.
A typical 'CONTINUE' interaction looks like this:
1. The user gives you a natural language PROMPT.
2. You:
i. Determine what needs to be done
ii. Determine that you need to see the output of some subprocess call to complete the task
iii. Write a short Python SCRIPT to print that and then print the word "CONTINUE"
3. The compiler
i. Checks and runs your SCRIPT
ii. Captures the output and appends it to the conversation as "LAST SCRIPT OUTPUT:"
iii. Finds the word "CONTINUE" and sends control back to you
4. You again:
i. Look at the original PROMPT + the "LAST SCRIPT OUTPUT:" to determine what needs to be done
ii. Write a short Python SCRIPT to do it
iii. Communicate back to the user by printing to the console in that SCRIPT
5. The compiler...
Please follow these conventions carefully:
- Decline any tasks that seem dangerous, irreversible, or that you don't understand.
- Always review the full conversation prior to answering and maintain continuity.
- If asked for information, just print the information clearly and concisely.
- If asked to do something, print a concise summary of what you've done as confirmation.
- If asked a question, respond in a friendly, conversational way. Use programmatically-generated and natural language responses as appropriate.
- If you need clarification, return a SCRIPT that prints your question. In the next interaction, continue based on the user's response.
- Assume the user would like something concise. For example rather than printing a massive table, filter or summarize it to what's likely of interest.
- Actively clean up any temporary processes or files you use.
- When looking through files, use git as available to skip files, and skip hidden files (.env, .git, etc) by default.
- You can plot anything with matplotlib.
- ALWAYS Return your SCRIPT inside of a single pair of ``` delimiters. Only the console output of the first such SCRIPT is visible to the user, so make sure that it's complete and don't bother returning anything else.
"""
chat_format.override('system_content', lambda: system_content)
thread = ws.Thread(model, format=chat_format, sampler=DefaultSampling)
while True:
prompt = input(">: ")
if prompt.lower() == "q":
break
response = thread.send(prompt)
# Process the response using RawDog
script_output = rawdog.main(response)
if script_output:
print(script_output)
```
## GGUF
Webscout provides tools to convert and quantize Hugging Face models into the GGUF format for use with offline LLMs.
**Example:**
```python
from webscout.Extra import gguf
"""
Valid quantization methods:
"q2_k", "q3_k_l", "q3_k_m", "q3_k_s",
"q4_0", "q4_1", "q4_k_m", "q4_k_s",
"q5_0", "q5_1", "q5_k_m", "q5_k_s",
"q6_k", "q8_0"
"""
gguf.convert(
model_id="OEvortex/HelpingAI-Lite-1.5T", # Replace with your model ID
username="Abhaykoul", # Replace with your Hugging Face username
token="hf_token_write", # Replace with your Hugging Face token
quantization_methods="q4_k_m" # Optional, adjust quantization methods
)
```
## 🤖 Autollama
Webscout's `autollama` utility downloads a model from Hugging Face and then automatically makes it Ollama-ready.
```python
from webscout.Extra import autollama
model_path = "Vortex4ai/Jarvis-0.5B"
gguf_file = "test2-q4_k_m.gguf"
autollama.main(model_path, gguf_file)
```
**Command Line Usage:**
* **GGUF Conversion:**
```bash
python -m webscout.Extra.gguf -m "OEvortex/HelpingAI-Lite-1.5T" -u "your_username" -t "your_hf_token" -q "q4_k_m,q5_k_m"
```
* **Autollama:**
```bash
python -m webscout.Extra.autollama -m "OEvortex/HelpingAI-Lite-1.5T" -g "HelpingAI-Lite-1.5T.q4_k_m.gguf"
```
**Note:**
* Replace `"your_username"` and `"your_hf_token"` with your actual Hugging Face credentials.
* The `model_path` in `autollama` is the Hugging Face model ID, and `gguf_file` is the GGUF file ID.
## 🌐 `Webai` - Terminal GPT and an Open Interpreter
```bash
python -m webscout.webai webai --provider "phind" --rawdog
```
## 🤝 Contributing
Contributions are welcome! If you'd like to contribute to Webscout, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your branch to your forked repository.
5. Submit a pull request to the main repository.
## 🙏 Acknowledgments
* All the amazing developers who have contributed to the project!
* The open-source community for their support and inspiration.