webscout 8.3.6__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 (304) hide show
  1. webscout/AIauto.py +250 -250
  2. webscout/AIbase.py +379 -379
  3. webscout/AIutel.py +60 -58
  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 +33 -11
  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 -314
  61. webscout/Provider/AISEARCH/stellar_search.py +177 -177
  62. webscout/Provider/AISEARCH/webpilotai_search.py +255 -255
  63. webscout/Provider/Aitopia.py +314 -315
  64. webscout/Provider/Andi.py +3 -3
  65. webscout/Provider/Apriel.py +306 -0
  66. webscout/Provider/ChatGPTClone.py +236 -236
  67. webscout/Provider/ChatSandbox.py +343 -342
  68. webscout/Provider/Cloudflare.py +324 -324
  69. webscout/Provider/Cohere.py +208 -207
  70. webscout/Provider/Deepinfra.py +370 -369
  71. webscout/Provider/ExaAI.py +260 -260
  72. webscout/Provider/ExaChat.py +308 -387
  73. webscout/Provider/Flowith.py +221 -221
  74. webscout/Provider/GMI.py +293 -0
  75. webscout/Provider/Gemini.py +164 -162
  76. webscout/Provider/GeminiProxy.py +167 -166
  77. webscout/Provider/GithubChat.py +371 -370
  78. webscout/Provider/Groq.py +800 -800
  79. webscout/Provider/HeckAI.py +383 -379
  80. webscout/Provider/Jadve.py +282 -297
  81. webscout/Provider/K2Think.py +308 -0
  82. webscout/Provider/Koboldai.py +206 -384
  83. webscout/Provider/LambdaChat.py +423 -425
  84. webscout/Provider/Nemotron.py +244 -245
  85. webscout/Provider/Netwrck.py +248 -247
  86. webscout/Provider/OLLAMA.py +395 -394
  87. webscout/Provider/OPENAI/Cloudflare.py +394 -395
  88. webscout/Provider/OPENAI/FalconH1.py +452 -457
  89. webscout/Provider/OPENAI/FreeGemini.py +297 -299
  90. webscout/Provider/OPENAI/{monochat.py → K2Think.py} +432 -329
  91. webscout/Provider/OPENAI/NEMOTRON.py +241 -244
  92. webscout/Provider/OPENAI/PI.py +428 -427
  93. webscout/Provider/OPENAI/README.md +959 -959
  94. webscout/Provider/OPENAI/TogetherAI.py +345 -345
  95. webscout/Provider/OPENAI/TwoAI.py +466 -467
  96. webscout/Provider/OPENAI/__init__.py +33 -59
  97. webscout/Provider/OPENAI/ai4chat.py +313 -303
  98. webscout/Provider/OPENAI/base.py +249 -269
  99. webscout/Provider/OPENAI/chatglm.py +528 -0
  100. webscout/Provider/OPENAI/chatgpt.py +593 -588
  101. webscout/Provider/OPENAI/chatgptclone.py +521 -524
  102. webscout/Provider/OPENAI/chatsandbox.py +202 -177
  103. webscout/Provider/OPENAI/deepinfra.py +319 -315
  104. webscout/Provider/OPENAI/e2b.py +1665 -1665
  105. webscout/Provider/OPENAI/exaai.py +420 -420
  106. webscout/Provider/OPENAI/exachat.py +452 -452
  107. webscout/Provider/OPENAI/friendli.py +232 -232
  108. webscout/Provider/OPENAI/{refact.py → gmi.py} +324 -274
  109. webscout/Provider/OPENAI/groq.py +364 -364
  110. webscout/Provider/OPENAI/heckai.py +314 -311
  111. webscout/Provider/OPENAI/llmchatco.py +337 -337
  112. webscout/Provider/OPENAI/netwrck.py +355 -354
  113. webscout/Provider/OPENAI/oivscode.py +290 -290
  114. webscout/Provider/OPENAI/opkfc.py +518 -518
  115. webscout/Provider/OPENAI/pydantic_imports.py +1 -1
  116. webscout/Provider/OPENAI/scirachat.py +535 -529
  117. webscout/Provider/OPENAI/sonus.py +308 -308
  118. webscout/Provider/OPENAI/standardinput.py +442 -442
  119. webscout/Provider/OPENAI/textpollinations.py +340 -348
  120. webscout/Provider/OPENAI/toolbaz.py +419 -413
  121. webscout/Provider/OPENAI/typefully.py +362 -362
  122. webscout/Provider/OPENAI/utils.py +295 -295
  123. webscout/Provider/OPENAI/venice.py +436 -436
  124. webscout/Provider/OPENAI/wisecat.py +387 -387
  125. webscout/Provider/OPENAI/writecream.py +166 -166
  126. webscout/Provider/OPENAI/x0gpt.py +378 -378
  127. webscout/Provider/OPENAI/yep.py +389 -389
  128. webscout/Provider/OpenGPT.py +230 -230
  129. webscout/Provider/Openai.py +244 -496
  130. webscout/Provider/PI.py +405 -404
  131. webscout/Provider/Perplexitylabs.py +430 -431
  132. webscout/Provider/QwenLM.py +272 -254
  133. webscout/Provider/STT/__init__.py +32 -2
  134. webscout/Provider/{Llama3.py → Sambanova.py} +257 -258
  135. webscout/Provider/StandardInput.py +309 -309
  136. webscout/Provider/TTI/README.md +82 -82
  137. webscout/Provider/TTI/__init__.py +33 -12
  138. webscout/Provider/TTI/aiarta.py +413 -413
  139. webscout/Provider/TTI/base.py +136 -136
  140. webscout/Provider/TTI/bing.py +243 -243
  141. webscout/Provider/TTI/gpt1image.py +149 -149
  142. webscout/Provider/TTI/imagen.py +196 -196
  143. webscout/Provider/TTI/infip.py +211 -211
  144. webscout/Provider/TTI/magicstudio.py +232 -232
  145. webscout/Provider/TTI/monochat.py +219 -219
  146. webscout/Provider/TTI/piclumen.py +214 -214
  147. webscout/Provider/TTI/pixelmuse.py +232 -232
  148. webscout/Provider/TTI/pollinations.py +232 -232
  149. webscout/Provider/TTI/together.py +288 -288
  150. webscout/Provider/TTI/utils.py +12 -12
  151. webscout/Provider/TTI/venice.py +367 -367
  152. webscout/Provider/TTS/README.md +192 -192
  153. webscout/Provider/TTS/__init__.py +33 -10
  154. webscout/Provider/TTS/parler.py +110 -110
  155. webscout/Provider/TTS/streamElements.py +333 -333
  156. webscout/Provider/TTS/utils.py +280 -280
  157. webscout/Provider/TeachAnything.py +237 -236
  158. webscout/Provider/TextPollinationsAI.py +311 -318
  159. webscout/Provider/TogetherAI.py +356 -357
  160. webscout/Provider/TwoAI.py +313 -569
  161. webscout/Provider/TypliAI.py +312 -311
  162. webscout/Provider/UNFINISHED/ChatHub.py +208 -208
  163. webscout/Provider/UNFINISHED/ChutesAI.py +313 -313
  164. webscout/Provider/{GizAI.py → UNFINISHED/GizAI.py} +294 -294
  165. webscout/Provider/{Marcus.py → UNFINISHED/Marcus.py} +198 -198
  166. webscout/Provider/{Qodo.py → UNFINISHED/Qodo.py} +477 -477
  167. webscout/Provider/UNFINISHED/VercelAIGateway.py +338 -338
  168. webscout/Provider/{XenAI.py → UNFINISHED/XenAI.py} +324 -324
  169. webscout/Provider/UNFINISHED/Youchat.py +330 -330
  170. webscout/Provider/UNFINISHED/liner.py +334 -0
  171. webscout/Provider/UNFINISHED/liner_api_request.py +262 -262
  172. webscout/Provider/UNFINISHED/puterjs.py +634 -634
  173. webscout/Provider/UNFINISHED/samurai.py +223 -223
  174. webscout/Provider/UNFINISHED/test_lmarena.py +119 -119
  175. webscout/Provider/Venice.py +251 -250
  176. webscout/Provider/VercelAI.py +256 -255
  177. webscout/Provider/WiseCat.py +232 -231
  178. webscout/Provider/WrDoChat.py +367 -366
  179. webscout/Provider/__init__.py +33 -86
  180. webscout/Provider/ai4chat.py +174 -174
  181. webscout/Provider/akashgpt.py +331 -334
  182. webscout/Provider/cerebras.py +446 -340
  183. webscout/Provider/chatglm.py +394 -214
  184. webscout/Provider/cleeai.py +211 -212
  185. webscout/Provider/deepseek_assistant.py +1 -1
  186. webscout/Provider/elmo.py +282 -282
  187. webscout/Provider/geminiapi.py +208 -208
  188. webscout/Provider/granite.py +261 -261
  189. webscout/Provider/hermes.py +263 -265
  190. webscout/Provider/julius.py +223 -222
  191. webscout/Provider/learnfastai.py +309 -309
  192. webscout/Provider/llama3mitril.py +214 -214
  193. webscout/Provider/llmchat.py +243 -243
  194. webscout/Provider/llmchatco.py +290 -290
  195. webscout/Provider/meta.py +801 -801
  196. webscout/Provider/oivscode.py +309 -309
  197. webscout/Provider/scira_chat.py +384 -457
  198. webscout/Provider/searchchat.py +292 -291
  199. webscout/Provider/sonus.py +258 -258
  200. webscout/Provider/toolbaz.py +370 -364
  201. webscout/Provider/turboseek.py +274 -265
  202. webscout/Provider/typefully.py +208 -207
  203. webscout/Provider/x0gpt.py +1 -0
  204. webscout/Provider/yep.py +372 -371
  205. webscout/__init__.py +30 -31
  206. webscout/__main__.py +5 -5
  207. webscout/auth/api_key_manager.py +189 -189
  208. webscout/auth/config.py +175 -175
  209. webscout/auth/models.py +185 -185
  210. webscout/auth/routes.py +664 -664
  211. webscout/auth/simple_logger.py +236 -236
  212. webscout/cli.py +523 -523
  213. webscout/conversation.py +438 -438
  214. webscout/exceptions.py +361 -361
  215. webscout/litagent/Readme.md +298 -298
  216. webscout/litagent/__init__.py +28 -28
  217. webscout/litagent/agent.py +581 -581
  218. webscout/litagent/constants.py +59 -59
  219. webscout/litprinter/__init__.py +58 -58
  220. webscout/models.py +181 -181
  221. webscout/optimizers.py +419 -419
  222. webscout/prompt_manager.py +288 -288
  223. webscout/sanitize.py +1078 -1078
  224. webscout/scout/README.md +401 -401
  225. webscout/scout/__init__.py +8 -8
  226. webscout/scout/core/__init__.py +6 -6
  227. webscout/scout/core/crawler.py +297 -297
  228. webscout/scout/core/scout.py +706 -706
  229. webscout/scout/core/search_result.py +95 -95
  230. webscout/scout/core/text_analyzer.py +62 -62
  231. webscout/scout/core/text_utils.py +277 -277
  232. webscout/scout/core/web_analyzer.py +51 -51
  233. webscout/scout/element.py +599 -599
  234. webscout/scout/parsers/__init__.py +69 -69
  235. webscout/scout/parsers/html5lib_parser.py +172 -172
  236. webscout/scout/parsers/html_parser.py +236 -236
  237. webscout/scout/parsers/lxml_parser.py +178 -178
  238. webscout/scout/utils.py +37 -37
  239. webscout/swiftcli/Readme.md +323 -323
  240. webscout/swiftcli/__init__.py +95 -95
  241. webscout/swiftcli/core/__init__.py +7 -7
  242. webscout/swiftcli/core/cli.py +308 -308
  243. webscout/swiftcli/core/context.py +104 -104
  244. webscout/swiftcli/core/group.py +241 -241
  245. webscout/swiftcli/decorators/__init__.py +28 -28
  246. webscout/swiftcli/decorators/command.py +221 -221
  247. webscout/swiftcli/decorators/options.py +220 -220
  248. webscout/swiftcli/decorators/output.py +302 -302
  249. webscout/swiftcli/exceptions.py +21 -21
  250. webscout/swiftcli/plugins/__init__.py +9 -9
  251. webscout/swiftcli/plugins/base.py +135 -135
  252. webscout/swiftcli/plugins/manager.py +269 -269
  253. webscout/swiftcli/utils/__init__.py +59 -59
  254. webscout/swiftcli/utils/formatting.py +252 -252
  255. webscout/swiftcli/utils/parsing.py +267 -267
  256. webscout/update_checker.py +117 -117
  257. webscout/version.py +1 -1
  258. webscout/webscout_search.py +1183 -1183
  259. webscout/webscout_search_async.py +649 -649
  260. webscout/yep_search.py +346 -346
  261. webscout/zeroart/README.md +89 -89
  262. webscout/zeroart/__init__.py +134 -134
  263. webscout/zeroart/base.py +66 -66
  264. webscout/zeroart/effects.py +100 -100
  265. webscout/zeroart/fonts.py +1238 -1238
  266. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/METADATA +937 -936
  267. webscout-2025.10.11.dist-info/RECORD +300 -0
  268. webscout/Provider/AISEARCH/DeepFind.py +0 -254
  269. webscout/Provider/AllenAI.py +0 -440
  270. webscout/Provider/Blackboxai.py +0 -793
  271. webscout/Provider/FreeGemini.py +0 -250
  272. webscout/Provider/GptOss.py +0 -207
  273. webscout/Provider/Hunyuan.py +0 -283
  274. webscout/Provider/Kimi.py +0 -445
  275. webscout/Provider/MCPCore.py +0 -322
  276. webscout/Provider/MiniMax.py +0 -207
  277. webscout/Provider/OPENAI/BLACKBOXAI.py +0 -1045
  278. webscout/Provider/OPENAI/MiniMax.py +0 -298
  279. webscout/Provider/OPENAI/Qwen3.py +0 -304
  280. webscout/Provider/OPENAI/autoproxy.py +0 -1067
  281. webscout/Provider/OPENAI/copilot.py +0 -321
  282. webscout/Provider/OPENAI/gptoss.py +0 -288
  283. webscout/Provider/OPENAI/kimi.py +0 -469
  284. webscout/Provider/OPENAI/mcpcore.py +0 -431
  285. webscout/Provider/OPENAI/multichat.py +0 -378
  286. webscout/Provider/OPENAI/qodo.py +0 -630
  287. webscout/Provider/OPENAI/xenai.py +0 -514
  288. webscout/Provider/Reka.py +0 -214
  289. webscout/Provider/UNFINISHED/fetch_together_models.py +0 -90
  290. webscout/Provider/asksteve.py +0 -220
  291. webscout/Provider/copilot.py +0 -441
  292. webscout/Provider/freeaichat.py +0 -294
  293. webscout/Provider/koala.py +0 -182
  294. webscout/Provider/lmarena.py +0 -198
  295. webscout/Provider/monochat.py +0 -275
  296. webscout/Provider/multichat.py +0 -375
  297. webscout/Provider/scnet.py +0 -244
  298. webscout/Provider/talkai.py +0 -194
  299. webscout/tempid.py +0 -128
  300. webscout-8.3.6.dist-info/RECORD +0 -327
  301. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/WHEEL +0 -0
  302. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/entry_points.txt +0 -0
  303. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/licenses/LICENSE.md +0 -0
  304. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/top_level.txt +0 -0
@@ -1,457 +1,452 @@
1
- import requests
2
- import json
3
- import time
4
- import uuid
5
- from typing import List, Dict, Optional, Union, Generator, Any
6
-
7
- from webscout.Provider.OPENAI.base import OpenAICompatibleProvider, BaseChat, BaseCompletions
8
- from webscout.Provider.OPENAI.utils import (
9
- ChatCompletionChunk, ChatCompletion, Choice, ChoiceDelta,
10
- ChatCompletionMessage, CompletionUsage,
11
- get_system_prompt,
12
- count_tokens,
13
- format_prompt
14
- )
15
- from webscout.litagent import LitAgent
16
-
17
- def convert_openai_to_falcon_history(messages: List[Dict[str, str]]) -> list:
18
- """
19
- Converts a list of OpenAI-style chat messages to Falcon/Gradio chat history format.
20
-
21
- Args:
22
- messages (List[Dict[str, str]]):
23
- A list of message dictionaries, each with 'role' and 'content' keys, following the OpenAI API format.
24
-
25
- Returns:
26
- list: A single-turn Falcon/Gradio chat history in the format [[prompt, None]].
27
- """
28
- prompt = format_prompt(messages, add_special_tokens=False, do_continue=True, include_system=True)
29
- return [[prompt, None]]
30
-
31
- class Completions(BaseCompletions):
32
- """
33
- Handles text completion requests for the FalconH1 provider, supporting both streaming and non-streaming modes.
34
-
35
- Attributes:
36
- _client (Any): Reference to the FalconH1 client instance.
37
- _last_yielded_content_stream (str): Tracks the last yielded content in streaming mode.
38
- """
39
- def __init__(self, client):
40
- """
41
- Initializes the Completions handler.
42
-
43
- Args:
44
- client: The FalconH1 client instance.
45
- """
46
- self._client = client
47
- self._last_yielded_content_stream = ""
48
-
49
- def create(
50
- self,
51
- *,
52
- model: str,
53
- messages: List[Dict[str, str]],
54
- max_tokens: Optional[int] = 1024,
55
- stream: bool = False,
56
- temperature: Optional[float] = 0.1,
57
- top_p: Optional[float] = 1.0,
58
- timeout: Optional[int] = None,
59
- proxies: Optional[dict] = None,
60
- **kwargs: Any
61
- ) -> Union[ChatCompletion, Generator[ChatCompletionChunk, None, None]]:
62
- """
63
- Creates a chat completion using the FalconH1 API, supporting both streaming and non-streaming responses.
64
-
65
- Args:
66
- model (str): The model identifier to use for completion.
67
- messages (List[Dict[str, str]]): List of chat messages in OpenAI format.
68
- max_tokens (Optional[int]): Maximum number of tokens to generate in the completion.
69
- stream (bool): Whether to stream the response as chunks.
70
- temperature (Optional[float]): Sampling temperature.
71
- top_p (Optional[float]): Nucleus sampling probability.
72
- timeout (Optional[int]): Request timeout in seconds.
73
- proxies (Optional[dict]): Optional proxy settings for the request.
74
- **kwargs: Additional keyword arguments for advanced options (e.g., top_k, repetition_penalty).
75
-
76
- Returns:
77
- Union[ChatCompletion, Generator[ChatCompletionChunk, None, None]]: The chat completion result or a generator yielding streamed chunks.
78
- """
79
- session_hash = str(uuid.uuid4()).replace('-', '')
80
- chat_history = convert_openai_to_falcon_history(messages)
81
- if not chat_history or chat_history[-1][0] is None:
82
- raise ValueError("Messages must contain at least one user message for Falcon API.")
83
- resolved_model_name = self._client.get_model(model)
84
- payload_data = [
85
- chat_history,
86
- resolved_model_name,
87
- temperature,
88
- max_tokens,
89
- top_p,
90
- kwargs.get("top_k", 20),
91
- kwargs.get("repetition_penalty", 1.2)
92
- ]
93
- payload = {
94
- "data": payload_data,
95
- "event_data": None,
96
- "fn_index": 5,
97
- "trigger_id": 12,
98
- "session_hash": session_hash
99
- }
100
- request_id = f"chatcmpl-{uuid.uuid4()}"
101
- created_time = int(time.time())
102
- if stream:
103
- self._last_yielded_content_stream = ""
104
- return self._create_stream(request_id, created_time, resolved_model_name, payload, session_hash, timeout=timeout, proxies=proxies)
105
- else:
106
- return self._create_non_stream(request_id, created_time, resolved_model_name, payload, session_hash, timeout=timeout, proxies=proxies)
107
-
108
- def _create_stream(
109
- self, request_id: str, created_time: int, model: str, payload: Dict[str, Any], session_hash: str,
110
- timeout: Optional[int] = None, proxies: Optional[dict] = None
111
- ) -> Generator[ChatCompletionChunk, None, None]:
112
- """
113
- Internal method to handle streaming chat completions from the FalconH1 API.
114
-
115
- Args:
116
- request_id (str): Unique request identifier.
117
- created_time (int): Timestamp of request creation.
118
- model (str): Model identifier.
119
- payload (Dict[str, Any]): Request payload for the API.
120
- session_hash (str): Unique session hash for the request.
121
- timeout (Optional[int]): Request timeout in seconds.
122
- proxies (Optional[dict]): Optional proxy settings.
123
-
124
- Yields:
125
- ChatCompletionChunk: Chunks of the chat completion as they are received from the API.
126
- """
127
- original_proxies = self._client.session.proxies.copy()
128
- if proxies is not None:
129
- self._client.session.proxies = proxies
130
- else:
131
- self._client.session.proxies = {}
132
- try:
133
- session = self._client.session
134
- join_resp = session.post(
135
- self._client.api_join_endpoint,
136
- headers=self._client.headers,
137
- json=payload,
138
- timeout=timeout if timeout is not None else self._client.timeout
139
- )
140
- join_resp.raise_for_status()
141
- data_url = f"{self._client.api_data_endpoint}?session_hash={session_hash}"
142
- stream_resp = session.get(
143
- data_url,
144
- headers=self._client.stream_headers,
145
- stream=True,
146
- timeout=timeout if timeout is not None else self._client.timeout
147
- )
148
- stream_resp.raise_for_status()
149
- for line in stream_resp.iter_lines():
150
- if line:
151
- decoded_line = line.decode('utf-8')
152
- if decoded_line.startswith('data: '):
153
- try:
154
- json_data = json.loads(decoded_line[6:])
155
- msg_type = json_data.get('msg')
156
- if msg_type == 'process_generating':
157
- output_field = json_data.get('output', {})
158
- data_field = output_field.get('data')
159
- if data_field and isinstance(data_field, list) and len(data_field) > 0:
160
- inner_data = data_field[0]
161
- content_to_yield = None
162
- if isinstance(inner_data, list) and len(inner_data) > 0:
163
- if isinstance(inner_data[0], list) and len(inner_data[0]) == 3 and inner_data[0][0] == "append":
164
- content_to_yield = inner_data[0][2]
165
- elif isinstance(inner_data[0], list) and len(inner_data[0]) == 2 and \
166
- isinstance(inner_data[0][1], str):
167
- current_full_response = inner_data[0][1]
168
- if current_full_response.startswith(self._last_yielded_content_stream):
169
- content_to_yield = current_full_response[len(self._last_yielded_content_stream):]
170
- else:
171
- content_to_yield = current_full_response
172
- self._last_yielded_content_stream = current_full_response
173
- if content_to_yield:
174
- delta = ChoiceDelta(content=content_to_yield, role="assistant")
175
- yield ChatCompletionChunk(id=request_id, choices=[Choice(index=0, delta=delta)], created=created_time, model=model)
176
- elif msg_type == 'process_completed' or msg_type == 'close_stream':
177
- break
178
- except json.JSONDecodeError:
179
- continue
180
- except Exception as e:
181
- continue
182
- finally:
183
- self._client.session.proxies = original_proxies
184
-
185
- def _create_non_stream(
186
- self, request_id: str, created_time: int, model: str, payload: Dict[str, Any], session_hash: str,
187
- timeout: Optional[int] = None, proxies: Optional[dict] = None
188
- ) -> ChatCompletion:
189
- """
190
- Internal method to handle non-streaming chat completions from the FalconH1 API.
191
-
192
- Args:
193
- request_id (str): Unique request identifier.
194
- created_time (int): Timestamp of request creation.
195
- model (str): Model identifier.
196
- payload (Dict[str, Any]): Request payload for the API.
197
- session_hash (str): Unique session hash for the request.
198
- timeout (Optional[int]): Request timeout in seconds.
199
- proxies (Optional[dict]): Optional proxy settings.
200
-
201
- Returns:
202
- ChatCompletion: The full chat completion result.
203
- """
204
- original_proxies = self._client.session.proxies.copy()
205
- if proxies is not None:
206
- self._client.session.proxies = proxies
207
- else:
208
- self._client.session.proxies = {}
209
- full_response_content = ""
210
- last_full_response_chunk_ns = ""
211
- response_parts = []
212
- try:
213
- session = self._client.session
214
- join_resp = session.post(
215
- self._client.api_join_endpoint, headers=self._client.headers, json=payload,
216
- timeout=timeout if timeout is not None else self._client.timeout
217
- )
218
- join_resp.raise_for_status()
219
- data_url = f"{self._client.api_data_endpoint}?session_hash={session_hash}"
220
- overall_start_time = time.time()
221
- effective_timeout = timeout if timeout is not None else self._client.timeout
222
- while True:
223
- if time.time() - overall_start_time > effective_timeout:
224
- raise TimeoutError("Timeout waiting for non-stream response completion.")
225
- stream_resp = session.get(
226
- data_url, headers=self._client.stream_headers, stream=True,
227
- timeout=effective_timeout
228
- )
229
- stream_resp.raise_for_status()
230
- found_completion_message = False
231
- for line in stream_resp.iter_lines():
232
- if time.time() - overall_start_time > effective_timeout:
233
- raise TimeoutError("Timeout during non-stream response processing.")
234
- if line:
235
- decoded_line = line.decode('utf-8')
236
- if decoded_line.startswith('data: '):
237
- try:
238
- json_data = json.loads(decoded_line[6:])
239
- msg_type = json_data.get('msg')
240
- if msg_type == 'process_generating':
241
- output_field = json_data.get('output', {})
242
- data_field = output_field.get('data')
243
- if data_field and isinstance(data_field, list) and len(data_field) > 0:
244
- inner_data = data_field[0]
245
- current_chunk_text = None
246
- if isinstance(inner_data, list) and len(inner_data) > 0:
247
- if isinstance(inner_data[0], list) and len(inner_data[0]) == 3 and inner_data[0][0] == "append":
248
- current_chunk_text = inner_data[0][2]
249
- elif isinstance(inner_data[0], list) and len(inner_data[0]) == 2 and isinstance(inner_data[0][1], str):
250
- current_full_response = inner_data[0][1]
251
- if current_full_response.startswith(last_full_response_chunk_ns):
252
- current_chunk_text = current_full_response[len(last_full_response_chunk_ns):]
253
- else:
254
- current_chunk_text = current_full_response
255
- last_full_response_chunk_ns = current_full_response
256
- if current_chunk_text:
257
- response_parts.append(current_chunk_text)
258
- elif msg_type == 'process_completed' or msg_type == 'close_stream':
259
- if msg_type == 'process_completed':
260
- output_field = json_data.get('output', {})
261
- data_field = output_field.get('data')
262
- if data_field and isinstance(data_field, list) and len(data_field) > 0:
263
- inner_data = data_field[0]
264
- if isinstance(inner_data, list) and len(inner_data) > 0 and \
265
- isinstance(inner_data[0], list) and len(inner_data[0]) == 2 and \
266
- isinstance(inner_data[0][1], str):
267
- final_full_response = inner_data[0][1]
268
- if final_full_response != last_full_response_chunk_ns:
269
- if final_full_response.startswith(last_full_response_chunk_ns):
270
- response_parts.append(final_full_response[len(last_full_response_chunk_ns):])
271
- else:
272
- response_parts = [final_full_response]
273
- last_full_response_chunk_ns = final_full_response
274
- found_completion_message = True
275
- break
276
- except json.JSONDecodeError:
277
- continue
278
- except Exception as e:
279
- raise e
280
- if found_completion_message:
281
- break
282
- full_response_content = "".join(response_parts)
283
- message = ChatCompletionMessage(role="assistant", content=full_response_content)
284
- choice = Choice(index=0, message=message, finish_reason="stop")
285
-
286
- # Simplified token counting without history iteration
287
- chat_history = payload['data'][0]
288
- prompt = chat_history[0][0] if chat_history and chat_history[0] and chat_history[0][0] else ""
289
- prompt_tokens = count_tokens(prompt)
290
- completion_tokens = count_tokens(full_response_content)
291
- usage = CompletionUsage(
292
- prompt_tokens=prompt_tokens,
293
- completion_tokens=completion_tokens,
294
- total_tokens=prompt_tokens + completion_tokens
295
- )
296
- return ChatCompletion(
297
- id=request_id, choices=[choice], created=created_time,
298
- model=model, usage=usage
299
- )
300
- finally:
301
- self._client.session.proxies = original_proxies
302
-
303
- class Chat(BaseChat):
304
- """
305
- Provides a chat interface for the FalconH1 provider, exposing the completions API.
306
-
307
- Attributes:
308
- completions (Completions): The completions handler for chat requests.
309
- """
310
- def __init__(self, client):
311
- """
312
- Initializes the Chat interface for FalconH1.
313
-
314
- Args:
315
- client: The FalconH1 client instance.
316
- """
317
- self.completions = Completions(client)
318
-
319
- class FalconH1(OpenAICompatibleProvider):
320
- """
321
- FalconH1 provider implementation compatible with the OpenAI API interface.
322
- Handles chat completions using FalconH1 models via the Hugging Face Spaces API.
323
-
324
- Attributes:
325
- base_url (str): Base URL for the FalconH1 API.
326
- api_join_endpoint (str): Endpoint for joining the chat queue.
327
- api_data_endpoint (str): Endpoint for retrieving chat data.
328
- AVAILABLE_MODELS (List[str]): List of supported FalconH1 model identifiers.
329
- timeout (int): Default request timeout in seconds.
330
- session (requests.Session): HTTP session for API requests.
331
- headers (dict): Default HTTP headers for requests.
332
- stream_headers (dict): HTTP headers for streaming requests.
333
- chat (Chat): Chat interface for completions.
334
- """
335
- base_url = "https://tiiuae-falcon-h1-playground.hf.space"
336
- api_join_endpoint = f"{base_url}/gradio_api/queue/join?__theme=dark"
337
- api_data_endpoint = f"{base_url}/gradio_api/queue/data"
338
- AVAILABLE_MODELS = [
339
- "Falcon-H1-34B-Instruct",
340
- "Falcon-H1-7B-Instruct",
341
- "Falcon-H1-3B-Instruct",
342
- "Falcon-H1-1.5B-Deep-Instruct",
343
- "Falcon-H1-1.5B-Instruct",
344
- "Falcon-H1-0.5B-Instruct",
345
- ]
346
- def __init__(self, timeout: int = 120, proxies: Optional[dict] = None):
347
- """
348
- Initializes the FalconH1 provider with optional timeout and proxy settings.
349
-
350
- Args:
351
- timeout (int): Default request timeout in seconds (default: 120).
352
- proxies (Optional[dict]): Optional proxy settings for HTTP requests.
353
- """
354
- self.timeout = timeout
355
- self.session = requests.Session()
356
- if proxies:
357
- self.session.proxies = proxies
358
- else:
359
- self.session.proxies = {}
360
- self.headers = {
361
- 'User-Agent': LitAgent().random(),
362
- 'Accept': '*/*',
363
- 'Accept-Language': 'en-US,en;q=0.9,en-IN;q=0.8',
364
- 'Accept-Encoding': 'gzip, deflate, br, zstd',
365
- 'Referer': f'{self.base_url}/?__theme=dark',
366
- 'Content-Type': 'application/json',
367
- 'Origin': self.base_url,
368
- 'Connection': 'keep-alive',
369
- 'Sec-Fetch-Dest': 'empty',
370
- 'Sec-Fetch-Mode': 'cors',
371
- 'Sec-Fetch-Site': 'same-origin',
372
- 'DNT': '1',
373
- 'Sec-GPC': '1',
374
- }
375
- self.stream_headers = {
376
- 'Accept': 'text/event-stream',
377
- 'Accept-Language': self.headers['Accept-Language'],
378
- 'Referer': self.headers['Referer'],
379
- 'User-Agent': self.headers['User-Agent'],
380
- 'Connection': 'keep-alive',
381
- 'Cache-Control': 'no-cache',
382
- }
383
- self.session.headers.update(self.headers)
384
- self.chat = Chat(self)
385
- def get_model(self, model_identifier: str) -> str:
386
- """
387
- Returns the resolved model name for the given identifier.
388
-
389
- Args:
390
- model_identifier (str): The model identifier string.
391
-
392
- Returns:
393
- str: The resolved model name (currently returns the identifier as-is).
394
- """
395
- return model_identifier
396
- @property
397
- def models(self):
398
- """
399
- Returns a list-like object containing available FalconH1 models.
400
-
401
- Returns:
402
- ModelList: An object with a .list() method returning model data objects.
403
- """
404
- class ModelData:
405
- def __init__(self, id_str):
406
- self.id = id_str
407
- class ModelList:
408
- def __init__(self, models_available):
409
- self.data = [ModelData(m) for m in models_available]
410
- def list(self):
411
- return self.data
412
- return ModelList(self.AVAILABLE_MODELS)
413
-
414
- if __name__ == "__main__":
415
- """
416
- Example usage of the FalconH1 provider for both non-streaming and streaming chat completions.
417
- """
418
- print("FalconH1 Provider Example")
419
- client = FalconH1()
420
- print("\n--- Non-Streaming Example ---")
421
- try:
422
- response = client.chat.completions.create(
423
- model="Falcon-H1-34B-Instruct",
424
- messages=[
425
- {"role": "system", "content": "You are a helpful AI assistant named Falcon."},
426
- {"role": "user", "content": "Hello, what is your name and what can you do?"}
427
- ]
428
- )
429
- print(f"ID: {response.id}")
430
- print(f"Model: {response.model}")
431
- if response.choices:
432
- print(f"Response: {response.choices[0].message.content}")
433
- if response.usage:
434
- print(f"Usage: {response.usage}")
435
- except Exception as e:
436
- print(f"Error in non-streaming example: {e}")
437
- print("\n--- Streaming Example ---")
438
- try:
439
- stream_response = client.chat.completions.create(
440
- model="Falcon-H1-34B-Instruct",
441
- messages=[
442
- {"role": "user", "content": "Tell me a short story about a brave falcon."}
443
- ],
444
- stream=True,
445
- max_tokens=150
446
- )
447
- print("Streaming response:")
448
- full_streamed_content = ""
449
- for chunk in stream_response:
450
- if chunk.choices and chunk.choices[0].delta and chunk.choices[0].delta.content:
451
- content_piece = chunk.choices[0].delta.content
452
- print(content_piece, end="", flush=True)
453
- full_streamed_content += content_piece
454
- print("\n--- End of Stream ---")
455
- except Exception as e:
456
- print(f"Error in streaming example: {e}")
457
-
1
+ import requests
2
+ import json
3
+ import time
4
+ import uuid
5
+ from typing import List, Dict, Optional, Union, Generator, Any
6
+
7
+ from webscout.Provider.OPENAI.base import OpenAICompatibleProvider, BaseChat, BaseCompletions
8
+ from webscout.Provider.OPENAI.utils import (
9
+ ChatCompletionChunk, ChatCompletion, Choice, ChoiceDelta,
10
+ ChatCompletionMessage, CompletionUsage,
11
+ get_system_prompt,
12
+ count_tokens,
13
+ format_prompt
14
+ )
15
+ from webscout.litagent import LitAgent
16
+
17
+ def convert_openai_to_falcon_history(messages: List[Dict[str, str]]) -> list:
18
+ """
19
+ Converts a list of OpenAI-style chat messages to Falcon/Gradio chat history format.
20
+
21
+ Args:
22
+ messages (List[Dict[str, str]]):
23
+ A list of message dictionaries, each with 'role' and 'content' keys, following the OpenAI API format.
24
+
25
+ Returns:
26
+ list: A single-turn Falcon/Gradio chat history in the format [[prompt, None]].
27
+ """
28
+ prompt = format_prompt(messages, add_special_tokens=False, do_continue=True, include_system=True)
29
+ return [[prompt, None]]
30
+
31
+ class Completions(BaseCompletions):
32
+ """
33
+ Handles text completion requests for the FalconH1 provider, supporting both streaming and non-streaming modes.
34
+
35
+ Attributes:
36
+ _client (Any): Reference to the FalconH1 client instance.
37
+ _last_yielded_content_stream (str): Tracks the last yielded content in streaming mode.
38
+ """
39
+ def __init__(self, client):
40
+ """
41
+ Initializes the Completions handler.
42
+
43
+ Args:
44
+ client: The FalconH1 client instance.
45
+ """
46
+ self._client = client
47
+ self._last_yielded_content_stream = ""
48
+
49
+ def create(
50
+ self,
51
+ *,
52
+ model: str,
53
+ messages: List[Dict[str, str]],
54
+ max_tokens: Optional[int] = 1024,
55
+ stream: bool = False,
56
+ temperature: Optional[float] = 0.1,
57
+ top_p: Optional[float] = 1.0,
58
+ timeout: Optional[int] = None,
59
+ proxies: Optional[dict] = None,
60
+ **kwargs: Any
61
+ ) -> Union[ChatCompletion, Generator[ChatCompletionChunk, None, None]]:
62
+ """
63
+ Creates a chat completion using the FalconH1 API, supporting both streaming and non-streaming responses.
64
+
65
+ Args:
66
+ model (str): The model identifier to use for completion.
67
+ messages (List[Dict[str, str]]): List of chat messages in OpenAI format.
68
+ max_tokens (Optional[int]): Maximum number of tokens to generate in the completion.
69
+ stream (bool): Whether to stream the response as chunks.
70
+ temperature (Optional[float]): Sampling temperature.
71
+ top_p (Optional[float]): Nucleus sampling probability.
72
+ timeout (Optional[int]): Request timeout in seconds.
73
+ proxies (Optional[dict]): Optional proxy settings for the request.
74
+ **kwargs: Additional keyword arguments for advanced options (e.g., top_k, repetition_penalty).
75
+
76
+ Returns:
77
+ Union[ChatCompletion, Generator[ChatCompletionChunk, None, None]]: The chat completion result or a generator yielding streamed chunks.
78
+ """
79
+ session_hash = str(uuid.uuid4()).replace('-', '')
80
+ chat_history = convert_openai_to_falcon_history(messages)
81
+ if not chat_history or chat_history[-1][0] is None:
82
+ raise ValueError("Messages must contain at least one user message for Falcon API.")
83
+ resolved_model_name = self._client.get_model(model)
84
+ payload_data = [
85
+ chat_history,
86
+ resolved_model_name,
87
+ temperature,
88
+ max_tokens,
89
+ top_p,
90
+ kwargs.get("top_k", 20),
91
+ kwargs.get("repetition_penalty", 1.2)
92
+ ]
93
+ payload = {
94
+ "data": payload_data,
95
+ "event_data": None,
96
+ "fn_index": 5,
97
+ "trigger_id": 12,
98
+ "session_hash": session_hash
99
+ }
100
+ request_id = f"chatcmpl-{uuid.uuid4()}"
101
+ created_time = int(time.time())
102
+ if stream:
103
+ self._last_yielded_content_stream = ""
104
+ return self._create_stream(request_id, created_time, resolved_model_name, payload, session_hash, timeout=timeout, proxies=proxies)
105
+ else:
106
+ return self._create_non_stream(request_id, created_time, resolved_model_name, payload, session_hash, timeout=timeout, proxies=proxies)
107
+
108
+ def _create_stream(
109
+ self, request_id: str, created_time: int, model: str, payload: Dict[str, Any], session_hash: str,
110
+ timeout: Optional[int] = None, proxies: Optional[dict] = None
111
+ ) -> Generator[ChatCompletionChunk, None, None]:
112
+ """
113
+ Internal method to handle streaming chat completions from the FalconH1 API.
114
+
115
+ Args:
116
+ request_id (str): Unique request identifier.
117
+ created_time (int): Timestamp of request creation.
118
+ model (str): Model identifier.
119
+ payload (Dict[str, Any]): Request payload for the API.
120
+ session_hash (str): Unique session hash for the request.
121
+ timeout (Optional[int]): Request timeout in seconds.
122
+ proxies (Optional[dict]): Optional proxy settings.
123
+
124
+ Yields:
125
+ ChatCompletionChunk: Chunks of the chat completion as they are received from the API.
126
+ """
127
+ original_proxies = self._client.session.proxies.copy()
128
+ if proxies is not None:
129
+ self._client.session.proxies = proxies
130
+ else:
131
+ self._client.session.proxies = {}
132
+ try:
133
+ session = self._client.session
134
+ join_resp = session.post(
135
+ self._client.api_join_endpoint,
136
+ headers=self._client.headers,
137
+ json=payload,
138
+ timeout=timeout if timeout is not None else self._client.timeout
139
+ )
140
+ join_resp.raise_for_status()
141
+ data_url = f"{self._client.api_data_endpoint}?session_hash={session_hash}"
142
+ stream_resp = session.get(
143
+ data_url,
144
+ headers=self._client.stream_headers,
145
+ stream=True,
146
+ timeout=timeout if timeout is not None else self._client.timeout
147
+ )
148
+ stream_resp.raise_for_status()
149
+ for line in stream_resp.iter_lines():
150
+ if line:
151
+ decoded_line = line.decode('utf-8')
152
+ if decoded_line.startswith('data: '):
153
+ try:
154
+ json_data = json.loads(decoded_line[6:])
155
+ msg_type = json_data.get('msg')
156
+ if msg_type == 'process_generating':
157
+ output_field = json_data.get('output', {})
158
+ data_field = output_field.get('data')
159
+ if data_field and isinstance(data_field, list) and len(data_field) > 0:
160
+ inner_data = data_field[0]
161
+ content_to_yield = None
162
+ if isinstance(inner_data, list) and len(inner_data) > 0:
163
+ if isinstance(inner_data[0], list) and len(inner_data[0]) == 3 and inner_data[0][0] == "append":
164
+ content_to_yield = inner_data[0][2]
165
+ elif isinstance(inner_data[0], list) and len(inner_data[0]) == 2 and \
166
+ isinstance(inner_data[0][1], str):
167
+ current_full_response = inner_data[0][1]
168
+ if current_full_response.startswith(self._last_yielded_content_stream):
169
+ content_to_yield = current_full_response[len(self._last_yielded_content_stream):]
170
+ else:
171
+ content_to_yield = current_full_response
172
+ self._last_yielded_content_stream = current_full_response
173
+ if content_to_yield:
174
+ delta = ChoiceDelta(content=content_to_yield, role="assistant")
175
+ yield ChatCompletionChunk(id=request_id, choices=[Choice(index=0, delta=delta)], created=created_time, model=model)
176
+ elif msg_type == 'process_completed' or msg_type == 'close_stream':
177
+ break
178
+ except json.JSONDecodeError:
179
+ continue
180
+ except Exception as e:
181
+ continue
182
+ finally:
183
+ self._client.session.proxies = original_proxies
184
+
185
+ def _create_non_stream(
186
+ self, request_id: str, created_time: int, model: str, payload: Dict[str, Any], session_hash: str,
187
+ timeout: Optional[int] = None, proxies: Optional[dict] = None
188
+ ) -> ChatCompletion:
189
+ """
190
+ Internal method to handle non-streaming chat completions from the FalconH1 API.
191
+
192
+ Args:
193
+ request_id (str): Unique request identifier.
194
+ created_time (int): Timestamp of request creation.
195
+ model (str): Model identifier.
196
+ payload (Dict[str, Any]): Request payload for the API.
197
+ session_hash (str): Unique session hash for the request.
198
+ timeout (Optional[int]): Request timeout in seconds.
199
+ proxies (Optional[dict]): Optional proxy settings.
200
+
201
+ Returns:
202
+ ChatCompletion: The full chat completion result.
203
+ """
204
+ original_proxies = self._client.session.proxies.copy()
205
+ if proxies is not None:
206
+ self._client.session.proxies = proxies
207
+ else:
208
+ self._client.session.proxies = {}
209
+ full_response_content = ""
210
+ last_full_response_chunk_ns = ""
211
+ response_parts = []
212
+ try:
213
+ session = self._client.session
214
+ join_resp = session.post(
215
+ self._client.api_join_endpoint, headers=self._client.headers, json=payload,
216
+ timeout=timeout if timeout is not None else self._client.timeout
217
+ )
218
+ join_resp.raise_for_status()
219
+ data_url = f"{self._client.api_data_endpoint}?session_hash={session_hash}"
220
+ overall_start_time = time.time()
221
+ effective_timeout = timeout if timeout is not None else self._client.timeout
222
+ while True:
223
+ if time.time() - overall_start_time > effective_timeout:
224
+ raise TimeoutError("Timeout waiting for non-stream response completion.")
225
+ stream_resp = session.get(
226
+ data_url, headers=self._client.stream_headers, stream=True,
227
+ timeout=effective_timeout
228
+ )
229
+ stream_resp.raise_for_status()
230
+ found_completion_message = False
231
+ for line in stream_resp.iter_lines():
232
+ if time.time() - overall_start_time > effective_timeout:
233
+ raise TimeoutError("Timeout during non-stream response processing.")
234
+ if line:
235
+ decoded_line = line.decode('utf-8')
236
+ if decoded_line.startswith('data: '):
237
+ try:
238
+ json_data = json.loads(decoded_line[6:])
239
+ msg_type = json_data.get('msg')
240
+ if msg_type == 'process_generating':
241
+ output_field = json_data.get('output', {})
242
+ data_field = output_field.get('data')
243
+ if data_field and isinstance(data_field, list) and len(data_field) > 0:
244
+ inner_data = data_field[0]
245
+ current_chunk_text = None
246
+ if isinstance(inner_data, list) and len(inner_data) > 0:
247
+ if isinstance(inner_data[0], list) and len(inner_data[0]) == 3 and inner_data[0][0] == "append":
248
+ current_chunk_text = inner_data[0][2]
249
+ elif isinstance(inner_data[0], list) and len(inner_data[0]) == 2 and isinstance(inner_data[0][1], str):
250
+ current_full_response = inner_data[0][1]
251
+ if current_full_response.startswith(last_full_response_chunk_ns):
252
+ current_chunk_text = current_full_response[len(last_full_response_chunk_ns):]
253
+ else:
254
+ current_chunk_text = current_full_response
255
+ last_full_response_chunk_ns = current_full_response
256
+ if current_chunk_text:
257
+ response_parts.append(current_chunk_text)
258
+ elif msg_type == 'process_completed' or msg_type == 'close_stream':
259
+ if msg_type == 'process_completed':
260
+ output_field = json_data.get('output', {})
261
+ data_field = output_field.get('data')
262
+ if data_field and isinstance(data_field, list) and len(data_field) > 0:
263
+ inner_data = data_field[0]
264
+ if isinstance(inner_data, list) and len(inner_data) > 0 and \
265
+ isinstance(inner_data[0], list) and len(inner_data[0]) == 2 and \
266
+ isinstance(inner_data[0][1], str):
267
+ final_full_response = inner_data[0][1]
268
+ if final_full_response != last_full_response_chunk_ns:
269
+ if final_full_response.startswith(last_full_response_chunk_ns):
270
+ response_parts.append(final_full_response[len(last_full_response_chunk_ns):])
271
+ else:
272
+ response_parts = [final_full_response]
273
+ last_full_response_chunk_ns = final_full_response
274
+ found_completion_message = True
275
+ break
276
+ except json.JSONDecodeError:
277
+ continue
278
+ except Exception as e:
279
+ raise e
280
+ if found_completion_message:
281
+ break
282
+ full_response_content = "".join(response_parts)
283
+ message = ChatCompletionMessage(role="assistant", content=full_response_content)
284
+ choice = Choice(index=0, message=message, finish_reason="stop")
285
+
286
+ # Simplified token counting without history iteration
287
+ chat_history = payload['data'][0]
288
+ prompt = chat_history[0][0] if chat_history and chat_history[0] and chat_history[0][0] else ""
289
+ prompt_tokens = count_tokens(prompt)
290
+ completion_tokens = count_tokens(full_response_content)
291
+ usage = CompletionUsage(
292
+ prompt_tokens=prompt_tokens,
293
+ completion_tokens=completion_tokens,
294
+ total_tokens=prompt_tokens + completion_tokens
295
+ )
296
+ return ChatCompletion(
297
+ id=request_id, choices=[choice], created=created_time,
298
+ model=model, usage=usage
299
+ )
300
+ finally:
301
+ self._client.session.proxies = original_proxies
302
+
303
+ class Chat(BaseChat):
304
+ """
305
+ Provides a chat interface for the FalconH1 provider, exposing the completions API.
306
+
307
+ Attributes:
308
+ completions (Completions): The completions handler for chat requests.
309
+ """
310
+ def __init__(self, client):
311
+ """
312
+ Initializes the Chat interface for FalconH1.
313
+
314
+ Args:
315
+ client: The FalconH1 client instance.
316
+ """
317
+ self.completions = Completions(client)
318
+
319
+ class FalconH1(OpenAICompatibleProvider):
320
+ """
321
+ FalconH1 provider implementation compatible with the OpenAI API interface.
322
+ Handles chat completions using FalconH1 models via the Hugging Face Spaces API.
323
+
324
+ Attributes:
325
+ base_url (str): Base URL for the FalconH1 API.
326
+ api_join_endpoint (str): Endpoint for joining the chat queue.
327
+ api_data_endpoint (str): Endpoint for retrieving chat data.
328
+ AVAILABLE_MODELS (List[str]): List of supported FalconH1 model identifiers.
329
+ timeout (int): Default request timeout in seconds.
330
+ session (requests.Session): HTTP session for API requests.
331
+ headers (dict): Default HTTP headers for requests.
332
+ stream_headers (dict): HTTP headers for streaming requests.
333
+ chat (Chat): Chat interface for completions.
334
+ """
335
+ base_url = "https://tiiuae-falcon-h1-playground.hf.space"
336
+ api_join_endpoint = f"{base_url}/gradio_api/queue/join?__theme=dark"
337
+ api_data_endpoint = f"{base_url}/gradio_api/queue/data"
338
+ AVAILABLE_MODELS = [
339
+ "Falcon-H1-34B-Instruct",
340
+ "Falcon-H1-7B-Instruct",
341
+ "Falcon-H1-3B-Instruct",
342
+ "Falcon-H1-1.5B-Deep-Instruct",
343
+ "Falcon-H1-1.5B-Instruct",
344
+ "Falcon-H1-0.5B-Instruct",
345
+ ]
346
+ def __init__(self, timeout: int = 120, proxies: Optional[dict] = None):
347
+ """
348
+ Initializes the FalconH1 provider with optional timeout and proxy settings.
349
+
350
+ Args:
351
+ timeout (int): Default request timeout in seconds (default: 120).
352
+ proxies (Optional[dict]): Optional proxy settings for HTTP requests.
353
+ """
354
+ super().__init__(proxies=proxies)
355
+ self.timeout = timeout
356
+ self.headers = {
357
+ 'User-Agent': LitAgent().random(),
358
+ 'Accept': '*/*',
359
+ 'Accept-Language': 'en-US,en;q=0.9,en-IN;q=0.8',
360
+ 'Accept-Encoding': 'gzip, deflate, br, zstd',
361
+ 'Referer': f'{self.base_url}/?__theme=dark',
362
+ 'Content-Type': 'application/json',
363
+ 'Origin': self.base_url,
364
+ 'Connection': 'keep-alive',
365
+ 'Sec-Fetch-Dest': 'empty',
366
+ 'Sec-Fetch-Mode': 'cors',
367
+ 'Sec-Fetch-Site': 'same-origin',
368
+ 'DNT': '1',
369
+ 'Sec-GPC': '1',
370
+ }
371
+ self.stream_headers = {
372
+ 'Accept': 'text/event-stream',
373
+ 'Accept-Language': self.headers['Accept-Language'],
374
+ 'Referer': self.headers['Referer'],
375
+ 'User-Agent': self.headers['User-Agent'],
376
+ 'Connection': 'keep-alive',
377
+ 'Cache-Control': 'no-cache',
378
+ }
379
+ self.session.headers.update(self.headers)
380
+ self.chat = Chat(self)
381
+ def get_model(self, model_identifier: str) -> str:
382
+ """
383
+ Returns the resolved model name for the given identifier.
384
+
385
+ Args:
386
+ model_identifier (str): The model identifier string.
387
+
388
+ Returns:
389
+ str: The resolved model name (currently returns the identifier as-is).
390
+ """
391
+ return model_identifier
392
+ @property
393
+ def models(self):
394
+ """
395
+ Returns a list-like object containing available FalconH1 models.
396
+
397
+ Returns:
398
+ ModelList: An object with a .list() method returning model data objects.
399
+ """
400
+ class ModelData:
401
+ def __init__(self, id_str):
402
+ self.id = id_str
403
+ class ModelList:
404
+ def __init__(self, models_available):
405
+ self.data = [ModelData(m) for m in models_available]
406
+ def list(self):
407
+ return self.data
408
+ return ModelList(self.AVAILABLE_MODELS)
409
+
410
+ if __name__ == "__main__":
411
+ """
412
+ Example usage of the FalconH1 provider for both non-streaming and streaming chat completions.
413
+ """
414
+ print("FalconH1 Provider Example")
415
+ client = FalconH1()
416
+ print("\n--- Non-Streaming Example ---")
417
+ try:
418
+ response = client.chat.completions.create(
419
+ model="Falcon-H1-34B-Instruct",
420
+ messages=[
421
+ {"role": "system", "content": "You are a helpful AI assistant named Falcon."},
422
+ {"role": "user", "content": "Hello, what is your name and what can you do?"}
423
+ ]
424
+ )
425
+ print(f"ID: {response.id}")
426
+ print(f"Model: {response.model}")
427
+ if response.choices:
428
+ print(f"Response: {response.choices[0].message.content}")
429
+ if response.usage:
430
+ print(f"Usage: {response.usage}")
431
+ except Exception as e:
432
+ print(f"Error in non-streaming example: {e}")
433
+ print("\n--- Streaming Example ---")
434
+ try:
435
+ stream_response = client.chat.completions.create(
436
+ model="Falcon-H1-34B-Instruct",
437
+ messages=[
438
+ {"role": "user", "content": "Tell me a short story about a brave falcon."}
439
+ ],
440
+ stream=True,
441
+ max_tokens=150
442
+ )
443
+ print("Streaming response:")
444
+ full_streamed_content = ""
445
+ for chunk in stream_response:
446
+ if chunk.choices and chunk.choices[0].delta and chunk.choices[0].delta.content:
447
+ content_piece = chunk.choices[0].delta.content
448
+ print(content_piece, end="", flush=True)
449
+ full_streamed_content += content_piece
450
+ print("\n--- End of Stream ---")
451
+ except Exception as e:
452
+ print(f"Error in streaming example: {e}")