oci-cli 3.64.1__py3-none-any.whl → 3.65.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/model/detect-anomalies-inline.txt

@@ -1,139 +0,0 @@
-"detect-anomalies-inline"
-*************************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Make a detect call with an anomaly model and detection data
-
-
-Usage
-=====
-
-   oci anomaly-detection model detect-anomalies-inline [OPTIONS]
-
-
-Required Parameters
-===================
-
---data [complex type]
-
-Array containing data. This is a complex type whose value must be
-valid JSON. The value can be provided as a string on the command line
-or passed in as a file using the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
---model-id [text]
-
-The OCID of the trained model.
-
---signal-names [complex type]
-
-List of signal names. This is a complex type whose value must be valid
-JSON. The value can be provided as a string on the command line or
-passed in as a file using the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
-
-Optional Parameters
-===================
-
---from-json [text]
-
-Provide input to this command as a JSON document from a file using the
-file://path-to/file syntax.
-
-The "--generate-full-command-json-input" option can be used to
-generate a sample json file to be used with this command option. The
-key names are pre-populated and match the command option names
-(converted to camelCase format, e.g. compartment-id –> compartmentId),
-while the values of the keys need to be populated by the user before
-using the sample file as an input to this command. For any command
-option that accepts multiple values, the value of the key can be a
-JSON array.
-
-Options can still be provided on the command line. If an option exists
-in both the JSON document and the command line then the command line
-specified value will be used.
-
-For examples on usage of this option, please see our “using CLI with
-advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---if-match [text]
-
-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.
-
---sensitivity [float]
-
-Sensitivity of the algorithm to detect anomalies - higher the value,
-more anomalies get flagged. The value estimated during training is
-used by default. You can choose to provide a custom value.
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci anomaly-detection model create --generate-param-json-input model-training-details > model-training-details.json
-
-       oci anomaly-detection model detect-anomalies-inline --generate-param-json-input data > data.json
-       oci anomaly-detection model detect-anomalies-inline --generate-param-json-input signal-names > signal-names.json
-
-Copy the following CLI commands into a file named example.sh. Run the
-command by typing “bash example.sh” and replacing the example
-parameters with your own.
-
-Please note this sample will only work in the POSIX-compliant bash-
-like shell. You need to set up the OCI configuration and appropriate
-security policies before trying the examples.
-
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/project/create.html#cmdoption-compartment-id
-
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       model_id=$(oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id --query data.id --raw-output)
-
-       oci anomaly-detection model detect-anomalies-inline --data file://data.json --model-id $model_id --signal-names file://signal-names.json

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/model/detect-anomalies.txt

@@ -1,125 +0,0 @@
-"detect-anomalies"
-******************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Make a detect call with an anomaly model and detection data
-
-
-Usage
-=====
-
-   oci anomaly-detection model detect-anomalies [OPTIONS]
-
-
-Required Parameters
-===================
-
---model-id [text]
-
-The OCID of the trained model.
-
---request-type [text]
-
-Type of request. This parameter is automatically populated by classes
-generated by the SDK. For raw curl requests, you must provide this
-field.
-
-Accepted values are:
-
-   BASE64_ENCODED, INLINE
-
-
-Optional Parameters
-===================
-
---from-json [text]
-
-Provide input to this command as a JSON document from a file using the
-file://path-to/file syntax.
-
-The "--generate-full-command-json-input" option can be used to
-generate a sample json file to be used with this command option. The
-key names are pre-populated and match the command option names
-(converted to camelCase format, e.g. compartment-id –> compartmentId),
-while the values of the keys need to be populated by the user before
-using the sample file as an input to this command. For any command
-option that accepts multiple values, the value of the key can be a
-JSON array.
-
-Options can still be provided on the command line. If an option exists
-in both the JSON document and the command line then the command line
-specified value will be used.
-
-For examples on usage of this option, please see our “using CLI with
-advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---if-match [text]
-
-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.
-
---sensitivity [float]
-
-Sensitivity of the algorithm to detect anomalies - higher the value,
-more anomalies get flagged. The value estimated during training is
-used by default. You can choose to provide a custom value.
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci anomaly-detection model create --generate-param-json-input model-training-details > model-training-details.json
-
-Copy the following CLI commands into a file named example.sh. Run the
-command by typing “bash example.sh” and replacing the example
-parameters with your own.
-
-Please note this sample will only work in the POSIX-compliant bash-
-like shell. You need to set up the OCI configuration and appropriate
-security policies before trying the examples.
-
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/project/create.html#cmdoption-compartment-id
-       export request_type=<substitute-value-of-request_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/model/detect-anomalies.html#cmdoption-request-type
-
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       model_id=$(oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id --query data.id --raw-output)
-
-       oci anomaly-detection model detect-anomalies --model-id $model_id --request-type $request_type

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/model/get.txt

@@ -1,100 +0,0 @@
-"get"
-*****
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Gets a Model by identifier
-
-
-Usage
-=====
-
-   oci anomaly-detection model get [OPTIONS]
-
-
-Required Parameters
-===================
-
---model-id [text]
-
-The OCID of the Model.
-
-
-Optional Parameters
-===================
-
---from-json [text]
-
-Provide input to this command as a JSON document from a file using the
-file://path-to/file syntax.
-
-The "--generate-full-command-json-input" option can be used to
-generate a sample json file to be used with this command option. The
-key names are pre-populated and match the command option names
-(converted to camelCase format, e.g. compartment-id –> compartmentId),
-while the values of the keys need to be populated by the user before
-using the sample file as an input to this command. For any command
-option that accepts multiple values, the value of the key can be a
-JSON array.
-
-Options can still be provided on the command line. If an option exists
-in both the JSON document and the command line then the command line
-specified value will be used.
-
-For examples on usage of this option, please see our “using CLI with
-advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci anomaly-detection model create --generate-param-json-input model-training-details > model-training-details.json
-
-Copy the following CLI commands into a file named example.sh. Run the
-command by typing “bash example.sh” and replacing the example
-parameters with your own.
-
-Please note this sample will only work in the POSIX-compliant bash-
-like shell. You need to set up the OCI configuration and appropriate
-security policies before trying the examples.
-
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/project/create.html#cmdoption-compartment-id
-
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       model_id=$(oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id --query data.id --raw-output)
-
-       oci anomaly-detection model get --model-id $model_id

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/model/list.txt

@@ -1,148 +0,0 @@
-"list"
-******
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Returns a list of Models.
-
-
-Usage
-=====
-
-   oci anomaly-detection model list [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The ID of the compartment in which to list resources.
-
-
-Optional Parameters
-===================
-
---all
-
-Fetches all pages of results. If you provide this option, then you
-cannot provide the "--limit" option.
-
---display-name [text]
-
-A filter to return only resources that match the entire display name
-given.
-
---from-json [text]
-
-Provide input to this command as a JSON document from a file using the
-file://path-to/file syntax.
-
-The "--generate-full-command-json-input" option can be used to
-generate a sample json file to be used with this command option. The
-key names are pre-populated and match the command option names
-(converted to camelCase format, e.g. compartment-id –> compartmentId),
-while the values of the keys need to be populated by the user before
-using the sample file as an input to this command. For any command
-option that accepts multiple values, the value of the key can be a
-JSON array.
-
-Options can still be provided on the command line. If an option exists
-in both the JSON document and the command line then the command line
-specified value will be used.
-
-For examples on usage of this option, please see our “using CLI with
-advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---lifecycle-state [text]
-
-<b>Filter</b> results by the specified lifecycle state. Must be a
-valid state for the resource type.
-
-Accepted values are:
-
-   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
-
---limit [integer]
-
-The maximum number of items to return.
-
---page [text]
-
-The page token representing the page at which to start retrieving
-results. This is usually retrieved from a previous list call.
-
---page-size [integer]
-
-When fetching results, the number of results to fetch per call. Only
-valid when used with "--all" or "--limit", and ignored otherwise.
-
---project-id [text]
-
-The ID of the project for which to list the objects.
-
---sort-by [text]
-
-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.
-
-Accepted values are:
-
-   displayName, timeCreated
-
---sort-order [text]
-
-The sort order to use, either ‘asc’ or ‘desc’.
-
-Accepted values are:
-
-   ASC, DESC
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy the following CLI commands into a file named example.sh. Run the
-command by typing “bash example.sh” and replacing the example
-parameters with your own.
-
-Please note this sample will only work in the POSIX-compliant bash-
-like shell. You need to set up the OCI configuration and appropriate
-security policies before trying the examples.
-
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/model/list.html#cmdoption-compartment-id
-
-       oci anomaly-detection model list --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/model.txt

@@ -1,30 +0,0 @@
-model
-*****
-
-
-Description
-===========
-
-Description of Model.
-
-
-Available Commands
-==================
-
-* change-compartment
-
-* create
-
-* delete
-
-* detect-anomalies
-
-* detect-anomalies-embedded
-
-* detect-anomalies-inline
-
-* get
-
-* list
-
-* update