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

oci/generative_ai_agent/models/data_source_config.py

@@ -0,0 +1,107 @@
+# 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 DataSourceConfig(object):
+    """
+    **DataSourceConfig**
+
+    The details of data source.
+    """
+
+    #: A constant which can be used with the data_source_config_type property of a DataSourceConfig.
+    #: This constant has a value of "OCI_OBJECT_STORAGE"
+    DATA_SOURCE_CONFIG_TYPE_OCI_OBJECT_STORAGE = "OCI_OBJECT_STORAGE"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new DataSourceConfig 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.models.OciObjectStorageDataSourceConfig`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param data_source_config_type:
+            The value to assign to the data_source_config_type property of this DataSourceConfig.
+            Allowed values for this property are: "OCI_OBJECT_STORAGE", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type data_source_config_type: str
+
+        """
+        self.swagger_types = {
+            'data_source_config_type': 'str'
+        }
+
+        self.attribute_map = {
+            'data_source_config_type': 'dataSourceConfigType'
+        }
+
+        self._data_source_config_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['dataSourceConfigType']
+
+        if type == 'OCI_OBJECT_STORAGE':
+            return 'OciObjectStorageDataSourceConfig'
+        else:
+            return 'DataSourceConfig'
+
+    @property
+    def data_source_config_type(self):
+        """
+        **[Required]** Gets the data_source_config_type of this DataSourceConfig.
+        The type of the tool.
+        The allowed values are:
+        - `OCI_OBJECT_STORAGE`: The data source is OCI Object Storage.
+
+        Allowed values for this property are: "OCI_OBJECT_STORAGE", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The data_source_config_type of this DataSourceConfig.
+        :rtype: str
+        """
+        return self._data_source_config_type
+
+    @data_source_config_type.setter
+    def data_source_config_type(self, data_source_config_type):
+        """
+        Sets the data_source_config_type of this DataSourceConfig.
+        The type of the tool.
+        The allowed values are:
+        - `OCI_OBJECT_STORAGE`: The data source is OCI Object Storage.
+
+
+        :param data_source_config_type: The data_source_config_type of this DataSourceConfig.
+        :type: str
+        """
+        allowed_values = ["OCI_OBJECT_STORAGE"]
+        if not value_allowed_none_or_none_sentinel(data_source_config_type, allowed_values):
+            data_source_config_type = 'UNKNOWN_ENUM_VALUE'
+        self._data_source_config_type = data_source_config_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/models/data_source_summary.py

@@ -0,0 +1,469 @@
+# 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 DataSourceSummary(object):
+    """
+    **DataSourceSummary**
+
+    Summary information about a data source.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new DataSourceSummary 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 DataSourceSummary.
+        :type id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this DataSourceSummary.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this DataSourceSummary.
+        :type description: str
+
+        :param knowledge_base_id:
+            The value to assign to the knowledge_base_id property of this DataSourceSummary.
+        :type knowledge_base_id: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this DataSourceSummary.
+        :type compartment_id: str
+
+        :param time_created:
+            The value to assign to the time_created property of this DataSourceSummary.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this DataSourceSummary.
+        :type time_updated: datetime
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this DataSourceSummary.
+        :type lifecycle_state: str
+
+        :param lifecycle_details:
+            The value to assign to the lifecycle_details property of this DataSourceSummary.
+        :type lifecycle_details: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this DataSourceSummary.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this DataSourceSummary.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this DataSourceSummary.
+        :type system_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'knowledge_base_id': 'str',
+            'compartment_id': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'lifecycle_state': 'str',
+            'lifecycle_details': 'str',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'system_tags': 'dict(str, dict(str, object))'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'display_name': 'displayName',
+            'description': 'description',
+            'knowledge_base_id': 'knowledgeBaseId',
+            'compartment_id': 'compartmentId',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'lifecycle_state': 'lifecycleState',
+            'lifecycle_details': 'lifecycleDetails',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags'
+        }
+
+        self._id = None
+        self._display_name = None
+        self._description = None
+        self._knowledge_base_id = None
+        self._compartment_id = None
+        self._time_created = None
+        self._time_updated = None
+        self._lifecycle_state = None
+        self._lifecycle_details = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this DataSourceSummary.
+        The `OCID`__ of the data source.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The id of this DataSourceSummary.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this DataSourceSummary.
+        The `OCID`__ of the data source.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param id: The id of this DataSourceSummary.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this DataSourceSummary.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :return: The display_name of this DataSourceSummary.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this DataSourceSummary.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :param display_name: The display_name of this DataSourceSummary.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this DataSourceSummary.
+        A description of the data source.
+
+
+        :return: The description of this DataSourceSummary.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this DataSourceSummary.
+        A description of the data source.
+
+
+        :param description: The description of this DataSourceSummary.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def knowledge_base_id(self):
+        """
+        **[Required]** Gets the knowledge_base_id of this DataSourceSummary.
+        The `OCID`__ of the parent KnowledgeBase.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The knowledge_base_id of this DataSourceSummary.
+        :rtype: str
+        """
+        return self._knowledge_base_id
+
+    @knowledge_base_id.setter
+    def knowledge_base_id(self, knowledge_base_id):
+        """
+        Sets the knowledge_base_id of this DataSourceSummary.
+        The `OCID`__ of the parent KnowledgeBase.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param knowledge_base_id: The knowledge_base_id of this DataSourceSummary.
+        :type: str
+        """
+        self._knowledge_base_id = knowledge_base_id
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this DataSourceSummary.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The compartment_id of this DataSourceSummary.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this DataSourceSummary.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param compartment_id: The compartment_id of this DataSourceSummary.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this DataSourceSummary.
+        The date and time the data source was created, in the format defined by `RFC 3339`__.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :return: The time_created of this DataSourceSummary.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this DataSourceSummary.
+        The date and time the data source was created, in the format defined by `RFC 3339`__.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :param time_created: The time_created of this DataSourceSummary.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        Gets the time_updated of this DataSourceSummary.
+        The date and time the DataSource was updated, in the format defined by `RFC 3339`__.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :return: The time_updated of this DataSourceSummary.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets the time_updated of this DataSourceSummary.
+        The date and time the DataSource was updated, in the format defined by `RFC 3339`__.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :param time_updated: The time_updated of this DataSourceSummary.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[Required]** Gets the lifecycle_state of this DataSourceSummary.
+        The current state of the data source.
+
+
+        :return: The lifecycle_state of this DataSourceSummary.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this DataSourceSummary.
+        The current state of the data source.
+
+
+        :param lifecycle_state: The lifecycle_state of this DataSourceSummary.
+        :type: str
+        """
+        self._lifecycle_state = lifecycle_state
+
+    @property
+    def lifecycle_details(self):
+        """
+        Gets the lifecycle_details of this DataSourceSummary.
+        A message that describes the current state of the data source in more detail. For example,
+        can be used to provide actionable information for a resource in the Failed state.
+
+
+        :return: The lifecycle_details of this DataSourceSummary.
+        :rtype: str
+        """
+        return self._lifecycle_details
+
+    @lifecycle_details.setter
+    def lifecycle_details(self, lifecycle_details):
+        """
+        Sets the lifecycle_details of this DataSourceSummary.
+        A message that describes the current state of the data source in more detail. For example,
+        can be used to provide actionable information for a resource in the Failed state.
+
+
+        :param lifecycle_details: The lifecycle_details of this DataSourceSummary.
+        :type: str
+        """
+        self._lifecycle_details = lifecycle_details
+
+    @property
+    def freeform_tags(self):
+        """
+        **[Required]** Gets the freeform_tags of this DataSourceSummary.
+        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+        For more information, see `Resource Tags`__.
+
+        Example: `{\"Department\": \"Finance\"}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The freeform_tags of this DataSourceSummary.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this DataSourceSummary.
+        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+        For more information, see `Resource Tags`__.
+
+        Example: `{\"Department\": \"Finance\"}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :param freeform_tags: The freeform_tags of this DataSourceSummary.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        **[Required]** Gets the defined_tags of this DataSourceSummary.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        For more information, see `Resource Tags`__.
+
+        Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The defined_tags of this DataSourceSummary.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._defined_tags
+
+    @defined_tags.setter
+    def defined_tags(self, defined_tags):
+        """
+        Sets the defined_tags of this DataSourceSummary.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        For more information, see `Resource Tags`__.
+
+        Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :param defined_tags: The defined_tags of this DataSourceSummary.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        Gets the system_tags of this DataSourceSummary.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :return: The system_tags of this DataSourceSummary.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._system_tags
+
+    @system_tags.setter
+    def system_tags(self, system_tags):
+        """
+        Sets the system_tags of this DataSourceSummary.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :param system_tags: The system_tags of this DataSourceSummary.
+        :type: dict(str, dict(str, object))
+        """
+        self._system_tags = system_tags
+
+    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/models/database_connection.py

@@ -0,0 +1,107 @@
+# 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 DatabaseConnection(object):
+    """
+    **DatabaseConnection**
+
+    The connection type for Databases.
+    """
+
+    #: A constant which can be used with the connection_type property of a DatabaseConnection.
+    #: This constant has a value of "DATABASE_TOOL_CONNECTION"
+    CONNECTION_TYPE_DATABASE_TOOL_CONNECTION = "DATABASE_TOOL_CONNECTION"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new DatabaseConnection 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.models.DatabaseToolConnection`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param connection_type:
+            The value to assign to the connection_type property of this DatabaseConnection.
+            Allowed values for this property are: "DATABASE_TOOL_CONNECTION", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type connection_type: str
+
+        """
+        self.swagger_types = {
+            'connection_type': 'str'
+        }
+
+        self.attribute_map = {
+            'connection_type': 'connectionType'
+        }
+
+        self._connection_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['connectionType']
+
+        if type == 'DATABASE_TOOL_CONNECTION':
+            return 'DatabaseToolConnection'
+        else:
+            return 'DatabaseConnection'
+
+    @property
+    def connection_type(self):
+        """
+        **[Required]** Gets the connection_type of this DatabaseConnection.
+        The type of Database connection.
+        The allowed values are:
+        - `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection.
+
+        Allowed values for this property are: "DATABASE_TOOL_CONNECTION", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The connection_type of this DatabaseConnection.
+        :rtype: str
+        """
+        return self._connection_type
+
+    @connection_type.setter
+    def connection_type(self, connection_type):
+        """
+        Sets the connection_type of this DatabaseConnection.
+        The type of Database connection.
+        The allowed values are:
+        - `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection.
+
+
+        :param connection_type: The connection_type of this DatabaseConnection.
+        :type: str
+        """
+        allowed_values = ["DATABASE_TOOL_CONNECTION"]
+        if not value_allowed_none_or_none_sentinel(connection_type, allowed_values):
+            connection_type = 'UNKNOWN_ENUM_VALUE'
+        self._connection_type = connection_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