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,333 +1,333 @@
1
- import json
2
- import random
3
- from uuid import uuid4
4
- from typing import Dict, Optional, Generator, Union, Any
5
- from curl_cffi import requests
6
-
7
- from webscout.AIbase import AISearch, SearchResponse
8
- from webscout import exceptions
9
- from webscout.litagent import LitAgent
10
-
11
-
12
- class Perplexity(AISearch):
13
- """A class to interact with the Perplexity AI search API.
14
-
15
- Perplexity provides a powerful search interface that returns AI-generated responses
16
- based on web content. It supports both streaming and non-streaming responses,
17
- multiple search modes, and model selection.
18
-
19
- Basic Usage:
20
- >>> from webscout import Perplexity
21
- >>> ai = Perplexity()
22
- >>> # Non-streaming example
23
- >>> response = ai.search("What is Python?")
24
- >>> print(response)
25
- Python is a high-level programming language...
26
-
27
- >>> # Streaming example
28
- >>> for chunk in ai.search("Tell me about AI", stream=True):
29
- ... print(chunk, end="", flush=True)
30
- Artificial Intelligence is...
31
-
32
- >>> # Pro search with specific model (requires authentication via cookies)
33
- >>> cookies = {"perplexity-user": "your_cookie_value"}
34
- >>> ai_pro = Perplexity(cookies=cookies)
35
- >>> response = ai_pro.search("Latest AI research", mode="pro", model="gpt-4o")
36
- >>> print(response)
37
-
38
- >>> # Raw response format
39
- >>> for chunk in ai.search("Hello", stream=True, raw=True):
40
- ... print(chunk)
41
- {'text': 'Hello'}
42
- {'text': ' there!'}
43
-
44
- Args:
45
- cookies (dict, optional): Cookies to use for authentication. Defaults to None.
46
- timeout (int, optional): Request timeout in seconds. Defaults to 60.
47
- proxies (dict, optional): Proxy configuration for requests. Defaults to None.
48
- """
49
-
50
- def __init__(
51
- self,
52
- cookies: Optional[Dict[str, str]] = None,
53
- timeout: int = 60,
54
- proxies: Optional[Dict[str, str]] = None
55
- ):
56
- """
57
- Initialize the Perplexity client.
58
-
59
- Args:
60
- cookies (dict, optional): Cookies to use for authentication. Defaults to None.
61
- timeout (int, optional): Request timeout in seconds. Defaults to 60.
62
- proxies (dict, optional): Proxy configuration for requests. Defaults to None.
63
- """
64
- self.timeout = timeout
65
- self.agent = LitAgent()
66
- self.session = requests.Session(headers={
67
- 'accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7',
68
- 'accept-language': 'en-US,en;q=0.9',
69
- 'cache-control': 'max-age=0',
70
- 'dnt': '1',
71
- 'priority': 'u=0, i',
72
- 'sec-ch-ua': '"Not;A=Brand";v="24", "Chromium";v="128"',
73
- 'sec-ch-ua-arch': '"x86"',
74
- 'sec-ch-ua-bitness': '"64"',
75
- 'sec-ch-ua-full-version': '"128.0.6613.120"',
76
- 'sec-ch-ua-full-version-list': '"Not;A=Brand";v="24.0.0.0", "Chromium";v="128.0.6613.120"',
77
- 'sec-ch-ua-mobile': '?0',
78
- 'sec-ch-ua-model': '""',
79
- 'sec-ch-ua-platform': '"Windows"',
80
- 'sec-ch-ua-platform-version': '"19.0.0"',
81
- 'sec-fetch-dest': 'document',
82
- 'sec-fetch-mode': 'navigate',
83
- 'sec-fetch-site': 'same-origin',
84
- 'sec-fetch-user': '?1',
85
- 'upgrade-insecure-requests': '1',
86
- 'user-agent': self.agent.random(),
87
- }, cookies=cookies or {}, impersonate='chrome')
88
-
89
- # Apply proxies if provided
90
- if proxies:
91
- self.session.proxies.update(proxies)
92
-
93
- # Initialize session with socket.io
94
- self.timestamp = format(random.getrandbits(32), '08x')
95
-
96
- # Get socket.io session ID
97
- response = self.session.get(f'https://www.perplexity.ai/socket.io/?EIO=4&transport=polling&t={self.timestamp}')
98
- self.sid = json.loads(response.text[1:])['sid']
99
-
100
- # Initialize socket.io connection
101
- assert (self.session.post(
102
- f'https://www.perplexity.ai/socket.io/?EIO=4&transport=polling&t={self.timestamp}&sid={self.sid}',
103
- data='40{"jwt":"anonymous-ask-user"}'
104
- )).text == 'OK'
105
-
106
- # Get session info
107
- self.session.get('https://www.perplexity.ai/api/auth/session')
108
-
109
- # Set default values
110
- self.copilot = 0 if not cookies else float('inf')
111
- self.file_upload = 0 if not cookies else float('inf')
112
-
113
- def _extract_answer(self, response):
114
- """
115
- Extract the answer from the response.
116
-
117
- Args:
118
- response (dict): The response from Perplexity AI.
119
-
120
- Returns:
121
- str: The extracted answer text.
122
- """
123
- if not response:
124
- return ""
125
-
126
- # Find the FINAL step in the text array
127
- final_step = None
128
- if 'text' in response and isinstance(response['text'], list):
129
- for step in response['text']:
130
- if step.get('step_type') == 'FINAL' and 'content' in step and 'answer' in step['content']:
131
- final_step = step
132
- break
133
-
134
- if not final_step:
135
- return ""
136
-
137
- try:
138
- # Parse the answer JSON string
139
- answer_json = json.loads(final_step['content']['answer'])
140
- return answer_json.get('answer', '')
141
- except (json.JSONDecodeError, KeyError):
142
- return ""
143
-
144
- def search(
145
- self,
146
- prompt: str,
147
- mode: str = 'auto',
148
- model: Optional[str] = None,
149
- sources: Optional[list] = None,
150
- stream: bool = False,
151
- raw: bool = False,
152
- language: str = 'en-US',
153
- follow_up: Optional[Dict[str, Any]] = None,
154
- incognito: bool = False
155
- ) -> Union[SearchResponse, Generator[Union[Dict[str, str], SearchResponse], None, None]]:
156
- """Search using the Perplexity API and get AI-generated responses.
157
-
158
- This method sends a search query to Perplexity and returns the AI-generated response.
159
- It supports both streaming and non-streaming modes, as well as raw response format.
160
-
161
- Args:
162
- prompt (str): The search query or prompt to send to the API.
163
- mode (str, optional): Search mode. Options: 'auto', 'pro', 'reasoning', 'deep research'.
164
- Defaults to 'auto'.
165
- model (str, optional): Model to use. Available models depend on the mode. Defaults to None.
166
- sources (list, optional): Sources to use. Options: 'web', 'scholar', 'social'.
167
- Defaults to ['web'].
168
- stream (bool, optional): If True, yields response chunks as they arrive.
169
- If False, returns complete response. Defaults to False.
170
- raw (bool, optional): If True, returns raw response dictionaries.
171
- If False, returns Response objects that convert to text automatically.
172
- Defaults to False.
173
- language (str, optional): Language to use. Defaults to 'en-US'.
174
- follow_up (dict, optional): Follow-up information. Defaults to None.
175
- incognito (bool, optional): Whether to use incognito mode. Defaults to False.
176
-
177
- Returns:
178
- If stream=True: Generator yielding response chunks as they arrive
179
- If stream=False: Complete response
180
-
181
- Raises:
182
- ValueError: If invalid mode or model is provided
183
- exceptions.APIConnectionError: If connection to API fails
184
- exceptions.FailedToGenerateResponseError: If response generation fails
185
- """
186
- if sources is None:
187
- sources = ['web']
188
-
189
- # Validate inputs
190
- if mode not in ['auto', 'pro', 'reasoning', 'deep research']:
191
- raise ValueError('Search modes -> ["auto", "pro", "reasoning", "deep research"]')
192
-
193
- if not all([source in ('web', 'scholar', 'social') for source in sources]):
194
- raise ValueError('Sources -> ["web", "scholar", "social"]')
195
-
196
- # Check if model is valid for the selected mode
197
- valid_models = {
198
- 'auto': [None],
199
- 'pro': [None, 'sonar', 'gpt-4.5', 'gpt-4o', 'claude 3.7 sonnet', 'gemini 2.0 flash', 'grok-2'],
200
- 'reasoning': [None, 'r1', 'o3-mini', 'claude 3.7 sonnet'],
201
- 'deep research': [None]
202
- }
203
-
204
- if mode in valid_models and model not in valid_models[mode] and model is not None:
205
- raise ValueError(f'Invalid model for {mode} mode. Valid models: {valid_models[mode]}')
206
-
207
- # Prepare request data
208
- json_data = {
209
- 'query_str': prompt,
210
- 'params': {
211
- 'attachments': follow_up['attachments'] if follow_up else [],
212
- 'frontend_context_uuid': str(uuid4()),
213
- 'frontend_uuid': str(uuid4()),
214
- 'is_incognito': incognito,
215
- 'language': language,
216
- 'last_backend_uuid': follow_up['backend_uuid'] if follow_up else None,
217
- 'mode': 'concise' if mode == 'auto' else 'copilot',
218
- 'model_preference': {
219
- 'auto': {
220
- None: 'turbo'
221
- },
222
- 'pro': {
223
- None: 'pplx_pro',
224
- 'sonar': 'experimental',
225
- 'gpt-4.5': 'gpt45',
226
- 'gpt-4o': 'gpt4o',
227
- 'claude 3.7 sonnet': 'claude2',
228
- 'gemini 2.0 flash': 'gemini2flash',
229
- 'grok-2': 'grok'
230
- },
231
- 'reasoning': {
232
- None: 'pplx_reasoning',
233
- 'r1': 'r1',
234
- 'o3-mini': 'o3mini',
235
- 'claude 3.7 sonnet': 'claude37sonnetthinking'
236
- },
237
- 'deep research': {
238
- None: 'pplx_alpha'
239
- }
240
- }[mode][model],
241
- 'source': 'default',
242
- 'sources': sources,
243
- 'version': '2.18'
244
- }
245
- }
246
-
247
- try:
248
- # Make the request
249
- resp = self.session.post(
250
- 'https://www.perplexity.ai/rest/sse/perplexity_ask',
251
- json=json_data,
252
- stream=True,
253
- timeout=self.timeout
254
- )
255
-
256
- if resp.status_code != 200:
257
- raise exceptions.APIConnectionError(f"API returned status code {resp.status_code}")
258
-
259
- # Define streaming response handler
260
- def stream_response():
261
- for chunk in resp.iter_lines(delimiter=b'\r\n\r\n'):
262
- content = chunk.decode('utf-8')
263
- if content.startswith('event: message\r\n'):
264
- content_json = json.loads(content[len('event: message\r\ndata: '):])
265
- if 'text' in content_json:
266
- try:
267
- # If text is a string, try to parse it as JSON
268
- if isinstance(content_json['text'], str):
269
- content_json['text'] = json.loads(content_json['text'])
270
- except json.JSONDecodeError:
271
- pass
272
-
273
- if raw:
274
- yield content_json
275
- else:
276
- # For non-raw responses, extract text from each chunk
277
- if 'text' in content_json and isinstance(content_json['text'], list):
278
- for step in content_json['text']:
279
- if step.get('type') == 'answer' and 'value' in step:
280
- yield SearchResponse(step['value'])
281
- elif step.get('type') == 'thinking' and 'value' in step:
282
- yield SearchResponse(step['value'])
283
- elif content.startswith('event: end_of_stream\r\n'):
284
- return
285
-
286
- # Handle streaming or non-streaming response
287
- if stream:
288
- return stream_response()
289
- else:
290
- chunks = []
291
- final_response = None
292
-
293
- for chunk in resp.iter_lines(delimiter=b'\r\n\r\n'):
294
- content = chunk.decode('utf-8')
295
- if content.startswith('event: message\r\n'):
296
- content_json = json.loads(content[len('event: message\r\ndata: '):])
297
- if 'text' in content_json:
298
- try:
299
- # If text is a string, try to parse it as JSON
300
- if isinstance(content_json['text'], str):
301
- content_json['text'] = json.loads(content_json['text'])
302
- except json.JSONDecodeError:
303
- pass
304
- chunks.append(content_json)
305
- final_response = content_json
306
- elif content.startswith('event: end_of_stream\r\n'):
307
- # Process the final response to extract the answer
308
- if final_response:
309
- answer_text = self._extract_answer(final_response)
310
- return SearchResponse(answer_text) if not raw else final_response
311
- elif chunks:
312
- answer_text = self._extract_answer(chunks[-1])
313
- return SearchResponse(answer_text) if not raw else chunks[-1]
314
- else:
315
- return SearchResponse("") if not raw else {}
316
-
317
- # If we get here, something went wrong
318
- raise exceptions.FailedToGenerateResponseError("Failed to get complete response")
319
-
320
- except requests.RequestsError as e:
321
- raise exceptions.APIConnectionError(f"Connection error: {str(e)}")
322
- except json.JSONDecodeError:
323
- raise exceptions.FailedToGenerateResponseError("Failed to parse response JSON")
324
- except Exception as e:
325
- raise exceptions.FailedToGenerateResponseError(f"Error: {str(e)}")
326
-
327
-
328
- if __name__ == "__main__":
329
- # Simple test
330
- ai = Perplexity()
331
- response = ai.search("What is Python?")
332
- print(response)
1
+ import json
2
+ import random
3
+ from uuid import uuid4
4
+ from typing import Dict, Optional, Generator, Union, Any
5
+ from curl_cffi import requests
6
+
7
+ from webscout.AIbase import AISearch, SearchResponse
8
+ from webscout import exceptions
9
+ from webscout.litagent import LitAgent
10
+
11
+
12
+ class Perplexity(AISearch):
13
+ """A class to interact with the Perplexity AI search API.
14
+
15
+ Perplexity provides a powerful search interface that returns AI-generated responses
16
+ based on web content. It supports both streaming and non-streaming responses,
17
+ multiple search modes, and model selection.
18
+
19
+ Basic Usage:
20
+ >>> from webscout import Perplexity
21
+ >>> ai = Perplexity()
22
+ >>> # Non-streaming example
23
+ >>> response = ai.search("What is Python?")
24
+ >>> print(response)
25
+ Python is a high-level programming language...
26
+
27
+ >>> # Streaming example
28
+ >>> for chunk in ai.search("Tell me about AI", stream=True):
29
+ ... print(chunk, end="", flush=True)
30
+ Artificial Intelligence is...
31
+
32
+ >>> # Pro search with specific model (requires authentication via cookies)
33
+ >>> cookies = {"perplexity-user": "your_cookie_value"}
34
+ >>> ai_pro = Perplexity(cookies=cookies)
35
+ >>> response = ai_pro.search("Latest AI research", mode="pro", model="gpt-4o")
36
+ >>> print(response)
37
+
38
+ >>> # Raw response format
39
+ >>> for chunk in ai.search("Hello", stream=True, raw=True):
40
+ ... print(chunk)
41
+ {'text': 'Hello'}
42
+ {'text': ' there!'}
43
+
44
+ Args:
45
+ cookies (dict, optional): Cookies to use for authentication. Defaults to None.
46
+ timeout (int, optional): Request timeout in seconds. Defaults to 60.
47
+ proxies (dict, optional): Proxy configuration for requests. Defaults to None.
48
+ """
49
+
50
+ def __init__(
51
+ self,
52
+ cookies: Optional[Dict[str, str]] = None,
53
+ timeout: int = 60,
54
+ proxies: Optional[Dict[str, str]] = None
55
+ ):
56
+ """
57
+ Initialize the Perplexity client.
58
+
59
+ Args:
60
+ cookies (dict, optional): Cookies to use for authentication. Defaults to None.
61
+ timeout (int, optional): Request timeout in seconds. Defaults to 60.
62
+ proxies (dict, optional): Proxy configuration for requests. Defaults to None.
63
+ """
64
+ self.timeout = timeout
65
+ self.agent = LitAgent()
66
+ self.session = requests.Session(headers={
67
+ 'accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7',
68
+ 'accept-language': 'en-US,en;q=0.9',
69
+ 'cache-control': 'max-age=0',
70
+ 'dnt': '1',
71
+ 'priority': 'u=0, i',
72
+ 'sec-ch-ua': '"Not;A=Brand";v="24", "Chromium";v="128"',
73
+ 'sec-ch-ua-arch': '"x86"',
74
+ 'sec-ch-ua-bitness': '"64"',
75
+ 'sec-ch-ua-full-version': '"128.0.6613.120"',
76
+ 'sec-ch-ua-full-version-list': '"Not;A=Brand";v="24.0.0.0", "Chromium";v="128.0.6613.120"',
77
+ 'sec-ch-ua-mobile': '?0',
78
+ 'sec-ch-ua-model': '""',
79
+ 'sec-ch-ua-platform': '"Windows"',
80
+ 'sec-ch-ua-platform-version': '"19.0.0"',
81
+ 'sec-fetch-dest': 'document',
82
+ 'sec-fetch-mode': 'navigate',
83
+ 'sec-fetch-site': 'same-origin',
84
+ 'sec-fetch-user': '?1',
85
+ 'upgrade-insecure-requests': '1',
86
+ 'user-agent': self.agent.random(),
87
+ }, cookies=cookies or {}, impersonate='chrome')
88
+
89
+ # Apply proxies if provided
90
+ if proxies:
91
+ self.session.proxies.update(proxies)
92
+
93
+ # Initialize session with socket.io
94
+ self.timestamp = format(random.getrandbits(32), '08x')
95
+
96
+ # Get socket.io session ID
97
+ response = self.session.get(f'https://www.perplexity.ai/socket.io/?EIO=4&transport=polling&t={self.timestamp}')
98
+ self.sid = json.loads(response.text[1:])['sid']
99
+
100
+ # Initialize socket.io connection
101
+ assert (self.session.post(
102
+ f'https://www.perplexity.ai/socket.io/?EIO=4&transport=polling&t={self.timestamp}&sid={self.sid}',
103
+ data='40{"jwt":"anonymous-ask-user"}'
104
+ )).text == 'OK'
105
+
106
+ # Get session info
107
+ self.session.get('https://www.perplexity.ai/api/auth/session')
108
+
109
+ # Set default values
110
+ self.copilot = 0 if not cookies else float('inf')
111
+ self.file_upload = 0 if not cookies else float('inf')
112
+
113
+ def _extract_answer(self, response):
114
+ """
115
+ Extract the answer from the response.
116
+
117
+ Args:
118
+ response (dict): The response from Perplexity AI.
119
+
120
+ Returns:
121
+ str: The extracted answer text.
122
+ """
123
+ if not response:
124
+ return ""
125
+
126
+ # Find the FINAL step in the text array
127
+ final_step = None
128
+ if 'text' in response and isinstance(response['text'], list):
129
+ for step in response['text']:
130
+ if step.get('step_type') == 'FINAL' and 'content' in step and 'answer' in step['content']:
131
+ final_step = step
132
+ break
133
+
134
+ if not final_step:
135
+ return ""
136
+
137
+ try:
138
+ # Parse the answer JSON string
139
+ answer_json = json.loads(final_step['content']['answer'])
140
+ return answer_json.get('answer', '')
141
+ except (json.JSONDecodeError, KeyError):
142
+ return ""
143
+
144
+ def search(
145
+ self,
146
+ prompt: str,
147
+ mode: str = 'auto',
148
+ model: Optional[str] = None,
149
+ sources: Optional[list] = None,
150
+ stream: bool = False,
151
+ raw: bool = False,
152
+ language: str = 'en-US',
153
+ follow_up: Optional[Dict[str, Any]] = None,
154
+ incognito: bool = False
155
+ ) -> Union[SearchResponse, Generator[Union[Dict[str, str], SearchResponse], None, None]]:
156
+ """Search using the Perplexity API and get AI-generated responses.
157
+
158
+ This method sends a search query to Perplexity and returns the AI-generated response.
159
+ It supports both streaming and non-streaming modes, as well as raw response format.
160
+
161
+ Args:
162
+ prompt (str): The search query or prompt to send to the API.
163
+ mode (str, optional): Search mode. Options: 'auto', 'pro', 'reasoning', 'deep research'.
164
+ Defaults to 'auto'.
165
+ model (str, optional): Model to use. Available models depend on the mode. Defaults to None.
166
+ sources (list, optional): Sources to use. Options: 'web', 'scholar', 'social'.
167
+ Defaults to ['web'].
168
+ stream (bool, optional): If True, yields response chunks as they arrive.
169
+ If False, returns complete response. Defaults to False.
170
+ raw (bool, optional): If True, returns raw response dictionaries.
171
+ If False, returns Response objects that convert to text automatically.
172
+ Defaults to False.
173
+ language (str, optional): Language to use. Defaults to 'en-US'.
174
+ follow_up (dict, optional): Follow-up information. Defaults to None.
175
+ incognito (bool, optional): Whether to use incognito mode. Defaults to False.
176
+
177
+ Returns:
178
+ If stream=True: Generator yielding response chunks as they arrive
179
+ If stream=False: Complete response
180
+
181
+ Raises:
182
+ ValueError: If invalid mode or model is provided
183
+ exceptions.APIConnectionError: If connection to API fails
184
+ exceptions.FailedToGenerateResponseError: If response generation fails
185
+ """
186
+ if sources is None:
187
+ sources = ['web']
188
+
189
+ # Validate inputs
190
+ if mode not in ['auto', 'pro', 'reasoning', 'deep research']:
191
+ raise ValueError('Search modes -> ["auto", "pro", "reasoning", "deep research"]')
192
+
193
+ if not all([source in ('web', 'scholar', 'social') for source in sources]):
194
+ raise ValueError('Sources -> ["web", "scholar", "social"]')
195
+
196
+ # Check if model is valid for the selected mode
197
+ valid_models = {
198
+ 'auto': [None],
199
+ 'pro': [None, 'sonar', 'gpt-4.5', 'gpt-4o', 'claude 3.7 sonnet', 'gemini 2.0 flash', 'grok-2'],
200
+ 'reasoning': [None, 'r1', 'o3-mini', 'claude 3.7 sonnet'],
201
+ 'deep research': [None]
202
+ }
203
+
204
+ if mode in valid_models and model not in valid_models[mode] and model is not None:
205
+ raise ValueError(f'Invalid model for {mode} mode. Valid models: {valid_models[mode]}')
206
+
207
+ # Prepare request data
208
+ json_data = {
209
+ 'query_str': prompt,
210
+ 'params': {
211
+ 'attachments': follow_up['attachments'] if follow_up else [],
212
+ 'frontend_context_uuid': str(uuid4()),
213
+ 'frontend_uuid': str(uuid4()),
214
+ 'is_incognito': incognito,
215
+ 'language': language,
216
+ 'last_backend_uuid': follow_up['backend_uuid'] if follow_up else None,
217
+ 'mode': 'concise' if mode == 'auto' else 'copilot',
218
+ 'model_preference': {
219
+ 'auto': {
220
+ None: 'turbo'
221
+ },
222
+ 'pro': {
223
+ None: 'pplx_pro',
224
+ 'sonar': 'experimental',
225
+ 'gpt-4.5': 'gpt45',
226
+ 'gpt-4o': 'gpt4o',
227
+ 'claude 3.7 sonnet': 'claude2',
228
+ 'gemini 2.0 flash': 'gemini2flash',
229
+ 'grok-2': 'grok'
230
+ },
231
+ 'reasoning': {
232
+ None: 'pplx_reasoning',
233
+ 'r1': 'r1',
234
+ 'o3-mini': 'o3mini',
235
+ 'claude 3.7 sonnet': 'claude37sonnetthinking'
236
+ },
237
+ 'deep research': {
238
+ None: 'pplx_alpha'
239
+ }
240
+ }[mode][model],
241
+ 'source': 'default',
242
+ 'sources': sources,
243
+ 'version': '2.18'
244
+ }
245
+ }
246
+
247
+ try:
248
+ # Make the request
249
+ resp = self.session.post(
250
+ 'https://www.perplexity.ai/rest/sse/perplexity_ask',
251
+ json=json_data,
252
+ stream=True,
253
+ timeout=self.timeout
254
+ )
255
+
256
+ if resp.status_code != 200:
257
+ raise exceptions.APIConnectionError(f"API returned status code {resp.status_code}")
258
+
259
+ # Define streaming response handler
260
+ def stream_response():
261
+ for chunk in resp.iter_lines(delimiter=b'\r\n\r\n'):
262
+ content = chunk.decode('utf-8')
263
+ if content.startswith('event: message\r\n'):
264
+ content_json = json.loads(content[len('event: message\r\ndata: '):])
265
+ if 'text' in content_json:
266
+ try:
267
+ # If text is a string, try to parse it as JSON
268
+ if isinstance(content_json['text'], str):
269
+ content_json['text'] = json.loads(content_json['text'])
270
+ except json.JSONDecodeError:
271
+ pass
272
+
273
+ if raw:
274
+ yield content_json
275
+ else:
276
+ # For non-raw responses, extract text from each chunk
277
+ if 'text' in content_json and isinstance(content_json['text'], list):
278
+ for step in content_json['text']:
279
+ if step.get('type') == 'answer' and 'value' in step:
280
+ yield SearchResponse(step['value'])
281
+ elif step.get('type') == 'thinking' and 'value' in step:
282
+ yield SearchResponse(step['value'])
283
+ elif content.startswith('event: end_of_stream\r\n'):
284
+ return
285
+
286
+ # Handle streaming or non-streaming response
287
+ if stream:
288
+ return stream_response()
289
+ else:
290
+ chunks = []
291
+ final_response = None
292
+
293
+ for chunk in resp.iter_lines(delimiter=b'\r\n\r\n'):
294
+ content = chunk.decode('utf-8')
295
+ if content.startswith('event: message\r\n'):
296
+ content_json = json.loads(content[len('event: message\r\ndata: '):])
297
+ if 'text' in content_json:
298
+ try:
299
+ # If text is a string, try to parse it as JSON
300
+ if isinstance(content_json['text'], str):
301
+ content_json['text'] = json.loads(content_json['text'])
302
+ except json.JSONDecodeError:
303
+ pass
304
+ chunks.append(content_json)
305
+ final_response = content_json
306
+ elif content.startswith('event: end_of_stream\r\n'):
307
+ # Process the final response to extract the answer
308
+ if final_response:
309
+ answer_text = self._extract_answer(final_response)
310
+ return SearchResponse(answer_text) if not raw else final_response
311
+ elif chunks:
312
+ answer_text = self._extract_answer(chunks[-1])
313
+ return SearchResponse(answer_text) if not raw else chunks[-1]
314
+ else:
315
+ return SearchResponse("") if not raw else {}
316
+
317
+ # If we get here, something went wrong
318
+ raise exceptions.FailedToGenerateResponseError("Failed to get complete response")
319
+
320
+ except requests.RequestsError as e:
321
+ raise exceptions.APIConnectionError(f"Connection error: {str(e)}")
322
+ except json.JSONDecodeError:
323
+ raise exceptions.FailedToGenerateResponseError("Failed to parse response JSON")
324
+ except Exception as e:
325
+ raise exceptions.FailedToGenerateResponseError(f"Error: {str(e)}")
326
+
327
+
328
+ if __name__ == "__main__":
329
+ # Simple test
330
+ ai = Perplexity()
331
+ response = ai.search("What is Python?")
332
+ print(response)
333
333