Skip to main content

Take large input or read a file and send it in chunks to ChatGPT.

Project description

chatgptmax

PyPI Version Python Version License

A Python package for sending long input text to OpenAI's GPT models using message chunking.

Read the blog post that inspired this project.

Installation

You can install chatgptmax using pip:

pip install chatgptmax

Usage

Here's are basic usage examples of the chatgptmax module. This assumes you have an OpenAI API key set up as an environment variable, OPENAI_API_KEY.

You can also try out chatgptmax using the Jupyter notebook provided here.

Clean text with preprocessing

Suppose you have a file named sample.txt with the following content:

This is a sample text. It contains some stop words that should be removed. We will use the chatgptmax module to clean and process this text.

You can use the clean.text_from_file method to read and clean the text from this file:

from chatgptmax import clean

# Specify the path to your file
file_path = "sample.txt"

# Clean and process the text from the file
cleaned_text = clean.text_from_file(file_path)

# Print the cleaned text
print(cleaned_text)

This code will read the content of sample.txt, remove common stopwords, and print the cleaned text:

This sample text contains stop words removed. We chatgptmax module clean process text.

Send lots of text to ChatGPT

You can use the send function to send a prompt along with a large amount of text data from a file to ChatGPT:

from chatgptmax import send, read_data

# Define the path to your text file
file_path = "path_to_your_file.txt"

# Read the text data from the file
text_data = read_data(file_path)

# Define your prompt
prompt_text = "Summarize the following text for me:"

# Send the text data to ChatGPT for summarization
responses = send(prompt=prompt_text, text_data=text_data)

# Print ChatGPT's responses
for response in responses:
    print(response)

This code will send the cleaned text as text data to ChatGPT along with the prompt. ChatGPT will provide responses based on your prompt and text data.

Please make sure you have your OpenAI API key properly set up as an environment variable or using a secret management service for this example to work.

For more examples and instructions, read the documentation

Documentation

For more information on how to use chatgptmax, please refer to the official documentation.

Contributing

If you'd like to contribute to this project, please read our Contribution Guide for details on how to get started.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chatgptmax-1.1.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

chatgptmax-1.1.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file chatgptmax-1.1.1.tar.gz.

File metadata

  • Download URL: chatgptmax-1.1.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for chatgptmax-1.1.1.tar.gz
Algorithm Hash digest
SHA256 bbdb8169728f9d5c969c3d58d734e193cf5bf7f55d3837fb8eaa996888aacab1
MD5 f7a4f2f6a2a7def5ecc1ba0325b1b61e
BLAKE2b-256 3bab135a9081ddd3960c1597af1d89a81a71a708c2c8dca283f975b741ac24db

See more details on using hashes here.

File details

Details for the file chatgptmax-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: chatgptmax-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for chatgptmax-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 97b245cfe7d5a9b39b4c08959270c25b97f04e7a635558fdb2d48e729b06bb77
MD5 30bf499a6bb53efe3036a35f8761b063
BLAKE2b-256 e513a2d6db5340ac6dba03ab3be27a9e45af794989a92cba164fc483efe8f960

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page