Show / Hide Table of Contents

Namespace Oci.DatascienceService.Models

Classes

ApplicationComponent

Reference to an application component

ApplicationComponentModelConverter

ArtifactExportDetails

Details of Artifact source

ArtifactExportDetailsModelConverter

ArtifactExportDetailsObjectStorage

Model artifact source details for exporting artifact to service bucket

ArtifactImportDetails

Details of Artifact source

ArtifactImportDetailsModelConverter

ArtifactImportDetailsObjectStorage

Artifact destination details for importing to destination bucket

AuthConfiguration

AuthN/Z configuration for online prediction

AuthConfigurationModelConverter

AutoScalingPolicy

The scaling policy to enable autoscaling on the model deployment.

AutoScalingPolicyDetails

Details for an autoscaling policy to enable on the model deployment. Each autoscaling configuration can have one autoscaling policy. In a threshold-based autoscaling policy, an autoscaling action is triggered when a performance metric meets or exceeds a threshold.

AutoScalingPolicyDetailsModelConverter

BackupOperationDetails

Backup operation details of the model.

BackupSetting

Back up setting details of the model.

CategoryLogDetails

The log details for each category.

ChangeDataSciencePrivateEndpointCompartmentDetails

The details required to change a private endpoint compartment.

ChangeJobCompartmentDetails

Details for changing the compartment of a job.

ChangeJobRunCompartmentDetails

Details for changing the compartment of a job run.

ChangeMlApplicationCompartmentDetails

The information to be updated.

ChangeMlApplicationImplementationCompartmentDetails

The information to be updated.

ChangeMlApplicationInstanceCompartmentDetails

The information to be updated.

ChangeMlApplicationInstanceViewCompartmentDetails

The information to be updated.

ChangeModelCompartmentDetails

Details for changing the compartment of a model.

ChangeModelDeploymentCompartmentDetails

Details for changing the compartment of a model deployment.

ChangeModelVersionSetCompartmentDetails

Details for changing the compartment of a model version set.

ChangeNotebookSessionCompartmentDetails

Details for changing the compartment of a notebook session.

ChangePipelineCompartmentDetails

Details for which compartment to move the resource to.

ChangePipelineRunCompartmentDetails

Details for which compartment to move the resource to.

ChangeProjectCompartmentDetails

Details for changing the compartment of a project.

ChangeScheduleCompartmentDetails

The information to be updated.

ConfigurationProperty

Property that is used for provisioning of the given MlApplicationInstance. It is validated against configurationSchema defined in referenced MlApplicationImplementation. The value is mandatory with exception for ConfigurationProperty of SECRET type where read operation does not return value field as it contains plain text secret and update operation does not have to contain value field when the secret value should not be updated.

ConfigurationPropertySchema

Schema for single configuration property

ContainerSummary

Summary representation of a container

CreateAuthConfigurationDetails

AuthN/Z configuration for online prediction

CreateAuthConfigurationDetailsModelConverter

CreateDataSciencePrivateEndpointDetails

The details required to create a Data Science private endpoint.

CreateIamAuthConfigurationCreateDetails

Configuration of IAM AuthN/Z for online prediction

CreateIdcsAuthConfigurationDetails

Configuration of IDCS AuthN/Z for online prediction

CreateIdcsCustomServiceAuthConfigurationDetails

Create configuration for existing Oracle Cloud Service

CreateJobDetails

Parameters needed to create a new job.

CreateJobRunDetails

Parameters needed to create a new job run.

CreateJobRunScheduleActionDetails

create job run details

CreateMlApplicationDetails

The information about new MlApplication.

CreateMlApplicationImplementationDetails

The information about new MlApplicationImplementation.

CreateMlApplicationInstanceDetails

The information about new MlApplicationInstance.

CreateModelDeploymentDetails

Parameters needed to create a new model deployment. Model deployments are used by data scientists to perform predictions from the model hosted on an HTTP server.

CreateModelDetails

Parameters needed to create a new model. Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifact.

CreateModelProvenanceDetails

Model provenance gives data scientists information about the origin of their model. This information allows data scientists to reproduce the development environment in which the model was trained.

CreateModelVersionSetDetails

Parameters that are required to create a new model version set.

CreateNotebookSessionDetails

Parameters needed to create a new notebook session. Notebook sessions are interactive coding environments for data scientists.

CreatePipelineDetails

The information about new Pipeline.

CreatePipelineRunDetails

The information about new PipelineRun.

CreatePipelineRunScheduleActionDetails

create pipeline run details

CreateProjectDetails

Parameters needed to create a new project. Projects enable users to organize their data science work.

CreateScheduleDetails

Creation details for a new schedule.

CustomExpressionQueryScalingConfiguration

The scaling configuration for the custom metric expression rule.

CustomMetricExpressionRule

A custom Monitoring Query Language (MQL) expression for triggering an autoscaling action on the model deployment.

DataFlowApplicationApplicationComponent

Data Flow Application application component

DataScienceJobApplicationComponent

Data Science Job application component

DataScienceModelApplicationComponent

Data Science Model application component

DataScienceModelDeploymentInstanceComponent

Reference to Data Science Model Deployment

DataSciencePipelineApplicationComponent

Data Science Pipeline application component

DataSciencePrivateEndpoint

Data Science private endpoint.

DataSciencePrivateEndpointSummary

List of Data Science private endpoints.

DataScienceScheduleInstanceComponent

Data Science Schedule instance component

DefaultJobConfigurationDetails

The default job configuration.

DefaultModelDeploymentEnvironmentConfigurationDetails

The environment configuration details object for managed container

DisableMlApplicationInstanceViewTriggerDetails

Payload for disable trigger action

EnableMlApplicationInstanceViewTriggerDetails

Payload for enable trigger action

ExportModelArtifactDetails

Details required for exporting the model artifact from source to service bucket

FastLaunchJobConfigSummary

The shape config to launch a fast launch capable job instance

FileStorageMountConfigurationDetails

The File Storage Mount Configuration Details.

FixedSizeScalingPolicy

The fixed size scaling policy.

GenericJobRunUseCaseConfigurationDetails

The evaluation use-case configuration.

GenericOciResourceApplicationComponent

Generic OCI resource application component

GenericOciResourceInstanceComponent

Generic OCI resource instance component

IamAuthConfiguration

Configuration of IAM AuthN/Z for online prediction

IdcsAuthConfiguration

Configuration of IDCS AuthN/Z for online prediction

IdcsCustomServiceAuthConfiguration

Using existing Oracle Cloud Service for online prediction AuthN/Z

ImplementationLogDetails

Log configuration details for particular areas of ML Application Implementation.

ImplementationLogging

Configuration of Logging for ML Application Implementation.

ImportModelArtifactDetails

Details required for importing the artifact from service bucket

InstanceComponent

Reference to instance component

InstanceComponentModelConverter

InstanceConfiguration

The model deployment instance configuration

InstancePoolModelDeploymentSystemData

Instance pool based model deployment system data.

InvokeMlApplicationProviderTriggerScheduleActionDetails

invoke ml application trigger details

Job

A job for training models.

JobConfigurationDetails

The job configuration details

JobConfigurationDetailsModelConverter

JobEnvironmentConfigurationDetails

Environment configuration to capture job runtime dependencies.

JobEnvironmentConfigurationDetailsModelConverter

JobInfrastructureConfigurationDetails

The job infrastructure configuration details (shape, block storage, etc.)

JobInfrastructureConfigurationDetailsModelConverter

JobLogConfigurationDetails

Logging configuration for resource.

JobRun

A job run.

JobRunLogDetails

Customer logging details for job run.

JobRunSummary

Summary information for a job run.

JobRunUseCaseConfigurationDetails

The use-case configuration details

JobRunUseCaseConfigurationDetailsModelConverter

JobRunWorkloadConfigurationDetails

The job run workload configuration.

JobShapeConfigDetails

Details for the job run shape configuration. Specify only when a flex shape is selected.

JobShapeSummary

The compute shape used to launch a job compute instance.

JobSummary

Summary information for a job.

LogDetails

The log details.

ManagedEgressStandaloneJobInfrastructureConfigurationDetails

The standalone job infrastructure configuration with network egress settings preconfigured.

Metadata

Defines properties of each model metadata.

MetricExpressionRule

The metric expression rule base.

MetricExpressionRuleModelConverter

MlApplication

Resource representing a definition of an AI/ML use-case

MlApplicationCollection

Results of a mlApplication search. It contains list of MlApplicationSummary items.

MlApplicationImplementation

Resource representing solution for AI/ML use-case defined by ML Application

MlApplicationImplementationCollection

Results of a MlApplicationImplementation search. It contains list of MlApplicationImplementationSummary items.

MlApplicationImplementationSummary

Summary of the MlApplicationImplementation.

MlApplicationImplementationVersion

Read-only fully managed snapshot of MlApplicationImplementation taken when MlApplicationImplementation was updated with new ML Application package.

MlApplicationImplementationVersionCollection

Results of a MlApplicationImplementationVersion search. It contains list of MlApplicationImplementationVersionSummary items.

MlApplicationImplementationVersionSummary

Summary of the MlApplicationImplementationVersion.

MlApplicationInstance

Resource representing instance of ML Application.

MlApplicationInstanceCollection

Results of a mlApplicationInstance search. It contains list of MlApplicationInstanceSummary items.

MlApplicationInstanceInternalTrigger

Trigger details

MlApplicationInstanceSummary

Summary of the MlApplicationInstance.

MlApplicationInstanceView

Representation of ML Application Instance which providers use for instance observability.

MlApplicationInstanceViewCollection

Results of a MlApplicationInstanceView search. It contains list of MlApplicationInstanceViewSummary items.

MlApplicationInstanceViewSummary

Summary of the MlApplicationInstanceView.

MlApplicationPackageArgumentDetails

Represents single argument name value pair.

MlApplicationPackageArguments

List of ML Application package arguments provided during ML Application package upload.

MlApplicationSummary

Summary of the MlApplication.

Model

Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifacts.

ModelArtifactReferenceDetails

Reference to the location where the model artifact is stored.

ModelArtifactReferenceDetailsModelConverter

ModelConfigurationDetails

The model configuration details.

ModelDeployWorkloadConfigurationDetails

The model deployment workload configuration.

ModelDeployment

Model deployments are used by data scientists to perform predictions from the model hosted on an HTTP server.

ModelDeploymentConfigurationDetails

The model deployment configuration details.

ModelDeploymentConfigurationDetailsModelConverter

ModelDeploymentEnvironmentConfigurationDetails

The configuration to carry the environment details thats used in Model Deployment creation

ModelDeploymentEnvironmentConfigurationDetailsModelConverter

ModelDeploymentInstanceShapeConfigDetails

Details for the model-deployment instance shape configuration.

ModelDeploymentShapeSummary

The compute shape used to launch a model deployment compute instance.

ModelDeploymentSummary

Summary information for a model deployment.

ModelDeploymentSystemData

Model deployment system data.

ModelDeploymentSystemDataModelConverter

ModelProvenance

Model provenance gives data scientists information about the origin of their model. This information allows data scientists to reproduce the development environment in which the model was trained.

ModelSummary

Summary information for a model.

ModelVersionSet

A model version set to associate different versions of machine learning models.

ModelVersionSetSummary

Summary information for a model version set.

NotebookSession

Notebook sessions are interactive coding environments for data scientists.

NotebookSessionConfigDetails

Details for the notebook session configuration.

NotebookSessionConfigurationDetails

Details for the notebook session configuration.

NotebookSessionGitConfigDetails

Git configuration Details.

NotebookSessionGitRepoConfigDetails

Git repository configurations.

NotebookSessionRuntimeConfigDetails

Notebook Session runtime configuration details.

NotebookSessionShapeConfigDetails

Details for the notebook session shape configuration.

NotebookSessionShapeSummary

The compute shape used to launch a notebook session compute instance.

NotebookSessionSummary

Summary information for a notebook session.

OSSModelArtifactReferenceDetails

Reference to the OSS where model artifact is stored

ObjectStorageBucketInstanceComponent

Reference to Object Storage Bucket

ObjectStorageMountConfigurationDetails

The Object Storage Configuration Details.

ObjectStorageObjectInstanceComponent

Reference to Object Storage Object

OcirContainerJobEnvironmentConfigurationDetails

Environment configuration based on container image stored in OCI Container Registry.

OcirModelDeploymentEnvironmentConfigurationDetails

The environment configuration details object for OCI Registry

Pipeline

A Pipeline to orchestrate and execute machine learning workflows.

PipelineConfigurationDetails

The configuration details of a pipeline.

PipelineConfigurationDetailsModelConverter

PipelineContainerConfigurationDetails

Container Details for a step in pipeline.

PipelineContainerConfigurationDetailsModelConverter

PipelineContainerStepDetails

The type of step where user provides the container details for an execution engine managed by the pipelines service.

PipelineContainerStepRun

Detail of each ContainerStepRun.

PipelineContainerStepUpdateDetails

Update the details for a container step type.

PipelineCustomScriptStepDetails

The type of step where user provides the step artifact to be executed on an execution engine managed by the pipelines service.

PipelineCustomScriptStepRun

Detail of each CustomScriptStepRun.

PipelineCustomScriptStepUpdateDetails

The type of step where user provides the step artifact to be executed on an execution engine managed by the pipelines service.

PipelineDataflowConfigurationDetails

The configuration details of a Dataflow step.

PipelineDataflowStepDetails

The type of step where the dataflow application is pre-created by the user.

PipelineDataflowStepRun

Detail of each Dataflow Step Run.

PipelineDataflowStepUpdateDetails

The type of step where the dataflow application is pre-created by the user.

PipelineDefaultConfigurationDetails

The default pipeline configuration.

PipelineInfrastructureConfigurationDetails

The infrastructure configuration details of a pipeline or a step.

PipelineLogConfigurationDetails

The pipeline log configuration details.

PipelineMLJobStepDetails

The type of step where the job is pre-created by the user.

PipelineMLJobStepRun

Detail of each MLJobStepRun.

PipelineMLJobStepUpdateDetails

The type of step where the job is pre-created by the user.

PipelineOcirContainerConfigurationDetails

Container configuration based on image stored in OCI Container Registry.

PipelineRun

Description of PipelineRun.

PipelineRunLogDetails

Customer logging details for pipeline run.

PipelineRunSummary

Summary of the PipelineRun.

PipelineShapeConfigDetails

Details for the pipeline step run shape configuration. Specify only when a flex shape is selected.

PipelineStepConfigurationDetails

The configuration details of a step.

PipelineStepDetails

A step in the pipeline.

PipelineStepDetailsModelConverter

PipelineStepOverrideDetails

Override details of the step. Only Step Configuration is allowed to be overridden.

PipelineStepRun

Detail of each StepRun.

PipelineStepRunModelConverter

PipelineStepUpdateDetails

The details of the step to update.

PipelineStepUpdateDetailsModelConverter

PipelineSummary

Summary of the Pipeline.

PredefinedExpressionThresholdScalingConfiguration

The scaling configuration for the predefined metric expression rule.

PredefinedMetricExpressionRule

An expression built using CPU or Memory metrics for triggering an autoscaling action on the model deployment.

PredictionEndpointDetails

Prediction endpoint related information.

PredictionUri

Prediction URI per use-case.

Project

Projects enable users to organize their data science work.

ProjectSummary

Summary information for a project.

RegisterModelArtifactReferenceDetails

Parameters that are required to register a model artifact reference collection.

RetentionOperationDetails

Retention operation details for the model.

RetentionSetting

Retention setting details of the model.

ScalingConfiguration

Scaling configuration for the metric expression rule.

ScalingConfigurationModelConverter

ScalingPolicy

The scaling policy to apply to each model of the deployment.

ScalingPolicyModelConverter

Schedule

A repeating action. Examples:

  • Invoke a ML Pipeline Run once an hour.
  • Call ML Job Run every night at midnight.

ScheduleAction

The schedule action

ScheduleActionModelConverter

ScheduleCronTrigger

The scheduled UNIX cron definition.

ScheduleHttpAction

this is HTTP action

ScheduleHttpActionDetails

Schedule Http action details

ScheduleHttpActionDetailsModelConverter

ScheduleICalTrigger

The iCal schedule trigger.

ScheduleIntervalTrigger

The interval schedule trigger.

ScheduleLogDetails

Custom logging details for schedule execution.

ScheduleSummary

Summary representation of a schedule.

ScheduleTrigger

The trigger of the schedule can be UNIX cron or iCal expression or simple interval

ScheduleTriggerModelConverter

SingleModelDeploymentConfigurationDetails

The single model type deployment.

StandaloneJobInfrastructureConfigurationDetails

The standalone job infrastructure configuration.

StorageMountConfigurationDetails

The storage mount configuration details

StorageMountConfigurationDetailsModelConverter

TagConfiguration

Defines properties of each container tag metadata.

ThresholdBasedAutoScalingPolicyDetails

Details for a threshold-based autoscaling policy to enable on the model deployment. In a threshold-based autoscaling policy, an autoscaling action is triggered when a performance metric meets or exceeds a threshold.

TriggerMlApplicationInstanceFlowDetails

Payload for trigger request endpoint

TriggerMlApplicationInstanceViewFlowDetails

Payload for trigger request endpoint

TriggerParameter

Trigger parameter

UpdateCategoryLogDetails

The log details for each category for update.

UpdateDataSciencePrivateEndpointDetails

The details required to update a private endpoint.

UpdateDefaultModelDeploymentEnvironmentConfigurationDetails

The update environment configuration details object for managed container

UpdateJobDetails

Details for updating a job.

UpdateJobRunDetails

Details for updating a job run.

UpdateMlApplicationDetails

The information to be updated.

UpdateMlApplicationImplementationDetails

The information to be updated.

UpdateMlApplicationImplementationVersionDetails

The information to be updated.

UpdateMlApplicationInstanceDetails

The information to be updated.

UpdateMlApplicationInstanceViewDetails

The information to be updated.

UpdateModelConfigurationDetails

The model configuration details for update.

UpdateModelDeploymentConfigurationDetails

The model deployment configuration details for update.

UpdateModelDeploymentConfigurationDetailsModelConverter

UpdateModelDeploymentDetails

Details for updating a model deployment. You can update modelDeploymentConfigurationDetails and change instanceShapeName and modelId when the model deployment is in the ACTIVE lifecycle state. The bandwidthMbps or instanceCount can only be updated while the model deployment is in the INACTIVE state. Changes to the bandwidthMbps or instanceCount will take effect the next time the ActivateModelDeployment action is invoked on the model deployment resource.

UpdateModelDeploymentEnvironmentConfigurationDetails

The configuration to carry the environment details thats used in Model Deployment update

UpdateModelDeploymentEnvironmentConfigurationDetailsModelConverter

UpdateModelDetails

Details for updating a model.

UpdateModelProvenanceDetails

Model provenance gives data scientists information about the origin of their model. This information allows data scientists to reproduce the development environment in which the model was trained.

UpdateModelVersionSetDetails

Details for updating a model version set.

UpdateNotebookSessionDetails

Details for updating a notebook session. notebookSessionConfigurationDetails can only be updated while the notebook session is in the INACTIVE state. Changes to the notebookSessionConfigurationDetails take effect the next time the ActivateNotebookSession action is invoked on the notebook session resource.

UpdateOcirModelDeploymentEnvironmentConfigurationDetails

The update environment configuration details object for OCI Registry

UpdatePipelineDetails

The information of pipeline to be updated.

UpdatePipelineRunDetails

The information to be updated.

UpdateProjectDetails

Details for updating a project.

UpdateScheduleDetails

Update details for a schedule.

UpdateSingleModelDeploymentConfigurationDetails

The single model type deployment for update.

WorkRequest

An asynchronous work request.

WorkRequestError

Errors related to a specific work request.

WorkRequestLogEntry

Log entries related to a specific work request.

WorkRequestResource

The properties that define a work request resource.

WorkRequestSummary

Summary information for a work request.

WorkloadConfigurationDetails

The workload configuration details

WorkloadConfigurationDetailsModelConverter

Enums

ApplicationComponent.TypeEnum

ArtifactSourceType

Possible sources where artifact would be present

AuthConfiguration.TypeEnum

AutoScalingPolicyDetails.AutoScalingPolicyTypeEnum

ConfigurationPropertySchema.ValueTypeEnum

ContainerSummary.TargetWorkloadsEnum

ContainerSummary.UsagesEnum

ContainerTargetWorkload

The target workload of the container.

ContainerUsage

The Usage of the container.

ContainerVersionLifecycleState

Container Version LifecycleState enum.

DataSciencePrivateEndpointLifecycleState

The current state of the private endpoint.

DataScienceResourceType

Data Science resource type.

FastLaunchJobConfigSummary.ManagedEgressSupportEnum

FastLaunchJobConfigSummary.ShapeSeriesEnum

InstanceComponent.TypeEnum

JobConfigurationDetails.JobTypeEnum

JobEnvironmentConfigurationDetails.JobEnvironmentTypeEnum

JobInfrastructureConfigurationDetails.JobInfrastructureTypeEnum

JobLifecycleState

The status of a job.

JobRunLifecycleState

The status of a job run.

JobRunUseCaseConfigurationDetails.UseCaseTypeEnum

JobShapeSummary.ShapeSeriesEnum

MetricExpressionRule.MetricExpressionRuleTypeEnum

MlApplication.LifecycleStateEnum

MlApplicationImplementation.LifecycleStateEnum

MlApplicationImplementationVersion.LifecycleStateEnum

MlApplicationInstance.LifecycleStateEnum

MlApplicationInstance.LifecycleSubstateEnum

MlApplicationInstanceView.LifecycleStateEnum

MlApplicationInstanceView.LifecycleSubstateEnum

MlApplicationPackageArgumentDetails.TypeEnum

ModelArtifactReferenceDetails.ModelArtifactReferenceTypeEnum

ModelCategory

The category of a model.

ModelDeploymentEnvironmentConfigurationType

The environment of Model Deployment.

ModelDeploymentInstanceShapeConfigDetails.CpuBaselineEnum

ModelDeploymentLifecycleState

The lifecycle state of a model deployment.

ModelDeploymentShapeSeries

The family that the compute shape belongs to.

ModelDeploymentSystemData.SystemInfraTypeEnum

ModelDeploymentType

The type of model deployment.

ModelLifecycleState

The lifecycle state of a model.

ModelSettingActionState

Represents the state of the model for backup, archival and deletion.

ModelSettingCustomerNotificationType

Customer notification type based on setting action events for backup, archival and deletion.

ModelVersionSetCategory

The lifecycle state of a model.

ModelVersionSetLifecycleState

The lifecycle state of a model version set.

NotebookSessionLifecycleState

The lifecycle state of a notebook session.

NotebookSessionShapeSeries

The family that the compute shape belongs to.

PipelineConfigurationDetails.TypeEnum

PipelineContainerConfigurationDetails.ContainerTypeEnum

PipelineLifecycleState

The lifecycle state of a pipeline.

PipelineRunLifecycleState

The lifecycle state of a pipeline run.

PipelineStepDetails.StepTypeEnum

PipelineStepRun.LifecycleStateEnum

PipelineStepRun.StepTypeEnum

PipelineStepUpdateDetails.StepTypeEnum

PredefinedMetricExpressionRule.MetricTypeEnum

ProjectLifecycleState

The lifecycle state of a project.

ScalingConfiguration.ScalingConfigurationTypeEnum

ScalingPolicy.PolicyTypeEnum

ScheduleAction.ActionTypeEnum

ScheduleHttpActionDetails.HttpActionTypeEnum

ScheduleIntervalTrigger.FrequencyEnum

ScheduleLifecycleState

The status of a schedule.

ScheduleTrigger.TriggerTypeEnum

StorageMountConfigurationDetails.StorageTypeEnum

WorkRequestOperationType

The types of work request operations.

WorkRequestResource.ActionTypeEnum

WorkRequestStatus

The status of a work request.

WorkloadConfigurationDetails.WorkloadTypeEnum

In this article
Back to top