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

oci/generative_ai_inference/models/cohere_chat_response.py

@@ -55,6 +55,10 @@ class CohereChatResponse(BaseChatResponse):
             The value to assign to the text property of this CohereChatResponse.
         :type text: str
 
+        :param chat_history:
+            The value to assign to the chat_history property of this CohereChatResponse.
+        :type chat_history: list[oci.generative_ai_inference.models.CohereMessage]
+
         :param citations:
             The value to assign to the citations property of this CohereChatResponse.
         :type citations: list[oci.generative_ai_inference.models.Citation]
@@ -69,6 +73,10 @@ class CohereChatResponse(BaseChatResponse):
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type finish_reason: str
 
+        :param error_message:
+            The value to assign to the error_message property of this CohereChatResponse.
+        :type error_message: str
+
         :param search_queries:
             The value to assign to the search_queries property of this CohereChatResponse.
         :type search_queries: list[oci.generative_ai_inference.models.SearchQuery]
@@ -77,41 +85,61 @@ class CohereChatResponse(BaseChatResponse):
             The value to assign to the documents property of this CohereChatResponse.
         :type documents: list[object]
 
+        :param tool_calls:
+            The value to assign to the tool_calls property of this CohereChatResponse.
+        :type tool_calls: list[oci.generative_ai_inference.models.CohereToolCall]
+
+        :param prompt:
+            The value to assign to the prompt property of this CohereChatResponse.
+        :type prompt: str
+
         """
         self.swagger_types = {
             'api_format': 'str',
             'text': 'str',
+            'chat_history': 'list[CohereMessage]',
             'citations': 'list[Citation]',
             'is_search_required': 'bool',
             'finish_reason': 'str',
+            'error_message': 'str',
             'search_queries': 'list[SearchQuery]',
-            'documents': 'list[object]'
+            'documents': 'list[object]',
+            'tool_calls': 'list[CohereToolCall]',
+            'prompt': 'str'
         }
 
         self.attribute_map = {
             'api_format': 'apiFormat',
             'text': 'text',
+            'chat_history': 'chatHistory',
             'citations': 'citations',
             'is_search_required': 'isSearchRequired',
             'finish_reason': 'finishReason',
+            'error_message': 'errorMessage',
             'search_queries': 'searchQueries',
-            'documents': 'documents'
+            'documents': 'documents',
+            'tool_calls': 'toolCalls',
+            'prompt': 'prompt'
         }
 
         self._api_format = None
         self._text = None
+        self._chat_history = None
         self._citations = None
         self._is_search_required = None
         self._finish_reason = None
+        self._error_message = None
         self._search_queries = None
         self._documents = None
+        self._tool_calls = None
+        self._prompt = None
         self._api_format = 'COHERE'
 
     @property
     def text(self):
         """
         **[Required]** Gets the text of this CohereChatResponse.
-        Contents of the reply generated by the model.
+        Contents of the response that the model generates.
 
 
         :return: The text of this CohereChatResponse.
@@ -123,7 +151,7 @@ class CohereChatResponse(BaseChatResponse):
     def text(self, text):
         """
         Sets the text of this CohereChatResponse.
-        Contents of the reply generated by the model.
+        Contents of the response that the model generates.
 
 
         :param text: The text of this CohereChatResponse.
@@ -131,11 +159,35 @@ class CohereChatResponse(BaseChatResponse):
         """
         self._text = text
 
+    @property
+    def chat_history(self):
+        """
+        Gets the chat_history of this CohereChatResponse.
+        The list of previous messages between the user and the model. The chat history gives the model context for responding to the user's inputs.
+
+
+        :return: The chat_history of this CohereChatResponse.
+        :rtype: list[oci.generative_ai_inference.models.CohereMessage]
+        """
+        return self._chat_history
+
+    @chat_history.setter
+    def chat_history(self, chat_history):
+        """
+        Sets the chat_history of this CohereChatResponse.
+        The list of previous messages between the user and the model. The chat history gives the model context for responding to the user's inputs.
+
+
+        :param chat_history: The chat_history of this CohereChatResponse.
+        :type: list[oci.generative_ai_inference.models.CohereMessage]
+        """
+        self._chat_history = chat_history
+
     @property
     def citations(self):
         """
         Gets the citations of this CohereChatResponse.
-        Inline citations for the generated reply.
+        Inline citations for the generated response.
 
 
         :return: The citations of this CohereChatResponse.
@@ -147,7 +199,7 @@ class CohereChatResponse(BaseChatResponse):
     def citations(self, citations):
         """
         Sets the citations of this CohereChatResponse.
-        Inline citations for the generated reply.
+        Inline citations for the generated response.
 
 
         :param citations: The citations of this CohereChatResponse.
@@ -159,7 +211,7 @@ class CohereChatResponse(BaseChatResponse):
     def is_search_required(self):
         """
         Gets the is_search_required of this CohereChatResponse.
-        Denotes that a search for documents is required.
+        If set to true, a search for documents is required.
 
 
         :return: The is_search_required of this CohereChatResponse.
@@ -171,7 +223,7 @@ class CohereChatResponse(BaseChatResponse):
     def is_search_required(self, is_search_required):
         """
         Sets the is_search_required of this CohereChatResponse.
-        Denotes that a search for documents is required.
+        If set to true, a search for documents is required.
 
 
         :param is_search_required: The is_search_required of this CohereChatResponse.
@@ -183,7 +235,7 @@ class CohereChatResponse(BaseChatResponse):
     def finish_reason(self):
         """
         **[Required]** Gets the finish_reason of this CohereChatResponse.
-        Why the generation was completed.
+        Why the generation stopped.
 
         Allowed values for this property are: "COMPLETE", "ERROR_TOXIC", "ERROR_LIMIT", "ERROR", "USER_CANCEL", "MAX_TOKENS", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -198,7 +250,7 @@ class CohereChatResponse(BaseChatResponse):
     def finish_reason(self, finish_reason):
         """
         Sets the finish_reason of this CohereChatResponse.
-        Why the generation was completed.
+        Why the generation stopped.
 
 
         :param finish_reason: The finish_reason of this CohereChatResponse.
@@ -209,11 +261,35 @@ class CohereChatResponse(BaseChatResponse):
             finish_reason = 'UNKNOWN_ENUM_VALUE'
         self._finish_reason = finish_reason
 
+    @property
+    def error_message(self):
+        """
+        Gets the error_message of this CohereChatResponse.
+        If there is an error during the streaming scenario, then the `errorMessage` parameter contains details for the error.
+
+
+        :return: The error_message of this CohereChatResponse.
+        :rtype: str
+        """
+        return self._error_message
+
+    @error_message.setter
+    def error_message(self, error_message):
+        """
+        Sets the error_message of this CohereChatResponse.
+        If there is an error during the streaming scenario, then the `errorMessage` parameter contains details for the error.
+
+
+        :param error_message: The error_message of this CohereChatResponse.
+        :type: str
+        """
+        self._error_message = error_message
+
     @property
     def search_queries(self):
         """
         Gets the search_queries of this CohereChatResponse.
-        Generated search queries.
+        The generated search queries.
 
 
         :return: The search_queries of this CohereChatResponse.
@@ -225,7 +301,7 @@ class CohereChatResponse(BaseChatResponse):
     def search_queries(self, search_queries):
         """
         Sets the search_queries of this CohereChatResponse.
-        Generated search queries.
+        The generated search queries.
 
 
         :param search_queries: The search_queries of this CohereChatResponse.
@@ -237,8 +313,21 @@ class CohereChatResponse(BaseChatResponse):
     def documents(self):
         """
         Gets the documents of this CohereChatResponse.
-        Documents seen by the model when generating the reply. Each document is a JSON String
-        representing the field and values of the document.
+        The documents that the model can refer to when generating a response. Each document is a JSON string that represents the field and values of the document.
+
+        Example:
+        '[
+          {
+            \"id\": \"doc_0\",
+            \"snippet\": \"Emperor penguins are the tallest.\",
+            \"title\": \"Tall penguins\"
+          },
+          {
+            \"id\": \"doc_1\",
+            \"snippet\": \"Emperor penguins only live in Antarctica.\",
+            \"title\": \"Penguin habitats\"
+          }
+        ]'
 
 
         :return: The documents of this CohereChatResponse.
@@ -250,8 +339,21 @@ class CohereChatResponse(BaseChatResponse):
     def documents(self, documents):
         """
         Sets the documents of this CohereChatResponse.
-        Documents seen by the model when generating the reply. Each document is a JSON String
-        representing the field and values of the document.
+        The documents that the model can refer to when generating a response. Each document is a JSON string that represents the field and values of the document.
+
+        Example:
+        '[
+          {
+            \"id\": \"doc_0\",
+            \"snippet\": \"Emperor penguins are the tallest.\",
+            \"title\": \"Tall penguins\"
+          },
+          {
+            \"id\": \"doc_1\",
+            \"snippet\": \"Emperor penguins only live in Antarctica.\",
+            \"title\": \"Penguin habitats\"
+          }
+        ]'
 
 
         :param documents: The documents of this CohereChatResponse.
@@ -259,6 +361,54 @@ class CohereChatResponse(BaseChatResponse):
         """
         self._documents = documents
 
+    @property
+    def tool_calls(self):
+        """
+        Gets the tool_calls of this CohereChatResponse.
+        A list of tool calls generated by the model.
+
+
+        :return: The tool_calls of this CohereChatResponse.
+        :rtype: list[oci.generative_ai_inference.models.CohereToolCall]
+        """
+        return self._tool_calls
+
+    @tool_calls.setter
+    def tool_calls(self, tool_calls):
+        """
+        Sets the tool_calls of this CohereChatResponse.
+        A list of tool calls generated by the model.
+
+
+        :param tool_calls: The tool_calls of this CohereChatResponse.
+        :type: list[oci.generative_ai_inference.models.CohereToolCall]
+        """
+        self._tool_calls = tool_calls
+
+    @property
+    def prompt(self):
+        """
+        Gets the prompt of this CohereChatResponse.
+        The full prompt that was sent to the model if isEcho is true when request.
+
+
+        :return: The prompt of this CohereChatResponse.
+        :rtype: str
+        """
+        return self._prompt
+
+    @prompt.setter
+    def prompt(self, prompt):
+        """
+        Sets the prompt of this CohereChatResponse.
+        The full prompt that was sent to the model if isEcho is true when request.
+
+
+        :param prompt: The prompt of this CohereChatResponse.
+        :type: str
+        """
+        self._prompt = prompt
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_inference/models/cohere_llm_inference_response.py

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

oci/generative_ai_inference/models/cohere_message.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class CohereMessage(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 CohereMessage.
@@ -23,41 +23,73 @@ class CohereMessage(object):
     #: This constant has a value of "USER"
     ROLE_USER = "USER"
 
+    #: A constant which can be used with the role property of a CohereMessage.
+    #: This constant has a value of "SYSTEM"
+    ROLE_SYSTEM = "SYSTEM"
+
+    #: A constant which can be used with the role property of a CohereMessage.
+    #: This constant has a value of "TOOL"
+    ROLE_TOOL = "TOOL"
+
     def __init__(self, **kwargs):
         """
-        Initializes a new CohereMessage object with values from keyword arguments.
+        Initializes a new CohereMessage 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.CohereChatBotMessage`
+        * :class:`~oci.generative_ai_inference.models.CohereSystemMessage`
+        * :class:`~oci.generative_ai_inference.models.CohereToolMessage`
+        * :class:`~oci.generative_ai_inference.models.CohereUserMessage`
+
         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 CohereMessage.
-            Allowed values for this property are: "CHATBOT", "USER"
+            Allowed values for this property are: "CHATBOT", "USER", "SYSTEM", "TOOL", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type role: str
 
-        :param message:
-            The value to assign to the message property of this CohereMessage.
-        :type message: str
-
         """
         self.swagger_types = {
-            'role': 'str',
-            'message': 'str'
+            'role': 'str'
         }
 
         self.attribute_map = {
-            'role': 'role',
-            'message': 'message'
+            'role': 'role'
         }
 
         self._role = None
-        self._message = 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 == 'CHATBOT':
+            return 'CohereChatBotMessage'
+
+        if type == 'SYSTEM':
+            return 'CohereSystemMessage'
+
+        if type == 'TOOL':
+            return 'CohereToolMessage'
+
+        if type == 'USER':
+            return 'CohereUserMessage'
+        else:
+            return 'CohereMessage'
 
     @property
     def role(self):
         """
         **[Required]** Gets the role of this CohereMessage.
-        One of CHATBOT|USER to identify who the message is coming from.
+        To identify who the message is coming from, a role is associated to each message.
 
-        Allowed values for this property are: "CHATBOT", "USER"
+        Allowed values for this property are: "CHATBOT", "USER", "SYSTEM", "TOOL", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
 
 
         :return: The role of this CohereMessage.
@@ -69,43 +101,17 @@ class CohereMessage(object):
     def role(self, role):
         """
         Sets the role of this CohereMessage.
-        One of CHATBOT|USER to identify who the message is coming from.
+        To identify who the message is coming from, a role is associated to each message.
 
 
         :param role: The role of this CohereMessage.
         :type: str
         """
-        allowed_values = ["CHATBOT", "USER"]
+        allowed_values = ["CHATBOT", "USER", "SYSTEM", "TOOL"]
         if not value_allowed_none_or_none_sentinel(role, allowed_values):
-            raise ValueError(
-                f"Invalid value for `role`, must be None or one of {allowed_values}"
-            )
+            role = 'UNKNOWN_ENUM_VALUE'
         self._role = role
 
-    @property
-    def message(self):
-        """
-        **[Required]** Gets the message of this CohereMessage.
-        Contents of the chat message.
-
-
-        :return: The message of this CohereMessage.
-        :rtype: str
-        """
-        return self._message
-
-    @message.setter
-    def message(self, message):
-        """
-        Sets the message of this CohereMessage.
-        Contents of the chat message.
-
-
-        :param message: The message of this CohereMessage.
-        :type: str
-        """
-        self._message = message
-
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_inference/models/cohere_parameter_definition.py

@@ -0,0 +1,134 @@
+# 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 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 CohereParameterDefinition(object):
+    """
+    A definition of tool parameter.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereParameterDefinition object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param description:
+            The value to assign to the description property of this CohereParameterDefinition.
+        :type description: str
+
+        :param type:
+            The value to assign to the type property of this CohereParameterDefinition.
+        :type type: str
+
+        :param is_required:
+            The value to assign to the is_required property of this CohereParameterDefinition.
+        :type is_required: bool
+
+        """
+        self.swagger_types = {
+            'description': 'str',
+            'type': 'str',
+            'is_required': 'bool'
+        }
+
+        self.attribute_map = {
+            'description': 'description',
+            'type': 'type',
+            'is_required': 'isRequired'
+        }
+
+        self._description = None
+        self._type = None
+        self._is_required = None
+
+    @property
+    def description(self):
+        """
+        Gets the description of this CohereParameterDefinition.
+        The description of the parameter.
+
+
+        :return: The description of this CohereParameterDefinition.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this CohereParameterDefinition.
+        The description of the parameter.
+
+
+        :param description: The description of this CohereParameterDefinition.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this CohereParameterDefinition.
+        The type of the parameter. Must be a valid Python type.
+
+
+        :return: The type of this CohereParameterDefinition.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this CohereParameterDefinition.
+        The type of the parameter. Must be a valid Python type.
+
+
+        :param type: The type of this CohereParameterDefinition.
+        :type: str
+        """
+        self._type = type
+
+    @property
+    def is_required(self):
+        """
+        Gets the is_required of this CohereParameterDefinition.
+        Denotes whether the parameter is always present (required) or not. Defaults to not required.
+
+
+        :return: The is_required of this CohereParameterDefinition.
+        :rtype: bool
+        """
+        return self._is_required
+
+    @is_required.setter
+    def is_required(self, is_required):
+        """
+        Sets the is_required of this CohereParameterDefinition.
+        Denotes whether the parameter is always present (required) or not. Defaults to not required.
+
+
+        :param is_required: The is_required of this CohereParameterDefinition.
+        :type: bool
+        """
+        self._is_required = is_required
+
+    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/cohere_system_message.py

@@ -0,0 +1,82 @@
+# 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 .cohere_message import CohereMessage
+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 CohereSystemMessage(CohereMessage):
+    """
+    A message that represents a single chat dialog as SYSTEM role.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereSystemMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereSystemMessage.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 CohereSystemMessage.
+            Allowed values for this property are: "CHATBOT", "USER", "SYSTEM", "TOOL"
+        :type role: str
+
+        :param message:
+            The value to assign to the message property of this CohereSystemMessage.
+        :type message: str
+
+        """
+        self.swagger_types = {
+            'role': 'str',
+            'message': 'str'
+        }
+
+        self.attribute_map = {
+            'role': 'role',
+            'message': 'message'
+        }
+
+        self._role = None
+        self._message = None
+        self._role = 'SYSTEM'
+
+    @property
+    def message(self):
+        """
+        **[Required]** Gets the message of this CohereSystemMessage.
+        Contents of the chat message.
+
+
+        :return: The message of this CohereSystemMessage.
+        :rtype: str
+        """
+        return self._message
+
+    @message.setter
+    def message(self, message):
+        """
+        Sets the message of this CohereSystemMessage.
+        Contents of the chat message.
+
+
+        :param message: The message of this CohereSystemMessage.
+        :type: str
+        """
+        self._message = message
+
+    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