AnomalyDetectionClient¶
-
class
oci.ai_anomaly_detection.
AnomalyDetectionClient
(config, **kwargs)¶ OCI AI Service solutions can help Enterprise customers integrate AI into their products immediately by using our proven, pre-trained/custom models or containers, and without a need to set up in house team of AI and ML experts. This allows enterprises to focus on business drivers and development work rather than AI/ML operations, shortening the time to market.
Methods
__init__
(config, **kwargs)Creates a new service client cancel_work_request
(work_request_id, **kwargs)Cancel work request with the given ID. change_ai_private_endpoint_compartment
(…)Moves a resource into a different compartment. change_data_asset_compartment
(data_asset_id, …)Changing the compartment of a data asset. change_detect_anomaly_job_compartment
(…)Moves a asynchronous anomaly detect job resource from one compartment to another. change_model_compartment
(model_id, …)Moves a Model resource from one compartment to another. change_project_compartment
(project_id, …)Moves a Project resource from one compartment to another. create_ai_private_endpoint
(…)Create a new private reverse connection endpoint. create_data_asset
(create_data_asset_details, …)Creates a new DataAsset. create_detect_anomaly_job
(…)Creates a job to perform anomaly detection. create_model
(create_model_details, **kwargs)Creates a new Model. create_project
(create_project_details, **kwargs)Creates a new Project. delete_ai_private_endpoint
(…)Deletes a private reverse connection endpoint by identifier. delete_data_asset
(data_asset_id, **kwargs)Deletes a DataAsset resource by identifier delete_detect_anomaly_job
(…)Deletes an accepted, but not started detect anomaly asynchronous job. delete_model
(model_id, **kwargs)Deletes an ai model resource by identifier. delete_project
(project_id, **kwargs)Deletes a Project resource by identifier. detect_anomalies
(detect_anomalies_details, …)Make a detect call with an anomaly model and detection data get_ai_private_endpoint
(…)Gets a specific private reverse connection by identifier. get_data_asset
(data_asset_id, **kwargs)Gets a DataAsset by identifier get_detect_anomaly_job
(…)Gets a detect anomaly asynchronous job by identifier. get_model
(model_id, **kwargs)Gets a Model by identifier get_project
(project_id, **kwargs)Gets a Project by identifier get_work_request
(work_request_id, **kwargs)Gets the status of the work request with the given ID. list_ai_private_endpoints
(compartment_id, …)Returns a list of all the AI private endpoints in the specified compartment. list_data_assets
(compartment_id, **kwargs)Returns a list of DataAssets. list_detect_anomaly_jobs
(compartment_id, …)Returns a list of all the Anomaly Detection jobs in the specified compartment. list_models
(compartment_id, **kwargs)Returns a list of Models. list_projects
(compartment_id, **kwargs)Returns a list of Projects. list_work_request_errors
(work_request_id, …)Return a (paginated) list of errors for a given work request. list_work_request_logs
(work_request_id, **kwargs)Return a (paginated) list of logs for a given work request. list_work_requests
(compartment_id, **kwargs)Lists the work requests in a compartment. update_ai_private_endpoint
(…)Updates the private reverse connection endpoint. update_data_asset
(data_asset_id, …)Updates the DataAsset update_detect_anomaly_job
(…)Updates the detect anomaly asynchronous job by identifier. update_model
(model_id, update_model_details, …)Updates the Model update_project
(project_id, …)Updates the Project -
__init__
(config, **kwargs)¶ Creates a new service client
Parameters: - config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
from_file()
method can be used to load configuration from a file. Alternatively, adict
can be passed. You can validate_config the dict usingvalidate_config()
- service_endpoint (str) – (optional)
The endpoint of the service to call using this client. For example
https://iaas.us-ashburn-1.oraclecloud.com
. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint. - timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
- signer (
AbstractBaseSigner
) –(optional) The signer to use when signing requests made by the service client. The default is to use a
Signer
based on the values provided in the config parameter.One use case for this parameter is for Instance Principals authentication by passing an instance of
InstancePrincipalsSecurityTokenSigner
as the value for this keyword argument - retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a
retry_strategy
keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.This should be one of the strategies available in the
retry
module. A convenienceDEFAULT_RETRY_STRATEGY
is also available. The specifics of the default retry strategy are described here. - circuit_breaker_strategy (obj) – (optional)
A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level).
This client uses
DEFAULT_CIRCUIT_BREAKER_STRATEGY
as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here. - circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
- client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
- allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
- config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
-
cancel_work_request
(work_request_id, **kwargs)¶ Cancel work request with the given ID.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use cancel_work_request API.
-
change_ai_private_endpoint_compartment
(ai_private_endpoint_id, change_ai_private_endpoint_compartment_details, **kwargs)¶ Moves a resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
Parameters: - ai_private_endpoint_id (str) – (required) Unique private reverse connection identifier.
- change_ai_private_endpoint_compartment_details (oci.ai_anomaly_detection.models.ChangeAiPrivateEndpointCompartmentDetails) – (required) Details for the target compartment.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- opc_retry_token (str) – (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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_ai_private_endpoint_compartment API.
-
change_data_asset_compartment
(data_asset_id, change_data_asset_compartment_details, **kwargs)¶ Changing the compartment of a data asset.
Parameters: - data_asset_id (str) – (required) The OCID of the Data Asset.
- change_data_asset_compartment_details (oci.ai_anomaly_detection.models.ChangeDataAssetCompartmentDetails) – (required) The information to be updated.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- opc_retry_token (str) – (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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use change_data_asset_compartment API.
-
change_detect_anomaly_job_compartment
(detect_anomaly_job_id, change_detect_anomaly_job_compartment_details, **kwargs)¶ Moves a asynchronous anomaly detect job resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
Parameters: - detect_anomaly_job_id (str) – (required) Unique asynchronous job identifier.
- change_detect_anomaly_job_compartment_details (oci.ai_anomaly_detection.models.ChangeDetectAnomalyJobCompartmentDetails) – (required) The details to change the compartment of the async anomaly detect job.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_detect_anomaly_job_compartment API.
-
change_model_compartment
(model_id, change_model_compartment_details, **kwargs)¶ Moves a Model resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
Parameters: - model_id (str) – (required) The OCID of the Model.
- change_model_compartment_details (oci.ai_anomaly_detection.models.ChangeModelCompartmentDetails) – (required) The information to be updated.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- opc_retry_token (str) – (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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_model_compartment API.
-
change_project_compartment
(project_id, change_project_compartment_details, **kwargs)¶ Moves a Project resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
Parameters: - project_id (str) – (required) The OCID of the Project.
- change_project_compartment_details (oci.ai_anomaly_detection.models.ChangeProjectCompartmentDetails) – (required) The details to change the compartment of the project.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- opc_retry_token (str) – (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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_project_compartment API.
-
create_ai_private_endpoint
(create_ai_private_endpoint_details, **kwargs)¶ Create a new private reverse connection endpoint.
Parameters: - create_ai_private_endpoint_details (oci.ai_anomaly_detection.models.CreateAiPrivateEndpointDetails) – (required) The information used to create the private reverse connection.
- opc_request_id (str) – (optional) The client request ID for tracing.
- opc_retry_token (str) – (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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use create_ai_private_endpoint API.
-
create_data_asset
(create_data_asset_details, **kwargs)¶ Creates a new DataAsset.
Parameters: - create_data_asset_details (oci.ai_anomaly_detection.models.CreateDataAssetDetails) – (required) Details for the new DataAsset.
- opc_retry_token (str) – (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 (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_data_asset API.
-
create_detect_anomaly_job
(create_detect_anomaly_job_details, **kwargs)¶ Creates a job to perform anomaly detection.
Parameters: - create_detect_anomaly_job_details (oci.ai_anomaly_detection.models.CreateDetectAnomalyJobDetails) –
(required) The input is either:
- JSON object in the request. This object is defined, and the SDK generates the object for it.
- Data embedded as Base64 string in format of either: - CSV - JSON If this option is used, then you must provide the content of specified CSV or JSON in Base64 encoded string. The Embedded JSON has to be in the same format as the inline request JSON.
- opc_request_id (str) – (optional) The client request ID for tracing.
- opc_retry_token (str) – (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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDetectAnomalyJob
Return type: Example: Click here to see an example of how to use create_detect_anomaly_job API.
- create_detect_anomaly_job_details (oci.ai_anomaly_detection.models.CreateDetectAnomalyJobDetails) –
-
create_model
(create_model_details, **kwargs)¶ Creates a new Model.
Parameters: - create_model_details (oci.ai_anomaly_detection.models.CreateModelDetails) – (required) Details for the new Model.
- opc_retry_token (str) – (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 (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_model API.
-
create_project
(create_project_details, **kwargs)¶ Creates a new Project.
Parameters: - create_project_details (oci.ai_anomaly_detection.models.CreateProjectDetails) – (required) Details for the new Project.
- opc_retry_token (str) – (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 (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_project API.
-
delete_ai_private_endpoint
(ai_private_endpoint_id, **kwargs)¶ Deletes a private reverse connection endpoint by identifier.
Parameters: - ai_private_endpoint_id (str) – (required) Unique private reverse connection identifier.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_ai_private_endpoint API.
-
delete_data_asset
(data_asset_id, **kwargs)¶ Deletes a DataAsset resource by identifier
Parameters: - data_asset_id (str) – (required) The OCID of the Data Asset.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_data_asset API.
-
delete_detect_anomaly_job
(detect_anomaly_job_id, **kwargs)¶ Deletes an accepted, but not started detect anomaly asynchronous job.
Parameters: - detect_anomaly_job_id (str) – (required) Unique asynchronous job identifier.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_detect_anomaly_job API.
-
delete_model
(model_id, **kwargs)¶ Deletes an ai model resource by identifier. This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a project.
Parameters: - model_id (str) – (required) The OCID of the Model.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_model API.
-
delete_project
(project_id, **kwargs)¶ Deletes a Project resource by identifier. This operation fails with a 409 error unless all associated resources (models deployments or data assets) are in a DELETED state. You must delete all associated resources before deleting a project.
Parameters: - project_id (str) – (required) The OCID of the Project.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_project API.
-
detect_anomalies
(detect_anomalies_details, **kwargs)¶ Make a detect call with an anomaly model and detection data
Parameters: - detect_anomalies_details (oci.ai_anomaly_detection.models.DetectAnomaliesDetails) –
(required) The input is either:
- JSON object in the request. This object is defined and SDK will generate the object for it
- Data embedded as Base64 string in format of either - CSV - JSON If this option is chosen then customer has to provide the content of specified CSV or JSON in Base64 encoded string. The Embedded JSON will still has to be in same format as inline request JSON
- opc_request_id (str) – (optional) The client request ID for tracing.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_retry_token (str) – (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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAnomalyDetectResult
Return type: Example: Click here to see an example of how to use detect_anomalies API.
- detect_anomalies_details (oci.ai_anomaly_detection.models.DetectAnomaliesDetails) –
-
get_ai_private_endpoint
(ai_private_endpoint_id, **kwargs)¶ Gets a specific private reverse connection by identifier.
Parameters: - ai_private_endpoint_id (str) – (required) Unique private reverse connection identifier.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAiPrivateEndpoint
Return type: Example: Click here to see an example of how to use get_ai_private_endpoint API.
-
get_data_asset
(data_asset_id, **kwargs)¶ Gets a DataAsset by identifier
Parameters: - data_asset_id (str) – (required) The OCID of the Data Asset.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use get_data_asset API.
-
get_detect_anomaly_job
(detect_anomaly_job_id, **kwargs)¶ Gets a detect anomaly asynchronous job by identifier.
Parameters: - detect_anomaly_job_id (str) – (required) Unique asynchronous job identifier.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDetectAnomalyJob
Return type: Example: Click here to see an example of how to use get_detect_anomaly_job API.
-
get_model
(model_id, **kwargs)¶ Gets a Model by identifier
Parameters: - model_id (str) – (required) The OCID of the Model.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use get_model API.
-
get_project
(project_id, **kwargs)¶ Gets a Project by identifier
Parameters: - project_id (str) – (required) The OCID of the Project.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use get_project API.
-
get_work_request
(work_request_id, **kwargs)¶ Gets the status of the work request with the given ID.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeWorkRequest
Return type: Example: Click here to see an example of how to use get_work_request API.
-
list_ai_private_endpoints
(compartment_id, **kwargs)¶ Returns a list of all the AI private endpoints in the specified compartment.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- lifecycle_state (str) –
(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- id (str) – (optional) unique AiPrivateEndpoint identifier
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- sort_order (str) –
(optional) The sort order to use, either ‘asc’ or ‘desc’.
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
Allowed values are: “timeCreated”, “displayName”
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAiPrivateEndpointCollection
Return type: Example: Click here to see an example of how to use list_ai_private_endpoints API.
-
list_data_assets
(compartment_id, **kwargs)¶ Returns a list of DataAssets.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- project_id (str) – (optional) The ID of the project for which to list the objects.
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- lifecycle_state (str) –
(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
Allowed values are: “ACTIVE”, “DELETED”
- sort_order (str) –
(optional) The sort order to use, either ‘asc’ or ‘desc’.
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
Allowed values are: “timeCreated”, “displayName”
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDataAssetCollection
Return type: Example: Click here to see an example of how to use list_data_assets API.
-
list_detect_anomaly_jobs
(compartment_id, **kwargs)¶ Returns a list of all the Anomaly Detection jobs in the specified compartment.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- model_id (str) – (optional) The ID of the trained model for which to list the resources.
- project_id (str) – (optional) The ID of the project for which to list the objects.
- detect_anomaly_job_id (str) – (optional) Unique Async Job identifier
- lifecycle_state (str) –
(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
Allowed values are: “SUCCEEDED”, “PARTIALLY_SUCCEEDED”, “FAILED”, “ACCEPTED”, “CANCELED”, “IN_PROGRESS”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- sort_order (str) –
(optional) The sort order to use, either ‘asc’ or ‘desc’.
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
Allowed values are: “timeCreated”, “displayName”
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDetectAnomalyJobCollection
Return type: Example: Click here to see an example of how to use list_detect_anomaly_jobs API.
-
list_models
(compartment_id, **kwargs)¶ Returns a list of Models.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- project_id (str) – (optional) The ID of the project for which to list the objects.
- lifecycle_state (str) –
(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
Allowed values are: “DELETING”, “DELETED”, “FAILED”, “CREATING”, “ACTIVE”, “UPDATING”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- sort_order (str) –
(optional) The sort order to use, either ‘asc’ or ‘desc’.
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(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 (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeModelCollection
Return type: Example: Click here to see an example of how to use list_models API.
-
list_projects
(compartment_id, **kwargs)¶ Returns a list of Projects.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- lifecycle_state (str) –
(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
Allowed values are: “ACTIVE”, “CREATING”, “FAILED”, “DELETING”, “DELETED”, “UPDATING”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- sort_order (str) –
(optional) The sort order to use, either ‘asc’ or ‘desc’.
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(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 (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeProjectCollection
Return type: Example: Click here to see an example of how to use list_projects API.
-
list_work_request_errors
(work_request_id, **kwargs)¶ Return a (paginated) list of errors for a given work request.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- limit (int) – (optional) The maximum number of items to return.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeWorkRequestErrorCollection
Return type: Example: Click here to see an example of how to use list_work_request_errors API.
-
list_work_request_logs
(work_request_id, **kwargs)¶ Return a (paginated) list of logs for a given work request.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- limit (int) – (optional) The maximum number of items to return.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeWorkRequestLogEntryCollection
Return type: Example: Click here to see an example of how to use list_work_request_logs API.
-
list_work_requests
(compartment_id, **kwargs)¶ Lists the work requests in a compartment.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- work_request_id (str) – (optional) The ID of the asynchronous work request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- limit (int) – (optional) The maximum number of items to return.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeWorkRequestSummaryCollection
Return type: Example: Click here to see an example of how to use list_work_requests API.
-
update_ai_private_endpoint
(ai_private_endpoint_id, update_ai_private_endpoint_details, **kwargs)¶ Updates the private reverse connection endpoint.
Parameters: - ai_private_endpoint_id (str) – (required) Unique private reverse connection identifier.
- update_ai_private_endpoint_details (oci.ai_anomaly_detection.models.UpdateAiPrivateEndpointDetails) – (required) The information to be updated in private reverse connection
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use update_ai_private_endpoint API.
-
update_data_asset
(data_asset_id, update_data_asset_details, **kwargs)¶ Updates the DataAsset
Parameters: - data_asset_id (str) – (required) The OCID of the Data Asset.
- update_data_asset_details (oci.ai_anomaly_detection.models.UpdateDataAssetDetails) – (required) The information to be updated.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use update_data_asset API.
-
update_detect_anomaly_job
(detect_anomaly_job_id, update_detect_anomaly_job_details, **kwargs)¶ Updates the detect anomaly asynchronous job by identifier.
Parameters: - detect_anomaly_job_id (str) – (required) Unique asynchronous job identifier.
- update_detect_anomaly_job_details (oci.ai_anomaly_detection.models.UpdateDetectAnomalyJobDetails) – (required) The information to be updated.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDetectAnomalyJob
Return type: Example: Click here to see an example of how to use update_detect_anomaly_job API.
-
update_model
(model_id, update_model_details, **kwargs)¶ Updates the Model
Parameters: - model_id (str) – (required) The OCID of the Model.
- update_model_details (oci.ai_anomaly_detection.models.UpdateModelDetails) – (required) The information to be updated.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use update_model API.
-
update_project
(project_id, update_project_details, **kwargs)¶ Updates the Project
Parameters: - project_id (str) – (required) The OCID of the Project.
- update_project_details (oci.ai_anomaly_detection.models.UpdateProjectDetails) – (required) The information to be updated.
- if_match (str) – (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 will be updated or deleted only if the etag you provide matches the resource’s current etag value.
- opc_request_id (str) – (optional) The client request ID for tracing.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use update_project API.
-