Skip to content

index.mdx

Latest commit

 

History

History
128 lines (96 loc) · 6.27 KB

index.mdx

File metadata and controls

128 lines (96 loc) · 6.27 KB
Raw
title Python SDK
sidebar_position 0
sidebar_label Overview

import { LuSettings, LuPlug, LuPlay, LuRocket, LuSend, LuFolderOpen, LuMessageSquare, LuActivity, LuShieldAlert, LuBookOpen, LuFlaskConical, LuChartLine, LuRadar, LuGitCompare } from 'react-icons/lu';

Python SDK

Build, run, and manage AI pipelines from Python. The rocketride package is async-first — built on asyncio and websockets — and speaks the engine's native WebSocket protocol: you author a .pipe (visually or by hand) and run it against the engine from your own application.

Install

pip install rocketride

Python 3.10+. The rocketride CLI is installed with the package.

Quickstart

import asyncio
from rocketride import RocketRideClient


async def main():
    async with RocketRideClient(uri='https://api.rocketride.ai', auth='my-key') as client:
        result = await client.use(filepath='pipeline.pipe')
        token = result['token']
        out = await client.send(token, 'Hello, pipeline!', objinfo={'name': 'input.txt'}, mimetype='text/plain')
        print(out)
        await client.terminate(token)


asyncio.run(main())

send() / send_files() target pipelines whose source is webhook or dropper; if your pipeline source is chat, use client.chat(). No pipeline yet? The IDE walkthrough builds one in minutes.

Explore the SDK

Configuration Constructor options, environment variables, timeouts, and reconnection. Connection The attach/login layers, context manager, persist mode, and lifecycle callbacks. Running Pipelines Start with use(), watch progress, validate, and terminate. Deployments Publish immutable versions, point team environments at them, and schedule runs. Sending Data One-shot sends, concurrent file uploads with progress, and chunked streaming. File Storage Read, write, and manage your server-side store; signed URLs for direct access. Chat Build a Question, stream the response, parse it with Answer. Run Logs The log continuum and the DVR session: live monitoring and replay with one API. Error Handling What the SDK raises, when, and how to catch it. API Reference Every public class and method, in one place. Examples Seven complete programs, from hello-pipeline to custom DAP requests. Analytics Report client-side analytics events through the SDK. OpenTelemetry Bridge Export live pipeline traces and metrics over OTLP with rocketride otel. Pipeline Diff Review what changed between two .pipe revisions with rocketride diff.

Links