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.5.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.5-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: k_llms-0.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 e116da934e3b2a49c88f73b2ed33892d6eca56dc605c031fa246f0f968c8f402
MD5 50aa89b0b927ec11806fce3334aab7d1
BLAKE2b-256 2ce98ffae35a8fcaff3f7c2d3b83470a8d94221c6c92dc1a7b2f49a6ff3e0ef0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: k_llms-0.0.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 834383a00d22d21f7b040db1f8106cdee177f48cac0d52b0990c011a7f998ec8
MD5 d6eb69b20fc00b3eb17639eb8288d711
BLAKE2b-256 d06bc2f9c31aa037622263cd2a851cfbd23d0c9cf537126e1fdc926b0d34833a

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