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.15.tar.gz (66.4 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.15-py3-none-any.whl (137.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.15.tar.gz
  • Upload date:
  • Size: 66.4 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.15.tar.gz
Algorithm Hash digest
SHA256 a30cda40613d46045987a6c9c876ed0d68b2dac3d7cd08238f15f35144bd28ac
MD5 4b014531e63fb5d3d9e7893675138ff5
BLAKE2b-256 bbdbe2c6eac7b76684004dc078ec33262efe210b1d3f4871b9a695370e1de2bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.15-py3-none-any.whl
  • Upload date:
  • Size: 137.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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 5637841f4e11edbd095dcd616cf4e8a2e98a4979fa8d88f3f3883b62f030e6e4
MD5 5b64942492aadb6c24b59d7536f151a0
BLAKE2b-256 647a74d1052dc89c1faf25e297436b8356d874b1424cdda52555a90e7982d7ec

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