oci-cli 3.72.0__py3-none-any.whl → 3.72.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-inference/chat-result/chat-cohere-chat-request-v2.txt

@@ -0,0 +1,350 @@
+"chat-cohere-chat-request-v2"
+*****************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Creates a response for the given conversation.
+
+
+Usage
+=====
+
+   oci generative-ai-inference chat-result chat-cohere-chat-request-v2 [OPTIONS]
+
+
+Required Parameters
+===================
+
+--chat-request-messages [complex type]
+
+A list of chat messages in chronological order, representing a
+conversation between the user and the model. 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.
+
+--compartment-id, -c [text]
+
+The OCID of compartment in which to call the Generative AI service to
+chat.
+
+--serving-mode [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.
+
+
+Optional Parameters
+===================
+
+--chat-request-citation-options [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.
+
+--chat-request-documents [complex type]
+
+A list of relevant documents that the model can refer to for
+generating grounded responses to the user’s requests. Some example
+keys that you can add to the dictionary are “text”, “author”, and
+“date”. Keep the total word count of the strings in the dictionary to
+300 words or less. 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.
+
+--chat-request-frequency-penalty [text]
+
+To reduce repetitiveness of generated tokens, this number penalizes
+new tokens based on their frequency in the generated text so far.
+Greater numbers encourage the model to use new tokens, while lower
+numbers encourage the model to repeat the tokens. Set to 0 to disable.
+
+--chat-request-is-log-probs-enabled [boolean]
+
+The log probabilities of the generated tokens will be included in the
+response.
+
+--chat-request-is-raw-prompting [boolean]
+
+When enabled, the user’s *message* will be sent to the model without
+any preprocessing.
+
+--chat-request-is-search-queries-only [boolean]
+
+When set to true, the response contains only a list of generated
+search queries without the search results and the model will not
+respond to the user’s message.
+
+--chat-request-is-stream [boolean]
+
+Whether to stream the partial progress of the model’s response. When
+set to true, as tokens become available, they are sent as data-only
+server-sent events.
+
+--chat-request-is-strict-tools-enabled [boolean]
+
+When set to true, tool calls in the Assistant message will be forced
+to follow the tool definition strictly. Note:The first few requests
+with a new set of tools will take longer to process.
+
+--chat-request-max-tokens [integer]
+
+The maximum number of output tokens that the model will generate for
+the response. The token count of your prompt plus maxTokens must not
+exceed the model’s context length. For on-demand inferencing, the
+response length is capped at 4,000 tokens for each run.
+
+--chat-request-presence-penalty [text]
+
+To reduce repetitiveness of generated tokens, this number penalizes
+new tokens based on whether they’ve appeared in the generated text so
+far. Greater numbers encourage the model to use new tokens, while
+lower numbers encourage the model to repeat the tokens.
+
+Similar to frequency penalty, a penalty is applied to previously
+present tokens, except that this penalty is applied equally to all
+tokens that have already appeared, regardless of how many times
+they’ve appeared. Set to 0 to disable.
+
+--chat-request-priority [integer]
+
+The priority of the request (lower means earlier handling; default 0
+highest priority). Higher priority requests are handled first, and
+dropped last when the system is under load.
+
+--chat-request-response-format [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.
+
+--chat-request-safety-mode [text]
+
+Safety mode: Adds a safety instruction for the model to use when
+generating responses. Contextual: (Default) Puts fewer constraints on
+the output. It maintains core protections by aiming to reject harmful
+or illegal suggestions, but it allows profanity and some toxic
+content, sexually explicit and violent content, and content that
+contains medical, financial, or legal information. Contextual mode is
+suited for entertainment, creative, or academic use. Strict: Aims to
+avoid sensitive topics, such as violent or sexual acts and profanity.
+This mode aims to provide a safer experience by prohibiting responses
+or recommendations that it finds inappropriate. Strict mode is suited
+for corporate use, such as for corporate communications and customer
+service. Off: No safety mode is applied. Note: This parameter is only
+compatible with models cohere.command-r-08-2024,
+cohere.command-r-plus-08-2024 and Cohere models released after these
+models. See release dates.
+
+Accepted values are:
+
+   CONTEXTUAL, OFF, STRICT
+
+--chat-request-seed [integer]
+
+If specified, the backend will make a best effort to sample tokens
+deterministically, so that repeated requests with the same seed and
+parameters yield the same result. However, determinism cannot be fully
+guaranteed.
+
+--chat-request-stop-sequences [complex type]
+
+Stop the model generation when it reaches a stop sequence defined in
+this parameter. 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.
+
+--chat-request-stream-options [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.
+
+--chat-request-temperature [text]
+
+A number that sets the randomness of the generated output. A lower
+temperature means less random generations. Use lower numbers for tasks
+such as question answering or summarizing. High temperatures can
+generate hallucinations or factually incorrect information. Start with
+temperatures lower than 1.0 and increase the temperature for more
+creative outputs, as you regenerate the prompts to refine the outputs.
+
+--chat-request-thinking [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.
+
+--chat-request-tools [complex type]
+
+A list of available tools (functions) that the model may suggest
+invoking before producing a text response.
+
+This option is a JSON list with items of type CohereToolV2.  For
+documentation on CohereToolV2 please see our API reference: https://d
+ocs.cloud.oracle.com/api/#/en/generativeaiinference/20231130/datatype
+s/CohereToolV2. 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.
+
+--chat-request-tools-choice [text]
+
+Used to control whether or not the model will be forced to use a tool
+when answering. When REQUIRED is specified, the model will be forced
+to use at least one of the user-defined tools, and the tools parameter
+must be passed in the request. When NONE is specified, the model will
+be forced not to use one of the specified tools, and give a direct
+response. If tool_choice isn’t specified, then the model is free to
+choose whether to use the specified tools or not. Note:This parameter
+is only compatible with models Command-r7b and newer.
+
+Accepted values are:
+
+   NONE, REQUIRED
+
+--chat-request-top-k [integer]
+
+A sampling method in which the model chooses the next token randomly
+from the top k most likely tokens. A higher value for k generates more
+random output, which makes the output text sound more natural. The
+default value for k is 0 which disables this method and considers all
+tokens. To set a number for the likely tokens, choose an integer
+between 1 and 500.
+
+If also using top p, then the model considers only the top tokens
+whose probabilities add up to p percent and ignores the rest of the k
+tokens. For example, if k is 20 but only the probabilities of the top
+10 add up to the value of p, then only the top 10 tokens are chosen.
+
+--chat-request-top-p [text]
+
+If set to a probability 0.0 < p < 1.0, it ensures that only the most
+likely tokens, with total probability mass of p, are considered for
+generation at each step.
+
+To eliminate tokens with low likelihood, assign p a minimum percentage
+for the next token’s likelihood. For example, when p is set to 0.75,
+the model eliminates the bottom 25 percent for the next token. Set to
+1.0 to consider all tokens and set to 0 to disable. If both k and p
+are enabled, p acts after k.
+
+--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", "--enable-dual-stack", "--enable-propagation", "--
+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-inference chat-result chat-cohere-chat-request-v2 --generate-param-json-input chat-request-messages > chat-request-messages.json
+       oci generative-ai-inference chat-result chat-cohere-chat-request-v2 --generate-param-json-input serving-mode > serving-mode.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-inference/chat-result/chat-cohere-chat-request-v2.html#cmdoption-compartment-id
+
+       oci generative-ai-inference chat-result chat-cohere-chat-request-v2 --chat-request-messages file://chat-request-messages.json --compartment-id $compartment_id --serving-mode file://serving-mode.json

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-inference/chat-result/chat-generic-chat-request.txt

@@ -181,7 +181,7 @@ on reasoning in a response.
 
 Accepted values are:
 
-   HIGH, LOW, MEDIUM, MINIMAL
+   HIGH, LOW, MEDIUM, MINIMAL, NONE
 
 --chat-request-response-format [complex type]
 

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-inference/chat-result.txt

@@ -15,6 +15,8 @@ Available Commands
 
 * chat-cohere-chat-request
 
+* chat-cohere-chat-request-v2
+
 * chat-dedicated-serving-mode
 
 * chat-generic-chat-request

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-inference/embed-text-result/embed-text.txt

@@ -76,6 +76,16 @@ via the file:// syntax.
 Optional Parameters
 ===================
 
+--embedding-types [text]
+
+Specifies the types of embeddings you want to get back. Supports list
+of enums. Supported values :float, int8, uint8, binary, ubinary,
+base64. If nothing is passed default will be considered as float.
+
+Accepted values are:
+
+   base64, binary, float, int8, ubinary, uint8
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the
@@ -111,6 +121,12 @@ Accepted values are:
 Whether or not to include the original inputs in the response. Results
 are index-based.
 
+--output-dimensions [integer]
+
+The number of dimensions of the output embedding. This is only
+available for embed-v4 and newer models. Possible values are 256, 512,
+1024, and 1536.
+
 --truncate [text]
 
 For an input that’s longer than the maximum token length, specifies

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-inference/rerank-text-result/rerank-text-dedicated-serving-mode.txt

@@ -91,6 +91,10 @@ Whether or not to return the documents in the response.
 
 The maximum number of chunks to produce internally from a document.
 
+--max-tokens-per-document [integer]
+
+Used to truncate the long documents with the specified no of tokens.
+
 --top-n [integer]
 
 The number of most relevant documents or indices to return. Defaults

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-inference/rerank-text-result/rerank-text-on-demand-serving-mode.txt

@@ -92,6 +92,10 @@ Whether or not to return the documents in the response.
 
 The maximum number of chunks to produce internally from a document.
 
+--max-tokens-per-document [integer]
+
+Used to truncate the long documents with the specified no of tokens.
+
 --top-n [integer]
 
 The number of most relevant documents or indices to return. Defaults

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-inference/rerank-text-result/rerank-text.txt

@@ -98,6 +98,10 @@ Whether or not to return the documents in the response.
 
 The maximum number of chunks to produce internally from a document.
 
+--max-tokens-per-document [integer]
+
+Used to truncate the long documents with the specified no of tokens.
+
 --top-n [integer]
 
 The number of most relevant documents or indices to return. Defaults

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

@@ -41,6 +41,8 @@ Available Commands
 
   * chat-cohere-chat-request
 
+  * chat-cohere-chat-request-v2
+
   * chat-dedicated-serving-mode
 
   * chat-generic-chat-request

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

@@ -27,6 +27,26 @@ To learn more about the service, see the Generative AI documentation.
 Available Commands
 ==================
 
+* api-key
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * renew
+
+  * set-api-key-state
+
+  * update
+
+* api-key-collection
+
+  * list-api-keys
+
 * dedicated-ai-cluster
 
   * change-compartment

oci_cli/help_text_producer/data_files/text/cmdref/iot/digital-twin-instance/get-content.txt

@@ -17,8 +17,9 @@
 Description
 ===========
 
-Retrieves the latest snapshot data of digital twin instance identified
-by the specified OCID.
+Retrieves the content associated with a digital twin instance
+identified by the specified OCID. The content can be retrieved only
+when a model is associated with the digital twin instance.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/iot/domain-group/create.txt

@@ -110,6 +110,16 @@ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 The maximum time to wait for the work request to reach the state
 defined by "--wait-for-state". Defaults to 1200 seconds.
 
+--type [text]
+
+Type of the domain group. LIGHTWEIGHT uses fewer resources and has a
+higher Recovery Time Objective (RTO), making it suitable for
+development and testing. STANDARD is recommended for production.
+
+Accepted values are:
+
+   LIGHTWEIGHT, STANDARD
+
 --wait-for-state [text]
 
 This operation asynchronously creates, modifies or deletes a resource

oci_cli/help_text_producer/data_files/text/cmdref/iot/domain-group/list.txt

@@ -117,6 +117,14 @@ Accepted values are:
 
    ASC, DESC
 
+--type [text]
+
+Filter resources by type. Valid values are LIGHTWEIGHT or STANDARD.
+
+Accepted values are:
+
+   LIGHTWEIGHT, STANDARD
+
 
 Global Parameters
 =================

oci_cli/help_text_producer/data_files/text/cmdref/organizations/work-request-error/{list.txt → list-errors.txt}

@@ -1,5 +1,5 @@
-"list"
-******
+"list-errors"
+*************
 
 * Description
 
@@ -23,7 +23,7 @@ Return a (paginated) list of errors for a given work request.
 Usage
 =====
 
-   oci organizations work-request-error list [OPTIONS]
+   oci organizations work-request-error list-errors [OPTIONS]
 
 
 Required Parameters
@@ -114,6 +114,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/organizations/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/organizations/work-request-error/list-errors.html#cmdoption-work-request-id
 
-       oci organizations work-request-error list --work-request-id $work_request_id
+       oci organizations work-request-error list-errors --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/organizations/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/organizations/{work-request-log-entry → work-request-log}/list.txt

@@ -11,6 +11,8 @@
 
 * Global Parameters
 
+* Example using required parameter
+
 
 Description
 ===========
@@ -21,7 +23,7 @@ Return a (paginated) list of logs for a given work request.
 Usage
 =====
 
-   oci organizations work-request-log-entry list [OPTIONS]
+   oci organizations work-request-log list [OPTIONS]
 
 
 Required Parameters
@@ -99,3 +101,19 @@ 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 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/organizations/work-request-log/list.html#cmdoption-work-request-id
+
+       oci organizations work-request-log list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/organizations/{work-request-log-entry.txt → work-request-log.txt}

@@ -1,5 +1,5 @@
-work-request-log-entry
-**********************
+work-request-log
+****************
 
 
 Description

oci_cli/help_text_producer/data_files/text/cmdref/organizations.txt

@@ -141,8 +141,8 @@ Available Commands
 
 * work-request-error
 
-  * list
+  * list-errors
 
-* work-request-log-entry
+* work-request-log
 
   * list

oci_cli/version.py

@@ -2,4 +2,4 @@
 # Copyright (c) 2016, 2026, Oracle and/or its affiliates. All rights reserved.
 # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 
-__version__ = '3.72.0'
+__version__ = '3.72.1'

{oci_cli-3.72.0.dist-info → oci_cli-3.72.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oci-cli
-Version: 3.72.0
+Version: 3.72.1
 Summary: Oracle Cloud Infrastructure CLI
 Home-page: https://docs.cloud.oracle.com/iaas/Content/API/Concepts/cliconcepts.htm
 Author: Oracle
@@ -23,7 +23,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.6
-Requires-Dist: oci (==2.165.0)
+Requires-Dist: oci (==2.165.1)
 Requires-Dist: arrow (>=1.0.0)
 Requires-Dist: certifi (>=2025.1.31)
 Requires-Dist: click (==8.0.4)