oci 2.152.1__py3-none-any.whl → 2.154.0__py3-none-any.whl

oci/generative_ai_agent_runtime/models/model_params.py

@@ -0,0 +1,225 @@
+# 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: 20240531
+
+
+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 ModelParams(object):
+    """
+    Details of model parameters.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ModelParams object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param max_tokens:
+            The value to assign to the max_tokens property of this ModelParams.
+        :type max_tokens: int
+
+        :param temperature:
+            The value to assign to the temperature property of this ModelParams.
+        :type temperature: float
+
+        :param top_p:
+            The value to assign to the top_p property of this ModelParams.
+        :type top_p: float
+
+        :param top_k:
+            The value to assign to the top_k property of this ModelParams.
+        :type top_k: int
+
+        :param frequency_penalty:
+            The value to assign to the frequency_penalty property of this ModelParams.
+        :type frequency_penalty: float
+
+        :param presence_penalty:
+            The value to assign to the presence_penalty property of this ModelParams.
+        :type presence_penalty: float
+
+        """
+        self.swagger_types = {
+            'max_tokens': 'int',
+            'temperature': 'float',
+            'top_p': 'float',
+            'top_k': 'int',
+            'frequency_penalty': 'float',
+            'presence_penalty': 'float'
+        }
+        self.attribute_map = {
+            'max_tokens': 'maxTokens',
+            'temperature': 'temperature',
+            'top_p': 'topP',
+            'top_k': 'topK',
+            'frequency_penalty': 'frequencyPenalty',
+            'presence_penalty': 'presencePenalty'
+        }
+        self._max_tokens = None
+        self._temperature = None
+        self._top_p = None
+        self._top_k = None
+        self._frequency_penalty = None
+        self._presence_penalty = None
+
+    @property
+    def max_tokens(self):
+        """
+        Gets the max_tokens of this ModelParams.
+        Maximum number of tokens.
+
+
+        :return: The max_tokens of this ModelParams.
+        :rtype: int
+        """
+        return self._max_tokens
+
+    @max_tokens.setter
+    def max_tokens(self, max_tokens):
+        """
+        Sets the max_tokens of this ModelParams.
+        Maximum number of tokens.
+
+
+        :param max_tokens: The max_tokens of this ModelParams.
+        :type: int
+        """
+        self._max_tokens = max_tokens
+
+    @property
+    def temperature(self):
+        """
+        Gets the temperature of this ModelParams.
+        Sampling temperature.
+
+
+        :return: The temperature of this ModelParams.
+        :rtype: float
+        """
+        return self._temperature
+
+    @temperature.setter
+    def temperature(self, temperature):
+        """
+        Sets the temperature of this ModelParams.
+        Sampling temperature.
+
+
+        :param temperature: The temperature of this ModelParams.
+        :type: float
+        """
+        self._temperature = temperature
+
+    @property
+    def top_p(self):
+        """
+        Gets the top_p of this ModelParams.
+        Nucleus sampling probability.
+
+
+        :return: The top_p of this ModelParams.
+        :rtype: float
+        """
+        return self._top_p
+
+    @top_p.setter
+    def top_p(self, top_p):
+        """
+        Sets the top_p of this ModelParams.
+        Nucleus sampling probability.
+
+
+        :param top_p: The top_p of this ModelParams.
+        :type: float
+        """
+        self._top_p = top_p
+
+    @property
+    def top_k(self):
+        """
+        Gets the top_k of this ModelParams.
+        Top-K sampling parameter.
+
+
+        :return: The top_k of this ModelParams.
+        :rtype: int
+        """
+        return self._top_k
+
+    @top_k.setter
+    def top_k(self, top_k):
+        """
+        Sets the top_k of this ModelParams.
+        Top-K sampling parameter.
+
+
+        :param top_k: The top_k of this ModelParams.
+        :type: int
+        """
+        self._top_k = top_k
+
+    @property
+    def frequency_penalty(self):
+        """
+        Gets the frequency_penalty of this ModelParams.
+        Frequency penalty to reduce repeating tokens.
+
+
+        :return: The frequency_penalty of this ModelParams.
+        :rtype: float
+        """
+        return self._frequency_penalty
+
+    @frequency_penalty.setter
+    def frequency_penalty(self, frequency_penalty):
+        """
+        Sets the frequency_penalty of this ModelParams.
+        Frequency penalty to reduce repeating tokens.
+
+
+        :param frequency_penalty: The frequency_penalty of this ModelParams.
+        :type: float
+        """
+        self._frequency_penalty = frequency_penalty
+
+    @property
+    def presence_penalty(self):
+        """
+        Gets the presence_penalty of this ModelParams.
+        Presence penalty to encourage new topics.
+
+
+        :return: The presence_penalty of this ModelParams.
+        :rtype: float
+        """
+        return self._presence_penalty
+
+    @presence_penalty.setter
+    def presence_penalty(self, presence_penalty):
+        """
+        Sets the presence_penalty of this ModelParams.
+        Presence penalty to encourage new topics.
+
+
+        :param presence_penalty: The presence_penalty of this ModelParams.
+        :type: float
+        """
+        self._presence_penalty = presence_penalty
+
+    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_agent_runtime/models/planning_trace.py

@@ -0,0 +1,177 @@
+# 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: 20240531
+
+from .trace import Trace
+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 PlanningTrace(Trace):
+    """
+    Contains trace information related to planning at the platform.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PlanningTrace object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.PlanningTrace.trace_type` attribute
+        of this class is ``PLANNING_TRACE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param key:
+            The value to assign to the key property of this PlanningTrace.
+        :type key: str
+
+        :param parent_key:
+            The value to assign to the parent_key property of this PlanningTrace.
+        :type parent_key: str
+
+        :param source:
+            The value to assign to the source property of this PlanningTrace.
+        :type source: oci.generative_ai_agent_runtime.models.SourceDetails
+
+        :param time_created:
+            The value to assign to the time_created property of this PlanningTrace.
+        :type time_created: datetime
+
+        :param time_finished:
+            The value to assign to the time_finished property of this PlanningTrace.
+        :type time_finished: datetime
+
+        :param trace_type:
+            The value to assign to the trace_type property of this PlanningTrace.
+            Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE", "TOOL_INVOCATION_TRACE", "PLANNING_TRACE", "EXECUTION_TRACE"
+        :type trace_type: str
+
+        :param input:
+            The value to assign to the input property of this PlanningTrace.
+        :type input: str
+
+        :param output:
+            The value to assign to the output property of this PlanningTrace.
+        :type output: str
+
+        :param usage:
+            The value to assign to the usage property of this PlanningTrace.
+        :type usage: list[oci.generative_ai_agent_runtime.models.Usage]
+
+        """
+        self.swagger_types = {
+            'key': 'str',
+            'parent_key': 'str',
+            'source': 'SourceDetails',
+            'time_created': 'datetime',
+            'time_finished': 'datetime',
+            'trace_type': 'str',
+            'input': 'str',
+            'output': 'str',
+            'usage': 'list[Usage]'
+        }
+        self.attribute_map = {
+            'key': 'key',
+            'parent_key': 'parentKey',
+            'source': 'source',
+            'time_created': 'timeCreated',
+            'time_finished': 'timeFinished',
+            'trace_type': 'traceType',
+            'input': 'input',
+            'output': 'output',
+            'usage': 'usage'
+        }
+        self._key = None
+        self._parent_key = None
+        self._source = None
+        self._time_created = None
+        self._time_finished = None
+        self._trace_type = None
+        self._input = None
+        self._output = None
+        self._usage = None
+        self._trace_type = 'PLANNING_TRACE'
+
+    @property
+    def input(self):
+        """
+        Gets the input of this PlanningTrace.
+        Input prompt to planning LLM.
+
+
+        :return: The input of this PlanningTrace.
+        :rtype: str
+        """
+        return self._input
+
+    @input.setter
+    def input(self, input):
+        """
+        Sets the input of this PlanningTrace.
+        Input prompt to planning LLM.
+
+
+        :param input: The input of this PlanningTrace.
+        :type: str
+        """
+        self._input = input
+
+    @property
+    def output(self):
+        """
+        Gets the output of this PlanningTrace.
+        Output string from planning LLM.
+
+
+        :return: The output of this PlanningTrace.
+        :rtype: str
+        """
+        return self._output
+
+    @output.setter
+    def output(self, output):
+        """
+        Sets the output of this PlanningTrace.
+        Output string from planning LLM.
+
+
+        :param output: The output of this PlanningTrace.
+        :type: str
+        """
+        self._output = output
+
+    @property
+    def usage(self):
+        """
+        Gets the usage of this PlanningTrace.
+        Details of model and its usage.
+
+
+        :return: The usage of this PlanningTrace.
+        :rtype: list[oci.generative_ai_agent_runtime.models.Usage]
+        """
+        return self._usage
+
+    @usage.setter
+    def usage(self, usage):
+        """
+        Sets the usage of this PlanningTrace.
+        Details of model and its usage.
+
+
+        :param usage: The usage of this PlanningTrace.
+        :type: list[oci.generative_ai_agent_runtime.models.Usage]
+        """
+        self._usage = usage
+
+    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_agent_runtime/models/required_action.py

@@ -28,6 +28,7 @@ class RequiredAction(object):
         Initializes a new RequiredAction 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_agent_runtime.models.HumanApprovalRequiredAction`
         * :class:`~oci.generative_ai_agent_runtime.models.FunctionCallingRequiredAction`
 
         The following keyword arguments are supported (corresponding to the getters/setters of this class):
@@ -62,6 +63,9 @@ class RequiredAction(object):
         """
         type = object_dictionary['requiredActionType']
 
+        if type == 'HUMAN_APPROVAL_REQUIRED_ACTION':
+            return 'HumanApprovalRequiredAction'
+
         if type == 'FUNCTION_CALLING_REQUIRED_ACTION':
             return 'FunctionCallingRequiredAction'
         else:

oci/generative_ai_agent_runtime/models/retrieval_trace.py

@@ -21,13 +21,29 @@ class RetrievalTrace(Trace):
         of this class is ``RETRIEVAL_TRACE`` and it should not be changed.
         The following keyword arguments are supported (corresponding to the getters/setters of this class):
 
+        :param key:
+            The value to assign to the key property of this RetrievalTrace.
+        :type key: str
+
+        :param parent_key:
+            The value to assign to the parent_key property of this RetrievalTrace.
+        :type parent_key: str
+
+        :param source:
+            The value to assign to the source property of this RetrievalTrace.
+        :type source: oci.generative_ai_agent_runtime.models.SourceDetails
+
         :param time_created:
             The value to assign to the time_created property of this RetrievalTrace.
         :type time_created: datetime
 
+        :param time_finished:
+            The value to assign to the time_finished property of this RetrievalTrace.
+        :type time_finished: datetime
+
         :param trace_type:
             The value to assign to the trace_type property of this RetrievalTrace.
-            Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE"
+            Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE", "TOOL_INVOCATION_TRACE", "PLANNING_TRACE", "EXECUTION_TRACE"
         :type trace_type: str
 
         :param retrieval_input:
@@ -38,23 +54,42 @@ class RetrievalTrace(Trace):
             The value to assign to the citations property of this RetrievalTrace.
         :type citations: list[oci.generative_ai_agent_runtime.models.Citation]
 
+        :param usage:
+            The value to assign to the usage property of this RetrievalTrace.
+        :type usage: list[oci.generative_ai_agent_runtime.models.Usage]
+
         """
         self.swagger_types = {
+            'key': 'str',
+            'parent_key': 'str',
+            'source': 'SourceDetails',
             'time_created': 'datetime',
+            'time_finished': 'datetime',
             'trace_type': 'str',
             'retrieval_input': 'str',
-            'citations': 'list[Citation]'
+            'citations': 'list[Citation]',
+            'usage': 'list[Usage]'
         }
         self.attribute_map = {
+            'key': 'key',
+            'parent_key': 'parentKey',
+            'source': 'source',
             'time_created': 'timeCreated',
+            'time_finished': 'timeFinished',
             'trace_type': 'traceType',
             'retrieval_input': 'retrievalInput',
-            'citations': 'citations'
+            'citations': 'citations',
+            'usage': 'usage'
         }
+        self._key = None
+        self._parent_key = None
+        self._source = None
         self._time_created = None
+        self._time_finished = None
         self._trace_type = None
         self._retrieval_input = None
         self._citations = None
+        self._usage = None
         self._trace_type = 'RETRIEVAL_TRACE'
 
     @property
@@ -105,6 +140,30 @@ class RetrievalTrace(Trace):
         """
         self._citations = citations
 
+    @property
+    def usage(self):
+        """
+        Gets the usage of this RetrievalTrace.
+        Details of model and its usage.
+
+
+        :return: The usage of this RetrievalTrace.
+        :rtype: list[oci.generative_ai_agent_runtime.models.Usage]
+        """
+        return self._usage
+
+    @usage.setter
+    def usage(self, usage):
+        """
+        Sets the usage of this RetrievalTrace.
+        Details of model and its usage.
+
+
+        :param usage: The usage of this RetrievalTrace.
+        :type: list[oci.generative_ai_agent_runtime.models.Usage]
+        """
+        self._usage = usage
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_agent_runtime/models/source_details.py

@@ -0,0 +1,101 @@
+# 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: 20240531
+
+
+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 SourceDetails(object):
+    """
+    The details of source of the event.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new SourceDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param key:
+            The value to assign to the key property of this SourceDetails.
+        :type key: str
+
+        :param name:
+            The value to assign to the name property of this SourceDetails.
+        :type name: str
+
+        """
+        self.swagger_types = {
+            'key': 'str',
+            'name': 'str'
+        }
+        self.attribute_map = {
+            'key': 'key',
+            'name': 'name'
+        }
+        self._key = None
+        self._name = None
+
+    @property
+    def key(self):
+        """
+        Gets the key of this SourceDetails.
+        Id of the source of the event.
+
+
+        :return: The key of this SourceDetails.
+        :rtype: str
+        """
+        return self._key
+
+    @key.setter
+    def key(self, key):
+        """
+        Sets the key of this SourceDetails.
+        Id of the source of the event.
+
+
+        :param key: The key of this SourceDetails.
+        :type: str
+        """
+        self._key = key
+
+    @property
+    def name(self):
+        """
+        Gets the name of this SourceDetails.
+        Name of the source of the event.
+
+
+        :return: The name of this SourceDetails.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this SourceDetails.
+        Name of the source of the event.
+
+
+        :param name: The name of this SourceDetails.
+        :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