Skip to main content

A Python SDK for Asteroid

Project description

Asteroid AI

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.base_supervisors import llm_supervisor, human_supervisor
from openai import OpenAI

# Define your tools with supervisors
@supervise(supervision_functions=[
    [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}."

tools = [{
    "type": "function",
    "function": {
        "name": "book_flight",
        "description": "Book a flight ticket.",
        "parameters": {
            "type": "object",
            "properties": {
                "departure_city": {
                    "type": "string"
                },
                "arrival_city": {
                    "type": "string"
                },
                "datetime": {
                    "type": "string"
                }
            },
            "required": [
                "departure_city",
                "arrival_city",
                "datetime"
            ],
            "additionalProperties": False
        },
        "strict": True
    }
}]

# Initialize the SDK
run_id = asteroid_init()

# 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=tools
)
# 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.28.tar.gz (90.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.28-py3-none-any.whl (195.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.28.tar.gz
  • Upload date:
  • Size: 90.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for asteroid_sdk-0.1.28.tar.gz
Algorithm Hash digest
SHA256 49a0b9d5782f191bc6e6412c855e2595a41d910433edd4aefd827e7cd26d9cce
MD5 8fe8776b13c2754e316326bd62747403
BLAKE2b-256 54791bae5069a5c9efdb137af825e6a03ead91bbb3287c8b32d09857eefffb4b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asteroid_sdk-0.1.28-py3-none-any.whl
  • Upload date:
  • Size: 195.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for asteroid_sdk-0.1.28-py3-none-any.whl
Algorithm Hash digest
SHA256 e23b24fce245c37b48c3e5755cc817b3eaa5be740bf3eff4607d00a630c4e023
MD5 ae624865918413f4357f1639b53a2ac0
BLAKE2b-256 335d58a21c9024c925af6343d9a207089cf99f0ed57f53a011e4b8d0f27309ec

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