arize-phoenix 4.24.0__tar.gz → 4.25.0__tar.gz

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/.gitignore

@@ -25,3 +25,6 @@ coverage.xml
 
 # devtools
 pyrightconfig.json
+
+# Demo data
+tutorials/internal/demo_llama_index/*.json

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: arize-phoenix
-Version: 4.24.0
+Version: 4.25.0
 Summary: AI Observability and Evaluation
 Project-URL: Documentation, https://docs.arize.com/phoenix/
 Project-URL: Issues, https://github.com/Arize-ai/phoenix/issues
@@ -42,9 +42,11 @@ Requires-Dist: protobuf<6.0,>=3.20
 Requires-Dist: psutil
 Requires-Dist: pyarrow
 Requires-Dist: pydantic!=2.0.*,<3,>=1.0
+Requires-Dist: pyjwt
 Requires-Dist: python-multipart
 Requires-Dist: scikit-learn
-Requires-Dist: scipy
+Requires-Dist: scipy!=1.14.1; platform_system == 'Darwin'
+Requires-Dist: scipy; platform_system != 'Darwin'
 Requires-Dist: sqlalchemy[asyncio]<3,>=2.0.4
 Requires-Dist: sqlean-py>=3.45.1
 Requires-Dist: starlette
@@ -85,14 +87,16 @@ Requires-Dist: nbqa; extra == 'dev'
 Requires-Dist: pandas-stubs==2.0.3.230814; (python_version < '3.9') and extra == 'dev'
 Requires-Dist: pandas-stubs==2.2.2.240603; (python_version >= '3.9') and extra == 'dev'
 Requires-Dist: pandas>=1.0; extra == 'dev'
+Requires-Dist: portpicker; extra == 'dev'
 Requires-Dist: pre-commit; extra == 'dev'
 Requires-Dist: prometheus-client; extra == 'dev'
 Requires-Dist: psycopg[binary]; extra == 'dev'
 Requires-Dist: pytest-asyncio; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: pytest-postgresql; extra == 'dev'
-Requires-Dist: pytest==8.3.1; extra == 'dev'
-Requires-Dist: ruff==0.5.4; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Requires-Dist: pytest==8.3.2; extra == 'dev'
+Requires-Dist: ruff==0.6.1; extra == 'dev'
 Requires-Dist: strawberry-graphql[debug-server,opentelemetry]==0.236.0; extra == 'dev'
 Requires-Dist: tabulate; extra == 'dev'
 Requires-Dist: types-tabulate; extra == 'dev'
@@ -107,6 +111,7 @@ Requires-Dist: llama-index-readers-file==0.1.25; extra == 'llama-index'
 Requires-Dist: llama-index==0.10.51; extra == 'llama-index'
 Provides-Extra: pg
 Requires-Dist: asyncpg; extra == 'pg'
+Provides-Extra: test
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -144,9 +149,8 @@ Phoenix is an open-source AI observability platform designed for experimentation
 -   **_Evaluation_** - Leverage LLMs to benchmark your application's performance using response and retrieval evals.
 -   **_Datasets_** -  Create versioned datasets of examples for experimentation, evaluation, and fine-tuning.
 -   **_Experiments_** -  Track and evaluate changes to prompts, LLMs, and retrieval.
--   **_Inference Analysis_** - Visualize inferences and embeddings using dimensionality reduction and clustering to identify drift and performance degradation.
 
-Phoenix is vendor and language agnostic with out-of-the-box support for popular frameworks (🦙LlamaIndex, 🦜⛓LangChain, 🧩DSPy) and LLM providers (OpenAI, Bedrock, and more). For details on auto-instrumentation, check out the [OpenInference](https://github.com/Arize-ai/openinference) project.
+Phoenix is vendor and language agnostic with out-of-the-box support for popular frameworks (🦙LlamaIndex, 🦜⛓LangChain, Haystack, 🧩DSPy) and LLM providers (OpenAI, Bedrock, and more). For details on auto-instrumentation, check out the [OpenInference](https://github.com/Arize-ai/openinference) project.
 
 Phoenix runs practically anywhere, including your Jupyter notebook, local machine, containerized deployment, or in the cloud.
 

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/README.md

@@ -33,9 +33,8 @@ Phoenix is an open-source AI observability platform designed for experimentation
 -   **_Evaluation_** - Leverage LLMs to benchmark your application's performance using response and retrieval evals.
 -   **_Datasets_** -  Create versioned datasets of examples for experimentation, evaluation, and fine-tuning.
 -   **_Experiments_** -  Track and evaluate changes to prompts, LLMs, and retrieval.
--   **_Inference Analysis_** - Visualize inferences and embeddings using dimensionality reduction and clustering to identify drift and performance degradation.
 
-Phoenix is vendor and language agnostic with out-of-the-box support for popular frameworks (🦙LlamaIndex, 🦜⛓LangChain, 🧩DSPy) and LLM providers (OpenAI, Bedrock, and more). For details on auto-instrumentation, check out the [OpenInference](https://github.com/Arize-ai/openinference) project.
+Phoenix is vendor and language agnostic with out-of-the-box support for popular frameworks (🦙LlamaIndex, 🦜⛓LangChain, Haystack, 🧩DSPy) and LLM providers (OpenAI, Bedrock, and more). For details on auto-instrumentation, check out the [OpenInference](https://github.com/Arize-ai/openinference) project.
 
 Phoenix runs practically anywhere, including your Jupyter notebook, local machine, containerized deployment, or in the cloud.
 

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/examples/manually-instrumented-chatbot/frontend/requirements.txt

@@ -14,7 +14,7 @@ blinker==1.7.0
     # via streamlit
 cachetools==5.3.3
     # via streamlit
-certifi==2024.2.2
+certifi==2024.7.4
     # via
     #   httpcore
     #   httpx

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/pyproject.toml

@@ -36,7 +36,8 @@ dependencies = [
   "typing-extensions>=4.5; python_version<'3.12'",
   # A minimum version of typing-extensions==4.6.0 is needed to avoid this issue on Python 3.12: https://github.com/Azure/azure-sdk-for-python/issues/33442#issuecomment-1847886784
   "typing-extensions>=4.6; python_version>='3.12'",
-  "scipy",
+  "scipy!=1.14.1; platform_system == 'Darwin'",  # MacOS installation issue: https://github.com/scipy/scipy/issues/21424
+  "scipy; platform_system != 'Darwin'",
   "wrapt",
   "protobuf>=3.20, <6.0",
   "grpcio",
@@ -60,7 +61,8 @@ dependencies = [
   "python-multipart",  # see https://www.starlette.io/#dependencies
   "arize-phoenix-evals>=0.13.1",
   "fastapi",
-  "pydantic>=1.0,!=2.0.*,<3,", # exclude 2.0.* since it does not support the `json_encoders` configuration setting
+  "pydantic>=1.0,!=2.0.*,<3", # exclude 2.0.* since it does not support the `json_encoders` configuration setting
+  "pyjwt",
 ]
 dynamic = ["version"]
 
@@ -70,14 +72,15 @@ dev = [
   "hatch",
   "jupyter",
   "nbqa",
-  "ruff==0.5.4",
+  "ruff==0.6.1",
   "mypy==1.11.1",
   "pandas>=1.0",
   "tabulate",  # used by DataFrame.to_markdown()
   "types-tabulate",
   "pandas-stubs==2.2.2.240603; python_version>='3.9'",
   "pandas-stubs==2.0.3.230814; python_version<'3.9'",
-  "pytest==8.3.1",
+  "pytest==8.3.2",
+  "pytest-xdist",
   "pytest-asyncio",
   "pytest-cov",
   "pytest-postgresql",
@@ -94,6 +97,7 @@ dev = [
   "prometheus_client",
   "asgi-lifespan",
   "Faker>=26.0.0",
+  "portpicker",
   "uvloop; platform_system != 'Windows'",
 ]
 evals = []
@@ -121,6 +125,8 @@ container = [
   "strawberry-graphql[opentelemetry]==0.236.0",  # need to pin version because we're monkey-patching
   "uvloop; platform_system != 'Windows'",
 ]
+test = [
+]
 
 [project.urls]
 Documentation = "https://docs.arize.com/phoenix/"
@@ -151,7 +157,8 @@ dependencies = [
   "numpy",
   "pandas==2.2.2; python_version>='3.9'",
   "pandas==1.4.0; python_version<'3.9'",
-  "pytest==8.3.1",
+  "pytest==8.3.2",
+  "pytest-xdist",
   "pytest-asyncio",
   "pytest-cov",
   "pytest-postgresql",
@@ -179,7 +186,7 @@ dependencies = [
 
 [tool.hatch.envs.type]
 dependencies = [
-  "mypy==1.11.0",
+  "mypy==1.11.1",
   "tenacity",
   "pandas>=1.0",
   "pandas-stubs==2.0.3.230814",
@@ -214,7 +221,7 @@ python = ["3.8", "3.9", "3.12"]
 [tool.hatch.envs.style]
 detached = true
 dependencies = [
-  "ruff==0.5.4",
+  "ruff==0.6.1",
 ]
 
 [[tool.hatch.envs.style.matrix]]
@@ -234,7 +241,7 @@ dependencies = [
 ]
 
 [tool.hatch.envs.default.scripts]
-tests = "pytest {args}"
+tests = "pytest -n auto {args}"
 coverage = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src/phoenix --cov=tests {args}"
 
 [[tool.hatch.envs.test.matrix]]
@@ -246,6 +253,8 @@ addopts = [
   "-rA",
   "--import-mode=importlib",
   "--doctest-modules",
+  "--new-first",
+  "--showlocals",
 ]
 testpaths = [
   "tests",
@@ -363,9 +372,6 @@ ignore-setters = false
 
 [tool.mypy]
 plugins = ["strawberry.ext.mypy_plugin", "pydantic.mypy"]
-disallow_untyped_calls = true
-disallow_untyped_defs = true
-disallow_incomplete_defs  = true
 strict = true
 exclude = [
   "api_reference",
@@ -413,7 +419,6 @@ exclude = [
   "*.pyi",
   "docs/",
 ]
-extend-include = ["*.ipynb"]
 line-length = 100
 target-version = "py38"
 
@@ -427,4 +432,4 @@ select = ["E", "F", "W", "I", "NPY201"]
 force-single-line = false
 
 [tool.ruff.format]
-line-ending = "lf"
+line-ending = "native"

arize_phoenix-4.25.0/src/phoenix/auth/utils.py

@@ -0,0 +1,15 @@
+from hashlib import pbkdf2_hmac
+
+
+def compute_password_hash(password: str, salt: str) -> str:
+    """
+    Salts and hashes a password using PBKDF2, HMAC, and SHA256.
+    """
+    password_bytes = password.encode("utf-8")
+    salt_bytes = salt.encode("utf-8")
+    password_hash_bytes = pbkdf2_hmac("sha256", password_bytes, salt_bytes, NUM_ITERATIONS)
+    password_hash = password_hash_bytes.hex()
+    return password_hash
+
+
+NUM_ITERATIONS = 1_000_000

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/db/engines.py

@@ -7,6 +7,7 @@ from typing import Any
 
 import aiosqlite
 import numpy as np
+import sqlalchemy
 import sqlean
 from sqlalchemy import URL, StaticPool, event, make_url
 from sqlalchemy.ext.asyncio import AsyncEngine, create_async_engine
@@ -15,6 +16,7 @@ from typing_extensions import assert_never
 from phoenix.db.helpers import SupportedSQLDialect
 from phoenix.db.migrate import migrate_in_thread
 from phoenix.db.models import init_models
+from phoenix.settings import Settings
 
 sqlean.extensions.enable("text", "stats")
 
@@ -118,7 +120,13 @@ def aio_sqlite_engine(
         else:
             asyncio.create_task(init_models(engine))
     else:
-        migrate_in_thread(engine.url)
+        sync_engine = sqlalchemy.create_engine(
+            url=url.set(drivername="sqlite"),
+            echo=Settings.log_migrations,
+            json_serializer=_dumps,
+            creator=lambda: sqlean.connect(f"file:{database}", uri=True),
+        )
+        migrate_in_thread(sync_engine)
     return engine
 
 
@@ -130,7 +138,12 @@ def aio_postgresql_engine(
     engine = create_async_engine(url=url, echo=echo, json_serializer=_dumps)
     if not migrate:
         return engine
-    migrate_in_thread(engine.url)
+    sync_engine = sqlalchemy.create_engine(
+        url=url.set(drivername="postgresql"),
+        echo=Settings.log_migrations,
+        json_serializer=_dumps,
+    )
+    migrate_in_thread(sync_engine)
     return engine
 
 

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/db/insertion/dataset.py

@@ -24,6 +24,7 @@ from phoenix.db import models
 from phoenix.db.insertion.helpers import DataManipulationEvent
 
 logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
 
 DatasetId: TypeAlias = int
 DatasetVersionId: TypeAlias = int

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/db/migrate.py

@@ -1,25 +1,34 @@
+import codecs
 import logging
+import sys
 from pathlib import Path
-from queue import Empty, Queue
+from queue import Empty, SimpleQueue
 from threading import Thread
 from typing import Optional
 
 from alembic import command
 from alembic.config import Config
-from sqlalchemy import URL
+from sqlalchemy import Engine
 
 from phoenix.exceptions import PhoenixMigrationError
 from phoenix.settings import Settings
 
 logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
 
 
 def printif(condition: bool, text: str) -> None:
-    if condition:
-        print(text)
+    if not condition:
+        return
+    if sys.platform.startswith("win"):
+        text = codecs.encode(text, "ascii", errors="ignore").decode("ascii").strip()
+    print(text)
 
 
-def migrate(url: URL, error_queue: Optional["Queue[Exception]"] = None) -> None:
+def migrate(
+    engine: Engine,
+    error_queue: Optional["SimpleQueue[BaseException]"] = None,
+) -> None:
     """
     Runs migrations on the database.
     NB: Migrate only works on non-memory databases.
@@ -37,24 +46,26 @@ def migrate(url: URL, error_queue: Optional["Queue[Exception]"] = None) -> None:
         # Explicitly set the migration directory
         scripts_location = str(Path(__file__).parent.resolve() / "migrations")
         alembic_cfg.set_main_option("script_location", scripts_location)
-        alembic_cfg.set_main_option("sqlalchemy.url", str(url).replace("%", "%%"))
+        url = str(engine.url).replace("%", "%%")
+        alembic_cfg.set_main_option("sqlalchemy.url", url)
+        alembic_cfg.attributes["connection"] = engine.connect()
         command.upgrade(alembic_cfg, "head")
         printif(log_migrations, "---------------------------")
         printif(log_migrations, "✅ Migrations complete.")
-    except Exception as e:
+    except BaseException as e:
         if error_queue:
             error_queue.put(e)
             raise e
 
 
-def migrate_in_thread(url: URL) -> None:
+def migrate_in_thread(engine: Engine) -> None:
     """
     Runs migrations on the database in a separate thread.
     This is needed because depending on the context (notebook)
     the migration process can fail to execute in the main thread.
     """
-    error_queue: Queue[Exception] = Queue()
-    t = Thread(target=migrate, args=(url, error_queue))
+    error_queue: SimpleQueue[BaseException] = SimpleQueue()
+    t = Thread(target=migrate, args=(engine, error_queue))
     t.start()
     t.join()
 

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/db/migrations/future_versions/cd164e83824f_users_and_tokens.py

@@ -11,7 +11,6 @@ from typing import Any, Dict, List, Optional, Sequence, TypedDict, Union
 
 import sqlalchemy as sa
 from alembic import op
-from phoenix.datetime_utils import normalize_datetime
 from sqlalchemy import (
     JSON,
     TIMESTAMP,
@@ -32,6 +31,8 @@ from sqlalchemy.orm import (
     mapped_column,
 )
 
+from phoenix.datetime_utils import normalize_datetime
+
 
 class JSONB(JSON):
     # See https://docs.sqlalchemy.org/en/20/core/custom_types.html
@@ -113,7 +114,7 @@ class Base(DeclarativeBase):
 class UserRole(Base):
     __tablename__ = "user_roles"
     id: Mapped[int] = mapped_column(primary_key=True)
-    role: Mapped[str] = mapped_column(unique=True)
+    name: Mapped[str] = mapped_column(unique=True)
 
 
 class User(Base):
@@ -150,10 +151,10 @@ async def insert_roles_and_users(connection: AsyncConnection) -> None:
     user to the `users` table.
     """
     await connection.execute(
-        insert(UserRole).values([{"role": "SYSTEM"}, {"role": "ADMIN"}, {"role": "MEMBER"}])
+        insert(UserRole).values([{"name": "SYSTEM"}, {"name": "ADMIN"}, {"name": "MEMBER"}])
     )
-    system_user_role_id = sa.select(UserRole.id).where(UserRole.role == "SYSTEM").scalar_subquery()
-    admin_user_role_id = sa.select(UserRole.id).where(UserRole.role == "ADMIN").scalar_subquery()
+    system_user_role_id = sa.select(UserRole.id).where(UserRole.name == "SYSTEM").scalar_subquery()
+    admin_user_role_id = sa.select(UserRole.id).where(UserRole.name == "ADMIN").scalar_subquery()
     await connection.execute(
         insert(User).values(
             [
@@ -183,7 +184,7 @@ def upgrade() -> None:
         "user_roles",
         sa.Column("id", sa.Integer, primary_key=True),
         sa.Column(
-            "role",
+            "name",
             sa.String,
             nullable=False,
             unique=True,

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/db/migrations/versions/3be8647b87d8_add_token_columns_to_spans_table.py

@@ -19,7 +19,6 @@ from sqlalchemy import (
     update,
 )
 from sqlalchemy.dialects import postgresql
-from sqlalchemy.ext.asyncio.engine import AsyncConnection
 from sqlalchemy.ext.compiler import compiles
 from sqlalchemy.orm import (
     DeclarativeBase,
@@ -111,11 +110,10 @@ LLM_TOKEN_COUNT_PROMPT = SpanAttributes.LLM_TOKEN_COUNT_PROMPT.split(".")
 LLM_TOKEN_COUNT_COMPLETION = SpanAttributes.LLM_TOKEN_COUNT_COMPLETION.split(".")
 
 
-async def get_token_counts_from_attributes(connection: AsyncConnection) -> None:
-    """
-    Gets token counts from attributes if present.
-    """
-    await connection.execute(
+def upgrade() -> None:
+    op.add_column("spans", sa.Column("llm_token_count_prompt", sa.Integer, nullable=True))
+    op.add_column("spans", sa.Column("llm_token_count_completion", sa.Integer, nullable=True))
+    op.execute(
         update(Span).values(
             llm_token_count_prompt=Span.attributes[LLM_TOKEN_COUNT_PROMPT].as_float(),
             llm_token_count_completion=Span.attributes[LLM_TOKEN_COUNT_COMPLETION].as_float(),
@@ -123,12 +121,6 @@ async def get_token_counts_from_attributes(connection: AsyncConnection) -> None:
     )
 
 
-def upgrade() -> None:
-    op.add_column("spans", sa.Column("llm_token_count_prompt", sa.Integer, nullable=True))
-    op.add_column("spans", sa.Column("llm_token_count_completion", sa.Integer, nullable=True))
-    op.run_async(get_token_counts_from_attributes)
-
-
 def downgrade() -> None:
     op.drop_column("spans", "llm_token_count_completion")
     op.drop_column("spans", "llm_token_count_prompt")

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/db/models.py

@@ -625,7 +625,7 @@ if ENABLE_AUTH:
     class UserRole(Base):
         __tablename__ = "user_roles"
         id: Mapped[int] = mapped_column(primary_key=True)
-        role: Mapped[str] = mapped_column(unique=True)
+        name: Mapped[str] = mapped_column(unique=True)
         users: Mapped[List["User"]] = relationship("User", back_populates="role")
 
     class User(Base):

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/inferences/fixtures.py

@@ -18,6 +18,7 @@ from phoenix.inferences.schema import (
 )
 
 logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
 
 
 class InferencesRole(Enum):

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/inferences/inferences.py

@@ -34,6 +34,7 @@ from .schema import (
 from .validation import validate_inferences_inputs
 
 logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
 
 # A schema like object. Not recommended to use this directly
 SchemaLike: TypeAlias = Any

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/metrics/__init__.py

@@ -10,6 +10,7 @@ import pandas as pd
 from phoenix.core.model_schema import Column
 
 logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
 
 
 @dataclass(frozen=True)

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/server/api/context.py

@@ -74,3 +74,17 @@ class Context(BaseContext):
     event_queue: CanPutItem[DmlEvent] = _NoOp()
     corpus: Optional[Model] = None
     read_only: bool = False
+    secret: Optional[str] = None
+
+    def get_secret(self) -> str:
+        """A type safe way to get the application secret. Throws an error if the secret is not set.
+
+        Returns:
+            str: the phoenix secret
+        """
+        if self.secret is None:
+            raise ValueError(
+                "Application secret not set."
+                " Please set the PHOENIX_SECRET environment variable and re-deploy the application."
+            )
+        return self.secret

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/server/api/mutations/__init__.py

@@ -1,5 +1,6 @@
 import strawberry
 
+from phoenix.server.api.mutations.api_key_mutations import ApiKeyMutationMixin
 from phoenix.server.api.mutations.dataset_mutations import DatasetMutationMixin
 from phoenix.server.api.mutations.experiment_mutations import ExperimentMutationMixin
 from phoenix.server.api.mutations.export_events_mutations import ExportEventsMutationMixin
@@ -16,5 +17,6 @@ class Mutation(
     ExportEventsMutationMixin,
     SpanAnnotationMutationMixin,
     TraceAnnotationMutationMixin,
+    ApiKeyMutationMixin,
 ):
     pass

arize_phoenix-4.25.0/src/phoenix/server/api/mutations/api_key_mutations.py

@@ -0,0 +1,119 @@
+from datetime import datetime
+from typing import Any, Dict, Optional
+
+import jwt
+import strawberry
+from sqlalchemy import insert, select
+from strawberry import UNSET
+from strawberry.types import Info
+
+from phoenix.db import models
+from phoenix.server.api.context import Context
+from phoenix.server.api.mutations.auth import HasSecret, IsAuthenticated
+from phoenix.server.api.queries import Query
+from phoenix.server.api.types.SystemApiKey import SystemApiKey
+
+
+@strawberry.type
+class CreateSystemApiKeyMutationPayload:
+    jwt: str
+    api_key: SystemApiKey
+    query: Query
+
+
+@strawberry.input
+class CreateApiKeyInput:
+    name: str
+    description: Optional[str] = UNSET
+    expires_at: Optional[datetime] = UNSET
+
+
+@strawberry.type
+class ApiKeyMutationMixin:
+    @strawberry.mutation(permission_classes=[HasSecret, IsAuthenticated])  # type: ignore
+    async def create_system_api_key(
+        self, info: Info[Context, None], input: CreateApiKeyInput
+    ) -> CreateSystemApiKeyMutationPayload:
+        # TODO(auth): safe guard against auth being disabled and secret not being set
+        async with info.context.db() as session:
+            # Get the system user - note this could be pushed into a dataloader
+            system_user = await session.scalar(
+                select(models.User)
+                .join(models.UserRole)  # Join User with UserRole
+                .where(models.UserRole.name == "SYSTEM")  # Filter where role is SYSTEM
+                .limit(1)
+            )
+            if system_user is None:
+                raise ValueError("System user not found")
+
+            insert_stmt = (
+                insert(models.APIKey)
+                .values(
+                    user_id=system_user.id,
+                    name=input.name,
+                    description=input.description or None,
+                    expires_at=input.expires_at or None,
+                )
+                .returning(models.APIKey)
+            )
+            api_key = await session.scalar(insert_stmt)
+            assert api_key is not None
+
+        encoded_jwt = create_jwt(
+            secret=info.context.get_secret(),
+            name=api_key.name,
+            id=api_key.id,
+            description=api_key.description,
+            iat=api_key.created_at,
+            exp=api_key.expires_at,
+        )
+        return CreateSystemApiKeyMutationPayload(
+            jwt=encoded_jwt,
+            api_key=SystemApiKey(
+                id_attr=api_key.id,
+                name=api_key.name,
+                description=api_key.description,
+                created_at=api_key.created_at,
+                expires_at=api_key.expires_at,
+            ),
+            query=Query(),
+        )
+
+
+def create_jwt(
+    *,
+    secret: str,
+    algorithm: str = "HS256",
+    name: str,
+    description: Optional[str],
+    iat: datetime,
+    exp: Optional[datetime],
+    id: int,
+) -> str:
+    """Create a signed JSON Web Token for authentication
+
+    Args:
+        secret (str): the secret to sign with
+        name (str): name of the key / token
+        description (Optional[str]): description of the token
+        iat (datetime): the issued at time
+        exp (Optional[datetime]): the expiry, if set
+        id (int): the id of the key
+        algorithm (str, optional): the algorithm to use. Defaults to "HS256".
+
+    Returns:
+        str: The encoded JWT
+    """
+    payload: Dict[str, Any] = {
+        "name": name,
+        "description": description,
+        "iat": iat.utcnow(),
+        "id": id,
+    }
+    if exp is not None:
+        payload["exp"] = exp.utcnow()
+
+    # Encode the payload to create the JWT
+    token = jwt.encode(payload, secret, algorithm=algorithm)
+
+    return token

{arize_phoenix-4.24.0 → arize_phoenix-4.25.0}/src/phoenix/server/api/mutations/auth.py

@@ -9,3 +9,10 @@ class IsAuthenticated(BasePermission):
 
     async def has_permission(self, source: Any, info: Info, **kwargs: Any) -> bool:
         return not info.context.read_only
+
+
+class HasSecret(BasePermission):
+    message = "Application secret is not set"
+
+    async def has_permission(self, source: Any, info: Info, **kwargs: Any) -> bool:
+        return info.context.secret is not None