select-ai 1.0.0rc1__tar.gz → 1.1.0__tar.gz

{select_ai-1.0.0rc1/src/select_ai.egg-info → select_ai-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: select_ai
-Version: 1.0.0rc1
+Version: 1.1.0
 Summary: Select AI for Python
 Author-email: Abhishek Singh <abhishek.o.singh@oracle.com>
 Maintainer-email: Abhishek Singh <abhishek.o.singh@oracle.com>
@@ -46,6 +46,10 @@ Run
 python3 -m pip install select_ai
 ```
 
+## Documentation
+
+See [Select AI for Python documentation][documentation]
+
 ## Samples
 
 Examples can be found in the [/samples][samples] directory
@@ -114,6 +118,7 @@ Released under the Universal Permissive License v1.0 as shown at
 <https://oss.oracle.com/licenses/upl/>.
 
 [contributing]: https://github.com/oracle/python-select-ai/blob/main/CONTRIBUTING.md
+[documentation]: https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/pysai/
 [ghdiscussions]: https://github.com/oracle/python-select-ai/discussions
 [ghissues]: https://github.com/oracle/python-select-ai/issues
 [samples]: https://github.com/oracle/python-select-ai/tree/main/samples

{select_ai-1.0.0rc1 → select_ai-1.1.0}/README.md

@@ -13,6 +13,10 @@ Run
 python3 -m pip install select_ai
 ```
 
+## Documentation
+
+See [Select AI for Python documentation][documentation]
+
 ## Samples
 
 Examples can be found in the [/samples][samples] directory
@@ -81,6 +85,7 @@ Released under the Universal Permissive License v1.0 as shown at
 <https://oss.oracle.com/licenses/upl/>.
 
 [contributing]: https://github.com/oracle/python-select-ai/blob/main/CONTRIBUTING.md
+[documentation]: https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/pysai/
 [ghdiscussions]: https://github.com/oracle/python-select-ai/discussions
 [ghissues]: https://github.com/oracle/python-select-ai/issues
 [samples]: https://github.com/oracle/python-select-ai/tree/main/samples

select_ai-1.1.0/samples/async/vector_index_get_attributes.py

@@ -0,0 +1,36 @@
+# -----------------------------------------------------------------------------
+# 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/vector_index_get_attributes.py
+#
+# Get vector index attributes
+# -----------------------------------------------------------------------------
+
+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)
+
+    async_vector_index = select_ai.AsyncVectorIndex(
+        index_name="test_vector_index",
+    )
+    attributes = await async_vector_index.get_attributes()
+    print(attributes)
+    async_profile = await async_vector_index.get_profile()
+    print(async_profile)
+
+
+asyncio.run(main())

select_ai-1.1.0/samples/async/vector_index_update_attributes.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/vector_index_update_attributes.py
+#
+# Update Vector index attributes
+# -----------------------------------------------------------------------------
+
+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)
+    async_vector_index = select_ai.AsyncVectorIndex(
+        index_name="test_vector_index",
+    )
+
+    # Use vector_index.set_attributes to update a multiple attributes
+    updated_attributes = select_ai.OracleVectorIndexAttributes(
+        refresh_rate=1450,
+    )
+    await async_vector_index.set_attributes(attributes=updated_attributes)
+
+    # Use vector_index.set_attribute to update a single attribute
+    await async_vector_index.set_attribute(
+        attribute_name="similarity_threshold", attribute_value=0.5
+    )
+    attributes = await async_vector_index.get_attributes()
+    print(attributes)
+
+
+asyncio.run(main())

select_ai-1.1.0/samples/vector_index_get_attributes.py

@@ -0,0 +1,29 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# vector_index_get_attributes.py
+#
+# Gets attributes for a vector index
+# -----------------------------------------------------------------------------
+
+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)
+
+vector_index = select_ai.VectorIndex(
+    index_name="test_vector_index",
+)
+
+print(vector_index.get_attributes())
+print(vector_index.get_profile())

select_ai-1.1.0/samples/vector_index_update_attributes.py

@@ -0,0 +1,36 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# vector_index_update_attributes.py
+#
+# Update attributes for a vector index
+# -----------------------------------------------------------------------------
+
+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)
+vector_index = select_ai.VectorIndex(
+    index_name="test_vector_index",
+)
+
+# Use vector_index.set_attributes to update a multiple attributes
+updated_attributes = select_ai.OracleVectorIndexAttributes(
+    refresh_rate=1450,
+)
+vector_index.set_attributes(attributes=updated_attributes)
+
+# Use vector_index.set_attribute to update a single attribute
+vector_index.set_attribute(
+    attribute_name="similarity_threshold", attribute_value=0.5
+)
+print(vector_index.get_attributes())

{select_ai-1.0.0rc1 → select_ai-1.1.0}/src/select_ai/async_profile.py

@@ -21,7 +21,11 @@ import oracledb
 import pandas
 
 from select_ai.action import Action
-from select_ai.base_profile import BaseProfile, ProfileAttributes
+from select_ai.base_profile import (
+    BaseProfile,
+    ProfileAttributes,
+    no_data_for_prompt,
+)
 from select_ai.conversation import AsyncConversation
 from select_ai.db import async_cursor, async_get_connection
 from select_ai.errors import ProfileExistsError, ProfileNotFoundError
@@ -347,10 +351,10 @@ class AsyncProfile(BaseProfile):
             result = await data.read()
         else:
             result = None
-        if action == Action.RUNSQL and result:
+        if action == Action.RUNSQL:
+            if no_data_for_prompt(result):  # empty dataframe
+                return pandas.DataFrame()
             return pandas.DataFrame(json.loads(result))
-        elif action == Action.RUNSQL:
-            return pandas.DataFrame()
         else:
             return result
 

{select_ai-1.0.0rc1 → select_ai-1.1.0}/src/select_ai/base_profile.py

@@ -59,6 +59,7 @@ class ProfileAttributes(SelectAIDataClass):
     constraints: Optional[str] = None
     conversation: Optional[bool] = None
     credential_name: Optional[str] = None
+    enable_custom_source_uri: Optional[bool] = None
     enable_sources: Optional[bool] = None
     enable_source_offsets: Optional[bool] = None
     enforce_object_list: Optional[bool] = None
@@ -182,3 +183,11 @@ class BaseProfile(ABC):
             f"{self.__class__.__name__}(profile_name={self.profile_name}, "
             f"attributes={self.attributes}, description={self.description})"
         )
+
+
+def no_data_for_prompt(result) -> bool:
+    if result is None:
+        return True
+    if result == "No data found for the prompt.":
+        return True
+    return False

{select_ai-1.0.0rc1 → select_ai-1.1.0}/src/select_ai/profile.py

@@ -15,7 +15,11 @@ import pandas
 
 from select_ai import Conversation
 from select_ai.action import Action
-from select_ai.base_profile import BaseProfile, ProfileAttributes
+from select_ai.base_profile import (
+    BaseProfile,
+    ProfileAttributes,
+    no_data_for_prompt,
+)
 from select_ai.db import cursor
 from select_ai.errors import ProfileExistsError, ProfileNotFoundError
 from select_ai.provider import Provider
@@ -319,10 +323,10 @@ class Profile(BaseProfile):
             result = data.read()
         else:
             result = None
-        if action == Action.RUNSQL and result:
+        if action == Action.RUNSQL:
+            if no_data_for_prompt(result):  # empty dataframe
+                return pandas.DataFrame()
             return pandas.DataFrame(json.loads(result))
-        elif action == Action.RUNSQL:
-            return pandas.DataFrame()
         else:
             return result
 

{select_ai-1.0.0rc1 → select_ai-1.1.0}/src/select_ai/vector_index.py

@@ -17,7 +17,7 @@ from select_ai._abc import SelectAIDataClass
 from select_ai._enums import StrEnum
 from select_ai.async_profile import AsyncProfile
 from select_ai.db import async_cursor, cursor
-from select_ai.errors import VectorIndexNotFoundError
+from select_ai.errors import ProfileNotFoundError, VectorIndexNotFoundError
 from select_ai.profile import Profile
 from select_ai.sql import (
     GET_USER_VECTOR_INDEX_ATTRIBUTES,
@@ -89,9 +89,21 @@ class VectorIndexAttributes(SelectAIDataClass):
     vector_table_name: Optional[str] = None
     pipeline_name: Optional[str] = None
 
-    def json(self, exclude_null=True):
+    def json(self, exclude_null=True, for_update=False):
         attributes = self.dict(exclude_null=exclude_null)
         attributes.pop("pipeline_name", None)
+        # Currently, the following are unmodifiable
+        unmodifiable = [
+            "location",
+            "chunk_size",
+            "chunk_overlap",
+            "vector_dimension",
+            "vector_table_name",
+            "vector_distance_metric",
+        ]
+        if for_update:
+            for key in unmodifiable:
+                attributes.pop(key, None)
         return json.dumps(attributes)
 
     @classmethod
@@ -113,7 +125,7 @@ class _BaseVectorIndex(ABC):
 
     def __init__(
         self,
-        profile: BaseProfile = None,
+        profile: Optional[BaseProfile] = None,
         index_name: Optional[str] = None,
         description: Optional[str] = None,
         attributes: Optional[VectorIndexAttributes] = None,
@@ -159,7 +171,9 @@ class VectorIndex(_BaseVectorIndex):
         :raises: VectorIndexNotFoundError
         """
         with cursor() as cr:
-            cr.execute(GET_USER_VECTOR_INDEX_ATTRIBUTES, index_name=index_name)
+            cr.execute(
+                GET_USER_VECTOR_INDEX_ATTRIBUTES, index_name=index_name.upper()
+            )
             attributes = cr.fetchall()
             if attributes:
                 post_processed_attributes = {}
@@ -248,10 +262,18 @@ class VectorIndex(_BaseVectorIndex):
 
         """
         with cursor() as cr:
-            cr.callproc(
-                "DBMS_CLOUD_AI.ENABLE_VECTOR_INDEX",
-                keyword_parameters={"index_name": self.index_name},
-            )
+            try:
+                cr.callproc(
+                    "DBMS_CLOUD_AI.ENABLE_VECTOR_INDEX",
+                    keyword_parameters={"index_name": self.index_name},
+                )
+            except oracledb.Error as e:
+                (error,) = e.args
+                # ORA-20000: Vector Index is already in the desired status
+                if error.code == 20000:
+                    pass
+                else:
+                    raise
 
     def disable(self):
         """This procedure disables a vector index object in the current
@@ -263,16 +285,49 @@ class VectorIndex(_BaseVectorIndex):
         :return: None
         :raises: oracledb.DatabaseError
         """
+        with cursor() as cr:
+            try:
+                cr.callproc(
+                    "DBMS_CLOUD_AI.DISABLE_VECTOR_INDEX",
+                    keyword_parameters={"index_name": self.index_name},
+                )
+            except oracledb.Error as e:
+                (error,) = e.args
+                # ORA-20000: Vector Index is already in the desired status
+                if error.code == 20000:
+                    pass
+                else:
+                    raise
+
+    def set_attribute(
+        self,
+        attribute_name: str,
+        attribute_value: Union[str, int, float],
+    ):
+        """
+        This procedure updates an existing vector store index with a specified
+        value of the vector index attribute.
+
+        :param str attribute_name: Custom attribute name
+        :param Union[str, int, float] attribute_value: Attribute Value
+
+        """
+        setattr(self.attributes, attribute_name, attribute_value)
+        parameters = {
+            "index_name": self.index_name,
+            "attribute_name": attribute_name,
+            "attribute_value": attribute_value,
+        }
         with cursor() as cr:
             cr.callproc(
-                "DBMS_CLOUD_AI.DISABLE_VECTOR_INDEX",
-                keyword_parameters={"index_name": self.index_name},
+                "DBMS_CLOUD_AI.UPDATE_VECTOR_INDEX",
+                keyword_parameters=parameters,
             )
 
     def set_attributes(
         self,
-        attribute_name: str,
-        attribute_value: Union[str, int, float],
+        attribute_name: Optional[str] = None,
+        attribute_value: Optional[Union[str, int, float]] = None,
         attributes: VectorIndexAttributes = None,
     ):
         """
@@ -283,8 +338,8 @@ class VectorIndex(_BaseVectorIndex):
 
         :param str attribute_name: Custom attribute name
         :param Union[str, int, float] attribute_value: Attribute Value
-        :param VectorIndexAttributes attributes: Specify multiple attributes
-         to update in a single API invocation
+        :param select_ai.VectorIndexAttributes attributes: Use this to
+         update multiple attribute values
         :return: None
         :raises: oracledb.DatabaseError
         """
@@ -297,12 +352,12 @@ class VectorIndex(_BaseVectorIndex):
 
         parameters = {"index_name": self.index_name}
         if attributes:
-            parameters["attributes"] = attributes.json()
+            parameters["attributes"] = attributes.json(for_update=True)
             self.attributes = attributes
         else:
             setattr(self.attributes, attribute_name, attribute_value)
-            parameters["attributes_name"] = attribute_name
-            parameters["attributes_value"] = attribute_value
+            parameters["attribute_name"] = attribute_name
+            parameters["attribute_value"] = attribute_value
 
         with cursor() as cr:
             cr.callproc(
@@ -318,6 +373,16 @@ class VectorIndex(_BaseVectorIndex):
         """
         return self._get_attributes(self.index_name)
 
+    def get_profile(self) -> Profile:
+        """Get Profile object linked to this vector index
+
+        :return: select_ai.Profile
+        :raises: ProfileNotFoundError
+        """
+        attributes = self._get_attributes(index_name=self.index_name)
+        profile = Profile(profile_name=attributes.profile_name)
+        return profile
+
     @classmethod
     def list(cls, index_name_pattern: str = ".*") -> Iterator["VectorIndex"]:
         """List Vector Indexes
@@ -340,11 +405,15 @@ class VectorIndex(_BaseVectorIndex):
                 else:
                     description = None
                 attributes = cls._get_attributes(index_name=index_name)
+                try:
+                    profile = Profile(profile_name=attributes.profile_name)
+                except ProfileNotFoundError:
+                    profile = None
                 yield cls(
                     index_name=index_name,
                     description=description,
                     attributes=attributes,
-                    profile=Profile(profile_name=attributes.profile_name),
+                    profile=profile,
                 )
 
 
@@ -368,7 +437,7 @@ class AsyncVectorIndex(_BaseVectorIndex):
         """
         async with async_cursor() as cr:
             await cr.execute(
-                GET_USER_VECTOR_INDEX_ATTRIBUTES, index_name=index_name
+                GET_USER_VECTOR_INDEX_ATTRIBUTES, index_name=index_name.upper()
             )
             attributes = await cr.fetchall()
             if attributes:
@@ -457,10 +526,18 @@ class AsyncVectorIndex(_BaseVectorIndex):
 
         """
         async with async_cursor() as cr:
-            await cr.callproc(
-                "DBMS_CLOUD_AI.ENABLE_VECTOR_INDEX",
-                keyword_parameters={"index_name": self.index_name},
-            )
+            try:
+                await cr.callproc(
+                    "DBMS_CLOUD_AI.ENABLE_VECTOR_INDEX",
+                    keyword_parameters={"index_name": self.index_name},
+                )
+            except oracledb.DatabaseError as e:
+                (error,) = e.args
+                # ORA-20000: Vector Index is already in the desired status
+                if error.code == 20000:
+                    pass
+                else:
+                    raise
 
     async def disable(self) -> None:
         """This procedure disables a vector index object in the current
@@ -472,16 +549,46 @@ class AsyncVectorIndex(_BaseVectorIndex):
         :return: None
         :raises: oracledb.DatabaseError
         """
+        async with async_cursor() as cr:
+            try:
+                await cr.callproc(
+                    "DBMS_CLOUD_AI.DISABLE_VECTOR_INDEX",
+                    keyword_parameters={"index_name": self.index_name},
+                )
+            except oracledb.Error as e:
+                (error,) = e.args
+                if error.code == 20000:
+                    pass
+                else:
+                    raise
+
+    async def set_attribute(
+        self, attribute_name: str, attribute_value: Union[str, int, float]
+    ) -> None:
+        """
+        This procedure updates an existing vector store index with a specified
+        value of the vector index attribute.
+
+        :param str attribute_name: Custom attribute name
+        :param Union[str, int, float] attribute_value: Attribute Value
+
+        """
+        parameters = {
+            "index_name": self.index_name,
+            "attribute_name": attribute_name,
+            "attribute_value": attribute_value,
+        }
+        setattr(self.attributes, attribute_name, attribute_value)
         async with async_cursor() as cr:
             await cr.callproc(
-                "DBMS_CLOUD_AI.DISABLE_VECTOR_INDEX",
-                keyword_parameters={"index_name": self.index_name},
+                "DBMS_CLOUD_AI.UPDATE_VECTOR_INDEX",
+                keyword_parameters=parameters,
             )
 
     async def set_attributes(
         self,
-        attribute_name: str,
-        attribute_value: Union[str, int],
+        attribute_name: Optional[str] = None,
+        attribute_value: Optional[Union[str, int, float]] = None,
         attributes: VectorIndexAttributes = None,
     ) -> None:
         """
@@ -492,8 +599,8 @@ class AsyncVectorIndex(_BaseVectorIndex):
 
         :param str attribute_name: Custom attribute name
         :param Union[str, int, float] attribute_value: Attribute Value
-        :param VectorIndexAttributes attributes: Specify multiple attributes
-         to update in a single API invocation
+        :param select_ai.VectorIndexAttributes attributes: Use this to
+         update multiple attribute values
         :return: None
         :raises: oracledb.DatabaseError
         """
@@ -506,11 +613,11 @@ class AsyncVectorIndex(_BaseVectorIndex):
         parameters = {"index_name": self.index_name}
         if attributes:
             self.attributes = attributes
-            parameters["attributes"] = attributes.json()
+            parameters["attributes"] = attributes.json(for_update=True)
         else:
             setattr(self.attributes, attribute_name, attribute_value)
-            parameters["attributes_name"] = attribute_name
-            parameters["attributes_value"] = attribute_value
+            parameters["attribute_name"] = attribute_name
+            parameters["attribute_value"] = attribute_value
 
         async with async_cursor() as cr:
             await cr.callproc(
@@ -526,6 +633,16 @@ class AsyncVectorIndex(_BaseVectorIndex):
         """
         return await self._get_attributes(index_name=self.index_name)
 
+    async def get_profile(self) -> AsyncProfile:
+        """Get AsyncProfile object linked to this vector index
+
+        :return: select_ai.AsyncProfile
+        :raises: ProfileNotFoundError
+        """
+        attributes = await self._get_attributes(index_name=self.index_name)
+        profile = await AsyncProfile(profile_name=attributes.profile_name)
+        return profile
+
     @classmethod
     async def list(
         cls, index_name_pattern: str = ".*"
@@ -552,11 +669,15 @@ class AsyncVectorIndex(_BaseVectorIndex):
                 else:
                     description = None
                 attributes = await cls._get_attributes(index_name=index_name)
+                try:
+                    profile = await AsyncProfile(
+                        profile_name=attributes.profile_name,
+                    )
+                except ProfileNotFoundError:
+                    profile = None
                 yield VectorIndex(
                     index_name=index_name,
                     description=description,
                     attributes=attributes,
-                    profile=await AsyncProfile(
-                        profile_name=attributes.profile_name
-                    ),
+                    profile=profile,
                 )

{select_ai-1.0.0rc1 → select_ai-1.1.0}/src/select_ai/version.py

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

{select_ai-1.0.0rc1 → select_ai-1.1.0/src/select_ai.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: select_ai
-Version: 1.0.0rc1
+Version: 1.1.0
 Summary: Select AI for Python
 Author-email: Abhishek Singh <abhishek.o.singh@oracle.com>
 Maintainer-email: Abhishek Singh <abhishek.o.singh@oracle.com>
@@ -46,6 +46,10 @@ Run
 python3 -m pip install select_ai
 ```
 
+## Documentation
+
+See [Select AI for Python documentation][documentation]
+
 ## Samples
 
 Examples can be found in the [/samples][samples] directory
@@ -114,6 +118,7 @@ Released under the Universal Permissive License v1.0 as shown at
 <https://oss.oracle.com/licenses/upl/>.
 
 [contributing]: https://github.com/oracle/python-select-ai/blob/main/CONTRIBUTING.md
+[documentation]: https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/pysai/
 [ghdiscussions]: https://github.com/oracle/python-select-ai/discussions
 [ghissues]: https://github.com/oracle/python-select-ai/issues
 [samples]: https://github.com/oracle/python-select-ai/tree/main/samples

{select_ai-1.0.0rc1 → select_ai-1.1.0}/src/select_ai.egg-info/SOURCES.txt

@@ -22,8 +22,10 @@ samples/profile_show_sql.py
 samples/profiles_list.py
 samples/vector_index_create.py
 samples/vector_index_delete.py
+samples/vector_index_get_attributes.py
 samples/vector_index_list.py
 samples/vector_index_rag.py
+samples/vector_index_update_attributes.py
 samples/async/conversation_chat_session.py
 samples/async/conversations_list.py
 samples/async/create_ai_credential.py
@@ -42,8 +44,10 @@ samples/async/profile_sql_concurrent_tasks.py
 samples/async/profiles_list.py
 samples/async/vector_index_create.py
 samples/async/vector_index_delete.py
+samples/async/vector_index_get_attributes.py
 samples/async/vector_index_list.py
 samples/async/vector_index_rag.py
+samples/async/vector_index_update_attributes.py
 src/select_ai/__init__.py
 src/select_ai/_abc.py
 src/select_ai/_enums.py