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
from asteroid_sdk.registration.initialise_project import asteroid_init
from asteroid_sdk.supervision.decorators import supervise
from asteroid_sdk.supervision.supervisors import openai_llm_supervisor, human_supervisor
from openai import OpenAI

# Initialize the SDK
run_id = asteroid_init()


# Define your tools with supervisors
@supervise(supervision_functions=[
    [openai_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.8.tar.gz (22.6 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.8-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.8.tar.gz
  • Upload date:
  • Size: 22.6 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.8.tar.gz
Algorithm Hash digest
SHA256 fc907407eee54a795b7be8683b74679e8c454e02b38279fa3e386f318a056920
MD5 b78d2ef022d73ead5572006524de85ce
BLAKE2b-256 e317cfe93368badd86341c43d3e89f8af141931a4027f5b274e9e29e818035d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 27.7 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ab52e3729f7e2162a9e14f293064b08793b4af07b638a636e633bdc54577d41d
MD5 b0a4d8014ce090b835e30f45351174e9
BLAKE2b-256 edacf60955f24c68ad74230000e13e9bf39079b87ff1e0ff24217cd26806de2f

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