oci 2.126.4__py3-none-any.whl → 2.128.0__py3-none-any.whl

oci/generative_ai_inference/models/llama_llm_inference_request.py

@@ -410,7 +410,7 @@ class LlamaLlmInferenceRequest(LlmInferenceRequest):
     def max_tokens(self):
         """
         Gets the max_tokens of this LlamaLlmInferenceRequest.
-        The maximum number of tokens that can be generated per output sequence. The token count of your prompt plus max_tokens cannot exceed the model's context length.
+        The maximum number of tokens that can be generated per output sequence. The token count of the prompt plus `maxTokens` cannot exceed the model's context length.
 
 
         :return: The max_tokens of this LlamaLlmInferenceRequest.
@@ -422,7 +422,7 @@ class LlamaLlmInferenceRequest(LlmInferenceRequest):
     def max_tokens(self, max_tokens):
         """
         Sets the max_tokens of this LlamaLlmInferenceRequest.
-        The maximum number of tokens that can be generated per output sequence. The token count of your prompt plus max_tokens cannot exceed the model's context length.
+        The maximum number of tokens that can be generated per output sequence. The token count of the prompt plus `maxTokens` cannot exceed the model's context length.
 
 
         :param max_tokens: The max_tokens of this LlamaLlmInferenceRequest.

oci/generative_ai_inference/models/llama_llm_inference_response.py

@@ -23,7 +23,7 @@ class LlamaLlmInferenceResponse(LlmInferenceResponse):
 
         :param runtime_type:
             The value to assign to the runtime_type property of this LlamaLlmInferenceResponse.
-            Allowed values for this property are: "COHERE", "LLAMA", "OPENAI", "DALLE3"
+            Allowed values for this property are: "COHERE", "LLAMA"
         :type runtime_type: str
 
         :param created:

oci/generative_ai_inference/models/llm_inference_response.py

@@ -23,14 +23,6 @@ class LlmInferenceResponse(object):
     #: This constant has a value of "LLAMA"
     RUNTIME_TYPE_LLAMA = "LLAMA"
 
-    #: A constant which can be used with the runtime_type property of a LlmInferenceResponse.
-    #: This constant has a value of "OPENAI"
-    RUNTIME_TYPE_OPENAI = "OPENAI"
-
-    #: A constant which can be used with the runtime_type property of a LlmInferenceResponse.
-    #: This constant has a value of "DALLE3"
-    RUNTIME_TYPE_DALLE3 = "DALLE3"
-
     def __init__(self, **kwargs):
         """
         Initializes a new LlmInferenceResponse object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
@@ -43,7 +35,7 @@ class LlmInferenceResponse(object):
 
         :param runtime_type:
             The value to assign to the runtime_type property of this LlmInferenceResponse.
-            Allowed values for this property are: "COHERE", "LLAMA", "OPENAI", "DALLE3", 'UNKNOWN_ENUM_VALUE'.
+            Allowed values for this property are: "COHERE", "LLAMA", 'UNKNOWN_ENUM_VALUE'.
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type runtime_type: str
 
@@ -80,7 +72,7 @@ class LlmInferenceResponse(object):
         **[Required]** Gets the runtime_type of this LlmInferenceResponse.
         The runtime of the provided model.
 
-        Allowed values for this property are: "COHERE", "LLAMA", "OPENAI", "DALLE3", 'UNKNOWN_ENUM_VALUE'.
+        Allowed values for this property are: "COHERE", "LLAMA", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
 
 
@@ -99,7 +91,7 @@ class LlmInferenceResponse(object):
         :param runtime_type: The runtime_type of this LlmInferenceResponse.
         :type: str
         """
-        allowed_values = ["COHERE", "LLAMA", "OPENAI", "DALLE3"]
+        allowed_values = ["COHERE", "LLAMA"]
         if not value_allowed_none_or_none_sentinel(runtime_type, allowed_values):
             runtime_type = 'UNKNOWN_ENUM_VALUE'
         self._runtime_type = runtime_type

oci/generative_ai_inference/models/logprobs.py

@@ -12,7 +12,9 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class Logprobs(object):
     """
-    Returns if the logarithmic probabilites is set.
+    Includes the logarithmic probabilities for the most likely output tokens and the chosen tokens.
+
+    For example, if the log probability is 5, the API returns a list of the 5 most likely tokens. The API returns the log probability of the sampled token, so there might be up to logprobs+1 elements in the response.
     """
 
     def __init__(self, **kwargs):

oci/generative_ai_inference/models/message.py

@@ -12,16 +12,36 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class Message(object):
     """
-    An message that represents a single dialogue of chat
+    A message that represents a single chat dialog.
     """
 
+    #: A constant which can be used with the role property of a Message.
+    #: This constant has a value of "SYSTEM"
+    ROLE_SYSTEM = "SYSTEM"
+
+    #: A constant which can be used with the role property of a Message.
+    #: This constant has a value of "USER"
+    ROLE_USER = "USER"
+
+    #: A constant which can be used with the role property of a Message.
+    #: This constant has a value of "ASSISTANT"
+    ROLE_ASSISTANT = "ASSISTANT"
+
     def __init__(self, **kwargs):
         """
-        Initializes a new Message object with values from keyword arguments.
+        Initializes a new Message object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.generative_ai_inference.models.SystemMessage`
+        * :class:`~oci.generative_ai_inference.models.AssistantMessage`
+        * :class:`~oci.generative_ai_inference.models.UserMessage`
+
         The following keyword arguments are supported (corresponding to the getters/setters of this class):
 
         :param role:
             The value to assign to the role property of this Message.
+            Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type role: str
 
         :param content:
@@ -42,11 +62,33 @@ class Message(object):
         self._role = None
         self._content = None
 
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['role']
+
+        if type == 'SYSTEM':
+            return 'SystemMessage'
+
+        if type == 'ASSISTANT':
+            return 'AssistantMessage'
+
+        if type == 'USER':
+            return 'UserMessage'
+        else:
+            return 'Message'
+
     @property
     def role(self):
         """
         **[Required]** Gets the role of this Message.
-        Indicates who is giving the current message.
+        Indicates who is writing the current chat message.
+
+        Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
 
 
         :return: The role of this Message.
@@ -58,18 +100,21 @@ class Message(object):
     def role(self, role):
         """
         Sets the role of this Message.
-        Indicates who is giving the current message.
+        Indicates who is writing the current chat message.
 
 
         :param role: The role of this Message.
         :type: str
         """
+        allowed_values = ["SYSTEM", "USER", "ASSISTANT"]
+        if not value_allowed_none_or_none_sentinel(role, allowed_values):
+            role = 'UNKNOWN_ENUM_VALUE'
         self._role = role
 
     @property
     def content(self):
         """
-        **[Required]** Gets the content of this Message.
+        Gets the content of this Message.
         Contents of the chat message.
 
 

oci/generative_ai_inference/models/on_demand_serving_mode.py

@@ -49,7 +49,7 @@ class OnDemandServingMode(ServingMode):
     def model_id(self):
         """
         **[Required]** Gets the model_id of this OnDemandServingMode.
-        The unique ID of a model to use. Can use list Models API to list available models.
+        The unique ID of a model to use. You can use the :func:`list_models` API to list the available models.
 
 
         :return: The model_id of this OnDemandServingMode.
@@ -61,7 +61,7 @@ class OnDemandServingMode(ServingMode):
     def model_id(self, model_id):
         """
         Sets the model_id of this OnDemandServingMode.
-        The unique ID of a model to use. Can use list Models API to list available models.
+        The unique ID of a model to use. You can use the :func:`list_models` API to list the available models.
 
 
         :param model_id: The model_id of this OnDemandServingMode.

oci/generative_ai_inference/models/serving_mode.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ServingMode(object):
     """
-    The model's serving mode, which could be on-demand serving or dedicated serving.
+    The model's serving mode, which is either on-demand serving or dedicated serving.
     """
 
     #: A constant which can be used with the serving_type property of a ServingMode.
@@ -69,7 +69,7 @@ class ServingMode(object):
     def serving_type(self):
         """
         **[Required]** Gets the serving_type of this ServingMode.
-        The serving mode type, which could be on-demand serving or dedicated serving.
+        The serving mode type, which is either on-demand serving or dedicated serving.
 
         Allowed values for this property are: "ON_DEMAND", "DEDICATED"
 
@@ -83,7 +83,7 @@ class ServingMode(object):
     def serving_type(self, serving_type):
         """
         Sets the serving_type of this ServingMode.
-        The serving mode type, which could be on-demand serving or dedicated serving.
+        The serving mode type, which is either on-demand serving or dedicated serving.
 
 
         :param serving_type: The serving_type of this ServingMode.

oci/generative_ai_inference/models/summarize_text_details.py

@@ -186,7 +186,7 @@ class SummarizeTextDetails(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this SummarizeTextDetails.
-        The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+        The OCID of compartment in which to call the Generative AI service to summarize text.
 
 
         :return: The compartment_id of this SummarizeTextDetails.
@@ -198,7 +198,7 @@ class SummarizeTextDetails(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this SummarizeTextDetails.
-        The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+        The OCID of compartment in which to call the Generative AI service to summarize text.
 
 
         :param compartment_id: The compartment_id of this SummarizeTextDetails.

oci/generative_ai_inference/models/system_message.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 .message import Message
+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 SystemMessage(Message):
+    """
+    Represents a single instance of system message.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new SystemMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.SystemMessage.role` attribute
+        of this class is ``SYSTEM`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param role:
+            The value to assign to the role property of this SystemMessage.
+            Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT"
+        :type role: str
+
+        :param content:
+            The value to assign to the content property of this SystemMessage.
+        :type content: list[oci.generative_ai_inference.models.ChatContent]
+
+        :param name:
+            The value to assign to the name property of this SystemMessage.
+        :type name: str
+
+        """
+        self.swagger_types = {
+            'role': 'str',
+            'content': 'list[ChatContent]',
+            'name': 'str'
+        }
+
+        self.attribute_map = {
+            'role': 'role',
+            'content': 'content',
+            'name': 'name'
+        }
+
+        self._role = None
+        self._content = None
+        self._name = None
+        self._role = 'SYSTEM'
+
+    @property
+    def name(self):
+        """
+        Gets the name of this SystemMessage.
+        An optional name for the participant. Provides the model information to differentiate between participants of the same role.
+
+
+        :return: The name of this SystemMessage.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this SystemMessage.
+        An optional name for the participant. Provides the model information to differentiate between participants of the same role.
+
+
+        :param name: The name of this SystemMessage.
+        :type: str
+        """
+        self._name = name
+
+    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/text_content.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class TextContent(ChatContent):
     """
-    Represents a single instance of text chat content.
+    Represents a single instance of text in the chat content.
     """
 
     def __init__(self, **kwargs):

oci/generative_ai_inference/models/user_message.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 .message import Message
+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 UserMessage(Message):
+    """
+    Represents a single instance of user message.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new UserMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.UserMessage.role` attribute
+        of this class is ``USER`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param role:
+            The value to assign to the role property of this UserMessage.
+            Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT"
+        :type role: str
+
+        :param content:
+            The value to assign to the content property of this UserMessage.
+        :type content: list[oci.generative_ai_inference.models.ChatContent]
+
+        :param name:
+            The value to assign to the name property of this UserMessage.
+        :type name: str
+
+        """
+        self.swagger_types = {
+            'role': 'str',
+            'content': 'list[ChatContent]',
+            'name': 'str'
+        }
+
+        self.attribute_map = {
+            'role': 'role',
+            'content': 'content',
+            'name': 'name'
+        }
+
+        self._role = None
+        self._content = None
+        self._name = None
+        self._role = 'USER'
+
+    @property
+    def name(self):
+        """
+        Gets the name of this UserMessage.
+        An optional name for the participant. Provides the model information to differentiate between participants of the same role.
+
+
+        :return: The name of this UserMessage.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this UserMessage.
+        An optional name for the participant. Provides the model information to differentiate between participants of the same role.
+
+
+        :param name: The name of this UserMessage.
+        :type: str
+        """
+        self._name = name
+
+    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.126.4/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.128.0/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.126.4/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.128.0/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.126.4/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.128.0/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']