select-ai 1.0.0__tar.gz

select_ai-1.0.0/LICENSE.txt

@@ -0,0 +1,35 @@
+Copyright (c) 2025, Oracle and/or its affiliates.
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any
+person obtaining a copy of this software, associated documentation and/or data
+(collectively the "Software"), free of charge and under any and all copyright
+rights in the Software, and any and all patent rights owned or freely
+licensable by each licensor hereunder covering either (i) the unmodified
+Software as contributed to or provided by such licensor, or (ii) the Larger
+Works (as defined below), to deal in both
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+one is included with the Software (each a "Larger Work" to which the Software
+is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create
+derivative works of, display, perform, and distribute the Software and make,
+use, sell, offer for sale, import, export, have made, and have sold the
+Software and the Larger Work(s), and to sublicense the foregoing rights on
+either these or other terms.
+
+This license is subject to the following condition:
+The above copyright notice and either this complete permission notice or at
+a minimum a reference to the UPL must be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

select_ai-1.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include tests *.py
+recursive-include samples *.py

select_ai-1.0.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: select_ai
+Version: 1.0.0
+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
+Project-URL: Homepage, https://github.com/oracle/python-select-ai
+Project-URL: Repository, https://github.com/oracle/python-select-ai
+Project-URL: Issues, https://github.com/oracle/python-select-ai/issues
+Project-URL: Documentation, https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/pysai/
+Keywords: oracle,select-ai,adbs,autonomous database serverless
+Classifier: Development Status :: 5 - Production/Stable
+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
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+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
+```
+
+## Documentation
+
+See [Select AI for Python documentation][documentation]
+
+## 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")
+# run_sql returns a pandas dataframe
+df = profile.run_sql(prompt="How many promotions?")
+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]
+
+## Security
+
+Please consult the [security guide][security] 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/>.
+
+[contributing]: https://github.com/oracle/python-select-ai/blob/main/CONTRIBUTING.md
+[documentation]: https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/pysai/
+[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
+[security]: https://github.com/oracle/python-select-ai/blob/main/SECURITY.md

select_ai-1.0.0/README.md

@@ -0,0 +1,92 @@
+# 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
+```
+
+## Documentation
+
+See [Select AI for Python documentation][documentation]
+
+## 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")
+# run_sql returns a pandas dataframe
+df = profile.run_sql(prompt="How many promotions?")
+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]
+
+## Security
+
+Please consult the [security guide][security] 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/>.
+
+[contributing]: https://github.com/oracle/python-select-ai/blob/main/CONTRIBUTING.md
+[documentation]: https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/pysai/
+[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
+[security]: https://github.com/oracle/python-select-ai/blob/main/SECURITY.md

select_ai-1.0.0/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["setuptools >= 77.0.3", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "select_ai"
+dynamic = ["version"]
+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"}
+]
+maintainers =[
+    {name="Abhishek Singh", email="abhishek.o.singh@oracle.com"}
+]
+keywords = [
+	"oracle",
+	"select-ai",
+    "adbs",
+    "autonomous database serverless"
+]
+license = " UPL-1.0"
+license-files = ["LICENSE.txt"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Database",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+dependencies = [
+    "oracledb",
+    "pandas==2.2.3"
+]
+
+[project.urls]
+Homepage = "https://github.com/oracle/python-select-ai"
+Repository = "https://github.com/oracle/python-select-ai"
+Issues = "https://github.com/oracle/python-select-ai/issues"
+Documentation = "https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/pysai/"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = { attr = "select_ai.version.__version__" }
+
+[tool.black]
+line-length = 79
+target-version = ["py39", "py310", "py311", "py312", "py313"]
+required-version = 24
+
+[tool.ruff]
+line-length = 79
+target-version = "py39"
+per-file-ignores = { "__init__.py" = ["F401"] }

select_ai-1.0.0/samples/async/conversation_chat_session.py

@@ -0,0 +1,49 @@
+# -----------------------------------------------------------------------------
+# 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/conversation_chat_session.py
+#
+# Demonstrates context aware conversation using AI Profile
+# -----------------------------------------------------------------------------
+
+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"
+    )
+    conversation_attributes = select_ai.ConversationAttributes(
+        title="History of Science",
+        description="LLM's understanding of history of science",
+    )
+    async_conversation = select_ai.AsyncConversation(
+        attributes=conversation_attributes
+    )
+
+    async with async_profile.chat_session(
+        conversation=async_conversation, delete=True
+    ) as async_session:
+        response = await async_session.chat(
+            prompt="What is importance of history of science ?"
+        )
+        print(response)
+        response = await async_session.chat(
+            prompt="Elaborate more on 'Learning from past mistakes'"
+        )
+        print(response)
+
+
+asyncio.run(main())

select_ai-1.0.0/samples/async/conversations_list.py

@@ -0,0 +1,31 @@
+# -----------------------------------------------------------------------------
+# 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/conversations_list.py
+#
+# List all conversations saved in the database
+# -----------------------------------------------------------------------------
+
+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 for conversation in select_ai.AsyncConversation().list():
+        print(conversation.conversation_id)
+        print(conversation.attributes)
+
+
+asyncio.run(main())

select_ai-1.0.0/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/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/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/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/samples/async/profile_chat.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_chat.py
+#
+# Chat using an AI Profile
+# -----------------------------------------------------------------------------
+
+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"
+    )
+
+    # Asynchronously send multiple chat prompts
+    chat_tasks = [
+        async_profile.chat(prompt="What is OCI ?"),
+        async_profile.chat(prompt="What is OML4PY?"),
+        async_profile.chat(prompt="What is Autonomous Database ?"),
+    ]
+    for chat_task in asyncio.as_completed(chat_tasks):
+        result = await chat_task
+        print(result)
+
+
+asyncio.run(main())

select_ai-1.0.0/samples/async/profile_create.py

@@ -0,0 +1,50 @@
+# -----------------------------------------------------------------------------
+# 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_create.py
+#
+# Create an OCI Gen AI profile
+# -----------------------------------------------------------------------------
+
+import asyncio
+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")
+
+
+# This example shows how to asynchronously generate SQLs nad run SQLs
+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"
+    )
+    profile_attributes = select_ai.ProfileAttributes(
+        credential_name="my_oci_ai_profile_key",
+        object_list=[{"owner": "SH"}],
+        provider=provider,
+    )
+    async_profile = await select_ai.AsyncProfile(
+        profile_name="async_oci_ai_profile",
+        attributes=profile_attributes,
+        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: ",
+        pformat(profile_attributes.dict(exclude_null=False)),
+    )
+
+
+asyncio.run(main())

select_ai-1.0.0/samples/async/profile_explain_sql.py

@@ -0,0 +1,31 @@
+# -----------------------------------------------------------------------------
+# 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_explain_sql.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",
+    )
+    response = await async_profile.explain_sql("How many promotions ?")
+    print(response)
+
+
+asyncio.run(main())