Skip to main content
Version: 25.7

snorkelai.sdk.client

Interfaces to interact with the Snorkel Flow REST API.

Most of the functions in the snorkelai.sdk.client module require a client context object — SnorkelSDKContext — that points to the Snorkel Flow instance:

import snorkelai.sdk.client as sf
ctx = sf.SnorkelSDKContext.from_endpoint_url()

All the functions under submodules are also available under snorkelai.sdk.client.

Examples

import snorkelai.sdk.client as sf
# get_annotations is available under snorkelai.sdk.client.annotations
sf.annotations.get_annotations(node)
# also available under snorkelai.sdk.client (recommended)
sf.get_annotations(node) # noqa: F405

Since snorkelai.sdk.client submodules may be reorganized in the future, we recommend accessing functions directly from snorkelai.sdk.client to minimize the risk of future breaking changes.

Submodules

snorkelai.sdk.client.annotationsAnnotations allow subject matter experts (SMEs) and LLMs to add labels to your data.
snorkelai.sdk.client.annotation_sourcesAnnotation source related functions.
snorkelai.sdk.client.commentsComment related functions.
snorkelai.sdk.client.connector_configsDataset views functions for datasets
snorkelai.sdk.client.ctxContext related classes.
snorkelai.sdk.client.external_modelsExternal model endpoints related functions.
snorkelai.sdk.client.filesFile storage related functions to upload and download files and directories.
snorkelai.sdk.client.file_storage_configsFile storage config related functions.
snorkelai.sdk.client.fm_suiteFoundation model suite related functions.
snorkelai.sdk.client.gtsGround truth related functions.
snorkelai.sdk.client.secretsSecret store related functions.
snorkelai.sdk.client.syntheticSynthetic data related functions for generating synthetic data.
snorkelai.sdk.client.transferSDK functions for transferring assets between applications or nodes on a single Snorkel Flow instance.
snorkelai.sdk.client.utilsUtility functions.
snorkelai.sdk.client.usersUser related functions.