golean 0.1.5

A Python package for interacting with the GoLean API service.

GoLean API Client

GoLean is a powerful Python client for the GoLean API, offering efficient and customizable prompt compression services tailored for Large Language Models (LLMs). Optimize your LLM workflows with our state-of-the-art compression algorithms.

Features

• Efficient Prompt Compression: Optimize LLM performance with customizable compression rates.
• Flexible Model Support: Compatible with a wide range of LLMs from OpenAI, Anthropic, and Cohere.
• Cost Optimization: Reduce token usage for various LLM APIs.
• Secure Authentication: Robust API key-based authentication system.
• Easy Configuration: Seamless setup with support for environment variables.
• Comprehensive Documentation: Detailed guides and API references to get you started quickly.

Installation

Install the GoLean client using pip:

pip install golean

Quick Start

from golean import GoLean

# Initialize the GoLean client
golean = GoLean(api_key="your_api_key")

# Compress a prompt
result = golean.compress_prompt(
    context="The quick brown fox jumps over the lazy dog. The fox is known for its cunning and agility.",
    compression_rate=0.5
)

print(f"Compressed Prompt: {result['compressed_prompt']}")
print(f"Original Number of Tokens: {result['original_tokens']}")
print(f"Compressed tokens: {result['compressed_tokens']}")
print(f"Actual Compression Rate: {result['actual_compression_rate']}")

Usage

Initialization

from golean import GoLean

# Initialize with API key
golean = GoLean(api_key="your_api_key")

# Or, set GOLEAN_API_KEY as an environment variable and initialize without parameters
golean = GoLean()

Compressing Prompts

result = golean.compress_prompt(
    context="Large Language Models (LLMs) are revolutionizing various industries, from content creation to data analysis. These models, trained on vast amounts of text data, can generate human-like text, answer questions, and perform complex language tasks.",
    compression_rate=0.7,
    targetModelName="gpt-4o"
)

print(f"Compressed Prompt: {result['compressed_prompt']}")
print(f"Original Number of Tokens: {result['original_tokens']}")
print(f"Compressed Tokens: {result['compressed_tokens']}")
print(f"Actual Compression Rate: {result['actual_compression_rate']}")

Supported Models

GoLean supports compression optimization for various LLM models:

OpenAI Models

• gpt-3.5-turbo
• gpt-3.5-turbo-16k
• gpt-4-turbo
• gpt-4
• gpt-4o
• gpt-4o-2024-05-13

Anthropic Models

• claude-3-sonnet
• claude-3-opus
• claude-3-haiku

Cohere Models

• command-r

Configuration

API Key

Set your API key using one of these methods:

1. Environment variable:

   export GOLEAN_API_KEY=your_api_key_here
   

2. .env file in your project root:

   GOLEAN_API_KEY=your_api_key_here
   

3. Directly in your code (not recommended for production):

   golean = GoLean(api_key="your_api_key_here")
   

API Reference

GoLean Class

class GoLean:
    def __init__(self, api_key: Optional[str] = None):
        """
        Initialize the GoLean client.

        Args:
            api_key (str, optional): Your GoLean API key. If not provided, reads from GOLEAN_API_KEY env variable.
        """

    def compress_prompt(
        context: str,
        compression_rate: float,
        openai_model_for_token_count: Optional[str] = "gpt-4o",
        target_model_name: Optional[str] = "gpt-4o"
    ) -> Dict[str, Any]:
        """
        Compress a prompt using the GoLean API.

        Args:
            context (str): The context for the prompt.
            compression_rate (float): Desired compression rate (0 < rate <= 1). Default is 0.5.
            openai_model_for_count: (str, optional). This specifies the OpenAI Model used to calculate the number of input and output tokens that will be returned in the API response.
            targetModelName (str, optional):  If a model name is passed, will enable model-specific cost savings tracking for that specific model, summarized in your dashboard.

        Returns:
            Dict[str, Any]: Dictionary containing the compressed prompt and metadata.
        """

For complete API documentation, please refer to our official documentation.

Response Format

The compress_prompt method returns a dictionary with the following keys:

• compressed_context (str): The compressed version of the input context.
• original_tokens (int): The number of tokens in the original prompt.
• compressed_tokens (int): The number of tokens in the compressed prompt.
• actual_compression_rate (str): The achieved compression rate as a percentage.

Support

For technical assistance, please contact our support team:

• Email: [e-mail]
• Documentation: https://docs.golean.ai

For enterprise support options and custom LLM optimization solutions, please contact our sales team at [e-mail].

Legal

Copyright © 2024 GoLean, Inc. All rights reserved.

GoLean is a registered trademark of GoLean, Inc. All other trademarks are the property of their respective owners.

---

Empower your LLMs with GoLean - Compress, Optimize, Succeed.