webscout 8.3.7__py3-none-any.whl → 2025.10.11__py3-none-any.whl

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 (273) hide show
  1. webscout/AIauto.py +250 -250
  2. webscout/AIbase.py +379 -379
  3. webscout/AIutel.py +60 -60
  4. webscout/Bard.py +1012 -1012
  5. webscout/Bing_search.py +417 -417
  6. webscout/DWEBS.py +529 -529
  7. webscout/Extra/Act.md +309 -309
  8. webscout/Extra/GitToolkit/__init__.py +10 -10
  9. webscout/Extra/GitToolkit/gitapi/README.md +110 -110
  10. webscout/Extra/GitToolkit/gitapi/__init__.py +11 -11
  11. webscout/Extra/GitToolkit/gitapi/repository.py +195 -195
  12. webscout/Extra/GitToolkit/gitapi/user.py +96 -96
  13. webscout/Extra/GitToolkit/gitapi/utils.py +61 -61
  14. webscout/Extra/YTToolkit/README.md +375 -375
  15. webscout/Extra/YTToolkit/YTdownloader.py +956 -956
  16. webscout/Extra/YTToolkit/__init__.py +2 -2
  17. webscout/Extra/YTToolkit/transcriber.py +475 -475
  18. webscout/Extra/YTToolkit/ytapi/README.md +44 -44
  19. webscout/Extra/YTToolkit/ytapi/__init__.py +6 -6
  20. webscout/Extra/YTToolkit/ytapi/channel.py +307 -307
  21. webscout/Extra/YTToolkit/ytapi/errors.py +13 -13
  22. webscout/Extra/YTToolkit/ytapi/extras.py +118 -118
  23. webscout/Extra/YTToolkit/ytapi/https.py +88 -88
  24. webscout/Extra/YTToolkit/ytapi/patterns.py +61 -61
  25. webscout/Extra/YTToolkit/ytapi/playlist.py +58 -58
  26. webscout/Extra/YTToolkit/ytapi/pool.py +7 -7
  27. webscout/Extra/YTToolkit/ytapi/query.py +39 -39
  28. webscout/Extra/YTToolkit/ytapi/stream.py +62 -62
  29. webscout/Extra/YTToolkit/ytapi/utils.py +62 -62
  30. webscout/Extra/YTToolkit/ytapi/video.py +232 -232
  31. webscout/Extra/autocoder/__init__.py +9 -9
  32. webscout/Extra/autocoder/autocoder.py +1105 -1105
  33. webscout/Extra/autocoder/autocoder_utiles.py +332 -332
  34. webscout/Extra/gguf.md +429 -429
  35. webscout/Extra/gguf.py +1213 -1213
  36. webscout/Extra/tempmail/README.md +487 -487
  37. webscout/Extra/tempmail/__init__.py +27 -27
  38. webscout/Extra/tempmail/async_utils.py +140 -140
  39. webscout/Extra/tempmail/base.py +160 -160
  40. webscout/Extra/tempmail/cli.py +186 -186
  41. webscout/Extra/tempmail/emailnator.py +84 -84
  42. webscout/Extra/tempmail/mail_tm.py +360 -360
  43. webscout/Extra/tempmail/temp_mail_io.py +291 -291
  44. webscout/Extra/weather.md +281 -281
  45. webscout/Extra/weather.py +193 -193
  46. webscout/Litlogger/README.md +10 -10
  47. webscout/Litlogger/__init__.py +15 -15
  48. webscout/Litlogger/formats.py +13 -13
  49. webscout/Litlogger/handlers.py +121 -121
  50. webscout/Litlogger/levels.py +13 -13
  51. webscout/Litlogger/logger.py +134 -134
  52. webscout/Provider/AISEARCH/Perplexity.py +332 -332
  53. webscout/Provider/AISEARCH/README.md +279 -279
  54. webscout/Provider/AISEARCH/__init__.py +16 -1
  55. webscout/Provider/AISEARCH/felo_search.py +206 -206
  56. webscout/Provider/AISEARCH/genspark_search.py +323 -323
  57. webscout/Provider/AISEARCH/hika_search.py +185 -185
  58. webscout/Provider/AISEARCH/iask_search.py +410 -410
  59. webscout/Provider/AISEARCH/monica_search.py +219 -219
  60. webscout/Provider/AISEARCH/scira_search.py +316 -316
  61. webscout/Provider/AISEARCH/stellar_search.py +177 -177
  62. webscout/Provider/AISEARCH/webpilotai_search.py +255 -255
  63. webscout/Provider/Aitopia.py +314 -314
  64. webscout/Provider/Apriel.py +306 -0
  65. webscout/Provider/ChatGPTClone.py +236 -236
  66. webscout/Provider/ChatSandbox.py +343 -343
  67. webscout/Provider/Cloudflare.py +324 -324
  68. webscout/Provider/Cohere.py +208 -208
  69. webscout/Provider/Deepinfra.py +370 -366
  70. webscout/Provider/ExaAI.py +260 -260
  71. webscout/Provider/ExaChat.py +308 -308
  72. webscout/Provider/Flowith.py +221 -221
  73. webscout/Provider/GMI.py +293 -0
  74. webscout/Provider/Gemini.py +164 -164
  75. webscout/Provider/GeminiProxy.py +167 -167
  76. webscout/Provider/GithubChat.py +371 -372
  77. webscout/Provider/Groq.py +800 -800
  78. webscout/Provider/HeckAI.py +383 -383
  79. webscout/Provider/Jadve.py +282 -282
  80. webscout/Provider/K2Think.py +307 -307
  81. webscout/Provider/Koboldai.py +205 -205
  82. webscout/Provider/LambdaChat.py +423 -423
  83. webscout/Provider/Nemotron.py +244 -244
  84. webscout/Provider/Netwrck.py +248 -248
  85. webscout/Provider/OLLAMA.py +395 -395
  86. webscout/Provider/OPENAI/Cloudflare.py +393 -393
  87. webscout/Provider/OPENAI/FalconH1.py +451 -451
  88. webscout/Provider/OPENAI/FreeGemini.py +296 -296
  89. webscout/Provider/OPENAI/K2Think.py +431 -431
  90. webscout/Provider/OPENAI/NEMOTRON.py +240 -240
  91. webscout/Provider/OPENAI/PI.py +427 -427
  92. webscout/Provider/OPENAI/README.md +959 -959
  93. webscout/Provider/OPENAI/TogetherAI.py +345 -345
  94. webscout/Provider/OPENAI/TwoAI.py +465 -465
  95. webscout/Provider/OPENAI/__init__.py +33 -18
  96. webscout/Provider/OPENAI/base.py +248 -248
  97. webscout/Provider/OPENAI/chatglm.py +528 -0
  98. webscout/Provider/OPENAI/chatgpt.py +592 -592
  99. webscout/Provider/OPENAI/chatgptclone.py +521 -521
  100. webscout/Provider/OPENAI/chatsandbox.py +202 -202
  101. webscout/Provider/OPENAI/deepinfra.py +318 -314
  102. webscout/Provider/OPENAI/e2b.py +1665 -1665
  103. webscout/Provider/OPENAI/exaai.py +420 -420
  104. webscout/Provider/OPENAI/exachat.py +452 -452
  105. webscout/Provider/OPENAI/friendli.py +232 -232
  106. webscout/Provider/OPENAI/{refact.py → gmi.py} +324 -274
  107. webscout/Provider/OPENAI/groq.py +364 -364
  108. webscout/Provider/OPENAI/heckai.py +314 -314
  109. webscout/Provider/OPENAI/llmchatco.py +337 -337
  110. webscout/Provider/OPENAI/netwrck.py +355 -355
  111. webscout/Provider/OPENAI/oivscode.py +290 -290
  112. webscout/Provider/OPENAI/opkfc.py +518 -518
  113. webscout/Provider/OPENAI/pydantic_imports.py +1 -1
  114. webscout/Provider/OPENAI/scirachat.py +535 -535
  115. webscout/Provider/OPENAI/sonus.py +308 -308
  116. webscout/Provider/OPENAI/standardinput.py +442 -442
  117. webscout/Provider/OPENAI/textpollinations.py +340 -340
  118. webscout/Provider/OPENAI/toolbaz.py +419 -416
  119. webscout/Provider/OPENAI/typefully.py +362 -362
  120. webscout/Provider/OPENAI/utils.py +295 -295
  121. webscout/Provider/OPENAI/venice.py +436 -436
  122. webscout/Provider/OPENAI/wisecat.py +387 -387
  123. webscout/Provider/OPENAI/writecream.py +166 -166
  124. webscout/Provider/OPENAI/x0gpt.py +378 -378
  125. webscout/Provider/OPENAI/yep.py +389 -389
  126. webscout/Provider/OpenGPT.py +230 -230
  127. webscout/Provider/Openai.py +243 -243
  128. webscout/Provider/PI.py +405 -405
  129. webscout/Provider/Perplexitylabs.py +430 -430
  130. webscout/Provider/QwenLM.py +272 -272
  131. webscout/Provider/STT/__init__.py +16 -1
  132. webscout/Provider/Sambanova.py +257 -257
  133. webscout/Provider/StandardInput.py +309 -309
  134. webscout/Provider/TTI/README.md +82 -82
  135. webscout/Provider/TTI/__init__.py +33 -18
  136. webscout/Provider/TTI/aiarta.py +413 -413
  137. webscout/Provider/TTI/base.py +136 -136
  138. webscout/Provider/TTI/bing.py +243 -243
  139. webscout/Provider/TTI/gpt1image.py +149 -149
  140. webscout/Provider/TTI/imagen.py +196 -196
  141. webscout/Provider/TTI/infip.py +211 -211
  142. webscout/Provider/TTI/magicstudio.py +232 -232
  143. webscout/Provider/TTI/monochat.py +219 -219
  144. webscout/Provider/TTI/piclumen.py +214 -214
  145. webscout/Provider/TTI/pixelmuse.py +232 -232
  146. webscout/Provider/TTI/pollinations.py +232 -232
  147. webscout/Provider/TTI/together.py +288 -288
  148. webscout/Provider/TTI/utils.py +12 -12
  149. webscout/Provider/TTI/venice.py +367 -367
  150. webscout/Provider/TTS/README.md +192 -192
  151. webscout/Provider/TTS/__init__.py +33 -18
  152. webscout/Provider/TTS/parler.py +110 -110
  153. webscout/Provider/TTS/streamElements.py +333 -333
  154. webscout/Provider/TTS/utils.py +280 -280
  155. webscout/Provider/TeachAnything.py +237 -237
  156. webscout/Provider/TextPollinationsAI.py +310 -310
  157. webscout/Provider/TogetherAI.py +356 -356
  158. webscout/Provider/TwoAI.py +312 -312
  159. webscout/Provider/TypliAI.py +311 -311
  160. webscout/Provider/UNFINISHED/ChatHub.py +208 -208
  161. webscout/Provider/UNFINISHED/ChutesAI.py +313 -313
  162. webscout/Provider/UNFINISHED/GizAI.py +294 -294
  163. webscout/Provider/UNFINISHED/Marcus.py +198 -198
  164. webscout/Provider/UNFINISHED/Qodo.py +477 -477
  165. webscout/Provider/UNFINISHED/VercelAIGateway.py +338 -338
  166. webscout/Provider/UNFINISHED/XenAI.py +324 -324
  167. webscout/Provider/UNFINISHED/Youchat.py +330 -330
  168. webscout/Provider/UNFINISHED/liner.py +334 -0
  169. webscout/Provider/UNFINISHED/liner_api_request.py +262 -262
  170. webscout/Provider/UNFINISHED/puterjs.py +634 -634
  171. webscout/Provider/UNFINISHED/samurai.py +223 -223
  172. webscout/Provider/UNFINISHED/test_lmarena.py +119 -119
  173. webscout/Provider/Venice.py +250 -250
  174. webscout/Provider/VercelAI.py +256 -256
  175. webscout/Provider/WiseCat.py +231 -231
  176. webscout/Provider/WrDoChat.py +366 -366
  177. webscout/Provider/__init__.py +33 -18
  178. webscout/Provider/ai4chat.py +174 -174
  179. webscout/Provider/akashgpt.py +331 -331
  180. webscout/Provider/cerebras.py +446 -446
  181. webscout/Provider/chatglm.py +394 -301
  182. webscout/Provider/cleeai.py +211 -211
  183. webscout/Provider/elmo.py +282 -282
  184. webscout/Provider/geminiapi.py +208 -208
  185. webscout/Provider/granite.py +261 -261
  186. webscout/Provider/hermes.py +263 -263
  187. webscout/Provider/julius.py +223 -223
  188. webscout/Provider/learnfastai.py +309 -309
  189. webscout/Provider/llama3mitril.py +214 -214
  190. webscout/Provider/llmchat.py +243 -243
  191. webscout/Provider/llmchatco.py +290 -290
  192. webscout/Provider/meta.py +801 -801
  193. webscout/Provider/oivscode.py +309 -309
  194. webscout/Provider/scira_chat.py +383 -383
  195. webscout/Provider/searchchat.py +292 -292
  196. webscout/Provider/sonus.py +258 -258
  197. webscout/Provider/toolbaz.py +370 -367
  198. webscout/Provider/turboseek.py +273 -273
  199. webscout/Provider/typefully.py +207 -207
  200. webscout/Provider/yep.py +372 -372
  201. webscout/__init__.py +30 -31
  202. webscout/__main__.py +5 -5
  203. webscout/auth/api_key_manager.py +189 -189
  204. webscout/auth/config.py +175 -175
  205. webscout/auth/models.py +185 -185
  206. webscout/auth/routes.py +664 -664
  207. webscout/auth/simple_logger.py +236 -236
  208. webscout/cli.py +523 -523
  209. webscout/conversation.py +438 -438
  210. webscout/exceptions.py +361 -361
  211. webscout/litagent/Readme.md +298 -298
  212. webscout/litagent/__init__.py +28 -28
  213. webscout/litagent/agent.py +581 -581
  214. webscout/litagent/constants.py +59 -59
  215. webscout/litprinter/__init__.py +58 -58
  216. webscout/models.py +181 -181
  217. webscout/optimizers.py +419 -419
  218. webscout/prompt_manager.py +288 -288
  219. webscout/sanitize.py +1078 -1078
  220. webscout/scout/README.md +401 -401
  221. webscout/scout/__init__.py +8 -8
  222. webscout/scout/core/__init__.py +6 -6
  223. webscout/scout/core/crawler.py +297 -297
  224. webscout/scout/core/scout.py +706 -706
  225. webscout/scout/core/search_result.py +95 -95
  226. webscout/scout/core/text_analyzer.py +62 -62
  227. webscout/scout/core/text_utils.py +277 -277
  228. webscout/scout/core/web_analyzer.py +51 -51
  229. webscout/scout/element.py +599 -599
  230. webscout/scout/parsers/__init__.py +69 -69
  231. webscout/scout/parsers/html5lib_parser.py +172 -172
  232. webscout/scout/parsers/html_parser.py +236 -236
  233. webscout/scout/parsers/lxml_parser.py +178 -178
  234. webscout/scout/utils.py +37 -37
  235. webscout/swiftcli/Readme.md +323 -323
  236. webscout/swiftcli/__init__.py +95 -95
  237. webscout/swiftcli/core/__init__.py +7 -7
  238. webscout/swiftcli/core/cli.py +308 -308
  239. webscout/swiftcli/core/context.py +104 -104
  240. webscout/swiftcli/core/group.py +241 -241
  241. webscout/swiftcli/decorators/__init__.py +28 -28
  242. webscout/swiftcli/decorators/command.py +221 -221
  243. webscout/swiftcli/decorators/options.py +220 -220
  244. webscout/swiftcli/decorators/output.py +302 -302
  245. webscout/swiftcli/exceptions.py +21 -21
  246. webscout/swiftcli/plugins/__init__.py +9 -9
  247. webscout/swiftcli/plugins/base.py +135 -135
  248. webscout/swiftcli/plugins/manager.py +269 -269
  249. webscout/swiftcli/utils/__init__.py +59 -59
  250. webscout/swiftcli/utils/formatting.py +252 -252
  251. webscout/swiftcli/utils/parsing.py +267 -267
  252. webscout/update_checker.py +117 -117
  253. webscout/version.py +1 -1
  254. webscout/webscout_search.py +1183 -1183
  255. webscout/webscout_search_async.py +649 -649
  256. webscout/yep_search.py +346 -346
  257. webscout/zeroart/README.md +89 -89
  258. webscout/zeroart/__init__.py +134 -134
  259. webscout/zeroart/base.py +66 -66
  260. webscout/zeroart/effects.py +100 -100
  261. webscout/zeroart/fonts.py +1238 -1238
  262. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/METADATA +937 -937
  263. webscout-2025.10.11.dist-info/RECORD +300 -0
  264. webscout/Provider/AISEARCH/DeepFind.py +0 -254
  265. webscout/Provider/OPENAI/Qwen3.py +0 -303
  266. webscout/Provider/OPENAI/qodo.py +0 -630
  267. webscout/Provider/OPENAI/xenai.py +0 -514
  268. webscout/tempid.py +0 -134
  269. webscout-8.3.7.dist-info/RECORD +0 -301
  270. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/WHEEL +0 -0
  271. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/entry_points.txt +0 -0
  272. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/licenses/LICENSE.md +0 -0
  273. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/top_level.txt +0 -0
@@ -1,410 +1,410 @@
1
- import aiohttp
2
- import asyncio
3
- import lxml.html
4
- import re
5
- import urllib.parse
6
- from markdownify import markdownify as md
7
- from typing import Dict, Optional, Generator, Union, AsyncIterator, Literal
8
-
9
- from webscout.AIbase import AISearch, SearchResponse
10
- from webscout import exceptions
11
- from webscout.scout import Scout
12
-
13
-
14
- def cache_find(diff: Union[dict, list]) -> Optional[str]:
15
- """Find HTML content in a nested dictionary or list structure.
16
-
17
- Args:
18
- diff (Union[dict, list]): The nested structure to search
19
-
20
- Returns:
21
- Optional[str]: The found HTML content, or None if not found
22
- """
23
- values = diff if isinstance(diff, list) else diff.values()
24
- for value in values:
25
- if isinstance(value, (list, dict)):
26
- cache = cache_find(value)
27
- if cache:
28
- return cache
29
- if isinstance(value, str) and re.search(r"<p>.+?</p>", value):
30
- return md(value).strip()
31
-
32
- return None
33
-
34
-
35
- ModeType = Literal["question", "academic", "fast", "forums", "wiki", "advanced"]
36
- DetailLevelType = Literal["concise", "detailed", "comprehensive"]
37
-
38
-
39
- class IAsk(AISearch):
40
- """A class to interact with the IAsk AI search API.
41
-
42
- IAsk provides a powerful search interface that returns AI-generated responses
43
- based on web content. It supports both streaming and non-streaming responses,
44
- as well as different search modes and detail levels.
45
-
46
- Basic Usage:
47
- >>> from webscout import IAsk
48
- >>> ai = IAsk()
49
- >>> # Non-streaming example
50
- >>> response = ai.search("What is Python?")
51
- >>> print(response)
52
- Python is a high-level programming language...
53
-
54
- >>> # Streaming example
55
- >>> for chunk in ai.search("Tell me about AI", stream=True):
56
- ... print(chunk, end="", flush=True)
57
- Artificial Intelligence is...
58
-
59
- >>> # With specific mode and detail level
60
- >>> response = ai.search("Climate change", mode="academic", detail_level="detailed")
61
- >>> print(response)
62
- Climate change refers to...
63
-
64
- Args:
65
- timeout (int, optional): Request timeout in seconds. Defaults to 30.
66
- proxies (dict, optional): Proxy configuration for requests. Defaults to None.
67
- mode (ModeType, optional): Default search mode. Defaults to "question".
68
- detail_level (DetailLevelType, optional): Default detail level. Defaults to None.
69
- """
70
-
71
- def __init__(
72
- self,
73
- timeout: int = 30,
74
- proxies: Optional[dict] = None,
75
- mode: ModeType = "question",
76
- detail_level: Optional[DetailLevelType] = None,
77
- ):
78
- """Initialize the IAsk API client.
79
-
80
- Args:
81
- timeout (int, optional): Request timeout in seconds. Defaults to 30.
82
- proxies (dict, optional): Proxy configuration for requests. Defaults to None.
83
- mode (ModeType, optional): Default search mode. Defaults to "question".
84
- detail_level (DetailLevelType, optional): Default detail level. Defaults to None.
85
- """
86
- self.timeout = timeout
87
- self.proxies = proxies or {}
88
- self.default_mode = mode
89
- self.default_detail_level = detail_level
90
- self.api_endpoint = "https://iask.ai/"
91
- self.last_response = {}
92
-
93
- def create_url(self, query: str, mode: ModeType = "question", detail_level: Optional[DetailLevelType] = None) -> str:
94
- """Create a properly formatted URL with mode and detail level parameters.
95
-
96
- Args:
97
- query (str): The search query.
98
- mode (ModeType, optional): Search mode. Defaults to "question".
99
- detail_level (DetailLevelType, optional): Detail level. Defaults to None.
100
-
101
- Returns:
102
- str: Formatted URL with query parameters.
103
-
104
- Example:
105
- >>> ai = IAsk()
106
- >>> url = ai.create_url("Climate change", mode="academic", detail_level="detailed")
107
- >>> print(url)
108
- https://iask.ai/?mode=academic&q=Climate+change&options%5Bdetail_level%5D=detailed
109
- """
110
- # Create a dictionary of parameters with flattened structure
111
- params = {
112
- "mode": mode,
113
- "q": query
114
- }
115
-
116
- # Add detail_level if provided using the flattened format
117
- if detail_level:
118
- params["options[detail_level]"] = detail_level
119
-
120
- # Encode the parameters and build the URL
121
- query_string = urllib.parse.urlencode(params)
122
- url = f"{self.api_endpoint}?{query_string}"
123
-
124
- return url
125
-
126
- def format_html(self, html_content: str) -> str:
127
- """Format HTML content into a more readable text format.
128
-
129
- Args:
130
- html_content (str): The HTML content to format.
131
-
132
- Returns:
133
- str: Formatted text.
134
- """
135
- scout = Scout(html_content, features='html.parser')
136
- output_lines = []
137
-
138
- for child in scout.find_all(['h1', 'h2', 'h3', 'p', 'ol', 'ul', 'div']):
139
- if child.name in ["h1", "h2", "h3"]:
140
- output_lines.append(f"\n**{child.get_text().strip()}**\n")
141
- elif child.name == "p":
142
- text = child.get_text().strip()
143
- text = re.sub(r"^According to Ask AI & Question AI www\.iAsk\.ai:\s*", "", text).strip()
144
- # Remove footnote markers
145
- text = re.sub(r'\[\d+\]\(#fn:\d+ \'see footnote\'\)', '', text)
146
- output_lines.append(text + "\n")
147
- elif child.name in ["ol", "ul"]:
148
- for li in child.find_all("li"):
149
- output_lines.append("- " + li.get_text().strip() + "\n")
150
- elif child.name == "div" and "footnotes" in child.get("class", []):
151
- output_lines.append("\n**Authoritative Sources**\n")
152
- for li in child.find_all("li"):
153
- link = li.find("a")
154
- if link:
155
- output_lines.append(f"- {link.get_text().strip()} ({link.get('href')})\n")
156
-
157
- return "".join(output_lines)
158
-
159
- def search(
160
- self,
161
- prompt: str,
162
- stream: bool = False,
163
- raw: bool = False,
164
- mode: Optional[ModeType] = None,
165
- detail_level: Optional[DetailLevelType] = None,
166
- ) -> Union[SearchResponse, Generator[Union[Dict[str, str], SearchResponse], None, None]]:
167
- """Search using the IAsk API and get AI-generated responses.
168
-
169
- This method sends a search query to IAsk and returns the AI-generated response.
170
- It supports both streaming and non-streaming modes, as well as raw response format.
171
-
172
- Args:
173
- prompt (str): The search query or prompt to send to the API.
174
- stream (bool, optional): If True, yields response chunks as they arrive.
175
- If False, returns complete response. Defaults to False.
176
- raw (bool, optional): If True, returns raw response dictionaries with 'text' key.
177
- If False, returns Response objects that convert to text automatically.
178
- Defaults to False.
179
- mode (ModeType, optional): Search mode to use. Defaults to None (uses instance default).
180
- detail_level (DetailLevelType, optional): Detail level to use. Defaults to None (uses instance default).
181
-
182
- Returns:
183
- Union[Response, Generator[Union[Dict[str, str], Response], None, None]]:
184
- - If stream=False: Returns complete response as Response object
185
- - If stream=True: Yields response chunks as either Dict or Response objects
186
-
187
- Raises:
188
- APIConnectionError: If the API request fails
189
-
190
- Examples:
191
- Basic search:
192
- >>> ai = IAsk()
193
- >>> response = ai.search("What is Python?")
194
- >>> print(response)
195
- Python is a programming language...
196
-
197
- Streaming response:
198
- >>> for chunk in ai.search("Tell me about AI", stream=True):
199
- ... print(chunk, end="")
200
- Artificial Intelligence...
201
-
202
- Raw response format:
203
- >>> for chunk in ai.search("Hello", stream=True, raw=True):
204
- ... print(chunk)
205
- {'text': 'Hello'}
206
- {'text': ' there!'}
207
-
208
- With specific mode and detail level:
209
- >>> response = ai.search("Climate change", mode="academic", detail_level="detailed")
210
- >>> print(response)
211
- Climate change refers to...
212
- """
213
- # Use provided parameters or fall back to instance defaults
214
- search_mode = mode or self.default_mode
215
- search_detail_level = detail_level or self.default_detail_level
216
-
217
- # For non-streaming, run the async search and return the complete response
218
- if not stream:
219
- # Create a new event loop for this request
220
- loop = asyncio.new_event_loop()
221
- asyncio.set_event_loop(loop)
222
- try:
223
- result = loop.run_until_complete(
224
- self._async_search(prompt, False, raw, search_mode, search_detail_level)
225
- )
226
- return result
227
- finally:
228
- loop.close()
229
-
230
- # For streaming, use a simpler approach with a single event loop
231
- # that stays open until the generator is exhausted
232
- buffer = ""
233
-
234
- def sync_generator():
235
- nonlocal buffer
236
- # Create a new event loop for this generator
237
- loop = asyncio.new_event_loop()
238
- asyncio.set_event_loop(loop)
239
-
240
- try:
241
- # Get the async generator
242
- async_gen_coro = self._async_search(prompt, True, raw, search_mode, search_detail_level)
243
- async_gen = loop.run_until_complete(async_gen_coro)
244
-
245
- # Process chunks one by one
246
- while True:
247
- try:
248
- # Get the next chunk
249
- chunk_coro = async_gen.__anext__()
250
- chunk = loop.run_until_complete(chunk_coro)
251
-
252
- # Update buffer and yield the chunk
253
- if isinstance(chunk, dict) and 'text' in chunk:
254
- buffer += chunk['text']
255
- elif isinstance(chunk, SearchResponse):
256
- buffer += chunk.text
257
- else:
258
- buffer += str(chunk)
259
-
260
- yield chunk
261
- except StopAsyncIteration:
262
- break
263
- except Exception as e:
264
- print(f"Error in generator: {e}")
265
- break
266
- finally:
267
- # Store the final response and close the loop
268
- self.last_response = {"text": buffer}
269
- loop.close()
270
-
271
- return sync_generator()
272
-
273
- async def _async_search(
274
- self,
275
- prompt: str,
276
- stream: bool = False,
277
- raw: bool = False,
278
- mode: ModeType = "question",
279
- detail_level: Optional[DetailLevelType] = None,
280
- ) -> Union[SearchResponse, AsyncIterator[Union[Dict[str, str], SearchResponse]]]:
281
- """Internal async implementation of the search method."""
282
-
283
- async def stream_generator() -> AsyncIterator[str]:
284
- async with aiohttp.ClientSession() as session:
285
- # Prepare parameters
286
- params = {"mode": mode, "q": prompt}
287
- if detail_level:
288
- params["options[detail_level]"] = detail_level
289
-
290
- try:
291
- async with session.get(
292
- self.api_endpoint,
293
- params=params,
294
- proxy=self.proxies.get('http') if self.proxies else None,
295
- timeout=self.timeout
296
- ) as response:
297
- if not response.ok:
298
- raise exceptions.APIConnectionError(
299
- f"Failed to generate response - ({response.status_code}, {response.reason}) - {await response.text()}"
300
- )
301
-
302
- etree = lxml.html.fromstring(await response.text())
303
- phx_node = etree.xpath('//*[starts-with(@id, "phx-")]').pop()
304
- csrf_token = (
305
- etree.xpath('//*[@name="csrf-token"]').pop().get("content")
306
- )
307
-
308
- async with session.ws_connect(
309
- f"{self.api_endpoint}live/websocket",
310
- params={
311
- "_csrf_token": csrf_token,
312
- "vsn": "2.0.0",
313
- },
314
- proxy=self.proxies.get('http') if self.proxies else None,
315
- timeout=self.timeout
316
- ) as wsResponse:
317
- await wsResponse.send_json(
318
- [
319
- None,
320
- None,
321
- f"lv:{phx_node.get('id')}",
322
- "phx_join",
323
- {
324
- "params": {"_csrf_token": csrf_token},
325
- "url": str(response.url),
326
- "session": phx_node.get("data-phx-session"),
327
- },
328
- ]
329
- )
330
- while True:
331
- json_data = await wsResponse.receive_json()
332
- if not json_data:
333
- break
334
- diff: dict = json_data[4]
335
- try:
336
- chunk: str = diff["e"][0][1]["data"]
337
- # Check if the chunk contains HTML content
338
- if re.search(r"<[^>]+>", chunk):
339
- formatted_chunk = self.format_html(chunk)
340
- yield formatted_chunk
341
- else:
342
- yield chunk.replace("<br/>", "\n")
343
- except:
344
- cache = cache_find(diff)
345
- if cache:
346
- if diff.get("response", None):
347
- # Format the cache content if it contains HTML
348
- if re.search(r"<[^>]+>", cache):
349
- formatted_cache = self.format_html(cache)
350
- yield formatted_cache
351
- else:
352
- yield cache
353
- break
354
- except Exception as e:
355
- raise exceptions.APIConnectionError(f"Error connecting to IAsk API: {str(e)}")
356
-
357
- # For non-streaming, collect all chunks and return a single response
358
- if not stream:
359
- buffer = ""
360
- async for chunk in stream_generator():
361
- buffer += chunk
362
- self.last_response = {"text": buffer}
363
- return SearchResponse(buffer) if not raw else {"text": buffer}
364
-
365
- # For streaming, create an async generator that yields chunks
366
- async def process_stream():
367
- buffer = ""
368
- async for chunk in stream_generator():
369
- buffer += chunk
370
- if raw:
371
- yield {"text": chunk}
372
- else:
373
- yield SearchResponse(chunk)
374
- self.last_response = {"text": buffer}
375
-
376
- # Return the async generator
377
- return process_stream()
378
-
379
-
380
- if __name__ == "__main__":
381
- from rich import print
382
-
383
- ai = IAsk()
384
-
385
- # Example 1: Simple search with default mode
386
- print("\n[bold cyan]Example 1: Simple search with default mode[/bold cyan]")
387
- response = ai.search("What is Python?", stream=True)
388
- for chunk in response:
389
- print(chunk, end="", flush=True)
390
- print("\n\n[bold green]Response complete.[/bold green]\n")
391
-
392
- # Example 2: Search with academic mode
393
- print("\n[bold cyan]Example 2: Search with academic mode[/bold cyan]")
394
- response = ai.search("Quantum computing applications", mode="academic", stream=True)
395
- for chunk in response:
396
- print(chunk, end="", flush=True)
397
- print("\n\n[bold green]Response complete.[/bold green]\n")
398
-
399
- # Example 3: Search with advanced mode and detailed level
400
- print("\n[bold cyan]Example 3: Search with advanced mode and detailed level[/bold cyan]")
401
- response = ai.search("Climate change solutions", mode="advanced", detail_level="detailed", stream=True)
402
- for chunk in response:
403
- print(chunk, end="", flush=True)
404
- print("\n\n[bold green]Response complete.[/bold green]\n")
405
-
406
- # Example 4: Demonstrating the create_url method
407
- print("\n[bold cyan]Example 4: Generated URL for browser access[/bold cyan]")
408
- url = ai.create_url("Helpingai details", mode="question", detail_level="detailed")
409
- print(f"URL: {url}")
410
- print("This URL can be used directly in a browser or with other HTTP clients.")
1
+ import aiohttp
2
+ import asyncio
3
+ import lxml.html
4
+ import re
5
+ import urllib.parse
6
+ from markdownify import markdownify as md
7
+ from typing import Dict, Optional, Generator, Union, AsyncIterator, Literal
8
+
9
+ from webscout.AIbase import AISearch, SearchResponse
10
+ from webscout import exceptions
11
+ from webscout.scout import Scout
12
+
13
+
14
+ def cache_find(diff: Union[dict, list]) -> Optional[str]:
15
+ """Find HTML content in a nested dictionary or list structure.
16
+
17
+ Args:
18
+ diff (Union[dict, list]): The nested structure to search
19
+
20
+ Returns:
21
+ Optional[str]: The found HTML content, or None if not found
22
+ """
23
+ values = diff if isinstance(diff, list) else diff.values()
24
+ for value in values:
25
+ if isinstance(value, (list, dict)):
26
+ cache = cache_find(value)
27
+ if cache:
28
+ return cache
29
+ if isinstance(value, str) and re.search(r"<p>.+?</p>", value):
30
+ return md(value).strip()
31
+
32
+ return None
33
+
34
+
35
+ ModeType = Literal["question", "academic", "fast", "forums", "wiki", "advanced"]
36
+ DetailLevelType = Literal["concise", "detailed", "comprehensive"]
37
+
38
+
39
+ class IAsk(AISearch):
40
+ """A class to interact with the IAsk AI search API.
41
+
42
+ IAsk provides a powerful search interface that returns AI-generated responses
43
+ based on web content. It supports both streaming and non-streaming responses,
44
+ as well as different search modes and detail levels.
45
+
46
+ Basic Usage:
47
+ >>> from webscout import IAsk
48
+ >>> ai = IAsk()
49
+ >>> # Non-streaming example
50
+ >>> response = ai.search("What is Python?")
51
+ >>> print(response)
52
+ Python is a high-level programming language...
53
+
54
+ >>> # Streaming example
55
+ >>> for chunk in ai.search("Tell me about AI", stream=True):
56
+ ... print(chunk, end="", flush=True)
57
+ Artificial Intelligence is...
58
+
59
+ >>> # With specific mode and detail level
60
+ >>> response = ai.search("Climate change", mode="academic", detail_level="detailed")
61
+ >>> print(response)
62
+ Climate change refers to...
63
+
64
+ Args:
65
+ timeout (int, optional): Request timeout in seconds. Defaults to 30.
66
+ proxies (dict, optional): Proxy configuration for requests. Defaults to None.
67
+ mode (ModeType, optional): Default search mode. Defaults to "question".
68
+ detail_level (DetailLevelType, optional): Default detail level. Defaults to None.
69
+ """
70
+
71
+ def __init__(
72
+ self,
73
+ timeout: int = 30,
74
+ proxies: Optional[dict] = None,
75
+ mode: ModeType = "question",
76
+ detail_level: Optional[DetailLevelType] = None,
77
+ ):
78
+ """Initialize the IAsk API client.
79
+
80
+ Args:
81
+ timeout (int, optional): Request timeout in seconds. Defaults to 30.
82
+ proxies (dict, optional): Proxy configuration for requests. Defaults to None.
83
+ mode (ModeType, optional): Default search mode. Defaults to "question".
84
+ detail_level (DetailLevelType, optional): Default detail level. Defaults to None.
85
+ """
86
+ self.timeout = timeout
87
+ self.proxies = proxies or {}
88
+ self.default_mode = mode
89
+ self.default_detail_level = detail_level
90
+ self.api_endpoint = "https://iask.ai/"
91
+ self.last_response = {}
92
+
93
+ def create_url(self, query: str, mode: ModeType = "question", detail_level: Optional[DetailLevelType] = None) -> str:
94
+ """Create a properly formatted URL with mode and detail level parameters.
95
+
96
+ Args:
97
+ query (str): The search query.
98
+ mode (ModeType, optional): Search mode. Defaults to "question".
99
+ detail_level (DetailLevelType, optional): Detail level. Defaults to None.
100
+
101
+ Returns:
102
+ str: Formatted URL with query parameters.
103
+
104
+ Example:
105
+ >>> ai = IAsk()
106
+ >>> url = ai.create_url("Climate change", mode="academic", detail_level="detailed")
107
+ >>> print(url)
108
+ https://iask.ai/?mode=academic&q=Climate+change&options%5Bdetail_level%5D=detailed
109
+ """
110
+ # Create a dictionary of parameters with flattened structure
111
+ params = {
112
+ "mode": mode,
113
+ "q": query
114
+ }
115
+
116
+ # Add detail_level if provided using the flattened format
117
+ if detail_level:
118
+ params["options[detail_level]"] = detail_level
119
+
120
+ # Encode the parameters and build the URL
121
+ query_string = urllib.parse.urlencode(params)
122
+ url = f"{self.api_endpoint}?{query_string}"
123
+
124
+ return url
125
+
126
+ def format_html(self, html_content: str) -> str:
127
+ """Format HTML content into a more readable text format.
128
+
129
+ Args:
130
+ html_content (str): The HTML content to format.
131
+
132
+ Returns:
133
+ str: Formatted text.
134
+ """
135
+ scout = Scout(html_content, features='html.parser')
136
+ output_lines = []
137
+
138
+ for child in scout.find_all(['h1', 'h2', 'h3', 'p', 'ol', 'ul', 'div']):
139
+ if child.name in ["h1", "h2", "h3"]:
140
+ output_lines.append(f"\n**{child.get_text().strip()}**\n")
141
+ elif child.name == "p":
142
+ text = child.get_text().strip()
143
+ text = re.sub(r"^According to Ask AI & Question AI www\.iAsk\.ai:\s*", "", text).strip()
144
+ # Remove footnote markers
145
+ text = re.sub(r'\[\d+\]\(#fn:\d+ \'see footnote\'\)', '', text)
146
+ output_lines.append(text + "\n")
147
+ elif child.name in ["ol", "ul"]:
148
+ for li in child.find_all("li"):
149
+ output_lines.append("- " + li.get_text().strip() + "\n")
150
+ elif child.name == "div" and "footnotes" in child.get("class", []):
151
+ output_lines.append("\n**Authoritative Sources**\n")
152
+ for li in child.find_all("li"):
153
+ link = li.find("a")
154
+ if link:
155
+ output_lines.append(f"- {link.get_text().strip()} ({link.get('href')})\n")
156
+
157
+ return "".join(output_lines)
158
+
159
+ def search(
160
+ self,
161
+ prompt: str,
162
+ stream: bool = False,
163
+ raw: bool = False,
164
+ mode: Optional[ModeType] = None,
165
+ detail_level: Optional[DetailLevelType] = None,
166
+ ) -> Union[SearchResponse, Generator[Union[Dict[str, str], SearchResponse], None, None]]:
167
+ """Search using the IAsk API and get AI-generated responses.
168
+
169
+ This method sends a search query to IAsk and returns the AI-generated response.
170
+ It supports both streaming and non-streaming modes, as well as raw response format.
171
+
172
+ Args:
173
+ prompt (str): The search query or prompt to send to the API.
174
+ stream (bool, optional): If True, yields response chunks as they arrive.
175
+ If False, returns complete response. Defaults to False.
176
+ raw (bool, optional): If True, returns raw response dictionaries with 'text' key.
177
+ If False, returns Response objects that convert to text automatically.
178
+ Defaults to False.
179
+ mode (ModeType, optional): Search mode to use. Defaults to None (uses instance default).
180
+ detail_level (DetailLevelType, optional): Detail level to use. Defaults to None (uses instance default).
181
+
182
+ Returns:
183
+ Union[Response, Generator[Union[Dict[str, str], Response], None, None]]:
184
+ - If stream=False: Returns complete response as Response object
185
+ - If stream=True: Yields response chunks as either Dict or Response objects
186
+
187
+ Raises:
188
+ APIConnectionError: If the API request fails
189
+
190
+ Examples:
191
+ Basic search:
192
+ >>> ai = IAsk()
193
+ >>> response = ai.search("What is Python?")
194
+ >>> print(response)
195
+ Python is a programming language...
196
+
197
+ Streaming response:
198
+ >>> for chunk in ai.search("Tell me about AI", stream=True):
199
+ ... print(chunk, end="")
200
+ Artificial Intelligence...
201
+
202
+ Raw response format:
203
+ >>> for chunk in ai.search("Hello", stream=True, raw=True):
204
+ ... print(chunk)
205
+ {'text': 'Hello'}
206
+ {'text': ' there!'}
207
+
208
+ With specific mode and detail level:
209
+ >>> response = ai.search("Climate change", mode="academic", detail_level="detailed")
210
+ >>> print(response)
211
+ Climate change refers to...
212
+ """
213
+ # Use provided parameters or fall back to instance defaults
214
+ search_mode = mode or self.default_mode
215
+ search_detail_level = detail_level or self.default_detail_level
216
+
217
+ # For non-streaming, run the async search and return the complete response
218
+ if not stream:
219
+ # Create a new event loop for this request
220
+ loop = asyncio.new_event_loop()
221
+ asyncio.set_event_loop(loop)
222
+ try:
223
+ result = loop.run_until_complete(
224
+ self._async_search(prompt, False, raw, search_mode, search_detail_level)
225
+ )
226
+ return result
227
+ finally:
228
+ loop.close()
229
+
230
+ # For streaming, use a simpler approach with a single event loop
231
+ # that stays open until the generator is exhausted
232
+ buffer = ""
233
+
234
+ def sync_generator():
235
+ nonlocal buffer
236
+ # Create a new event loop for this generator
237
+ loop = asyncio.new_event_loop()
238
+ asyncio.set_event_loop(loop)
239
+
240
+ try:
241
+ # Get the async generator
242
+ async_gen_coro = self._async_search(prompt, True, raw, search_mode, search_detail_level)
243
+ async_gen = loop.run_until_complete(async_gen_coro)
244
+
245
+ # Process chunks one by one
246
+ while True:
247
+ try:
248
+ # Get the next chunk
249
+ chunk_coro = async_gen.__anext__()
250
+ chunk = loop.run_until_complete(chunk_coro)
251
+
252
+ # Update buffer and yield the chunk
253
+ if isinstance(chunk, dict) and 'text' in chunk:
254
+ buffer += chunk['text']
255
+ elif isinstance(chunk, SearchResponse):
256
+ buffer += chunk.text
257
+ else:
258
+ buffer += str(chunk)
259
+
260
+ yield chunk
261
+ except StopAsyncIteration:
262
+ break
263
+ except Exception as e:
264
+ print(f"Error in generator: {e}")
265
+ break
266
+ finally:
267
+ # Store the final response and close the loop
268
+ self.last_response = {"text": buffer}
269
+ loop.close()
270
+
271
+ return sync_generator()
272
+
273
+ async def _async_search(
274
+ self,
275
+ prompt: str,
276
+ stream: bool = False,
277
+ raw: bool = False,
278
+ mode: ModeType = "question",
279
+ detail_level: Optional[DetailLevelType] = None,
280
+ ) -> Union[SearchResponse, AsyncIterator[Union[Dict[str, str], SearchResponse]]]:
281
+ """Internal async implementation of the search method."""
282
+
283
+ async def stream_generator() -> AsyncIterator[str]:
284
+ async with aiohttp.ClientSession() as session:
285
+ # Prepare parameters
286
+ params = {"mode": mode, "q": prompt}
287
+ if detail_level:
288
+ params["options[detail_level]"] = detail_level
289
+
290
+ try:
291
+ async with session.get(
292
+ self.api_endpoint,
293
+ params=params,
294
+ proxy=self.proxies.get('http') if self.proxies else None,
295
+ timeout=self.timeout
296
+ ) as response:
297
+ if not response.ok:
298
+ raise exceptions.APIConnectionError(
299
+ f"Failed to generate response - ({response.status_code}, {response.reason}) - {await response.text()}"
300
+ )
301
+
302
+ etree = lxml.html.fromstring(await response.text())
303
+ phx_node = etree.xpath('//*[starts-with(@id, "phx-")]').pop()
304
+ csrf_token = (
305
+ etree.xpath('//*[@name="csrf-token"]').pop().get("content")
306
+ )
307
+
308
+ async with session.ws_connect(
309
+ f"{self.api_endpoint}live/websocket",
310
+ params={
311
+ "_csrf_token": csrf_token,
312
+ "vsn": "2.0.0",
313
+ },
314
+ proxy=self.proxies.get('http') if self.proxies else None,
315
+ timeout=self.timeout
316
+ ) as wsResponse:
317
+ await wsResponse.send_json(
318
+ [
319
+ None,
320
+ None,
321
+ f"lv:{phx_node.get('id')}",
322
+ "phx_join",
323
+ {
324
+ "params": {"_csrf_token": csrf_token},
325
+ "url": str(response.url),
326
+ "session": phx_node.get("data-phx-session"),
327
+ },
328
+ ]
329
+ )
330
+ while True:
331
+ json_data = await wsResponse.receive_json()
332
+ if not json_data:
333
+ break
334
+ diff: dict = json_data[4]
335
+ try:
336
+ chunk: str = diff["e"][0][1]["data"]
337
+ # Check if the chunk contains HTML content
338
+ if re.search(r"<[^>]+>", chunk):
339
+ formatted_chunk = self.format_html(chunk)
340
+ yield formatted_chunk
341
+ else:
342
+ yield chunk.replace("<br/>", "\n")
343
+ except:
344
+ cache = cache_find(diff)
345
+ if cache:
346
+ if diff.get("response", None):
347
+ # Format the cache content if it contains HTML
348
+ if re.search(r"<[^>]+>", cache):
349
+ formatted_cache = self.format_html(cache)
350
+ yield formatted_cache
351
+ else:
352
+ yield cache
353
+ break
354
+ except Exception as e:
355
+ raise exceptions.APIConnectionError(f"Error connecting to IAsk API: {str(e)}")
356
+
357
+ # For non-streaming, collect all chunks and return a single response
358
+ if not stream:
359
+ buffer = ""
360
+ async for chunk in stream_generator():
361
+ buffer += chunk
362
+ self.last_response = {"text": buffer}
363
+ return SearchResponse(buffer) if not raw else {"text": buffer}
364
+
365
+ # For streaming, create an async generator that yields chunks
366
+ async def process_stream():
367
+ buffer = ""
368
+ async for chunk in stream_generator():
369
+ buffer += chunk
370
+ if raw:
371
+ yield {"text": chunk}
372
+ else:
373
+ yield SearchResponse(chunk)
374
+ self.last_response = {"text": buffer}
375
+
376
+ # Return the async generator
377
+ return process_stream()
378
+
379
+
380
+ if __name__ == "__main__":
381
+ from rich import print
382
+
383
+ ai = IAsk()
384
+
385
+ # Example 1: Simple search with default mode
386
+ print("\n[bold cyan]Example 1: Simple search with default mode[/bold cyan]")
387
+ response = ai.search("What is Python?", stream=True)
388
+ for chunk in response:
389
+ print(chunk, end="", flush=True)
390
+ print("\n\n[bold green]Response complete.[/bold green]\n")
391
+
392
+ # Example 2: Search with academic mode
393
+ print("\n[bold cyan]Example 2: Search with academic mode[/bold cyan]")
394
+ response = ai.search("Quantum computing applications", mode="academic", stream=True)
395
+ for chunk in response:
396
+ print(chunk, end="", flush=True)
397
+ print("\n\n[bold green]Response complete.[/bold green]\n")
398
+
399
+ # Example 3: Search with advanced mode and detailed level
400
+ print("\n[bold cyan]Example 3: Search with advanced mode and detailed level[/bold cyan]")
401
+ response = ai.search("Climate change solutions", mode="advanced", detail_level="detailed", stream=True)
402
+ for chunk in response:
403
+ print(chunk, end="", flush=True)
404
+ print("\n\n[bold green]Response complete.[/bold green]\n")
405
+
406
+ # Example 4: Demonstrating the create_url method
407
+ print("\n[bold cyan]Example 4: Generated URL for browser access[/bold cyan]")
408
+ url = ai.create_url("Helpingai details", mode="question", detail_level="detailed")
409
+ print(f"URL: {url}")
410
+ print("This URL can be used directly in a browser or with other HTTP clients.")