Skip to main content

LLM provider abstraction layer.

Project description

oneping

oneping.reply('Give me a ping, Vasily. One ping only, please.', provider='anthropic')

One ping only, please.

This is a Python library for querying LLM providers such as OpenAI or Anthropic, as well as local models. The main goal is to create an abstraction layer that makes switching between them seamless. Currently the following providers are supported: openai, anthropic, fireworks, and local (local models).

There is also a Chat interface that automatically tracks the message history. Kind of departing from the "one ping" notion, but oh well. Additionally, there is a textual powered console interface and a fasthtml powered web interface. Both are components that can be embedded in other applications.

Requesting the local provider will target localhost and use an OpenAI-compatible API as in llama.cpp or llama-cpp-python. The various native libraries are soft dependencies and the library can still partially function with or without any or all of them. The native packages for these providers are: openai, anthropic, and fireworks-ai.

Installation

For standard usage, install with:

pip install oneping

To install the native provider dependencies add "[native]" after oneping in the command above. The same goes for the chat interface dependencies with "[chat]".

The easiest way to handle authentication is to set an API key environment variable such as: OPENAI_API_KEY, ANTHROPIC_API_KEY, FIREWORKS_API_KEY, etc. You can also pass the api_key argument to any of the functions directly.

Library Usage

Basic usage with Anthropic through the URL interface:

response = oneping.reply(query, provider='anthropic')

The reply function accepts a number of arguments including (some of these have per-provider defaults):

  • query (required): The query to send to the LLM (required)
  • provider = local: The provider to use: openai, anthropic, fireworks, or local
  • system = None: The system prompt to use (not required, but recommended)
  • prefill = None: Start "assistant" response with a string (Anthropic doesn't like newlines in this)
  • model = None: Indicate the desired model for the provider (provider default)
  • max_tokens = 1024: The maximum number of tokens to return
  • history = None: List of prior messages or True to request full history as return value
  • native = False: Use the native provider libraries
  • url = None: Override the default URL for the provider (provider default)
  • port = 8000: Which port to use for local or custom provider
  • api_key = None: The API key to use for non-local providers

For example, to use the OpenAI API with a custom system prompt:

response = oneping.reply(query, provider='openai', system=system)

To conduct a full conversation with a local LLM, see Chat interface below. For streaming, use the function stream and for async streaming, use stream_async. Both of these take the same arguments as reply.

Command Line

You can call oneping directly or as a module with python -m oneping and use the following subcommands:

  • reply: get a single response from the LLM
  • stream: stream a response from the LLM
  • embed: get embeddings from the LLM
  • console: start a console (Textual) chat
  • web: start a web (FastHTML) chat

These accept the arguments listed above for reply as command line arguments. For example:

oneping stream "Does Jupiter have a solid core?" --provider anthropic

Or you can pipe in your query from stdin:

echo "Does Jupiter have a solid core?" | oneping stream --provider anthropic

I've personally found it useful to set up aliases like claude = oneping stream --provider anthropic.

Chat Interface

The Chat interface is a simple wrapper for a conversation history. It can be used to chat with an LLM provider or to simply maintain a conversation history for your bot. If takes the usual reply, stream, and stream_async functions, and calling it directly will map to reply.

chat = oneping.Chat(provider='anthropic', system=system)
reply1 = chat(query1)
reply2 = chat(query2)

There is also a textual powered console interface and a fasthtml powered web interface. You can call these with: oneping console or oneping web.

Textual Chat FastHTML Chat

Server

The server module includes a simple function to start a llama-cpp-python server on the fly (oneping.server.start in Python or oneping server from the command line).

oneping server <path-to-gguf>

To run the server in embedding mode, pass the --embedding flag. You can also specify things like --host and --port or any options supported by llama-cpp-python.

Embeddings

Embeddings queries are supported through the embed function. It accepts the relevant arguments from the reply function. Right now only openai and local providers are supported.

vecs = oneping.embed(text, provider='openai')

and on the command line:

oneping embed "hello world" --provider openai

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

oneping-0.5.6.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

oneping-0.5.6-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file oneping-0.5.6.tar.gz.

File metadata

  • Download URL: oneping-0.5.6.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for oneping-0.5.6.tar.gz
Algorithm Hash digest
SHA256 cf5d39ad993de4f1e1c713e1ab2362023436db7df0f275ecf1d38e18d364988d
MD5 783fb427e194f9533d719649218892fc
BLAKE2b-256 759d41af853a800e133ba9ffa1744a37e966e3a5ce6a24a933ab55b02ff4f9ca

See more details on using hashes here.

File details

Details for the file oneping-0.5.6-py3-none-any.whl.

File metadata

  • Download URL: oneping-0.5.6-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for oneping-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3861a2e36b1e5785fa1caf4b8ff3a598e034d1b33a1aea0554921459b34b020d
MD5 00daf12986437234ade4e92fdc799697
BLAKE2b-256 1bcc36c62d0ed9b5d7e653a913d17509f90c1f9e9c8ca77eabc661c87467bf8e

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