Skip to main content

Retab official python library

Project description

k-LLMS

Built with 🩷 at retab

k-llms is a wrapper around the OpenAI client that adds consensus functionality through the n_consensus parameter.

Features

  • Drop-in replacement for OpenAI client
  • Adds n_consensus parameter to make multiple parallel requests
  • Automatic result consolidation using majority voting
  • Likelihood computations
  • Support for both sync and async operations
  • Compatible with all OpenAI chat completion parameters
  • Support for structured outputs with parse()

Installation

# The wrapper uses the official OpenAI client
pip install openai
pip install k-llms

Usage

Basic Usage

from k_llms import KLLMs
from openai import OpenAI

# Initialize the client (uses OPENAI_API_KEY env var by default)
kllms_client = KLLMs()

openai_client = OpenAI()

# Make a single request (normal OpenAI behavior)
response = openai_client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello!"}]
)

# Make multiple requests with consensus
consensus_response = kllms_client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "What is 2+2?"}],
    n_consensus=3  # Makes 3 parallel requests and consolidates
)

Structured Outputs with Parse

from pydantic import BaseModel

class UserInfo(BaseModel):
    name: str
    age: int

# Single parse request
result = openai_client.chat.completions.parse(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "John is 30 years old"}],
    response_format=UserInfo
)

# Multiple parse requests with consensus
result = kllms_client.chat.completions.parse(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "John is 30 years old"}],
    response_format=UserInfo,
    n_consensus=3
)

# Access consolidated result
consensus_user = result.choices[0].message.parsed  # Consolidated UserInfo object
original_users = [choice.message.parsed for choice in result.choices[1:]]  # Original results

Async Usage

from k_llms import AsyncKLLMs
from openai import AsyncOpenAI
import asyncio

async def main():
    kllms_client = AsyncKLLMs()
    openai_client = AsyncOpenAI()
    
    response = await openai_client.chat.completions.create(
        model="gpt-4o-mini",
        messages=[{"role": "user", "content": "Hello!"}],
        n_consensus=3
    )
    print(response.choices[0].message.content)

asyncio.run(main())

How Consensus Works

When n_consensus > 1:

  1. The wrapper makes n_consensus parallel requests to the API
  2. For both completions.create() and parse(): Results are consolidated using majority voting
    • For simple values: Most common value wins
    • For JSON/dict responses: Field-by-field majority voting
    • For lists: Element-by-element consolidation
  3. All responses return a choices array where:
    • choices[0]: Consolidated/consensus result
    • choices[1...n]: Individual original results from each API call

API Compatibility

The wrapper maintains full compatibility with the OpenAI client API. All parameters supported by the official client work seamlessly, including:

  • temperature, top_p, max_tokens
  • response_format, tools, tool_choice
  • stream (automatically disabled - all responses are non-streaming)
  • All other OpenAI parameters

Limitations

  • Streaming is not supported (all requests return KLLMsChatCompletion objects)
  • The n parameter is ignored when using n_consensus to avoid conflicts

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

k_llms-0.0.50.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

k_llms-0.0.50-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

Details for the file k_llms-0.0.50.tar.gz.

File metadata

  • Download URL: k_llms-0.0.50.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for k_llms-0.0.50.tar.gz
Algorithm Hash digest
SHA256 2ef9bfc52b0b0f715639ade9639de023ddab421d971e28c545e37c7af4f35c6d
MD5 d63b10cef6e787b8d00b0bcd419d9a98
BLAKE2b-256 0afebbf68f7498a0752737d54e8584c7908365571fb0a78fe1bf81e4835afe99

See more details on using hashes here.

File details

Details for the file k_llms-0.0.50-py3-none-any.whl.

File metadata

  • Download URL: k_llms-0.0.50-py3-none-any.whl
  • Upload date:
  • Size: 34.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for k_llms-0.0.50-py3-none-any.whl
Algorithm Hash digest
SHA256 5148606282ec821b25309ad0654e1b0bb6217d29e1dc671a392a8332c76301f1
MD5 774a6a4f5c90ac25f46044b1e24de0b9
BLAKE2b-256 ac4aa098dc21c85acc086ef497eaedd919ec368f84985b727016a84431f36b99

See more details on using hashes here.

Supported by

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