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

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

oci/generative_ai_inference/models/generic_chat_request.py

@@ -38,6 +38,10 @@ class GenericChatRequest(BaseChatRequest):
             The value to assign to the num_generations property of this GenericChatRequest.
         :type num_generations: int
 
+        :param seed:
+            The value to assign to the seed property of this GenericChatRequest.
+        :type seed: int
+
         :param is_echo:
             The value to assign to the is_echo property of this GenericChatRequest.
         :type is_echo: bool
@@ -78,12 +82,21 @@ class GenericChatRequest(BaseChatRequest):
             The value to assign to the logit_bias property of this GenericChatRequest.
         :type logit_bias: object
 
+        :param tool_choice:
+            The value to assign to the tool_choice property of this GenericChatRequest.
+        :type tool_choice: oci.generative_ai_inference.models.ToolChoice
+
+        :param tools:
+            The value to assign to the tools property of this GenericChatRequest.
+        :type tools: list[oci.generative_ai_inference.models.ToolDefinition]
+
         """
         self.swagger_types = {
             'api_format': 'str',
             'messages': 'list[Message]',
             'is_stream': 'bool',
             'num_generations': 'int',
+            'seed': 'int',
             'is_echo': 'bool',
             'top_k': 'int',
             'top_p': 'float',
@@ -93,7 +106,9 @@ class GenericChatRequest(BaseChatRequest):
             'stop': 'list[str]',
             'log_probs': 'int',
             'max_tokens': 'int',
-            'logit_bias': 'object'
+            'logit_bias': 'object',
+            'tool_choice': 'ToolChoice',
+            'tools': 'list[ToolDefinition]'
         }
 
         self.attribute_map = {
@@ -101,6 +116,7 @@ class GenericChatRequest(BaseChatRequest):
             'messages': 'messages',
             'is_stream': 'isStream',
             'num_generations': 'numGenerations',
+            'seed': 'seed',
             'is_echo': 'isEcho',
             'top_k': 'topK',
             'top_p': 'topP',
@@ -110,13 +126,16 @@ class GenericChatRequest(BaseChatRequest):
             'stop': 'stop',
             'log_probs': 'logProbs',
             'max_tokens': 'maxTokens',
-            'logit_bias': 'logitBias'
+            'logit_bias': 'logitBias',
+            'tool_choice': 'toolChoice',
+            'tools': 'tools'
         }
 
         self._api_format = None
         self._messages = None
         self._is_stream = None
         self._num_generations = None
+        self._seed = None
         self._is_echo = None
         self._top_k = None
         self._top_p = None
@@ -127,6 +146,8 @@ class GenericChatRequest(BaseChatRequest):
         self._log_probs = None
         self._max_tokens = None
         self._logit_bias = None
+        self._tool_choice = None
+        self._tools = None
         self._api_format = 'GENERIC'
 
     @property
@@ -201,6 +222,30 @@ class GenericChatRequest(BaseChatRequest):
         """
         self._num_generations = num_generations
 
+    @property
+    def seed(self):
+        """
+        Gets the seed of this GenericChatRequest.
+        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 GenericChatRequest.
+        :rtype: int
+        """
+        return self._seed
+
+    @seed.setter
+    def seed(self, seed):
+        """
+        Sets the seed of this GenericChatRequest.
+        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 GenericChatRequest.
+        :type: int
+        """
+        self._seed = seed
+
     @property
     def is_echo(self):
         """
@@ -467,6 +512,50 @@ class GenericChatRequest(BaseChatRequest):
         """
         self._logit_bias = logit_bias
 
+    @property
+    def tool_choice(self):
+        """
+        Gets the tool_choice of this GenericChatRequest.
+
+        :return: The tool_choice of this GenericChatRequest.
+        :rtype: oci.generative_ai_inference.models.ToolChoice
+        """
+        return self._tool_choice
+
+    @tool_choice.setter
+    def tool_choice(self, tool_choice):
+        """
+        Sets the tool_choice of this GenericChatRequest.
+
+        :param tool_choice: The tool_choice of this GenericChatRequest.
+        :type: oci.generative_ai_inference.models.ToolChoice
+        """
+        self._tool_choice = tool_choice
+
+    @property
+    def tools(self):
+        """
+        Gets the tools of this GenericChatRequest.
+        A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.
+
+
+        :return: The tools of this GenericChatRequest.
+        :rtype: list[oci.generative_ai_inference.models.ToolDefinition]
+        """
+        return self._tools
+
+    @tools.setter
+    def tools(self, tools):
+        """
+        Sets the tools of this GenericChatRequest.
+        A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.
+
+
+        :param tools: The tools of this GenericChatRequest.
+        :type: list[oci.generative_ai_inference.models.ToolDefinition]
+        """
+        self._tools = tools
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_inference/models/image_url.py

@@ -12,7 +12,7 @@ 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.
+    Provide a base64 encoded image.
     """
 
     #: A constant which can be used with the detail property of a ImageUrl.
@@ -60,7 +60,15 @@ class ImageUrl(object):
     def url(self):
         """
         **[Required]** Gets the url of this ImageUrl.
-        The URL of the image.
+        The base64 encoded image data.
+
+        Example for a png image:
+          `{
+            \"type\": \"IMAGE\",
+            \"imageUrl\": {
+              \"url\": \"data:image/png;base64,<base64 encoded image content>\"
+            }
+          }`
 
 
         :return: The url of this ImageUrl.
@@ -72,7 +80,15 @@ class ImageUrl(object):
     def url(self, url):
         """
         Sets the url of this ImageUrl.
-        The URL of the image.
+        The base64 encoded image data.
+
+        Example for a png image:
+          `{
+            \"type\": \"IMAGE\",
+            \"imageUrl\": {
+              \"url\": \"data:image/png;base64,<base64 encoded image content>\"
+            }
+          }`
 
 
         :param url: The url of this ImageUrl.
@@ -84,7 +100,7 @@ class ImageUrl(object):
     def detail(self):
         """
         Gets the detail of this ImageUrl.
-        The level of the detail.
+        The default value is AUTO and only AUTO is supported. This option controls how to convert the base64 encoded image to tokens.
 
         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'.
@@ -99,7 +115,7 @@ class ImageUrl(object):
     def detail(self, detail):
         """
         Sets the detail of this ImageUrl.
-        The level of the detail.
+        The default value is AUTO and only AUTO is supported. This option controls how to convert the base64 encoded image to tokens.
 
 
         :param detail: The detail of this ImageUrl.

oci/generative_ai_inference/models/message.py

@@ -27,6 +27,10 @@ class Message(object):
     #: This constant has a value of "ASSISTANT"
     ROLE_ASSISTANT = "ASSISTANT"
 
+    #: A constant which can be used with the role property of a Message.
+    #: This constant has a value of "TOOL"
+    ROLE_TOOL = "TOOL"
+
     def __init__(self, **kwargs):
         """
         Initializes a new Message object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
@@ -35,12 +39,13 @@ class Message(object):
         * :class:`~oci.generative_ai_inference.models.SystemMessage`
         * :class:`~oci.generative_ai_inference.models.AssistantMessage`
         * :class:`~oci.generative_ai_inference.models.UserMessage`
+        * :class:`~oci.generative_ai_inference.models.ToolMessage`
 
         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 Message.
-            Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", 'UNKNOWN_ENUM_VALUE'.
+            Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL", 'UNKNOWN_ENUM_VALUE'.
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type role: str
 
@@ -78,6 +83,9 @@ class Message(object):
 
         if type == 'USER':
             return 'UserMessage'
+
+        if type == 'TOOL':
+            return 'ToolMessage'
         else:
             return 'Message'
 
@@ -87,7 +95,7 @@ class Message(object):
         **[Required]** Gets the role of this Message.
         Indicates who is writing the current chat message.
 
-        Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", 'UNKNOWN_ENUM_VALUE'.
+        Allowed values for this property are: "SYSTEM", "USER", "ASSISTANT", "TOOL", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
 
 
@@ -106,7 +114,7 @@ class Message(object):
         :param role: The role of this Message.
         :type: str
         """
-        allowed_values = ["SYSTEM", "USER", "ASSISTANT"]
+        allowed_values = ["SYSTEM", "USER", "ASSISTANT", "TOOL"]
         if not value_allowed_none_or_none_sentinel(role, allowed_values):
             role = 'UNKNOWN_ENUM_VALUE'
         self._role = role

oci/generative_ai_inference/models/rerank_text_details.py

@@ -0,0 +1,254 @@
+# 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 RerankTextDetails(object):
+    """
+    Details required for a rerank request.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RerankTextDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param input:
+            The value to assign to the input property of this RerankTextDetails.
+        :type input: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this RerankTextDetails.
+        :type compartment_id: str
+
+        :param serving_mode:
+            The value to assign to the serving_mode property of this RerankTextDetails.
+        :type serving_mode: oci.generative_ai_inference.models.ServingMode
+
+        :param documents:
+            The value to assign to the documents property of this RerankTextDetails.
+        :type documents: list[str]
+
+        :param top_n:
+            The value to assign to the top_n property of this RerankTextDetails.
+        :type top_n: int
+
+        :param is_echo:
+            The value to assign to the is_echo property of this RerankTextDetails.
+        :type is_echo: bool
+
+        :param max_chunks_per_document:
+            The value to assign to the max_chunks_per_document property of this RerankTextDetails.
+        :type max_chunks_per_document: int
+
+        """
+        self.swagger_types = {
+            'input': 'str',
+            'compartment_id': 'str',
+            'serving_mode': 'ServingMode',
+            'documents': 'list[str]',
+            'top_n': 'int',
+            'is_echo': 'bool',
+            'max_chunks_per_document': 'int'
+        }
+
+        self.attribute_map = {
+            'input': 'input',
+            'compartment_id': 'compartmentId',
+            'serving_mode': 'servingMode',
+            'documents': 'documents',
+            'top_n': 'topN',
+            'is_echo': 'isEcho',
+            'max_chunks_per_document': 'maxChunksPerDocument'
+        }
+
+        self._input = None
+        self._compartment_id = None
+        self._serving_mode = None
+        self._documents = None
+        self._top_n = None
+        self._is_echo = None
+        self._max_chunks_per_document = None
+
+    @property
+    def input(self):
+        """
+        **[Required]** Gets the input of this RerankTextDetails.
+        Input query for search in the documents.
+
+
+        :return: The input of this RerankTextDetails.
+        :rtype: str
+        """
+        return self._input
+
+    @input.setter
+    def input(self, input):
+        """
+        Sets the input of this RerankTextDetails.
+        Input query for search in the documents.
+
+
+        :param input: The input of this RerankTextDetails.
+        :type: str
+        """
+        self._input = input
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this RerankTextDetails.
+        The OCID of the compartment to call into the Generative AI service LLMs.
+
+
+        :return: The compartment_id of this RerankTextDetails.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this RerankTextDetails.
+        The OCID of the compartment to call into the Generative AI service LLMs.
+
+
+        :param compartment_id: The compartment_id of this RerankTextDetails.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def serving_mode(self):
+        """
+        **[Required]** Gets the serving_mode of this RerankTextDetails.
+
+        :return: The serving_mode of this RerankTextDetails.
+        :rtype: oci.generative_ai_inference.models.ServingMode
+        """
+        return self._serving_mode
+
+    @serving_mode.setter
+    def serving_mode(self, serving_mode):
+        """
+        Sets the serving_mode of this RerankTextDetails.
+
+        :param serving_mode: The serving_mode of this RerankTextDetails.
+        :type: oci.generative_ai_inference.models.ServingMode
+        """
+        self._serving_mode = serving_mode
+
+    @property
+    def documents(self):
+        """
+        **[Required]** Gets the documents of this RerankTextDetails.
+        A list of document strings to rerank based on the query asked.
+
+
+        :return: The documents of this RerankTextDetails.
+        :rtype: list[str]
+        """
+        return self._documents
+
+    @documents.setter
+    def documents(self, documents):
+        """
+        Sets the documents of this RerankTextDetails.
+        A list of document strings to rerank based on the query asked.
+
+
+        :param documents: The documents of this RerankTextDetails.
+        :type: list[str]
+        """
+        self._documents = documents
+
+    @property
+    def top_n(self):
+        """
+        Gets the top_n of this RerankTextDetails.
+        The number of most relevant documents or indices to return. Defaults to the length of the documents.
+
+
+        :return: The top_n of this RerankTextDetails.
+        :rtype: int
+        """
+        return self._top_n
+
+    @top_n.setter
+    def top_n(self, top_n):
+        """
+        Sets the top_n of this RerankTextDetails.
+        The number of most relevant documents or indices to return. Defaults to the length of the documents.
+
+
+        :param top_n: The top_n of this RerankTextDetails.
+        :type: int
+        """
+        self._top_n = top_n
+
+    @property
+    def is_echo(self):
+        """
+        Gets the is_echo of this RerankTextDetails.
+        Whether or not to return the documents in the response.
+
+
+        :return: The is_echo of this RerankTextDetails.
+        :rtype: bool
+        """
+        return self._is_echo
+
+    @is_echo.setter
+    def is_echo(self, is_echo):
+        """
+        Sets the is_echo of this RerankTextDetails.
+        Whether or not to return the documents in the response.
+
+
+        :param is_echo: The is_echo of this RerankTextDetails.
+        :type: bool
+        """
+        self._is_echo = is_echo
+
+    @property
+    def max_chunks_per_document(self):
+        """
+        Gets the max_chunks_per_document of this RerankTextDetails.
+        The maximum number of chunks to produce internally from a document.
+
+
+        :return: The max_chunks_per_document of this RerankTextDetails.
+        :rtype: int
+        """
+        return self._max_chunks_per_document
+
+    @max_chunks_per_document.setter
+    def max_chunks_per_document(self, max_chunks_per_document):
+        """
+        Sets the max_chunks_per_document of this RerankTextDetails.
+        The maximum number of chunks to produce internally from a document.
+
+
+        :param max_chunks_per_document: The max_chunks_per_document of this RerankTextDetails.
+        :type: int
+        """
+        self._max_chunks_per_document = max_chunks_per_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