oci 2.143.1__py3-none-any.whl → 2.144.1__py3-none-any.whl

oci/generative_ai_inference/models/rerank_text_result.py

@@ -0,0 +1,165 @@
+# 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 RerankTextResult(object):
+    """
+    The rerank response to return to the caller.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RerankTextResult object with values from keyword arguments.
+        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 RerankTextResult.
+        :type id: str
+
+        :param model_id:
+            The value to assign to the model_id property of this RerankTextResult.
+        :type model_id: str
+
+        :param model_version:
+            The value to assign to the model_version property of this RerankTextResult.
+        :type model_version: str
+
+        :param document_ranks:
+            The value to assign to the document_ranks property of this RerankTextResult.
+        :type document_ranks: list[oci.generative_ai_inference.models.DocumentRank]
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'model_id': 'str',
+            'model_version': 'str',
+            'document_ranks': 'list[DocumentRank]'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'model_id': 'modelId',
+            'model_version': 'modelVersion',
+            'document_ranks': 'documentRanks'
+        }
+
+        self._id = None
+        self._model_id = None
+        self._model_version = None
+        self._document_ranks = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this RerankTextResult.
+        A unique identifier for this `RerankResult`.
+
+
+        :return: The id of this RerankTextResult.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this RerankTextResult.
+        A unique identifier for this `RerankResult`.
+
+
+        :param id: The id of this RerankTextResult.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def model_id(self):
+        """
+        Gets the model_id of this RerankTextResult.
+        The OCID of the model used in the rerank request.
+
+
+        :return: The model_id of this RerankTextResult.
+        :rtype: str
+        """
+        return self._model_id
+
+    @model_id.setter
+    def model_id(self, model_id):
+        """
+        Sets the model_id of this RerankTextResult.
+        The OCID of the model used in the rerank request.
+
+
+        :param model_id: The model_id of this RerankTextResult.
+        :type: str
+        """
+        self._model_id = model_id
+
+    @property
+    def model_version(self):
+        """
+        Gets the model_version of this RerankTextResult.
+        The version of the model.
+
+
+        :return: The model_version of this RerankTextResult.
+        :rtype: str
+        """
+        return self._model_version
+
+    @model_version.setter
+    def model_version(self, model_version):
+        """
+        Sets the model_version of this RerankTextResult.
+        The version of the model.
+
+
+        :param model_version: The model_version of this RerankTextResult.
+        :type: str
+        """
+        self._model_version = model_version
+
+    @property
+    def document_ranks(self):
+        """
+        **[Required]** Gets the document_ranks of this RerankTextResult.
+        Top n documents with their index and relevance score.
+
+
+        :return: The document_ranks of this RerankTextResult.
+        :rtype: list[oci.generative_ai_inference.models.DocumentRank]
+        """
+        return self._document_ranks
+
+    @document_ranks.setter
+    def document_ranks(self, document_ranks):
+        """
+        Sets the document_ranks of this RerankTextResult.
+        Top n documents with their index and relevance score.
+
+
+        :param document_ranks: The document_ranks of this RerankTextResult.
+        :type: list[oci.generative_ai_inference.models.DocumentRank]
+        """
+        self._document_ranks = document_ranks
+
+    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/system_message.py

@@ -23,7 +23,7 @@ class SystemMessage(Message):
 
         :param role:
             The value to assign to the role property of this SystemMessage.
-            Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT"
+            Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL"
         :type role: str
 
         :param content:

oci/generative_ai_inference/models/tool_call.py

@@ -0,0 +1,132 @@
+# 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 ToolCall(object):
+    """
+    The tool call generated by the model, such as function call.
+    """
+
+    #: A constant which can be used with the type property of a ToolCall.
+    #: This constant has a value of "FUNCTION"
+    TYPE_FUNCTION = "FUNCTION"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolCall 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.FunctionCall`
+
+        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 ToolCall.
+        :type id: str
+
+        :param type:
+            The value to assign to the type property of this ToolCall.
+            Allowed values for this property are: "FUNCTION", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type type: str
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'type': 'str'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'type': 'type'
+        }
+
+        self._id = None
+        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 == 'FUNCTION':
+            return 'FunctionCall'
+        else:
+            return 'ToolCall'
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this ToolCall.
+        The ID of the tool call.
+
+
+        :return: The id of this ToolCall.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this ToolCall.
+        The ID of the tool call.
+
+
+        :param id: The id of this ToolCall.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this ToolCall.
+        The type of the tool.
+
+        Allowed values for this property are: "FUNCTION", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The type of this ToolCall.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this ToolCall.
+        The type of the tool.
+
+
+        :param type: The type of this ToolCall.
+        :type: str
+        """
+        allowed_values = ["FUNCTION"]
+        if not value_allowed_none_or_none_sentinel(type, allowed_values):
+            type = 'UNKNOWN_ENUM_VALUE'
+        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/tool_choice.py

@@ -0,0 +1,125 @@
+# 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 ToolChoice(object):
+    """
+    The tool choice for a tool.
+    """
+
+    #: A constant which can be used with the type property of a ToolChoice.
+    #: This constant has a value of "NONE"
+    TYPE_NONE = "NONE"
+
+    #: A constant which can be used with the type property of a ToolChoice.
+    #: This constant has a value of "AUTO"
+    TYPE_AUTO = "AUTO"
+
+    #: A constant which can be used with the type property of a ToolChoice.
+    #: This constant has a value of "REQUIRED"
+    TYPE_REQUIRED = "REQUIRED"
+
+    #: A constant which can be used with the type property of a ToolChoice.
+    #: This constant has a value of "FUNCTION"
+    TYPE_FUNCTION = "FUNCTION"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolChoice 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.ToolChoiceFunction`
+        * :class:`~oci.generative_ai_inference.models.ToolChoiceNone`
+        * :class:`~oci.generative_ai_inference.models.ToolChoiceAuto`
+        * :class:`~oci.generative_ai_inference.models.ToolChoiceRequired`
+
+        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 ToolChoice.
+            Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION"
+        :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 == 'FUNCTION':
+            return 'ToolChoiceFunction'
+
+        if type == 'NONE':
+            return 'ToolChoiceNone'
+
+        if type == 'AUTO':
+            return 'ToolChoiceAuto'
+
+        if type == 'REQUIRED':
+            return 'ToolChoiceRequired'
+        else:
+            return 'ToolChoice'
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this ToolChoice.
+        The tool choice.
+
+        Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION"
+
+
+        :return: The type of this ToolChoice.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this ToolChoice.
+        The tool choice.
+
+
+        :param type: The type of this ToolChoice.
+        :type: str
+        """
+        allowed_values = ["NONE", "AUTO", "REQUIRED", "FUNCTION"]
+        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/tool_choice_auto.py

@@ -0,0 +1,51 @@
+# 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_choice import ToolChoice
+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 ToolChoiceAuto(ToolChoice):
+    """
+    The model can pick between generating a message or calling one or more tools.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolChoiceAuto object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolChoiceAuto.type` attribute
+        of this class is ``AUTO`` 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 ToolChoiceAuto.
+            Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION"
+        :type type: str
+
+        """
+        self.swagger_types = {
+            'type': 'str'
+        }
+
+        self.attribute_map = {
+            'type': 'type'
+        }
+
+        self._type = None
+        self._type = 'AUTO'
+
+    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/tool_choice_function.py

@@ -0,0 +1,82 @@
+# 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_choice import ToolChoice
+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 ToolChoiceFunction(ToolChoice):
+    """
+    The tool choice for a function.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolChoiceFunction object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolChoiceFunction.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 ToolChoiceFunction.
+            Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION"
+        :type type: str
+
+        :param name:
+            The value to assign to the name property of this ToolChoiceFunction.
+        :type name: str
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'name': 'str'
+        }
+
+        self.attribute_map = {
+            'type': 'type',
+            'name': 'name'
+        }
+
+        self._type = None
+        self._name = None
+        self._type = 'FUNCTION'
+
+    @property
+    def name(self):
+        """
+        Gets the name of this ToolChoiceFunction.
+        The function name.
+
+
+        :return: The name of this ToolChoiceFunction.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this ToolChoiceFunction.
+        The function name.
+
+
+        :param name: The name of this ToolChoiceFunction.
+        :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/tool_choice_none.py

@@ -0,0 +1,51 @@
+# 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_choice import ToolChoice
+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 ToolChoiceNone(ToolChoice):
+    """
+    The model will not call any tool and instead generates a message.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolChoiceNone object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolChoiceNone.type` attribute
+        of this class is ``NONE`` 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 ToolChoiceNone.
+            Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION"
+        :type type: str
+
+        """
+        self.swagger_types = {
+            'type': 'str'
+        }
+
+        self.attribute_map = {
+            'type': 'type'
+        }
+
+        self._type = None
+        self._type = 'NONE'
+
+    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/tool_choice_required.py

@@ -0,0 +1,51 @@
+# 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_choice import ToolChoice
+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 ToolChoiceRequired(ToolChoice):
+    """
+    The model must call one or more tools.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolChoiceRequired object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.ToolChoiceRequired.type` attribute
+        of this class is ``REQUIRED`` 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 ToolChoiceRequired.
+            Allowed values for this property are: "NONE", "AUTO", "REQUIRED", "FUNCTION"
+        :type type: str
+
+        """
+        self.swagger_types = {
+            'type': 'str'
+        }
+
+        self.attribute_map = {
+            'type': 'type'
+        }
+
+        self._type = None
+        self._type = '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