oci 2.143.0__py3-none-any.whl → 2.144.0__py3-none-any.whl

oci/generative_ai_inference/models/cohere_chat_request.py

@@ -616,7 +616,7 @@ class CohereChatRequest(BaseChatRequest):
     def seed(self):
         """
         Gets the seed of this CohereChatRequest.
-        If specified, the backend will make a best effort to sample tokens deterministically, such that repeated requests with the same seed and parameters should return the same result. However, determinism cannot be totally guaranteed.
+        If specified, the backend will make a best effort to sample tokens deterministically, so that repeated requests with the same seed and parameters yield the same result. However, determinism cannot be fully guaranteed.
 
 
         :return: The seed of this CohereChatRequest.
@@ -628,7 +628,7 @@ class CohereChatRequest(BaseChatRequest):
     def seed(self, seed):
         """
         Sets the seed of this CohereChatRequest.
-        If specified, the backend will make a best effort to sample tokens deterministically, such that repeated requests with the same seed and parameters should return the same result. However, determinism cannot be totally guaranteed.
+        If specified, the backend will make a best effort to sample tokens deterministically, so that repeated requests with the same seed and parameters yield the same result. However, determinism cannot be fully guaranteed.
 
 
         :param seed: The seed of this CohereChatRequest.

oci/generative_ai_inference/models/document.py

@@ -0,0 +1,72 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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 Document(object):
+    """
+    The input of the document to rerank.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Document object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param text:
+            The value to assign to the text property of this Document.
+        :type text: str
+
+        """
+        self.swagger_types = {
+            'text': 'str'
+        }
+
+        self.attribute_map = {
+            'text': 'text'
+        }
+
+        self._text = None
+
+    @property
+    def text(self):
+        """
+        **[Required]** Gets the text of this Document.
+        The text of the document to rerank.
+
+
+        :return: The text of this Document.
+        :rtype: str
+        """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        """
+        Sets the text of this Document.
+        The text of the document to rerank.
+
+
+        :param text: The text of this Document.
+        :type: str
+        """
+        self._text = 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/document_rank.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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 DocumentRank(object):
+    """
+    An object that contains a relevance score, an index and the text for a document.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new DocumentRank object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param index:
+            The value to assign to the index property of this DocumentRank.
+        :type index: int
+
+        :param relevance_score:
+            The value to assign to the relevance_score property of this DocumentRank.
+        :type relevance_score: float
+
+        :param document:
+            The value to assign to the document property of this DocumentRank.
+        :type document: oci.generative_ai_inference.models.Document
+
+        """
+        self.swagger_types = {
+            'index': 'int',
+            'relevance_score': 'float',
+            'document': 'Document'
+        }
+
+        self.attribute_map = {
+            'index': 'index',
+            'relevance_score': 'relevanceScore',
+            'document': 'document'
+        }
+
+        self._index = None
+        self._relevance_score = None
+        self._document = None
+
+    @property
+    def index(self):
+        """
+        Gets the index of this DocumentRank.
+        Index of the document in documents array.
+
+
+        :return: The index of this DocumentRank.
+        :rtype: int
+        """
+        return self._index
+
+    @index.setter
+    def index(self, index):
+        """
+        Sets the index of this DocumentRank.
+        Index of the document in documents array.
+
+
+        :param index: The index of this DocumentRank.
+        :type: int
+        """
+        self._index = index
+
+    @property
+    def relevance_score(self):
+        """
+        Gets the relevance_score of this DocumentRank.
+        The relevance score for the document at that index.
+
+
+        :return: The relevance_score of this DocumentRank.
+        :rtype: float
+        """
+        return self._relevance_score
+
+    @relevance_score.setter
+    def relevance_score(self, relevance_score):
+        """
+        Sets the relevance_score of this DocumentRank.
+        The relevance score for the document at that index.
+
+
+        :param relevance_score: The relevance_score of this DocumentRank.
+        :type: float
+        """
+        self._relevance_score = relevance_score
+
+    @property
+    def document(self):
+        """
+        Gets the document of this DocumentRank.
+
+        :return: The document of this DocumentRank.
+        :rtype: oci.generative_ai_inference.models.Document
+        """
+        return self._document
+
+    @document.setter
+    def document(self, document):
+        """
+        Sets the document of this DocumentRank.
+
+        :param document: The document of this DocumentRank.
+        :type: oci.generative_ai_inference.models.Document
+        """
+        self._document = document
+
+    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

@@ -43,6 +43,10 @@ class EmbedTextDetails(object):
     #: This constant has a value of "CLUSTERING"
     INPUT_TYPE_CLUSTERING = "CLUSTERING"
 
+    #: A constant which can be used with the input_type property of a EmbedTextDetails.
+    #: This constant has a value of "IMAGE"
+    INPUT_TYPE_IMAGE = "IMAGE"
+
     def __init__(self, **kwargs):
         """
         Initializes a new EmbedTextDetails object with values from keyword arguments.
@@ -71,7 +75,7 @@ class EmbedTextDetails(object):
 
         :param input_type:
             The value to assign to the input_type property of this EmbedTextDetails.
-            Allowed values for this property are: "SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING"
+            Allowed values for this property are: "SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING", "IMAGE"
         :type input_type: str
 
         """
@@ -104,7 +108,7 @@ class EmbedTextDetails(object):
     def inputs(self):
         """
         **[Required]** Gets the inputs of this EmbedTextDetails.
-        Provide a list of strings. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.
+        Provide a list of strings or one base64 encoded image with `input_type` setting to `IMAGE`. If text embedding, 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 +120,7 @@ class EmbedTextDetails(object):
     def inputs(self, inputs):
         """
         Sets the inputs of this EmbedTextDetails.
-        Provide a list of strings. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.
+        Provide a list of strings or one base64 encoded image with `input_type` setting to `IMAGE`. If text embedding, 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.
@@ -229,7 +233,7 @@ class EmbedTextDetails(object):
         Gets the input_type of this EmbedTextDetails.
         Specifies the input type.
 
-        Allowed values for this property are: "SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING"
+        Allowed values for this property are: "SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING", "IMAGE"
 
 
         :return: The input_type of this EmbedTextDetails.
@@ -247,7 +251,7 @@ class EmbedTextDetails(object):
         :param input_type: The input_type of this EmbedTextDetails.
         :type: str
         """
-        allowed_values = ["SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING"]
+        allowed_values = ["SEARCH_DOCUMENT", "SEARCH_QUERY", "CLASSIFICATION", "CLUSTERING", "IMAGE"]
         if not value_allowed_none_or_none_sentinel(input_type, allowed_values):
             raise ValueError(
                 f"Invalid value for `input_type`, must be None or one of {allowed_values}"

oci/generative_ai_inference/models/function_call.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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 .tool_call import ToolCall
+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 FunctionCall(ToolCall):
+    """
+    The function call generated by the model.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new FunctionCall object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.FunctionCall.type` attribute
+        of this class is ``FUNCTION`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param id:
+            The value to assign to the id property of this FunctionCall.
+        :type id: str
+
+        :param type:
+            The value to assign to the type property of this FunctionCall.
+            Allowed values for this property are: "FUNCTION"
+        :type type: str
+
+        :param name:
+            The value to assign to the name property of this FunctionCall.
+        :type name: str
+
+        :param arguments:
+            The value to assign to the arguments property of this FunctionCall.
+        :type arguments: str
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'type': 'str',
+            'name': 'str',
+            'arguments': 'str'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'type': 'type',
+            'name': 'name',
+            'arguments': 'arguments'
+        }
+
+        self._id = None
+        self._type = None
+        self._name = None
+        self._arguments = None
+        self._type = 'FUNCTION'
+
+    @property
+    def name(self):
+        """
+        Gets the name of this FunctionCall.
+        The name of the function to call.
+
+
+        :return: The name of this FunctionCall.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this FunctionCall.
+        The name of the function to call.
+
+
+        :param name: The name of this FunctionCall.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def arguments(self):
+        """
+        Gets the arguments of this FunctionCall.
+        The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
+
+
+        :return: The arguments of this FunctionCall.
+        :rtype: str
+        """
+        return self._arguments
+
+    @arguments.setter
+    def arguments(self, arguments):
+        """
+        Sets the arguments of this FunctionCall.
+        The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
+
+
+        :param arguments: The arguments of this FunctionCall.
+        :type: str
+        """
+        self._arguments = arguments
+
+    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/function_definition.py

@@ -0,0 +1,144 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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 .tool_definition import ToolDefinition
+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 FunctionDefinition(ToolDefinition):
+    """
+    A function the model may call.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new FunctionDefinition object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.FunctionDefinition.type` attribute
+        of this class is ``FUNCTION`` 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 FunctionDefinition.
+            Allowed values for this property are: "FUNCTION"
+        :type type: str
+
+        :param name:
+            The value to assign to the name property of this FunctionDefinition.
+        :type name: str
+
+        :param description:
+            The value to assign to the description property of this FunctionDefinition.
+        :type description: str
+
+        :param parameters:
+            The value to assign to the parameters property of this FunctionDefinition.
+        :type parameters: object
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'name': 'str',
+            'description': 'str',
+            'parameters': 'object'
+        }
+
+        self.attribute_map = {
+            'type': 'type',
+            'name': 'name',
+            'description': 'description',
+            'parameters': 'parameters'
+        }
+
+        self._type = None
+        self._name = None
+        self._description = None
+        self._parameters = None
+        self._type = 'FUNCTION'
+
+    @property
+    def name(self):
+        """
+        Gets the name of this FunctionDefinition.
+        The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
+
+
+        :return: The name of this FunctionDefinition.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this FunctionDefinition.
+        The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
+
+
+        :param name: The name of this FunctionDefinition.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this FunctionDefinition.
+        A description of what the function does, used by the model to choose when and how to call the function.
+
+
+        :return: The description of this FunctionDefinition.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this FunctionDefinition.
+        A description of what the function does, used by the model to choose when and how to call the function.
+
+
+        :param description: The description of this FunctionDefinition.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def parameters(self):
+        """
+        Gets the parameters of this FunctionDefinition.
+        The parameters the functions accepts, described as a JSON Schema object. Omitting parameters defines a function with an empty parameter list.
+
+
+        :return: The parameters of this FunctionDefinition.
+        :rtype: object
+        """
+        return self._parameters
+
+    @parameters.setter
+    def parameters(self, parameters):
+        """
+        Sets the parameters of this FunctionDefinition.
+        The parameters the functions accepts, described as a JSON Schema object. Omitting parameters defines a function with an empty parameter list.
+
+
+        :param parameters: The parameters of this FunctionDefinition.
+        :type: object
+        """
+        self._parameters = parameters
+
+    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