oci 2.138.0__py3-none-any.whl → 2.139.0__py3-none-any.whl

oci/generative_ai_inference/models/cohere_chat_request.py

@@ -54,6 +54,10 @@ class CohereChatRequest(BaseChatRequest):
             The value to assign to the documents property of this CohereChatRequest.
         :type documents: list[object]
 
+        :param response_format:
+            The value to assign to the response_format property of this CohereChatRequest.
+        :type response_format: oci.generative_ai_inference.models.CohereResponseFormat
+
         :param is_search_queries_only:
             The value to assign to the is_search_queries_only property of this CohereChatRequest.
         :type is_search_queries_only: bool
@@ -70,6 +74,10 @@ class CohereChatRequest(BaseChatRequest):
             The value to assign to the max_tokens property of this CohereChatRequest.
         :type max_tokens: int
 
+        :param max_input_tokens:
+            The value to assign to the max_input_tokens property of this CohereChatRequest.
+        :type max_input_tokens: int
+
         :param temperature:
             The value to assign to the temperature property of this CohereChatRequest.
         :type temperature: float
@@ -134,10 +142,12 @@ class CohereChatRequest(BaseChatRequest):
             'message': 'str',
             'chat_history': 'list[CohereMessage]',
             'documents': 'list[object]',
+            'response_format': 'CohereResponseFormat',
             'is_search_queries_only': 'bool',
             'preamble_override': 'str',
             'is_stream': 'bool',
             'max_tokens': 'int',
+            'max_input_tokens': 'int',
             'temperature': 'float',
             'top_k': 'int',
             'top_p': 'float',
@@ -159,10 +169,12 @@ class CohereChatRequest(BaseChatRequest):
             'message': 'message',
             'chat_history': 'chatHistory',
             'documents': 'documents',
+            'response_format': 'responseFormat',
             'is_search_queries_only': 'isSearchQueriesOnly',
             'preamble_override': 'preambleOverride',
             'is_stream': 'isStream',
             'max_tokens': 'maxTokens',
+            'max_input_tokens': 'maxInputTokens',
             'temperature': 'temperature',
             'top_k': 'topK',
             'top_p': 'topP',
@@ -183,10 +195,12 @@ class CohereChatRequest(BaseChatRequest):
         self._message = None
         self._chat_history = None
         self._documents = None
+        self._response_format = None
         self._is_search_queries_only = None
         self._preamble_override = None
         self._is_stream = None
         self._max_tokens = None
+        self._max_input_tokens = None
         self._temperature = None
         self._top_k = None
         self._top_p = None
@@ -289,6 +303,26 @@ class CohereChatRequest(BaseChatRequest):
         """
         self._documents = documents
 
+    @property
+    def response_format(self):
+        """
+        Gets the response_format of this CohereChatRequest.
+
+        :return: The response_format of this CohereChatRequest.
+        :rtype: oci.generative_ai_inference.models.CohereResponseFormat
+        """
+        return self._response_format
+
+    @response_format.setter
+    def response_format(self, response_format):
+        """
+        Sets the response_format of this CohereChatRequest.
+
+        :param response_format: The response_format of this CohereChatRequest.
+        :type: oci.generative_ai_inference.models.CohereResponseFormat
+        """
+        self._response_format = response_format
+
     @property
     def is_search_queries_only(self):
         """
@@ -389,6 +423,30 @@ class CohereChatRequest(BaseChatRequest):
         """
         self._max_tokens = max_tokens
 
+    @property
+    def max_input_tokens(self):
+        """
+        Gets the max_input_tokens of this CohereChatRequest.
+        The maximum number of input tokens to send to the model. If not specified, max_input_tokens is the model's context length limit minus a small buffer.
+
+
+        :return: The max_input_tokens of this CohereChatRequest.
+        :rtype: int
+        """
+        return self._max_input_tokens
+
+    @max_input_tokens.setter
+    def max_input_tokens(self, max_input_tokens):
+        """
+        Sets the max_input_tokens of this CohereChatRequest.
+        The maximum number of input tokens to send to the model. If not specified, max_input_tokens is the model's context length limit minus a small buffer.
+
+
+        :param max_input_tokens: The max_input_tokens of this CohereChatRequest.
+        :type: int
+        """
+        self._max_input_tokens = max_input_tokens
+
     @property
     def temperature(self):
         """
@@ -475,7 +533,7 @@ class CohereChatRequest(BaseChatRequest):
     def prompt_truncation(self):
         """
         Gets the prompt_truncation of this CohereChatRequest.
-        Defaults to OFF. Dictates how the prompt will be constructed. With `prompt_truncation` set to AUTO_PRESERVE_ORDER, some elements from `chat_history` and `documents` will be dropped to construct a prompt that fits within the model's context length limit. During this process the order of the documents and chat history will be preserved. With `prompt_truncation` set to OFF, no elements will be dropped.
+        Defaults to OFF. Dictates how the prompt will be constructed. With `promptTruncation` set to AUTO_PRESERVE_ORDER, some elements from `chatHistory` and `documents` will be dropped to construct a prompt that fits within the model's context length limit. During this process the order of the documents and chat history will be preserved. With `prompt_truncation` set to OFF, no elements will be dropped.
 
         Allowed values for this property are: "OFF", "AUTO_PRESERVE_ORDER"
 
@@ -489,7 +547,7 @@ class CohereChatRequest(BaseChatRequest):
     def prompt_truncation(self, prompt_truncation):
         """
         Sets the prompt_truncation of this CohereChatRequest.
-        Defaults to OFF. Dictates how the prompt will be constructed. With `prompt_truncation` set to AUTO_PRESERVE_ORDER, some elements from `chat_history` and `documents` will be dropped to construct a prompt that fits within the model's context length limit. During this process the order of the documents and chat history will be preserved. With `prompt_truncation` set to OFF, no elements will be dropped.
+        Defaults to OFF. Dictates how the prompt will be constructed. With `promptTruncation` set to AUTO_PRESERVE_ORDER, some elements from `chatHistory` and `documents` will be dropped to construct a prompt that fits within the model's context length limit. During this process the order of the documents and chat history will be preserved. With `prompt_truncation` set to OFF, no elements will be dropped.
 
 
         :param prompt_truncation: The prompt_truncation of this CohereChatRequest.

oci/generative_ai_inference/models/cohere_response_format.py

@@ -0,0 +1,109 @@
+# 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 CohereResponseFormat(object):
+    """
+    Specify the format the model output is guaranteed to be of
+    """
+
+    #: A constant which can be used with the type property of a CohereResponseFormat.
+    #: This constant has a value of "JSON_OBJECT"
+    TYPE_JSON_OBJECT = "JSON_OBJECT"
+
+    #: A constant which can be used with the type property of a CohereResponseFormat.
+    #: This constant has a value of "TEXT"
+    TYPE_TEXT = "TEXT"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereResponseFormat 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.CohereResponseTextFormat`
+        * :class:`~oci.generative_ai_inference.models.CohereResponseJsonFormat`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this CohereResponseFormat.
+            Allowed values for this property are: "JSON_OBJECT", "TEXT"
+        :type type: str
+
+        """
+        self.swagger_types = {
+            'type': 'str'
+        }
+
+        self.attribute_map = {
+            'type': 'type'
+        }
+
+        self._type = 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['type']
+
+        if type == 'TEXT':
+            return 'CohereResponseTextFormat'
+
+        if type == 'JSON_OBJECT':
+            return 'CohereResponseJsonFormat'
+        else:
+            return 'CohereResponseFormat'
+
+    @property
+    def type(self):
+        """
+        Gets the type of this CohereResponseFormat.
+        The format type
+
+        Allowed values for this property are: "JSON_OBJECT", "TEXT"
+
+
+        :return: The type of this CohereResponseFormat.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this CohereResponseFormat.
+        The format type
+
+
+        :param type: The type of this CohereResponseFormat.
+        :type: str
+        """
+        allowed_values = ["JSON_OBJECT", "TEXT"]
+        if not value_allowed_none_or_none_sentinel(type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `type`, must be None or one of {allowed_values}"
+            )
+        self._type = type
+
+    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_response_json_format.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_response_format import CohereResponseFormat
+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 CohereResponseJsonFormat(CohereResponseFormat):
+    """
+    The json object format for the model structured output
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereResponseJsonFormat object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereResponseJsonFormat.type` attribute
+        of this class is ``JSON_OBJECT`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this CohereResponseJsonFormat.
+            Allowed values for this property are: "JSON_OBJECT", "TEXT"
+        :type type: str
+
+        :param schema:
+            The value to assign to the schema property of this CohereResponseJsonFormat.
+        :type schema: object
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'schema': 'object'
+        }
+
+        self.attribute_map = {
+            'type': 'type',
+            'schema': 'schema'
+        }
+
+        self._type = None
+        self._schema = None
+        self._type = 'JSON_OBJECT'
+
+    @property
+    def schema(self):
+        """
+        Gets the schema of this CohereResponseJsonFormat.
+        The schema used by the structured output, described as a JSON Schema object.
+
+
+        :return: The schema of this CohereResponseJsonFormat.
+        :rtype: object
+        """
+        return self._schema
+
+    @schema.setter
+    def schema(self, schema):
+        """
+        Sets the schema of this CohereResponseJsonFormat.
+        The schema used by the structured output, described as a JSON Schema object.
+
+
+        :param schema: The schema of this CohereResponseJsonFormat.
+        :type: object
+        """
+        self._schema = schema
+
+    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_response_text_format.py

@@ -0,0 +1,51 @@
+# 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_response_format import CohereResponseFormat
+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 CohereResponseTextFormat(CohereResponseFormat):
+    """
+    The text format for cohere model response
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereResponseTextFormat object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereResponseTextFormat.type` attribute
+        of this class is ``TEXT`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this CohereResponseTextFormat.
+            Allowed values for this property are: "JSON_OBJECT", "TEXT"
+        :type type: str
+
+        """
+        self.swagger_types = {
+            'type': 'str'
+        }
+
+        self.attribute_map = {
+            'type': 'type'
+        }
+
+        self._type = None
+        self._type = 'TEXT'
+
+    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/image_content.py

@@ -0,0 +1,78 @@
+# 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 .chat_content import ChatContent
+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 ImageContent(ChatContent):
+    """
+    Represents a single instance of chat image content.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ImageContent object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ImageContent.type` attribute
+        of this class is ``IMAGE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this ImageContent.
+            Allowed values for this property are: "TEXT", "IMAGE"
+        :type type: str
+
+        :param image_url:
+            The value to assign to the image_url property of this ImageContent.
+        :type image_url: oci.generative_ai_inference.models.ImageUrl
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'image_url': 'ImageUrl'
+        }
+
+        self.attribute_map = {
+            'type': 'type',
+            'image_url': 'imageUrl'
+        }
+
+        self._type = None
+        self._image_url = None
+        self._type = 'IMAGE'
+
+    @property
+    def image_url(self):
+        """
+        Gets the image_url of this ImageContent.
+
+        :return: The image_url of this ImageContent.
+        :rtype: oci.generative_ai_inference.models.ImageUrl
+        """
+        return self._image_url
+
+    @image_url.setter
+    def image_url(self, image_url):
+        """
+        Sets the image_url of this ImageContent.
+
+        :param image_url: The image_url of this ImageContent.
+        :type: oci.generative_ai_inference.models.ImageUrl
+        """
+        self._image_url = image_url
+
+    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/image_url.py

@@ -0,0 +1,123 @@
+# 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 ImageUrl(object):
+    """
+    Represents a single instance of chat image url.
+    """
+
+    #: A constant which can be used with the detail property of a ImageUrl.
+    #: This constant has a value of "AUTO"
+    DETAIL_AUTO = "AUTO"
+
+    #: A constant which can be used with the detail property of a ImageUrl.
+    #: This constant has a value of "HIGH"
+    DETAIL_HIGH = "HIGH"
+
+    #: A constant which can be used with the detail property of a ImageUrl.
+    #: This constant has a value of "LOW"
+    DETAIL_LOW = "LOW"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ImageUrl object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param url:
+            The value to assign to the url property of this ImageUrl.
+        :type url: str
+
+        :param detail:
+            The value to assign to the detail property of this ImageUrl.
+            Allowed values for this property are: "AUTO", "HIGH", "LOW", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type detail: str
+
+        """
+        self.swagger_types = {
+            'url': 'str',
+            'detail': 'str'
+        }
+
+        self.attribute_map = {
+            'url': 'url',
+            'detail': 'detail'
+        }
+
+        self._url = None
+        self._detail = None
+
+    @property
+    def url(self):
+        """
+        **[Required]** Gets the url of this ImageUrl.
+        The URL of the image.
+
+
+        :return: The url of this ImageUrl.
+        :rtype: str
+        """
+        return self._url
+
+    @url.setter
+    def url(self, url):
+        """
+        Sets the url of this ImageUrl.
+        The URL of the image.
+
+
+        :param url: The url of this ImageUrl.
+        :type: str
+        """
+        self._url = url
+
+    @property
+    def detail(self):
+        """
+        Gets the detail of this ImageUrl.
+        The level of the detail.
+
+        Allowed values for this property are: "AUTO", "HIGH", "LOW", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The detail of this ImageUrl.
+        :rtype: str
+        """
+        return self._detail
+
+    @detail.setter
+    def detail(self, detail):
+        """
+        Sets the detail of this ImageUrl.
+        The level of the detail.
+
+
+        :param detail: The detail of this ImageUrl.
+        :type: str
+        """
+        allowed_values = ["AUTO", "HIGH", "LOW"]
+        if not value_allowed_none_or_none_sentinel(detail, allowed_values):
+            detail = 'UNKNOWN_ENUM_VALUE'
+        self._detail = detail
+
+    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

@@ -23,7 +23,7 @@ class TextContent(ChatContent):
 
         :param type:
             The value to assign to the type property of this TextContent.
-            Allowed values for this property are: "TEXT"
+            Allowed values for this property are: "TEXT", "IMAGE"
         :type type: str
 
         :param text:

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.138.0/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.139.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.138.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.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.139.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.138.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.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.139.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']