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

Uploaded Python 3

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.9.tar.gz
  • Upload date:
  • Size: 62.0 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.9.tar.gz
Algorithm Hash digest
SHA256 3b95f264e4141c3144e568675ddbfa5032665b510dd8e9c1cdbe3cdb4d4bbd15
MD5 8c1238ccb5926055284e6f65ed7b4136
BLAKE2b-256 767d17a23af4f946d819fe320b190c567638ade6bf64686934251b4e3426f801

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 bc1df5ae77873da23eec494e5736ed7bf5e7f047bfc09cfe91173fe86e119414
MD5 55c38a3f204cddcd01b12bc78256dc5f
BLAKE2b-256 ea451e9a5a21626f830daead99d20455b99ed2e9021af1531b58be4b83fd0e09

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