Added HTML doc

Author: aosingh

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: check-yaml
     -   id: check-added-large-files
-        args: ['--maxkb=600']
+        args: ['--maxkb=2000']
 -   repo: https://github.com/psf/black-pre-commit-mirror
     rev: 24.4.2
     hooks:

html_docs/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 36b6c214f26231472002212b71360286
+tags: 645f666f9bcd5a90fca523b33c5a78b7

html_docs/.buildinfo.bak

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 057449c3c388680715e8906e52cf61eb
+tags: 645f666f9bcd5a90fca523b33c5a78b7

html_docs/_images/conversation.png

@@ -0,0 +1,109 @@
+.. Python API for Select AI documentation master file, created by
+   sphinx-quickstart on Thu May 15 08:17:49 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+select_ai documentation
+======================================
+
+``select_ai`` is a Python module which enables integrating `DBMS_CLOUD_AI <https://docs.oracle.com/en-us/iaas/autonomous-database-serverless/doc/dbms-cloud-ai-package.html>`__
+``PL/SQL`` package into Python workflows. It bridges the gap between ``PL/SQL`` package's AI capabilities
+and Python's rich ecosystem.
+
+
+Getting Started
+===============
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/introduction.rst
+    user_guide/installation.rst
+    user_guide/connection.rst
+
+
+Actions
+=======
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/actions.rst
+
+Provider
+========
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/provider.rst
+
+Credential
+==========
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/credential.rst
+
+
+Profile Attributes
+==================
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/profile_attributes.rst
+
+Profile
+==================
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/profile.rst
+
+
+Conversation
+============
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/conversation.rst
+
+
+Vector Index
+============
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/vector_index.rst
+
+Synthetic Data
+==============
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/synthetic_data.rst
+
+
+Select AI Agents
+================
+
+.. toctree::
+    :numbered:
+    :maxdepth: 3
+
+    user_guide/agent.rst

html_docs/_images/profile_provider.png

@@ -0,0 +1,47 @@
+:orphan:
+
+.. _license:
+
+
+.. include:: <isonum.txt>
+
+.. centered:: **LICENSE AGREEMENT FOR python-select-ai**
+
+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.
+
+END OF TERMS AND CONDITIONS

html_docs/_images/vector_index.png

@@ -0,0 +1,45 @@
+.. _actions:
+
+An action in Select AI is a keyword that instructs Select AI to perform different behavior when acting on the prompt.
+
+********************
+Supported Actions
+********************
+
+Following list of actions can be performed using ``select_ai``
+
+.. list-table:: Select AI Actions
+    :header-rows: 1
+    :widths: 20 30 50
+    :align: left
+
+    * - Actions
+      - Enum
+      - Description
+    * - chat
+      - ``select_ai.Action.CHAT``
+      - Enables general conversations with the LLM, potentially for clarifying prompts, exploring data, or generating content.
+    * - explainsql
+      - ``select_ai.Action.EXPLAINSQL``
+      - Explain the generated SQL query
+    * - narrate
+      - ``select_ai.Action.NARRATE``
+      - Explains the output of the query in natural language, making the results accessible to users without deep technical expertise.
+    * - runsql
+      - ``select_ai.Action.RUNSQL``
+      - Executes a SQL query generated from a natural language prompt. This is the default action.
+    * - showprompt
+      - ``select_ai.Action.SHOWPROMPT``
+      - Show the details of the prompt sent to LLM
+    * - showsql
+      - ``select_ai.Action.SHOWSQL``
+      - Displays the generated SQL statement without executing it.
+    * - summarize
+      - ``select_ai.Action.SUMMARIZE``
+      - Generate summary of your large texts
+    * - feedback
+      - ``select_ai.Action.FEEDBACK``
+      - Provide feedback to improve accuracy of the generated SQL
+    * - translate
+      - ``select_ai.Action.TRANSLATE``
+      - Translate text from one language to another