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

select_ai-1.0.0.dev8/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: select_ai
+Version: 1.0.0.dev8
+Summary: Select AI for Python
+Author-email: Abhishek Singh <abhishek.o.singh@oracle.com>
+Maintainer-email: Abhishek Singh <abhishek.o.singh@oracle.com>
+License-Expression: UPL-1.0
+Keywords: oracle,select-ai,adbs,autonomous database serverless
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Database
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: oracledb
+Requires-Dist: pandas==2.2.3
+Dynamic: license-file
+
+# Select AI for Python
+
+
+Select AI for Python enables you to ask questions of your database data using natural language (text-to-SQL), get generative AI responses using your trusted content (retrieval augmented generation), generate synthetic data using large language models, and other features – all from Python. With the general availability of Select AI Python, Python developers have access to the functionality of Select AI on Oracle Autonomous Database.
+
+Select AI for Python enables you to leverage the broader Python ecosystem in combination with generative AI and database functionality - bridging the gap between the DBMS_CLOUD_AI PL/SQL package and Python's rich ecosystem. It provides intuitive objects and methods for AI model interaction.
+
+
+## Installation
+
+Run
+```bash
+python3 -m pip install select_ai
+```
+
+## Samples
+
+Examples can be found in the [/samples][samples] directory
+
+### Basic Example
+
+```python
+import select_ai
+
+user = "<your_select_ai_user>"
+password = "<your_select_ai_password>"
+dsn = "<your_select_ai_db_connect_string>"
+
+select_ai.connect(user=user, password=password, dsn=dsn)
+profile = select_ai.Profile(profile_name="oci_ai_profile")
+df = profile.run_sql(
+    prompt="How many promotions are there in the sh database?"
+)
+print(df.columns)
+print(df)
+```
+
+### Async Example
+
+```python
+
+import asyncio
+
+import select_ai
+
+user = "<your_select_ai_user>"
+password = "<your_select_ai_password>"
+dsn = "<your_select_ai_db_connect_string>"
+
+# This example shows how to asynchronously run sql
+async def main():
+    await select_ai.async_connect(user=user, password=password, dsn=dsn)
+    async_profile = await select_ai.AsyncProfile(
+        profile_name="async_oci_ai_profile",
+    )
+    # run_sql returns a pandas df
+    df = await async_profile.run_sql("How many promotions?")
+    print(df)
+
+asyncio.run(main())
+
+```
+## Help
+
+Questions can be asked in [GitHub Discussions][ghdiscussions].
+
+Problem reports can be raised in [GitHub Issues][ghissues].
+
+## Contributing
+
+
+This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
+
+## Security
+
+Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
+
+## License
+
+Copyright (c) 2025 Oracle and/or its affiliates.
+
+Released under the Universal Permissive License v1.0 as shown at
+<https://oss.oracle.com/licenses/upl/>.
+
+
+[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.0.dev8/README.md

@@ -0,0 +1,88 @@
+# Select AI for Python
+
+
+Select AI for Python enables you to ask questions of your database data using natural language (text-to-SQL), get generative AI responses using your trusted content (retrieval augmented generation), generate synthetic data using large language models, and other features – all from Python. With the general availability of Select AI Python, Python developers have access to the functionality of Select AI on Oracle Autonomous Database.
+
+Select AI for Python enables you to leverage the broader Python ecosystem in combination with generative AI and database functionality - bridging the gap between the DBMS_CLOUD_AI PL/SQL package and Python's rich ecosystem. It provides intuitive objects and methods for AI model interaction.
+
+
+## Installation
+
+Run
+```bash
+python3 -m pip install select_ai
+```
+
+## Samples
+
+Examples can be found in the [/samples][samples] directory
+
+### Basic Example
+
+```python
+import select_ai
+
+user = "<your_select_ai_user>"
+password = "<your_select_ai_password>"
+dsn = "<your_select_ai_db_connect_string>"
+
+select_ai.connect(user=user, password=password, dsn=dsn)
+profile = select_ai.Profile(profile_name="oci_ai_profile")
+df = profile.run_sql(
+    prompt="How many promotions are there in the sh database?"
+)
+print(df.columns)
+print(df)
+```
+
+### Async Example
+
+```python
+
+import asyncio
+
+import select_ai
+
+user = "<your_select_ai_user>"
+password = "<your_select_ai_password>"
+dsn = "<your_select_ai_db_connect_string>"
+
+# This example shows how to asynchronously run sql
+async def main():
+    await select_ai.async_connect(user=user, password=password, dsn=dsn)
+    async_profile = await select_ai.AsyncProfile(
+        profile_name="async_oci_ai_profile",
+    )
+    # run_sql returns a pandas df
+    df = await async_profile.run_sql("How many promotions?")
+    print(df)
+
+asyncio.run(main())
+
+```
+## Help
+
+Questions can be asked in [GitHub Discussions][ghdiscussions].
+
+Problem reports can be raised in [GitHub Issues][ghissues].
+
+## Contributing
+
+
+This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
+
+## Security
+
+Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
+
+## License
+
+Copyright (c) 2025 Oracle and/or its affiliates.
+
+Released under the Universal Permissive License v1.0 as shown at
+<https://oss.oracle.com/licenses/upl/>.
+
+
+[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.0.dev7 → select_ai-1.0.0.dev8}/pyproject.toml

@@ -5,7 +5,8 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "select_ai"
 dynamic = ["version"]
-description = "Python API for Select AI"
+description = "Select AI for Python"
+readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.9"
 authors = [
     {name="Abhishek Singh", email="abhishek.o.singh@oracle.com"}
@@ -22,7 +23,7 @@ keywords = [
 license = " UPL-1.0"
 license-files = ["LICENSE.txt"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "Natural Language :: English",
     "Operating System :: OS Independent",

select_ai-1.0.0.dev8/samples/async/create_ai_credential.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/create_ai_credential.py
+#
+# Async API to create credential
+# -----------------------------------------------------------------------------
+
+import asyncio
+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")
+
+
+async def main():
+    await select_ai.async_connect(user=user, password=password, dsn=dsn)
+    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"],
+    }
+    await select_ai.async_create_credential(
+        credential=credential, replace=True
+    )
+    print("Created credential: ", credential["credential_name"])
+
+
+asyncio.run(main())

select_ai-1.0.0.dev8/samples/async/delete_ai_credential.py

@@ -0,0 +1,32 @@
+# -----------------------------------------------------------------------------
+# 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/delete_ai_credential
+#
+# Async API to delete credential
+# -----------------------------------------------------------------------------
+
+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)
+    await select_ai.async_delete_credential(
+        credential_name="my_oci_ai_profile_key", force=True
+    )
+    print("Deleted credential: my_oci_ai_profile_key")
+
+
+asyncio.run(main())

select_ai-1.0.0.dev8/samples/async/disable_ai_provider.py

@@ -0,0 +1,33 @@
+# -----------------------------------------------------------------------------
+# 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/disable_ai_provider.py
+#
+# Async API to disable AI provider for database users
+# -----------------------------------------------------------------------------
+
+import asyncio
+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")
+
+
+async def main():
+    await select_ai.async_connect(user=admin_user, password=password, dsn=dsn)
+    await select_ai.async_disable_provider(
+        users=select_ai_user, provider_endpoint="*.openai.azure.com"
+    )
+    print("Disabled AI provider for user: ", select_ai_user)
+
+
+asyncio.run(main())

select_ai-1.0.0.dev8/samples/async/enable_ai_provider.py

@@ -0,0 +1,33 @@
+# -----------------------------------------------------------------------------
+# 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/enable_ai_provider.py
+#
+# Async API to enable AI provider for database users
+# -----------------------------------------------------------------------------
+
+import asyncio
+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")
+
+
+async def main():
+    await select_ai.async_connect(user=admin_user, password=password, dsn=dsn)
+    await select_ai.async_enable_provider(
+        users=select_ai_user, provider_endpoint="*.openai.azure.com"
+    )
+    print("Enabled AI provider for user: ", select_ai_user)
+
+
+asyncio.run(main())

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

@@ -19,13 +19,12 @@ password = os.getenv("SELECT_AI_PASSWORD")
 dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
 
 
-# This example shows how to asynchronously ask the LLM to explain SQL
 async def main():
     await select_ai.async_connect(user=user, password=password, dsn=dsn)
     async_profile = await select_ai.AsyncProfile(
         profile_name="async_oci_ai_profile",
     )
-    response = await async_profile.explain_sql("How many promotions")
+    response = await async_profile.explain_sql("How many promotions ?")
     print(response)
 
 

select_ai-1.0.0.dev8/samples/async/profile_gen_multi_table_synthetic_data.py

@@ -0,0 +1,48 @@
+# -----------------------------------------------------------------------------
+# 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/profile_gen_multi_table_synthetic_data.py
+# -----------------------------------------------------------------------------
+
+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_profile = await select_ai.AsyncProfile(
+        profile_name="async_oci_ai_profile",
+    )
+    synthetic_data_params = select_ai.SyntheticDataParams(
+        sample_rows=100, table_statistics=True, priority="HIGH"
+    )
+    object_list = [
+        {
+            "owner": user,
+            "name": "MOVIE",
+            "record_count": 100,
+            "user_prompt": "the release date for the movies should be in 2019",
+        },
+        {"owner": user, "name": "ACTOR", "record_count": 10},
+        {"owner": user, "name": "DIRECTOR", "record_count": 5},
+    ]
+    synthetic_data_attributes = select_ai.SyntheticDataAttributes(
+        object_list=object_list, params=synthetic_data_params
+    )
+    await async_profile.generate_synthetic_data(
+        synthetic_data_attributes=synthetic_data_attributes
+    )
+
+
+asyncio.run(main())

select_ai-1.0.0.dev8/samples/async/profile_gen_single_table_synthetic_data.py

@@ -0,0 +1,41 @@
+# -----------------------------------------------------------------------------
+# 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/profile_gen_single_table_synthetic_data.py
+# -----------------------------------------------------------------------------
+
+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_profile = await select_ai.AsyncProfile(
+        profile_name="async_oci_ai_profile",
+    )
+    synthetic_data_params = select_ai.SyntheticDataParams(
+        sample_rows=100, table_statistics=True, priority="HIGH"
+    )
+    synthetic_data_attributes = select_ai.SyntheticDataAttributes(
+        object_name="MOVIE",
+        user_prompt="the release date for the movies should be in 2019",
+        params=synthetic_data_params,
+        record_count=100,
+    )
+    await async_profile.generate_synthetic_data(
+        synthetic_data_attributes=synthetic_data_attributes
+    )
+
+
+asyncio.run(main())

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

@@ -28,7 +28,7 @@ async def main():
         profile_name="async_oci_ai_profile",
     )
     # run_sql returns a pandas df
-    df = await async_profile.run_sql("How many promotions")
+    df = await async_profile.run_sql("How many promotions?")
     print(df)
 
 

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

@@ -26,7 +26,7 @@ async def main():
     async_profile = await select_ai.AsyncProfile(
         profile_name="async_oci_ai_profile",
     )
-    response = await async_profile.show_sql("How many promotions")
+    response = await async_profile.show_sql("How many promotions?")
     print(response)
 
 

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

@@ -29,8 +29,8 @@ async def main():
     )
     sql_tasks = [
         async_profile.show_sql(prompt="How many customers?"),
-        async_profile.run_sql(prompt="How many promotions"),
-        async_profile.explain_sql(prompt="How many promotions"),
+        async_profile.run_sql(prompt="How many promotions?"),
+        async_profile.explain_sql(prompt="How many promotions?"),
     ]
 
     # Collect results from multiple asynchronous tasks

{select_ai-1.0.0.dev7 → select_ai-1.0.0.dev8}/samples/conversation_chat_session.py

@@ -10,6 +10,7 @@
 #
 # Demonstrates context aware conversation using AI Profile
 # -----------------------------------------------------------------------------
+
 import os
 
 import select_ai

{select_ai-1.0.0.dev7 → select_ai-1.0.0.dev8}/samples/conversation_create.py

@@ -11,6 +11,7 @@
 # Create a new conversation given a title and description. The created
 # conversation can be used in profile.chat_session()
 # -----------------------------------------------------------------------------
+
 import os
 
 import select_ai

{select_ai-1.0.0.dev7 → select_ai-1.0.0.dev8}/samples/create_ai_credential.py

@@ -10,6 +10,7 @@
 #
 # Create a Database credential storing OCI Gen AI's credentials
 # -----------------------------------------------------------------------------
+
 import os
 
 import oci

select_ai-1.0.0.dev8/samples/delete_ai_credential.py

@@ -0,0 +1,25 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# delete_ai_credential.py
+#
+# Delete AI credential
+# -----------------------------------------------------------------------------
+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)
+select_ai.delete_credential(
+    credential_name="my_oci_ai_profile_key", force=True
+)
+print("Deleted credential: my_oci_ai_profile_key")

{select_ai-1.0.0.dev7 → select_ai-1.0.0.dev8}/samples/profile_explain_sql.py

@@ -23,6 +23,6 @@ profile = select_ai.Profile(
 )
 print(profile.description)
 explanation = profile.explain_sql(
-    prompt="How many promotions are there in the sh database?"
+    prompt="How many promotions are there in the database?"
 )
 print(explanation)

{select_ai-1.0.0.dev7 → select_ai-1.0.0.dev8}/samples/profile_narrate.py

@@ -24,6 +24,6 @@ profile = select_ai.Profile(
     profile_name="oci_ai_profile",
 )
 narration = profile.narrate(
-    prompt="How many promotions are there in the sh database?"
+    prompt="How many promotions are there in the database?"
 )
 print(narration)

{select_ai-1.0.0.dev7 → select_ai-1.0.0.dev8}/samples/profile_run_sql.py

@@ -22,7 +22,7 @@ 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")
 df = profile.run_sql(
-    prompt="How many promotions are there in the sh database?"
+    prompt="How many promotions are there in the database?"
 )
 print(df.columns)
 print(df)

{select_ai-1.0.0.dev7 → select_ai-1.0.0.dev8}/samples/profile_show_sql.py

@@ -22,6 +22,6 @@ 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")
 sql = profile.show_sql(
-    prompt="How many promotions are there in the sh database?"
+    prompt="How many promotions are there in the database?"
 )
 print(sql)

{select_ai-1.0.0.dev7 → select_ai-1.0.0.dev8}/src/select_ai/__init__.py

@@ -6,11 +6,6 @@
 # -----------------------------------------------------------------------------
 
 from .action import Action
-from .admin import (
-    create_credential,
-    disable_provider,
-    enable_provider,
-)
 from .async_profile import AsyncProfile
 from .base_profile import BaseProfile, ProfileAttributes
 from .conversation import (
@@ -18,6 +13,12 @@ from .conversation import (
     Conversation,
     ConversationAttributes,
 )
+from .credential import (
+    async_create_credential,
+    async_delete_credential,
+    create_credential,
+    delete_credential,
+)
 from .db import (
     async_connect,
     async_cursor,
@@ -39,6 +40,10 @@ from .provider import (
     OCIGenAIProvider,
     OpenAIProvider,
     Provider,
+    async_disable_provider,
+    async_enable_provider,
+    disable_provider,
+    enable_provider,
 )
 from .synthetic_data import (
     SyntheticDataAttributes,