Data Science Functions

Package: DBMS_CLOUD_OCI_DSC_DATA_SCIENCE

ACTIVATE_MODEL Function

Activates the model.

Syntax

FUNCTION activate_model (
  model_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_activate_model_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

ACTIVATE_MODEL_DEPLOYMENT Function

Activates the model deployment.

Syntax

FUNCTION activate_model_deployment (
  model_deployment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_activate_model_deployment_response_t;

Parameters

Parameter Description

model_deployment_id

(required) The OCID of the model deployment.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

ACTIVATE_NOTEBOOK_SESSION Function

Activates the notebook session.

Syntax

FUNCTION activate_notebook_session (
  notebook_session_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_activate_notebook_session_response_t;

Parameters

Parameter Description

notebook_session_id

(required) The OCID of the notebook session.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CANCEL_JOB_RUN Function

Cancels an IN_PROGRESS job run.

Syntax

FUNCTION cancel_job_run (
  job_run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_cancel_job_run_response_t;

Parameters

Parameter Description

job_run_id

(required) The OCID of the job run.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CANCEL_PIPELINE_RUN Function

Cancel a PipelineRun.

Syntax

FUNCTION cancel_pipeline_run (
  pipeline_run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_cancel_pipeline_run_response_t;

Parameters

Parameter Description

pipeline_run_id

(required) The OCID of the pipeline run.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CANCEL_WORK_REQUEST Function

Cancels a work request that has not started.

Syntax

FUNCTION cancel_work_request (
  work_request_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_cancel_work_request_response_t;

Parameters

Parameter Description

work_request_id

(required) The OCID of the work request.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DATA_SCIENCE_PRIVATE_ENDPOINT_COMPARTMENT Function

Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_data_science_private_endpoint_compartment (
  data_science_private_endpoint_id varchar2,
  change_data_science_private_endpoint_compartment_details dbms_cloud_oci_datascience_change_data_science_private_endpoint_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_data_science_private_endpoint_compartment_response_t;

Parameters

Parameter Description

data_science_private_endpoint_id

(required) The unique ID for a Data Science private endpoint.

change_data_science_private_endpoint_compartment_details

(required) Details for changing a private endpoint's compartment.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_JOB_COMPARTMENT Function

Changes a job's compartment

Syntax

FUNCTION change_job_compartment (
  job_id varchar2,
  change_job_compartment_details dbms_cloud_oci_datascience_change_job_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_job_compartment_response_t;

Parameters

Parameter Description

job_id

(required) The OCID of the job.

change_job_compartment_details

(required) Details for changing the compartment of a job.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_JOB_RUN_COMPARTMENT Function

Changes a job run's compartment

Syntax

FUNCTION change_job_run_compartment (
  job_run_id varchar2,
  change_job_run_compartment_details dbms_cloud_oci_datascience_change_job_run_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_job_run_compartment_response_t;

Parameters

Parameter Description

job_run_id

(required) The OCID of the job run.

change_job_run_compartment_details

(required) Details for changing the compartment of a job.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MODEL_COMPARTMENT Function

Moves a model resource into a different compartment.

Syntax

FUNCTION change_model_compartment (
  model_id varchar2,
  change_model_compartment_details dbms_cloud_oci_datascience_change_model_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_model_compartment_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

change_model_compartment_details

(required) Details for changing the compartment of a model.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MODEL_DEPLOYMENT_COMPARTMENT Function

Moves a model deployment into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_model_deployment_compartment (
  model_deployment_id varchar2,
  change_model_deployment_compartment_details dbms_cloud_oci_datascience_change_model_deployment_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_model_deployment_compartment_response_t;

Parameters

Parameter Description

model_deployment_id

(required) The OCID of the model deployment.

change_model_deployment_compartment_details

(required) Details for changing the compartment of a model deployment.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MODEL_VERSION_SET_COMPARTMENT Function

Moves a modelVersionSet resource into a different compartment.

Syntax

FUNCTION change_model_version_set_compartment (
  model_version_set_id varchar2,
  change_model_version_set_compartment_details dbms_cloud_oci_datascience_change_model_version_set_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_model_version_set_compartment_response_t;

Parameters

Parameter Description

model_version_set_id

(required) The OCID of the model version set.

change_model_version_set_compartment_details

(required) Details for changing the compartment of a model version set.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_NOTEBOOK_SESSION_COMPARTMENT Function

Moves a notebook session resource into a different compartment.

Syntax

FUNCTION change_notebook_session_compartment (
  notebook_session_id varchar2,
  change_notebook_session_compartment_details dbms_cloud_oci_datascience_change_notebook_session_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_notebook_session_compartment_response_t;

Parameters

Parameter Description

notebook_session_id

(required) The OCID of the notebook session.

change_notebook_session_compartment_details

(required) Details for changing the compartment of a notebook session.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PIPELINE_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_pipeline_compartment (
  pipeline_id varchar2,
  change_pipeline_compartment_details dbms_cloud_oci_datascience_change_pipeline_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_pipeline_compartment_response_t;

Parameters

Parameter Description

pipeline_id

(required) The OCID of the pipeline.

change_pipeline_compartment_details

(required) Details for the compartment move.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PIPELINE_RUN_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_pipeline_run_compartment (
  pipeline_run_id varchar2,
  change_pipeline_run_compartment_details dbms_cloud_oci_datascience_change_pipeline_run_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_pipeline_run_compartment_response_t;

Parameters

Parameter Description

pipeline_run_id

(required) The OCID of the pipeline run.

change_pipeline_run_compartment_details

(required) Details for the compartment move.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PROJECT_COMPARTMENT Function

Moves a project resource into a different compartment.

Syntax

FUNCTION change_project_compartment (
  project_id varchar2,
  change_project_compartment_details dbms_cloud_oci_datascience_change_project_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_change_project_compartment_response_t;

Parameters

Parameter Description

project_id

(required) The OCID of the project.

change_project_compartment_details

(required) Details for changing the compartment of a project.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DATA_SCIENCE_PRIVATE_ENDPOINT Function

Creates a Data Science private endpoint to be used by a Data Science resource.

Syntax

FUNCTION create_data_science_private_endpoint (
  create_data_science_private_endpoint_details dbms_cloud_oci_datascience_create_data_science_private_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_data_science_private_endpoint_response_t;

Parameters

Parameter Description

create_data_science_private_endpoint_details

(required) The parameters required to create a private endpoint.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_JOB Function

Creates a job.

Syntax

FUNCTION create_job (
  create_job_details dbms_cloud_oci_datascience_create_job_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_job_response_t;

Parameters

Parameter Description

create_job_details

(required) Details for creating a new job.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_JOB_ARTIFACT Function

Uploads a job artifact.

Syntax

FUNCTION create_job_artifact (
  job_id varchar2,
  content_length number DEFAULT NULL,
  job_artifact blob,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  content_disposition varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_job_artifact_response_t;

Parameters

Parameter Description

job_id

(required) The OCID of the job.

content_length

(optional) The content length of the body.

job_artifact

(required) The job artifact to upload.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

content_disposition

(optional) This header is for specifying a filename during upload. It is used to identify the file type and validate if the file type is supported. Example: `--content-disposition \"attachment; filename=hello-world.py\"`

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_JOB_RUN Function

Creates a job run.

Syntax

FUNCTION create_job_run (
  create_job_run_details dbms_cloud_oci_datascience_create_job_run_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_job_run_response_t;

Parameters

Parameter Description

create_job_run_details

(required) Details for creating a new job run.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MODEL Function

Creates a new model.

Syntax

FUNCTION create_model (
  create_model_details dbms_cloud_oci_datascience_create_model_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_model_response_t;

Parameters

Parameter Description

create_model_details

(required) Details for creating a new model.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MODEL_ARTIFACT Function

Creates model artifact for specified model.

Syntax

FUNCTION create_model_artifact (
  model_id varchar2,
  content_length number DEFAULT NULL,
  model_artifact blob,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  content_disposition varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_model_artifact_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

content_length

(optional) The content length of the body.

model_artifact

(required) The model artifact to upload.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

content_disposition

(optional) This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: `{\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}`

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MODEL_DEPLOYMENT Function

Creates a new model deployment.

Syntax

FUNCTION create_model_deployment (
  create_model_deployment_details dbms_cloud_oci_datascience_create_model_deployment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_model_deployment_response_t;

Parameters

Parameter Description

create_model_deployment_details

(required) Details for creating a new model deployment.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MODEL_PROVENANCE Function

Creates provenance information for the specified model.

Syntax

FUNCTION create_model_provenance (
  model_id varchar2,
  create_model_provenance_details dbms_cloud_oci_datascience_create_model_provenance_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_model_provenance_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

create_model_provenance_details

(required) Provenance information for specified model.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MODEL_VERSION_SET Function

Creates a new modelVersionSet.

Syntax

FUNCTION create_model_version_set (
  create_model_version_set_details dbms_cloud_oci_datascience_create_model_version_set_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_model_version_set_response_t;

Parameters

Parameter Description

create_model_version_set_details

(required) Details for creating a new modelVersionSet.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_NOTEBOOK_SESSION Function

Creates a new notebook session.

Syntax

FUNCTION create_notebook_session (
  create_notebook_session_details dbms_cloud_oci_datascience_create_notebook_session_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_notebook_session_response_t;

Parameters

Parameter Description

create_notebook_session_details

(required) Details for creating a new notebook session.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PIPELINE Function

Creates a new Pipeline.

Syntax

FUNCTION create_pipeline (
  create_pipeline_details dbms_cloud_oci_datascience_create_pipeline_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_pipeline_response_t;

Parameters

Parameter Description

create_pipeline_details

(required) Details for the new Pipeline.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PIPELINE_RUN Function

Creates a new PipelineRun.

Syntax

FUNCTION create_pipeline_run (
  create_pipeline_run_details dbms_cloud_oci_datascience_create_pipeline_run_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_pipeline_run_response_t;

Parameters

Parameter Description

create_pipeline_run_details

(required) Details for the new PipelineRun.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PROJECT Function

Creates a new project.

Syntax

FUNCTION create_project (
  create_project_details dbms_cloud_oci_datascience_create_project_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_project_response_t;

Parameters

Parameter Description

create_project_details

(required) Details for creating a new project.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_STEP_ARTIFACT Function

Upload the artifact for a step in the pipeline.

Syntax

FUNCTION create_step_artifact (
  pipeline_id varchar2,
  step_name varchar2,
  content_length number DEFAULT NULL,
  step_artifact blob,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  content_disposition varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_create_step_artifact_response_t;

Parameters

Parameter Description

pipeline_id

(required) The OCID of the pipeline.

step_name

(required) Unique Step identifier in a pipeline.

content_length

(optional) The content length of the body.

step_artifact

(required) The step artifact to upload.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

content_disposition

(optional) This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: `{\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}`

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DEACTIVATE_MODEL Function

Deactivates the model.

Syntax

FUNCTION deactivate_model (
  model_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_deactivate_model_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DEACTIVATE_MODEL_DEPLOYMENT Function

Deactivates the model deployment.

Syntax

FUNCTION deactivate_model_deployment (
  model_deployment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_deactivate_model_deployment_response_t;

Parameters

Parameter Description

model_deployment_id

(required) The OCID of the model deployment.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DEACTIVATE_NOTEBOOK_SESSION Function

Deactivates the notebook session.

Syntax

FUNCTION deactivate_notebook_session (
  notebook_session_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_deactivate_notebook_session_response_t;

Parameters

Parameter Description

notebook_session_id

(required) The OCID of the notebook session.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DATA_SCIENCE_PRIVATE_ENDPOINT Function

Deletes a private endpoint using `privateEndpointId`.

Syntax

FUNCTION delete_data_science_private_endpoint (
  data_science_private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_data_science_private_endpoint_response_t;

Parameters

Parameter Description

data_science_private_endpoint_id

(required) The unique ID for a Data Science private endpoint.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_JOB Function

Deletes a job.

Syntax

FUNCTION delete_job (
  job_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  delete_related_job_runs number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_job_response_t;

Parameters

Parameter Description

job_id

(required) The OCID of the job.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

delete_related_job_runs

(optional) Delete all JobRuns associated with this job.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_JOB_RUN Function

Deletes a job run.

Syntax

FUNCTION delete_job_run (
  job_run_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_job_run_response_t;

Parameters

Parameter Description

job_run_id

(required) The OCID of the job run.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MODEL Function

Deletes the specified model.

Syntax

FUNCTION delete_model (
  model_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_model_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MODEL_DEPLOYMENT Function

Deletes the specified model deployment. Any unsaved work in this model deployment is lost.

Syntax

FUNCTION delete_model_deployment (
  model_deployment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_model_deployment_response_t;

Parameters

Parameter Description

model_deployment_id

(required) The OCID of the model deployment.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MODEL_VERSION_SET Function

Deletes the specified modelVersionSet.

Syntax

FUNCTION delete_model_version_set (
  model_version_set_id varchar2,
  is_delete_related_models number DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_model_version_set_response_t;

Parameters

Parameter Description

model_version_set_id

(required) The OCID of the model version set.

is_delete_related_models

(optional) By default, this parameter is false. A model version set can only be deleted if all the models associate with it are already in the DELETED state. You can optionally specify the deleteRelatedModels boolean query parameters to true, which deletes all associated models for you.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_NOTEBOOK_SESSION Function

Deletes the specified notebook session. Any unsaved work in this notebook session are lost.

Syntax

FUNCTION delete_notebook_session (
  notebook_session_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_notebook_session_response_t;

Parameters

Parameter Description

notebook_session_id

(required) The OCID of the notebook session.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PIPELINE Function

Deletes a Pipeline resource by identifier.

Syntax

FUNCTION delete_pipeline (
  pipeline_id varchar2,
  delete_related_pipeline_runs number DEFAULT NULL,
  delete_related_job_runs number DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_pipeline_response_t;

Parameters

Parameter Description

pipeline_id

(required) The OCID of the pipeline.

delete_related_pipeline_runs

(optional) A boolean value to specify whether to delete related PipelineRuns or not.

delete_related_job_runs

(optional) A boolean value to specify whether to delete related jobRuns or not.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PIPELINE_RUN Function

Deletes a PipelineRun resource by identifier.

Syntax

FUNCTION delete_pipeline_run (
  pipeline_run_id varchar2,
  delete_related_job_runs number DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_pipeline_run_response_t;

Parameters

Parameter Description

pipeline_run_id

(required) The OCID of the pipeline run.

delete_related_job_runs

(optional) A boolean value to specify whether to delete related jobRuns or not.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PROJECT Function

Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project.

Syntax

FUNCTION delete_project (
  project_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_delete_project_response_t;

Parameters

Parameter Description

project_id

(required) The OCID of the project.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

EXPORT_MODEL_ARTIFACT Function

Export model artifact from source to the service bucket

Syntax

FUNCTION export_model_artifact (
  model_id varchar2,
  export_model_artifact_details dbms_cloud_oci_datascience_export_model_artifact_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_export_model_artifact_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

export_model_artifact_details

(required) Model artifact source details for exporting.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATA_SCIENCE_PRIVATE_ENDPOINT Function

Retrieves an private endpoint using a `privateEndpointId`.

Syntax

FUNCTION get_data_science_private_endpoint (
  data_science_private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_data_science_private_endpoint_response_t;

Parameters

Parameter Description

data_science_private_endpoint_id

(required) The unique ID for a Data Science private endpoint.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB Function

Gets a job.

Syntax

FUNCTION get_job (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_job_response_t;

Parameters

Parameter Description

job_id

(required) The OCID of the job.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_ARTIFACT_CONTENT Function

Downloads job artifact content for specified job.

Syntax

FUNCTION get_job_artifact_content (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  range varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_job_artifact_content_response_t;

Parameters

Parameter Description

job_id

(required) The OCID of the job.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

range

(optional) Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_RUN Function

Gets a job run.

Syntax

FUNCTION get_job_run (
  job_run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_job_run_response_t;

Parameters

Parameter Description

job_run_id

(required) The OCID of the job run.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODEL Function

Gets the specified model's information.

Syntax

FUNCTION get_model (
  model_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_model_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODEL_ARTIFACT_CONTENT Function

Downloads model artifact content for specified model.

Syntax

FUNCTION get_model_artifact_content (
  model_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  range varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_model_artifact_content_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

range

(optional) Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODEL_DEPLOYMENT Function

Retrieves the model deployment for the specified `modelDeploymentId`.

Syntax

FUNCTION get_model_deployment (
  model_deployment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_model_deployment_response_t;

Parameters

Parameter Description

model_deployment_id

(required) The OCID of the model deployment.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODEL_PROVENANCE Function

Gets provenance information for specified model.

Syntax

FUNCTION get_model_provenance (
  model_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_model_provenance_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODEL_VERSION_SET Function

Gets the specified model version set information.

Syntax

FUNCTION get_model_version_set (
  model_version_set_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_model_version_set_response_t;

Parameters

Parameter Description

model_version_set_id

(required) The OCID of the model version set.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_NOTEBOOK_SESSION Function

Gets the specified notebook session's information.

Syntax

FUNCTION get_notebook_session (
  notebook_session_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_notebook_session_response_t;

Parameters

Parameter Description

notebook_session_id

(required) The OCID of the notebook session.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PIPELINE Function

Gets a Pipeline by identifier.

Syntax

FUNCTION get_pipeline (
  pipeline_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_pipeline_response_t;

Parameters

Parameter Description

pipeline_id

(required) The OCID of the pipeline.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PIPELINE_RUN Function

Gets a PipelineRun by identifier.

Syntax

FUNCTION get_pipeline_run (
  pipeline_run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_pipeline_run_response_t;

Parameters

Parameter Description

pipeline_run_id

(required) The OCID of the pipeline run.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PROJECT Function

Gets the specified project's information.

Syntax

FUNCTION get_project (
  project_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_project_response_t;

Parameters

Parameter Description

project_id

(required) The OCID of the project.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STEP_ARTIFACT_CONTENT Function

Download the artifact for a step in the pipeline.

Syntax

FUNCTION get_step_artifact_content (
  pipeline_id varchar2,
  step_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  range varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_step_artifact_content_response_t;

Parameters

Parameter Description

pipeline_id

(required) The OCID of the pipeline.

step_name

(required) Unique Step identifier in a pipeline.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

range

(optional) Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the specified work request's information.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_get_work_request_response_t;

Parameters

Parameter Description

work_request_id

(required) The OCID of the work request.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

HEAD_JOB_ARTIFACT Function

Gets job artifact metadata.

Syntax

FUNCTION head_job_artifact (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_head_job_artifact_response_t;

Parameters

Parameter Description

job_id

(required) The OCID of the job.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

HEAD_MODEL_ARTIFACT Function

Gets model artifact metadata for specified model.

Syntax

FUNCTION head_model_artifact (
  model_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_head_model_artifact_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

HEAD_STEP_ARTIFACT Function

Get the artifact metadata for a step in the pipeline.

Syntax

FUNCTION head_step_artifact (
  pipeline_id varchar2,
  step_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_head_step_artifact_response_t;

Parameters

Parameter Description

pipeline_id

(required) The OCID of the pipeline.

step_name

(required) Unique Step identifier in a pipeline.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

IMPORT_MODEL_ARTIFACT Function

Import model artifact from service bucket

Syntax

FUNCTION import_model_artifact (
  model_id varchar2,
  import_model_artifact_details dbms_cloud_oci_datascience_import_model_artifact_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_import_model_artifact_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

import_model_artifact_details

(required) Model artifact source details for importing.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATA_SCIENCE_PRIVATE_ENDPOINTS Function

Lists all Data Science private endpoints in the specified compartment. The query must include compartmentId. The query can also include one other parameter. If the query doesn't include compartmentId, or includes compartmentId with two or more other parameters, then an error is returned.

Syntax

FUNCTION list_data_science_private_endpoints (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  data_science_resource_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_data_science_private_endpoints_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

lifecycle_state

(optional) The lifecycle state of the private endpoint.

Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

sort_by

(optional) The field used to sort the results. Multiple fields aren't supported.

Allowed values are: 'timeCreated'

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

display_name

(optional) <b>Filter</b> results by its user-friendly name.

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

data_science_resource_type

(optional) Resource types in the Data Science service such as notebooks.

Allowed values are: 'NOTEBOOK_SESSION'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_FAST_LAUNCH_JOB_CONFIGS Function

List fast launch capable job configs in the specified compartment.

Syntax

FUNCTION list_fast_launch_job_configs (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_fast_launch_job_configs_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOB_RUNS Function

List out job runs.

Syntax

FUNCTION list_job_runs (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  job_id varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_job_runs_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

job_id

(optional) The OCID of the job.

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

display_name

(optional) <b>Filter</b> results by its user-friendly name.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive.

Allowed values are: 'timeCreated', 'displayName'

lifecycle_state

(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED', 'DELETED', 'NEEDS_ATTENTION'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOB_SHAPES Function

List job shapes available in the specified compartment.

Syntax

FUNCTION list_job_shapes (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_job_shapes_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOBS Function

List jobs in the specified compartment.

Syntax

FUNCTION list_jobs (
  compartment_id varchar2,
  project_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_jobs_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

project_id

(optional) <b>Filter</b> results by the OCID of the project.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

display_name

(optional) <b>Filter</b> results by its user-friendly name.

lifecycle_state

(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'DELETED'

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive.

Allowed values are: 'timeCreated', 'displayName'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MODEL_DEPLOYMENT_SHAPES Function

Lists the valid model deployment shapes.

Syntax

FUNCTION list_model_deployment_shapes (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_model_deployment_shapes_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MODEL_DEPLOYMENTS Function

Lists all model deployments in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

Syntax

FUNCTION list_model_deployments (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  project_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_model_deployments_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

project_id

(optional) <b>Filter</b> results by the OCID of the project.

display_name

(optional) <b>Filter</b> results by its user-friendly name.

lifecycle_state

(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'INACTIVE', 'UPDATING', 'DELETED', 'NEEDS_ATTENTION'

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, results are shown in descending order. When you sort by `displayName`, results are shown in ascending order. Sort order for the `displayName` field is case sensitive.

Allowed values are: 'timeCreated', 'displayName'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MODEL_VERSION_SETS Function

Lists model version sets in the specified compartment.

Syntax

FUNCTION list_model_version_sets (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  project_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_model_version_sets_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

project_id

(optional) <b>Filter</b> results by the OCID of the project.

name

(optional) A filter to return only resources that match the entire name given.

lifecycle_state

(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.

Allowed values are: 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order.

Allowed values are: 'timeCreated', 'name', 'lifecycleState'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MODELS Function

Lists models in the specified compartment.

Syntax

FUNCTION list_models (
  compartment_id varchar2,
  model_version_set_name varchar2 DEFAULT NULL,
  version_label varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  project_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_models_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

model_version_set_name

(optional) <b>Filter</b> results by the name of the model version set.

version_label

(optional) <b>Filter</b> results by version label.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

project_id

(optional) <b>Filter</b> results by the OCID of the project.

display_name

(optional) <b>Filter</b> results by its user-friendly name.

lifecycle_state

(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.

Allowed values are: 'ACTIVE', 'DELETED', 'FAILED', 'INACTIVE'

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive.

Allowed values are: 'timeCreated', 'displayName', 'lifecycleState'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_NOTEBOOK_SESSION_SHAPES Function

Lists the valid notebook session shapes.

Syntax

FUNCTION list_notebook_session_shapes (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_notebook_session_shapes_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_NOTEBOOK_SESSIONS Function

Lists the notebook sessions in the specified compartment.

Syntax

FUNCTION list_notebook_sessions (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  project_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_notebook_sessions_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

project_id

(optional) <b>Filter</b> results by the OCID of the project.

display_name

(optional) <b>Filter</b> results by its user-friendly name.

lifecycle_state

(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE', 'UPDATING'

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, results are shown in ascending order. Sort order for the `displayName` field is case sensitive.

Allowed values are: 'timeCreated', 'displayName'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PIPELINE_RUNS Function

Returns a list of PipelineRuns.

Syntax

FUNCTION list_pipeline_runs (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  pipeline_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_pipeline_runs_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

pipeline_id

(optional) The OCID of the pipeline.

display_name

(optional) <b>Filter</b> results by its user-friendly name.

lifecycle_state

(optional) The current state of the PipelineRun.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED', 'DELETING', 'DELETED'

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeAccepted`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive.

Allowed values are: 'timeAccepted', 'displayName'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PIPELINES Function

Returns a list of Pipelines.

Syntax

FUNCTION list_pipelines (
  compartment_id varchar2,
  project_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_pipelines_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

project_id

(optional) <b>Filter</b> results by the OCID of the project.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

display_name

(optional) <b>Filter</b> results by its user-friendly name.

lifecycle_state

(optional) The current state of the Pipeline.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'DELETED'

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive.

Allowed values are: 'timeCreated', 'displayName'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROJECTS Function

Lists projects in the specified compartment.

Syntax

FUNCTION list_projects (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  created_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_projects_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

display_name

(optional) <b>Filter</b> results by its user-friendly name.

lifecycle_state

(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.

Allowed values are: 'ACTIVE', 'DELETING', 'DELETED'

created_by

(optional) <b>Filter</b> results by the OCID of the user who created the resource.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive.

Allowed values are: 'timeCreated', 'displayName'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Lists work request errors for the specified work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_work_request_errors_response_t;

Parameters

Parameter Description

work_request_id

(required) The OCID of the work request.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Lists work request logs for the specified work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_work_request_logs_response_t;

Parameters

Parameter Description

work_request_id

(required) The OCID of the work request.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists work requests in the specified compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  operation_type varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_list_work_requests_response_t;

Parameters

Parameter Description

compartment_id

(required) <b>Filter</b> results by the OCID of the compartment.

id

(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

operation_type

(optional) <b>Filter</b> results by the type of the operation associated with the work request.

Allowed values are: 'NOTEBOOK_SESSION_CREATE', 'NOTEBOOK_SESSION_DELETE', 'NOTEBOOK_SESSION_ACTIVATE', 'NOTEBOOK_SESSION_DEACTIVATE', 'MODELVERSIONSET_DELETE', 'EXPORT_MODEL_ARTIFACT', 'IMPORT_MODEL_ARTIFACT', 'MODEL_DEPLOYMENT_CREATE', 'MODEL_DEPLOYMENT_DELETE', 'MODEL_DEPLOYMENT_ACTIVATE', 'MODEL_DEPLOYMENT_DEACTIVATE', 'MODEL_DEPLOYMENT_UPDATE', 'PROJECT_DELETE', 'WORKREQUEST_CANCEL', 'JOB_DELETE', 'PIPELINE_CREATE', 'PIPELINE_DELETE', 'PIPELINE_RUN_CREATE', 'PIPELINE_RUN_CANCEL', 'PIPELINE_RUN_DELETE', 'PRIVATE_ENDPOINT_CREATE', 'PRIVATE_ENDPOINT_DELETE', 'PRIVATE_ENDPOINT_MOVE', 'PRIVATE_ENDPOINT_UPDATE'

status

(optional) <b>Filter</b> results by work request status.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: `50`

page

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. See List Pagination.

sort_order

(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.

Allowed values are: 'operationType', 'status', 'timeAccepted'

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DATA_SCIENCE_PRIVATE_ENDPOINT Function

Updates a private endpoint using a `privateEndpointId`. If changes to a private endpoint match a previously defined private endpoint, then a 409 status code is returned. This indicates that a conflict has been detected.

Syntax

FUNCTION update_data_science_private_endpoint (
  data_science_private_endpoint_id varchar2,
  update_data_science_private_endpoint_details dbms_cloud_oci_datascience_update_data_science_private_endpoint_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_data_science_private_endpoint_response_t;

Parameters

Parameter Description

data_science_private_endpoint_id

(required) The unique ID for a Data Science private endpoint.

update_data_science_private_endpoint_details

(required) Details for updating a private endpoint.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_JOB Function

Updates a job.

Syntax

FUNCTION update_job (
  job_id varchar2,
  update_job_details dbms_cloud_oci_datascience_update_job_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_job_response_t;

Parameters

Parameter Description

job_id

(required) The OCID of the job.

update_job_details

(required) Details for updating a job.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_JOB_RUN Function

Updates a job run.

Syntax

FUNCTION update_job_run (
  job_run_id varchar2,
  update_job_run_details dbms_cloud_oci_datascience_update_job_run_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_job_run_response_t;

Parameters

Parameter Description

job_run_id

(required) The OCID of the job run.

update_job_run_details

(required) Details for updating a job.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MODEL Function

Updates the properties of a model. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.

Syntax

FUNCTION update_model (
  model_id varchar2,
  update_model_details dbms_cloud_oci_datascience_update_model_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_model_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

update_model_details

(required) Details for updating a model. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MODEL_DEPLOYMENT Function

Updates the properties of a model deployment. Some of the properties of `modelDeploymentConfigurationDetails` or `CategoryLogDetails` can also be updated with zero down time when the model deployment's lifecycle state is ACTIVE or NEEDS_ATTENTION i.e `instanceShapeName`, `instanceCount` and `modelId`, separately `loadBalancerShape` or `CategoryLogDetails` can also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model deployment is activated.

Syntax

FUNCTION update_model_deployment (
  model_deployment_id varchar2,
  update_model_deployment_details dbms_cloud_oci_datascience_update_model_deployment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_model_deployment_response_t;

Parameters

Parameter Description

model_deployment_id

(required) The OCID of the model deployment.

update_model_deployment_details

(required) Details for updating a model deployment. Some of the properties of `modelDeploymentConfigurationDetails` or `CategoryLogDetails` can also be updated with zero down time when the model deployment's lifecycle state is ACTIVE or NEEDS_ATTENTION i.e `instanceShapeName`, `instanceCount` and `modelId`, separately `loadBalancerShape` or `CategoryLogDetails` can also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model deployment is activated.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MODEL_PROVENANCE Function

Updates the provenance information for the specified model.

Syntax

FUNCTION update_model_provenance (
  model_id varchar2,
  update_model_provenance_details dbms_cloud_oci_datascience_update_model_provenance_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_model_provenance_response_t;

Parameters

Parameter Description

model_id

(required) The OCID of the model.

update_model_provenance_details

(required) Provenance information for the specified model.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MODEL_VERSION_SET Function

Updates the properties of a model version set. User can update the `description` property.

Syntax

FUNCTION update_model_version_set (
  model_version_set_id varchar2,
  update_model_version_set_details dbms_cloud_oci_datascience_update_model_version_set_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_model_version_set_response_t;

Parameters

Parameter Description

model_version_set_id

(required) The OCID of the model version set.

update_model_version_set_details

(required) Details for updating a model version set. You can update `description` property only.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_NOTEBOOK_SESSION Function

Updates the properties of a notebook session. You can update the `displayName`, `freeformTags`, and `definedTags` properties. When the notebook session is in the INACTIVE lifecycle state, you can update `notebookSessionConfigurationDetails` and change `shape`, `subnetId`, and `blockStorageSizeInGBs`. Changes to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource.

Syntax

FUNCTION update_notebook_session (
  notebook_session_id varchar2,
  update_notebook_session_details dbms_cloud_oci_datascience_update_notebook_session_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_notebook_session_response_t;

Parameters

Parameter Description

notebook_session_id

(required) The OCID of the notebook session.

update_notebook_session_details

(required) 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.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PIPELINE Function

Updates the Pipeline.

Syntax

FUNCTION update_pipeline (
  pipeline_id varchar2,
  update_pipeline_details dbms_cloud_oci_datascience_update_pipeline_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_pipeline_response_t;

Parameters

Parameter Description

pipeline_id

(required) The OCID of the pipeline.

update_pipeline_details

(required) The information to be updated.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PIPELINE_RUN Function

Updates the PipelineRun.

Syntax

FUNCTION update_pipeline_run (
  pipeline_run_id varchar2,
  update_pipeline_run_details dbms_cloud_oci_datascience_update_pipeline_run_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_pipeline_run_response_t;

Parameters

Parameter Description

pipeline_run_id

(required) The OCID of the pipeline run.

update_pipeline_run_details

(required) The information to be updated.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PROJECT Function

Updates the properties of a project. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.

Syntax

FUNCTION update_project (
  project_id varchar2,
  update_project_details dbms_cloud_oci_datascience_update_project_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dsc_data_science_update_project_response_t;

Parameters

Parameter Description

project_id

(required) The OCID of the project.

update_project_details

(required) Details for updating a project. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the `etag` you provide matches the resource's current `etag` value.

opc_request_id

(optional) Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datascience.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.