oci 2.127.0__py3-none-any.whl → 2.128.1__py3-none-any.whl

oci/generative_ai_inference/models/__init__.py

@@ -6,6 +6,7 @@
 
 from __future__ import absolute_import
 
+from .assistant_message import AssistantMessage
 from .base_chat_request import BaseChatRequest
 from .base_chat_response import BaseChatResponse
 from .chat_choice import ChatChoice
@@ -14,11 +15,19 @@ from .chat_details import ChatDetails
 from .chat_result import ChatResult
 from .choice import Choice
 from .citation import Citation
+from .cohere_chat_bot_message import CohereChatBotMessage
 from .cohere_chat_request import CohereChatRequest
 from .cohere_chat_response import CohereChatResponse
 from .cohere_llm_inference_request import CohereLlmInferenceRequest
 from .cohere_llm_inference_response import CohereLlmInferenceResponse
 from .cohere_message import CohereMessage
+from .cohere_parameter_definition import CohereParameterDefinition
+from .cohere_system_message import CohereSystemMessage
+from .cohere_tool import CohereTool
+from .cohere_tool_call import CohereToolCall
+from .cohere_tool_message import CohereToolMessage
+from .cohere_tool_result import CohereToolResult
+from .cohere_user_message import CohereUserMessage
 from .dedicated_serving_mode import DedicatedServingMode
 from .embed_text_details import EmbedTextDetails
 from .embed_text_result import EmbedTextResult
@@ -38,11 +47,14 @@ from .search_query import SearchQuery
 from .serving_mode import ServingMode
 from .summarize_text_details import SummarizeTextDetails
 from .summarize_text_result import SummarizeTextResult
+from .system_message import SystemMessage
 from .text_content import TextContent
 from .token_likelihood import TokenLikelihood
+from .user_message import UserMessage
 
 # Maps type names to classes for generative_ai_inference services.
 generative_ai_inference_type_mapping = {
+    "AssistantMessage": AssistantMessage,
     "BaseChatRequest": BaseChatRequest,
     "BaseChatResponse": BaseChatResponse,
     "ChatChoice": ChatChoice,
@@ -51,11 +63,19 @@ generative_ai_inference_type_mapping = {
     "ChatResult": ChatResult,
     "Choice": Choice,
     "Citation": Citation,
+    "CohereChatBotMessage": CohereChatBotMessage,
     "CohereChatRequest": CohereChatRequest,
     "CohereChatResponse": CohereChatResponse,
     "CohereLlmInferenceRequest": CohereLlmInferenceRequest,
     "CohereLlmInferenceResponse": CohereLlmInferenceResponse,
     "CohereMessage": CohereMessage,
+    "CohereParameterDefinition": CohereParameterDefinition,
+    "CohereSystemMessage": CohereSystemMessage,
+    "CohereTool": CohereTool,
+    "CohereToolCall": CohereToolCall,
+    "CohereToolMessage": CohereToolMessage,
+    "CohereToolResult": CohereToolResult,
+    "CohereUserMessage": CohereUserMessage,
     "DedicatedServingMode": DedicatedServingMode,
     "EmbedTextDetails": EmbedTextDetails,
     "EmbedTextResult": EmbedTextResult,
@@ -75,6 +95,8 @@ generative_ai_inference_type_mapping = {
     "ServingMode": ServingMode,
     "SummarizeTextDetails": SummarizeTextDetails,
     "SummarizeTextResult": SummarizeTextResult,
+    "SystemMessage": SystemMessage,
     "TextContent": TextContent,
-    "TokenLikelihood": TokenLikelihood
+    "TokenLikelihood": TokenLikelihood,
+    "UserMessage": UserMessage
 }

oci/generative_ai_inference/models/assistant_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 AssistantMessage(Message):
+    """
+    Represents a single instance of assistant message.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new AssistantMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.AssistantMessage.role` attribute
+        of this class is ``ASSISTANT`` 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 AssistantMessage.
+            Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT"
+        :type role: str
+
+        :param content:
+            The value to assign to the content property of this AssistantMessage.
+        :type content: list[oci.generative_ai_inference.models.ChatContent]
+
+        :param name:
+            The value to assign to the name property of this AssistantMessage.
+        :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 = 'ASSISTANT'
+
+    @property
+    def name(self):
+        """
+        Gets the name of this AssistantMessage.
+        An optional name for the participant. Provides the model information to differentiate between participants of the same role.
+
+
+        :return: The name of this AssistantMessage.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this AssistantMessage.
+        An optional name for the participant. Provides the model information to differentiate between participants of the same role.
+
+
+        :param name: The name of this AssistantMessage.
+        :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/base_chat_request.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class BaseChatRequest(object):
     """
-    Base class for chat inference requests
+    The base class to use for the chat inference request.
     """
 
     #: A constant which can be used with the api_format property of a BaseChatRequest.
@@ -69,7 +69,7 @@ class BaseChatRequest(object):
     def api_format(self):
         """
         **[Required]** Gets the api_format of this BaseChatRequest.
-        The api format for the model's request
+        The API format for the model's request.
 
         Allowed values for this property are: "COHERE", "GENERIC"
 
@@ -83,7 +83,7 @@ class BaseChatRequest(object):
     def api_format(self, api_format):
         """
         Sets the api_format of this BaseChatRequest.
-        The api format for the model's request
+        The API format for the model's request.
 
 
         :param api_format: The api_format of this BaseChatRequest.

oci/generative_ai_inference/models/base_chat_response.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class BaseChatResponse(object):
     """
-    Base class for chat inference response
+    The base class that creates the chat response.
     """
 
     #: A constant which can be used with the api_format property of a BaseChatResponse.
@@ -70,7 +70,7 @@ class BaseChatResponse(object):
     def api_format(self):
         """
         **[Required]** Gets the api_format of this BaseChatResponse.
-        The api format for the model's response
+        The API format for the model's response.
 
         Allowed values for this property are: "COHERE", "GENERIC", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -85,7 +85,7 @@ class BaseChatResponse(object):
     def api_format(self, api_format):
         """
         Sets the api_format of this BaseChatResponse.
-        The api format for the model's response
+        The API format for the model's response.
 
 
         :param api_format: The api_format of this BaseChatResponse.

oci/generative_ai_inference/models/chat_details.py

@@ -53,7 +53,7 @@ class ChatDetails(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this ChatDetails.
-        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 chat.
 
 
         :return: The compartment_id of this ChatDetails.
@@ -65,7 +65,7 @@ class ChatDetails(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this ChatDetails.
-        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 chat.
 
 
         :param compartment_id: The compartment_id of this ChatDetails.
@@ -96,7 +96,7 @@ class ChatDetails(object):
     @property
     def chat_request(self):
         """
-        Gets the chat_request of this ChatDetails.
+        **[Required]** Gets the chat_request of this ChatDetails.
 
         :return: The chat_request of this ChatDetails.
         :rtype: oci.generative_ai_inference.models.BaseChatRequest

oci/generative_ai_inference/models/chat_result.py

@@ -53,7 +53,7 @@ class ChatResult(object):
     def model_id(self):
         """
         **[Required]** Gets the model_id of this ChatResult.
-        The OCID of the model used in this inference request.
+        The OCID of the model that's used in this inference request.
 
 
         :return: The model_id of this ChatResult.
@@ -65,7 +65,7 @@ class ChatResult(object):
     def model_id(self, model_id):
         """
         Sets the model_id of this ChatResult.
-        The OCID of the model used in this inference request.
+        The OCID of the model that's used in this inference request.
 
 
         :param model_id: The model_id of this ChatResult.

oci/generative_ai_inference/models/choice.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class Choice(object):
     """
-    Represents a single instance of generated text.
+    Represents a single instance of the generated text.
     """
 
     def __init__(self, **kwargs):

oci/generative_ai_inference/models/citation.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class Citation(object):
     """
-    A section of the generated reply which cites external knowledge.
+    A section of the generated response which cites the documents that were used for generating the response.
     """
 
     def __init__(self, **kwargs):
@@ -60,7 +60,7 @@ class Citation(object):
     def start(self):
         """
         **[Required]** Gets the start of this Citation.
-        The index of text that the citation starts at, counting from zero.
+        Counting from zero, the index of the text where the citation starts.
 
 
         :return: The start of this Citation.
@@ -72,7 +72,7 @@ class Citation(object):
     def start(self, start):
         """
         Sets the start of this Citation.
-        The index of text that the citation starts at, counting from zero.
+        Counting from zero, the index of the text where the citation starts.
 
 
         :param start: The start of this Citation.
@@ -84,7 +84,7 @@ class Citation(object):
     def end(self):
         """
         **[Required]** Gets the end of this Citation.
-        The index of text that the citation ends after, counting from zero.
+        Counting from zero, the index of the text that the citation ends after.
 
 
         :return: The end of this Citation.
@@ -96,7 +96,7 @@ class Citation(object):
     def end(self, end):
         """
         Sets the end of this Citation.
-        The index of text that the citation ends after, counting from zero.
+        Counting from zero, the index of the text that the citation ends after.
 
 
         :param end: The end of this Citation.
@@ -108,7 +108,7 @@ class Citation(object):
     def text(self):
         """
         **[Required]** Gets the text of this Citation.
-        The text of the citation
+        The text of the citation.
 
 
         :return: The text of this Citation.
@@ -120,7 +120,7 @@ class Citation(object):
     def text(self, text):
         """
         Sets the text of this Citation.
-        The text of the citation
+        The text of the citation.
 
 
         :param text: The text of this Citation.
@@ -132,7 +132,7 @@ class Citation(object):
     def document_ids(self):
         """
         **[Required]** Gets the document_ids of this Citation.
-        Identifiers of documents cited by this section of the generated reply.
+        Identifiers for the documents cited in the current generated response.
 
 
         :return: The document_ids of this Citation.
@@ -144,7 +144,7 @@ class Citation(object):
     def document_ids(self, document_ids):
         """
         Sets the document_ids of this Citation.
-        Identifiers of documents cited by this section of the generated reply.
+        Identifiers for the documents cited in the current generated response.
 
 
         :param document_ids: The document_ids of this Citation.

oci/generative_ai_inference/models/cohere_chat_bot_message.py

@@ -0,0 +1,113 @@
+# 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 CohereChatBotMessage(CohereMessage):
+    """
+    A message that represents a single chat dialog as CHATBOT role.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereChatBotMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereChatBotMessage.role` attribute
+        of this class is ``CHATBOT`` 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 CohereChatBotMessage.
+            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 CohereChatBotMessage.
+        :type message: str
+
+        :param tool_calls:
+            The value to assign to the tool_calls property of this CohereChatBotMessage.
+        :type tool_calls: list[oci.generative_ai_inference.models.CohereToolCall]
+
+        """
+        self.swagger_types = {
+            'role': 'str',
+            'message': 'str',
+            'tool_calls': 'list[CohereToolCall]'
+        }
+
+        self.attribute_map = {
+            'role': 'role',
+            'message': 'message',
+            'tool_calls': 'toolCalls'
+        }
+
+        self._role = None
+        self._message = None
+        self._tool_calls = None
+        self._role = 'CHATBOT'
+
+    @property
+    def message(self):
+        """
+        Gets the message of this CohereChatBotMessage.
+        Contents of the chat message.
+
+
+        :return: The message of this CohereChatBotMessage.
+        :rtype: str
+        """
+        return self._message
+
+    @message.setter
+    def message(self, message):
+        """
+        Sets the message of this CohereChatBotMessage.
+        Contents of the chat message.
+
+
+        :param message: The message of this CohereChatBotMessage.
+        :type: str
+        """
+        self._message = message
+
+    @property
+    def tool_calls(self):
+        """
+        Gets the tool_calls of this CohereChatBotMessage.
+        A list of tool calls generated by the model.
+
+
+        :return: The tool_calls of this CohereChatBotMessage.
+        :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 CohereChatBotMessage.
+        A list of tool calls generated by the model.
+
+
+        :param tool_calls: The tool_calls of this CohereChatBotMessage.
+        :type: list[oci.generative_ai_inference.models.CohereToolCall]
+        """
+        self._tool_calls = tool_calls
+
+    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