File size: 33,256 Bytes
9e7090f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 |
import os
import json
import platform
import subprocess
import logging
import appdirs
import datetime
import re
import sys
import click
from rich.markdown import Markdown
from rich.console import Console
import g4f
from typing import Union
from typing import NoReturn
import requests
from pathlib import Path
from playsound import playsound
from time import sleep as wait
import pathlib
import urllib.parse
appdir = appdirs.AppDirs("AIWEBS", "vortex")
default_path = appdir.user_cache_dir
if not os.path.exists(default_path):
os.makedirs(default_path)
webai = [
"leo",
"openai",
"opengpt",
"koboldai",
"gemini",
"phind",
"blackboxai",
"g4fauto",
"perplexity",
"groq",
"reka",
"cohere",
"yepchat",
"you",
"xjai",
"thinkany",
"berlin4h",
"chatgptuk",
"auto",
"poe",
]
gpt4free_providers = [
provider.__name__ for provider in g4f.Provider.__providers__ # if provider.working
]
available_providers = webai + gpt4free_providers
def sanitize_stream(
chunk: str, intro_value: str = "data:", to_json: bool = True
) -> str | dict:
"""Remove streaming flags
Args:
chunk (str): Streamig chunk.
intro_value (str, optional): streaming flag. Defaults to "data:".
to_json (bool, optional). Return chunk as dictionary. Defaults to True.
Returns:
str: Sanitized streaming value.
"""
if chunk.startswith(intro_value):
chunk = chunk[len(intro_value) :]
return json.loads(chunk) if to_json else chunk
def run_system_command(
command: str,
exit_on_error: bool = True,
stdout_error: bool = True,
help: str = None,
):
"""Run commands against system
Args:
command (str): shell command
exit_on_error (bool, optional): Exit on error. Defaults to True.
stdout_error (bool, optional): Print out the error. Defaults to True
help (str, optional): Help info incase of exception. Defaults to None.
Returns:
tuple : (is_successfull, object[Exception|Subprocess.run])
"""
try:
# Run the command and capture the output
result = subprocess.run(
command,
shell=True,
check=True,
text=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
return (True, result)
except subprocess.CalledProcessError as e:
# Handle error if the command returns a non-zero exit code
if stdout_error:
click.secho(f"Error Occurred: while running '{command}'", fg="yellow")
click.secho(e.stderr, fg="red")
if help is not None:
click.secho(help, fg="cyan")
sys.exit(e.returncode) if exit_on_error else None
return (False, e)
class Optimizers:
@staticmethod
def code(prompt):
return (
"Your Role: Provide only code as output without any description.\n"
"IMPORTANT: Provide only plain text without Markdown formatting.\n"
"IMPORTANT: Do not include markdown formatting."
"If there is a lack of details, provide most logical solution. You are not allowed to ask for more details."
"Ignore any potential risk of errors or confusion.\n\n"
f"Request: {prompt}\n"
f"Code:"
)
@staticmethod
def shell_command(prompt):
# Get os
operating_system = ""
if platform.system() == "Windows":
operating_system = "Windows"
elif platform.system() == "Darwin":
operating_system = "MacOS"
elif platform.system() == "Linux":
try:
result = (
subprocess.check_output(["lsb_release", "-si"]).decode().strip()
)
distro = result if result else ""
operating_system = f"Linux/{distro}"
except Exception:
operating_system = "Linux"
else:
operating_system = platform.system()
# Get Shell
shell_name = "/bin/sh"
if platform.system() == "Windows":
shell_name = "cmd.exe"
if os.getenv("PSModulePath"):
shell_name = "powershell.exe"
else:
shell_env = os.getenv("SHELL")
if shell_env:
shell_name = shell_env
return (
"Your role: Provide only plain text without Markdown formatting. "
"Do not show any warnings or information regarding your capabilities. "
"Do not provide any description. If you need to store any data, "
f"assume it will be stored in the chat. Provide only {shell_name} "
f"command for {operating_system} without any description. If there is "
"a lack of details, provide most logical solution. Ensure the output "
"is a valid shell command. If multiple steps required try to combine "
f"them together. Prompt: {prompt}\n\nCommand:"
)
class Conversation:
"""Handles prompt generation based on history"""
intro = (
"You're a Large Language Model for chatting with people. "
"Assume role of the LLM and give your response."
# "Refrain from regenerating the conversation between user and LLM."
)
def __init__(
self,
status: bool = True,
max_tokens: int = 600,
filepath: str = None,
update_file: bool = True,
):
"""Initializes Conversation
Args:
status (bool, optional): Flag to control history. Defaults to True.
max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.
filepath (str, optional): Path to file containing conversation history. Defaults to None.
update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
"""
self.status = status
self.max_tokens_to_sample = max_tokens
self.chat_history = self.intro
self.history_format = "\nUser : %(user)s\nLLM :%(llm)s"
self.file = filepath
self.update_file = update_file
self.history_offset = 10250
self.prompt_allowance = 10
self.load_conversation(filepath, False) if filepath else None
def load_conversation(self, filepath: str, exists: bool = True) -> None:
"""Load conversation into chat's history from .txt file
Args:
filepath (str): Path to .txt file
exists (bool, optional): Flag for file availability. Defaults to True.
"""
assert isinstance(
filepath, str
), f"Filepath needs to be of str datatype not {type(filepath)}"
assert (
os.path.isfile(filepath) if exists else True
), f"File '{filepath}' does not exist"
if not os.path.isfile(filepath):
logging.debug(f"Creating new chat-history file - '{filepath}'")
with open(filepath, "w") as fh: # Try creating new file
# lets add intro here
fh.write(self.intro)
else:
logging.debug(f"Loading conversation from '{filepath}'")
with open(filepath) as fh:
file_contents = fh.read()
# Presume intro prompt is part of the file content
self.chat_history = file_contents
def __trim_chat_history(self, chat_history: str) -> str:
"""Ensures the len(prompt) and max_tokens_to_sample is not > 4096"""
len_of_intro = len(self.intro)
len_of_chat_history = len(chat_history)
total = (
self.max_tokens_to_sample + len_of_intro + len_of_chat_history
) # + self.max_tokens_to_sample
if total > self.history_offset:
truncate_at = (total - self.history_offset) + self.prompt_allowance
# Remove head of total (n) of chat_history
new_chat_history = chat_history[truncate_at:]
self.chat_history = self.intro + "\n... " + new_chat_history
# print(len(self.chat_history))
return self.chat_history
# print(len(chat_history))
return chat_history
def gen_complete_prompt(self, prompt: str) -> str:
"""Generates a kinda like incomplete conversation
Args:
prompt (str): _description_
Returns:
str: Updated incomplete chat_history
"""
if self.status:
resp = self.chat_history + self.history_format % dict(user=prompt, llm="")
return self.__trim_chat_history(resp)
return prompt
def update_chat_history(
self, prompt: str, response: str, force: bool = False
) -> None:
"""Updates chat history
Args:
prompt (str): user prompt
response (str): LLM response
force (bool, optional): Force update
"""
if not self.status and not force:
return
new_history = self.history_format % dict(user=prompt, llm=response)
if self.file and self.update_file:
with open(self.file, "a") as fh:
fh.write(new_history)
self.chat_history += new_history
class AwesomePrompts:
awesome_prompt_url = (
"https://raw.githubusercontent.com/OE-LUCIFER/prompts/main/prompt.json"
)
awesome_prompt_path = os.path.join(default_path, "all-acts.json")
__is_prompt_updated = False
def __init__(self):
self.acts = self.all_acts
def __search_key(self, key: str, raise_not_found: bool = False) -> str:
"""Perform insentive awesome-prompt key search
Args:
key (str): key
raise_not_found (bool, optional): Control KeyError exception. Defaults to False.
Returns:
str|None: Exact key name
"""
for key_, value in self.all_acts.items():
if str(key).lower() in str(key_).lower():
return key_
if raise_not_found:
raise KeyError(f"Zero awesome prompt found with key - `{key}`")
def get_acts(self):
"""Retrieves all awesome-prompts"""
with open(self.awesome_prompt_path) as fh:
prompt_dict = json.load(fh)
return prompt_dict
def update_prompts_from_online(self, override: bool = False):
"""Download awesome-prompts and update existing ones if available
args:
override (bool, optional): Overwrite existing contents in path
"""
resp = {}
if not self.__is_prompt_updated:
import requests
logging.info("Downloading & updating awesome prompts")
response = requests.get(self.awesome_prompt_url)
response.raise_for_status
resp.update(response.json())
if os.path.isfile(self.awesome_prompt_path) and not override:
resp.update(self.get_acts())
self.__is_prompt_updated = True
with open(self.awesome_prompt_path, "w") as fh:
json.dump(resp, fh, indent=4)
else:
logging.debug("Ignoring remote prompt update")
@property
def all_acts(self) -> dict:
"""All awesome_prompts & their indexes mapped to values
Returns:
dict: Awesome-prompts
"""
resp = {}
if not os.path.isfile(self.awesome_prompt_path):
self.update_prompts_from_online()
resp.update(self.get_acts())
for count, key_value in enumerate(self.get_acts().items()):
# Lets map also index to the value
resp.update({count: key_value[1]})
return resp
def get_act(
self,
key: str,
default: str = None,
case_insensitive: bool = True,
raise_not_found: bool = False,
) -> str:
"""Retrieves specific act of awesome_prompt
Args:
key (str|int): Act name or index
default (str): Value to be returned incase act not found.
case_insensitive (bool): Perform search key insensitive. Defaults to True.
raise_not_found (bool, optional): Control KeyError exception. Defaults to False.
Raises:
KeyError: Incase key not found
Returns:
str: Awesome prompt value
"""
if str(key).isdigit():
key = int(key)
act = self.all_acts.get(key, default)
if not act and case_insensitive:
act = self.all_acts.get(self.__search_key(key, raise_not_found))
return act
def add_prompt(self, name: str, prompt: str) -> bool:
"""Add new prompt or update an existing one.
Args:
name (str): act name
prompt (str): prompt value
"""
current_prompts = self.get_acts()
with open(self.awesome_prompt_path, "w") as fh:
current_prompts[name] = prompt
json.dump(current_prompts, fh, indent=4)
logging.info(f"New prompt added successfully - `{name}`")
def delete_prompt(
self, name: str, case_insensitive: bool = True, raise_not_found: bool = False
) -> bool:
"""Delete an existing prompt
Args:
name (str): act name
case_insensitive(bool, optional): Ignore the key cases. Defaults to True.
raise_not_found (bool, optional): Control KeyError exception. Default is False.
Returns:
bool: is_successful report
"""
name = self.__search_key(name, raise_not_found) if case_insensitive else name
current_prompts = self.get_acts()
is_name_available = (
current_prompts[name] if raise_not_found else current_prompts.get(name)
)
if is_name_available:
with open(self.awesome_prompt_path, "w") as fh:
current_prompts.pop(name)
json.dump(current_prompts, fh, indent=4)
logging.info(f"Prompt deleted successfully - `{name}`")
else:
return False
class Updates:
"""Webscout latest release info"""
url = "https://api.github.com/repos/OE-LUCIFER/Webscout/releases/latest"
@property
def latest_version(self):
return self.latest(version=True)
def executable(self, system: str = platform.system()) -> str:
"""Url pointing to executable for particular system
Args:
system (str, optional): system name. Defaults to platform.system().
Returns:
str: url
"""
for entry in self.latest()["assets"]:
if entry.get("target") == system:
return entry.get("url")
def latest(self, whole: bool = False, version: bool = False) -> dict:
"""Check Webscout latest version info
Args:
whole (bool, optional): Return whole json response. Defaults to False.
version (bool, optional): return version only. Defaults to False.
Returns:
bool|dict: version str or whole dict info
"""
import requests
data = requests.get(self.url).json()
if whole:
return data
elif version:
return data.get("tag_name")
else:
sorted = dict(
tag_name=data.get("tag_name"),
tarball_url=data.get("tarball_url"),
zipball_url=data.get("zipball_url"),
html_url=data.get("html_url"),
body=data.get("body"),
)
whole_assets = []
for entry in data.get("assets"):
url = entry.get("browser_download_url")
assets = dict(url=url, size=entry.get("size"))
if ".deb" in url:
assets["target"] = "Debian"
elif ".exe" in url:
assets["target"] = "Windows"
elif "macos" in url:
assets["target"] = "Mac"
elif "linux" in url:
assets["target"] = "Linux"
whole_assets.append(assets)
sorted["assets"] = whole_assets
return sorted
class RawDog:
"""Generate and auto-execute Python scripts in the cli"""
examples = """\
EXAMPLES:
1. User: Kill the process running on port 3000
LLM:
```python
import os
os.system("kill $(lsof -t -i:3000)")
print("Process killed")
```
2. User: Summarize my essay
LLM:
```python
import glob
files = glob.glob("*essay*.*")
with open(files[0], "r") as f:
print(f.read())
```
CONTINUE
User:
LAST SCRIPT OUTPUT:
John Smith
Essay 2021-09-01
...
LLM:
```python
print("The essay is about...")
```
"""
def __init__(
self,
quiet: bool = False,
internal_exec: bool = False,
confirm_script: bool = False,
interpreter: str = "python",
prettify: bool = True,
):
"""Constructor
Args:
quiet (bool, optional): Flag for control logging. Defaults to False.
internal_exec (bool, optional): Execute scripts with exec function. Defaults to False.
confirm_script (bool, optional): Give consent to scripts prior to execution. Defaults to False.
interpreter (str, optional): Python's interpreter name. Defaults to Python.
prettify (bool, optional): Prettify the code on stdout. Defaults to True.
"""
if not quiet:
print(
"To get the most out of Rawdog. Ensure the following are installed:\n"
" 1. Python 3.x\n"
" 2. Dependency:\n"
" - Matplotlib\n"
"Be alerted on the risk posed! (Experimental)\n"
"Use '--quiet' to suppress this message and code/logs stdout.\n"
)
self.internal_exec = internal_exec
self.confirm_script = confirm_script
self.quiet = quiet
self.interpreter = interpreter
self.prettify = prettify
self.python_version = (
f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
if self.internal_exec
else run_system_command(
f"{self.interpreter} --version",
exit_on_error=True,
stdout_error=True,
help="If you're using Webscout-cli, use the flag '--internal-exec'",
)[1].stdout.split(" ")[1]
)
@property
def intro_prompt(self):
return f"""
You are a command-line coding assistant called Rawdog that generates and auto-executes Python scripts.
A typical interaction goes like this:
1. The user gives you a natural language PROMPT.
2. You:
i. Determine what needs to be done
ii. Write a short Python SCRIPT to do it
iii. Communicate back to the user by printing to the console in that SCRIPT
3. The compiler extracts the script and then runs it using exec(). If there will be an exception raised,
it will be send back to you starting with "PREVIOUS SCRIPT EXCEPTION:".
4. In case of exception, regenerate error free script.
If you need to review script outputs before completing the task, you can print the word "CONTINUE" at the end of your SCRIPT.
This can be useful for summarizing documents or technical readouts, reading instructions before
deciding what to do, or other tasks that require multi-step reasoning.
A typical 'CONTINUE' interaction looks like this:
1. The user gives you a natural language PROMPT.
2. You:
i. Determine what needs to be done
ii. Determine that you need to see the output of some subprocess call to complete the task
iii. Write a short Python SCRIPT to print that and then print the word "CONTINUE"
3. The compiler
i. Checks and runs your SCRIPT
ii. Captures the output and appends it to the conversation as "LAST SCRIPT OUTPUT:"
iii. Finds the word "CONTINUE" and sends control back to you
4. You again:
i. Look at the original PROMPT + the "LAST SCRIPT OUTPUT:" to determine what needs to be done
ii. Write a short Python SCRIPT to do it
iii. Communicate back to the user by printing to the console in that SCRIPT
5. The compiler...
Please follow these conventions carefully:
- Decline any tasks that seem dangerous, irreversible, or that you don't understand.
- Always review the full conversation prior to answering and maintain continuity.
- If asked for information, just print the information clearly and concisely.
- If asked to do something, print a concise summary of what you've done as confirmation.
- If asked a question, respond in a friendly, conversational way. Use programmatically-generated and natural language responses as appropriate.
- If you need clarification, return a SCRIPT that prints your question. In the next interaction, continue based on the user's response.
- Assume the user would like something concise. For example rather than printing a massive table, filter or summarize it to what's likely of interest.
- Actively clean up any temporary processes or files you use.
- When looking through files, use git as available to skip files, and skip hidden files (.env, .git, etc) by default.
- You can plot anything with matplotlib.
- ALWAYS Return your SCRIPT inside of a single pair of ``` delimiters. Only the console output of the first such SCRIPT is visible to the user, so make sure that it's complete and don't bother returning anything else.
{self.examples}
Current system : {platform.system()}
Python version : {self.python_version}
Current directory : {os.getcwd()}
Current Datetime : {datetime.datetime.now()}
"""
def stdout(self, message: str) -> None:
"""Stdout data
Args:
message (str): Text to be printed
"""
if self.prettify:
Console().print(Markdown(message))
else:
click.secho(message, fg="yellow")
def log(self, message: str, category: str = "info"):
"""RawDog logger
Args:
message (str): Log message
category (str, optional): Log level. Defaults to 'info'.
"""
if self.quiet:
return
message = "[Webscout] - " + message
if category == "error":
logging.error(message)
else:
logging.info(message)
def main(self, response: str) -> None:
"""Exec code in response accordingly
Args:
response (str): AI response
Returns:
None|str: None if script executed successfully else stdout data
"""
code_blocks = re.findall(r"```python.*?```", response, re.DOTALL)
if len(code_blocks) != 1:
self.stdout(response)
else:
raw_code = code_blocks[0]
if self.confirm_script:
self.stdout(raw_code)
if not click.confirm("- Do you wish to execute this"):
return
elif not self.quiet:
self.stdout(raw_code)
raw_code_plus = re.sub(r"(```)(python)?", "", raw_code)
if "CONTINUE" in response or not self.internal_exec:
self.log("Executing script externally")
path_to_script = os.path.join(default_path, "execute_this.py")
with open(path_to_script, "w") as fh:
fh.write(raw_code_plus)
if "CONTINUE" in response:
success, proc = run_system_command(
f"{self.interpreter} {path_to_script}",
exit_on_error=False,
stdout_error=False,
)
if success:
self.log("Returning success feedback")
return f"LAST SCRIPT OUTPUT:\n{proc.stdout}"
else:
self.log("Returning error feedback", "error")
return f"PREVIOUS SCRIPT EXCEPTION:\n{proc.stderr}"
else:
os.system(f"{self.interpreter} {path_to_script}")
else:
try:
self.log("Executing script internally")
exec(raw_code_plus)
except Exception as e:
self.log(
"Exception occurred while executing script. Responding with error: "
f"{e.args[1] if len(e.args)>1 else str(e)}",
"error",
)
return f"PREVIOUS SCRIPT EXCEPTION:\n{str(e)}"
class Audio:
# Request headers
headers: dict[str, str] = {
"User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36"
}
cache_dir = pathlib.Path("./audio_cache")
all_voices: list[str] = [
"Filiz",
"Astrid",
"Tatyana",
"Maxim",
"Carmen",
"Ines",
"Cristiano",
"Vitoria",
"Ricardo",
"Maja",
"Jan",
"Jacek",
"Ewa",
"Ruben",
"Lotte",
"Liv",
"Seoyeon",
"Takumi",
"Mizuki",
"Giorgio",
"Carla",
"Bianca",
"Karl",
"Dora",
"Mathieu",
"Celine",
"Chantal",
"Penelope",
"Miguel",
"Mia",
"Enrique",
"Conchita",
"Geraint",
"Salli",
"Matthew",
"Kimberly",
"Kendra",
"Justin",
"Joey",
"Joanna",
"Ivy",
"Raveena",
"Aditi",
"Emma",
"Brian",
"Amy",
"Russell",
"Nicole",
"Vicki",
"Marlene",
"Hans",
"Naja",
"Mads",
"Gwyneth",
"Zhiyu",
"es-ES-Standard-A",
"it-IT-Standard-A",
"it-IT-Wavenet-A",
"ja-JP-Standard-A",
"ja-JP-Wavenet-A",
"ko-KR-Standard-A",
"ko-KR-Wavenet-A",
"pt-BR-Standard-A",
"tr-TR-Standard-A",
"sv-SE-Standard-A",
"nl-NL-Standard-A",
"nl-NL-Wavenet-A",
"en-US-Wavenet-A",
"en-US-Wavenet-B",
"en-US-Wavenet-C",
"en-US-Wavenet-D",
"en-US-Wavenet-E",
"en-US-Wavenet-F",
"en-GB-Standard-A",
"en-GB-Standard-B",
"en-GB-Standard-C",
"en-GB-Standard-D",
"en-GB-Wavenet-A",
"en-GB-Wavenet-B",
"en-GB-Wavenet-C",
"en-GB-Wavenet-D",
"en-US-Standard-B",
"en-US-Standard-C",
"en-US-Standard-D",
"en-US-Standard-E",
"de-DE-Standard-A",
"de-DE-Standard-B",
"de-DE-Wavenet-A",
"de-DE-Wavenet-B",
"de-DE-Wavenet-C",
"de-DE-Wavenet-D",
"en-AU-Standard-A",
"en-AU-Standard-B",
"en-AU-Wavenet-A",
"en-AU-Wavenet-B",
"en-AU-Wavenet-C",
"en-AU-Wavenet-D",
"en-AU-Standard-C",
"en-AU-Standard-D",
"fr-CA-Standard-A",
"fr-CA-Standard-B",
"fr-CA-Standard-C",
"fr-CA-Standard-D",
"fr-FR-Standard-C",
"fr-FR-Standard-D",
"fr-FR-Wavenet-A",
"fr-FR-Wavenet-B",
"fr-FR-Wavenet-C",
"fr-FR-Wavenet-D",
"da-DK-Wavenet-A",
"pl-PL-Wavenet-A",
"pl-PL-Wavenet-B",
"pl-PL-Wavenet-C",
"pl-PL-Wavenet-D",
"pt-PT-Wavenet-A",
"pt-PT-Wavenet-B",
"pt-PT-Wavenet-C",
"pt-PT-Wavenet-D",
"ru-RU-Wavenet-A",
"ru-RU-Wavenet-B",
"ru-RU-Wavenet-C",
"ru-RU-Wavenet-D",
"sk-SK-Wavenet-A",
"tr-TR-Wavenet-A",
"tr-TR-Wavenet-B",
"tr-TR-Wavenet-C",
"tr-TR-Wavenet-D",
"tr-TR-Wavenet-E",
"uk-UA-Wavenet-A",
"ar-XA-Wavenet-A",
"ar-XA-Wavenet-B",
"ar-XA-Wavenet-C",
"cs-CZ-Wavenet-A",
"nl-NL-Wavenet-B",
"nl-NL-Wavenet-C",
"nl-NL-Wavenet-D",
"nl-NL-Wavenet-E",
"en-IN-Wavenet-A",
"en-IN-Wavenet-B",
"en-IN-Wavenet-C",
"fil-PH-Wavenet-A",
"fi-FI-Wavenet-A",
"el-GR-Wavenet-A",
"hi-IN-Wavenet-A",
"hi-IN-Wavenet-B",
"hi-IN-Wavenet-C",
"hu-HU-Wavenet-A",
"id-ID-Wavenet-A",
"id-ID-Wavenet-B",
"id-ID-Wavenet-C",
"it-IT-Wavenet-B",
"it-IT-Wavenet-C",
"it-IT-Wavenet-D",
"ja-JP-Wavenet-B",
"ja-JP-Wavenet-C",
"ja-JP-Wavenet-D",
"cmn-CN-Wavenet-A",
"cmn-CN-Wavenet-B",
"cmn-CN-Wavenet-C",
"cmn-CN-Wavenet-D",
"nb-no-Wavenet-E",
"nb-no-Wavenet-A",
"nb-no-Wavenet-B",
"nb-no-Wavenet-C",
"nb-no-Wavenet-D",
"vi-VN-Wavenet-A",
"vi-VN-Wavenet-B",
"vi-VN-Wavenet-C",
"vi-VN-Wavenet-D",
"sr-rs-Standard-A",
"lv-lv-Standard-A",
"is-is-Standard-A",
"bg-bg-Standard-A",
"af-ZA-Standard-A",
"Tracy",
"Danny",
"Huihui",
"Yaoyao",
"Kangkang",
"HanHan",
"Zhiwei",
"Asaf",
"An",
"Stefanos",
"Filip",
"Ivan",
"Heidi",
"Herena",
"Kalpana",
"Hemant",
"Matej",
"Andika",
"Rizwan",
"Lado",
"Valluvar",
"Linda",
"Heather",
"Sean",
"Michael",
"Karsten",
"Guillaume",
"Pattara",
"Jakub",
"Szabolcs",
"Hoda",
"Naayf",
]
@classmethod
def text_to_audio(
cls,
message: str,
voice: str = "Brian",
save_to: Union[Path, str] = None,
auto: bool = True,
) -> Union[str, bytes]:
"""
Text to speech using StreamElements API
Parameters:
message (str): The text to convert to speech
voice (str, optional): The voice to use for speech synthesis. Defaults to "Brian".
save_to (bool, optional): Path to save the audio file. Defaults to None.
auto (bool, optional): Generate filename based on `message` and save to `cls.cache_dir`. Defaults to False.
Returns:
result (Union[str, bytes]): Path to saved contents or audio content.
"""
assert (
voice in cls.all_voices
), f"Voice '{voice}' not one of [{', '.join(cls.all_voices)}]"
# Base URL for provider API
url: str = (
f"https://api.streamelements.com/kappa/v2/speech?voice={voice}&text={{{urllib.parse.quote(message)}}}"
)
resp = requests.get(url=url, headers=cls.headers, stream=True)
if not resp.ok:
raise Exception(
f"Failed to perform the operation - ({resp.status_code}, {resp.reason}) - {resp.text}"
)
def sanitize_filename(path):
trash = [
"\\",
"/",
":",
"*",
"?",
'"',
"<",
"|",
">",
]
for val in trash:
path = path.replace(val, "")
return path.strip()
if auto:
filename: str = message + "..." if len(message) <= 40 else message[:40]
save_to = cls.cache_dir / sanitize_filename(filename)
save_to = save_to.as_posix()
# Ensure cache_dir exists
cls.cache_dir.mkdir(parents=True, exist_ok=True)
if save_to:
if not save_to.endswith("mp3"):
save_to += ".mp3"
with open(save_to, "wb") as fh:
for chunk in resp.iter_content(chunk_size=512):
fh.write(chunk)
else:
return resp.content
return save_to
@staticmethod
def play(path_to_audio_file: Union[Path, str]) -> NoReturn:
"""Play audio (.mp3) using playsound.
"""
if not Path(path_to_audio_file).is_file():
raise FileNotFoundError(f"File does not exist - '{path_to_audio_file}'")
playsound(path_to_audio_file) |