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.13.tar.gz (63.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.13-py3-none-any.whl (134.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.13.tar.gz
  • Upload date:
  • Size: 63.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.13.tar.gz
Algorithm Hash digest
SHA256 39c63ac9036537ff61af80a9ccb9d11336d532a5fc2444ab05ff8eab3ae47d4d
MD5 939b777965a653d003ae7b02674a42ca
BLAKE2b-256 93a3397bd0f873802d728f9f5e58f7c105745082028da827db4573622a5df70e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 134.6 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 4a70b6bdf1cc8453c15d74c6b26f4e1b5b045373c4456a3bade15e2c5fc778fd
MD5 57840723f94eceaad21df3a884bf2e2e
BLAKE2b-256 ad479c1e8c5ab9e8f155ab1568c05a8aa5ab96a6503421ad8f733a1be5cc1a3f

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