bug fixes related to profile attributes and optional attributes

Author: aosingh

samples/async/create_ai_credential.py

@@ -0,0 +1,44 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2025, Oracle and/or its affiliates.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at
+# http://oss.oracle.com/licenses/upl.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# async/create_ai_credential.py
+#
+# Async API to create credential
+# -----------------------------------------------------------------------------
+
+import asyncio
+import os
+
+import oci
+import select_ai
+
+user = os.getenv("SELECT_AI_USER")
+password = os.getenv("SELECT_AI_PASSWORD")
+dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
+
+
+async def main():
+    await select_ai.async_connect(user=user, password=password, dsn=dsn)
+    default_config = oci.config.from_file()
+    oci.config.validate_config(default_config)
+    with open(default_config["key_file"]) as fp:
+        key_contents = fp.read()
+    credential = {
+        "credential_name": "my_oci_ai_profile_key",
+        "user_ocid": default_config["user"],
+        "tenancy_ocid": default_config["tenancy"],
+        "private_key": key_contents,
+        "fingerprint": default_config["fingerprint"],
+    }
+    await select_ai.async_create_credential(
+        credential=credential, replace=True
+    )
+    print("Created credential: ", credential["credential_name"])
+
+
+asyncio.run(main())

samples/async/delete_ai_credential.py

@@ -0,0 +1,32 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2025, Oracle and/or its affiliates.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at
+# http://oss.oracle.com/licenses/upl.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# async/create_ai_credential.py
+#
+# Async API to create credential
+# -----------------------------------------------------------------------------
+
+import asyncio
+import os
+
+import select_ai
+
+user = os.getenv("SELECT_AI_USER")
+password = os.getenv("SELECT_AI_PASSWORD")
+dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
+
+
+async def main():
+    await select_ai.async_connect(user=user, password=password, dsn=dsn)
+    await select_ai.async_delete_credential(
+        credential_name="my_oci_ai_profile_key", force=True
+    )
+    print("Deleted credential: my_oci_ai_profile_key")
+
+
+asyncio.run(main())

samples/async/disable_ai_provider.py

@@ -0,0 +1,33 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2025, Oracle and/or its affiliates.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at
+# http://oss.oracle.com/licenses/upl.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# async/disable_ai_provider.py
+#
+# Async API to disable AI provider for database users
+# -----------------------------------------------------------------------------
+
+import asyncio
+import os
+
+import select_ai
+
+admin_user = os.getenv("SELECT_AI_ADMIN_USER")
+password = os.getenv("SELECT_AI_ADMIN_PASSWORD")
+dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
+select_ai_user = os.getenv("SELECT_AI_USER")
+
+
+async def main():
+    await select_ai.async_connect(user=admin_user, password=password, dsn=dsn)
+    await select_ai.async_disable_provider(
+        users=select_ai_user, provider_endpoint="*.openai.azure.com"
+    )
+    print("Disabled AI provider for user: ", select_ai_user)
+
+
+asyncio.run(main())

samples/async/enable_ai_provider.py

@@ -0,0 +1,33 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2025, Oracle and/or its affiliates.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at
+# http://oss.oracle.com/licenses/upl.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# async/enable_ai_provider.py
+#
+# Async API to enable AI provider for database users
+# -----------------------------------------------------------------------------
+
+import asyncio
+import os
+
+import select_ai
+
+admin_user = os.getenv("SELECT_AI_ADMIN_USER")
+password = os.getenv("SELECT_AI_ADMIN_PASSWORD")
+dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
+select_ai_user = os.getenv("SELECT_AI_USER")
+
+
+async def main():
+    await select_ai.async_connect(user=admin_user, password=password, dsn=dsn)
+    await select_ai.async_enable_provider(
+        users=select_ai_user, provider_endpoint="*.openai.azure.com"
+    )
+    print("Enabled AI provider for user: ", select_ai_user)
+
+
+asyncio.run(main())

samples/delete_ai_credential.py

@@ -0,0 +1,25 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2025, Oracle and/or its affiliates.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at
+# http://oss.oracle.com/licenses/upl.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# delete_ai_credential.py
+#
+# Create a Database credential storing OCI Gen AI's credentials
+# -----------------------------------------------------------------------------
+import os
+
+import select_ai
+
+user = os.getenv("SELECT_AI_USER")
+password = os.getenv("SELECT_AI_PASSWORD")
+dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
+
+select_ai.connect(user=user, password=password, dsn=dsn)
+select_ai.delete_credential(
+    credential_name="my_oci_ai_profile_key", force=True
+)
+print("Deleted credential: my_oci_ai_profile_key")

src/select_ai/__init__.py

@@ -6,18 +6,19 @@
 # -----------------------------------------------------------------------------
 
 from .action import Action
-from .admin import (
-    create_credential,
-    disable_provider,
-    enable_provider,
-)
 from .async_profile import AsyncProfile
 from .base_profile import BaseProfile, ProfileAttributes
 from .conversation import (
     AsyncConversation,
     Conversation,
     ConversationAttributes,
 )
+from .credential import (
+    async_create_credential,
+    async_delete_credential,
+    create_credential,
+    delete_credential,
+)
 from .db import (
     async_connect,
     async_cursor,
@@ -39,6 +40,10 @@
     OCIGenAIProvider,
     OpenAIProvider,
     Provider,
+    async_disable_provider,
+    async_enable_provider,
+    disable_provider,
+    enable_provider,
 )
 from .synthetic_data import (
     SyntheticDataAttributes,

src/select_ai/async_profile.py

@@ -55,7 +55,7 @@ async def _init_profile(self):
         :return: None
         :raises: oracledb.DatabaseError
         """
-        if self.profile_name is not None:
+        if self.profile_name:
             profile_exists = False
             try:
                 saved_attributes = await self._get_attributes(
@@ -75,7 +75,7 @@ async def _init_profile(self):
                         profile_name=self.profile_name
                     )
             except ProfileNotFoundError:
-                if self.attributes is None:
+                if self.attributes is None and self.description is None:
                     raise
             else:
                 if self.attributes is None:
@@ -91,10 +91,13 @@ async def _init_profile(self):
                 await self.create(
                     replace=self.replace, description=self.description
                 )
+        else:  # profile name is None:
+            if self.attributes is not None or self.description is not None:
+                raise ValueError("'profile_name' cannot be empty or None")
         return self
 
     @staticmethod
-    async def _get_profile_description(profile_name) -> str:
+    async def _get_profile_description(profile_name) -> Union[str, None]:
         """Get description of profile from USER_CLOUD_AI_PROFILES
 
         :param str profile_name: Name of profile
@@ -110,7 +113,10 @@ async def _get_profile_description(profile_name) -> str:
             )
             profile = await cr.fetchone()
             if profile:
-                return await profile[1].read()
+                if profile[1] is not None:
+                    return await profile[1].read()
+                else:
+                    return None
             else:
                 raise ProfileNotFoundError(profile_name)
 
@@ -186,6 +192,12 @@ async def set_attributes(self, attributes: ProfileAttributes):
          attributes
         :return: None
         """
+        if not isinstance(attributes, ProfileAttributes):
+            raise TypeError(
+                "'attributes' must be an object of type "
+                "select_ai.ProfileAttributes"
+            )
+
         self.attributes = attributes
         parameters = {
             "profile_name": self.profile_name,

src/select_ai/base_profile.py

@@ -73,10 +73,9 @@ class ProfileAttributes(SelectAIDataClass):
     vector_index_name: Optional[str] = None
 
     def __post_init__(self):
-        if not isinstance(self.provider, Provider):
+        if self.provider and not isinstance(self.provider, Provider):
             raise ValueError(
-                f"The arg `provider` must be an object of "
-                f"type select_ai.Provider"
+                f"'provider' must be an object of " f"type select_ai.Provider"
             )
 
     def json(self, exclude_null=True):
@@ -166,6 +165,11 @@ def __init__(
     ):
         """Initialize a base profile"""
         self.profile_name = profile_name
+        if attributes and not isinstance(attributes, ProfileAttributes):
+            raise TypeError(
+                "'attributes' must be an object of type "
+                "select_ai.ProfileAttributes"
+            )
         self.attributes = attributes
         self.description = description
         self.merge = merge

src/select_ai/conversation.py

@@ -129,7 +129,10 @@ def get_attributes(self) -> ConversationAttributes:
             attributes = cr.fetchone()
             if attributes:
                 conversation_title = attributes[0]
-                description = attributes[1].read()  # Oracle.LOB
+                if attributes[1]:
+                    description = attributes[1].read()  # Oracle.LOB
+                else:
+                    description = None
                 retention_days = attributes[2]
                 return ConversationAttributes(
                     title=conversation_title,
@@ -154,7 +157,10 @@ def list(cls) -> Iterator["Conversation"]:
             for row in cr.fetchall():
                 conversation_id = row[0]
                 conversation_title = row[1]
-                description = row[2].read()  # Oracle.LOB
+                if row[2]:
+                    description = row[2].read()  # Oracle.LOB
+                else:
+                    description = None
                 retention_days = row[3]
                 attributes = ConversationAttributes(
                     title=conversation_title,
@@ -224,7 +230,10 @@ async def get_attributes(self) -> ConversationAttributes:
             attributes = await cr.fetchone()
             if attributes:
                 conversation_title = attributes[0]
-                description = await attributes[1].read()  # Oracle.AsyncLOB
+                if attributes[1]:
+                    description = await attributes[1].read()  # Oracle.AsyncLOB
+                else:
+                    description = None
                 retention_days = attributes[2]
                 return ConversationAttributes(
                     title=conversation_title,
@@ -250,7 +259,10 @@ async def list(cls) -> AsyncGenerator["AsyncConversation", None]:
             for row in rows:
                 conversation_id = row[0]
                 conversation_title = row[1]
-                description = await row[2].read()  # Oracle.AsyncLOB
+                if row[2]:
+                    description = await row[2].read()  # Oracle.AsyncLOB
+                else:
+                    description = None
                 retention_days = row[3]
                 attributes = ConversationAttributes(
                     title=conversation_title,