select-ai 1.0.0.dev5__tar.gz → 1.0.0.dev7__tar.gz

{select_ai-1.0.0.dev5/src/select_ai.egg-info → select_ai-1.0.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: select_ai
-Version: 1.0.0.dev5
+Version: 1.0.0.dev7
 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.dev5 → select_ai-1.0.0.dev7}/README.md

@@ -1,6 +1,6 @@
 # select-ai
 
-Python API for Select AI
+Select AI for Python
 
 ## Install
 

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/conversation_chat_session.py

@@ -4,6 +4,11 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
+# async/conversation_chat_session.py
+#
+# Demonstrates context aware conversation using AI Profile
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
@@ -41,5 +46,4 @@ async def main():
         print(response)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/conversations_list.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/conversations_list.py
+#
+# List all conversations saved in the database
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -22,5 +28,4 @@ async def main():
         print(conversation.attributes)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/profile_chat.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/profile_chat.py
+#
+# Chat using an AI Profile
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -21,7 +27,7 @@ async def main():
         profile_name="async_oci_ai_profile"
     )
 
-    # Asynchronously send multiple prompts
+    # Asynchronously send multiple chat prompts
     chat_tasks = [
         async_profile.chat(prompt="What is OCI ?"),
         async_profile.chat(prompt="What is OML4PY?"),
@@ -32,5 +38,4 @@ async def main():
         print(result)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/profile_create.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/profile_create.py
+#
+# Create an OCI Gen AI profile
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 from pprint import pformat
@@ -33,15 +39,12 @@ async def main():
         description="MY OCI AI Profile",
         replace=True,
     )
-
+    print("Created async profile ", async_profile.profile_name)
     profile_attributes = await async_profile.get_attributes()
-
-    print("Profile attributes are: ", profile_attributes)
     print(
-        "Profile attributes as Python dict: ",
+        "Profile attributes: ",
         pformat(profile_attributes.dict(exclude_null=False)),
     )
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/profile_explain_sql.py

@@ -5,6 +5,10 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/profile_explain_sql.py
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -25,5 +29,4 @@ async def main():
     print(response)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/profile_pipeline.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/profile_pipeline.py
+#
+# Demonstrates sending multiple prompts using a single Database round-trip
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -45,5 +51,4 @@ async def main():
         )
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/profile_run_sql.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/profile_run_sql.py
+#
+# Return a pandas.Dataframe built using the resultset of the generated SQL
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -26,5 +32,4 @@ async def main():
     print(df)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/profile_show_sql.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/profile_show_sql.py
+#
+# Show the generated SQL without executing it
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -24,5 +30,4 @@ async def main():
     print(response)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/profile_sql_concurrent_tasks.py

@@ -5,6 +5,13 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/profile_sql_concurrent_tasks.py
+#
+# Demonstrates sending multiple prompts concurrently using asyncio
+# -----------------------------------------------------------------------------
+
+
 import asyncio
 import os
 
@@ -32,5 +39,4 @@ async def main():
         print(result)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/profiles_list.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/profile_list.py
+#
+# List all the profile names matching a certain pattern
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -26,5 +32,4 @@ async def main():
         print(p.profile_name)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/vector_index_create.py

@@ -5,6 +5,13 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/vector_index_create.py
+#
+# Create a vector index for Retrieval Augmented Generation (RAG)
+# -----------------------------------------------------------------------------
+
+
 import asyncio
 import os
 
@@ -19,8 +26,9 @@ async def main():
     await select_ai.async_connect(user=user, password=password, dsn=dsn)
 
     provider = select_ai.OCIGenAIProvider(
-        region="us-chicago-1", oci_apiformat="GENERIC",
-        embedding_model="cohere.embed-english-v3.0"
+        region="us-chicago-1",
+        oci_apiformat="GENERIC",
+        embedding_model="cohere.embed-english-v3.0",
     )
     profile_attributes = select_ai.ProfileAttributes(
         credential_name="my_oci_ai_profile_key",
@@ -45,8 +53,7 @@ async def main():
         profile=async_profile,
     )
     await async_vector_index.create(replace=True)
-    print("created vector index: test_vector_index")
+    print("Created vector index: test_vector_index")
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/vector_index_delete.py

@@ -5,6 +5,10 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/vector_index_delete.py
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -22,5 +26,4 @@ async def main():
     print("Vector index deleted")
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/vector_index_list.py

@@ -5,6 +5,13 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/vector_index_list.py
+#
+# List all the vector indexes and associated profile where the index name
+# matches a certain pattern
+# -----------------------------------------------------------------------------
+
 import asyncio
 import os
 
@@ -23,5 +30,4 @@ async def main():
         print("Vector index profile", index.profile)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

{select_ai-1.0.0.dev5/samples/async_samples → select_ai-1.0.0.dev7/samples/async}/vector_index_rag.py

@@ -5,6 +5,13 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# async/vector_index_rag.py
+#
+# Demonstrates Retrieval Augmented Generation (RAG) using ai_profile.narrate()
+# -----------------------------------------------------------------------------
+
+
 import asyncio
 import os
 
@@ -20,9 +27,10 @@ async def main():
     async_profile = await select_ai.AsyncProfile(
         profile_name="async_oci_vector_ai_profile"
     )
-    r = await async_profile.narrate("list the conda environments in my object store")
+    r = await async_profile.narrate(
+        "list the conda environments in my object store"
+    )
     print(r)
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

select_ai-1.0.0.dev7/samples/conversation_chat_session.py

@@ -0,0 +1,40 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# conversation_chat_session.py
+#
+# Demonstrates context aware conversation using AI Profile
+# -----------------------------------------------------------------------------
+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)
+profile = select_ai.Profile(profile_name="oci_ai_profile")
+conversation_attributes = select_ai.ConversationAttributes(
+    title="History of Science",
+    description="LLM's understanding of history of science",
+)
+conversation = select_ai.Conversation(attributes=conversation_attributes)
+with profile.chat_session(conversation=conversation, delete=True) as session:
+    print(
+        "Conversation ID for this session is:",
+        conversation.conversation_id,
+    )
+    response = session.chat(
+        prompt="What is importance of history of science ?"
+    )
+    print(response)
+    response = session.chat(
+        prompt="Elaborate more on 'Learning from past mistakes'"
+    )
+    print(response)

select_ai-1.0.0.dev7/samples/conversation_create.py

@@ -0,0 +1,30 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# conversation_create.py
+#
+# Create a new conversation given a title and description. The created
+# conversation can be used in profile.chat_session()
+# -----------------------------------------------------------------------------
+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)
+conversation_attributes = select_ai.ConversationAttributes(
+    title="History of Science",
+    description="LLM's understanding of history of science",
+)
+conversation = select_ai.Conversation(attributes=conversation_attributes)
+conversation_id = conversation.create()
+
+print("Created conversation with conversation id: ", conversation_id)

select_ai-1.0.0.dev7/samples/conversation_delete.py

@@ -0,0 +1,30 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# conversation_delete.py
+#
+# Delete conversation given a conversation id
+# -----------------------------------------------------------------------------
+
+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)
+conversation = select_ai.Conversation(
+    conversation_id="37DDC22E-11C8-3D49-E063-D81A000A85FE"
+)
+conversation.delete(force=True)
+print(
+    "Deleted conversation with conversation id: ",
+    conversation.conversation_id,
+)

{select_ai-1.0.0.dev5 → select_ai-1.0.0.dev7}/samples/conversations_list.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# conversations_list.py
+#
+# List all conversations saved in the database
+# -----------------------------------------------------------------------------
+
 import os
 
 import select_ai
@@ -13,14 +19,7 @@ user = os.getenv("SELECT_AI_USER")
 password = os.getenv("SELECT_AI_PASSWORD")
 dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
 
-
-def main():
-    select_ai.connect(user=user, password=password, dsn=dsn)
-    # To list all conversations, use the class method list()
-    for conversation in select_ai.Conversation().list():
-        print(conversation.conversation_id)
-        print(conversation.attributes)
-
-
-if __name__ == "__main__":
-    main()
+select_ai.connect(user=user, password=password, dsn=dsn)
+for conversation in select_ai.Conversation().list():
+    print(conversation.conversation_id)
+    print(conversation.attributes)

select_ai-1.0.0.dev7/samples/create_ai_credential.py

@@ -0,0 +1,37 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# create_ai_credential.py
+#
+# Create a Database credential storing OCI Gen AI's credentials
+# -----------------------------------------------------------------------------
+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")
+
+select_ai.connect(user=user, password=password, dsn=dsn)
+
+# Default config file and profile
+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"],
+}
+select_ai.create_credential(credential=credential, replace=True)
+print("Created credential: ", credential["credential_name"])

select_ai-1.0.0.dev7/samples/disable_ai_provider.py

@@ -0,0 +1,27 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# disable_ai_provider.py
+#
+# Revokes privileges from the database user and removes ACL to invoke the AI
+# Provider endpoint
+# -----------------------------------------------------------------------------
+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")
+
+select_ai.connect(user=admin_user, password=password, dsn=dsn)
+select_ai.disable_provider(
+    users=select_ai_user, provider_endpoint="*.openai.azure.com"
+)
+print("Disabled AI provider for user: ", select_ai_user)

select_ai-1.0.0.dev7/samples/enable_ai_provider.py

@@ -0,0 +1,28 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# enable_ai_provider.py
+#
+# Grants privileges to the database user and add ACL to invoke the AI Provider
+# endpoint
+# -----------------------------------------------------------------------------
+
+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")
+
+select_ai.connect(user=admin_user, password=password, dsn=dsn)
+select_ai.enable_provider(
+    users=select_ai_user, provider_endpoint="*.openai.azure.com"
+)
+print("Enabled AI provider for user: ", select_ai_user)

{select_ai-1.0.0.dev5 → select_ai-1.0.0.dev7}/samples/profile_chat.py

@@ -5,6 +5,12 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
+# -----------------------------------------------------------------------------
+# profile_chat.py
+#
+# Chat using an AI Profile
+# -----------------------------------------------------------------------------
+
 import os
 
 import select_ai
@@ -13,12 +19,7 @@ user = os.getenv("SELECT_AI_USER")
 password = os.getenv("SELECT_AI_PASSWORD")
 dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
 
-
-def main():
-    select_ai.connect(user=user, password=password, dsn=dsn)
-    profile = select_ai.Profile(profile_name="oci_ai_profile")
-    print(profile.chat(prompt="What is OCI ?"))
-
-
-if __name__ == "__main__":
-    main()
+select_ai.connect(user=user, password=password, dsn=dsn)
+profile = select_ai.Profile(profile_name="oci_ai_profile")
+response = profile.chat(prompt="What is OCI ?")
+print(response)

select_ai-1.0.0.dev7/samples/profile_create.py

@@ -0,0 +1,43 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# profile_create.py
+#
+# Create an OCI Gen AI profile
+# -----------------------------------------------------------------------------
+
+import os
+from pprint import pformat
+
+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)
+provider = select_ai.OCIGenAIProvider(
+    region="us-chicago-1", oci_apiformat="GENERIC"
+)
+profile_attributes = select_ai.ProfileAttributes(
+    credential_name="my_oci_ai_profile_key",
+    object_list=[{"owner": "SH"}],
+    provider=provider,
+)
+profile = select_ai.Profile(
+    profile_name="oci_ai_profile",
+    attributes=profile_attributes,
+    description="MY OCI AI Profile",
+    replace=True,
+)
+print("Created profile ", profile.profile_name)
+profile_attributes = profile.get_attributes()
+print(
+    "Profile attributes are: ",
+    pformat(profile_attributes.dict(exclude_null=False)),
+)