Source code for smarter.apps.plugin.manifest.enum

"""Smarter API PLugin Manifest - enumerated datatypes."""

from smarter.lib.manifest.enum import SmarterEnumAbstract


###############################################################################
# Enums for describing possible manifest key values
###############################################################################


class SAMPluginCommonMetadataClassValues(SmarterEnumAbstract):
    """Smarter API Plugin Metadata Class keys enumeration."""

    # a plugin that returns a static json response contained inside the plugin manifest
    LEGACY = "static"

    # a plugin that returns a static json response contained inside the plugin manifest
    STATIC = "static"

    # a plugin that returns a dynamic json response by
    # executing an http request to a remote server that returns a json response
    API = "api"

    # a plugin that returns a dynamic json response by executing a sql query
    # to a database that returns a mysql readable object response
    SQL = "sql"





class SAMPluginCommonSpecSelectorKeyDirectiveValues(SmarterEnumAbstract):
    """Smarter API Plugin Spec Selector keys enumeration."""

    # Smarter handler applied key word search
    SEARCHTERMS = "search_terms"

    # Plugin is always selected, for every prompt request
    ALWAYS = "always"

    # Plugin is included in a list of plugins shown to an LLM prompt
    # in which we ask it to select suitable plugins to use for the prompt
    LLM = "llm"



###############################################################################
# Enums for manifest keys in error handlers and other on-screen messages
###############################################################################


class SAMPluginCommonMetadataKeys(SmarterEnumAbstract):
    """Smarter API Plugin Metadata keys enumeration."""

    PLUGIN_CLASS = "pluginClass"





class SAMPluginCommonMetadataClass(SmarterEnumAbstract):
    """Smarter API Plugin Metadata Class keys enumeration."""

    STATIC = "static"
    API = "api"
    SQL = "sql"





class SAMPluginSpecKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec keys enumeration."""

    SELECTOR = "selector"
    PROMPT = "prompt"
    DATA = "data"
    API_DATA = "apiData"
    SQL_DATA = "sqlData"
    CONNECTION = "connection"





class SAMPluginCommonSpecSelectorKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Selector keys enumeration."""

    DIRECTIVE = "directive"
    SEARCHTERMS = "searchTerms"





class SAMPluginCommonSpecPromptKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Prompt keys enumeration."""

    PROVIDER = "provider"
    SYSTEMROLE = "systemRole"
    MODEL = "model"
    TEMPERATURE = "temperature"
    MAXTOKENS = "maxTokens"





class SAMStaticPluginSpecDataKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Data keys enumeration."""

    DESCRIPTION = "description"
    STATIC = "staticData"





class SAMSqlPluginSpecDataKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Data keys enumeration."""

    DESCRIPTION = "description"
    SQL = "sqlData"



###############################################################################
# ApiConnection Spec keys
###############################################################################


class SAMApiConnectionSpecKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Data keys enumeration."""

    CONNECTION = "connection"





class SAMApiConnectionSpecConnectionKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Data keys enumeration."""

    BASE_URL = "baseUrl"
    API_KEY = "apiKey"
    AUTH_METHOD = "authMethod"
    TIMEOUT = "timeout"
    PROXY_PROTOCOL = "proxyProtocol"
    PROXY_HOST = "proxyHost"
    PROXY_PORT = "proxyPort"
    PROXY_USERNAME = "proxyUsername"
    PROXY_PASSWORD = "proxyPassword"





class SAMApiConnectionStatusKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Data keys enumeration."""

    CONNECTION_STRING = "connection_string"
    IS_VALID = "is_valid"



###############################################################################
# SqlConnection Spec keys
###############################################################################


class SAMSqlConnectionSpecKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Data keys enumeration."""

    CONNECTION = "connection"





class SAMSqlConnectionSpecConnectionKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Data keys enumeration."""

    DB_ENGINE = "dbEngine"
    AUTHENTICATION_METHOD = "authenticationMethod"
    TIMEOUT = "timeout"
    DESCRIPTION = "description"
    USE_SSL = "useSsl"
    SSL_CERT = "sslCert"
    SSL_KEY = "sslKey"
    SSL_CA = "sslCa"
    HOSTNAME = "hostname"
    PORT = "port"
    DATABASE = "database"
    USERNAME = "username"
    PASSWORD = "password"
    POOL_SIZE = "poolSize"
    MAX_OVERFLOW = "maxOverflow"
    PROXY_PROTOCOL = "proxyProtocol"
    PROXY_HOST = "proxyHost"
    PROXY_PORT = "proxyPort"
    PROXY_USERNAME = "proxyUsername"
    PROXY_PASSWORD = "proxyPassword"
    SSH_KNOWN_HOSTS = "sshKnownHosts"





class SAMSqlConnectionStatusKeys(SmarterEnumAbstract):
    """Smarter API Plugin Spec Data keys enumeration."""

    CONNECTION_STRING = "connection_string"
    IS_VALID = "is_valid"