oci-cli 3.62.2__py3-none-any.whl → 3.63.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent/tool/create-tool-agent-tool-config.txt

@@ -0,0 +1,187 @@
+"create-tool-agent-tool-config"
+*******************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Creates a tool.
+
+
+Usage
+=====
+
+   oci generative-ai-agent tool create-tool-agent-tool-config [OPTIONS]
+
+
+Required Parameters
+===================
+
+--agent-id [text]
+
+The OCID of the agent that this Tool is attached to.
+
+--compartment-id, -c [text]
+
+The OCID of the compartment.
+
+--description [text]
+
+Description about the Tool.
+
+--tool-config-agent-endpoint-id [text]
+
+The AgentEndpoint OCID to be used as a tool in this agent.
+
+
+Optional Parameters
+===================
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Operations": {"CostCenter": "42"}}
+
+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.
+
+--display-name [text]
+
+A user-friendly name. Does not have to be unique, and it’s changeable.
+Avoid entering confidential information.
+
+--freeform-tags [complex type]
+
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. For more information, see
+Resource Tags.
+
+Example:
+
+   {"Department": "Finance"}
+
+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.
+
+--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
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the work request to reach the state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--metadata [complex type]
+
+Key-value pairs to allow additional configurations. 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.
+
+--wait-for-state [text]
+
+This operation asynchronously creates, modifies or deletes a resource
+and uses a work request to track the progress of the operation.
+Specify this option to perform the action and then wait until the work
+request reaches a certain state. Multiple states can be specified,
+returning on the first state. For example, "--wait-for-state"
+SUCCEEDED "--wait-for-state" FAILED would return on whichever
+lifecycle state is reached first. If timeout is reached, a return code
+of 2 is returned. For any other error, a return code of 1 is returned.
+
+Accepted values are:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the work request
+has reached the state defined by "--wait-for-state". Defaults to 30
+seconds.
+
+
+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/generative-ai-agent/agent/create.html#cmdoption-compartment-id
+       export description=<substitute-value-of-description> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-agent/tool/create-tool-agent-tool-config.html#cmdoption-description
+       export tool_config_agent_endpoint_id=<substitute-value-of-tool_config_agent_endpoint_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-agent/tool/create-tool-agent-tool-config.html#cmdoption-tool-config-agent-endpoint-id
+
+       agent_id=$(oci generative-ai-agent agent create --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci generative-ai-agent tool create-tool-agent-tool-config --agent-id $agent_id --compartment-id $compartment_id --description $description --tool-config-agent-endpoint-id $tool_config_agent_endpoint_id

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent/tool/create-tool-sql-tool-config.txt

@@ -41,17 +41,6 @@ The OCID of the compartment.
 
 Description about the Tool.
 
---tool-config-database-schema [complex type]
-
-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.
-
 --tool-config-dialect [text]
 
 Dialect to be used for SQL generation.
@@ -156,6 +145,17 @@ 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.
 
+--tool-config-database-schema [complex type]
+
+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.
+
 --tool-config-generation-llm-customization [complex type]
 
 This is a complex type whose value must be valid JSON. The value can
@@ -245,11 +245,6 @@ 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 generative-ai-agent tool create-tool-sql-tool-config --generate-param-json-input tool-config-database-schema > tool-config-database-schema.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.
@@ -264,4 +259,4 @@ security policies before trying the examples.
 
        agent_id=$(oci generative-ai-agent agent create --compartment-id $compartment_id --query data.id --raw-output)
 
-       oci generative-ai-agent tool create-tool-sql-tool-config --agent-id $agent_id --compartment-id $compartment_id --description $description --tool-config-database-schema file://tool-config-database-schema.json --tool-config-dialect $tool_config_dialect
+       oci generative-ai-agent tool create-tool-sql-tool-config --agent-id $agent_id --compartment-id $compartment_id --description $description --tool-config-dialect $tool_config_dialect

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent/tool/update-tool-agent-tool-config.txt

@@ -0,0 +1,202 @@
+"update-tool-agent-tool-config"
+*******************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates a tool.
+
+
+Usage
+=====
+
+   oci generative-ai-agent tool update-tool-agent-tool-config [OPTIONS]
+
+
+Required Parameters
+===================
+
+--tool-config-agent-endpoint-id [text]
+
+The AgentEndpoint OCID to be used as a tool in this agent.
+
+--tool-id [text]
+
+The OCID of the Tool.
+
+
+Optional Parameters
+===================
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Operations": {"CostCenter": "42"}}
+
+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.
+
+--description [text]
+
+Description about the Tool.
+
+--display-name [text]
+
+A user-friendly name. Does not have to be unique, and it’s changeable.
+Avoid entering confidential information.
+
+--force
+
+Perform update without prompting for confirmation.
+
+--freeform-tags [complex type]
+
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. For more information, see
+Resource Tags.
+
+Example:
+
+   {"Department": "Finance"}
+
+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.
+
+--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.
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the work request to reach the state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--metadata [complex type]
+
+Key-value pairs to allow additional configurations. 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.
+
+--wait-for-state [text]
+
+This operation asynchronously creates, modifies or deletes a resource
+and uses a work request to track the progress of the operation.
+Specify this option to perform the action and then wait until the work
+request reaches a certain state. Multiple states can be specified,
+returning on the first state. For example, "--wait-for-state"
+SUCCEEDED "--wait-for-state" FAILED would return on whichever
+lifecycle state is reached first. If timeout is reached, a return code
+of 2 is returned. For any other error, a return code of 1 is returned.
+
+Accepted values are:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the work request
+has reached the state defined by "--wait-for-state". Defaults to 30
+seconds.
+
+
+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 generative-ai-agent tool create --generate-param-json-input tool-config > tool-config.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/generative-ai-agent/agent/create.html#cmdoption-compartment-id
+       export description=<substitute-value-of-description> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-agent/tool/create.html#cmdoption-description
+       export tool_config_agent_endpoint_id=<substitute-value-of-tool_config_agent_endpoint_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-agent/tool/update-tool-agent-tool-config.html#cmdoption-tool-config-agent-endpoint-id
+
+       agent_id=$(oci generative-ai-agent agent create --compartment-id $compartment_id --query data.id --raw-output)
+
+       tool_id=$(oci generative-ai-agent tool create --agent-id $agent_id --compartment-id $compartment_id --description $description --tool-config file://tool-config.json --query data.id --raw-output)
+
+       oci generative-ai-agent tool update-tool-agent-tool-config --tool-config-agent-endpoint-id $tool_config_agent_endpoint_id --tool-id $tool_id

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent/tool/update-tool-sql-tool-config.txt

@@ -29,17 +29,6 @@ Usage
 Required Parameters
 ===================
 
---tool-config-database-schema [complex type]
-
-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.
-
 --tool-config-dialect [text]
 
 Dialect to be used for SQL generation.
@@ -164,6 +153,17 @@ 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.
 
+--tool-config-database-schema [complex type]
+
+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.
+
 --tool-config-generation-llm-customization [complex type]
 
 This is a complex type whose value must be valid JSON. The value can
@@ -258,8 +258,6 @@ example parameters with your own.
 
        oci generative-ai-agent tool create --generate-param-json-input tool-config > tool-config.json
 
-       oci generative-ai-agent tool update-tool-sql-tool-config --generate-param-json-input tool-config-database-schema > tool-config-database-schema.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.
@@ -276,4 +274,4 @@ security policies before trying the examples.
 
        tool_id=$(oci generative-ai-agent tool create --agent-id $agent_id --compartment-id $compartment_id --description $description --tool-config file://tool-config.json --query data.id --raw-output)
 
-       oci generative-ai-agent tool update-tool-sql-tool-config --tool-config-database-schema file://tool-config-database-schema.json --tool-config-dialect $tool_config_dialect --tool-id $tool_id
+       oci generative-ai-agent tool update-tool-sql-tool-config --tool-config-dialect $tool_config_dialect --tool-id $tool_id

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent/tool.txt

@@ -18,6 +18,8 @@ Available Commands
 
 * create
 
+* create-tool-agent-tool-config
+
 * create-tool-function-calling-tool-config
 
 * create-tool-http-endpoint-tool-config
@@ -34,6 +36,8 @@ Available Commands
 
 * update
 
+* update-tool-agent-tool-config
+
 * update-tool-function-calling-tool-config
 
 * update-tool-http-endpoint-tool-config

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent-runtime/agent-endpoint/chat.txt

@@ -93,12 +93,30 @@ context.
 
 Whether to stream the response.
 
+--tool-inputs [complex type]
+
+Array of tool input objects, each specifying a tool’s ID, type, and
+corresponding input parameters required for execution.
+
+This option is a JSON list with items of type ToolInput.  For
+documentation on ToolInput please see our API reference: https://docs
+.cloud.oracle.com/api/#/en/generativeaiagentruntime/20240531/datatype
+s/ToolInput. 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.
+
 --tool-parameters [complex type]
 
 A map where each key is a toolId and the value contains tool type and
-additional dynamic parameters. 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.
+additional dynamic parameters. This field is deprecated and will be
+removed after July 02 2026. 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

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent.txt

@@ -112,6 +112,8 @@ Available Commands
 
   * create
 
+  * create-tool-agent-tool-config
+
   * create-tool-function-calling-tool-config
 
   * create-tool-http-endpoint-tool-config
@@ -128,6 +130,8 @@ Available Commands
 
   * update
 
+  * update-tool-agent-tool-config
+
   * update-tool-function-calling-tool-config
 
   * update-tool-http-endpoint-tool-config

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request/work-request-error/{list.txt → list-errors.txt}

@@ -1,5 +1,5 @@
-"list"
-******
+"list-errors"
+*************
 
 * Description
 
@@ -24,7 +24,7 @@ given ID.
 Usage
 =====
 
-   oci governance-rules-control-plane work-request work-request-error list [OPTIONS]
+   oci governance-rules-control-plane work-request work-request-error list-errors [OPTIONS]
 
 
 Required Parameters
@@ -124,6 +124,6 @@ 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 work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/governance-rules-control-plane/work-request/work-request-error/list.html#cmdoption-work-request-id
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/governance-rules-control-plane/work-request/work-request-error/list-errors.html#cmdoption-work-request-id
 
-       oci governance-rules-control-plane work-request work-request-error list --work-request-id $work_request_id
+       oci governance-rules-control-plane work-request work-request-error list-errors --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request/work-request-error.txt

@@ -11,4 +11,4 @@ An error encountered while executing a work request.
 Available Commands
 ==================
 
-* list
+* list-errors

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request.txt

@@ -21,7 +21,7 @@ Available Commands
 
 * work-request-error
 
-  * list
+  * list-errors
 
 * work-request-log
 

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane.txt

@@ -77,7 +77,7 @@ Available Commands
 
   * work-request-error
 
-    * list
+    * list-errors
 
   * work-request-log