oci 2.134.0__py3-none-any.whl → 2.135.0__py3-none-any.whl

oci/generative_ai_agent_runtime/models/retrieval_trace.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 RetrievalTrace(Trace):
+    """
+    The trace that displays the retrieval information.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RetrievalTrace object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.RetrievalTrace.trace_type` attribute
+        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 time_created:
+            The value to assign to the time_created property of this RetrievalTrace.
+        :type time_created: 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"
+        :type trace_type: str
+
+        :param retrieval_input:
+            The value to assign to the retrieval_input property of this RetrievalTrace.
+        :type retrieval_input: str
+
+        :param citations:
+            The value to assign to the citations property of this RetrievalTrace.
+        :type citations: list[oci.generative_ai_agent_runtime.models.Citation]
+
+        """
+        self.swagger_types = {
+            'time_created': 'datetime',
+            'trace_type': 'str',
+            'retrieval_input': 'str',
+            'citations': 'list[Citation]'
+        }
+
+        self.attribute_map = {
+            'time_created': 'timeCreated',
+            'trace_type': 'traceType',
+            'retrieval_input': 'retrievalInput',
+            'citations': 'citations'
+        }
+
+        self._time_created = None
+        self._trace_type = None
+        self._retrieval_input = None
+        self._citations = None
+        self._trace_type = 'RETRIEVAL_TRACE'
+
+    @property
+    def retrieval_input(self):
+        """
+        Gets the retrieval_input of this RetrievalTrace.
+        The agent's search string for getting the displayed information.
+
+
+        :return: The retrieval_input of this RetrievalTrace.
+        :rtype: str
+        """
+        return self._retrieval_input
+
+    @retrieval_input.setter
+    def retrieval_input(self, retrieval_input):
+        """
+        Sets the retrieval_input of this RetrievalTrace.
+        The agent's search string for getting the displayed information.
+
+
+        :param retrieval_input: The retrieval_input of this RetrievalTrace.
+        :type: str
+        """
+        self._retrieval_input = retrieval_input
+
+    @property
+    def citations(self):
+        """
+        Gets the citations of this RetrievalTrace.
+        A list of citations retrieved from data sources.
+
+
+        :return: The citations of this RetrievalTrace.
+        :rtype: list[oci.generative_ai_agent_runtime.models.Citation]
+        """
+        return self._citations
+
+    @citations.setter
+    def citations(self, citations):
+        """
+        Sets the citations of this RetrievalTrace.
+        A list of citations retrieved from data sources.
+
+
+        :param citations: The citations of this RetrievalTrace.
+        :type: list[oci.generative_ai_agent_runtime.models.Citation]
+        """
+        self._citations = citations
+
+    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/session.py

@@ -0,0 +1,227 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 Session(object):
+    """
+    A session represents an interactive conversation initiated by a user through an API to engage with an agent. It involves a series of exchanges where the user sends queries or prompts, and the agent responds with relevant information, actions, or assistance based on the user's input. The session persists for the duration of the interaction, maintaining context and continuity to provide coherent and meaningful responses throughout the conversation.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Session 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 Session.
+        :type id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this Session.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this Session.
+        :type description: str
+
+        :param welcome_message:
+            The value to assign to the welcome_message property of this Session.
+        :type welcome_message: str
+
+        :param time_created:
+            The value to assign to the time_created property of this Session.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this Session.
+        :type time_updated: datetime
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'welcome_message': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'display_name': 'displayName',
+            'description': 'description',
+            'welcome_message': 'welcomeMessage',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated'
+        }
+
+        self._id = None
+        self._display_name = None
+        self._description = None
+        self._welcome_message = None
+        self._time_created = None
+        self._time_updated = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this Session.
+        A unique ID for the session. This ID is immutable on creation.
+
+
+        :return: The id of this Session.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this Session.
+        A unique ID for the session. This ID is immutable on creation.
+
+
+        :param id: The id of this Session.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this Session.
+        A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
+
+
+        :return: The display_name of this Session.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this Session.
+        A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
+
+
+        :param display_name: The display_name of this Session.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this Session.
+        A description of the session.
+
+
+        :return: The description of this Session.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this Session.
+        A description of the session.
+
+
+        :param description: The description of this Session.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def welcome_message(self):
+        """
+        Gets the welcome_message of this Session.
+        A greeting message that the you receive when you start of a session.
+
+
+        :return: The welcome_message of this Session.
+        :rtype: str
+        """
+        return self._welcome_message
+
+    @welcome_message.setter
+    def welcome_message(self, welcome_message):
+        """
+        Sets the welcome_message of this Session.
+        A greeting message that the you receive when you start of a session.
+
+
+        :param welcome_message: The welcome_message of this Session.
+        :type: str
+        """
+        self._welcome_message = welcome_message
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this Session.
+        The date and time that the session started in the format of an RFC3339 datetime string.
+
+
+        :return: The time_created of this Session.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this Session.
+        The date and time that the session started in the format of an RFC3339 datetime string.
+
+
+        :param time_created: The time_created of this Session.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        Gets the time_updated of this Session.
+        The date and time that the session was last updated in the format of an RFC3339 datetime string.
+
+
+        :return: The time_updated of this Session.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets the time_updated of this Session.
+        The date and time that the session was last updated in the format of an RFC3339 datetime string.
+
+
+        :param time_updated: The time_updated of this Session.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    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/source_location.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 SourceLocation(object):
+    """
+    The location of the data files that the agent will use.
+    """
+
+    #: A constant which can be used with the source_location_type property of a SourceLocation.
+    #: This constant has a value of "OCI_OBJECT_STORAGE"
+    SOURCE_LOCATION_TYPE_OCI_OBJECT_STORAGE = "OCI_OBJECT_STORAGE"
+
+    #: A constant which can be used with the source_location_type property of a SourceLocation.
+    #: This constant has a value of "OCI_OPEN_SEARCH"
+    SOURCE_LOCATION_TYPE_OCI_OPEN_SEARCH = "OCI_OPEN_SEARCH"
+
+    #: A constant which can be used with the source_location_type property of a SourceLocation.
+    #: This constant has a value of "OCI_DATABASE"
+    SOURCE_LOCATION_TYPE_OCI_DATABASE = "OCI_DATABASE"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new SourceLocation 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.OciObjectStorageSourceLocation`
+        * :class:`~oci.generative_ai_agent_runtime.models.OciOpenSearchSourceLocation`
+        * :class:`~oci.generative_ai_agent_runtime.models.OciDatabaseSourceLocation`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param source_location_type:
+            The value to assign to the source_location_type property of this SourceLocation.
+            Allowed values for this property are: "OCI_OBJECT_STORAGE", "OCI_OPEN_SEARCH", "OCI_DATABASE", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type source_location_type: str
+
+        """
+        self.swagger_types = {
+            'source_location_type': 'str'
+        }
+
+        self.attribute_map = {
+            'source_location_type': 'sourceLocationType'
+        }
+
+        self._source_location_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['sourceLocationType']
+
+        if type == 'OCI_OBJECT_STORAGE':
+            return 'OciObjectStorageSourceLocation'
+
+        if type == 'OCI_OPEN_SEARCH':
+            return 'OciOpenSearchSourceLocation'
+
+        if type == 'OCI_DATABASE':
+            return 'OciDatabaseSourceLocation'
+        else:
+            return 'SourceLocation'
+
+    @property
+    def source_location_type(self):
+        """
+        **[Required]** Gets the source_location_type of this SourceLocation.
+        The type of the data source that contains data files for the agent.
+
+        Allowed values for this property are: "OCI_OBJECT_STORAGE", "OCI_OPEN_SEARCH", "OCI_DATABASE", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The source_location_type of this SourceLocation.
+        :rtype: str
+        """
+        return self._source_location_type
+
+    @source_location_type.setter
+    def source_location_type(self, source_location_type):
+        """
+        Sets the source_location_type of this SourceLocation.
+        The type of the data source that contains data files for the agent.
+
+
+        :param source_location_type: The source_location_type of this SourceLocation.
+        :type: str
+        """
+        allowed_values = ["OCI_OBJECT_STORAGE", "OCI_OPEN_SEARCH", "OCI_DATABASE"]
+        if not value_allowed_none_or_none_sentinel(source_location_type, allowed_values):
+            source_location_type = 'UNKNOWN_ENUM_VALUE'
+        self._source_location_type = source_location_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_agent_runtime/models/trace.py

@@ -0,0 +1,148 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 Trace(object):
+    """
+    The trace that displays the internal progression, such as reasoning and actions during an execution.
+    """
+
+    #: A constant which can be used with the trace_type property of a Trace.
+    #: This constant has a value of "ERROR_TRACE"
+    TRACE_TYPE_ERROR_TRACE = "ERROR_TRACE"
+
+    #: A constant which can be used with the trace_type property of a Trace.
+    #: This constant has a value of "RETRIEVAL_TRACE"
+    TRACE_TYPE_RETRIEVAL_TRACE = "RETRIEVAL_TRACE"
+
+    #: A constant which can be used with the trace_type property of a Trace.
+    #: This constant has a value of "GENERATION_TRACE"
+    TRACE_TYPE_GENERATION_TRACE = "GENERATION_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
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.generative_ai_agent_runtime.models.ErrorTrace`
+        * :class:`~oci.generative_ai_agent_runtime.models.RetrievalTrace`
+        * :class:`~oci.generative_ai_agent_runtime.models.GenerationTrace`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param time_created:
+            The value to assign to the time_created property of this Trace.
+        :type time_created: 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'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type trace_type: str
+
+        """
+        self.swagger_types = {
+            'time_created': 'datetime',
+            'trace_type': 'str'
+        }
+
+        self.attribute_map = {
+            'time_created': 'timeCreated',
+            'trace_type': 'traceType'
+        }
+
+        self._time_created = None
+        self._trace_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['traceType']
+
+        if type == 'ERROR_TRACE':
+            return 'ErrorTrace'
+
+        if type == 'RETRIEVAL_TRACE':
+            return 'RetrievalTrace'
+
+        if type == 'GENERATION_TRACE':
+            return 'GenerationTrace'
+        else:
+            return 'Trace'
+
+    @property
+    def time_created(self):
+        """
+        Gets the time_created of this Trace.
+        The date and time that the trace was created in the format of an RFC3339 datetime string.
+
+
+        :return: The time_created of this Trace.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this Trace.
+        The date and time that the trace was created in the format of an RFC3339 datetime string.
+
+
+        :param time_created: The time_created of this Trace.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @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'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The trace_type of this Trace.
+        :rtype: str
+        """
+        return self._trace_type
+
+    @trace_type.setter
+    def trace_type(self, trace_type):
+        """
+        Sets the trace_type of this Trace.
+        The type of the trace.
+
+
+        :param trace_type: The trace_type of this Trace.
+        :type: str
+        """
+        allowed_values = ["ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE"]
+        if not value_allowed_none_or_none_sentinel(trace_type, allowed_values):
+            trace_type = 'UNKNOWN_ENUM_VALUE'
+        self._trace_type = trace_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