LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
Pythonlangsmithtypessandboxessnapshot_create_paramsSnapshotCreateParams
Classā—Since v0.14

SnapshotCreateParams

Copy
SnapshotCreateParams()

Bases

TypedDict

Constructors

Attributes

View source on GitHub
constructor
__init__
NameType
docker_imageRequired[str]
fs_capacity_bytesRequired[int]
nameRequired[str]
descriptionstr
labelsDict[str, str]
registry_idstr
run_configRunConfig
tagstr
attribute
docker_image: Required[str]
attribute
fs_capacity_bytes: Required[int]
attribute
name: Required[str]
attribute
description: str

Description says what this snapshot's image can do, so a caller can hand it to an agent as a capability summary. At most 1024 characters.

attribute
labels: Dict[str, str]

Labels seed the snapshot's labels, overriding any label of the same key derived from the Docker image.

attribute
registry_id: str
attribute
run_config: RunConfig

RunConfig overrides the runtime configuration taken from the Docker image. Every sandbox created from the snapshot runs as the image's USER, in its WORKDIR, with its ENV beneath the sandbox's own env_vars; user and work_dir given here replace the image's, and env_vars merge over it.

attribute
tag: str

mutable Docker-style tag; defaults to "latest"