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.11.tar.gz (61.9 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.11-py3-none-any.whl (131.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.11.tar.gz
  • Upload date:
  • Size: 61.9 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.11.tar.gz
Algorithm Hash digest
SHA256 4dd15daa1fab1ce56b1a2516b7668a1fe3a93c930a6f0c70f42e9685c7133b13
MD5 6b73328a7000d0ce70812f26b17b4bf5
BLAKE2b-256 64484a1169a0e6ad7e921cdcbb4d6c4ab39b06b9bf0572f8023d924b7ec81f54

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 131.9 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 9c21bfb542d557cd05013acbba6e61479ccfa2319987658a66301c1ac6f3b2fc
MD5 b0a367b6eac87ce6497275fdd64f2645
BLAKE2b-256 59720f007b2e02d89d23c53226c78b283a0787c2b4fe3de2286fe730bd06331c

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