Skip to main content

client server for usage with snowglobe experiments

Project description

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 and custom code based risk assessment.

Installation

# Install client
pip install snowglobe

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

uv pip install --prerelease=allow snowglobe

snowglobe-connect commands

snowglobe-connect auth  # Sets up your API key
snowglobe-connect init  # Initializes a new agent connection and creates an agent wrapper file
snowglobe-connect test  # Tests your agent connection
snowglobe-connect start  # Starts the process of processing simulated user messages
snowglobe-connect --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:

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

snowglobe-0.9.1a2.tar.gz (95.2 kB view details)

Uploaded Source

Built Distribution

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

snowglobe-0.9.1a2-py3-none-any.whl (75.6 kB view details)

Uploaded Python 3

File details

Details for the file snowglobe-0.9.1a2.tar.gz.

File metadata

  • Download URL: snowglobe-0.9.1a2.tar.gz
  • Upload date:
  • Size: 95.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for snowglobe-0.9.1a2.tar.gz
Algorithm Hash digest
SHA256 8a59349d63d568969e102cdfe194df4c01466573eba13a98683912f33f999e72
MD5 ecd94a9cfca68a6ecbc6b8d2ba33f0bf
BLAKE2b-256 f2f6dcb49a835d97f88e067647679a9a2bc110c894c3b7de774a784bfebeab4f

See more details on using hashes here.

File details

Details for the file snowglobe-0.9.1a2-py3-none-any.whl.

File metadata

  • Download URL: snowglobe-0.9.1a2-py3-none-any.whl
  • Upload date:
  • Size: 75.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for snowglobe-0.9.1a2-py3-none-any.whl
Algorithm Hash digest
SHA256 f8ef6c8811e1ec1e46d770cf009f3461f1049cec63f9844313ac3884f9959398
MD5 23aa136b851b1ef66f613296f3a0121f
BLAKE2b-256 a0ed9c36b0439377190ee5572a8c4a00353eeff9536579b0445cfd5a3836297b

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