Python SDK

kumoai

View as Markdown

The kumoai root module provides SDK initialization, logging configuration, and the core type enumerations (Dtype, Stype) used throughout the SDK.

init()

Initializes and authenticates the SDK against the Kumo service. Must be called before using any other SDK functionality.

1import kumoai
2
3kumoai.init(url="<api_url>", api_key="<api_key>")
url
strDefaults to None

The Kumo API endpoint. Can also be provided via the KUMO_API_ENDPOINT environment variable. Inferred from the API key if not specified.

api_key
strDefaults to None

The Kumo API key. Can also be provided via the KUMO_API_KEY environment variable.

snowflake_credentials
Dict[str, str]Defaults to None

Snowflake credentials for SPCS deployments. Either password-based {"user", "password", "account"} or key-pair {"user", "private_key", "account"} with optional "private_key_passphrase" for encrypted keys. The private key must be in PEM format.

snowflake_application
strDefaults to None

The Snowflake application name.

log_level
strDefaults to "INFO"

Logging verbosity. See set_log_level() for valid values. Can also be set via the KUMOAI_LOG environment variable.

group
strDefaults to None

The group to operate in. Only applicable when RBAC is enabled. Accepts a group name or ID. Auto-selected if the user belongs to exactly one group.

project
strDefaults to None

The project to operate in. Only applicable when RBAC is enabled. Requires group to be resolvable.

set_log_level()

Sets the logging verbosity for the Kumo SDK.

1kumoai.set_log_level("DEBUG")
level
strRequired

The logging level. Valid values from most to least verbose: DEBUG, INFO, WARNING, ERROR, CRITICAL (FATAL is an alias for CRITICAL).

Dtype

Enumerates the data types supported by Kumo columns.

ValueDescription
boolBoolean column
intInteger column
byte8-bit integer column
int1616-bit integer column
int3232-bit integer column
int6464-bit integer column
floatFloating-point column
float3232-bit float column
float6464-bit float column
stringString column
binaryBinary column
dateDate column
timeTime column
timedeltaTimedelta column
floatlistList of floats (sequence / embedding)
intlistList of integers
stringlistList of strings
unsupportedUnsupported type

Stype

Enumerates the semantic types supported by Kumo columns. Semantic types describe how Kumo interprets and encodes the data in a column.

ValueDescription
numericalA numerical column. Typically integers or floats.
categoricalA categorical column. Typically a boolean or short string value.
multicategoricalA multi-categorical column. Typically a string containing multiple concatenated category labels.
IDA column holding entity identifiers.
textA text column. Multi-token string values where the language content carries semantic meaning.
timestampA date/time column.
sequenceA sequence or embedding column. Lists of floats of equal length, typically the output of another model.
imageA column holding image URLs.
unsupportedUnsupported type.