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.14.tar.gz (66.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.14-py3-none-any.whl (137.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.14.tar.gz
  • Upload date:
  • Size: 66.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.14.tar.gz
Algorithm Hash digest
SHA256 a9adca98d74eb780ec2696b64fe2e785e3e80f3357fcbe2a444283ab1099a38f
MD5 de3d2843d7982401cf06827e430dd593
BLAKE2b-256 cf1699c1adaaf0fc239e4c54b2206e6343ab0d8be1856934ced95321c17ee5b8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 137.3 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.14-py3-none-any.whl
Algorithm Hash digest
SHA256 5a036f8b5c8f1eb99f225b0c1b78367b736fc3e561603a9a66ed4b1ae5d79e0e
MD5 c75f2f6233ca0f09b217a85735521cfa
BLAKE2b-256 c2004f03a80c52fa115bbf878f091306d0add1f0fca90ae6329ee70966e37041

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