>>> import pytgpt.phind as phind
>>> bot = phind.PHIND()
>>> bot.chat('hello there')
'Hello! How can I assist you today?'
from pytgpt.imager import Imager
img = Imager()
generated_images = img.generate(prompt="Cyberpunk", amount=3, stream=True)
img.save(generated_images)
This project enables seamless interaction with over 45 free LLM providers without requiring an API Key and generating images as well.
The name python-tgpt draws inspiration from its parent project tgpt, which operates on Golang. Through this Python adaptation, users can effortlessly engage with a number of free LLMs available, fostering a smoother AI interaction experience.
- 🐍 Python package
- 🌐 FastAPI for web integration
- ⌨️ Command-line interface
- 🧠 Multiple LLM providers - 45+
- 🌊 Stream and non-stream response
- 🚀 Ready to use (No API key required)
- 🎯 Customizable script generation and execution
- 🔌 Offline support for Large Language Models
- 🎨 Image generation capabilities
- ⛓️ Chained requests via proxy
- 🗨️ Enhanced conversational chat experience
- 💾 Capability to save prompts and responses (Conversation)
- 🔄 Ability to load previous conversations
- 🤖 Pass awesome-chatgpt prompts easily
These are simply the hosts of the LLMs, which include:
- Leo - Brave
- Koboldai
- OpenGPTs
- OpenAI (API key required)
- WebChatGPT - OpenAI (Session ID required)
- Gemini - Google (Session ID required)
- Phind
- Llama2
- Blackboxai
- gpt4all (Offline)
- Poe - Poe|Quora (Session ID required)
- Groq (API Key required)
- Perplexity
- YepChat
41+ providers proudly offered by gpt4free.
- To list working providers run:
$ pytgpt gpt4free test -y
- Python>=3.10 (Optional)
Download binaries for your system from here.
Alternatively, you can install non-binaries. (Recommended)
-
Developers:
pip install --upgrade python-tgpt
-
Commandline:
pip install --upgrade "python-tgpt[cli]"
-
Full installation:
pip install --upgrade "python-tgpt[all]"
pip install -U "python-tgt[api]"
will install REST API dependencies.
This package offers a convenient command-line interface.
Note
phind
is the default provider.
-
For a quick response:
python -m pytgpt generate "<Your prompt>"
-
For interactive mode:
python -m pytgpt interactive "<Kickoff prompt (though not mandatory)>"
Make use of flag --provider
followed by the provider name of your choice. e.g --provider koboldai
To list all providers offered by gpt4free, use following commands:
pytgpt gpt4free list providers
You can also simply use pytgpt
instead of python -m pytgpt
.
Starting from version 0.2.7, running $ pytgpt
without any other command or option will automatically enter the interactive
mode. Otherwise, you'll need to explicitly declare the desired action, for example, by running $ pytgpt generate
.
- Generate a quick response
from pytgpt.leo import LEO
bot = LEO()
resp = bot.chat('<Your prompt>')
print(resp)
# Output : How may I help you.
- Get back whole response
from pytgpt.leo import LEO
bot = LEO()
resp = bot.ask('<Your Prompt')
print(resp)
# Output
"""
{'completion': "I'm so excited to share with you the incredible experiences...", 'stop_reason': None, 'truncated': False, 'stop': None, 'model': 'llama-2-13b-chat', 'log_id': 'cmpl-3NmRt5A5Djqo2jXtXLBwJ2', 'exception': None}
"""
Just add parameter stream
with value true
.
- Text Generated only
from pytgpt.leo import LEO
bot = LEO()
resp = bot.chat('<Your prompt>', stream=True)
for value in resp:
print(value)
# output
"""
How may
How may I help
How may I help you
How may I help you today?
"""
- Whole Response
from pytgpt.leo import LEO
bot = LEO()
resp = bot.ask('<Your Prompt>', stream=True)
for value in resp:
print(value)
# Output
"""
{'completion': "I'm so", 'stop_reason': None, 'truncated': False, 'stop': None, 'model': 'llama-2-13b-chat', 'log_id': 'cmpl-3NmRt5A5Djqo2jXtXLBwxx', 'exception': None}
{'completion': "I'm so excited to share with.", 'stop_reason': None, 'truncated': False, 'stop': None, 'model': 'llama-2-13b-chat', 'log_id': 'cmpl-3NmRt5A5Djqo2jXtXLBwxx', 'exception': None}
{'completion': "I'm so excited to share with you the incredible ", 'stop_reason': None, 'truncated': False, 'stop': None, 'model': 'llama-2-13b-chat', 'log_id': 'cmpl-3NmRt5A5Djqo2jXtXLBwxx', 'exception': None}
{'completion': "I'm so excited to share with you the incredible experiences...", 'stop_reason': None, 'truncated': False, 'stop': None, 'model': 'llama-2-13b-chat', 'log_id': 'cmpl-3NmRt5A5Djqo2jXtXLBwxx', 'exception': None}
"""
Auto - *(selects any working provider)*
import pytgpt.auto import auto
bot = auto.AUTO()
print(bot.chat("<Your-prompt>"))
Openai
import pytgpt.openai as openai
bot = openai.OPENAI("<OPENAI-API-KEY>")
print(bot.chat("<Your-prompt>"))
Koboldai
import pytgpt.koboldai as koboldai
bot = koboldai.KOBOLDAI()
print(bot.chat("<Your-prompt>"))
Opengpt
import pytgpt.opengpt as opengpt
bot = opengpt.OPENGPT()
print(bot.chat("<Your-prompt>"))
phind
import pytgpt.phind as phind
bot = phind.PHIND()
print(bot.chat("<Your-prompt>"))
Gpt4free providers
import pytgpt.gpt4free as gpt4free
bot = gpt4free.GPT4FREE(provider="Koala")
print(bot.chat("<Your-prompt>"))
To obtain more tailored responses, consider utilizing optimizers using the optimizer
parameter. Its values can be set to either code
or system_command
.
optimizer
parameter. Its values can be set to either code
or system_command
.from pytgpt.leo import LEO
bot = LEO()
resp = bot.ask('<Your Prompt>', optimizer='code')
print(resp)
Important
Commencing from v0.1.0, the default mode of interaction is conversational. This mode enhances the interactive experience, offering better control over the chat history. By associating previous prompts and responses, it tailors conversations for a more engaging experience.
You can still disable the mode:
bot = koboldai.KOBOLDAI(is_conversation=False)
Utilize the --disable-conversation
flag in the console to achieve the same functionality.
Caution
Bard autohandles context due to the obvious reason; the is_conversation
parameter is not necessary at all hence not required when initializing the class. Also be informed that majority of providers offered by gpt4free requires Google Chrome inorder to function.
This has been made possible by pollinations.ai.
$ pytgpt imager "<prompt>"
# e.g pytgpt imager "Coding bot"
Developers
from pytgpt.imager import Imager
img = Imager()
generated_img = img.generate('Coding bot') # [bytes]
img.save(generated_img)
Download Multiple Images
from pytgpt.imager import Imager
img = Imager()
img_generator = img.generate('Coding bot', amount=3, stream=True)
img.save(img_generator)
# RAM friendly
from pytgpt.imager import Prodia
img = Prodia()
img_generator = img.generate('Coding bot', amount=3, stream=True)
img.save(img_generator)
The generate
functionality has been enhanced starting from v0.3.0 to enable comprehensive utilization of the --with-copied
option and support for accepting piped inputs. This improvement introduces placeholders, offering dynamic values for more versatile interactions.
Placeholder | Represents |
---|---|
{{stream}} |
The piped input |
{{copied}} |
The last copied text |
This feature is particularly beneficial for intricate operations. For example:
$ git diff | pytgpt generate "Here is a diff file: {{stream}} Make a concise commit message from it, aligning with my commit message history: {{copied}}" --shell --new
In this illustration,
{{stream}}
denotes the result of the$ git diff
operation, while{{copied}}
signifies the content copied from the output of the$ git log
command.
These prompts are designed to guide the AI's behavior or responses in a particular direction, encouraging it to exhibit certain characteristics or behaviors. The term "awesome-prompt" is not a formal term in AI or machine learning literature, but it encapsulates the idea of crafting prompts that are effective in achieving desired outcomes. Let's say you want it to behave like a Linux Terminal, PHP Interpreter, or just to JAIL BREAK.
Instances :
$ pytgpt interactve --awesome-prompt "Linux Terminal"
# Act like a Linux Terminal
$ pytgpt interactive -ap DAN
# Jailbreak
Note
Awesome prompts are alternative to --intro
.
Run $ pytgpt awesome whole
to list available prompts (200+).
Run $ pytgpt awesome --help
for more info.
RawDog is a masterpiece feature that exploits the versatile capabilities of Python to command and control your system as per your needs. You can literally do anything with it, since it generates and executes python codes, driven by your prompts! To have a bite of rawdog simply append the flag --rawdog
shortform -rd
in generate/interactive mode. This introduces a never seen-before feature in the tgpt ecosystem. Thanks to AbanteAI/rawdog for the idea.
This can be useful in some ways. For instance :
$ pytgpt generate -n -q "Visualize the disk usage using pie chart" --rawdog
This will pop up a window showing system disk usage as shown below.
Pytgpt v0.4.6 introduces a convention way of taking variables from the environment.
To achieve that, set the environment variables in your operating system or script with prefix PYTGPT_
followed by the option name in uppercase, replacing dashes with underscores.
For example, for the option --provider
, you would set an environment variable PYTGPT_PROVIDER
to provide a default value for that option. Same case applies to boolean flags such as --rawdog
whose environment variable will be PYTGPT_RAWDOG
with value being either true/false
. Finally, --awesome-prompt
will take the environment variable PYTGPT_AWESOME_PROMPT
.
Note
This is NOT limited to any command
The environment variables can be overridden by explicitly declaring new value.
Tip
Save the variables in a .env
file in your current directory or export them in your ~/.zshrc
file.
To load previous conversations from a .txt
file, use the -fp
or --filepath
flag. If no flag is passed, the default one will be used. To load context from a file without altering its content, use the --retain-file
flag.
Version 0.4.6 also introduces dynamic provider called g4fauto
, which represents the fastest working g4f-based provider.
Tip
To launch web interface for g4f-based providers simply run $ pytgpt gpt4free gui
.
$ pytgpt api run
will start the REST-API. Access docs and redoc at /docs and /redoc respectively.
To launch the web interface for g4f-based providers, execute the following command in your terminal:
$ pytgpt gpt4free gui
This command initializes the Web-user interface for interacting with g4f-based providers.
To start the REST-API:
$ pytgpt api run
This command starts the RESTful API server, enabling you to interact with the service programmatically.
For accessing the documentation and redoc, navigate to the following paths in your web browser:
- Documentation:
*/docs
- ReDoc:
*/redoc
To enable speech synthesis of responses, ensure you have either the VLC player installed on your system or, if you are a Termux user, the Termux:API package.
To activate speech synthesis, use the --talk-to-me
flag or its shorthand -ttm
when running your commands. For example:
$ pytgpt generate "Generate an ogre story" --talk-to-me
or
$ pytgpt interactive -ttm
This flag instructs the system to audiolize the ai responses and then play them, enhancing the user experience by providing auditory feedback.
To speech synthesise the responses just ensure you have vlc player in your system or termux-api for the case of Termux users. Use the flag
--talk-to-me
, shortform-ttm
.
Version 0.6.4 introduces another dynamic provider, auto
, which denotes the working provider overall. This relieves you of the workload of manually checking a working provider each time you fire up pytgpt.
For more usage info run $ pytgpt --help
$ pytgpt --help
Usage: pytgpt [OPTIONS] COMMAND [ARGS]...
Options:
-v, --version Show the version and exit.
-h, --help Show this message and exit.
Commands:
api FastAPI control endpoint
awesome Perform CRUD operations on awesome-prompts
generate Generate a quick response with AI
gpt4free Discover gpt4free models, providers etc
imager Generate images with pollinations.ai
interactive Chat with AI interactively (Default)
utils Utility endpoint for pytgpt
webchatgpt Reverse Engineered ChatGPT Web-Version
No. | API | Status |
---|---|---|
1. | On-render | cron-job |