select-ai 1.0.0.dev4__py3-none-any.whl

select_ai/__init__.py

@@ -0,0 +1,52 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+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 (
+    AsyncConversation,
+    Conversation,
+    ConversationAttributes,
+)
+from .db import (
+    async_connect,
+    async_cursor,
+    async_is_connected,
+    connect,
+    cursor,
+    is_connected,
+)
+from .profile import Profile
+from .provider import (
+    AnthropicProvider,
+    AWSProvider,
+    AzureProvider,
+    CohereProvider,
+    GoogleProvider,
+    HuggingFaceProvider,
+    OCIGenAIProvider,
+    OpenAIProvider,
+    Provider,
+)
+from .synthetic_data import (
+    SyntheticDataAttributes,
+    SyntheticDataParams,
+)
+from .vector_index import (
+    AsyncVectorIndex,
+    OracleVectorIndexAttributes,
+    VectorDistanceMetric,
+    VectorIndex,
+    VectorIndexAttributes,
+)
+from .version import __version__ as __version__

select_ai/_abc.py

@@ -0,0 +1,74 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+import json
+import typing
+from abc import ABC
+from dataclasses import dataclass, fields
+from typing import Any, List, Mapping
+
+__all__ = ["SelectAIDataClass"]
+
+
+def _bool(value: Any) -> bool:
+    if isinstance(value, bool):
+        return value
+    if isinstance(value, int):
+        return bool(value)
+    if value.lower() in ('yes', 'true', 't', 'y', '1'):
+        return True
+    elif value.lower() in ('no', 'false', 'f', 'n', '0'):
+        return False
+    else:
+        raise ValueError(f"Invalid boolean value: {value}")
+
+@dataclass
+class SelectAIDataClass(ABC):
+    """SelectAIDataClass is an abstract container for all data
+    models defined in the select_ai Python module
+    """
+
+    def __getitem__(self, item):
+        return getattr(self, item)
+
+    def __setitem__(self, key, value):
+        setattr(self, key, value)
+
+    @classmethod
+    def keys(cls):
+        return set([field.name for field in fields(cls)])
+
+    def dict(self, exclude_null=True):
+        attributes = {}
+        for k, v in self.__dict__.items():
+            if v is not None or not exclude_null:
+                attributes[k] = v
+        return attributes
+
+    def json(self, exclude_null=True):
+        return json.dumps(self.dict(exclude_null=exclude_null))
+
+    def __post_init__(self):
+        for field in fields(self):
+            value = getattr(self, field.name)
+            if value is not None:
+                if field.type is typing.Optional[int]:
+                    setattr(self, field.name, int(value))
+                elif field.type is typing.Optional[str]:
+                    setattr(self, field.name, str(value))
+                elif field.type is typing.Optional[bool]:
+                    setattr(self, field.name, _bool(value))
+                elif field.type is typing.Optional[float]:
+                    setattr(self, field.name, float(value))
+                elif field.type is typing.Optional[Mapping] and isinstance(
+                    value, (str, bytes, bytearray)
+                ):
+                    setattr(self, field.name, json.loads(value))
+                elif field.type is typing.Optional[
+                    List[typing.Mapping]
+                ] and isinstance(value, (str, bytes, bytearray)):
+                    setattr(self, field.name, json.loads(value))

select_ai/_enums.py

@@ -0,0 +1,14 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+import enum
+
+
+class StrEnum(str, enum.Enum):
+
+    def __str__(self):
+        return self.value

select_ai/action.py

@@ -0,0 +1,21 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+from select_ai._enums import StrEnum
+
+__all__ = ["Action"]
+
+
+class Action(StrEnum):
+    """Supported Select AI actions"""
+
+    RUNSQL = "runsql"
+    SHOWSQL = "showsql"
+    EXPLAINSQL = "explainsql"
+    NARRATE = "narrate"
+    CHAT = "chat"
+    SHOWPROMPT = "showprompt"

select_ai/admin.py

@@ -0,0 +1,108 @@
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+
+from typing import List, Mapping
+
+import oracledb
+
+from .db import cursor
+from .sql import (
+    DISABLE_AI_PROFILE_DOMAIN_FOR_USER,
+    ENABLE_AI_PROFILE_DOMAIN_FOR_USER,
+    GRANT_PRIVILEGES_TO_USER,
+    REVOKE_PRIVILEGES_FROM_USER,
+)
+
+__all__ = [
+    "create_credential",
+    "disable_provider",
+    "enable_provider",
+]
+
+
+def create_credential(credential: Mapping, replace: bool = False):
+    """
+    Creates a credential object using DBMS_CLOUD.CREATE_CREDENTIAL
+
+    if replace is True, credential will be replaced if it "already exists"
+
+    """
+    valid_keys = {
+        "credential_name",
+        "username",
+        "password",
+        "user_ocid",
+        "tenancy_ocid",
+        "private_key",
+        "fingerprint",
+        "comments",
+    }
+    for k in credential.keys():
+        if k.lower() not in valid_keys:
+            raise ValueError(
+                f"Invalid value {k}: {credential[k]} for credential object"
+            )
+
+    with cursor() as cr:
+        try:
+            cr.callproc(
+                "DBMS_CLOUD.CREATE_CREDENTIAL", keyword_parameters=credential
+            )
+        except oracledb.DatabaseError as e:
+            (error,) = e.args
+            # If already exists and replace is True then drop and recreate
+            if "already exists" in error.message.lower() and replace:
+                cr.callproc(
+                    "DBMS_CLOUD.DROP_CREDENTIAL",
+                    keyword_parameters={
+                        "credential_name": credential["credential_name"]
+                    },
+                )
+                cr.callproc(
+                    "DBMS_CLOUD.CREATE_CREDENTIAL",
+                    keyword_parameters=credential,
+                )
+            else:
+                raise
+
+
+def enable_provider(users: List[str], provider_endpoint: str = None):
+    """
+    Enables AI profile for the user. This method grants execute privilege
+    on the packages DBMS_CLOUD, DBMS_CLOUD_AI and DBMS_CLOUD_PIPELINE. It
+    also enables the user to invoke the AI(LLM) endpoint hosted at a
+    certain domain
+    """
+
+    with cursor() as cr:
+        for user in users:
+            cr.execute(GRANT_PRIVILEGES_TO_USER.format(user))
+            if provider_endpoint:
+                cr.execute(
+                    ENABLE_AI_PROFILE_DOMAIN_FOR_USER,
+                    user=user,
+                    host=provider_endpoint,
+                )
+
+
+def disable_provider(users: List[str], provider_endpoint: str = None):
+    """
+    Disables AI provider for the user. This method revokes execute privilege
+    on the packages DBMS_CLOUD, DBMS_CLOUD_AI and DBMS_CLOUD_PIPELINE. It
+    also disables the user to invoke the AI(LLM) endpoint hosted at a
+    certain domain
+    """
+
+    with cursor() as cr:
+        for user in users:
+            cr.execute(REVOKE_PRIVILEGES_FROM_USER.format(user))
+            if provider_endpoint:
+                cr.execute(
+                    DISABLE_AI_PROFILE_DOMAIN_FOR_USER,
+                    user=user,
+                    host=provider_endpoint,
+                )