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

oci/generative_ai_agent/models/database_function.py

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

oci/generative_ai_agent/models/database_tool_connection.py

@@ -0,0 +1,88 @@
+# 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 .database_connection import DatabaseConnection
+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 DatabaseToolConnection(DatabaseConnection):
+    """
+    **DatabaseToolConnection**
+
+    The details of the customer Database Tools Connection.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new DatabaseToolConnection object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent.models.DatabaseToolConnection.connection_type` attribute
+        of this class is ``DATABASE_TOOL_CONNECTION`` and it should not be changed.
+        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 DatabaseToolConnection.
+            Allowed values for this property are: "DATABASE_TOOL_CONNECTION"
+        :type connection_type: str
+
+        :param connection_id:
+            The value to assign to the connection_id property of this DatabaseToolConnection.
+        :type connection_id: str
+
+        """
+        self.swagger_types = {
+            'connection_type': 'str',
+            'connection_id': 'str'
+        }
+
+        self.attribute_map = {
+            'connection_type': 'connectionType',
+            'connection_id': 'connectionId'
+        }
+
+        self._connection_type = None
+        self._connection_id = None
+        self._connection_type = 'DATABASE_TOOL_CONNECTION'
+
+    @property
+    def connection_id(self):
+        """
+        **[Required]** Gets the connection_id of this DatabaseToolConnection.
+        The `OCID`__ of the Database Tools Connection.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The connection_id of this DatabaseToolConnection.
+        :rtype: str
+        """
+        return self._connection_id
+
+    @connection_id.setter
+    def connection_id(self, connection_id):
+        """
+        Sets the connection_id of this DatabaseToolConnection.
+        The `OCID`__ of the Database Tools Connection.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param connection_id: The connection_id of this DatabaseToolConnection.
+        :type: str
+        """
+        self._connection_id = connection_id
+
+    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/default_index_config.py

@@ -0,0 +1,84 @@
+# 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 .index_config import IndexConfig
+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 DefaultIndexConfig(IndexConfig):
+    """
+    **DefaultIndexConfig**
+
+    The default index is service managed vector store on behalf of the customer.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new DefaultIndexConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent.models.DefaultIndexConfig.index_config_type` attribute
+        of this class is ``DEFAULT_INDEX_CONFIG`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param index_config_type:
+            The value to assign to the index_config_type property of this DefaultIndexConfig.
+            Allowed values for this property are: "DEFAULT_INDEX_CONFIG", "OCI_OPEN_SEARCH_INDEX_CONFIG", "OCI_DATABASE_CONFIG"
+        :type index_config_type: str
+
+        :param should_enable_hybrid_search:
+            The value to assign to the should_enable_hybrid_search property of this DefaultIndexConfig.
+        :type should_enable_hybrid_search: bool
+
+        """
+        self.swagger_types = {
+            'index_config_type': 'str',
+            'should_enable_hybrid_search': 'bool'
+        }
+
+        self.attribute_map = {
+            'index_config_type': 'indexConfigType',
+            'should_enable_hybrid_search': 'shouldEnableHybridSearch'
+        }
+
+        self._index_config_type = None
+        self._should_enable_hybrid_search = None
+        self._index_config_type = 'DEFAULT_INDEX_CONFIG'
+
+    @property
+    def should_enable_hybrid_search(self):
+        """
+        Gets the should_enable_hybrid_search of this DefaultIndexConfig.
+        Whether to enable Hybrid search in service managed OpenSearch.
+
+
+        :return: The should_enable_hybrid_search of this DefaultIndexConfig.
+        :rtype: bool
+        """
+        return self._should_enable_hybrid_search
+
+    @should_enable_hybrid_search.setter
+    def should_enable_hybrid_search(self, should_enable_hybrid_search):
+        """
+        Sets the should_enable_hybrid_search of this DefaultIndexConfig.
+        Whether to enable Hybrid search in service managed OpenSearch.
+
+
+        :param should_enable_hybrid_search: The should_enable_hybrid_search of this DefaultIndexConfig.
+        :type: bool
+        """
+        self._should_enable_hybrid_search = should_enable_hybrid_search
+
+    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/idcs_secret.py

@@ -0,0 +1,181 @@
+# 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 .secret_detail import SecretDetail
+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 IdcsSecret(SecretDetail):
+    """
+    **IdcsSecret**
+
+    The details of IDCS configured as OpenID setting in OpenSearch.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new IdcsSecret object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent.models.IdcsSecret.type` attribute
+        of this class is ``IDCS_SECRET`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this IdcsSecret.
+            Allowed values for this property are: "IDCS_SECRET", "BASIC_AUTH_SECRET"
+        :type type: str
+
+        :param idcs_url:
+            The value to assign to the idcs_url property of this IdcsSecret.
+        :type idcs_url: str
+
+        :param client_id:
+            The value to assign to the client_id property of this IdcsSecret.
+        :type client_id: str
+
+        :param vault_secret_id:
+            The value to assign to the vault_secret_id property of this IdcsSecret.
+        :type vault_secret_id: str
+
+        :param scope_url:
+            The value to assign to the scope_url property of this IdcsSecret.
+        :type scope_url: str
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'idcs_url': 'str',
+            'client_id': 'str',
+            'vault_secret_id': 'str',
+            'scope_url': 'str'
+        }
+
+        self.attribute_map = {
+            'type': 'type',
+            'idcs_url': 'idcsUrl',
+            'client_id': 'clientId',
+            'vault_secret_id': 'vaultSecretId',
+            'scope_url': 'scopeUrl'
+        }
+
+        self._type = None
+        self._idcs_url = None
+        self._client_id = None
+        self._vault_secret_id = None
+        self._scope_url = None
+        self._type = 'IDCS_SECRET'
+
+    @property
+    def idcs_url(self):
+        """
+        **[Required]** Gets the idcs_url of this IdcsSecret.
+        The URL represent authentication url of the IDCS.
+
+
+        :return: The idcs_url of this IdcsSecret.
+        :rtype: str
+        """
+        return self._idcs_url
+
+    @idcs_url.setter
+    def idcs_url(self, idcs_url):
+        """
+        Sets the idcs_url of this IdcsSecret.
+        The URL represent authentication url of the IDCS.
+
+
+        :param idcs_url: The idcs_url of this IdcsSecret.
+        :type: str
+        """
+        self._idcs_url = idcs_url
+
+    @property
+    def client_id(self):
+        """
+        **[Required]** Gets the client_id of this IdcsSecret.
+        The IDCS Connect clientId.
+
+
+        :return: The client_id of this IdcsSecret.
+        :rtype: str
+        """
+        return self._client_id
+
+    @client_id.setter
+    def client_id(self, client_id):
+        """
+        Sets the client_id of this IdcsSecret.
+        The IDCS Connect clientId.
+
+
+        :param client_id: The client_id of this IdcsSecret.
+        :type: str
+        """
+        self._client_id = client_id
+
+    @property
+    def vault_secret_id(self):
+        """
+        **[Required]** Gets the vault_secret_id of this IdcsSecret.
+        The `OCID`__ of the secret for client secret.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The vault_secret_id of this IdcsSecret.
+        :rtype: str
+        """
+        return self._vault_secret_id
+
+    @vault_secret_id.setter
+    def vault_secret_id(self, vault_secret_id):
+        """
+        Sets the vault_secret_id of this IdcsSecret.
+        The `OCID`__ of the secret for client secret.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param vault_secret_id: The vault_secret_id of this IdcsSecret.
+        :type: str
+        """
+        self._vault_secret_id = vault_secret_id
+
+    @property
+    def scope_url(self):
+        """
+        **[Required]** Gets the scope_url of this IdcsSecret.
+        Fully qualified scope url
+
+
+        :return: The scope_url of this IdcsSecret.
+        :rtype: str
+        """
+        return self._scope_url
+
+    @scope_url.setter
+    def scope_url(self, scope_url):
+        """
+        Sets the scope_url of this IdcsSecret.
+        Fully qualified scope url
+
+
+        :param scope_url: The scope_url of this IdcsSecret.
+        :type: str
+        """
+        self._scope_url = scope_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/models/index.py

@@ -0,0 +1,101 @@
+# 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 Index(object):
+    """
+    **Index**
+
+    OCI OpenSearch index details.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Index object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param name:
+            The value to assign to the name property of this Index.
+        :type name: str
+
+        :param schema:
+            The value to assign to the schema property of this Index.
+        :type schema: oci.generative_ai_agent.models.IndexSchema
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'schema': 'IndexSchema'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'schema': 'schema'
+        }
+
+        self._name = None
+        self._schema = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this Index.
+        The index name in opensearch.
+
+
+        :return: The name of this Index.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this Index.
+        The index name in opensearch.
+
+
+        :param name: The name of this Index.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def schema(self):
+        """
+        **[Required]** Gets the schema of this Index.
+
+        :return: The schema of this Index.
+        :rtype: oci.generative_ai_agent.models.IndexSchema
+        """
+        return self._schema
+
+    @schema.setter
+    def schema(self, schema):
+        """
+        Sets the schema of this Index.
+
+        :param schema: The schema of this Index.
+        :type: oci.generative_ai_agent.models.IndexSchema
+        """
+        self._schema = schema
+
+    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/index_config.py

@@ -0,0 +1,127 @@
+# 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 IndexConfig(object):
+    """
+    **IndexConfig**
+
+    The index configuration of Knowledge bases.
+    """
+
+    #: A constant which can be used with the index_config_type property of a IndexConfig.
+    #: This constant has a value of "DEFAULT_INDEX_CONFIG"
+    INDEX_CONFIG_TYPE_DEFAULT_INDEX_CONFIG = "DEFAULT_INDEX_CONFIG"
+
+    #: A constant which can be used with the index_config_type property of a IndexConfig.
+    #: This constant has a value of "OCI_OPEN_SEARCH_INDEX_CONFIG"
+    INDEX_CONFIG_TYPE_OCI_OPEN_SEARCH_INDEX_CONFIG = "OCI_OPEN_SEARCH_INDEX_CONFIG"
+
+    #: A constant which can be used with the index_config_type property of a IndexConfig.
+    #: This constant has a value of "OCI_DATABASE_CONFIG"
+    INDEX_CONFIG_TYPE_OCI_DATABASE_CONFIG = "OCI_DATABASE_CONFIG"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new IndexConfig 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.DefaultIndexConfig`
+        * :class:`~oci.generative_ai_agent.models.OciDatabaseConfig`
+        * :class:`~oci.generative_ai_agent.models.OciOpenSearchIndexConfig`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param index_config_type:
+            The value to assign to the index_config_type property of this IndexConfig.
+            Allowed values for this property are: "DEFAULT_INDEX_CONFIG", "OCI_OPEN_SEARCH_INDEX_CONFIG", "OCI_DATABASE_CONFIG", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type index_config_type: str
+
+        """
+        self.swagger_types = {
+            'index_config_type': 'str'
+        }
+
+        self.attribute_map = {
+            'index_config_type': 'indexConfigType'
+        }
+
+        self._index_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['indexConfigType']
+
+        if type == 'DEFAULT_INDEX_CONFIG':
+            return 'DefaultIndexConfig'
+
+        if type == 'OCI_DATABASE_CONFIG':
+            return 'OciDatabaseConfig'
+
+        if type == 'OCI_OPEN_SEARCH_INDEX_CONFIG':
+            return 'OciOpenSearchIndexConfig'
+        else:
+            return 'IndexConfig'
+
+    @property
+    def index_config_type(self):
+        """
+        **[Required]** Gets the index_config_type of this IndexConfig.
+        The type of index.
+        The allowed values are:
+        - `DEFAULT_INDEX_CONFIG`: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
+        - `OCI_OPEN_SEARCH_INDEX_CONFIG`: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
+        - `OCI_DATABASE_CONFIG`: OciDatabaseConfig allows customer to configure their Database.
+
+        Allowed values for this property are: "DEFAULT_INDEX_CONFIG", "OCI_OPEN_SEARCH_INDEX_CONFIG", "OCI_DATABASE_CONFIG", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The index_config_type of this IndexConfig.
+        :rtype: str
+        """
+        return self._index_config_type
+
+    @index_config_type.setter
+    def index_config_type(self, index_config_type):
+        """
+        Sets the index_config_type of this IndexConfig.
+        The type of index.
+        The allowed values are:
+        - `DEFAULT_INDEX_CONFIG`: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
+        - `OCI_OPEN_SEARCH_INDEX_CONFIG`: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
+        - `OCI_DATABASE_CONFIG`: OciDatabaseConfig allows customer to configure their Database.
+
+
+        :param index_config_type: The index_config_type of this IndexConfig.
+        :type: str
+        """
+        allowed_values = ["DEFAULT_INDEX_CONFIG", "OCI_OPEN_SEARCH_INDEX_CONFIG", "OCI_DATABASE_CONFIG"]
+        if not value_allowed_none_or_none_sentinel(index_config_type, allowed_values):
+            index_config_type = 'UNKNOWN_ENUM_VALUE'
+        self._index_config_type = index_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