Python

This section contains the index of classes in the public API Python client of Dataiku and serves as its reference documentation.

• Index
• Datasets
  • The dataiku.Dataset class
  • The dataikuapi.dss.dataset package
• Managed folders
  • dataiku package
  • dataikuapi package
• The main API client
  • DSSClient
  • TemporaryImportHandle
• Interaction with Pyspark
  • start_spark_context_and_setup_sql_context()
  • setup_sql_context()
  • distribute_py_libs()
  • get_dataframe()
  • write_schema_from_dataframe()
  • write_dataframe()
  • write_with_schema()
  • apply_prepare_recipe()
• Projects
  • DSSProject
  • DSSProjectGit
  • Project
• Recipes
  • DSSRecipe
  • DSSRecipeListItem
  • DSSRecipeStatus
  • RequiredSchemaUpdates
  • Settings
  • Creation
  • Utilities
• Scenarios
  • DSSScenario
  • DSSScenarioStatus
  • DSSScenarioSettings
  • StepBasedScenarioSettings
  • PythonScriptBasedScenarioSettings
  • DSSScenarioRun
  • DSSScenarioRunDetails
  • DSSStepRunDetails
  • DSSScenarioRunWaiter
  • DSSTriggerFire
  • DSSScenarioListItem
• Flow creation and management
  • DSSProjectFlow
  • DSSProjectFlowGraph
  • DSSFlowZone
  • DSSFlowZoneSettings
  • DSSSchemaPropagationRunBuilder
• LLM Mesh
  • DSSLLM
  • DSSLLMListItem
  • DSSLLMCompletionsQuery
  • DSSLLMCompletionsQuerySingleQuery
  • DSSLLMCompletionsResponse
  • DSSLLMCompletionQuery
  • DSSLLMCompletionQueryMultipartMessage
  • DSSLLMCompletionResponse
  • DSSLLMEmbeddingsQuery
  • DSSLLMEmbeddingsResponse
  • DSSKnowledgeBankListItem
  • DSSKnowledgeBank
  • KnowledgeBank
  • DKULLM
  • DKUChatModel
  • DKUEmbeddings
• Machine learning
  • API Reference
  • Algorithm details
• Experiment Tracking
  • DSSMLflowExtension
• Statistics worksheets
  • DSSStatisticsWorksheet
  • DSSStatisticsWorksheetSettings
  • DSSStatisticsCardSettings
  • DSSStatisticsCardResult
  • DSSStatisticsComputationSettings
  • DSSStatisticsComputationResult
• API Designer & Deployer
  • API Designer
  • API Deployer
• Project Deployer
  • DSSProjectDeployer
  • Infrastructures
  • Published projects
  • Deployments
• Static insights
  • save_data()
  • save_figure()
  • save_bokeh()
  • save_plotly()
  • save_ggplot()
• Jobs
  • JobDefinitionBuilder
  • DSSJob
  • DSSJobWaiter
• Authentication information and impersonation
• Importing tables as datasets
  • TablesImportDefinition
  • TablesPreparedImport
• Wiki
  • DSSWiki
  • DSSWikiSettings
  • DSSWikiArticle
  • DSSWikiArticleData
• Discussions
  • DSSObjectDiscussions
  • DSSDiscussion
  • DSSDiscussionReply
• Performing SQL, Hive and Impala queries
  • SQLExecutor2
  • HiveExecutor
  • ImpalaExecutor
• SQL Query
  • DSSSQLQuery
• Project libraries
  • DSSLibrary
  • DSSLibraryItem
  • DSSLibraryFolder
  • DSSLibraryFile
• Meanings
  • DSSMeaning
• Users and groups
  • DSSUser
  • DSSUserSettings
  • DSSOwnUser
  • DSSOwnUserSettings
  • DSSUserActivity
  • DSSGroup
  • DSSAuthorizationMatrix
• Connections
  • DSSConnection
  • DSSConnectionInfo
  • DSSConnectionListItem
  • DSSConnectionSettings
  • DSSConnectionDetailsReadability
• Scenarios (in a scenario)
  • Scenario
  • BuildFlowItemsStepDefHelper
• Code envs
  • DSSCodeEnv
  • DSSDesignCodeEnvSettings
  • DSSAutomationCodeEnvSettings
  • DSSAutomationCodeEnvVersionSettings
• Plugins
  • DSSPlugin
  • DSSPluginSettings
  • DSSPluginProjectSettings
  • DSSPluginParameterSet
  • DSSPluginProjectParameterSet
  • DSSPluginPreset
  • DSSPluginUsage
  • DSSMissingType
  • DSSPluginUsages
  • DSSMacro
• Project folders
  • DSSProjectFolder
  • DSSProjectFolderSettings
• Macros
• Dataiku applications
  • DSSApp
  • DSSAppListItem
  • DSSAppInstance
  • DSSAppManifest
  • TemporaryDSSAppInstance
• Feature Store
  • DSSFeatureStore
  • DSSFeatureGroupListItem
• Streaming endpoints
  • StreamingEndpoint
  • StreamingEndpointStream
  • ContinuousWriterBase
  • StreamingEndpointContinuousWriter
  • DSSStreamingEndpointListItem
  • DSSStreamingEndpoint
  • DSSStreamingEndpointSettings
  • KafkaStreamingEndpointSettings
  • HTTPSSEStreamingEndpointSettings
  • DSSManagedStreamingEndpointCreationHelper
  • DSSContinuousActivity
• Snowpark
  • DkuSnowpark
• Databricks Connect
  • DkuDBConnect
• Unified Monitoring
  • DSSUnifiedMonitoring
  • Project Monitoring
  • API Endpoint Monitoring
• Metrics and checks
  • dataiku package API
  • dataikuapi package API
• Model Evaluation Stores
  • dataiku package API
  • dataikuapi package API
• Other administration tasks
  • DSSGeneralSettings
  • DSSUserImpersonationRule
  • DSSGroupImpersonationRule
  • DSSInstanceVariables
  • DSSFuture
  • DSSJupyterNotebook
  • DSSJupyterNotebookListItem
  • DSSNotebookSession
  • DSSNotebookContent
  • DSSNotebook
  • DSSGlobalApiKey
  • DSSGlobalApiKeyListItem
  • DSSGlobalUsageSummary
  • DSSPersonalApiKey
  • DSSPersonalApiKeyListItem
• Utilities
  • DSSDatasetSelectionBuilder
  • DSSFilterBuilder
  • DSSInfoMessages
  • DSSInfoMessage
• Index of the dataiku package
  • Datasets
  • Managed folders
  • Streaming Endpoints
  • Saved models
  • Metrics and checks
  • Model Evaluation Stores
  • Projects
• Index of the dataikuapi package
  • Core classes
  • Project folders
  • Datasets
  • Statistics worksheets
  • Managed folders
  • Streaming endpoint
  • Recipes
  • Machine Learning
  • Experiment Tracking
  • Code Studios
  • Jobs
  • Scenarios
  • API node services
  • User-defined meanings
  • Administration
  • SQL queries
  • Metrics and checks
  • Model Evaluation Store
• API for plugin components
  • API for plugin recipes
  • API for plugin datasets
  • API for plugin formats
  • API for plugin FS providers
• Clusters
  • DSSCluster
  • DSSClusterSettings
  • DSSClusterStatus
• Code Studios
  • DSSCodeStudioObject
  • DSSCodeStudioObjectListItem
  • DSSCodeStudioObjectSettings
  • DSSCodeStudioObjectStatus
  • DSSCodeStudioObjectConflicts
  • DSSCodeStudioTemplateListItem
  • DSSCodeStudioTemplate
  • DSSCodeStudioTemplateSettings
• Fleet Manager
  • The main FMClient class
  • Fleet Manager Instances
  • Fleet Manager Virtual Networks
  • Fleet Manager Instance Templates
  • Fleet Manager Tenant
  • Fleet Manager Future
• Govern
  • GovernClient
  • GovernBlueprintListItem
  • GovernBlueprint
  • GovernBlueprintDefinition
  • GovernBlueprintVersionListItem
  • GovernBlueprintVersion
  • GovernBlueprintVersionTrace
  • GovernBlueprintVersionDefinition
  • GovernArtifact
  • GovernArtifactDefinition
  • GovernArtifactSignoffListItem
  • GovernArtifactSignoff
  • GovernArtifactSignoffDefinition
  • GovernArtifactSignoffRecurrenceConfiguration
  • GovernArtifactSignoffDetails
  • GovernArtifactSignoffFeedbackListItem
  • GovernArtifactSignoffFeedback
  • GovernArtifactSignoffFeedbackDefinition
  • GovernArtifactSignoffApproval
  • GovernArtifactSignoffApprovalDefinition
  • GovernUploadedFile
  • GovernTimeSeries
  • GovernArtifactSearchRequest
  • GovernArtifactSearchResponse
  • GovernArtifactSearchResponseHit
  • GovernArtifactSearchQuery
  • GovernArtifactSearchSource
  • GovernArtifactSearchSourceAll
  • GovernArtifactSearchSort
  • GovernArtifactSearchSortName
  • GovernArtifactSearchSortWorkflow
  • GovernArtifactSearchSortField
  • GovernArtifactSearchSortFieldDefinition
  • GovernArtifactFilter
  • GovernArtifactFilterBlueprints
  • GovernArtifactFilterBlueprintVersions
  • GovernArtifactFilterArtifacts
  • GovernArtifactFilterFieldValue
  • GovernArtifactFilterArchivedStatus
  • GovernAdminBlueprintDesigner
  • GovernAdminBlueprintListItem
  • GovernAdminBlueprint
  • GovernAdminBlueprintDefinition
  • GovernAdminBlueprintVersionListItem
  • GovernAdminBlueprintVersion
  • GovernAdminBlueprintVersionDefinition
  • GovernAdminBlueprintVersionTrace
  • GovernAdminSignoffConfigurationListItem
  • GovernAdminSignoffConfiguration
  • GovernAdminSignoffConfigurationDefinition
  • GovernAdminRolesPermissionsHandler
  • GovernAdminRoleListItem
  • GovernAdminRole
  • GovernAdminRoleDefinition
  • GovernAdminBlueprintRoleAssignmentsListItem
  • GovernAdminBlueprintRoleAssignments
  • GovernAdminBlueprintRoleAssignmentsDefinition
  • GovernAdminBlueprintPermissionsListItem
  • GovernAdminBlueprintPermissions
  • GovernAdminBlueprintPermissionsDefinition
  • GovernAdminDefaultPermissionsDefinition
  • GovernUser
  • GovernUserSettings
  • GovernOwnUser
  • GovernOwnUserSettings
  • GovernGroup
  • GovernGeneralSettings
  • GovernGlobalApiKey
  • GovernCustomPageListItem
  • GovernCustomPage
  • GovernCustomPageDefinition
  • GovernAdminCustomPagesHandler
  • GovernAdminCustomPageListItem
  • GovernAdminCustomPage
  • GovernAdminCustomPageDefinition
  • GovernBlueprintVersionId
  • GovernUsersContainer
  • GovernUserUsersContainer
• Workspaces
  • DSSWorkspace
  • DSSWorkspaceObject
  • DSSWorkspaceSettings
  • DSSWorkspacePermissionItem
• Data Collections
  • DSSDataCollection
  • DSSDataCollectionListItem
  • DSSDataCollectionSettings
  • DSSDataCollectionPermissionItem
  • DSSDataCollectionItem
• Data Quality
  • DSSDataQualityRuleSet
  • DSSDataQualityRule
  • DSSDataQualityRuleResult
• Webapps
  • DSSWebApp
  • DSSWebAppBackendClient
  • DSSWebAppBackendState
  • DSSWebAppSettings
  • DSSWebAppListItem
• Dashboards
  • DSSDashboard
  • DSSDashboardSettings
  • DSSDashboardListItem
• Insights
  • DSSInsight
  • DSSInsightSettings
  • DSSInsightListItem
• Messaging channels
  • DSSMessagingChannelListItem
  • DSSMailMessagingChannel
  • DSSMessagingChannel