Skip to main content

Python sdk for the Rowboat API

Project description

Rowboat Python SDK

A Python SDK for interacting with the Rowboat API.

Installation

You can install the package using pip:

pip install rowboat

Usage

Basic Usage

Initialize a client and use the chat method directly:

from rowboat import Client
from rowboat.schema import UserMessage, SystemMessage

# Initialize the client
client = Client(
    host="<HOST>",
    project_id="<PROJECT_ID>",
    api_key="<API_KEY>"
)

# Create messages
messages = [
    SystemMessage(role='system', content="You are a helpful assistant"),
    UserMessage(role='user', content="Hello, how are you?")
]

# Get response
response_messages, state = client.chat(messages=messages)
print(response_messages[-1].content)

# For subsequent messages, include previous messages and state
messages.extend(response_messages)
messages.append(UserMessage(role='user', content="What's your name?"))
response_messages, state = client.chat(messages=messages, state=state)

Using Tools

The SDK supports function calling through tools:

def weather_lookup(city_name: str) -> str:
    return f"The weather in {city_name} is 22°C."

# Create a tools dictionary
tools = {
    'weather_lookup': weather_lookup
}

# Use tools with the chat method
response_messages, state = client.chat(
    messages=messages,
    tools=tools
)

Stateful Chat (Convenience Wrapper)

For simpler use cases, the SDK provides a StatefulChat class that maintains conversation state automatically:

from rowboat import StatefulChat

# Initialize stateful chat
chat = StatefulChat(
    client,
    tools=tools,
    system_prompt="You are a helpful assistant."
)

# Simply send messages and get responses
response = chat.run("Hello, how are you?")
print(response)
# I'm good, thanks! How can I help you today?

Advanced Usage

Using a specific workflow

response_messages, state = client.chat(
    messages=messages,
    workflow_id="<WORKFLOW_ID>"
)

# or

chat = StatefulChat(
    client,
    workflow_id="<WORKFLOW_ID>"
)

Skip tool call runs

This will surface the tool calls to the SDK instead of running them automatically on the Rowboat server.

response_messages, state = client.chat(
    messages=messages,
    skip_tool_calls=True
)

# or

chat = StatefulChat(
    client,
    skip_tool_calls=True
)

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

rowboat-1.0.5.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rowboat-1.0.5-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file rowboat-1.0.5.tar.gz.

File metadata

  • Download URL: rowboat-1.0.5.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for rowboat-1.0.5.tar.gz
Algorithm Hash digest
SHA256 66279c59983a0d2f05af09a2daee93045ea0aa1bd372db781d738ba8678ea688
MD5 8f4d670cc4d8812424300df475166cf0
BLAKE2b-256 5ecdce34e714d7f343340f45bb8b1a5637ae11597bb854d9136854598e9f8ed2

See more details on using hashes here.

File details

Details for the file rowboat-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: rowboat-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for rowboat-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1df204afe052a3cbfe203203ed8a0b12a5f8cc9e017dda4e9e23a792ec5a89ae
MD5 a1c90f09325403b802decca8f81b2e20
BLAKE2b-256 98e6f41f0a03a23871b9d21dde2406cb2d7aba1e1412bd85054c98a712cdde16

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