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

oci/generative_ai_agent_runtime/models/message.py

@@ -0,0 +1,146 @@
+# 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 Message(object):
+    """
+    The Message resource generated by the agent.
+    """
+
+    #: A constant which can be used with the role property of a Message.
+    #: This constant has a value of "USER"
+    ROLE_USER = "USER"
+
+    #: A constant which can be used with the role property of a Message.
+    #: This constant has a value of "AGENT"
+    ROLE_AGENT = "AGENT"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Message object with values from keyword arguments.
+        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: "USER", "AGENT", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type role: str
+
+        :param content:
+            The value to assign to the content property of this Message.
+        :type content: oci.generative_ai_agent_runtime.models.MessageContent
+
+        :param time_created:
+            The value to assign to the time_created property of this Message.
+        :type time_created: datetime
+
+        """
+        self.swagger_types = {
+            'role': 'str',
+            'content': 'MessageContent',
+            'time_created': 'datetime'
+        }
+
+        self.attribute_map = {
+            'role': 'role',
+            'content': 'content',
+            'time_created': 'timeCreated'
+        }
+
+        self._role = None
+        self._content = None
+        self._time_created = None
+
+    @property
+    def role(self):
+        """
+        **[Required]** Gets the role of this Message.
+        The role of the sender of this message.
+
+        Allowed values for this property are: "USER", "AGENT", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The role of this Message.
+        :rtype: str
+        """
+        return self._role
+
+    @role.setter
+    def role(self, role):
+        """
+        Sets the role of this Message.
+        The role of the sender of this message.
+
+
+        :param role: The role of this Message.
+        :type: str
+        """
+        allowed_values = ["USER", "AGENT"]
+        if not value_allowed_none_or_none_sentinel(role, allowed_values):
+            role = 'UNKNOWN_ENUM_VALUE'
+        self._role = role
+
+    @property
+    def content(self):
+        """
+        **[Required]** Gets the content of this Message.
+
+        :return: The content of this Message.
+        :rtype: oci.generative_ai_agent_runtime.models.MessageContent
+        """
+        return self._content
+
+    @content.setter
+    def content(self, content):
+        """
+        Sets the content of this Message.
+
+        :param content: The content of this Message.
+        :type: oci.generative_ai_agent_runtime.models.MessageContent
+        """
+        self._content = content
+
+    @property
+    def time_created(self):
+        """
+        Gets the time_created of this Message.
+        The date and time that the message was created in the format of an RFC3339 datetime string.
+
+
+        :return: The time_created of this Message.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this Message.
+        The date and time that the message was created in the format of an RFC3339 datetime string.
+
+
+        :param time_created: The time_created of this Message.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    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/message_content.py

@@ -0,0 +1,103 @@
+# 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 MessageContent(object):
+    """
+    The content of the message.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new MessageContent object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param text:
+            The value to assign to the text property of this MessageContent.
+        :type text: str
+
+        :param citations:
+            The value to assign to the citations property of this MessageContent.
+        :type citations: list[oci.generative_ai_agent_runtime.models.Citation]
+
+        """
+        self.swagger_types = {
+            'text': 'str',
+            'citations': 'list[Citation]'
+        }
+
+        self.attribute_map = {
+            'text': 'text',
+            'citations': 'citations'
+        }
+
+        self._text = None
+        self._citations = None
+
+    @property
+    def text(self):
+        """
+        **[Required]** Gets the text of this MessageContent.
+        The content of the message.
+
+
+        :return: The text of this MessageContent.
+        :rtype: str
+        """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        """
+        Sets the text of this MessageContent.
+        The content of the message.
+
+
+        :param text: The text of this MessageContent.
+        :type: str
+        """
+        self._text = text
+
+    @property
+    def citations(self):
+        """
+        Gets the citations of this MessageContent.
+        Citations to data sources used for generating an agent's message.
+
+
+        :return: The citations of this MessageContent.
+        :rtype: list[oci.generative_ai_agent_runtime.models.Citation]
+        """
+        return self._citations
+
+    @citations.setter
+    def citations(self, citations):
+        """
+        Sets the citations of this MessageContent.
+        Citations to data sources used for generating an agent's message.
+
+
+        :param citations: The citations of this MessageContent.
+        :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/oci_database_source_location.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 .source_location import SourceLocation
+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 OciDatabaseSourceLocation(SourceLocation):
+    """
+    The location of the OCI Database that the agent will use.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new OciDatabaseSourceLocation object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.OciDatabaseSourceLocation.source_location_type` attribute
+        of this class is ``OCI_DATABASE`` and it should not be changed.
+        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 OciDatabaseSourceLocation.
+            Allowed values for this property are: "OCI_OBJECT_STORAGE", "OCI_OPEN_SEARCH", "OCI_DATABASE"
+        :type source_location_type: str
+
+        :param id:
+            The value to assign to the id property of this OciDatabaseSourceLocation.
+        :type id: str
+
+        :param function_name:
+            The value to assign to the function_name property of this OciDatabaseSourceLocation.
+        :type function_name: str
+
+        :param url:
+            The value to assign to the url property of this OciDatabaseSourceLocation.
+        :type url: str
+
+        """
+        self.swagger_types = {
+            'source_location_type': 'str',
+            'id': 'str',
+            'function_name': 'str',
+            'url': 'str'
+        }
+
+        self.attribute_map = {
+            'source_location_type': 'sourceLocationType',
+            'id': 'id',
+            'function_name': 'functionName',
+            'url': 'url'
+        }
+
+        self._source_location_type = None
+        self._id = None
+        self._function_name = None
+        self._url = None
+        self._source_location_type = 'OCI_DATABASE'
+
+    @property
+    def id(self):
+        """
+        Gets the id of this OciDatabaseSourceLocation.
+        The OCID of the `OCI Database Tools Connection`__.
+
+        __ https://docs.cloud.oracle.com/iaas/database-tools/home.htm
+
+
+        :return: The id of this OciDatabaseSourceLocation.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this OciDatabaseSourceLocation.
+        The OCID of the `OCI Database Tools Connection`__.
+
+        __ https://docs.cloud.oracle.com/iaas/database-tools/home.htm
+
+
+        :param id: The id of this OciDatabaseSourceLocation.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def function_name(self):
+        """
+        Gets the function_name of this OciDatabaseSourceLocation.
+        The name of the function that returns source text.
+
+
+        :return: The function_name of this OciDatabaseSourceLocation.
+        :rtype: str
+        """
+        return self._function_name
+
+    @function_name.setter
+    def function_name(self, function_name):
+        """
+        Sets the function_name of this OciDatabaseSourceLocation.
+        The name of the function that returns source text.
+
+
+        :param function_name: The function_name of this OciDatabaseSourceLocation.
+        :type: str
+        """
+        self._function_name = function_name
+
+    @property
+    def url(self):
+        """
+        Gets the url of this OciDatabaseSourceLocation.
+        The URL of the retrieved document, if available.
+
+
+        :return: The url of this OciDatabaseSourceLocation.
+        :rtype: str
+        """
+        return self._url
+
+    @url.setter
+    def url(self, url):
+        """
+        Sets the url of this OciDatabaseSourceLocation.
+        The URL of the retrieved document, if available.
+
+
+        :param url: The url of this OciDatabaseSourceLocation.
+        :type: str
+        """
+        self._url = url
+
+    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/oci_object_storage_source_location.py

@@ -0,0 +1,82 @@
+# 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 .source_location import SourceLocation
+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 OciObjectStorageSourceLocation(SourceLocation):
+    """
+    The OCI Object Storage that contains the data files.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new OciObjectStorageSourceLocation object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.OciObjectStorageSourceLocation.source_location_type` attribute
+        of this class is ``OCI_OBJECT_STORAGE`` and it should not be changed.
+        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 OciObjectStorageSourceLocation.
+            Allowed values for this property are: "OCI_OBJECT_STORAGE", "OCI_OPEN_SEARCH", "OCI_DATABASE"
+        :type source_location_type: str
+
+        :param url:
+            The value to assign to the url property of this OciObjectStorageSourceLocation.
+        :type url: str
+
+        """
+        self.swagger_types = {
+            'source_location_type': 'str',
+            'url': 'str'
+        }
+
+        self.attribute_map = {
+            'source_location_type': 'sourceLocationType',
+            'url': 'url'
+        }
+
+        self._source_location_type = None
+        self._url = None
+        self._source_location_type = 'OCI_OBJECT_STORAGE'
+
+    @property
+    def url(self):
+        """
+        Gets the url of this OciObjectStorageSourceLocation.
+        The URL of the OCI Object Storage data source.
+
+
+        :return: The url of this OciObjectStorageSourceLocation.
+        :rtype: str
+        """
+        return self._url
+
+    @url.setter
+    def url(self, url):
+        """
+        Sets the url of this OciObjectStorageSourceLocation.
+        The URL of the OCI Object Storage data source.
+
+
+        :param url: The url of this OciObjectStorageSourceLocation.
+        :type: str
+        """
+        self._url = url
+
+    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/oci_open_search_source_location.py

@@ -0,0 +1,144 @@
+# 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 .source_location import SourceLocation
+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 OciOpenSearchSourceLocation(SourceLocation):
+    """
+    The location of the OCI Search with OpenSearch that the agent will use.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new OciOpenSearchSourceLocation object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.OciOpenSearchSourceLocation.source_location_type` attribute
+        of this class is ``OCI_OPEN_SEARCH`` and it should not be changed.
+        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 OciOpenSearchSourceLocation.
+            Allowed values for this property are: "OCI_OBJECT_STORAGE", "OCI_OPEN_SEARCH", "OCI_DATABASE"
+        :type source_location_type: str
+
+        :param id:
+            The value to assign to the id property of this OciOpenSearchSourceLocation.
+        :type id: str
+
+        :param index_name:
+            The value to assign to the index_name property of this OciOpenSearchSourceLocation.
+        :type index_name: str
+
+        :param url:
+            The value to assign to the url property of this OciOpenSearchSourceLocation.
+        :type url: str
+
+        """
+        self.swagger_types = {
+            'source_location_type': 'str',
+            'id': 'str',
+            'index_name': 'str',
+            'url': 'str'
+        }
+
+        self.attribute_map = {
+            'source_location_type': 'sourceLocationType',
+            'id': 'id',
+            'index_name': 'indexName',
+            'url': 'url'
+        }
+
+        self._source_location_type = None
+        self._id = None
+        self._index_name = None
+        self._url = None
+        self._source_location_type = 'OCI_OPEN_SEARCH'
+
+    @property
+    def id(self):
+        """
+        Gets the id of this OciOpenSearchSourceLocation.
+        The OCID of the OCI OpenSearch cluster.
+
+
+        :return: The id of this OciOpenSearchSourceLocation.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this OciOpenSearchSourceLocation.
+        The OCID of the OCI OpenSearch cluster.
+
+
+        :param id: The id of this OciOpenSearchSourceLocation.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def index_name(self):
+        """
+        Gets the index_name of this OciOpenSearchSourceLocation.
+        The name of the index in OpenSearch that contains the source text.
+
+
+        :return: The index_name of this OciOpenSearchSourceLocation.
+        :rtype: str
+        """
+        return self._index_name
+
+    @index_name.setter
+    def index_name(self, index_name):
+        """
+        Sets the index_name of this OciOpenSearchSourceLocation.
+        The name of the index in OpenSearch that contains the source text.
+
+
+        :param index_name: The index_name of this OciOpenSearchSourceLocation.
+        :type: str
+        """
+        self._index_name = index_name
+
+    @property
+    def url(self):
+        """
+        Gets the url of this OciOpenSearchSourceLocation.
+        The URL of the retrieved document, if available.
+
+
+        :return: The url of this OciOpenSearchSourceLocation.
+        :rtype: str
+        """
+        return self._url
+
+    @url.setter
+    def url(self, url):
+        """
+        Sets the url of this OciOpenSearchSourceLocation.
+        The URL of the retrieved document, if available.
+
+
+        :param url: The url of this OciOpenSearchSourceLocation.
+        :type: str
+        """
+        self._url = url
+
+    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