oci 2.150.1__py3-none-any.whl → 2.150.3__py3-none-any.whl

oci/generative_ai_inference/models/cohere_chat_response.py

@@ -93,6 +93,10 @@ class CohereChatResponse(BaseChatResponse):
             The value to assign to the prompt property of this CohereChatResponse.
         :type prompt: str
 
+        :param usage:
+            The value to assign to the usage property of this CohereChatResponse.
+        :type usage: oci.generative_ai_inference.models.Usage
+
         """
         self.swagger_types = {
             'api_format': 'str',
@@ -105,7 +109,8 @@ class CohereChatResponse(BaseChatResponse):
             'search_queries': 'list[SearchQuery]',
             'documents': 'list[object]',
             'tool_calls': 'list[CohereToolCall]',
-            'prompt': 'str'
+            'prompt': 'str',
+            'usage': 'Usage'
         }
         self.attribute_map = {
             'api_format': 'apiFormat',
@@ -118,7 +123,8 @@ class CohereChatResponse(BaseChatResponse):
             'search_queries': 'searchQueries',
             'documents': 'documents',
             'tool_calls': 'toolCalls',
-            'prompt': 'prompt'
+            'prompt': 'prompt',
+            'usage': 'usage'
         }
         self._api_format = None
         self._text = None
@@ -131,6 +137,7 @@ class CohereChatResponse(BaseChatResponse):
         self._documents = None
         self._tool_calls = None
         self._prompt = None
+        self._usage = None
         self._api_format = 'COHERE'
 
     @property
@@ -407,6 +414,26 @@ class CohereChatResponse(BaseChatResponse):
         """
         self._prompt = prompt
 
+    @property
+    def usage(self):
+        """
+        Gets the usage of this CohereChatResponse.
+
+        :return: The usage of this CohereChatResponse.
+        :rtype: oci.generative_ai_inference.models.Usage
+        """
+        return self._usage
+
+    @usage.setter
+    def usage(self, usage):
+        """
+        Sets the usage of this CohereChatResponse.
+
+        :param usage: The usage of this CohereChatResponse.
+        :type: oci.generative_ai_inference.models.Usage
+        """
+        self._usage = usage
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_inference/models/completion_tokens_details.py

@@ -0,0 +1,132 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20231130
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class CompletionTokensDetails(object):
+    """
+    Breakdown of tokens used in a completion.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CompletionTokensDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param accepted_prediction_tokens:
+            The value to assign to the accepted_prediction_tokens property of this CompletionTokensDetails.
+        :type accepted_prediction_tokens: int
+
+        :param reasoning_tokens:
+            The value to assign to the reasoning_tokens property of this CompletionTokensDetails.
+        :type reasoning_tokens: int
+
+        :param rejected_prediction_tokens:
+            The value to assign to the rejected_prediction_tokens property of this CompletionTokensDetails.
+        :type rejected_prediction_tokens: int
+
+        """
+        self.swagger_types = {
+            'accepted_prediction_tokens': 'int',
+            'reasoning_tokens': 'int',
+            'rejected_prediction_tokens': 'int'
+        }
+        self.attribute_map = {
+            'accepted_prediction_tokens': 'acceptedPredictionTokens',
+            'reasoning_tokens': 'reasoningTokens',
+            'rejected_prediction_tokens': 'rejectedPredictionTokens'
+        }
+        self._accepted_prediction_tokens = None
+        self._reasoning_tokens = None
+        self._rejected_prediction_tokens = None
+
+    @property
+    def accepted_prediction_tokens(self):
+        """
+        Gets the accepted_prediction_tokens of this CompletionTokensDetails.
+        When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.
+
+
+        :return: The accepted_prediction_tokens of this CompletionTokensDetails.
+        :rtype: int
+        """
+        return self._accepted_prediction_tokens
+
+    @accepted_prediction_tokens.setter
+    def accepted_prediction_tokens(self, accepted_prediction_tokens):
+        """
+        Sets the accepted_prediction_tokens of this CompletionTokensDetails.
+        When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.
+
+
+        :param accepted_prediction_tokens: The accepted_prediction_tokens of this CompletionTokensDetails.
+        :type: int
+        """
+        self._accepted_prediction_tokens = accepted_prediction_tokens
+
+    @property
+    def reasoning_tokens(self):
+        """
+        Gets the reasoning_tokens of this CompletionTokensDetails.
+        Tokens generated by the model for reasoning.
+
+
+        :return: The reasoning_tokens of this CompletionTokensDetails.
+        :rtype: int
+        """
+        return self._reasoning_tokens
+
+    @reasoning_tokens.setter
+    def reasoning_tokens(self, reasoning_tokens):
+        """
+        Sets the reasoning_tokens of this CompletionTokensDetails.
+        Tokens generated by the model for reasoning.
+
+
+        :param reasoning_tokens: The reasoning_tokens of this CompletionTokensDetails.
+        :type: int
+        """
+        self._reasoning_tokens = reasoning_tokens
+
+    @property
+    def rejected_prediction_tokens(self):
+        """
+        Gets the rejected_prediction_tokens of this CompletionTokensDetails.
+        When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits.
+
+
+        :return: The rejected_prediction_tokens of this CompletionTokensDetails.
+        :rtype: int
+        """
+        return self._rejected_prediction_tokens
+
+    @rejected_prediction_tokens.setter
+    def rejected_prediction_tokens(self, rejected_prediction_tokens):
+        """
+        Sets the rejected_prediction_tokens of this CompletionTokensDetails.
+        When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits.
+
+
+        :param rejected_prediction_tokens: The rejected_prediction_tokens of this CompletionTokensDetails.
+        :type: int
+        """
+        self._rejected_prediction_tokens = rejected_prediction_tokens
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generative_ai_inference/models/embed_text_result.py

@@ -40,26 +40,33 @@ class EmbedTextResult(object):
             The value to assign to the model_version property of this EmbedTextResult.
         :type model_version: str
 
+        :param usage:
+            The value to assign to the usage property of this EmbedTextResult.
+        :type usage: oci.generative_ai_inference.models.Usage
+
         """
         self.swagger_types = {
             'id': 'str',
             'inputs': 'list[str]',
             'embeddings': 'list[list[float]]',
             'model_id': 'str',
-            'model_version': 'str'
+            'model_version': 'str',
+            'usage': 'Usage'
         }
         self.attribute_map = {
             'id': 'id',
             'inputs': 'inputs',
             'embeddings': 'embeddings',
             'model_id': 'modelId',
-            'model_version': 'modelVersion'
+            'model_version': 'modelVersion',
+            'usage': 'usage'
         }
         self._id = None
         self._inputs = None
         self._embeddings = None
         self._model_id = None
         self._model_version = None
+        self._usage = None
 
     @property
     def id(self):
@@ -181,6 +188,26 @@ class EmbedTextResult(object):
         """
         self._model_version = model_version
 
+    @property
+    def usage(self):
+        """
+        Gets the usage of this EmbedTextResult.
+
+        :return: The usage of this EmbedTextResult.
+        :rtype: oci.generative_ai_inference.models.Usage
+        """
+        return self._usage
+
+    @usage.setter
+    def usage(self, usage):
+        """
+        Sets the usage of this EmbedTextResult.
+
+        :param usage: The usage of this EmbedTextResult.
+        :type: oci.generative_ai_inference.models.Usage
+        """
+        self._usage = usage
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_inference/models/prompt_tokens_details.py

@@ -0,0 +1,70 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20231130
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class PromptTokensDetails(object):
+    """
+    Breakdown of tokens used in the prompt.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PromptTokensDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param cached_tokens:
+            The value to assign to the cached_tokens property of this PromptTokensDetails.
+        :type cached_tokens: int
+
+        """
+        self.swagger_types = {
+            'cached_tokens': 'int'
+        }
+        self.attribute_map = {
+            'cached_tokens': 'cachedTokens'
+        }
+        self._cached_tokens = None
+
+    @property
+    def cached_tokens(self):
+        """
+        Gets the cached_tokens of this PromptTokensDetails.
+        Cached tokens present in the prompt.
+
+
+        :return: The cached_tokens of this PromptTokensDetails.
+        :rtype: int
+        """
+        return self._cached_tokens
+
+    @cached_tokens.setter
+    def cached_tokens(self, cached_tokens):
+        """
+        Sets the cached_tokens of this PromptTokensDetails.
+        Cached tokens present in the prompt.
+
+
+        :param cached_tokens: The cached_tokens of this PromptTokensDetails.
+        :type: int
+        """
+        self._cached_tokens = cached_tokens
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generative_ai_inference/models/stream_options.py

@@ -0,0 +1,70 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20231130
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class StreamOptions(object):
+    """
+    Options for streaming response. Only set this when you set stream: true.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new StreamOptions object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param is_include_usage:
+            The value to assign to the is_include_usage property of this StreamOptions.
+        :type is_include_usage: bool
+
+        """
+        self.swagger_types = {
+            'is_include_usage': 'bool'
+        }
+        self.attribute_map = {
+            'is_include_usage': 'isIncludeUsage'
+        }
+        self._is_include_usage = None
+
+    @property
+    def is_include_usage(self):
+        """
+        Gets the is_include_usage of this StreamOptions.
+        If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request
+
+
+        :return: The is_include_usage of this StreamOptions.
+        :rtype: bool
+        """
+        return self._is_include_usage
+
+    @is_include_usage.setter
+    def is_include_usage(self, is_include_usage):
+        """
+        Sets the is_include_usage of this StreamOptions.
+        If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request
+
+
+        :param is_include_usage: The is_include_usage of this StreamOptions.
+        :type: bool
+        """
+        self._is_include_usage = is_include_usage
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generative_ai_inference/models/usage.py

@@ -0,0 +1,186 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20231130
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class Usage(object):
+    """
+    Usage statistics for the completion request.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Usage object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param completion_tokens:
+            The value to assign to the completion_tokens property of this Usage.
+        :type completion_tokens: int
+
+        :param prompt_tokens:
+            The value to assign to the prompt_tokens property of this Usage.
+        :type prompt_tokens: int
+
+        :param total_tokens:
+            The value to assign to the total_tokens property of this Usage.
+        :type total_tokens: int
+
+        :param completion_tokens_details:
+            The value to assign to the completion_tokens_details property of this Usage.
+        :type completion_tokens_details: oci.generative_ai_inference.models.CompletionTokensDetails
+
+        :param prompt_tokens_details:
+            The value to assign to the prompt_tokens_details property of this Usage.
+        :type prompt_tokens_details: oci.generative_ai_inference.models.PromptTokensDetails
+
+        """
+        self.swagger_types = {
+            'completion_tokens': 'int',
+            'prompt_tokens': 'int',
+            'total_tokens': 'int',
+            'completion_tokens_details': 'CompletionTokensDetails',
+            'prompt_tokens_details': 'PromptTokensDetails'
+        }
+        self.attribute_map = {
+            'completion_tokens': 'completionTokens',
+            'prompt_tokens': 'promptTokens',
+            'total_tokens': 'totalTokens',
+            'completion_tokens_details': 'completionTokensDetails',
+            'prompt_tokens_details': 'promptTokensDetails'
+        }
+        self._completion_tokens = None
+        self._prompt_tokens = None
+        self._total_tokens = None
+        self._completion_tokens_details = None
+        self._prompt_tokens_details = None
+
+    @property
+    def completion_tokens(self):
+        """
+        Gets the completion_tokens of this Usage.
+        Number of tokens in the generated completion.
+
+
+        :return: The completion_tokens of this Usage.
+        :rtype: int
+        """
+        return self._completion_tokens
+
+    @completion_tokens.setter
+    def completion_tokens(self, completion_tokens):
+        """
+        Sets the completion_tokens of this Usage.
+        Number of tokens in the generated completion.
+
+
+        :param completion_tokens: The completion_tokens of this Usage.
+        :type: int
+        """
+        self._completion_tokens = completion_tokens
+
+    @property
+    def prompt_tokens(self):
+        """
+        Gets the prompt_tokens of this Usage.
+        Number of tokens in the prompt.
+
+
+        :return: The prompt_tokens of this Usage.
+        :rtype: int
+        """
+        return self._prompt_tokens
+
+    @prompt_tokens.setter
+    def prompt_tokens(self, prompt_tokens):
+        """
+        Sets the prompt_tokens of this Usage.
+        Number of tokens in the prompt.
+
+
+        :param prompt_tokens: The prompt_tokens of this Usage.
+        :type: int
+        """
+        self._prompt_tokens = prompt_tokens
+
+    @property
+    def total_tokens(self):
+        """
+        Gets the total_tokens of this Usage.
+        Total number of tokens used in the request (prompt + completion).
+
+
+        :return: The total_tokens of this Usage.
+        :rtype: int
+        """
+        return self._total_tokens
+
+    @total_tokens.setter
+    def total_tokens(self, total_tokens):
+        """
+        Sets the total_tokens of this Usage.
+        Total number of tokens used in the request (prompt + completion).
+
+
+        :param total_tokens: The total_tokens of this Usage.
+        :type: int
+        """
+        self._total_tokens = total_tokens
+
+    @property
+    def completion_tokens_details(self):
+        """
+        Gets the completion_tokens_details of this Usage.
+
+        :return: The completion_tokens_details of this Usage.
+        :rtype: oci.generative_ai_inference.models.CompletionTokensDetails
+        """
+        return self._completion_tokens_details
+
+    @completion_tokens_details.setter
+    def completion_tokens_details(self, completion_tokens_details):
+        """
+        Sets the completion_tokens_details of this Usage.
+
+        :param completion_tokens_details: The completion_tokens_details of this Usage.
+        :type: oci.generative_ai_inference.models.CompletionTokensDetails
+        """
+        self._completion_tokens_details = completion_tokens_details
+
+    @property
+    def prompt_tokens_details(self):
+        """
+        Gets the prompt_tokens_details of this Usage.
+
+        :return: The prompt_tokens_details of this Usage.
+        :rtype: oci.generative_ai_inference.models.PromptTokensDetails
+        """
+        return self._prompt_tokens_details
+
+    @prompt_tokens_details.setter
+    def prompt_tokens_details(self, prompt_tokens_details):
+        """
+        Sets the prompt_tokens_details of this Usage.
+
+        :param prompt_tokens_details: The prompt_tokens_details of this Usage.
+        :type: oci.generative_ai_inference.models.PromptTokensDetails
+        """
+        self._prompt_tokens_details = prompt_tokens_details
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generic_artifacts_content/generic_artifacts_content_client.py

@@ -154,7 +154,7 @@ class GenericArtifactsContentClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.150.1/genericartifactscontent/get_generic_artifact_content.py.html>`__ to see an example of how to use get_generic_artifact_content API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.150.3/genericartifactscontent/get_generic_artifact_content.py.html>`__ to see an example of how to use get_generic_artifact_content API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['artifactId']
@@ -269,7 +269,7 @@ class GenericArtifactsContentClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.150.1/genericartifactscontent/get_generic_artifact_content_by_path.py.html>`__ to see an example of how to use get_generic_artifact_content_by_path API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.150.3/genericartifactscontent/get_generic_artifact_content_by_path.py.html>`__ to see an example of how to use get_generic_artifact_content_by_path API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['repositoryId', 'artifactPath', 'version']
@@ -399,7 +399,7 @@ class GenericArtifactsContentClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.150.1/genericartifactscontent/put_generic_artifact_content_by_path.py.html>`__ to see an example of how to use put_generic_artifact_content_by_path API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.150.3/genericartifactscontent/put_generic_artifact_content_by_path.py.html>`__ to see an example of how to use put_generic_artifact_content_by_path API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['repositoryId', 'artifactPath', 'version']