Merge pull request #8 from oracle/dev/v1.1.0

aosingh · web-flow · commit 27846fc99f28 · 2025-09-20T17:32:18.000-07:00
v1.1.0
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ doc/build
 doc/drawio
 **/__pycache__
 test.env
+test_19c.env
diff --git a/doc/source/user_guide/vector_index.rst b/doc/source/user_guide/vector_index.rst
@@ -81,6 +81,42 @@ output::
 
 .. latex:clearpage::
 
+
+Get vector index attributes
++++++++++++++++++++++++++++
+
+You can fetch the vector index attributes and associated AI profile using
+``vector_index.get_attributes()`` and ``vector_index.get_profile()`` methods
+respectively.
+
+.. literalinclude:: ../../../samples/vector_index_get_attributes.py
+   :language: python
+   :lines: 14-
+
+output::
+
+    OracleVectorIndexAttributes(chunk_size=1024, chunk_overlap=128, location='https://objectstorage.us-ashburn-1.oraclecloud.com/n/dwcsdev/b/conda-environment/o/tenant1-pdb3/graph', match_limit=5, object_storage_credential_name='my_oci_ai_profile_key', profile_name='oci_vector_ai_profile', refresh_rate=1450, similarity_threshold=0.5, vector_distance_metric='COSINE', vector_db_endpoint=None, vector_db_credential_name=None, vector_db_provider=<VectorDBProvider.ORACLE: 'oracle'>, vector_dimension=None, vector_table_name=None, pipeline_name='TEST_VECTOR_INDEX$VECPIPELINE')
+
+    Profile(profile_name=oci_vector_ai_profile, attributes=ProfileAttributes(annotations=None, case_sensitive_values=None, comments=None, constraints=None, conversation=None, credential_name='my_oci_ai_profile_key', enable_custom_source_uri=None, enable_sources=None, enable_source_offsets=None, enforce_object_list=None, max_tokens=1024, object_list=None, object_list_mode=None, provider=OCIGenAIProvider(embedding_model='cohere.embed-english-v3.0', model=None, provider_name='oci', provider_endpoint=None, region='us-chicago-1', oci_apiformat='GENERIC', oci_compartment_id=None, oci_endpoint_id=None, oci_runtimetype=None), seed=None, stop_tokens=None, streaming=None, temperature=None, vector_index_name='test_vector_index'), description=MY OCI AI Profile)
+
+.. latex:clearpage::
+
+Update vector index attributes
+++++++++++++++++++++++++++++++
+
+To update attributes, use either ``vector_index.set_attribute()`` or
+``vector_index.set_attributes()``
+
+.. literalinclude:: ../../../samples/vector_index_update_attributes.py
+   :language: python
+   :lines: 14-
+
+output::
+
+    OracleVectorIndexAttributes(chunk_size=1024, chunk_overlap=128, location='https://objectstorage.us-ashburn-1.oraclecloud.com/n/dwcsdev/b/conda-environment/o/tenant1-pdb3/graph', match_limit=5, object_storage_credential_name='my_oci_ai_profile_key', profile_name='oci_vector_ai_profile', refresh_rate=1450, similarity_threshold=0.5, vector_distance_metric='COSINE', vector_db_endpoint=None, vector_db_credential_name=None, vector_db_provider=<VectorDBProvider.ORACLE: 'oracle'>, vector_dimension=None, vector_table_name=None, pipeline_name='TEST_VECTOR_INDEX$VECPIPELINE')
+
+.. latex:clearpage::
+
 RAG using vector index
 ++++++++++++++++++++++
 
@@ -159,6 +195,41 @@ output::
 
 .. latex:clearpage::
 
+
+Async get vector index attributes
++++++++++++++++++++++++++++++++++
+
+You can fetch the vector index attributes and associated AI profile using
+``async_vector_index.get_attributes()`` and ``async_vector_index.get_profile()``
+methods respectively.
+
+.. literalinclude:: ../../../samples/async/vector_index_get_attributes.py
+   :language: python
+   :lines: 14-
+
+output::
+
+    OracleVectorIndexAttributes(chunk_size=1024, chunk_overlap=128, location='https://objectstorage.us-ashburn-1.oraclecloud.com/n/dwcsdev/b/conda-environment/o/tenant1-pdb3/graph', match_limit=5, object_storage_credential_name='my_oci_ai_profile_key', profile_name='oci_vector_ai_profile', refresh_rate=1450, similarity_threshold=0.5, vector_distance_metric='COSINE', vector_db_endpoint=None, vector_db_credential_name=None, vector_db_provider=<VectorDBProvider.ORACLE: 'oracle'>, vector_dimension=None, vector_table_name=None, pipeline_name='TEST_VECTOR_INDEX$VECPIPELINE')
+
+    AsyncProfile(profile_name=oci_vector_ai_profile, attributes=ProfileAttributes(annotations=None, case_sensitive_values=None, comments=None, constraints=None, conversation=None, credential_name='my_oci_ai_profile_key', enable_custom_source_uri=None, enable_sources=None, enable_source_offsets=None, enforce_object_list=None, max_tokens=1024, object_list=None, object_list_mode=None, provider=OCIGenAIProvider(embedding_model='cohere.embed-english-v3.0', model=None, provider_name='oci', provider_endpoint=None, region='us-chicago-1', oci_apiformat='GENERIC', oci_compartment_id=None, oci_endpoint_id=None, oci_runtimetype=None), seed=None, stop_tokens=None, streaming=None, temperature=None, vector_index_name='test_vector_index'), description=MY OCI AI Profile)
+
+.. latex:clearpage::
+
+Async update vector index attributes
+++++++++++++++++++++++++++++++++++++
+
+To update attributes, use either ``async_vector_index.set_attribute()`` or
+``async_vector_index.set_attributes()``
+
+.. literalinclude:: ../../../samples/async/vector_index_update_attributes.py
+   :language: python
+   :lines: 14-
+
+output::
+
+    OracleVectorIndexAttributes(chunk_size=1024, chunk_overlap=128, location='https://objectstorage.us-ashburn-1.oraclecloud.com/n/dwcsdev/b/conda-environment/o/tenant1-pdb3/graph', match_limit=5, object_storage_credential_name='my_oci_ai_profile_key', profile_name='oci_vector_ai_profile', refresh_rate=1450, similarity_threshold=0.5, vector_distance_metric='COSINE', vector_db_endpoint=None, vector_db_credential_name=None, vector_db_provider=<VectorDBProvider.ORACLE: 'oracle'>, vector_dimension=None, vector_table_name=None, pipeline_name='TEST_VECTOR_INDEX$VECPIPELINE')
+
+
 Async RAG using vector index
 ++++++++++++++++++++++++++++
 
diff --git a/samples/async/vector_index_get_attributes.py b/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())
diff --git a/samples/async/vector_index_update_attributes.py b/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())
diff --git a/samples/vector_index_get_attributes.py b/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())
diff --git a/samples/vector_index_update_attributes.py b/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())
diff --git a/src/select_ai/async_profile.py b/src/select_ai/async_profile.py
@@ -21,7 +21,11 @@
 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 @@ async def generate(
             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
 
diff --git a/src/select_ai/base_profile.py b/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 @@ def __repr__(self):
             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
diff --git a/src/select_ai/profile.py b/src/select_ai/profile.py
@@ -15,7 +15,11 @@
 
 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 @@ def generate(
             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
 
diff --git a/src/select_ai/vector_index.py b/src/select_ai/vector_index.py
diff --git a/src/select_ai/version.py b/src/select_ai/version.py
