Skip to main content

Client sdk to intearct with Dojo

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Dojo SDK Client

Python client SDK for interacting with the Dojo API

Installation

uv add dojo-sdk-client

if you want to use our example agents:

uv add "dojo-sdk-client[agents]"

if you want to use our multi-turn environment with verifiers

uv add "dojo-sdk-client[multi_turn_env]"

if you want to use our browserbase engine:

uv add "dojo-sdk-client[browserbase]"

Quick Start

Basic Task Execution

from dojo_sdk_client import BaseDojoClient
from dojo_sdk_client.types import TaskStatus

client = BaseDojoClient(api_key="your-api-key")

# Create and start task
exec_id = await client.create_task(
    task_id="tic-tac-toe/win-game",
    state={"board": [[0]*3 for _ in range(3)]}
)
await client.start_task(exec_id)

status = await client.get_task_status(exec_id)
while status.status == TaskStatus.QUEUED:
    await asyncio.sleep(1)
    status = await client.get_task_status(exec_id)

# Submit action
action = {"type": "click", "x": 100, "y": 100}
await client.submit_action(exec_id, action, "Making move")

Agent Evaluation

from dojo_sdk_client import DojoEvalClient
from dojo_sdk_client.select_engine import select_engine

engine = select_engine(API_KEY)

eval_client = DojoEvalClient(agent=agent, engine=engine)

results = await eval_client.evaluate(tasks=["tic-tac-toe/win-game", "2048/get-256-tile"], num_runners=1)

Changing Engines

from dojo_sdk_client.engines.browserbase_engine import BrowserBaseEngine

engine = BrowserBaseEngine(
    api_key="your-browserbase-api-key",
    project_id="your-browserbase-project-id",
    dojo_api_key="your-dojo-api-key"
)

eval_client = DojoEvalClient(agent=your_agent,engine=engine)

BrowserBase engine has a concurrency limit that can be controlled with the BROWSERBASE_CONCURRENT_LIMIT environment variable.

Clients

BaseDojoClient - Low-level HTTP client for direct API interactions

DojoEvalClient - High-level client for running automated evaluations

MultiTurnEnv - Multi-turn environment for running evaluations with Verifiers

Engines

DojoEngine - Default engine for running tasks using Dojo

BrowserBaseEngine - Engine for running tasks using BrowserBase

Documentation

Visit docs.trydojo.ai for complete 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

dojo_sdk_client-0.1.30.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

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

dojo_sdk_client-0.1.30-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

Details for the file dojo_sdk_client-0.1.30.tar.gz.

File metadata

  • Download URL: dojo_sdk_client-0.1.30.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for dojo_sdk_client-0.1.30.tar.gz
Algorithm Hash digest
SHA256 0c708d7e4b1dd7d2c8ff9379a3ffa1d645ec35def52ec20b38a63af80523b8f3
MD5 87a338ad071c00064e799ce737a1d1f2
BLAKE2b-256 5161c4eaa85982527d18fb97078511390fe268ba147fdf542c6b68c2cfbd1e10

See more details on using hashes here.

File details

Details for the file dojo_sdk_client-0.1.30-py3-none-any.whl.

File metadata

File hashes

Hashes for dojo_sdk_client-0.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 0ecc475102e4081cb9b28d424cf101cb4a65acb63adb9414089b488353162596
MD5 347f42731e5d4e5daf57dac8e52f165d
BLAKE2b-256 a409cf65021223a28dd2becc04bb25c6281ce9b4d509a0ff6d0756a1b2e1fbb6

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