webscout 8.3.7__py3-none-any.whl → 2025.10.13__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 (306) 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/Andi.py +1 -1
  65. webscout/Provider/Apriel.py +306 -0
  66. webscout/Provider/ChatGPTClone.py +237 -236
  67. webscout/Provider/ChatSandbox.py +343 -343
  68. webscout/Provider/Cloudflare.py +324 -324
  69. webscout/Provider/Cohere.py +208 -208
  70. webscout/Provider/Deepinfra.py +370 -366
  71. webscout/Provider/ExaAI.py +260 -260
  72. webscout/Provider/ExaChat.py +308 -308
  73. webscout/Provider/Flowith.py +221 -221
  74. webscout/Provider/GMI.py +293 -0
  75. webscout/Provider/Gemini.py +164 -164
  76. webscout/Provider/GeminiProxy.py +167 -167
  77. webscout/Provider/GithubChat.py +371 -372
  78. webscout/Provider/Groq.py +800 -800
  79. webscout/Provider/HeckAI.py +383 -383
  80. webscout/Provider/Jadve.py +282 -282
  81. webscout/Provider/K2Think.py +307 -307
  82. webscout/Provider/Koboldai.py +205 -205
  83. webscout/Provider/LambdaChat.py +423 -423
  84. webscout/Provider/Nemotron.py +244 -244
  85. webscout/Provider/Netwrck.py +248 -248
  86. webscout/Provider/OLLAMA.py +395 -395
  87. webscout/Provider/OPENAI/Cloudflare.py +393 -393
  88. webscout/Provider/OPENAI/FalconH1.py +451 -451
  89. webscout/Provider/OPENAI/FreeGemini.py +296 -296
  90. webscout/Provider/OPENAI/K2Think.py +431 -431
  91. webscout/Provider/OPENAI/NEMOTRON.py +240 -240
  92. webscout/Provider/OPENAI/PI.py +427 -427
  93. webscout/Provider/OPENAI/README.md +959 -959
  94. webscout/Provider/OPENAI/TogetherAI.py +345 -345
  95. webscout/Provider/OPENAI/TwoAI.py +465 -465
  96. webscout/Provider/OPENAI/__init__.py +33 -18
  97. webscout/Provider/OPENAI/base.py +248 -248
  98. webscout/Provider/OPENAI/chatglm.py +528 -0
  99. webscout/Provider/OPENAI/chatgpt.py +592 -592
  100. webscout/Provider/OPENAI/chatgptclone.py +521 -521
  101. webscout/Provider/OPENAI/chatsandbox.py +202 -202
  102. webscout/Provider/OPENAI/deepinfra.py +318 -314
  103. webscout/Provider/OPENAI/e2b.py +1665 -1665
  104. webscout/Provider/OPENAI/exaai.py +420 -420
  105. webscout/Provider/OPENAI/exachat.py +452 -452
  106. webscout/Provider/OPENAI/friendli.py +232 -232
  107. webscout/Provider/OPENAI/{refact.py → gmi.py} +324 -274
  108. webscout/Provider/OPENAI/groq.py +364 -364
  109. webscout/Provider/OPENAI/heckai.py +314 -314
  110. webscout/Provider/OPENAI/llmchatco.py +337 -337
  111. webscout/Provider/OPENAI/netwrck.py +355 -355
  112. webscout/Provider/OPENAI/oivscode.py +290 -290
  113. webscout/Provider/OPENAI/opkfc.py +518 -518
  114. webscout/Provider/OPENAI/pydantic_imports.py +1 -1
  115. webscout/Provider/OPENAI/scirachat.py +535 -535
  116. webscout/Provider/OPENAI/sonus.py +308 -308
  117. webscout/Provider/OPENAI/standardinput.py +442 -442
  118. webscout/Provider/OPENAI/textpollinations.py +340 -340
  119. webscout/Provider/OPENAI/toolbaz.py +419 -416
  120. webscout/Provider/OPENAI/typefully.py +362 -362
  121. webscout/Provider/OPENAI/utils.py +295 -295
  122. webscout/Provider/OPENAI/venice.py +436 -436
  123. webscout/Provider/OPENAI/wisecat.py +387 -387
  124. webscout/Provider/OPENAI/writecream.py +166 -166
  125. webscout/Provider/OPENAI/x0gpt.py +378 -378
  126. webscout/Provider/OPENAI/yep.py +389 -389
  127. webscout/Provider/OpenGPT.py +230 -230
  128. webscout/Provider/Openai.py +243 -243
  129. webscout/Provider/PI.py +405 -405
  130. webscout/Provider/Perplexitylabs.py +430 -430
  131. webscout/Provider/QwenLM.py +272 -272
  132. webscout/Provider/STT/__init__.py +16 -1
  133. webscout/Provider/Sambanova.py +257 -257
  134. webscout/Provider/StandardInput.py +309 -309
  135. webscout/Provider/TTI/README.md +82 -82
  136. webscout/Provider/TTI/__init__.py +33 -18
  137. webscout/Provider/TTI/aiarta.py +413 -413
  138. webscout/Provider/TTI/base.py +136 -136
  139. webscout/Provider/TTI/bing.py +243 -243
  140. webscout/Provider/TTI/gpt1image.py +149 -149
  141. webscout/Provider/TTI/imagen.py +196 -196
  142. webscout/Provider/TTI/infip.py +211 -211
  143. webscout/Provider/TTI/magicstudio.py +232 -232
  144. webscout/Provider/TTI/monochat.py +219 -219
  145. webscout/Provider/TTI/piclumen.py +214 -214
  146. webscout/Provider/TTI/pixelmuse.py +232 -232
  147. webscout/Provider/TTI/pollinations.py +232 -232
  148. webscout/Provider/TTI/together.py +288 -288
  149. webscout/Provider/TTI/utils.py +12 -12
  150. webscout/Provider/TTI/venice.py +367 -367
  151. webscout/Provider/TTS/README.md +192 -192
  152. webscout/Provider/TTS/__init__.py +33 -18
  153. webscout/Provider/TTS/parler.py +110 -110
  154. webscout/Provider/TTS/streamElements.py +333 -333
  155. webscout/Provider/TTS/utils.py +280 -280
  156. webscout/Provider/TeachAnything.py +237 -237
  157. webscout/Provider/TextPollinationsAI.py +310 -310
  158. webscout/Provider/TogetherAI.py +356 -356
  159. webscout/Provider/TwoAI.py +312 -312
  160. webscout/Provider/TypliAI.py +311 -311
  161. webscout/Provider/UNFINISHED/ChatHub.py +208 -208
  162. webscout/Provider/UNFINISHED/ChutesAI.py +313 -313
  163. webscout/Provider/UNFINISHED/GizAI.py +294 -294
  164. webscout/Provider/UNFINISHED/Marcus.py +198 -198
  165. webscout/Provider/UNFINISHED/Qodo.py +477 -477
  166. webscout/Provider/UNFINISHED/VercelAIGateway.py +338 -338
  167. webscout/Provider/UNFINISHED/XenAI.py +324 -324
  168. webscout/Provider/UNFINISHED/Youchat.py +330 -330
  169. webscout/Provider/UNFINISHED/liner.py +334 -0
  170. webscout/Provider/UNFINISHED/liner_api_request.py +262 -262
  171. webscout/Provider/UNFINISHED/puterjs.py +634 -634
  172. webscout/Provider/UNFINISHED/samurai.py +223 -223
  173. webscout/Provider/UNFINISHED/test_lmarena.py +119 -119
  174. webscout/Provider/Venice.py +250 -250
  175. webscout/Provider/VercelAI.py +256 -256
  176. webscout/Provider/WiseCat.py +231 -231
  177. webscout/Provider/WrDoChat.py +366 -366
  178. webscout/Provider/__init__.py +33 -18
  179. webscout/Provider/ai4chat.py +174 -174
  180. webscout/Provider/akashgpt.py +331 -331
  181. webscout/Provider/cerebras.py +446 -446
  182. webscout/Provider/chatglm.py +394 -301
  183. webscout/Provider/cleeai.py +211 -211
  184. webscout/Provider/elmo.py +282 -282
  185. webscout/Provider/geminiapi.py +208 -208
  186. webscout/Provider/granite.py +261 -261
  187. webscout/Provider/hermes.py +263 -263
  188. webscout/Provider/julius.py +223 -223
  189. webscout/Provider/learnfastai.py +309 -309
  190. webscout/Provider/llama3mitril.py +214 -214
  191. webscout/Provider/llmchat.py +243 -243
  192. webscout/Provider/llmchatco.py +290 -290
  193. webscout/Provider/meta.py +801 -801
  194. webscout/Provider/oivscode.py +309 -309
  195. webscout/Provider/scira_chat.py +383 -383
  196. webscout/Provider/searchchat.py +292 -292
  197. webscout/Provider/sonus.py +258 -258
  198. webscout/Provider/toolbaz.py +370 -367
  199. webscout/Provider/turboseek.py +273 -273
  200. webscout/Provider/typefully.py +207 -207
  201. webscout/Provider/yep.py +372 -372
  202. webscout/__init__.py +27 -31
  203. webscout/__main__.py +5 -5
  204. webscout/auth/api_key_manager.py +189 -189
  205. webscout/auth/config.py +175 -175
  206. webscout/auth/models.py +185 -185
  207. webscout/auth/routes.py +663 -664
  208. webscout/auth/simple_logger.py +236 -236
  209. webscout/cli.py +523 -523
  210. webscout/conversation.py +438 -438
  211. webscout/exceptions.py +361 -361
  212. webscout/litagent/Readme.md +298 -298
  213. webscout/litagent/__init__.py +28 -28
  214. webscout/litagent/agent.py +581 -581
  215. webscout/litagent/constants.py +59 -59
  216. webscout/litprinter/__init__.py +58 -58
  217. webscout/models.py +181 -181
  218. webscout/optimizers.py +419 -419
  219. webscout/prompt_manager.py +288 -288
  220. webscout/sanitize.py +1078 -1078
  221. webscout/scout/README.md +401 -401
  222. webscout/scout/__init__.py +8 -8
  223. webscout/scout/core/__init__.py +6 -6
  224. webscout/scout/core/crawler.py +297 -297
  225. webscout/scout/core/scout.py +706 -706
  226. webscout/scout/core/search_result.py +95 -95
  227. webscout/scout/core/text_analyzer.py +62 -62
  228. webscout/scout/core/text_utils.py +277 -277
  229. webscout/scout/core/web_analyzer.py +51 -51
  230. webscout/scout/element.py +599 -599
  231. webscout/scout/parsers/__init__.py +69 -69
  232. webscout/scout/parsers/html5lib_parser.py +172 -172
  233. webscout/scout/parsers/html_parser.py +236 -236
  234. webscout/scout/parsers/lxml_parser.py +178 -178
  235. webscout/scout/utils.py +37 -37
  236. webscout/search/__init__.py +51 -0
  237. webscout/search/base.py +195 -0
  238. webscout/search/duckduckgo_main.py +54 -0
  239. webscout/search/engines/__init__.py +48 -0
  240. webscout/search/engines/bing.py +84 -0
  241. webscout/search/engines/bing_news.py +52 -0
  242. webscout/search/engines/brave.py +43 -0
  243. webscout/search/engines/duckduckgo/__init__.py +25 -0
  244. webscout/search/engines/duckduckgo/answers.py +78 -0
  245. webscout/search/engines/duckduckgo/base.py +187 -0
  246. webscout/search/engines/duckduckgo/images.py +97 -0
  247. webscout/search/engines/duckduckgo/maps.py +168 -0
  248. webscout/search/engines/duckduckgo/news.py +68 -0
  249. webscout/search/engines/duckduckgo/suggestions.py +21 -0
  250. webscout/search/engines/duckduckgo/text.py +211 -0
  251. webscout/search/engines/duckduckgo/translate.py +47 -0
  252. webscout/search/engines/duckduckgo/videos.py +63 -0
  253. webscout/search/engines/duckduckgo/weather.py +74 -0
  254. webscout/search/engines/mojeek.py +37 -0
  255. webscout/search/engines/wikipedia.py +56 -0
  256. webscout/search/engines/yahoo.py +65 -0
  257. webscout/search/engines/yahoo_news.py +64 -0
  258. webscout/search/engines/yandex.py +43 -0
  259. webscout/search/engines/yep/__init__.py +13 -0
  260. webscout/search/engines/yep/base.py +32 -0
  261. webscout/search/engines/yep/images.py +99 -0
  262. webscout/search/engines/yep/suggestions.py +35 -0
  263. webscout/search/engines/yep/text.py +114 -0
  264. webscout/search/http_client.py +156 -0
  265. webscout/search/results.py +137 -0
  266. webscout/search/yep_main.py +44 -0
  267. webscout/swiftcli/Readme.md +323 -323
  268. webscout/swiftcli/__init__.py +95 -95
  269. webscout/swiftcli/core/__init__.py +7 -7
  270. webscout/swiftcli/core/cli.py +308 -308
  271. webscout/swiftcli/core/context.py +104 -104
  272. webscout/swiftcli/core/group.py +241 -241
  273. webscout/swiftcli/decorators/__init__.py +28 -28
  274. webscout/swiftcli/decorators/command.py +221 -221
  275. webscout/swiftcli/decorators/options.py +220 -220
  276. webscout/swiftcli/decorators/output.py +302 -302
  277. webscout/swiftcli/exceptions.py +21 -21
  278. webscout/swiftcli/plugins/__init__.py +9 -9
  279. webscout/swiftcli/plugins/base.py +135 -135
  280. webscout/swiftcli/plugins/manager.py +269 -269
  281. webscout/swiftcli/utils/__init__.py +59 -59
  282. webscout/swiftcli/utils/formatting.py +252 -252
  283. webscout/swiftcli/utils/parsing.py +267 -267
  284. webscout/update_checker.py +117 -117
  285. webscout/version.py +1 -1
  286. webscout/version.py.bak +2 -0
  287. webscout/zeroart/README.md +89 -89
  288. webscout/zeroart/__init__.py +134 -134
  289. webscout/zeroart/base.py +66 -66
  290. webscout/zeroart/effects.py +100 -100
  291. webscout/zeroart/fonts.py +1238 -1238
  292. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/METADATA +936 -937
  293. webscout-2025.10.13.dist-info/RECORD +329 -0
  294. webscout/Provider/AISEARCH/DeepFind.py +0 -254
  295. webscout/Provider/OPENAI/Qwen3.py +0 -303
  296. webscout/Provider/OPENAI/qodo.py +0 -630
  297. webscout/Provider/OPENAI/xenai.py +0 -514
  298. webscout/tempid.py +0 -134
  299. webscout/webscout_search.py +0 -1183
  300. webscout/webscout_search_async.py +0 -649
  301. webscout/yep_search.py +0 -346
  302. webscout-8.3.7.dist-info/RECORD +0 -301
  303. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/WHEEL +0 -0
  304. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/entry_points.txt +0 -0
  305. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/licenses/LICENSE.md +0 -0
  306. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/top_level.txt +0 -0
webscout/Provider/Groq.py CHANGED
@@ -1,801 +1,801 @@
1
- from typing import Any, AsyncGenerator, Dict, Optional, Callable, List, Union
2
-
3
- import httpx
4
- import json
5
-
6
- # Import curl_cffi for improved request handling
7
- from curl_cffi.requests import Session
8
- from curl_cffi import CurlError
9
-
10
- from webscout.AIutel import Optimizers
11
- from webscout.AIutel import Conversation
12
- from webscout.AIutel import AwesomePrompts, sanitize_stream # Import sanitize_stream
13
- from webscout.AIbase import Provider, AsyncProvider
14
- from webscout import exceptions
15
-
16
- class GROQ(Provider):
17
- """
18
- A class to interact with the GROQ AI API.
19
- """
20
- required_auth = True
21
- # Default models list (will be updated dynamically)
22
- AVAILABLE_MODELS = [
23
- "distil-whisper-large-v3-en",
24
- "gemma2-9b-it",
25
- "llama-3.3-70b-versatile",
26
- "llama-3.1-8b-instant",
27
- "llama-guard-3-8b",
28
- "llama3-70b-8192",
29
- "llama3-8b-8192",
30
- "whisper-large-v3",
31
- "whisper-large-v3-turbo",
32
- "meta-llama/llama-4-scout-17b-16e-instruct",
33
- "meta-llama/llama-4-maverick-17b-128e-instruct",
34
- "playai-tts",
35
- "playai-tts-arabic",
36
- "qwen-qwq-32b",
37
- "mistral-saba-24b",
38
- "qwen-2.5-coder-32b",
39
- "qwen-2.5-32b",
40
- "deepseek-r1-distill-qwen-32b",
41
- "deepseek-r1-distill-llama-70b",
42
- "llama-3.3-70b-specdec",
43
- "llama-3.2-1b-preview",
44
- "llama-3.2-3b-preview",
45
- "llama-3.2-11b-vision-preview",
46
- "llama-3.2-90b-vision-preview",
47
- "mixtral-8x7b-32768"
48
- ]
49
-
50
- @classmethod
51
- def get_models(cls, api_key: str = None):
52
- """Fetch available models from Groq API.
53
-
54
- Args:
55
- api_key (str, optional): Groq API key. If not provided, returns default models.
56
-
57
- Returns:
58
- list: List of available model IDs
59
- """
60
- if not api_key:
61
- return cls.AVAILABLE_MODELS
62
-
63
- try:
64
- # Use a temporary curl_cffi session for this class method
65
- temp_session = Session()
66
- headers = {
67
- "Content-Type": "application/json",
68
- "Authorization": f"Bearer {api_key}",
69
- }
70
-
71
- response = temp_session.get(
72
- "https://api.groq.com/openai/v1/models",
73
- headers=headers,
74
- impersonate="chrome110" # Use impersonate for fetching
75
- )
76
-
77
- if response.status_code != 200:
78
- return cls.AVAILABLE_MODELS
79
-
80
- data = response.json()
81
- if "data" in data and isinstance(data["data"], list):
82
- return [model["id"] for model in data["data"]]
83
- return cls.AVAILABLE_MODELS
84
-
85
- except (CurlError, Exception):
86
- # Fallback to default models list if fetching fails
87
- return cls.AVAILABLE_MODELS
88
-
89
- def __init__(
90
- self,
91
- api_key: str,
92
- is_conversation: bool = True,
93
- max_tokens: int = 600,
94
- temperature: float = 1,
95
- presence_penalty: int = 0,
96
- frequency_penalty: int = 0,
97
- top_p: float = 1,
98
- model: str = "mixtral-8x7b-32768",
99
- timeout: int = 30,
100
- intro: str = None,
101
- filepath: str = None,
102
- update_file: bool = True,
103
- proxies: dict = {},
104
- history_offset: int = 10250,
105
- act: str = None,
106
- system_prompt: Optional[str] = None,
107
- ):
108
- """Instantiates GROQ
109
-
110
- Args:
111
- api_key (key): GROQ's API key.
112
- is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
113
- max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.
114
- temperature (float, optional): Charge of the generated text's randomness. Defaults to 1.
115
- presence_penalty (int, optional): Chances of topic being repeated. Defaults to 0.
116
- frequency_penalty (int, optional): Chances of word being repeated. Defaults to 0.
117
- top_p (float, optional): Sampling threshold during inference time. Defaults to 0.999.
118
- model (str, optional): LLM model name. Defaults to "mixtral-8x7b-32768".
119
- timeout (int, optional): Http request timeout. Defaults to 30.
120
- intro (str, optional): Conversation introductory prompt. Defaults to None.
121
- filepath (str, optional): Path to file containing conversation history. Defaults to None.
122
- update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
123
- proxies (dict, optional): Http request proxies. Defaults to {}.
124
- history_offset (int, optional): Limit conversation history to this number of last texts. Defaults to 10250.
125
- act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
126
- system_prompt (str, optional): System prompt to guide the conversation. Defaults to None.
127
- """
128
- # Update available models from API
129
- self.update_available_models(api_key)
130
-
131
- # Validate model after updating available models
132
- if model not in self.AVAILABLE_MODELS:
133
- raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
134
-
135
- # Initialize curl_cffi Session
136
- self.session = Session()
137
- self.is_conversation = is_conversation
138
- self.max_tokens_to_sample = max_tokens
139
- self.api_key = api_key
140
- self.model = model
141
- self.temperature = temperature
142
- self.presence_penalty = presence_penalty
143
- self.frequency_penalty = frequency_penalty
144
- self.top_p = top_p
145
- self.chat_endpoint = "https://api.groq.com/openai/v1/chat/completions"
146
- self.stream_chunk_size = 64
147
- self.timeout = timeout
148
- self.last_response = {}
149
- self.system_prompt = system_prompt
150
- self.available_functions: Dict[str, Callable] = {} # Store available functions
151
- self.headers = {
152
- "Content-Type": "application/json",
153
- "Authorization": f"Bearer {self.api_key}",
154
- }
155
-
156
- self.__available_optimizers = (
157
- method
158
- for method in dir(Optimizers)
159
- if callable(getattr(Optimizers, method)) and not method.startswith("__")
160
- )
161
-
162
- # Update curl_cffi session headers
163
- self.session.headers.update(self.headers)
164
-
165
- # Set up conversation
166
- Conversation.intro = (
167
- AwesomePrompts().get_act(
168
- act, raise_not_found=True, default=None, case_insensitive=True
169
- )
170
- if act
171
- else intro or Conversation.intro
172
- )
173
- self.conversation = Conversation(
174
- is_conversation, self.max_tokens_to_sample, filepath, update_file
175
- )
176
- self.conversation.history_offset = history_offset
177
-
178
- # Set proxies for curl_cffi session
179
- self.session.proxies = proxies
180
-
181
- @staticmethod
182
- def _groq_extractor(chunk: Union[str, Dict[str, Any]]) -> Optional[Dict]:
183
- """Extracts the 'delta' object from Groq stream JSON chunks."""
184
- if isinstance(chunk, dict):
185
- # Return the delta object itself, or None if not found
186
- return chunk.get("choices", [{}])[0].get("delta")
187
- return None
188
-
189
- @classmethod
190
- def update_available_models(cls, api_key=None):
191
- """Update the available models list from Groq API"""
192
- try:
193
- models = cls.get_models(api_key)
194
- if models and len(models) > 0:
195
- cls.AVAILABLE_MODELS = models
196
- except Exception:
197
- # Fallback to default models list if fetching fails
198
- pass
199
-
200
- def add_function(self, function_name: str, function: Callable):
201
- """Add a function to the available functions dictionary.
202
-
203
- Args:
204
- function_name (str): The name of the function to be used in the prompt.
205
- function (Callable): The function itself.
206
- """
207
- self.available_functions[function_name] = function
208
-
209
- def ask(
210
- self,
211
- prompt: str,
212
- stream: bool = False,
213
- raw: bool = False,
214
- optimizer: str = None,
215
- conversationally: bool = False,
216
- tools: Optional[List[Dict[str, Any]]] = None, # Add tools parameter
217
- ) -> dict:
218
- """Chat with AI
219
-
220
- Args:
221
- prompt (str): Prompt to be send.
222
- stream (bool, optional): Flag for streaming response. Defaults to False.
223
- raw (bool, optional): Stream back raw response as received. Defaults to False.
224
- optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
225
- conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
226
- tools (List[Dict[str, Any]], optional): List of tool definitions. See example in class docstring. Defaults to None.
227
-
228
- Returns:
229
- dict : {}
230
- """
231
- conversation_prompt = self.conversation.gen_complete_prompt(prompt)
232
- if optimizer:
233
- if optimizer in self.__available_optimizers:
234
- conversation_prompt = getattr(Optimizers, optimizer)(
235
- conversation_prompt if conversationally else prompt
236
- )
237
- else:
238
- raise Exception(
239
- f"Optimizer is not one of {self.__available_optimizers}"
240
- )
241
-
242
- messages = [{"content": conversation_prompt, "role": "user"}]
243
- if self.system_prompt:
244
- messages.insert(0, {"role": "system", "content": self.system_prompt})
245
-
246
- self.session.headers.update(self.headers)
247
- payload = {
248
- "frequency_penalty": self.frequency_penalty,
249
- "messages": messages,
250
- "model": self.model,
251
- "presence_penalty": self.presence_penalty,
252
- "stream": stream,
253
- "temperature": self.temperature,
254
- "top_p": self.top_p,
255
- "tools": tools # Include tools in the payload
256
- }
257
-
258
- def for_stream():
259
- try:
260
- response = self.session.post(
261
- self.chat_endpoint,
262
- json=payload,
263
- stream=True,
264
- timeout=self.timeout,
265
- impersonate="chrome110" # Use impersonate for better compatibility
266
- )
267
- if not response.status_code == 200:
268
- raise exceptions.FailedToGenerateResponseError(
269
- # Removed response.reason_phrase
270
- f"Failed to generate response - ({response.status_code}) - {response.text}"
271
- )
272
-
273
- streaming_text = ""
274
- # Use sanitize_stream
275
- processed_stream = sanitize_stream(
276
- data=response.iter_content(chunk_size=None), # Pass byte iterator
277
- intro_value="data:",
278
- to_json=True, # Stream sends JSON
279
- content_extractor=self._groq_extractor, # Use the delta extractor
280
- yield_raw_on_error=False # Skip non-JSON lines or lines where extractor fails
281
- )
282
-
283
- for delta in processed_stream:
284
- # delta is the extracted 'delta' object or None
285
- if delta and isinstance(delta, dict):
286
- content = delta.get("content")
287
- if content:
288
- streaming_text += content
289
- resp = {"text": content} # Yield only the new chunk text
290
- self.last_response = {"choices": [{"delta": {"content": streaming_text}}]} # Update last_response structure
291
- yield resp if not raw else content # Yield dict or raw string chunk
292
- # Note: Tool calls in streaming delta are less common in OpenAI format, usually in final message
293
-
294
- except CurlError as e:
295
- raise exceptions.FailedToGenerateResponseError(f"CurlError: {str(e)}")
296
- except Exception as e:
297
- raise exceptions.FailedToGenerateResponseError(f"Error: {str(e)}")
298
-
299
- # Handle tool calls if any
300
- if 'tool_calls' in self.last_response.get('choices', [{}])[0].get('message', {}):
301
- tool_calls = self.last_response['choices'][0]['message']['tool_calls']
302
- for tool_call in tool_calls:
303
- function_name = tool_call.get('function', {}).get('name')
304
- arguments = json.loads(tool_call.get('function', {}).get('arguments', "{}"))
305
- if function_name in self.available_functions:
306
- tool_response = self.available_functions[function_name](**arguments)
307
- messages.append({
308
- "tool_call_id": tool_call['id'],
309
- "role": "tool",
310
- "name": function_name,
311
- "content": tool_response
312
- })
313
- payload['messages'] = messages
314
- # Make a second call to get the final response
315
- try:
316
- second_response = self.session.post(
317
- self.chat_endpoint,
318
- json=payload,
319
- timeout=self.timeout,
320
- impersonate="chrome110" # Use impersonate for better compatibility
321
- )
322
- if second_response.status_code == 200:
323
- self.last_response = second_response.json()
324
- else:
325
- raise exceptions.FailedToGenerateResponseError(
326
- f"Failed to execute tool - {second_response.text}"
327
- )
328
- except CurlError as e:
329
- raise exceptions.FailedToGenerateResponseError(f"CurlError during tool execution: {str(e)}")
330
- except Exception as e:
331
- raise exceptions.FailedToGenerateResponseError(f"Error during tool execution: {str(e)}")
332
-
333
- self.conversation.update_chat_history(
334
- prompt, self.get_message(self.last_response)
335
- )
336
-
337
- def for_non_stream():
338
- try:
339
- response = self.session.post(
340
- self.chat_endpoint,
341
- json=payload,
342
- stream=False,
343
- timeout=self.timeout,
344
- impersonate="chrome110" # Use impersonate for better compatibility
345
- )
346
- if (
347
- not response.status_code == 200
348
- ):
349
- raise exceptions.FailedToGenerateResponseError(
350
- # Removed response.reason_phrase
351
- f"Failed to generate response - ({response.status_code}) - {response.text}"
352
- )
353
-
354
- response_text = response.text # Get raw text
355
-
356
- # Use sanitize_stream to parse the non-streaming JSON response
357
- processed_stream = sanitize_stream(
358
- data=response_text,
359
- to_json=True, # Parse the whole text as JSON
360
- intro_value=None,
361
- # Extractor for non-stream structure (returns the whole parsed dict)
362
- content_extractor=lambda chunk: chunk if isinstance(chunk, dict) else None,
363
- yield_raw_on_error=False
364
- )
365
-
366
- # Extract the single result (the parsed JSON dictionary)
367
- resp = next(processed_stream, None)
368
- if resp is None:
369
- raise exceptions.FailedToGenerateResponseError("Failed to parse non-stream JSON response")
370
-
371
- except CurlError as e:
372
- raise exceptions.FailedToGenerateResponseError(f"CurlError: {str(e)}")
373
- except Exception as e:
374
- # Catch the original AttributeError here if it happens before the raise
375
- if isinstance(e, AttributeError) and 'reason_phrase' in str(e):
376
- raise exceptions.FailedToGenerateResponseError(
377
- f"Failed to generate response - ({response.status_code}) - {response.text}"
378
- )
379
- raise exceptions.FailedToGenerateResponseError(f"Error: {str(e)}")
380
-
381
- # Handle tool calls if any
382
- if 'tool_calls' in resp.get('choices', [{}])[0].get('message', {}):
383
- tool_calls = resp['choices'][0]['message']['tool_calls']
384
- for tool_call in tool_calls:
385
- function_name = tool_call.get('function', {}).get('name')
386
- arguments = json.loads(tool_call.get('function', {}).get('arguments', "{}"))
387
- if function_name in self.available_functions:
388
- tool_response = self.available_functions[function_name](**arguments)
389
- messages.append({
390
- "tool_call_id": tool_call['id'],
391
- "role": "tool",
392
- "name": function_name,
393
- "content": tool_response
394
- })
395
- payload['messages'] = messages
396
- # Make a second call to get the final response
397
- try:
398
- second_response = self.session.post(
399
- self.chat_endpoint,
400
- json=payload,
401
- timeout=self.timeout,
402
- impersonate="chrome110" # Use impersonate for better compatibility
403
- )
404
- if second_response.status_code == 200:
405
- resp = second_response.json()
406
- else:
407
- raise exceptions.FailedToGenerateResponseError(
408
- f"Failed to execute tool - {second_response.text}"
409
- )
410
- except CurlError as e:
411
- raise exceptions.FailedToGenerateResponseError(f"CurlError during tool execution: {str(e)}")
412
- except Exception as e:
413
- raise exceptions.FailedToGenerateResponseError(f"Error during tool execution: {str(e)}")
414
-
415
- self.last_response.update(resp)
416
- self.conversation.update_chat_history(
417
- prompt, self.get_message(self.last_response)
418
- )
419
- return resp
420
-
421
- return for_stream() if stream else for_non_stream()
422
-
423
- def chat(
424
- self,
425
- prompt: str,
426
- stream: bool = False,
427
- optimizer: str = None,
428
- conversationally: bool = False,
429
- tools: Optional[List[Dict[str, Any]]] = None,
430
- ) -> str:
431
- """Generate response `str`
432
- Args:
433
- prompt (str): Prompt to be send.
434
- stream (bool, optional): Flag for streaming response. Defaults to False.
435
- optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
436
- conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
437
- tools (List[Dict[str, Any]], optional): List of tool definitions. See example in class docstring. Defaults to None.
438
- Returns:
439
- str: Response generated
440
- """
441
-
442
- def for_stream():
443
- for response in self.ask(
444
- prompt, True, optimizer=optimizer, conversationally=conversationally, tools=tools
445
- ):
446
- yield self.get_message(response)
447
-
448
- def for_non_stream():
449
- return self.get_message(
450
- self.ask(
451
- prompt,
452
- False,
453
- optimizer=optimizer,
454
- conversationally=conversationally,
455
- tools=tools
456
- )
457
- )
458
-
459
- return for_stream() if stream else for_non_stream()
460
-
461
- def get_message(self, response: dict) -> str:
462
- """Retrieves message only from response
463
-
464
- Args:
465
- response (dict): Response generated by `self.ask`
466
-
467
- Returns:
468
- str: Message extracted
469
- """
470
- assert isinstance(response, dict), "Response should be of dict data-type only"
471
- try:
472
- # Check delta first for streaming
473
- if response.get("choices") and response["choices"][0].get("delta") and response["choices"][0]["delta"].get("content"):
474
- return response["choices"][0]["delta"]["content"]
475
- # Check message content for non-streaming or final message
476
- if response.get("choices") and response["choices"][0].get("message") and response["choices"][0]["message"].get("content"):
477
- return response["choices"][0]["message"]["content"]
478
- except (KeyError, IndexError, TypeError):
479
- # Handle cases where the structure might be different or content is null/missing
480
- pass
481
- return "" # Return empty string if no content found
482
-
483
-
484
- class AsyncGROQ(AsyncProvider):
485
- """
486
- An asynchronous class to interact with the GROQ AI API.
487
- """
488
-
489
- # Use the same model list as the synchronous class
490
- AVAILABLE_MODELS = GROQ.AVAILABLE_MODELS
491
-
492
- def __init__(
493
- self,
494
- api_key: str,
495
- is_conversation: bool = True,
496
- max_tokens: int = 600,
497
- temperature: float = 1,
498
- presence_penalty: int = 0,
499
- frequency_penalty: int = 0,
500
- top_p: float = 1,
501
- model: str = "mixtral-8x7b-32768",
502
- timeout: int = 30,
503
- intro: str = None,
504
- filepath: str = None,
505
- update_file: bool = True,
506
- proxies: dict = {},
507
- history_offset: int = 10250,
508
- act: str = None,
509
- system_prompt: Optional[str] = None,
510
- ):
511
- """Instantiates AsyncGROQ
512
-
513
- Args:
514
- api_key (key): GROQ's API key.
515
- is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
516
- max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.
517
- temperature (float, optional): Charge of the generated text's randomness. Defaults to 1.
518
- presence_penalty (int, optional): Chances of topic being repeated. Defaults to 0.
519
- frequency_penalty (int, optional): Chances of word being repeated. Defaults to 0.
520
- top_p (float, optional): Sampling threshold during inference time. Defaults to 0.999.
521
- model (str, optional): LLM model name. Defaults to "gpt-3.5-turbo".
522
- timeout (int, optional): Http request timeout. Defaults to 30.
523
- intro (str, optional): Conversation introductory prompt. Defaults to None.
524
- filepath (str, optional): Path to file containing conversation history. Defaults to None.
525
- update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
526
- proxies (dict, optional): Http request proxies. Defaults to {}.
527
- history_offset (int, optional): Limit conversation history to this number of last texts. Defaults to 10250.
528
- act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
529
- system_prompt (str, optional): System prompt to guide the conversation. Defaults to None.
530
- """
531
- # Update available models from API
532
- GROQ.update_available_models(api_key)
533
-
534
- # Validate model after updating available models
535
- if model not in self.AVAILABLE_MODELS:
536
- raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
537
-
538
- self.is_conversation = is_conversation
539
- self.max_tokens_to_sample = max_tokens
540
- self.api_key = api_key
541
- self.model = model
542
- self.temperature = temperature
543
- self.presence_penalty = presence_penalty
544
- self.frequency_penalty = frequency_penalty
545
- self.top_p = top_p
546
- self.chat_endpoint = "https://api.groq.com/openai/v1/chat/completions"
547
- self.stream_chunk_size = 64
548
- self.timeout = timeout
549
- self.last_response = {}
550
- self.system_prompt = system_prompt
551
- self.available_functions: Dict[str, Callable] = {} # Store available functions
552
- self.headers = {
553
- "Content-Type": "application/json",
554
- "Authorization": f"Bearer {self.api_key}",
555
- }
556
-
557
- self.__available_optimizers = (
558
- method
559
- for method in dir(Optimizers)
560
- if callable(getattr(Optimizers, method)) and not method.startswith("__")
561
- )
562
- Conversation.intro = (
563
- AwesomePrompts().get_act(
564
- act, raise_not_found=True, default=None, case_insensitive=True
565
- )
566
- if act
567
- else intro or Conversation.intro
568
- )
569
- self.conversation = Conversation(
570
- is_conversation, self.max_tokens_to_sample, filepath, update_file
571
- )
572
- self.conversation.history_offset = history_offset
573
- self.session = httpx.AsyncClient(headers=self.headers, proxies=proxies)
574
-
575
- def add_function(self, function_name: str, function: Callable):
576
- """Add a function to the available functions dictionary.
577
-
578
- Args:
579
- function_name (str): The name of the function to be used in the prompt.
580
- function (Callable): The function itself.
581
- """
582
- self.available_functions[function_name] = function
583
-
584
- async def ask(
585
- self,
586
- prompt: str,
587
- stream: bool = False,
588
- raw: bool = False,
589
- optimizer: str = None,
590
- conversationally: bool = False,
591
- tools: Optional[List[Dict[str, Any]]] = None,
592
- ) -> Union[dict, AsyncGenerator]:
593
- """Chat with AI asynchronously.
594
-
595
- Args:
596
- prompt (str): Prompt to be send.
597
- stream (bool, optional): Flag for streaming response. Defaults to False.
598
- raw (bool, optional): Stream back raw response as received. Defaults to False.
599
- optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
600
- conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
601
- tools (List[Dict[str, Any]], optional): List of tool definitions. See example in class docstring. Defaults to None.
602
- Returns:
603
- dict|AsyncGenerator : ai content
604
- """
605
- conversation_prompt = self.conversation.gen_complete_prompt(prompt)
606
- if optimizer:
607
- if optimizer in self.__available_optimizers:
608
- conversation_prompt = getattr(Optimizers, optimizer)(
609
- conversation_prompt if conversationally else prompt
610
- )
611
- else:
612
- raise Exception(
613
- f"Optimizer is not one of {self.__available_optimizers}"
614
- )
615
-
616
- messages = [{"content": conversation_prompt, "role": "user"}]
617
- if self.system_prompt:
618
- messages.insert(0, {"role": "system", "content": self.system_prompt})
619
-
620
- payload = {
621
- "frequency_penalty": self.frequency_penalty,
622
- "messages": messages,
623
- "model": self.model,
624
- "presence_penalty": self.presence_penalty,
625
- "stream": stream,
626
- "temperature": self.temperature,
627
- "top_p": self.top_p,
628
- "tools": tools
629
- }
630
-
631
- async def for_stream():
632
- async with self.session.stream(
633
- "POST", self.chat_endpoint, json=payload, timeout=self.timeout
634
- ) as response:
635
- if not response.is_success:
636
- raise exceptions.FailedToGenerateResponseError(
637
- # Removed response.reason_phrase (not available in httpx response)
638
- f"Failed to generate response - ({response.status_code})"
639
- )
640
-
641
- message_load = ""
642
- intro_value = "data:"
643
- async for value in response.aiter_lines():
644
- try:
645
- if value.startswith(intro_value):
646
- value = value[len(intro_value) :]
647
- resp = json.loads(value)
648
- incomplete_message = await self.get_message(resp)
649
- if incomplete_message:
650
- message_load += incomplete_message
651
- resp["choices"][0]["delta"]["content"] = message_load
652
- self.last_response.update(resp)
653
- yield value if raw else resp
654
- elif raw:
655
- yield value
656
- except json.decoder.JSONDecodeError:
657
- pass
658
-
659
- # Handle tool calls if any (in streaming mode)
660
- if 'tool_calls' in self.last_response.get('choices', [{}])[0].get('message', {}):
661
- tool_calls = self.last_response['choices'][0]['message']['tool_calls']
662
- for tool_call in tool_calls:
663
- function_name = tool_call.get('function', {}).get('name')
664
- arguments = json.loads(tool_call.get('function', {}).get('arguments', "{}"))
665
- if function_name in self.available_functions:
666
- tool_response = self.available_functions[function_name](**arguments)
667
- messages.append({
668
- "tool_call_id": tool_call['id'],
669
- "role": "tool",
670
- "name": function_name,
671
- "content": tool_response
672
- })
673
- payload['messages'] = messages
674
- # Make a second call to get the final response
675
- second_response = await self.session.post(
676
- self.chat_endpoint, json=payload, timeout=self.timeout
677
- )
678
- if second_response.is_success:
679
- self.last_response = second_response.json()
680
- else:
681
- raise exceptions.FailedToGenerateResponseError(
682
- f"Failed to execute tool - {second_response.text}"
683
- )
684
-
685
- self.conversation.update_chat_history(
686
- prompt, await self.get_message(self.last_response)
687
- )
688
-
689
- async def for_non_stream():
690
- response = await self.session.post(
691
- self.chat_endpoint, json=payload, timeout=self.timeout
692
- )
693
- if not response.is_success:
694
- raise exceptions.FailedToGenerateResponseError(
695
- # Removed response.reason_phrase (not available in httpx response)
696
- f"Failed to generate response - ({response.status_code})"
697
- )
698
- resp = response.json()
699
-
700
- # Handle tool calls if any (in non-streaming mode)
701
- if 'tool_calls' in resp.get('choices', [{}])[0].get('message', {}):
702
- tool_calls = resp['choices'][0]['message']['tool_calls']
703
- for tool_call in tool_calls:
704
- function_name = tool_call.get('function', {}).get('name')
705
- arguments = json.loads(tool_call.get('function', {}).get('arguments', "{}"))
706
- if function_name in self.available_functions:
707
- tool_response = self.available_functions[function_name](**arguments)
708
- messages.append({
709
- "tool_call_id": tool_call['id'],
710
- "role": "tool",
711
- "name": function_name,
712
- "content": tool_response
713
- })
714
- payload['messages'] = messages
715
- # Make a second call to get the final response
716
- second_response = await self.session.post(
717
- self.chat_endpoint, json=payload, timeout=self.timeout
718
- )
719
- if second_response.is_success:
720
- resp = second_response.json()
721
- else:
722
- raise exceptions.FailedToGenerateResponseError(
723
- f"Failed to execute tool - {second_response.text}"
724
- )
725
-
726
- self.last_response.update(resp)
727
- self.conversation.update_chat_history(
728
- prompt, await self.get_message(self.last_response)
729
- )
730
- return resp
731
-
732
- return for_stream() if stream else await for_non_stream()
733
-
734
- async def chat(
735
- self,
736
- prompt: str,
737
- stream: bool = False,
738
- optimizer: str = None,
739
- conversationally: bool = False,
740
- tools: Optional[List[Dict[str, Any]]] = None,
741
- ) -> Union[str, AsyncGenerator]:
742
- """Generate response `str` asynchronously.
743
- Args:
744
- prompt (str): Prompt to be send.
745
- stream (bool, optional): Flag for streaming response. Defaults to False.
746
- optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
747
- conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
748
- tools (List[Dict[str, Any]], optional): List of tool definitions. See example in class docstring. Defaults to None.
749
- Returns:
750
- str|AsyncGenerator: Response generated
751
- """
752
-
753
- async def for_stream():
754
- async_ask = await self.ask(
755
- prompt, True, optimizer=optimizer, conversationally=conversationally, tools=tools
756
- )
757
- async for response in async_ask:
758
- yield await self.get_message(response)
759
-
760
- async def for_non_stream():
761
- return await self.get_message(
762
- await self.ask(
763
- prompt,
764
- False,
765
- optimizer=optimizer,
766
- conversationally=conversationally,
767
- tools=tools
768
- )
769
- )
770
-
771
- return for_stream() if stream else await for_non_stream()
772
-
773
- async def get_message(self, response: dict) -> str:
774
- """Retrieves message only from response
775
-
776
- Args:
777
- response (dict): Response generated by `self.ask`
778
-
779
- Returns:
780
- str: Message extracted
781
- """
782
- assert isinstance(response, dict), "Response should be of dict data-type only"
783
- try:
784
- # Check delta first for streaming
785
- if response.get("choices") and response["choices"][0].get("delta") and response["choices"][0]["delta"].get("content"):
786
- return response["choices"][0]["delta"]["content"]
787
- # Check message content for non-streaming or final message
788
- if response.get("choices") and response["choices"][0].get("message") and response["choices"][0]["message"].get("content"):
789
- return response["choices"][0]["message"]["content"]
790
- except (KeyError, IndexError, TypeError):
791
- # Handle cases where the structure might be different or content is null/missing
792
- pass
793
- return "" # Return empty string if no content found
794
-
795
- if __name__ == "__main__":
796
- # Example usage
797
- api_key = "gsk_*******************************"
798
- groq = GROQ(api_key=api_key, model="compound-beta")
799
- prompt = "What is the capital of France?"
800
- response = groq.chat(prompt)
1
+ from typing import Any, AsyncGenerator, Dict, Optional, Callable, List, Union
2
+
3
+ import httpx
4
+ import json
5
+
6
+ # Import curl_cffi for improved request handling
7
+ from curl_cffi.requests import Session
8
+ from curl_cffi import CurlError
9
+
10
+ from webscout.AIutel import Optimizers
11
+ from webscout.AIutel import Conversation
12
+ from webscout.AIutel import AwesomePrompts, sanitize_stream # Import sanitize_stream
13
+ from webscout.AIbase import Provider, AsyncProvider
14
+ from webscout import exceptions
15
+
16
+ class GROQ(Provider):
17
+ """
18
+ A class to interact with the GROQ AI API.
19
+ """
20
+ required_auth = True
21
+ # Default models list (will be updated dynamically)
22
+ AVAILABLE_MODELS = [
23
+ "distil-whisper-large-v3-en",
24
+ "gemma2-9b-it",
25
+ "llama-3.3-70b-versatile",
26
+ "llama-3.1-8b-instant",
27
+ "llama-guard-3-8b",
28
+ "llama3-70b-8192",
29
+ "llama3-8b-8192",
30
+ "whisper-large-v3",
31
+ "whisper-large-v3-turbo",
32
+ "meta-llama/llama-4-scout-17b-16e-instruct",
33
+ "meta-llama/llama-4-maverick-17b-128e-instruct",
34
+ "playai-tts",
35
+ "playai-tts-arabic",
36
+ "qwen-qwq-32b",
37
+ "mistral-saba-24b",
38
+ "qwen-2.5-coder-32b",
39
+ "qwen-2.5-32b",
40
+ "deepseek-r1-distill-qwen-32b",
41
+ "deepseek-r1-distill-llama-70b",
42
+ "llama-3.3-70b-specdec",
43
+ "llama-3.2-1b-preview",
44
+ "llama-3.2-3b-preview",
45
+ "llama-3.2-11b-vision-preview",
46
+ "llama-3.2-90b-vision-preview",
47
+ "mixtral-8x7b-32768"
48
+ ]
49
+
50
+ @classmethod
51
+ def get_models(cls, api_key: str = None):
52
+ """Fetch available models from Groq API.
53
+
54
+ Args:
55
+ api_key (str, optional): Groq API key. If not provided, returns default models.
56
+
57
+ Returns:
58
+ list: List of available model IDs
59
+ """
60
+ if not api_key:
61
+ return cls.AVAILABLE_MODELS
62
+
63
+ try:
64
+ # Use a temporary curl_cffi session for this class method
65
+ temp_session = Session()
66
+ headers = {
67
+ "Content-Type": "application/json",
68
+ "Authorization": f"Bearer {api_key}",
69
+ }
70
+
71
+ response = temp_session.get(
72
+ "https://api.groq.com/openai/v1/models",
73
+ headers=headers,
74
+ impersonate="chrome110" # Use impersonate for fetching
75
+ )
76
+
77
+ if response.status_code != 200:
78
+ return cls.AVAILABLE_MODELS
79
+
80
+ data = response.json()
81
+ if "data" in data and isinstance(data["data"], list):
82
+ return [model["id"] for model in data["data"]]
83
+ return cls.AVAILABLE_MODELS
84
+
85
+ except (CurlError, Exception):
86
+ # Fallback to default models list if fetching fails
87
+ return cls.AVAILABLE_MODELS
88
+
89
+ def __init__(
90
+ self,
91
+ api_key: str,
92
+ is_conversation: bool = True,
93
+ max_tokens: int = 600,
94
+ temperature: float = 1,
95
+ presence_penalty: int = 0,
96
+ frequency_penalty: int = 0,
97
+ top_p: float = 1,
98
+ model: str = "mixtral-8x7b-32768",
99
+ timeout: int = 30,
100
+ intro: str = None,
101
+ filepath: str = None,
102
+ update_file: bool = True,
103
+ proxies: dict = {},
104
+ history_offset: int = 10250,
105
+ act: str = None,
106
+ system_prompt: Optional[str] = None,
107
+ ):
108
+ """Instantiates GROQ
109
+
110
+ Args:
111
+ api_key (key): GROQ's API key.
112
+ is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
113
+ max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.
114
+ temperature (float, optional): Charge of the generated text's randomness. Defaults to 1.
115
+ presence_penalty (int, optional): Chances of topic being repeated. Defaults to 0.
116
+ frequency_penalty (int, optional): Chances of word being repeated. Defaults to 0.
117
+ top_p (float, optional): Sampling threshold during inference time. Defaults to 0.999.
118
+ model (str, optional): LLM model name. Defaults to "mixtral-8x7b-32768".
119
+ timeout (int, optional): Http request timeout. Defaults to 30.
120
+ intro (str, optional): Conversation introductory prompt. Defaults to None.
121
+ filepath (str, optional): Path to file containing conversation history. Defaults to None.
122
+ update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
123
+ proxies (dict, optional): Http request proxies. Defaults to {}.
124
+ history_offset (int, optional): Limit conversation history to this number of last texts. Defaults to 10250.
125
+ act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
126
+ system_prompt (str, optional): System prompt to guide the conversation. Defaults to None.
127
+ """
128
+ # Update available models from API
129
+ self.update_available_models(api_key)
130
+
131
+ # Validate model after updating available models
132
+ if model not in self.AVAILABLE_MODELS:
133
+ raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
134
+
135
+ # Initialize curl_cffi Session
136
+ self.session = Session()
137
+ self.is_conversation = is_conversation
138
+ self.max_tokens_to_sample = max_tokens
139
+ self.api_key = api_key
140
+ self.model = model
141
+ self.temperature = temperature
142
+ self.presence_penalty = presence_penalty
143
+ self.frequency_penalty = frequency_penalty
144
+ self.top_p = top_p
145
+ self.chat_endpoint = "https://api.groq.com/openai/v1/chat/completions"
146
+ self.stream_chunk_size = 64
147
+ self.timeout = timeout
148
+ self.last_response = {}
149
+ self.system_prompt = system_prompt
150
+ self.available_functions: Dict[str, Callable] = {} # Store available functions
151
+ self.headers = {
152
+ "Content-Type": "application/json",
153
+ "Authorization": f"Bearer {self.api_key}",
154
+ }
155
+
156
+ self.__available_optimizers = (
157
+ method
158
+ for method in dir(Optimizers)
159
+ if callable(getattr(Optimizers, method)) and not method.startswith("__")
160
+ )
161
+
162
+ # Update curl_cffi session headers
163
+ self.session.headers.update(self.headers)
164
+
165
+ # Set up conversation
166
+ Conversation.intro = (
167
+ AwesomePrompts().get_act(
168
+ act, raise_not_found=True, default=None, case_insensitive=True
169
+ )
170
+ if act
171
+ else intro or Conversation.intro
172
+ )
173
+ self.conversation = Conversation(
174
+ is_conversation, self.max_tokens_to_sample, filepath, update_file
175
+ )
176
+ self.conversation.history_offset = history_offset
177
+
178
+ # Set proxies for curl_cffi session
179
+ self.session.proxies = proxies
180
+
181
+ @staticmethod
182
+ def _groq_extractor(chunk: Union[str, Dict[str, Any]]) -> Optional[Dict]:
183
+ """Extracts the 'delta' object from Groq stream JSON chunks."""
184
+ if isinstance(chunk, dict):
185
+ # Return the delta object itself, or None if not found
186
+ return chunk.get("choices", [{}])[0].get("delta")
187
+ return None
188
+
189
+ @classmethod
190
+ def update_available_models(cls, api_key=None):
191
+ """Update the available models list from Groq API"""
192
+ try:
193
+ models = cls.get_models(api_key)
194
+ if models and len(models) > 0:
195
+ cls.AVAILABLE_MODELS = models
196
+ except Exception:
197
+ # Fallback to default models list if fetching fails
198
+ pass
199
+
200
+ def add_function(self, function_name: str, function: Callable):
201
+ """Add a function to the available functions dictionary.
202
+
203
+ Args:
204
+ function_name (str): The name of the function to be used in the prompt.
205
+ function (Callable): The function itself.
206
+ """
207
+ self.available_functions[function_name] = function
208
+
209
+ def ask(
210
+ self,
211
+ prompt: str,
212
+ stream: bool = False,
213
+ raw: bool = False,
214
+ optimizer: str = None,
215
+ conversationally: bool = False,
216
+ tools: Optional[List[Dict[str, Any]]] = None, # Add tools parameter
217
+ ) -> dict:
218
+ """Chat with AI
219
+
220
+ Args:
221
+ prompt (str): Prompt to be send.
222
+ stream (bool, optional): Flag for streaming response. Defaults to False.
223
+ raw (bool, optional): Stream back raw response as received. Defaults to False.
224
+ optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
225
+ conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
226
+ tools (List[Dict[str, Any]], optional): List of tool definitions. See example in class docstring. Defaults to None.
227
+
228
+ Returns:
229
+ dict : {}
230
+ """
231
+ conversation_prompt = self.conversation.gen_complete_prompt(prompt)
232
+ if optimizer:
233
+ if optimizer in self.__available_optimizers:
234
+ conversation_prompt = getattr(Optimizers, optimizer)(
235
+ conversation_prompt if conversationally else prompt
236
+ )
237
+ else:
238
+ raise Exception(
239
+ f"Optimizer is not one of {self.__available_optimizers}"
240
+ )
241
+
242
+ messages = [{"content": conversation_prompt, "role": "user"}]
243
+ if self.system_prompt:
244
+ messages.insert(0, {"role": "system", "content": self.system_prompt})
245
+
246
+ self.session.headers.update(self.headers)
247
+ payload = {
248
+ "frequency_penalty": self.frequency_penalty,
249
+ "messages": messages,
250
+ "model": self.model,
251
+ "presence_penalty": self.presence_penalty,
252
+ "stream": stream,
253
+ "temperature": self.temperature,
254
+ "top_p": self.top_p,
255
+ "tools": tools # Include tools in the payload
256
+ }
257
+
258
+ def for_stream():
259
+ try:
260
+ response = self.session.post(
261
+ self.chat_endpoint,
262
+ json=payload,
263
+ stream=True,
264
+ timeout=self.timeout,
265
+ impersonate="chrome110" # Use impersonate for better compatibility
266
+ )
267
+ if not response.status_code == 200:
268
+ raise exceptions.FailedToGenerateResponseError(
269
+ # Removed response.reason_phrase
270
+ f"Failed to generate response - ({response.status_code}) - {response.text}"
271
+ )
272
+
273
+ streaming_text = ""
274
+ # Use sanitize_stream
275
+ processed_stream = sanitize_stream(
276
+ data=response.iter_content(chunk_size=None), # Pass byte iterator
277
+ intro_value="data:",
278
+ to_json=True, # Stream sends JSON
279
+ content_extractor=self._groq_extractor, # Use the delta extractor
280
+ yield_raw_on_error=False # Skip non-JSON lines or lines where extractor fails
281
+ )
282
+
283
+ for delta in processed_stream:
284
+ # delta is the extracted 'delta' object or None
285
+ if delta and isinstance(delta, dict):
286
+ content = delta.get("content")
287
+ if content:
288
+ streaming_text += content
289
+ resp = {"text": content} # Yield only the new chunk text
290
+ self.last_response = {"choices": [{"delta": {"content": streaming_text}}]} # Update last_response structure
291
+ yield resp if not raw else content # Yield dict or raw string chunk
292
+ # Note: Tool calls in streaming delta are less common in OpenAI format, usually in final message
293
+
294
+ except CurlError as e:
295
+ raise exceptions.FailedToGenerateResponseError(f"CurlError: {str(e)}")
296
+ except Exception as e:
297
+ raise exceptions.FailedToGenerateResponseError(f"Error: {str(e)}")
298
+
299
+ # Handle tool calls if any
300
+ if 'tool_calls' in self.last_response.get('choices', [{}])[0].get('message', {}):
301
+ tool_calls = self.last_response['choices'][0]['message']['tool_calls']
302
+ for tool_call in tool_calls:
303
+ function_name = tool_call.get('function', {}).get('name')
304
+ arguments = json.loads(tool_call.get('function', {}).get('arguments', "{}"))
305
+ if function_name in self.available_functions:
306
+ tool_response = self.available_functions[function_name](**arguments)
307
+ messages.append({
308
+ "tool_call_id": tool_call['id'],
309
+ "role": "tool",
310
+ "name": function_name,
311
+ "content": tool_response
312
+ })
313
+ payload['messages'] = messages
314
+ # Make a second call to get the final response
315
+ try:
316
+ second_response = self.session.post(
317
+ self.chat_endpoint,
318
+ json=payload,
319
+ timeout=self.timeout,
320
+ impersonate="chrome110" # Use impersonate for better compatibility
321
+ )
322
+ if second_response.status_code == 200:
323
+ self.last_response = second_response.json()
324
+ else:
325
+ raise exceptions.FailedToGenerateResponseError(
326
+ f"Failed to execute tool - {second_response.text}"
327
+ )
328
+ except CurlError as e:
329
+ raise exceptions.FailedToGenerateResponseError(f"CurlError during tool execution: {str(e)}")
330
+ except Exception as e:
331
+ raise exceptions.FailedToGenerateResponseError(f"Error during tool execution: {str(e)}")
332
+
333
+ self.conversation.update_chat_history(
334
+ prompt, self.get_message(self.last_response)
335
+ )
336
+
337
+ def for_non_stream():
338
+ try:
339
+ response = self.session.post(
340
+ self.chat_endpoint,
341
+ json=payload,
342
+ stream=False,
343
+ timeout=self.timeout,
344
+ impersonate="chrome110" # Use impersonate for better compatibility
345
+ )
346
+ if (
347
+ not response.status_code == 200
348
+ ):
349
+ raise exceptions.FailedToGenerateResponseError(
350
+ # Removed response.reason_phrase
351
+ f"Failed to generate response - ({response.status_code}) - {response.text}"
352
+ )
353
+
354
+ response_text = response.text # Get raw text
355
+
356
+ # Use sanitize_stream to parse the non-streaming JSON response
357
+ processed_stream = sanitize_stream(
358
+ data=response_text,
359
+ to_json=True, # Parse the whole text as JSON
360
+ intro_value=None,
361
+ # Extractor for non-stream structure (returns the whole parsed dict)
362
+ content_extractor=lambda chunk: chunk if isinstance(chunk, dict) else None,
363
+ yield_raw_on_error=False
364
+ )
365
+
366
+ # Extract the single result (the parsed JSON dictionary)
367
+ resp = next(processed_stream, None)
368
+ if resp is None:
369
+ raise exceptions.FailedToGenerateResponseError("Failed to parse non-stream JSON response")
370
+
371
+ except CurlError as e:
372
+ raise exceptions.FailedToGenerateResponseError(f"CurlError: {str(e)}")
373
+ except Exception as e:
374
+ # Catch the original AttributeError here if it happens before the raise
375
+ if isinstance(e, AttributeError) and 'reason_phrase' in str(e):
376
+ raise exceptions.FailedToGenerateResponseError(
377
+ f"Failed to generate response - ({response.status_code}) - {response.text}"
378
+ )
379
+ raise exceptions.FailedToGenerateResponseError(f"Error: {str(e)}")
380
+
381
+ # Handle tool calls if any
382
+ if 'tool_calls' in resp.get('choices', [{}])[0].get('message', {}):
383
+ tool_calls = resp['choices'][0]['message']['tool_calls']
384
+ for tool_call in tool_calls:
385
+ function_name = tool_call.get('function', {}).get('name')
386
+ arguments = json.loads(tool_call.get('function', {}).get('arguments', "{}"))
387
+ if function_name in self.available_functions:
388
+ tool_response = self.available_functions[function_name](**arguments)
389
+ messages.append({
390
+ "tool_call_id": tool_call['id'],
391
+ "role": "tool",
392
+ "name": function_name,
393
+ "content": tool_response
394
+ })
395
+ payload['messages'] = messages
396
+ # Make a second call to get the final response
397
+ try:
398
+ second_response = self.session.post(
399
+ self.chat_endpoint,
400
+ json=payload,
401
+ timeout=self.timeout,
402
+ impersonate="chrome110" # Use impersonate for better compatibility
403
+ )
404
+ if second_response.status_code == 200:
405
+ resp = second_response.json()
406
+ else:
407
+ raise exceptions.FailedToGenerateResponseError(
408
+ f"Failed to execute tool - {second_response.text}"
409
+ )
410
+ except CurlError as e:
411
+ raise exceptions.FailedToGenerateResponseError(f"CurlError during tool execution: {str(e)}")
412
+ except Exception as e:
413
+ raise exceptions.FailedToGenerateResponseError(f"Error during tool execution: {str(e)}")
414
+
415
+ self.last_response.update(resp)
416
+ self.conversation.update_chat_history(
417
+ prompt, self.get_message(self.last_response)
418
+ )
419
+ return resp
420
+
421
+ return for_stream() if stream else for_non_stream()
422
+
423
+ def chat(
424
+ self,
425
+ prompt: str,
426
+ stream: bool = False,
427
+ optimizer: str = None,
428
+ conversationally: bool = False,
429
+ tools: Optional[List[Dict[str, Any]]] = None,
430
+ ) -> str:
431
+ """Generate response `str`
432
+ Args:
433
+ prompt (str): Prompt to be send.
434
+ stream (bool, optional): Flag for streaming response. Defaults to False.
435
+ optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
436
+ conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
437
+ tools (List[Dict[str, Any]], optional): List of tool definitions. See example in class docstring. Defaults to None.
438
+ Returns:
439
+ str: Response generated
440
+ """
441
+
442
+ def for_stream():
443
+ for response in self.ask(
444
+ prompt, True, optimizer=optimizer, conversationally=conversationally, tools=tools
445
+ ):
446
+ yield self.get_message(response)
447
+
448
+ def for_non_stream():
449
+ return self.get_message(
450
+ self.ask(
451
+ prompt,
452
+ False,
453
+ optimizer=optimizer,
454
+ conversationally=conversationally,
455
+ tools=tools
456
+ )
457
+ )
458
+
459
+ return for_stream() if stream else for_non_stream()
460
+
461
+ def get_message(self, response: dict) -> str:
462
+ """Retrieves message only from response
463
+
464
+ Args:
465
+ response (dict): Response generated by `self.ask`
466
+
467
+ Returns:
468
+ str: Message extracted
469
+ """
470
+ assert isinstance(response, dict), "Response should be of dict data-type only"
471
+ try:
472
+ # Check delta first for streaming
473
+ if response.get("choices") and response["choices"][0].get("delta") and response["choices"][0]["delta"].get("content"):
474
+ return response["choices"][0]["delta"]["content"]
475
+ # Check message content for non-streaming or final message
476
+ if response.get("choices") and response["choices"][0].get("message") and response["choices"][0]["message"].get("content"):
477
+ return response["choices"][0]["message"]["content"]
478
+ except (KeyError, IndexError, TypeError):
479
+ # Handle cases where the structure might be different or content is null/missing
480
+ pass
481
+ return "" # Return empty string if no content found
482
+
483
+
484
+ class AsyncGROQ(AsyncProvider):
485
+ """
486
+ An asynchronous class to interact with the GROQ AI API.
487
+ """
488
+
489
+ # Use the same model list as the synchronous class
490
+ AVAILABLE_MODELS = GROQ.AVAILABLE_MODELS
491
+
492
+ def __init__(
493
+ self,
494
+ api_key: str,
495
+ is_conversation: bool = True,
496
+ max_tokens: int = 600,
497
+ temperature: float = 1,
498
+ presence_penalty: int = 0,
499
+ frequency_penalty: int = 0,
500
+ top_p: float = 1,
501
+ model: str = "mixtral-8x7b-32768",
502
+ timeout: int = 30,
503
+ intro: str = None,
504
+ filepath: str = None,
505
+ update_file: bool = True,
506
+ proxies: dict = {},
507
+ history_offset: int = 10250,
508
+ act: str = None,
509
+ system_prompt: Optional[str] = None,
510
+ ):
511
+ """Instantiates AsyncGROQ
512
+
513
+ Args:
514
+ api_key (key): GROQ's API key.
515
+ is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
516
+ max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.
517
+ temperature (float, optional): Charge of the generated text's randomness. Defaults to 1.
518
+ presence_penalty (int, optional): Chances of topic being repeated. Defaults to 0.
519
+ frequency_penalty (int, optional): Chances of word being repeated. Defaults to 0.
520
+ top_p (float, optional): Sampling threshold during inference time. Defaults to 0.999.
521
+ model (str, optional): LLM model name. Defaults to "gpt-3.5-turbo".
522
+ timeout (int, optional): Http request timeout. Defaults to 30.
523
+ intro (str, optional): Conversation introductory prompt. Defaults to None.
524
+ filepath (str, optional): Path to file containing conversation history. Defaults to None.
525
+ update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
526
+ proxies (dict, optional): Http request proxies. Defaults to {}.
527
+ history_offset (int, optional): Limit conversation history to this number of last texts. Defaults to 10250.
528
+ act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
529
+ system_prompt (str, optional): System prompt to guide the conversation. Defaults to None.
530
+ """
531
+ # Update available models from API
532
+ GROQ.update_available_models(api_key)
533
+
534
+ # Validate model after updating available models
535
+ if model not in self.AVAILABLE_MODELS:
536
+ raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
537
+
538
+ self.is_conversation = is_conversation
539
+ self.max_tokens_to_sample = max_tokens
540
+ self.api_key = api_key
541
+ self.model = model
542
+ self.temperature = temperature
543
+ self.presence_penalty = presence_penalty
544
+ self.frequency_penalty = frequency_penalty
545
+ self.top_p = top_p
546
+ self.chat_endpoint = "https://api.groq.com/openai/v1/chat/completions"
547
+ self.stream_chunk_size = 64
548
+ self.timeout = timeout
549
+ self.last_response = {}
550
+ self.system_prompt = system_prompt
551
+ self.available_functions: Dict[str, Callable] = {} # Store available functions
552
+ self.headers = {
553
+ "Content-Type": "application/json",
554
+ "Authorization": f"Bearer {self.api_key}",
555
+ }
556
+
557
+ self.__available_optimizers = (
558
+ method
559
+ for method in dir(Optimizers)
560
+ if callable(getattr(Optimizers, method)) and not method.startswith("__")
561
+ )
562
+ Conversation.intro = (
563
+ AwesomePrompts().get_act(
564
+ act, raise_not_found=True, default=None, case_insensitive=True
565
+ )
566
+ if act
567
+ else intro or Conversation.intro
568
+ )
569
+ self.conversation = Conversation(
570
+ is_conversation, self.max_tokens_to_sample, filepath, update_file
571
+ )
572
+ self.conversation.history_offset = history_offset
573
+ self.session = httpx.AsyncClient(headers=self.headers, proxies=proxies)
574
+
575
+ def add_function(self, function_name: str, function: Callable):
576
+ """Add a function to the available functions dictionary.
577
+
578
+ Args:
579
+ function_name (str): The name of the function to be used in the prompt.
580
+ function (Callable): The function itself.
581
+ """
582
+ self.available_functions[function_name] = function
583
+
584
+ async def ask(
585
+ self,
586
+ prompt: str,
587
+ stream: bool = False,
588
+ raw: bool = False,
589
+ optimizer: str = None,
590
+ conversationally: bool = False,
591
+ tools: Optional[List[Dict[str, Any]]] = None,
592
+ ) -> Union[dict, AsyncGenerator]:
593
+ """Chat with AI asynchronously.
594
+
595
+ Args:
596
+ prompt (str): Prompt to be send.
597
+ stream (bool, optional): Flag for streaming response. Defaults to False.
598
+ raw (bool, optional): Stream back raw response as received. Defaults to False.
599
+ optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
600
+ conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
601
+ tools (List[Dict[str, Any]], optional): List of tool definitions. See example in class docstring. Defaults to None.
602
+ Returns:
603
+ dict|AsyncGenerator : ai content
604
+ """
605
+ conversation_prompt = self.conversation.gen_complete_prompt(prompt)
606
+ if optimizer:
607
+ if optimizer in self.__available_optimizers:
608
+ conversation_prompt = getattr(Optimizers, optimizer)(
609
+ conversation_prompt if conversationally else prompt
610
+ )
611
+ else:
612
+ raise Exception(
613
+ f"Optimizer is not one of {self.__available_optimizers}"
614
+ )
615
+
616
+ messages = [{"content": conversation_prompt, "role": "user"}]
617
+ if self.system_prompt:
618
+ messages.insert(0, {"role": "system", "content": self.system_prompt})
619
+
620
+ payload = {
621
+ "frequency_penalty": self.frequency_penalty,
622
+ "messages": messages,
623
+ "model": self.model,
624
+ "presence_penalty": self.presence_penalty,
625
+ "stream": stream,
626
+ "temperature": self.temperature,
627
+ "top_p": self.top_p,
628
+ "tools": tools
629
+ }
630
+
631
+ async def for_stream():
632
+ async with self.session.stream(
633
+ "POST", self.chat_endpoint, json=payload, timeout=self.timeout
634
+ ) as response:
635
+ if not response.is_success:
636
+ raise exceptions.FailedToGenerateResponseError(
637
+ # Removed response.reason_phrase (not available in httpx response)
638
+ f"Failed to generate response - ({response.status_code})"
639
+ )
640
+
641
+ message_load = ""
642
+ intro_value = "data:"
643
+ async for value in response.aiter_lines():
644
+ try:
645
+ if value.startswith(intro_value):
646
+ value = value[len(intro_value) :]
647
+ resp = json.loads(value)
648
+ incomplete_message = await self.get_message(resp)
649
+ if incomplete_message:
650
+ message_load += incomplete_message
651
+ resp["choices"][0]["delta"]["content"] = message_load
652
+ self.last_response.update(resp)
653
+ yield value if raw else resp
654
+ elif raw:
655
+ yield value
656
+ except json.decoder.JSONDecodeError:
657
+ pass
658
+
659
+ # Handle tool calls if any (in streaming mode)
660
+ if 'tool_calls' in self.last_response.get('choices', [{}])[0].get('message', {}):
661
+ tool_calls = self.last_response['choices'][0]['message']['tool_calls']
662
+ for tool_call in tool_calls:
663
+ function_name = tool_call.get('function', {}).get('name')
664
+ arguments = json.loads(tool_call.get('function', {}).get('arguments', "{}"))
665
+ if function_name in self.available_functions:
666
+ tool_response = self.available_functions[function_name](**arguments)
667
+ messages.append({
668
+ "tool_call_id": tool_call['id'],
669
+ "role": "tool",
670
+ "name": function_name,
671
+ "content": tool_response
672
+ })
673
+ payload['messages'] = messages
674
+ # Make a second call to get the final response
675
+ second_response = await self.session.post(
676
+ self.chat_endpoint, json=payload, timeout=self.timeout
677
+ )
678
+ if second_response.is_success:
679
+ self.last_response = second_response.json()
680
+ else:
681
+ raise exceptions.FailedToGenerateResponseError(
682
+ f"Failed to execute tool - {second_response.text}"
683
+ )
684
+
685
+ self.conversation.update_chat_history(
686
+ prompt, await self.get_message(self.last_response)
687
+ )
688
+
689
+ async def for_non_stream():
690
+ response = await self.session.post(
691
+ self.chat_endpoint, json=payload, timeout=self.timeout
692
+ )
693
+ if not response.is_success:
694
+ raise exceptions.FailedToGenerateResponseError(
695
+ # Removed response.reason_phrase (not available in httpx response)
696
+ f"Failed to generate response - ({response.status_code})"
697
+ )
698
+ resp = response.json()
699
+
700
+ # Handle tool calls if any (in non-streaming mode)
701
+ if 'tool_calls' in resp.get('choices', [{}])[0].get('message', {}):
702
+ tool_calls = resp['choices'][0]['message']['tool_calls']
703
+ for tool_call in tool_calls:
704
+ function_name = tool_call.get('function', {}).get('name')
705
+ arguments = json.loads(tool_call.get('function', {}).get('arguments', "{}"))
706
+ if function_name in self.available_functions:
707
+ tool_response = self.available_functions[function_name](**arguments)
708
+ messages.append({
709
+ "tool_call_id": tool_call['id'],
710
+ "role": "tool",
711
+ "name": function_name,
712
+ "content": tool_response
713
+ })
714
+ payload['messages'] = messages
715
+ # Make a second call to get the final response
716
+ second_response = await self.session.post(
717
+ self.chat_endpoint, json=payload, timeout=self.timeout
718
+ )
719
+ if second_response.is_success:
720
+ resp = second_response.json()
721
+ else:
722
+ raise exceptions.FailedToGenerateResponseError(
723
+ f"Failed to execute tool - {second_response.text}"
724
+ )
725
+
726
+ self.last_response.update(resp)
727
+ self.conversation.update_chat_history(
728
+ prompt, await self.get_message(self.last_response)
729
+ )
730
+ return resp
731
+
732
+ return for_stream() if stream else await for_non_stream()
733
+
734
+ async def chat(
735
+ self,
736
+ prompt: str,
737
+ stream: bool = False,
738
+ optimizer: str = None,
739
+ conversationally: bool = False,
740
+ tools: Optional[List[Dict[str, Any]]] = None,
741
+ ) -> Union[str, AsyncGenerator]:
742
+ """Generate response `str` asynchronously.
743
+ Args:
744
+ prompt (str): Prompt to be send.
745
+ stream (bool, optional): Flag for streaming response. Defaults to False.
746
+ optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
747
+ conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
748
+ tools (List[Dict[str, Any]], optional): List of tool definitions. See example in class docstring. Defaults to None.
749
+ Returns:
750
+ str|AsyncGenerator: Response generated
751
+ """
752
+
753
+ async def for_stream():
754
+ async_ask = await self.ask(
755
+ prompt, True, optimizer=optimizer, conversationally=conversationally, tools=tools
756
+ )
757
+ async for response in async_ask:
758
+ yield await self.get_message(response)
759
+
760
+ async def for_non_stream():
761
+ return await self.get_message(
762
+ await self.ask(
763
+ prompt,
764
+ False,
765
+ optimizer=optimizer,
766
+ conversationally=conversationally,
767
+ tools=tools
768
+ )
769
+ )
770
+
771
+ return for_stream() if stream else await for_non_stream()
772
+
773
+ async def get_message(self, response: dict) -> str:
774
+ """Retrieves message only from response
775
+
776
+ Args:
777
+ response (dict): Response generated by `self.ask`
778
+
779
+ Returns:
780
+ str: Message extracted
781
+ """
782
+ assert isinstance(response, dict), "Response should be of dict data-type only"
783
+ try:
784
+ # Check delta first for streaming
785
+ if response.get("choices") and response["choices"][0].get("delta") and response["choices"][0]["delta"].get("content"):
786
+ return response["choices"][0]["delta"]["content"]
787
+ # Check message content for non-streaming or final message
788
+ if response.get("choices") and response["choices"][0].get("message") and response["choices"][0]["message"].get("content"):
789
+ return response["choices"][0]["message"]["content"]
790
+ except (KeyError, IndexError, TypeError):
791
+ # Handle cases where the structure might be different or content is null/missing
792
+ pass
793
+ return "" # Return empty string if no content found
794
+
795
+ if __name__ == "__main__":
796
+ # Example usage
797
+ api_key = "gsk_*******************************"
798
+ groq = GROQ(api_key=api_key, model="compound-beta")
799
+ prompt = "What is the capital of France?"
800
+ response = groq.chat(prompt)
801
801
  print(response)