API Reference (Python)

Compress Context

API Input

def compress_with_context(context: str, compression_mode: Optional[str]="medium") -> Dict[str, Any]:
    """
    Compress a context string using the GoLean API.

    Args:
        context (str): The context string to be compressed.
        compression_mode (Optional[str]): Level of compression. Must be one of "high", "medium", or "low". High compression compresses prompt the most. Defaults to "medium".

    Returns:
        Dict[str, Any]: Contains compressed result, token counts, and compression rate.
    """

API Output

{
    "compressed_result": str,
    "original_tokens": int,
    "compressed_tokens": int,
    "compression_rate": float
}

compressed_result: Compressed context

original_tokens: Number of tokens in the input context.

compressed_tokens: Number of remaining tokens after compression.

compression_rate: compressed_tokens / original_tokens

Compress Prompt Template and Data

API Input

def compress_with_template(template: str, data: Dict[str, Any], compression_mode: Optional[str]="medium") -> Dict[str, Any]:
    """
    Compress a template string by replacing placeholders with compressed values.

    Args:
        template (str): A string containing placeholders (e.g., "{key}").
        data (dict): Key-value pairs where keys match placeholders in the template.
        compression_mode (Optional[str]): Level of compression. Must be one of "high", "medium", or "low". High compression compresses prompt the most. Defaults to "medium".

    Returns:
        Dict[str, Any]: Contains compressed result, token counts, and compression rate.
    """

API Output

{
    "compressed_result": str,
    "original_tokens": int,
    "compressed_tokens": int,
    "compression_rate": float
}

compressed_result: Template with compressed data.

original_tokens: Number of tokens in the input template populated by original data.

compressed_tokens: Number of remaining tokens in the template populated by compressed data.

compression_rate: compressed_tokens / original_tokens