Index of the dataiku package#

This page contains the index of classes and functions in the dataiku package and serve as entrypoint to its reference API documentation

dataiku.api_client()#

Build an API client for the current DSS instance.

Returns:

API client configured for the current runtime context.

Return type:

dataikuapi.dssclient.DSSClient

dataiku.clear_remote_dss()#

Clear the remote DSS configuration previously set by set_remote_dss().

Use this to switch back to default DSS connection resolution (environment, config file, or local DSS context).

Returns:

None

dataiku.set_remote_dss(url, api_key=None, no_check_certificate=False, jwt_bearer_token=None)#

Configure access to a remote DSS instance.

Parameters:

  • url (str) – Base URL of the remote DSS instance.

  • api_key (str) – API key to use for remote DSS authentication.

  • no_check_certificate (bool) – Whether to skip TLS certificate checks (defaults to False).

Returns:

None

Datasets#

dataiku.Dataset(name[, project_key, ignore_flow])

Provides a handle to obtain readers and writers on a dataiku Dataset.

dataiku.core.dataset_write.DatasetWriter(dataset)

Handle to write to a dataset.

Managed folders#

dataiku.Folder(lookup[, project_key, ...])

Handle to interact with a folder.

dataiku.core.managed_folder.ManagedFolderWriter(...)

Handle to write to a managed folder

Streaming Endpoints#

dataiku.StreamingEndpoint(id[, project_key])

This is a handle to obtain readers and writers on a dataiku streaming endpoint.

Saved models#

dataiku.Model(lookup[, project_key, ignore_flow])

Handle to interact with a saved model.

Metrics and checks#

dataiku.core.metrics.ComputedMetrics(raw)

Handle to the metrics of a DSS object and their last computed value

dataiku.core.metrics.MetricDataPoint(raw)

A value of a metric, on a partition

dataiku.core.metrics.ComputedChecks(raw)

Handle to the checks of a DSS object and their last computed value

dataiku.core.metrics.CheckDataPoint(raw)

A value of a check, on a partition

Model Evaluation Stores#

dataiku.core.model_evaluation_store.ModelEvaluationStore(lookup)

This is a handle to interact with a model evaluation store.

dataiku.core.model_evaluation_store.ModelEvaluation(...)

This is a handle to interact with a model evaluation from a model evaluation store.

Projects#

dataiku.Project([project_key])

This is a handle to interact with the current project