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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file snowglobe-1.1.0.tar.gz.
File metadata
- Download URL: snowglobe-1.1.0.tar.gz
- Upload date:
- Size: 172.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4b396971599e38d47ac2884779941caef1c74b7eae29a131a1aa91778eb77fdf
|
|
| MD5 |
4fbb5fdf8e8ecff8a608523f400c0bcf
|
|
| BLAKE2b-256 |
78b40cc40bb7d149298abc2f68b0ca4a4801f446740b1b5f7f39326879c7f68a
|
Provenance
The following attestation bundles were made for snowglobe-1.1.0.tar.gz:
Publisher:
release.yml on guardrails-ai/client_wrapper
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
snowglobe-1.1.0.tar.gz -
Subject digest:
4b396971599e38d47ac2884779941caef1c74b7eae29a131a1aa91778eb77fdf - Sigstore transparency entry: 2207167829
- Sigstore integration time:
-
Permalink:
guardrails-ai/client_wrapper@7fe8287462049ecfeee7e8b2f50e698a86e2f437 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/guardrails-ai
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@7fe8287462049ecfeee7e8b2f50e698a86e2f437 -
Trigger Event:
push
-
Statement type:
File details
Details for the file snowglobe-1.1.0-py3-none-any.whl.
File metadata
- Download URL: snowglobe-1.1.0-py3-none-any.whl
- Upload date:
- Size: 116.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c1e342c64673141cd742b5108f80d6c1d1e4184b26b27c23227c5a2b8a480f01
|
|
| MD5 |
a726af1dff66af808e89bc58056d62e7
|
|
| BLAKE2b-256 |
f1d9ab5443b9206de8910b91a4fa46b47a3e0ddb7b79ad10d245662b32646079
|
Provenance
The following attestation bundles were made for snowglobe-1.1.0-py3-none-any.whl:
Publisher:
release.yml on guardrails-ai/client_wrapper
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
snowglobe-1.1.0-py3-none-any.whl -
Subject digest:
c1e342c64673141cd742b5108f80d6c1d1e4184b26b27c23227c5a2b8a480f01 - Sigstore transparency entry: 2207167841
- Sigstore integration time:
-
Permalink:
guardrails-ai/client_wrapper@7fe8287462049ecfeee7e8b2f50e698a86e2f437 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/guardrails-ai
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@7fe8287462049ecfeee7e8b2f50e698a86e2f437 -
Trigger Event:
push
-
Statement type:
