Index of the dataikuapi package

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

Core classes

dataikuapi.DSSClient(host[, api_key, ...])	Entry point for the DSS API client
dataikuapi.dss.project.DSSProject(client, ...)	A handle to interact with a project on the DSS instance.

Project folders

dataikuapi.dss.projectfolder.DSSProjectFolder(...)	A handle for a project folder on the DSS instance.
dataikuapi.dss.projectfolder.DSSProjectFolderSettings(...)	A handle for a project folder settings.

Datasets

dataikuapi.dss.dataset.DSSDataset(client, ...)

A dataset on the DSS instance.

Statistics worksheets

dataikuapi.dss.statistics.DSSStatisticsWorksheet(...)

A handle to interact with a worksheet.

Managed folders

dataikuapi.dss.managedfolder.DSSManagedFolder(...)

A handle to interact with a managed folder on the DSS instance.

Streaming endpoint

dataikuapi.dss.streaming_endpoint.DSSStreamingEndpoint(...)

A streaming endpoint on the DSS instance.

Recipes

dataikuapi.dss.recipe.DSSRecipe(client, ...)	A handle to an existing recipe on the DSS instance.
dataikuapi.dss.recipe.GroupingRecipeCreator(...)	Create a Group recipe.
dataikuapi.dss.recipe.JoinRecipeCreator(...)	Create a Join recipe.
dataikuapi.dss.recipe.StackRecipeCreator(...)	Create a Stack recipe
dataikuapi.dss.recipe.WindowRecipeCreator(...)	Create a Window recipe
dataikuapi.dss.recipe.SyncRecipeCreator(...)	Create a Sync recipe
dataikuapi.dss.recipe.SamplingRecipeCreator(...)	Create a Sample/Filter recipe
dataikuapi.dss.recipe.SQLQueryRecipeCreator(...)	Create a SQL query recipe.
dataikuapi.dss.recipe.CodeRecipeCreator(...)	Create a recipe running a script.
dataikuapi.dss.recipe.SplitRecipeCreator(...)	Create a Split recipe
dataikuapi.dss.recipe.EvaluationRecipeCreator(...)	Create a new Evaluate recipe.
dataikuapi.dss.recipe.StandaloneEvaluationRecipeCreator(...)	Create a new Standalone Evaluate recipe.
dataikuapi.dss.recipe.LLMEvaluationRecipeCreator(...)	Create a new LLM Evaluate recipe.
dataikuapi.dss.recipe.AgentEvaluationRecipeCreator(...)	Create a new Agent Evaluation recipe.

Machine Learning

dataikuapi.dss.ml.DSSMLTask(client, ...)	A handle to interact with a ML Task for prediction or clustering in a DSS visual analysis.
dataikuapi.dss.ml.DSSMLTaskSettings(client, ...)	Object to read and modify the settings of an existing ML task.

Experiment Tracking

dataikuapi.dss.mlflow.DSSMLflowExtension(...)

A handle to interact with specific endpoints of the DSS MLflow integration.

Code Studios

dataikuapi.dss.codestudio.DSSCodeStudioObject(...)

A handle to manage a code studio in a project

Jobs

dataikuapi.dss.job.DSSJob(client, ...)

A job on the DSS instance.

Scenarios

dataikuapi.dss.scenario.DSSScenario(client, ...)	A handle to interact with a scenario on the DSS instance.
dataikuapi.dss.scenario.DSSScenarioRun(...)	A handle containing basic info about a past run of a scenario.
dataikuapi.dss.scenario.DSSTriggerFire(...)	A handle representing the firing of a trigger on a scenario.

API node services

dataikuapi.dss.apiservice.DSSAPIService(...)	An API Service from the API Designer on the DSS instance.
dataikuapi.dss.ml.DSSMLTask(client, ...)	A handle to interact with a ML Task for prediction or clustering in a DSS visual analysis.

User-defined meanings

dataikuapi.dss.meaning.DSSMeaning(client, id)

A user-defined meaning on the DSS instance

Administration

dataikuapi.dss.admin.DSSUser(client, login)	A handle for a user on the DSS instance.
dataikuapi.dss.admin.DSSGroup(client, name)	A group on the DSS instance.
dataikuapi.dss.admin.DSSConnection(client, name)	A connection on the DSS instance.
dataikuapi.dss.admin.DSSAuthorizationMatrix(...)	The authorization matrix of all groups and enabled users of the DSS instance.
dataikuapi.dss.admin.DSSGeneralSettings(client)	The general settings of the DSS instance.
dataikuapi.dss.admin.DSSUserImpersonationRule([raw])	An user-level rule items for the impersonation settings
dataikuapi.dss.admin.DSSGroupImpersonationRule([raw])	A group-level rule items for the impersonation settings
dataikuapi.dss.admin.DSSInstanceVariables(...)	Dict containing the instance variables.
dataikuapi.dss.admin.DSSGlobalUsageSummary(data)	The summary of the usage of the DSS instance.
dataikuapi.dss.admin.DSSPersonalApiKey(...)	A personal API key on the DSS instance.
dataikuapi.dss.admin.DSSPersonalApiKeyListItem(...)	An item in a list of personal API key.
dataikuapi.dss.admin.DSSGlobalApiKey(client, ...)	A global API key on the DSS instance
dataikuapi.dss.future.DSSFuture(client, job_id)	A future represents a long-running task on a DSS instance.
dataikuapi.dss.admin.DSSCluster(client, ...)	A handle to interact with a cluster on the DSS instance.
dataikuapi.dss.data_directories_footprint.DSSDataDirectoriesFootprint(client)	Handle to analyze the footprint of data directories

Secrets Manager

dataikuapi.secretsmanager.secretsmanager.DSSSecretsManager(client)	Collection-level handle for DSS Secrets Manager operations.
dataikuapi.secretsmanager.secretsmanager.DSSSecret(...)	Handle for a specific DSS secret.
dataikuapi.secretsmanager.secretsmanager.DSSLocalSecret(...)	Typed handle for a local DSS secret.
dataikuapi.secretsmanager.secretsmanager.DSSVaultSecret(...)	Typed handle for a DSS secret whose value is resolved from a vault.
dataikuapi.secretsmanager.secretsmanager.DSSSecretType(*values)	Enumeration of DSS secret types.

Vaults Manager

dataikuapi.secretsmanager.vaultsmanager.DSSVaultsManager(client)	Collection-level handle for DSS vault administration operations.
dataikuapi.secretsmanager.vaultsmanager.DSSVault(...)	Handle for a specific DSS vault.
dataikuapi.secretsmanager.vaultsmanager.DSSVaultCacheSettings([...])	Cache settings attached to a DSS vault definition.
dataikuapi.secretsmanager.vaultsmanager.DSSVaultType(*values)	Enumeration of vault provider types supported by DSS.
dataikuapi.secretsmanager.vaultsmanager.AWSEnvironmentAuthConfig()	Use environment-provided AWS credentials when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.AWSIAMRoleAuthConfig(...)	Use an AWS IAM role assumption flow when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.AWSKeypairAuthConfig(...)	Use an explicit AWS access key / secret key pair when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.AWSSecretsManagerAuthConfigBase()	Base class for AWS Secrets Manager vault authentication configurations.
dataikuapi.secretsmanager.vaultsmanager.AWSSecretsManagerAuthMode(*values)	Enumeration of authentication modes supported for AWS Secrets Manager vaults.
dataikuapi.secretsmanager.vaultsmanager.AzureEnvironmentAuthConfig([...])	Use environment-provided Azure credentials when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.AzureManagedIdentityAuthConfig([...])	Use Azure managed identity when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.AzureClientSecretAuthConfig(...)	Use an explicit Azure application client secret when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.AzureClientCertificateAuthConfig(...)	Use an Azure application client certificate when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.AzureKeyVaultAuthConfigBase()	Base class for Azure Key Vault authentication configurations.
dataikuapi.secretsmanager.vaultsmanager.AzureKeyVaultAuthMode(*values)	Enumeration of authentication modes supported for Azure Key Vault vaults.
dataikuapi.secretsmanager.vaultsmanager.GCPEnvironmentAuthConfig([...])	Use Google Application Default Credentials when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.GCPKeypairAuthConfig(...)	Use a GCP service account key or path when accessing the remote vault.
dataikuapi.secretsmanager.vaultsmanager.GCPSecretManagerAuthConfigBase([...])	Base class for GCP Secret Manager vault authentication configurations.
dataikuapi.secretsmanager.vaultsmanager.GCPSecretManagerAuthMode(*values)	Enumeration of authentication modes supported for GCP Secret Manager vaults.

Jupyter notebooks

dataikuapi.dss.jupyternotebook.DSSJupyterNotebook(...)

A handle on a Python/R/scala notebook.

SQL notebooks

dataikuapi.dss.sqlnotebook.DSSSQLNotebook(...)	A handle on a SQL notebook
dataikuapi.dss.sqlnotebook.DSSSQLNotebookListItem(...)	An item in a list of SQL notebooks
dataikuapi.dss.sqlnotebook.DSSNotebookContent(...)	The content of a SQL notebook
dataikuapi.dss.sqlnotebook.DSSNotebookHistory(...)	The history of a SQL notebook
dataikuapi.dss.sqlnotebook.DSSNotebookQueryRunListItem(...)	An item in a list of query runs of a SQL notebook

SQL queries

dataikuapi.dss.sqlquery.DSSSQLQuery(client, ...)

A connection to a database or database-like on which queries can be run through DSS.

Metrics and checks

dataikuapi.dss.metrics.ComputedMetrics(raw)

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

Model Evaluation Store

dataikuapi.dss.modelevaluationstore.DSSModelEvaluationStore(...)	A handle to interact with a model evaluation store on the DSS instance.
dataikuapi.dss.modelevaluationstore.DSSModelEvaluationStoreSettings(...)	A handle on the settings of a model evaluation store
dataikuapi.dss.modelevaluationstore.DSSModelEvaluation(...)	A handle on a model evaluation
dataikuapi.dss.modelevaluationstore.DSSModelEvaluationFullInfo(...)	A handle on the full information on a model evaluation.