Skip to main content

Snowlgobe Connect SDK

The Snowglobe Connect SDK helps you connect your AI agents to Snowglobe. It sends simulated user messages to your LLM-based application during experiments. Your application should process these messages and return a response, enabling simulated conversations.

Installation

# Install client
pip install snowglobe

If using uv, set the --prerelease=allow flag

uv pip install --prerelease=allow snowglobe

snowglobe commands

snowglobe login  # Sets up your API key
snowglobe init  # Initializes a new agent connection and creates an agent wrapper file
snowglobe test  # Tests your agent connection
snowglobe start  # Starts the process of processing simulated user messages
snowglobe agent create --name <name>  # Creates an agent (scriptable init: CP application + wrapper file + mapping)
snowglobe agent profile  # Kicks off a new Agent Profile tuning job and waits for it (--no-wait to return immediately)
snowglobe agent profiles  # Lists Agent Profiles for a project agent
snowglobe --help

When using one of our specific preview environments in .snowgloberc one can override our server's URL with:

CONTROL_PLANE_URL=

Sample custom llm usage in agent wrapper file

Each agent wrapper file resides in the root directory of your project, and is named after the agent (e.g. My Agent Name becomes my_agent_name.py).

from snowglobe.client import CompletionRequest, CompletionFunctionOutputs
from openai import OpenAI
import os

client = OpenAI(api_key=os.getenv("SNOWGLOBE_API_KEY"))

def completion_fn(request: CompletionRequest) -> CompletionFunctionOutputs:
    """
    Process a scenario request from Snowglobe.
    
    This function is called by the Snowglobe client to process requests. It should return a
    CompletionFunctionOutputs object with the response content.

    Example CompletionRequest:
    CompletionRequest(
        messages=[
            SnowglobeMessage(role="user", content="Hello, how are you?", snowglobe_data=None),
        ]
    )

    Example CompletionFunctionOutputs:
    CompletionFunctionOutputs(response="This is a string response from your application")
    
    Args:
        request (CompletionRequest): The request object containing the messages.

    Returns:
        CompletionFunctionOutputs: The response object with the generated content.
    """

    # Process the request using the messages. Example:
    messages = request.to_openai_messages()
    response = client.chat.completions.create(
        model="gpt-4o-mini",
        messages=messages
    )
    return CompletionFunctionOutputs(response=response.choices[0].message.content)

Operator tuning

The wrapper exposes ~12 environment variables for concurrency, inbound rate limits, polling cadence, and HTTP retry. Defaults are tuned for low-to-medium throughput; raise them together (not individually) for higher load.

See .snowglobe/TUNING.md for the full knob reference, recipes, and the ratio caveat between dispatch concurrency and the inbound rate limiter.

Tracing & Telemetry

See our telemetry instrumentation extensions for snowglobe to help you track insightful traces from our agent:

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snowglobe-1.2.0.tar.gz (175.8 kB view details)

Uploaded Source

Built Distribution

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

snowglobe-1.2.0-py3-none-any.whl (118.6 kB view details)

Uploaded Python 3

File details

Details for the file snowglobe-1.2.0.tar.gz.

File metadata

  • Download URL: snowglobe-1.2.0.tar.gz
  • Upload date:
  • Size: 175.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for snowglobe-1.2.0.tar.gz
Algorithm Hash digest
SHA256 c52ffe6f0d396227f73cf62c4d1cb0bb7fb969a7e88abf9744f50c663f1470ce
MD5 cf1de9e3ba6b6ed3b07d3413e544224d
BLAKE2b-256 14d0944474879598a73027c1bffedd40f020e334f9600a674b73e3f15c78825d

See more details on using hashes here.

Provenance

The following attestation bundles were made for snowglobe-1.2.0.tar.gz:

Publisher: release.yml on guardrails-ai/client_wrapper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file snowglobe-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: snowglobe-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 118.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for snowglobe-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae5b55808fb60df3c20710176916c252e1353c59c2f6ab47925ab2d068719d14
MD5 af8757e879193690078facda2f5761da
BLAKE2b-256 1793432b9d5d263472e9706f0878415dec880e3c30efe0f9649b979f53d34ad4

See more details on using hashes here.

Provenance

The following attestation bundles were made for snowglobe-1.2.0-py3-none-any.whl:

Publisher: release.yml on guardrails-ai/client_wrapper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.3.0

2 files

This release

1.2.0 This release

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.9.17

2 files

0.9.16

2 files

0.9.15

2 files

0.9.14

2 files

0.9.13

2 files

0.8.8

2 files

0.8.7

2 files

0.8.6

2 files

0.8.5

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.4.22

2 files

0.4.21

2 files

0.4.20

2 files

0.4.19

2 files

0.4.18

2 files

0.4.17

2 files

0.4.16

2 files

0.4.15

2 files

0.4.14

2 files

0.4.13

2 files

0.4.12

2 files

0.4.11

2 files

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page