Add database model for model muxing (#760)

This introduces the `provider_endpoints`, `provider_models` and `muxes` database tables to store models
with their configuration as well as muxing configurations that allow us
to appropriately route prompts to the relevant models.

Closes: #752

Signed-off-by: Juan Antonio Osorio <[email protected]>

migrations/versions/2025_01_24_0758-0f9b8edc8e46_add_llm_and_mux.py

@@ -0,0 +1,134 @@
+"""add llm and mux
+
+Revision ID: 0f9b8edc8e46
+Revises: 90d5471db49a
+Create Date: 2025-01-24 07:58:34.907908+00:00
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import context, op
+
+# revision identifiers, used by Alembic.
+revision: str = "0f9b8edc8e46"
+down_revision: Union[str, None] = "90d5471db49a"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    with context.begin_transaction():
+        # This table is used to store the providers endpoints that
+        # are available for references, e.g. in Muxing. The
+        # `auth_blob` field is used to store the credentials for
+        # the model, which can be a JSON object or a string,
+        # depending on the `auth_type`.  The `auth_type` field
+        # is used to determine how to interpret # the
+        # `auth_blob` field. If `auth_type` is `none`, then the
+        # `auth_blob` field is ignored.
+        # The `endpoint` field is used to store the endpoint of the
+        # model.
+        # NOTE: This resource is not namespaced by a workspace; that is
+        # because the models are shared across workspaces.
+        # NOTE: The lack of `deleted_at` is intentional. This resource
+        # is not soft-deleted.
+        # TODO: Do we need a display name here? An option is to
+        # use the `name` field as the display name and normalize
+        # the `name` field to be a slug when used as a reference.
+        op.execute(
+            """
+            CREATE TABLE IF NOT EXISTS provider_endpoints (
+                id TEXT PRIMARY KEY,  -- UUID stored as TEXT
+                name TEXT NOT NULL UNIQUE,
+                description TEXT NOT NULL DEFAULT '',
+                provider_type TEXT NOT NULL,    -- e.g. "openai", "anthropic", "vllm"
+                endpoint TEXT NOT NULL DEFAULT '',
+                auth_type TEXT NOT NULL DEFAULT 'none',
+                auth_blob TEXT NOT NULL DEFAULT '',
+                created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+                updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
+            );
+            """
+        )
+
+        # This table is used to store the models that are available
+        # for a given provider. The `provider_endpoint_id` field is
+        # used to reference the provider endpoint that the model is
+        # associated with. The `name` field is used to store the name
+        # of the model, which should contain the version of the model.
+        # NOTE: This is basically a cache of the models that are
+        # available for a given provider. We should update this cache
+        # periodically; but always at the point of provider endpoint
+        # creation.
+        op.execute(
+            """
+            CREATE TABLE IF NOT EXISTS provider_models (
+                provider_endpoint_id TEXT NOT NULL REFERENCES provider_endpoints(id)
+                    ON DELETE CASCADE,
+                name TEXT NOT NULL,     -- this should contain the version of the model
+                created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+                updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+                deleted_at TIMESTAMP,
+                PRIMARY KEY (provider_endpoint_id, name)
+            );
+            """
+        )
+
+        # This table is used to store the Muxing configuration. The
+        # `destination_model_id` field is used to reference the model that the
+        # Muxing configuration is for.
+        # The `matcher_type` field is used to determine the type of the
+        # matcher that is used in the Muxing configuration. e.g. `file_glob` would
+        # be a matcher that uses file globbing to match files if a file is
+        # detected in the prompt. The `matcher_blob` field is used to store the
+        # configuration for the matcher, which can be a JSON object or a string,
+        # depending on the `matcher_type`. On an initial implementation, the
+        # `matcher_blob` field will simply be a string that is used to match
+        # the prompt file name (if a file is detected in the prompt).
+        # The `priority` field is used to determine the priority of the Muxing
+        # configuration. The lower the number, the higher the priority. Note that
+        # prompts will be matched against the Muxing configurations in ascending
+        # order of priority.
+        op.execute(
+            """
+            CREATE TABLE IF NOT EXISTS muxes (
+                id TEXT PRIMARY KEY,  -- UUID stored as TEXT
+                provider_endpoint_id TEXT NOT NULL,
+                provider_model_name TEXT NOT NULL,
+                workspace_id TEXT NOT NULL REFERENCES workspaces(id) ON DELETE CASCADE,
+                matcher_type TEXT NOT NULL,
+                matcher_blob TEXT NOT NULL,
+                priority INTEGER NOT NULL,
+                created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+                updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+                FOREIGN KEY (provider_endpoint_id, provider_model_name)
+                    REFERENCES provider_models(provider_endpoint_id, name) ON DELETE CASCADE
+            );
+            """
+        )
+
+        # In terms of access patterns, the `muxes` table will be queried
+        # to find the Muxing configuration for a given prompt. On initial search,
+        # the `muxes` table will be queried by the `workspace_id`.
+        op.execute("CREATE INDEX IF NOT EXISTS idx_muxes_workspace_id ON muxes (workspace_id);")
+
+        # We'll be JOINING the `muxes` table with the `provider_models` table
+        # to get the model information. We should have an index on the
+        # `provider_endpoint_id` and `provider_model_name` fields in the `muxes`
+        # table.
+        op.execute(
+            """
+            CREATE INDEX IF NOT EXISTS idx_muxes_provider_endpoint_id_provider_model_name
+            ON muxes (provider_endpoint_id, provider_model_name);
+            """
+        )
+
+
+def downgrade() -> None:
+    with context.begin_transaction():
+        op.execute("DROP INDEX IF EXISTS idx_muxes_provider_endpoint_id_provider_model_name;")
+        op.execute("DROP INDEX IF EXISTS idx_muxes_workspace_id;")
+        op.execute("DROP TABLE IF EXISTS muxes;")
+        op.execute("DROP TABLE IF EXISTS provider_models;")
+        op.execute("DROP TABLE IF EXISTS provider_endpoints;")