Updated samples

aosingh · aosingh · commit 8af166ce7fa4 · 2025-08-05T18:03:44.000-07:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # select-ai
 
-Python API for Select AI
+Select AI for Python
 
 ## Install
 
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -20,7 +20,7 @@
     "undoc-members": True,
 }
 
-project = "Python API for Select AI"
+project = "Select AI for Python"
 copyright = "2025, Oracle and/or its affiliates. All rights reserved."
 author = "Oracle"
 
diff --git a/doc/source/user_guide/installation.rst b/doc/source/user_guide/installation.rst
@@ -50,9 +50,9 @@ To use ``select_ai`` you need:
      import select_ai
      import getpass
 
-     username = ""
-     dsn = ""
-     password = getpass.getpass(f"Enter password for {username}@{dsn}")
+     user = "<your_db_user>"
+     password = "<your_db_password>"
+     dsn = "<your_db_dsn>"
      select_ai.connect(user=user, password=password, dsn=dsn)
      print("Connected to the Database")
 
@@ -67,3 +67,5 @@ To use ``select_ai`` you need:
   .. code-block:: shell
 
      Connected to the Database
+
+.. latex:clearpage::
diff --git a/doc/source/user_guide/introduction.rst b/doc/source/user_guide/introduction.rst
@@ -1,7 +1,7 @@
 .. _introduction:
 
 *****************************************************
-Introduction to the Python API for Select AI
+Introduction to Select AI for Python
 *****************************************************
 
 ``select_ai`` is a Python module that helps you invoke `DBMS_CLOUD_AI <https://docs.oracle.com/en-us/iaas/autonomous-database-serverless/doc/dbms-cloud-ai-package.html>`__
@@ -14,3 +14,5 @@ programming styles.
 
 The Select AI Python API supports Python versions 3.9, 3.10, 3.11, 3.12 and
 3.13.
+
+.. latex:clearpage::
diff --git a/doc/source/user_guide/provider.rst b/doc/source/user_guide/provider.rst
@@ -90,9 +90,9 @@ Enable AI service provider
 .. note::
 
    All sample scripts in this documentation read Oracle database connection
-   details from environment. Create a dotenv file ``.env``, export the
+   details from the environment. Create a dotenv file ``.env``, export the
    the following environment variables and source it before running the
-   scripts:
+   scripts.
 
    .. code-block:: sh
 
diff --git a/samples/async/conversation_chat_session.py b/samples/async/conversation_chat_session.py
@@ -4,11 +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
diff --git a/samples/async/conversations_list.py b/samples/async/conversations_list.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/conversations_list.py
 #
 # List all conversations saved in the database
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
diff --git a/samples/async/profile_chat.py b/samples/async/profile_chat.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/profile_chat.py
 #
 # Chat using an AI Profile
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
diff --git a/samples/async/profile_create.py b/samples/async/profile_create.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/profile_create.py
 #
 # Create an OCI Gen AI profile
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
diff --git a/samples/async/profile_explain_sql.py b/samples/async/profile_explain_sql.py
@@ -5,9 +5,9 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/profile_explain_sql.py
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
diff --git a/samples/async/profile_pipeline.py b/samples/async/profile_pipeline.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/profile_pipeline.py
 #
 # Demonstrates sending multiple prompts using a single Database round-trip
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
diff --git a/samples/async/profile_run_sql.py b/samples/async/profile_run_sql.py
@@ -5,11 +5,11 @@
 # 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
diff --git a/samples/async/profile_show_sql.py b/samples/async/profile_show_sql.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/profile_show_sql.py
 #
 # Show the generated SQL without executing it
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
diff --git a/samples/async/profile_sql_concurrent_tasks.py b/samples/async/profile_sql_concurrent_tasks.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/profile_sql_concurrent_tasks.py
 #
 # Demonstrates sending multiple prompts concurrently using asyncio
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 
 import asyncio
diff --git a/samples/async/profiles_list.py b/samples/async/profiles_list.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/profile_list.py
 #
 # List all the profile names matching a certain pattern
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
diff --git a/samples/async/vector_index_create.py b/samples/async/vector_index_create.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/vector_index_create.py
 #
 # Create a vector index for Retrieval Augmented Generation (RAG)
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 
 import asyncio
diff --git a/samples/async/vector_index_delete.py b/samples/async/vector_index_delete.py
@@ -5,9 +5,9 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/vector_index_delete.py
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import asyncio
 import os
diff --git a/samples/async/vector_index_list.py b/samples/async/vector_index_list.py
@@ -5,12 +5,12 @@
 # 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
diff --git a/samples/async/vector_index_rag.py b/samples/async/vector_index_rag.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # async/vector_index_rag.py
 #
 # Demonstrates Retrieval Augmented Generation (RAG) using ai_profile.narrate()
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 
 import asyncio
diff --git a/samples/conversation_chat_session.py b/samples/conversation_chat_session.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # conversation_chat_session.py
 #
 # Demonstrates context aware conversation using AI Profile
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 import os
 
 import select_ai
diff --git a/samples/conversation_create.py b/samples/conversation_create.py
@@ -5,12 +5,12 @@
 # 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
diff --git a/samples/conversation_delete.py b/samples/conversation_delete.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # conversation_delete.py
 #
 # Delete conversation given a conversation id
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import os
 
diff --git a/samples/conversations_list.py b/samples/conversations_list.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # conversations_list.py
 #
 # List all conversations saved in the database
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import os
 
diff --git a/samples/create_ai_credential.py b/samples/create_ai_credential.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # create_ai_credential.py
 #
 # Create a Database credential storing OCI Gen AI's credentials
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 import os
 
 import oci
diff --git a/samples/disable_ai_provider.py b/samples/disable_ai_provider.py
@@ -5,12 +5,12 @@
 # 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
diff --git a/samples/enable_ai_provider.py b/samples/enable_ai_provider.py
@@ -5,12 +5,12 @@
 # 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
 
@@ -21,14 +21,8 @@
 dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
 select_ai_user = os.getenv("SELECT_AI_USER")
 
-
-def main():
-    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)
-
-
-if __name__ == "__main__":
-    main()
+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)
diff --git a/samples/profile_chat.py b/samples/profile_chat.py
@@ -5,11 +5,11 @@
 # http://oss.oracle.com/licenses/upl.
 # -----------------------------------------------------------------------------
 
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # profile_chat.py
 #
 # Chat using an AI Profile
-# ------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import os
 
diff --git a/samples/profile_create.py b/samples/profile_create.py
diff --git a/samples/profile_delete.py b/samples/profile_delete.py
diff --git a/samples/profile_explain_sql.py b/samples/profile_explain_sql.py
diff --git a/samples/profile_gen_multi_table_synthetic_data.py b/samples/profile_gen_multi_table_synthetic_data.py
diff --git a/samples/profile_gen_single_table_synthetic_data.py b/samples/profile_gen_single_table_synthetic_data.py
diff --git a/samples/profile_narrate.py b/samples/profile_narrate.py
diff --git a/samples/profile_run_sql.py b/samples/profile_run_sql.py
diff --git a/samples/profile_show_sql.py b/samples/profile_show_sql.py
diff --git a/samples/profiles_list.py b/samples/profiles_list.py
diff --git a/samples/vector_index_create.py b/samples/vector_index_create.py
diff --git a/samples/vector_index_delete.py b/samples/vector_index_delete.py
diff --git a/samples/vector_index_list.py b/samples/vector_index_list.py
diff --git a/samples/vector_index_rag.py b/samples/vector_index_rag.py

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`"undoc-members": True,`
`21`	`21`	`}`
`22`	`22`
`23`		`-project = "Python API for Select AI"`
	`23`	`+project = "Select AI for Python"`
`24`	`24`	`copyright = "2025, Oracle and/or its affiliates. All rights reserved."`
`25`	`25`	`author = "Oracle"`
`26`	`26`