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.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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file asteroid_sdk-0.1.25.tar.gz.
File metadata
- Download URL: asteroid_sdk-0.1.25.tar.gz
- Upload date:
- Size: 87.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f4afebbec8b973af0ba95dece7e4dfbcae7ef7a3baf8ff1bb2bf575bae5c1795
|
|
| MD5 |
f8c5401d395de96e6780d9c49b4775b5
|
|
| BLAKE2b-256 |
d1ed6388751ee596291ebf0fed20eb8eec149190ca4f476e1a2194c4eab30091
|
File details
Details for the file asteroid_sdk-0.1.25-py3-none-any.whl.
File metadata
- Download URL: asteroid_sdk-0.1.25-py3-none-any.whl
- Upload date:
- Size: 186.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc292bce50d7293707d7ea10a1d94d10159236356cbd11feab5b8172101a0acb
|
|
| MD5 |
083de63eb8f009d7bcbda7a8b343fb04
|
|
| BLAKE2b-256 |
46f90af78836031cacb4bb11350c91a3762aff6cd6015ee5df75c1f06e4ce4e2
|