oci 2.125.2__py3-none-any.whl → 2.126.0__py3-none-any.whl

oci/generative_ai_inference/models/cohere_chat_response.py

@@ -0,0 +1,272 @@
+# 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 .base_chat_response import BaseChatResponse
+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 CohereChatResponse(BaseChatResponse):
+    """
+    The response to the chat conversation.
+    """
+
+    #: A constant which can be used with the finish_reason property of a CohereChatResponse.
+    #: This constant has a value of "COMPLETE"
+    FINISH_REASON_COMPLETE = "COMPLETE"
+
+    #: A constant which can be used with the finish_reason property of a CohereChatResponse.
+    #: This constant has a value of "ERROR_TOXIC"
+    FINISH_REASON_ERROR_TOXIC = "ERROR_TOXIC"
+
+    #: A constant which can be used with the finish_reason property of a CohereChatResponse.
+    #: This constant has a value of "ERROR_LIMIT"
+    FINISH_REASON_ERROR_LIMIT = "ERROR_LIMIT"
+
+    #: A constant which can be used with the finish_reason property of a CohereChatResponse.
+    #: This constant has a value of "ERROR"
+    FINISH_REASON_ERROR = "ERROR"
+
+    #: A constant which can be used with the finish_reason property of a CohereChatResponse.
+    #: This constant has a value of "USER_CANCEL"
+    FINISH_REASON_USER_CANCEL = "USER_CANCEL"
+
+    #: A constant which can be used with the finish_reason property of a CohereChatResponse.
+    #: This constant has a value of "MAX_TOKENS"
+    FINISH_REASON_MAX_TOKENS = "MAX_TOKENS"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereChatResponse object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereChatResponse.api_format` attribute
+        of this class is ``COHERE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param api_format:
+            The value to assign to the api_format property of this CohereChatResponse.
+            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'.
+        :type api_format: str
+
+        :param text:
+            The value to assign to the text property of this CohereChatResponse.
+        :type text: str
+
+        :param citations:
+            The value to assign to the citations property of this CohereChatResponse.
+        :type citations: list[oci.generative_ai_inference.models.Citation]
+
+        :param is_search_required:
+            The value to assign to the is_search_required property of this CohereChatResponse.
+        :type is_search_required: bool
+
+        :param finish_reason:
+            The value to assign to the finish_reason property of this CohereChatResponse.
+            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'.
+        :type finish_reason: 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]
+
+        :param documents:
+            The value to assign to the documents property of this CohereChatResponse.
+        :type documents: list[object]
+
+        """
+        self.swagger_types = {
+            'api_format': 'str',
+            'text': 'str',
+            'citations': 'list[Citation]',
+            'is_search_required': 'bool',
+            'finish_reason': 'str',
+            'search_queries': 'list[SearchQuery]',
+            'documents': 'list[object]'
+        }
+
+        self.attribute_map = {
+            'api_format': 'apiFormat',
+            'text': 'text',
+            'citations': 'citations',
+            'is_search_required': 'isSearchRequired',
+            'finish_reason': 'finishReason',
+            'search_queries': 'searchQueries',
+            'documents': 'documents'
+        }
+
+        self._api_format = None
+        self._text = None
+        self._citations = None
+        self._is_search_required = None
+        self._finish_reason = None
+        self._search_queries = None
+        self._documents = None
+        self._api_format = 'COHERE'
+
+    @property
+    def text(self):
+        """
+        **[Required]** Gets the text of this CohereChatResponse.
+        Contents of the reply generated by the model.
+
+
+        :return: The text of this CohereChatResponse.
+        :rtype: str
+        """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        """
+        Sets the text of this CohereChatResponse.
+        Contents of the reply generated by the model.
+
+
+        :param text: The text of this CohereChatResponse.
+        :type: str
+        """
+        self._text = text
+
+    @property
+    def citations(self):
+        """
+        Gets the citations of this CohereChatResponse.
+        Inline citations for the generated reply.
+
+
+        :return: The citations of this CohereChatResponse.
+        :rtype: list[oci.generative_ai_inference.models.Citation]
+        """
+        return self._citations
+
+    @citations.setter
+    def citations(self, citations):
+        """
+        Sets the citations of this CohereChatResponse.
+        Inline citations for the generated reply.
+
+
+        :param citations: The citations of this CohereChatResponse.
+        :type: list[oci.generative_ai_inference.models.Citation]
+        """
+        self._citations = citations
+
+    @property
+    def is_search_required(self):
+        """
+        Gets the is_search_required of this CohereChatResponse.
+        Denotes that a search for documents is required.
+
+
+        :return: The is_search_required of this CohereChatResponse.
+        :rtype: bool
+        """
+        return self._is_search_required
+
+    @is_search_required.setter
+    def is_search_required(self, is_search_required):
+        """
+        Sets the is_search_required of this CohereChatResponse.
+        Denotes that a search for documents is required.
+
+
+        :param is_search_required: The is_search_required of this CohereChatResponse.
+        :type: bool
+        """
+        self._is_search_required = is_search_required
+
+    @property
+    def finish_reason(self):
+        """
+        **[Required]** Gets the finish_reason of this CohereChatResponse.
+        Why the generation was completed.
+
+        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'.
+
+
+        :return: The finish_reason of this CohereChatResponse.
+        :rtype: str
+        """
+        return self._finish_reason
+
+    @finish_reason.setter
+    def finish_reason(self, finish_reason):
+        """
+        Sets the finish_reason of this CohereChatResponse.
+        Why the generation was completed.
+
+
+        :param finish_reason: The finish_reason of this CohereChatResponse.
+        :type: str
+        """
+        allowed_values = ["COMPLETE", "ERROR_TOXIC", "ERROR_LIMIT", "ERROR", "USER_CANCEL", "MAX_TOKENS"]
+        if not value_allowed_none_or_none_sentinel(finish_reason, allowed_values):
+            finish_reason = 'UNKNOWN_ENUM_VALUE'
+        self._finish_reason = finish_reason
+
+    @property
+    def search_queries(self):
+        """
+        Gets the search_queries of this CohereChatResponse.
+        Generated search queries.
+
+
+        :return: The search_queries of this CohereChatResponse.
+        :rtype: list[oci.generative_ai_inference.models.SearchQuery]
+        """
+        return self._search_queries
+
+    @search_queries.setter
+    def search_queries(self, search_queries):
+        """
+        Sets the search_queries of this CohereChatResponse.
+        Generated search queries.
+
+
+        :param search_queries: The search_queries of this CohereChatResponse.
+        :type: list[oci.generative_ai_inference.models.SearchQuery]
+        """
+        self._search_queries = search_queries
+
+    @property
+    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.
+
+
+        :return: The documents of this CohereChatResponse.
+        :rtype: list[object]
+        """
+        return self._documents
+
+    @documents.setter
+    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.
+
+
+        :param documents: The documents of this CohereChatResponse.
+        :type: list[object]
+        """
+        self._documents = documents
+
+    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_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"
+            Allowed values for this property are: "COHERE", "LLAMA", "OPENAI", "DALLE3"
         :type runtime_type: str
 
         :param generated_texts:

oci/generative_ai_inference/models/cohere_message.py

@@ -0,0 +1,119 @@
+# 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 CohereMessage(object):
+    """
+    An message that represents a single dialogue of chat
+    """
+
+    #: A constant which can be used with the role property of a CohereMessage.
+    #: This constant has a value of "CHATBOT"
+    ROLE_CHATBOT = "CHATBOT"
+
+    #: A constant which can be used with the role property of a CohereMessage.
+    #: This constant has a value of "USER"
+    ROLE_USER = "USER"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereMessage object with values from keyword arguments.
+        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"
+        :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'
+        }
+
+        self.attribute_map = {
+            'role': 'role',
+            'message': 'message'
+        }
+
+        self._role = None
+        self._message = None
+
+    @property
+    def role(self):
+        """
+        **[Required]** Gets the role of this CohereMessage.
+        One of CHATBOT|USER to identify who the message is coming from.
+
+        Allowed values for this property are: "CHATBOT", "USER"
+
+
+        :return: The role of this CohereMessage.
+        :rtype: str
+        """
+        return self._role
+
+    @role.setter
+    def role(self, role):
+        """
+        Sets the role of this CohereMessage.
+        One of CHATBOT|USER to identify who the message is coming from.
+
+
+        :param role: The role of this CohereMessage.
+        :type: str
+        """
+        allowed_values = ["CHATBOT", "USER"]
+        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}"
+            )
+        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)
+
+    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_details.py

@@ -104,7 +104,7 @@ class EmbedTextDetails(object):
     def inputs(self):
         """
         **[Required]** Gets the inputs of this EmbedTextDetails.
-        The list of strings for embeddings.
+        Provide a list of strings with a maximum number of 96 entries. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.
 
 
         :return: The inputs of this EmbedTextDetails.
@@ -116,7 +116,7 @@ class EmbedTextDetails(object):
     def inputs(self, inputs):
         """
         Sets the inputs of this EmbedTextDetails.
-        The list of strings for embeddings.
+        Provide a list of strings with a maximum number of 96 entries. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.
 
 
         :param inputs: The inputs of this EmbedTextDetails.