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

oci/generative_ai_agent_runtime/models/tool_invocation_trace.py

@@ -0,0 +1,190 @@
+# 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 ToolInvocationTrace(Trace):
+    """
+    **Pre-General Availability: 2024-01-24**
+    |*Important*|
+    |-
+    |*The following legal notice applies to Oracle pre-GA releases. For copyright and other applicable notices, see  `Oracle Legal Notices`__.*
+
+    |*Pre-General Availability Draft Documentation Notice*|
+    |-
+    |*This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation. This documentation is not a commitment by Oracle to deliver any material, code, functionality or services. This documentation, and Oracle Pre-GA programs and services are subject to change at any time without notice and, accordingly, should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality for Oracle's Pre-GA programs and services remains at the sole discretion of Oracle. All release dates or other predictions of future events are subject to change. The future availability of any future Oracle program or service should not be relied on in entering into any license or service agreement with Oracle.*
+    **GenerationTrace**
+
+
+    The trace information about the tool selection from multiple tools.
+
+    __ https://docs.oracle.com/iaas/Content/legalnotices.htm
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolInvocationTrace object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.ToolInvocationTrace.trace_type` attribute
+        of this class is ``TOOL_INVOCATION_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 ToolInvocationTrace.
+        :type key: str
+
+        :param parent_key:
+            The value to assign to the parent_key property of this ToolInvocationTrace.
+        :type parent_key: str
+
+        :param source:
+            The value to assign to the source property of this ToolInvocationTrace.
+        :type source: oci.generative_ai_agent_runtime.models.SourceDetails
+
+        :param time_created:
+            The value to assign to the time_created property of this ToolInvocationTrace.
+        :type time_created: datetime
+
+        :param time_finished:
+            The value to assign to the time_finished property of this ToolInvocationTrace.
+        :type time_finished: datetime
+
+        :param trace_type:
+            The value to assign to the trace_type property of this ToolInvocationTrace.
+            Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE", "TOOL_INVOCATION_TRACE", "PLANNING_TRACE", "EXECUTION_TRACE"
+        :type trace_type: str
+
+        :param tool_id:
+            The value to assign to the tool_id property of this ToolInvocationTrace.
+        :type tool_id: str
+
+        :param tool_name:
+            The value to assign to the tool_name property of this ToolInvocationTrace.
+        :type tool_name: str
+
+        :param invocation_details:
+            The value to assign to the invocation_details property of this ToolInvocationTrace.
+        :type invocation_details: str
+
+        """
+        self.swagger_types = {
+            'key': 'str',
+            'parent_key': 'str',
+            'source': 'SourceDetails',
+            'time_created': 'datetime',
+            'time_finished': 'datetime',
+            'trace_type': 'str',
+            'tool_id': 'str',
+            'tool_name': 'str',
+            'invocation_details': 'str'
+        }
+        self.attribute_map = {
+            'key': 'key',
+            'parent_key': 'parentKey',
+            'source': 'source',
+            'time_created': 'timeCreated',
+            'time_finished': 'timeFinished',
+            'trace_type': 'traceType',
+            'tool_id': 'toolId',
+            'tool_name': 'toolName',
+            'invocation_details': 'invocationDetails'
+        }
+        self._key = None
+        self._parent_key = None
+        self._source = None
+        self._time_created = None
+        self._time_finished = None
+        self._trace_type = None
+        self._tool_id = None
+        self._tool_name = None
+        self._invocation_details = None
+        self._trace_type = 'TOOL_INVOCATION_TRACE'
+
+    @property
+    def tool_id(self):
+        """
+        Gets the tool_id of this ToolInvocationTrace.
+        The ID of the selected tool based on the user query.
+
+
+        :return: The tool_id of this ToolInvocationTrace.
+        :rtype: str
+        """
+        return self._tool_id
+
+    @tool_id.setter
+    def tool_id(self, tool_id):
+        """
+        Sets the tool_id of this ToolInvocationTrace.
+        The ID of the selected tool based on the user query.
+
+
+        :param tool_id: The tool_id of this ToolInvocationTrace.
+        :type: str
+        """
+        self._tool_id = tool_id
+
+    @property
+    def tool_name(self):
+        """
+        Gets the tool_name of this ToolInvocationTrace.
+        The display name of the selected tool.
+
+
+        :return: The tool_name of this ToolInvocationTrace.
+        :rtype: str
+        """
+        return self._tool_name
+
+    @tool_name.setter
+    def tool_name(self, tool_name):
+        """
+        Sets the tool_name of this ToolInvocationTrace.
+        The display name of the selected tool.
+
+
+        :param tool_name: The tool_name of this ToolInvocationTrace.
+        :type: str
+        """
+        self._tool_name = tool_name
+
+    @property
+    def invocation_details(self):
+        """
+        Gets the invocation_details of this ToolInvocationTrace.
+        The invocation details related to the selected tool.
+
+
+        :return: The invocation_details of this ToolInvocationTrace.
+        :rtype: str
+        """
+        return self._invocation_details
+
+    @invocation_details.setter
+    def invocation_details(self, invocation_details):
+        """
+        Sets the invocation_details of this ToolInvocationTrace.
+        The invocation details related to the selected tool.
+
+
+        :param invocation_details: The invocation_details of this ToolInvocationTrace.
+        :type: str
+        """
+        self._invocation_details = invocation_details
+
+    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/trace.py

@@ -27,6 +27,18 @@ class Trace(object):
     #: This constant has a value of "GENERATION_TRACE"
     TRACE_TYPE_GENERATION_TRACE = "GENERATION_TRACE"
 
+    #: A constant which can be used with the trace_type property of a Trace.
+    #: This constant has a value of "TOOL_INVOCATION_TRACE"
+    TRACE_TYPE_TOOL_INVOCATION_TRACE = "TOOL_INVOCATION_TRACE"
+
+    #: A constant which can be used with the trace_type property of a Trace.
+    #: This constant has a value of "PLANNING_TRACE"
+    TRACE_TYPE_PLANNING_TRACE = "PLANNING_TRACE"
+
+    #: A constant which can be used with the trace_type property of a Trace.
+    #: This constant has a value of "EXECUTION_TRACE"
+    TRACE_TYPE_EXECUTION_TRACE = "EXECUTION_TRACE"
+
     def __init__(self, **kwargs):
         """
         Initializes a new Trace object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
@@ -34,30 +46,61 @@ class Trace(object):
 
         * :class:`~oci.generative_ai_agent_runtime.models.ErrorTrace`
         * :class:`~oci.generative_ai_agent_runtime.models.RetrievalTrace`
+        * :class:`~oci.generative_ai_agent_runtime.models.ExecutionTrace`
         * :class:`~oci.generative_ai_agent_runtime.models.GenerationTrace`
+        * :class:`~oci.generative_ai_agent_runtime.models.ToolInvocationTrace`
+        * :class:`~oci.generative_ai_agent_runtime.models.PlanningTrace`
 
         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 Trace.
+        :type key: str
+
+        :param parent_key:
+            The value to assign to the parent_key property of this Trace.
+        :type parent_key: str
+
+        :param source:
+            The value to assign to the source property of this Trace.
+        :type source: oci.generative_ai_agent_runtime.models.SourceDetails
+
         :param time_created:
             The value to assign to the time_created property of this Trace.
         :type time_created: datetime
 
+        :param time_finished:
+            The value to assign to the time_finished property of this Trace.
+        :type time_finished: datetime
+
         :param trace_type:
             The value to assign to the trace_type property of this Trace.
-            Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE", 'UNKNOWN_ENUM_VALUE'.
+            Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE", "TOOL_INVOCATION_TRACE", "PLANNING_TRACE", "EXECUTION_TRACE", 'UNKNOWN_ENUM_VALUE'.
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type trace_type: str
 
         """
         self.swagger_types = {
+            'key': 'str',
+            'parent_key': 'str',
+            'source': 'SourceDetails',
             'time_created': 'datetime',
+            'time_finished': 'datetime',
             'trace_type': 'str'
         }
         self.attribute_map = {
+            'key': 'key',
+            'parent_key': 'parentKey',
+            'source': 'source',
             'time_created': 'timeCreated',
+            'time_finished': 'timeFinished',
             'trace_type': 'traceType'
         }
+        self._key = None
+        self._parent_key = None
+        self._source = None
         self._time_created = None
+        self._time_finished = None
         self._trace_type = None
 
     @staticmethod
@@ -74,11 +117,88 @@ class Trace(object):
         if type == 'RETRIEVAL_TRACE':
             return 'RetrievalTrace'
 
+        if type == 'EXECUTION_TRACE':
+            return 'ExecutionTrace'
+
         if type == 'GENERATION_TRACE':
             return 'GenerationTrace'
+
+        if type == 'TOOL_INVOCATION_TRACE':
+            return 'ToolInvocationTrace'
+
+        if type == 'PLANNING_TRACE':
+            return 'PlanningTrace'
         else:
             return 'Trace'
 
+    @property
+    def key(self):
+        """
+        Gets the key of this Trace.
+        Unique identifier for the event (UUID).
+
+
+        :return: The key of this Trace.
+        :rtype: str
+        """
+        return self._key
+
+    @key.setter
+    def key(self, key):
+        """
+        Sets the key of this Trace.
+        Unique identifier for the event (UUID).
+
+
+        :param key: The key of this Trace.
+        :type: str
+        """
+        self._key = key
+
+    @property
+    def parent_key(self):
+        """
+        Gets the parent_key of this Trace.
+        Identifier of the parent event, if applicable (UUID).
+
+
+        :return: The parent_key of this Trace.
+        :rtype: str
+        """
+        return self._parent_key
+
+    @parent_key.setter
+    def parent_key(self, parent_key):
+        """
+        Sets the parent_key of this Trace.
+        Identifier of the parent event, if applicable (UUID).
+
+
+        :param parent_key: The parent_key of this Trace.
+        :type: str
+        """
+        self._parent_key = parent_key
+
+    @property
+    def source(self):
+        """
+        Gets the source of this Trace.
+
+        :return: The source of this Trace.
+        :rtype: oci.generative_ai_agent_runtime.models.SourceDetails
+        """
+        return self._source
+
+    @source.setter
+    def source(self, source):
+        """
+        Sets the source of this Trace.
+
+        :param source: The source of this Trace.
+        :type: oci.generative_ai_agent_runtime.models.SourceDetails
+        """
+        self._source = source
+
     @property
     def time_created(self):
         """
@@ -103,13 +223,37 @@ class Trace(object):
         """
         self._time_created = time_created
 
+    @property
+    def time_finished(self):
+        """
+        Gets the time_finished of this Trace.
+        Timestamp for when the event ended (In RFC 3339).
+
+
+        :return: The time_finished of this Trace.
+        :rtype: datetime
+        """
+        return self._time_finished
+
+    @time_finished.setter
+    def time_finished(self, time_finished):
+        """
+        Sets the time_finished of this Trace.
+        Timestamp for when the event ended (In RFC 3339).
+
+
+        :param time_finished: The time_finished of this Trace.
+        :type: datetime
+        """
+        self._time_finished = time_finished
+
     @property
     def trace_type(self):
         """
         **[Required]** Gets the trace_type of this Trace.
         The type of the trace.
 
-        Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE", 'UNKNOWN_ENUM_VALUE'.
+        Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE", "TOOL_INVOCATION_TRACE", "PLANNING_TRACE", "EXECUTION_TRACE", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
 
 
@@ -128,7 +272,7 @@ class Trace(object):
         :param trace_type: The trace_type of this Trace.
         :type: str
         """
-        allowed_values = ["ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE"]
+        allowed_values = ["ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE", "TOOL_INVOCATION_TRACE", "PLANNING_TRACE", "EXECUTION_TRACE"]
         if not value_allowed_none_or_none_sentinel(trace_type, allowed_values):
             trace_type = 'UNKNOWN_ENUM_VALUE'
         self._trace_type = trace_type

oci/generative_ai_agent_runtime/models/usage.py

@@ -0,0 +1,93 @@
+# 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 Usage(object):
+    """
+    Details of usage.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Usage object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_details:
+            The value to assign to the model_details property of this Usage.
+        :type model_details: oci.generative_ai_agent_runtime.models.ModelDetails
+
+        :param usage_details:
+            The value to assign to the usage_details property of this Usage.
+        :type usage_details: oci.generative_ai_agent_runtime.models.UsageDetails
+
+        """
+        self.swagger_types = {
+            'model_details': 'ModelDetails',
+            'usage_details': 'UsageDetails'
+        }
+        self.attribute_map = {
+            'model_details': 'modelDetails',
+            'usage_details': 'usageDetails'
+        }
+        self._model_details = None
+        self._usage_details = None
+
+    @property
+    def model_details(self):
+        """
+        Gets the model_details of this Usage.
+
+        :return: The model_details of this Usage.
+        :rtype: oci.generative_ai_agent_runtime.models.ModelDetails
+        """
+        return self._model_details
+
+    @model_details.setter
+    def model_details(self, model_details):
+        """
+        Sets the model_details of this Usage.
+
+        :param model_details: The model_details of this Usage.
+        :type: oci.generative_ai_agent_runtime.models.ModelDetails
+        """
+        self._model_details = model_details
+
+    @property
+    def usage_details(self):
+        """
+        Gets the usage_details of this Usage.
+
+        :return: The usage_details of this Usage.
+        :rtype: oci.generative_ai_agent_runtime.models.UsageDetails
+        """
+        return self._usage_details
+
+    @usage_details.setter
+    def usage_details(self, usage_details):
+        """
+        Sets the usage_details of this Usage.
+
+        :param usage_details: The usage_details of this Usage.
+        :type: oci.generative_ai_agent_runtime.models.UsageDetails
+        """
+        self._usage_details = usage_details
+
+    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/usage_details.py

@@ -0,0 +1,163 @@
+# 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 UsageDetails(object):
+    """
+    Usage details.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new UsageDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param input_token_count:
+            The value to assign to the input_token_count property of this UsageDetails.
+        :type input_token_count: int
+
+        :param output_token_count:
+            The value to assign to the output_token_count property of this UsageDetails.
+        :type output_token_count: int
+
+        :param input_char_count:
+            The value to assign to the input_char_count property of this UsageDetails.
+        :type input_char_count: int
+
+        :param output_char_count:
+            The value to assign to the output_char_count property of this UsageDetails.
+        :type output_char_count: int
+
+        """
+        self.swagger_types = {
+            'input_token_count': 'int',
+            'output_token_count': 'int',
+            'input_char_count': 'int',
+            'output_char_count': 'int'
+        }
+        self.attribute_map = {
+            'input_token_count': 'inputTokenCount',
+            'output_token_count': 'outputTokenCount',
+            'input_char_count': 'inputCharCount',
+            'output_char_count': 'outputCharCount'
+        }
+        self._input_token_count = None
+        self._output_token_count = None
+        self._input_char_count = None
+        self._output_char_count = None
+
+    @property
+    def input_token_count(self):
+        """
+        Gets the input_token_count of this UsageDetails.
+        Number of input tokens.
+
+
+        :return: The input_token_count of this UsageDetails.
+        :rtype: int
+        """
+        return self._input_token_count
+
+    @input_token_count.setter
+    def input_token_count(self, input_token_count):
+        """
+        Sets the input_token_count of this UsageDetails.
+        Number of input tokens.
+
+
+        :param input_token_count: The input_token_count of this UsageDetails.
+        :type: int
+        """
+        self._input_token_count = input_token_count
+
+    @property
+    def output_token_count(self):
+        """
+        Gets the output_token_count of this UsageDetails.
+        Number of output tokens.
+
+
+        :return: The output_token_count of this UsageDetails.
+        :rtype: int
+        """
+        return self._output_token_count
+
+    @output_token_count.setter
+    def output_token_count(self, output_token_count):
+        """
+        Sets the output_token_count of this UsageDetails.
+        Number of output tokens.
+
+
+        :param output_token_count: The output_token_count of this UsageDetails.
+        :type: int
+        """
+        self._output_token_count = output_token_count
+
+    @property
+    def input_char_count(self):
+        """
+        Gets the input_char_count of this UsageDetails.
+        Number of input characters.
+
+
+        :return: The input_char_count of this UsageDetails.
+        :rtype: int
+        """
+        return self._input_char_count
+
+    @input_char_count.setter
+    def input_char_count(self, input_char_count):
+        """
+        Sets the input_char_count of this UsageDetails.
+        Number of input characters.
+
+
+        :param input_char_count: The input_char_count of this UsageDetails.
+        :type: int
+        """
+        self._input_char_count = input_char_count
+
+    @property
+    def output_char_count(self):
+        """
+        Gets the output_char_count of this UsageDetails.
+        Number of output characters.
+
+
+        :return: The output_char_count of this UsageDetails.
+        :rtype: int
+        """
+        return self._output_char_count
+
+    @output_char_count.setter
+    def output_char_count(self, output_char_count):
+        """
+        Sets the output_char_count of this UsageDetails.
+        Number of output characters.
+
+
+        :param output_char_count: The output_char_count of this UsageDetails.
+        :type: int
+        """
+        self._output_char_count = output_char_count
+
+    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