select-ai 1.0.0.dev5__py3-none-any.whl → 1.0.0.dev6__py3-none-any.whl

select_ai/__init__.py

@@ -21,9 +21,11 @@ from .conversation import (
 from .db import (
     async_connect,
     async_cursor,
+    async_disconnect,
     async_is_connected,
     connect,
     cursor,
+    disconnect,
     is_connected,
 )
 from .profile import Profile

select_ai/_abc.py

@@ -19,13 +19,14 @@ def _bool(value: Any) -> bool:
         return value
     if isinstance(value, int):
         return bool(value)
-    if value.lower() in ('yes', 'true', 't', 'y', '1'):
+    if value.lower() in ("yes", "true", "t", "y", "1"):
         return True
-    elif value.lower() in ('no', 'false', 'f', 'n', '0'):
+    elif value.lower() in ("no", "false", "f", "n", "0"):
         return False
     else:
         raise ValueError(f"Invalid boolean value: {value}")
 
+
 @dataclass
 class SelectAIDataClass(ABC):
     """SelectAIDataClass is an abstract container for all data
@@ -72,3 +73,5 @@ class SelectAIDataClass(ABC):
                     List[typing.Mapping]
                 ] and isinstance(value, (str, bytes, bytearray)):
                     setattr(self, field.name, json.loads(value))
+                else:
+                    setattr(self, field.name, value)

select_ai/admin.py

@@ -5,7 +5,7 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-from typing import List, Mapping
+from typing import List, Mapping, Union
 
 import oracledb
 
@@ -70,13 +70,17 @@ def create_credential(credential: Mapping, replace: bool = False):
                 raise
 
 
-def enable_provider(users: List[str], provider_endpoint: str = None):
+def enable_provider(
+    users: Union[str, List[str]], provider_endpoint: str = None
+):
     """
     Enables AI profile for the user. This method grants execute privilege
     on the packages DBMS_CLOUD, DBMS_CLOUD_AI and DBMS_CLOUD_PIPELINE. It
     also enables the user to invoke the AI(LLM) endpoint hosted at a
     certain domain
     """
+    if isinstance(users, str):
+        users = [users]
 
     with cursor() as cr:
         for user in users:
@@ -89,13 +93,17 @@ def enable_provider(users: List[str], provider_endpoint: str = None):
                 )
 
 
-def disable_provider(users: List[str], provider_endpoint: str = None):
+def disable_provider(
+    users: Union[str, List[str]], provider_endpoint: str = None
+):
     """
     Disables AI provider for the user. This method revokes execute privilege
     on the packages DBMS_CLOUD, DBMS_CLOUD_AI and DBMS_CLOUD_PIPELINE. It
     also disables the user to invoke the AI(LLM) endpoint hosted at a
     certain domain
     """
+    if isinstance(users, str):
+        users = [users]
 
     with cursor() as cr:
         for user in users:

select_ai/async_profile.py

@@ -24,9 +24,10 @@ from select_ai.action import Action
 from select_ai.base_profile import BaseProfile, ProfileAttributes
 from select_ai.conversation import AsyncConversation
 from select_ai.db import async_cursor, async_get_connection
-from select_ai.errors import ProfileNotFoundError
+from select_ai.errors import ProfileExistsError, ProfileNotFoundError
 from select_ai.provider import Provider
 from select_ai.sql import (
+    GET_USER_AI_PROFILE,
     GET_USER_AI_PROFILE_ATTRIBUTES,
     LIST_USER_AI_PROFILES,
 )
@@ -61,6 +62,18 @@ class AsyncProfile(BaseProfile):
                     profile_name=self.profile_name
                 )
                 profile_exists = True
+                if not self.replace and not self.merge:
+                    if (
+                        self.attributes is not None
+                        or self.description is not None
+                    ):
+                        if self.raise_error_if_exists:
+                            raise ProfileExistsError(self.profile_name)
+
+                if self.description is None:
+                    self.description = await self._get_profile_description(
+                        profile_name=self.profile_name
+                    )
             except ProfileNotFoundError:
                 if self.attributes is None:
                     raise
@@ -80,6 +93,27 @@ class AsyncProfile(BaseProfile):
                 )
         return self
 
+    @staticmethod
+    async def _get_profile_description(profile_name) -> str:
+        """Get description of profile from USER_CLOUD_AI_PROFILES
+
+        :param str profile_name: Name of profile
+        :return: Description of profile
+        :rtype: str
+        :raises: ProfileNotFoundError
+
+        """
+        async with async_cursor() as cr:
+            await cr.execute(
+                GET_USER_AI_PROFILE,
+                profile_name=profile_name.upper(),
+            )
+            profile = await cr.fetchone()
+            if profile:
+                return await profile[1].read()
+            else:
+                raise ProfileNotFoundError(profile_name)
+
     @staticmethod
     async def _get_attributes(profile_name) -> ProfileAttributes:
         """Asynchronously gets AI profile attributes from the Database
@@ -264,6 +298,7 @@ class AsyncProfile(BaseProfile):
                     profile_name=profile_name,
                     description=description,
                     attributes=attributes,
+                    raise_error_if_exists=False,
                 )
 
     async def generate(

select_ai/base_profile.py

@@ -72,6 +72,13 @@ class ProfileAttributes(SelectAIDataClass):
     temperature: Optional[float] = None
     vector_index_name: Optional[str] = None
 
+    def __post_init__(self):
+        if not isinstance(self.provider, Provider):
+            raise ValueError(
+                f"The arg `provider` must be an object of "
+                f"type select_ai.Provider"
+            )
+
     def json(self, exclude_null=True):
         attributes = {}
         for k, v in self.dict(exclude_null=exclude_null).items():
@@ -136,12 +143,16 @@ class BaseProfile(ABC):
     :param str description: Description of the profile
 
     :param bool merge: Fetches the profile
-     from database, merges the attributes and saves it back
+     from database, merges the non-null attributes and saves it back
      in the database. Default value is False
 
     :param bool replace: Replaces the profile and attributes
      in the database. Default value is False
 
+    :param bool  raise_error_if_exists: Raise ProfileExistsError
+     if profile exists in the database and replace = False and
+     merge = False. Default value is True
+
     """
 
     def __init__(
@@ -151,6 +162,7 @@ class BaseProfile(ABC):
         description: Optional[str] = None,
         merge: Optional[bool] = False,
         replace: Optional[bool] = False,
+        raise_error_if_exists: Optional[bool] = True,
     ):
         """Initialize a base profile"""
         self.profile_name = profile_name
@@ -158,6 +170,7 @@ class BaseProfile(ABC):
         self.description = description
         self.merge = merge
         self.replace = replace
+        self.raise_error_if_exists = raise_error_if_exists
 
     def __repr__(self):
         return (

select_ai/conversation.py

@@ -5,6 +5,8 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+import datetime
+import json
 from dataclasses import dataclass
 from typing import AsyncGenerator, Iterator, Optional
 
@@ -27,17 +29,28 @@ class ConversationAttributes(SelectAIDataClass):
 
     :param str title: Conversation Title
     :param str description: Description of the conversation topic
-    :param int retention_days: The number of days the conversation will be
-     stored in the database from its creation date. If value is 0, we will
-     not remove the conversation unless it is manually deleted by
-     drop_conversation
+    :param datetime.timedelta retention_days: The number of days the conversation
+     will be stored in the database from its creation date. If value is 0, the
+     conversation will not be removed unless it is manually deleted by
+     delete
+    :param int conversation_length: Number of prompts to store for this
+     conversation
 
     """
 
     title: Optional[str] = "New Conversation"
     description: Optional[str] = None
-    retention_days: Optional[int] = 7
-    # conversation_length: Optional[int] = 10
+    retention_days: Optional[datetime.timedelta] = datetime.timedelta(days=7)
+    conversation_length: Optional[int] = 10
+
+    def json(self, exclude_null=True):
+        attributes = {}
+        for k, v in self.dict(exclude_null=exclude_null).items():
+            if isinstance(v, datetime.timedelta):
+                attributes[k] = v.days
+            else:
+                attributes[k] = v
+        return json.dumps(attributes)
 
 
 class _BaseConversation:

select_ai/db.py

@@ -12,6 +12,8 @@ from typing import Dict, Hashable
 
 import oracledb
 
+from select_ai.errors import DatabaseNotConnectedError
+
 __conn__: Dict[Hashable, oracledb.Connection] = {}
 __async_conn__: Dict[Hashable, oracledb.AsyncConnection] = {}
 
@@ -24,6 +26,8 @@ __all__ = [
     "async_get_connection",
     "cursor",
     "async_cursor",
+    "disconnect",
+    "async_disconnect",
 ]
 
 
@@ -109,10 +113,7 @@ def _set_connection(
 def get_connection() -> oracledb.Connection:
     """Returns the connection object if connection is healthy"""
     if not is_connected():
-        raise Exception(
-            "Not connected to the Database. "
-            "Use select_ai.db.connect() to establish connection"
-        )
+        raise DatabaseNotConnectedError()
     global __conn__
     key = (os.getpid(), get_ident())
     return __conn__[key]
@@ -121,11 +122,7 @@ def get_connection() -> oracledb.Connection:
 async def async_get_connection() -> oracledb.AsyncConnection:
     """Returns the AsyncConnection object if connection is healthy"""
     if not await async_is_connected():
-        raise Exception(
-            "Not connected to the Database. "
-            "Use select_ai.db.async_connect() to establish "
-            "connection"
-        )
+        raise DatabaseNotConnectedError()
     global __async_conn__
     key = (os.getpid(), get_ident())
     return __async_conn__[key]
@@ -169,3 +166,21 @@ async def async_cursor():
         yield cr
     finally:
         cr.close()
+
+
+def disconnect():
+    try:
+        conn = get_connection()
+    except DatabaseNotConnectedError:
+        pass
+    else:
+        conn.close()
+
+
+async def async_disconnect():
+    try:
+        conn = await async_get_connection()
+    except DatabaseNotConnectedError:
+        pass
+    else:
+        await conn.close()

select_ai/errors.py

@@ -12,6 +12,17 @@ class SelectAIError(Exception):
     pass
 
 
+class DatabaseNotConnectedError(SelectAIError):
+    """Raised when a database is not connected"""
+
+    def __str__(self):
+        return (
+            "Not connected to the Database. "
+            "Use select_ai.connect() or select_ai.async_connect() "
+            "to establish connection"
+        )
+
+
 class ConversationNotFoundError(SelectAIError):
     """Conversation not found in the database"""
 
@@ -32,6 +43,19 @@ class ProfileNotFoundError(SelectAIError):
         return f"Profile {self.profile_name} not found"
 
 
+class ProfileExistsError(SelectAIError):
+    """Profile already exists in the database"""
+
+    def __init__(self, profile_name: str):
+        self.profile_name = profile_name
+
+    def __str__(self):
+        return (
+            f"Profile {self.profile_name} already exists. "
+            f"Use either replace=True or merge=True"
+        )
+
+
 class VectorIndexNotFoundError(SelectAIError):
     """VectorIndex not found in the database"""
 

select_ai/profile.py

@@ -17,9 +17,10 @@ from select_ai import Conversation
 from select_ai.action import Action
 from select_ai.base_profile import BaseProfile, ProfileAttributes
 from select_ai.db import cursor
-from select_ai.errors import ProfileNotFoundError
+from select_ai.errors import ProfileExistsError, ProfileNotFoundError
 from select_ai.provider import Provider
 from select_ai.sql import (
+    GET_USER_AI_PROFILE,
     GET_USER_AI_PROFILE_ATTRIBUTES,
     LIST_USER_AI_PROFILES,
 )
@@ -50,6 +51,18 @@ class Profile(BaseProfile):
                     profile_name=self.profile_name
                 )
                 profile_exists = True
+                if not self.replace and not self.merge:
+                    if (
+                        self.attributes is not None
+                        or self.description is not None
+                    ):
+                        if self.raise_error_if_exists:
+                            raise ProfileExistsError(self.profile_name)
+
+                if self.description is None:
+                    self.description = self._get_profile_description(
+                        profile_name=self.profile_name
+                    )
             except ProfileNotFoundError:
                 if self.attributes is None:
                     raise
@@ -66,6 +79,22 @@ class Profile(BaseProfile):
             if self.replace or not profile_exists:
                 self.create(replace=self.replace)
 
+    @staticmethod
+    def _get_profile_description(profile_name) -> str:
+        """Get description of profile from USER_CLOUD_AI_PROFILES
+
+        :param str profile_name:
+        :return: str
+        :raises: ProfileNotFoundError
+        """
+        with cursor() as cr:
+            cr.execute(GET_USER_AI_PROFILE, profile_name=profile_name.upper())
+            profile = cr.fetchone()
+            if profile:
+                return profile[1].read()
+            else:
+                raise ProfileNotFoundError(profile_name)
+
     @staticmethod
     def _get_attributes(profile_name) -> ProfileAttributes:
         """Get AI profile attributes from the Database
@@ -237,6 +266,7 @@ class Profile(BaseProfile):
                     profile_name=profile_name,
                     description=description,
                     attributes=attributes,
+                    raise_error_if_exists=False,
                 )
 
     def generate(
@@ -354,7 +384,7 @@ class Profile(BaseProfile):
 
     def generate_synthetic_data(
         self, synthetic_data_attributes: SyntheticDataAttributes
-    ):
+    ) -> None:
         """Generate synthetic data for a single table, multiple tables or a
         full schema.
 

select_ai/provider.py

@@ -176,7 +176,6 @@ class AWSProvider(Provider):
         self.provider_endpoint = f"bedrock-runtime.{self.region}.amazonaws.com"
 
 
-
 @dataclass
 class AnthropicProvider(Provider):
     """

select_ai/sql.py

@@ -64,7 +64,7 @@ WHERE profile_name = :profile_name
 """
 
 GET_USER_AI_PROFILE = """
-SELECT count(*)
+SELECT profile_name, description
 FROM  USER_CLOUD_AI_PROFILES
 WHERE profile_name = :profile_name
 """

select_ai/vector_index.py

@@ -109,7 +109,6 @@ class OracleVectorIndexAttributes(VectorIndexAttributes):
     vector_db_provider: Optional[VectorDBProvider] = VectorDBProvider.ORACLE
 
 
-
 class _BaseVectorIndex(ABC):
 
     def __init__(
@@ -165,7 +164,7 @@ class VectorIndex(_BaseVectorIndex):
             else:
                 raise VectorIndexNotFoundError(index_name=index_name)
 
-    def create(self, replace=False):
+    def create(self, replace: Optional[bool] = False):
         """Create a vector index in the database and populates the index
          with data from an object store bucket using an async scheduler job
 
@@ -204,7 +203,9 @@ class VectorIndex(_BaseVectorIndex):
         self.profile.set_attribute("vector_index_name", self.index_name)
 
     def delete(
-        self, include_data: Optional[int] = True, force: Optional[int] = False
+        self,
+        include_data: Optional[bool] = True,
+        force: Optional[bool] = False,
     ):
         """This procedure removes a vector store index
 
@@ -370,7 +371,7 @@ class AsyncVectorIndex(_BaseVectorIndex):
             else:
                 raise VectorIndexNotFoundError(index_name=index_name)
 
-    async def create(self, replace: Optional[int] = False) -> None:
+    async def create(self, replace: Optional[bool] = False) -> None:
         """Create a vector index in the database and populates it with data
         from an object store bucket using an async scheduler job
 
@@ -407,7 +408,9 @@ class AsyncVectorIndex(_BaseVectorIndex):
         await self.profile.set_attribute("vector_index_name", self.index_name)
 
     async def delete(
-        self, include_data: Optional[int] = True, force: Optional[int] = False
+        self,
+        include_data: Optional[bool] = True,
+        force: Optional[bool] = False,
     ) -> None:
         """This procedure removes a vector store index.
 

select_ai/version.py

@@ -5,4 +5,4 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-__version__ = "1.0.0.dev5"
+__version__ = "1.0.0.dev6"

{select_ai-1.0.0.dev5.dist-info → select_ai-1.0.0.dev6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: select_ai
-Version: 1.0.0.dev5
+Version: 1.0.0.dev6
 Summary: Python API for Select AI
 Author-email: Abhishek Singh <abhishek.o.singh@oracle.com>
 Maintainer-email: Abhishek Singh <abhishek.o.singh@oracle.com>

select_ai-1.0.0.dev6.dist-info/RECORD

@@ -0,0 +1,21 @@
+select_ai/__init__.py,sha256=LVdOh_JnWEXaXs0NSflA1f0YIWCUEpTBZCvWNTvSS74,1319
+select_ai/_abc.py,sha256=ccec6yu54w5QMix_EKc_BJ_0JatUDXKjfLW9KshOGak,2692
+select_ai/_enums.py,sha256=U0UavuE4pbRY-0-Qb8z-F7KfxU0YUfOgUahaSjDi0dU,416
+select_ai/action.py,sha256=s78uhi5HHCLbTN2S5tLDSswTLUl40FZ3nESLka8CfZk,592
+select_ai/admin.py,sha256=MMkXpvVJZUoloty8HiQnndPVPpuZch22Pnk8llUhUCc,3528
+select_ai/async_profile.py,sha256=1_ds6Rej4m17cd5aaRM5LoPOIL0EL4OVYBULiCLj57M,17593
+select_ai/base_profile.py,sha256=Iyd5GdBNqEISiWCwYpGSKOGd394f-A5QgHPtuJ547CE,6791
+select_ai/conversation.py,sha256=jeZy7qtbnFTO9xTE3gNZLyxVI0Pnj_rpc0QZb1r-A00,9240
+select_ai/db.py,sha256=Q0MvoIBzE0fHP1d9oFjvnjfgKqdRk6ZCM6bERokcM3E,4669
+select_ai/errors.py,sha256=2T5eICWWjj7a907aRh7es5wTcvWm_wJiP8h0b3ipxVQ,2114
+select_ai/profile.py,sha256=lyMnS1ExRPYwS54OqlLpH3WwJxkj_epat7Z_nVDH3Os,14868
+select_ai/provider.py,sha256=7KNdU2BmUMzjPj2WAwtn0vEYPBYY83MvRTT1q2Ng5tM,5103
+select_ai/sql.py,sha256=9yCdB1H_sYpjMLs-6SB8xf5-QpTwCAx4cIgIsElvly4,2786
+select_ai/synthetic_data.py,sha256=lnjEIcUzr7lr2dO24OgxRhol-tiVOiKK-kEvFVJoiig,3078
+select_ai/vector_index.py,sha256=y6Vrky7T5qNJK_eDVBS3U7i5B-Hvq6FBUd_CjkN23bo,20212
+select_ai/version.py,sha256=4HksrDhF_YLN3qkAVlYmmmBl9tDnJJ1XbM3x2xA-XfM,348
+select_ai-1.0.0.dev6.dist-info/licenses/LICENSE.txt,sha256=_0VqOxSjO1hu6JexZDVzqUXSmzH1A53EOfyiJzXTBKc,1840
+select_ai-1.0.0.dev6.dist-info/METADATA,sha256=P_89Il0dtluoQWFYZpexYhvfs18iymZT05A0hI3cKe4,1016
+select_ai-1.0.0.dev6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+select_ai-1.0.0.dev6.dist-info/top_level.txt,sha256=u_QUAHDibro58Lvi_MU6a9Wc6VfQT8HEQm0cciMTP-c,10
+select_ai-1.0.0.dev6.dist-info/RECORD,,

select_ai-1.0.0.dev5.dist-info/RECORD

@@ -1,21 +0,0 @@
-select_ai/__init__.py,sha256=JPm7f3IjEos8cbYr_hpwQKN6_sxG_gNgZXFqDpqxvrI,1281
-select_ai/_abc.py,sha256=PQZYYz2SKchPujRe7V58rmby6IlZ9bMnNpfOQYQ_EZk,2616
-select_ai/_enums.py,sha256=U0UavuE4pbRY-0-Qb8z-F7KfxU0YUfOgUahaSjDi0dU,416
-select_ai/action.py,sha256=s78uhi5HHCLbTN2S5tLDSswTLUl40FZ3nESLka8CfZk,592
-select_ai/admin.py,sha256=87OQEVmbFs6ftV4phLGHC1NGIWvD6x2Wu4Qic2DisRI,3375
-select_ai/async_profile.py,sha256=STAV1yLxCKJbYjFtW4uViAUa8j20lzQxYoToml435BM,16293
-select_ai/base_profile.py,sha256=YzromcmBdAmO9DX86L8_wwNtHYn8nPrHvUirYoxb5fA,6269
-select_ai/conversation.py,sha256=IulU5BHbBksk1zo4ppaR85-EVd0o7VUptkdHrBjKYeg,8770
-select_ai/db.py,sha256=G7yvE9UtUFpS46yXEv0_56lTqeve5r7mVGW7b8QmbEc,4484
-select_ai/errors.py,sha256=dMWdbsdWCpBPO1OD1zkDGUymJ37iBQDjEo9kb-PwirU,1470
-select_ai/profile.py,sha256=NX5-wP-HXBZJzyX9rlNElo3MZDC3A62r9QnPJge4k34,13705
-select_ai/provider.py,sha256=ycMMGMVix-4Pc54WOJXO6e2NvYZJYrMv7o-3tUKMlEc,5104
-select_ai/sql.py,sha256=_KQeBrHy9IXMI3N7PO064wp72gBzJGPfPMMNRprpxWs,2769
-select_ai/synthetic_data.py,sha256=lnjEIcUzr7lr2dO24OgxRhol-tiVOiKK-kEvFVJoiig,3078
-select_ai/vector_index.py,sha256=WnLP2QaqQUqT8BEs_nEyv02o-JfmuYx4V0pfUlflEz0,20156
-select_ai/version.py,sha256=R0gtkgmNpwllnJqpLPgfrKjzTGo50AjJykyg8-wlUZ0,348
-select_ai-1.0.0.dev5.dist-info/licenses/LICENSE.txt,sha256=_0VqOxSjO1hu6JexZDVzqUXSmzH1A53EOfyiJzXTBKc,1840
-select_ai-1.0.0.dev5.dist-info/METADATA,sha256=4f7wh45Gv51jSHpb69BtEar0v5WwuTuDmGdMUvD9eJk,1016
-select_ai-1.0.0.dev5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-select_ai-1.0.0.dev5.dist-info/top_level.txt,sha256=u_QUAHDibro58Lvi_MU6a9Wc6VfQT8HEQm0cciMTP-c,10
-select_ai-1.0.0.dev5.dist-info/RECORD,,