Skip to main content

A Python SDK for Asteroid

Project description

Asteroid Python SDK ☄️

A Python SDK for interacting with the Asteroid platform. To successfully use Asteroid Python SDK, you need to have a running instance of the Asteroid server. Book a demo with Asteroid founders to get started!

Installation

pip install asteroid-sdk

Quick Start

from asteroid_sdk.wrappers.openai import asteroid_openai_client, asteroid_init
from asteroid_sdk.supervision.decorators import supervise
from asteroid_sdk.supervision.supervisors import llm_supervisor, human_supervisor
from openai import OpenAI

# Initialize the SDK
run_id = asteroid_init()

# Define your tools with supervisors
@supervise(supervision_functions=[[llm_supervisor(instructions="For flights above $1000, escalate."), human_supervisor()]])
def book_flight(departure_city: str, arrival_city: str, datetime: str):
    """Book a flight ticket."""
    return f"Flight booked from {departure_city} to {arrival_city} on {datetime}."

# Wrap your LLM client
client = OpenAI()
wrapped_client = asteroid_openai_client(client, run_id)

# Run your LLM
response = wrapped_client.chat.completions.create(
  model="gpt-4o",
  messages=[{"role": "user", "content": "Book a flight from SF to LA for tomorrow for $1100."}],
  tools=[book_flight]
)
# The response is supervised by Asteroid, check the web UI for the results and human review

Documentation

For more information, please refer to the Asteroid Documentation!

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

asteroid_sdk-0.1.4.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

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

asteroid_sdk-0.1.4-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

Details for the file asteroid_sdk-0.1.4.tar.gz.

File metadata

  • Download URL: asteroid_sdk-0.1.4.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for asteroid_sdk-0.1.4.tar.gz
Algorithm Hash digest
SHA256 b3261ec8757d0c88ace65968086273f4cdadf7de0f1f90c85ac4a23f912f6a03
MD5 f80f51b7f9143d3fe244908ecd2ac58b
BLAKE2b-256 b12d06f129938ec85abeac8f7849c7ff5d1b07f1200eb68fb8c2ebe1545f46ce

See more details on using hashes here.

File details

Details for the file asteroid_sdk-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: asteroid_sdk-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 27.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for asteroid_sdk-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b18d78d2c62d4753cc1a29768368f8e699502c1ea6a35ed0d3a24ad11e58d486
MD5 bab68ee4e764cd3d2d9031142eabb533
BLAKE2b-256 bdf3d475a3f7ee8d7e6d05d5a094901fec776054d2aa5225be6fa0469e657153

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