python-tgpt

>>> 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.

Features

• 🐍 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
• 🎤 Text-to-audio conversion 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
• 🤖 Telegram bot - interface
• 🔄 Asynchronous support for all major operations.

Providers

These are simply the hosts of the LLMs, they include:

• Phind
• Perplexity
• Blackboxai
• Koboldai
• Ai4chat
• gpt4all (Offline)
• Poe - Poe|Quora (Session ID required)
• Groq (API Key required)
• OpenAI (API key required)

41+ providers proudly offered by gpt4free.

• To list working providers run:

  $ pytgpt gpt4free test -y

Prerequisites

• Python>=3.10

Installation and Usage

Installation

1. Developers:

   pip install --upgrade python-tgpt

2. Commandline:

   pip install --upgrade "python-tgpt[cli]"

3. Full installation:

   pip install  --upgrade "python-tgpt[all]"

pip install -U "python-tgt[api]" will install REST API dependencies.

Termux extras

1. Developers:

   pip install --upgrade "python-tgpt[termux]"

2. Commandline:

   pip install --upgrade "python-tgpt[termux-cli]"

3. Full installation:

   pip install  --upgrade "python-tgpt[termux-all]"

pip install -U "python-tgt[termux-api]" will install REST API dependencies

Usage

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.

Developer Docs

1. Generate a quick response

from pytgpt.phind import PHIND
bot = PHIND()
resp = bot.chat('<Your prompt>')
print(resp)
# Output : How can I assist you today?

2. Get back whole response

from pytgpt.phind import PHIND
bot = PHIND()
resp = bot.chat('<Your prompt>')
print(resp)
# Output
"""
{'id': 'chatcmpl-gp6cwu2e5ez3ltoyti4z', 'object': 'chat.completion.chunk', 'created': 1731257890, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': "Hello! I'm an AI assistant created by Phind to help with programming tasks. How can I assist you today?"}, 'finish_reason': None}]}
"""

Stream Response

Just add parameter stream with value true.

1. Text Generated only

from pytgpt.phind import PHIND
bot = PHIND()
response = bot.chat('hello', stream=True)
for chunk in response:
    print(chunk)
# output
"""
Hello
Hello!
Hello! How
Hello! How can
Hello! How can I
Hello! How can I assist
Hello! How can I assist you
Hello! How can I assist you today
Hello! How can I assist you today?
"""

2. Whole Response

from pytgpt.phind import PHIND
bot = PHIND()
resp = bot.ask('<Your Prompt>', stream=True)
for value in resp:
    print(value)
# Output
"""
{'id': 'chatcmpl-icz6a4m1nbbclw9hhgol', 'object': 'chat.completion.chunk', 'created': 1731258032, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': 'Hello'}, 'finish_reason': None}]}
{'id': 'chatcmpl-icz6a4m1nbbclw9hhgol', 'object': 'chat.completion.chunk', 'created': 1731258032, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': "Hello! I'm an AI"}, 'finish_reason': None}]}
{'id': 'chatcmpl-icz6a4m1nbbclw9hhgol', 'object': 'chat.completion.chunk', 'created': 1731258032, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': "Hello! I'm an AI assistant created by Phind to help with coding and technical tasks. How"}, 'finish_reason': None}]}
{'id': 'chatcmpl-icz6a4m1nbbclw9hhgol', 'object': 'chat.completion.chunk', 'created': 1731258032, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': "Hello! I'm an AI assistant created by Phind to help with coding and technical tasks. How can I assist you today?"}, 'finish_reason': 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>"))

Phind

import pytgpt.phind as phind
bot = phind.PHIND()
print(bot.chat("<Your-prompt>"))

Perplexity

import pytgpt.perplexity as perplexity
bot = perplexity.PERPLEXITY()
print(bot.chat("<Your-prompt>"))

Blackboxai

import pytgpt.blackboxai as blackboxai
bot = blackboxai.BLACKBOXAI()
print(bot.chat("<Your-prompt>"))

Gpt4free providers

import pytgpt.gpt4free as gpt4free
bot = gpt4free.GPT4FREE(provider="Koala")
print(bot.chat("<Your-prompt>"))

Asynchronous

Version 0.7.0 introduces asynchronous implementation to almost all providers except a few such as perplexity, which relies on other libraries which lacks such implementation.

To make it easier, you just have to prefix Async to the common synchronous class name. For instance PHIND will be accessed as AsyncPHIND:

Streaming Whole ai response.

import asyncio
from pytgpt.phind import AsyncPHIND

async def main():
    async_ask = await AsyncPHIND(False).ask(
        "Critique that python is cool.",
        stream=True
    )
    async for streaming_response in async_ask:
        print(
            streaming_response
        )

asyncio.run(
    main()
)

Streaming just the text

import asyncio
from pytgpt.phind import AsyncPHIND

async def main():
    async_ask = await AsyncPHIND(False).chat(
        "Critique that python is cool.",
        stream=True
    )
    async for streaming_text in async_ask:
        print(
            streaming_text
        )

asyncio.run(
    main()
)

To obtain more tailored responses, consider utilizing optimizers using the optimizer parameter. Its values can be set to either code or system_command.

from pytgpt.phind import PHIND
bot = PHIND()
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.

Image Generation

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

Using Prodia provider

from pytgpt.imager import Prodia

img = Prodia()

img_generator = img.generate('Coding bot', amount=3, stream=True)

img.save(img_generator)

Advanced Usage of Placeholders

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}}" --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.

Awesome Prompts

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 interactive --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.

Introducing RawDog

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.

Passing Environment Variables

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.

Dynamic Provider & Further Interfaces

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

Speech Synthesis

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.

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. However, auto as a provider does not work so well with streaming responses, so probably you would need to sacrifice performance for the sake of reliability.

Telegram Bot

If you're not satisfied with the existing interfaces, pytgpt-bot could be the solution you're seeking. This bot is designed to enhance your experience by offering a wide range of functionalities. Whether you're interested in engaging in AI-driven conversations, creating images and audio from text, or exploring other innovative features, pytgpt-bot is equipped to meet your needs.

The bot is maintained as a separate project so you just have to execute a command to get it installed :

$ pip install pytgpt-bot

Usage : pytgpt bot run <bot-api-token>

Or you can simply interact with the one running now as @pytgpt-bot

For more usage info run $ 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
  bot          Telegram bot interface control
  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

API Health Status

No.	API	Status
1.	On-render	cron-job

CHANGELOG

Acknowledgements

1. tgpt
2. gpt4free