Simplifed doc and bug fixes

Author: aosingh

doc/source/user_guide/async_profile.rst

@@ -16,7 +16,7 @@ used with ``await``.
 Async Profile creation
 ***********************
 
-.. literalinclude:: ../../../samples/async_samples/profile_create.py
+.. literalinclude:: ../../../samples/async/profile_create.py
    :language: python
 
 output::
@@ -54,7 +54,7 @@ output::
 Async explain SQL
 ***********************
 
-.. literalinclude:: ../../../samples/async_samples/profile_explain_sql.py
+.. literalinclude:: ../../../samples/async/profile_explain_sql.py
    :language: python
 
 output::
@@ -82,7 +82,7 @@ output::
 Async run SQL
 ***********************
 
-.. literalinclude:: ../../../samples/async_samples/profile_run_sql.py
+.. literalinclude:: ../../../samples/async/profile_run_sql.py
    :language: python
 
 output::
@@ -94,7 +94,7 @@ output::
 Async show SQL
 ***********************
 
-.. literalinclude:: ../../../samples/async_samples/profile_show_sql.py
+.. literalinclude:: ../../../samples/async/profile_show_sql.py
    :language: python
 
 output::
@@ -106,7 +106,7 @@ output::
 Async concurrent SQL
 ***********************
 
-.. literalinclude:: ../../../samples/async_samples/profile_sql_concurrent_tasks.py
+.. literalinclude:: ../../../samples/async/profile_sql_concurrent_tasks.py
    :language: python
 
 output::
@@ -139,7 +139,7 @@ output::
 Async chat
 **********
 
-.. literalinclude:: ../../../samples/async_samples/profile_chat.py
+.. literalinclude:: ../../../samples/async/profile_chat.py
    :language: python
 
 output::
@@ -162,7 +162,7 @@ output::
 Async pipeline
 *********************
 
-.. literalinclude:: ../../../samples/async_samples/profile_pipeline.py
+.. literalinclude:: ../../../samples/async/profile_pipeline.py
    :language: python
 
 output::
@@ -192,7 +192,7 @@ output::
 List profiles asynchronously
 ****************************
 
-.. literalinclude:: ../../../samples/async_samples/profiles_list.py
+.. literalinclude:: ../../../samples/async/profiles_list.py
    :language: python
 
 output::

doc/source/user_guide/conversation.rst

@@ -93,7 +93,7 @@ output::
 Async chat session
 ++++++++++++++++++
 
-.. literalinclude:: ../../../samples/async_samples/conversation_chat_session.py
+.. literalinclude:: ../../../samples/async/conversation_chat_session.py
    :language: python
 
 output::
@@ -114,7 +114,7 @@ output::
 Async list conversations
 ++++++++++++++++++++++++
 
-.. literalinclude:: ../../../samples/async_samples/conversations_list.py
+.. literalinclude:: ../../../samples/async/conversations_list.py
    :language: python
 
 output::

doc/source/user_guide/profile.rst

@@ -137,7 +137,6 @@ List profiles
 .. literalinclude:: ../../../samples/profiles_list.py
    :language: python
 
-
 output::
 
     OCI_AI_PROFILE
@@ -146,8 +145,4 @@ output::
 Async Profile
 *************
 
-.. toctree::
-    :numbered:
-    :maxdepth: 3
-
-    async_profile.rst
+async_profile.rst

doc/source/user_guide/vector_index.rst

@@ -118,7 +118,7 @@ A ``AsyncVectorIndex`` object can be created with ``select_ai.AsyncVectorIndex()
 Async create vector index
 +++++++++++++++++++++++++
 
-.. literalinclude:: ../../../samples/async_samples/vector_index_create.py
+.. literalinclude:: ../../../samples/async/vector_index_create.py
    :language: python
 
 output::
@@ -129,7 +129,7 @@ output::
 Async list vector index
 ++++++++++++++++++++++++
 
-.. literalinclude:: ../../../samples/async_samples/vector_index_list.py
+.. literalinclude:: ../../../samples/async/vector_index_list.py
    :language: python
 
 output::
@@ -141,7 +141,7 @@ output::
 Async RAG using vector index
 ++++++++++++++++++++++++++++
 
-.. literalinclude:: ../../../samples/async_samples/vector_index_rag.py
+.. literalinclude:: ../../../samples/async/vector_index_rag.py
    :language: python
 
 output::

samples/async_samples/conversation_chat_session.py renamed to 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())

samples/async_samples/conversations_list.py renamed to 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())

samples/async_samples/profile_chat.py renamed to 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())

samples/async_samples/profile_create.py renamed to 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
@@ -43,5 +49,4 @@ async def main():
     )
 
 
-if __name__ == "__main__":
-    asyncio.run(main())
+asyncio.run(main())

samples/async_samples/profile_explain_sql.py renamed to 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())

samples/async_samples/profile_pipeline.py renamed to 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())