hyperforge 1.0.0.post19__py3-none-any.whl

hyperforge/api/models.py

@@ -0,0 +1,129 @@
+from enum import Enum
+from typing import Any, Dict, List, Literal, Optional
+
+from nucliadb_models import TextFormat
+from pydantic import BaseModel, Field
+
+from hyperforge.driver import DriverConfig
+from hyperforge.models import Rules
+
+
+class StashRoles(str, Enum):
+    # Can do anything at the stash
+    OWNER = "SOWNER"
+
+    # Can access the stash
+    MEMBER = "SMEMBER"
+
+    # Can access the stash
+    CONTRIBUTOR = "SCONTRIBUTOR"
+
+
+class AccountRoles(str, Enum):
+    OWNER = "AOWNER"
+    MEMBER = "AMEMBER"
+
+
+class AgentRole(str, Enum):
+    MEMBER = "SESSIONMEMBER"
+
+
+class NucliaDBRoles(str, Enum):
+    MANAGER = "MANAGER"
+    READER = "READER"
+    WRITER = "WRITER"
+
+
+class UserType(str, Enum):
+    ROOT = "ROOT"
+    DEALER = "DEALER"
+    USER = "USER"
+    READONLY = "READONLY"
+    MANAGER = "MANAGER"
+    SALES = "SALES"
+
+
+class AccountTypes(str, Enum):
+    TRIAL = "stash-trial"
+    STARTER = "stash-starter"
+    GROWTH = "stash-growth"
+    STARTUP = "stash-startup"
+    ENTERPRISE = "stash-enterprise"
+
+    # will be removed at some point in the near future
+    DEVELOPER = "stash-developer"
+    BUSINESS = "stash-business"
+
+    # V3 account types
+    V3_STARTER = "v3starter"
+    V3_FLY = "v3fly"
+    V3_GROWTH = "v3growth"
+    V3_PRO = "v3pro"
+    V3_ENTERPRISE = "v3enterprise"
+    COWORK = "cowork"
+
+
+class SessionData(BaseModel):
+    slug: str
+    name: str
+    summary: str
+    data: str
+    format: TextFormat
+
+
+INFO_FIELD_ID = "info"
+
+DEFAULT_RESOURCE_LIST_PAGE_SIZE = 20
+
+
+class InspectData(BaseModel):
+    contexts: List[Any]
+    driver: List[DriverConfig]
+    postprocess: List[Any]
+    preprocess: List[Any]
+    rules: Rules
+
+
+class AgentID(BaseModel):
+    id: str
+
+
+class DriverID(BaseModel):
+    id: str
+
+
+class PromptID(BaseModel):
+    id: str
+
+
+class InteractionsAuditDownloadRequest(BaseModel):
+    session_id: Optional[str] = Field(default=None, description="Filter by session ID")
+    year: Optional[int] = Field(
+        default=None,
+        description="Filter by year (e.g., 2024). If not specified, defaults to the current year.",
+    )
+    month: Optional[int] = Field(
+        default=None,
+        description="Filter by month (1-12). If not specified, defaults to the past month.",
+    )
+
+
+class DownloadStatus(BaseModel):
+    id: str
+    type: str
+    status: Literal["pending", "ready"]
+    download_url: str | None
+    query: dict[str, Any]
+
+
+class InteractionOperation(int, Enum):
+    QUESTION = 0
+    QUIT = 1
+
+
+class InteractionRequest(BaseModel):
+    question: str
+    headers: Dict[str, str] = {}
+    arguments: Dict[str, str] = {}
+    operation: InteractionOperation = InteractionOperation.QUESTION
+    streaming: bool = False

hyperforge/api/session.py

@@ -0,0 +1,197 @@
+"""Session management functions for ARAG agents with NucliaDB memory."""
+
+from typing import Optional
+
+from nucliadb_models import (
+    CreateResourcePayload,
+    ResourceCreated,
+    TextField,
+    TextFormat,
+    UpdateResourcePayload,
+)
+from nucliadb_models.conversation import InputConversationField
+from nucliadb_models.resource import Resource, ResourceList
+from nucliadb_sdk import NucliaDBAsync
+from nucliadb_sdk.v2.exceptions import NotFoundError
+
+from hyperforge import logger
+from hyperforge.api.models import INFO_FIELD_ID
+from hyperforge.memory.memory import QUESTION_ANSWERS_FIELD
+
+
+async def create_session_resource(
+    ndb: NucliaDBAsync,
+    agent_id: str,
+    slug: str,
+    title: str,
+    summary: str,
+    data: str,
+    format: TextFormat = TextFormat.PLAIN,
+) -> ResourceCreated:
+    """Create a new session resource in the agent's memory KB.
+
+    Args:
+        ndb: NucliaDB client instance
+        agent_id: The agent/KB ID
+        slug: Optional resource slug (ID)
+        title: Optional session title
+        summary: Optional session summary
+        data: Session data text content
+        format: Text format (default: PLAIN)
+
+    Returns:
+        ResourceCreated with the new session details
+
+    Raises:
+        Exception: If session creation fails
+    """
+    try:
+        created = await ndb.create_resource(
+            kbid=agent_id,
+            content=CreateResourcePayload(
+                title=title,
+                slug=slug,
+                summary=summary,
+                texts={INFO_FIELD_ID: TextField(body=data, format=format)},
+                conversations={QUESTION_ANSWERS_FIELD: InputConversationField()},
+            ),
+        )
+        logger.info(f"Created session {created.uuid} for agent {agent_id}")
+        return created
+    except Exception as e:
+        logger.exception(f"Error creating session for agent {agent_id}: {e}")
+        raise
+
+
+async def get_session_resource(
+    ndb: NucliaDBAsync,
+    agent_id: str,
+    session_id: str,
+    show: Optional[list[str]] = None,
+) -> Resource:
+    """Get a session resource by ID.
+
+    Args:
+        ndb: NucliaDB client instance
+        agent_id: The agent/KB ID
+        session_id: The session resource ID
+        show: Optional list of fields to include (e.g., ["basic", "values"])
+
+    Returns:
+        Resource object
+
+    Raises:
+        NotFoundError: If session doesn't exist
+    """
+    query_params = {}
+    if show:
+        query_params["show"] = show
+
+    return await ndb.get_resource_by_id(
+        rid=session_id,
+        kbid=agent_id,
+        query_params=query_params,
+    )
+
+
+async def session_exists(
+    ndb: NucliaDBAsync,
+    agent_id: str,
+    session_id: str,
+) -> bool:
+    """Check if a session resource exists.
+
+    Args:
+        ndb: NucliaDB client instance
+        agent_id: The agent/KB ID
+        session_id: The session resource ID
+
+    Returns:
+        True if session exists, False otherwise
+    """
+    try:
+        await ndb.get_resource_by_id(
+            rid=session_id,
+            kbid=agent_id,
+            query_params={"show": ["basic"]},
+        )
+        return True
+    except NotFoundError:
+        return False
+
+
+async def update_session_resource(
+    ndb: NucliaDBAsync,
+    agent_id: str,
+    session_id: str,
+    title: str,
+    summary: str,
+    data: str,
+    format: TextFormat,
+) -> None:
+    """Update a session resource.
+
+    Args:
+        ndb: NucliaDB client instance
+        agent_id: The agent/KB ID
+        session_id: The session resource ID
+        title: Optional new title
+        summary: Optional new summary
+        data: Optional new data text content
+        format: Optional text format
+
+    Raises:
+        NotFoundError: If session doesn't exist
+    """
+    await ndb.update_resource(
+        rid=session_id,
+        kbid=agent_id,
+        content=UpdateResourcePayload(
+            title=title,
+            summary=summary,
+            texts={INFO_FIELD_ID: TextField(body=data, format=format)},
+        ),
+    )
+
+
+async def delete_session_resource(
+    ndb: NucliaDBAsync,
+    agent_id: str,
+    session_id: str,
+) -> None:
+    """Delete a session resource.
+
+    Args:
+        ndb: NucliaDB client instance
+        agent_id: The agent/KB ID
+        session_id: The session resource ID
+
+    Raises:
+        NotFoundError: If session doesn't exist
+    """
+    await ndb.delete_resource(
+        rid=session_id,
+        kbid=agent_id,
+    )
+
+
+async def list_session_resources(
+    ndb: NucliaDBAsync,
+    agent_id: str,
+    page: int = 0,
+    size: int = 20,
+) -> ResourceList:
+    """List session resources for an agent.
+
+    Args:
+        ndb: NucliaDB client instance
+        agent_id: The agent/KB ID
+        page: Page number (0-based)
+        size: Page size
+
+    Returns:
+        ResourceList with sessions
+    """
+    return await ndb.list_resources(
+        kbid=agent_id, query_params={"page": page, "size": size}
+    )

hyperforge/api/settings.py

@@ -0,0 +1,38 @@
+from typing import Optional
+
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    debug: bool = False
+    log_level: str = "ERROR"
+    http_host: str = "0.0.0.0"
+    http_port: int = 8080
+
+    memory_apikey_nucliadb: Optional[str] = None
+    memory_reader_nucliadb: str = "reader.nucliadb.svc.cluster.local:8080"
+    memory_writer_nucliadb: str = "writer.nucliadb.svc.cluster.local:8080"
+    memory_search_nucliadb: str = "search.nucliadb.svc.cluster.local:8080"
+
+    idp_regional_grpc: str = "idp-grpc.idp-regional.svc.cluster.local:9090"
+    dummy_idp: bool = False
+
+    sentry_url: Optional[str] = None
+    running_environment: str = "stage"
+    zone: str = "stashify"
+    grpc_port: int = 8030
+
+    valkey_url: str = "redis://arag-valkey-cluster"
+    valkey_cluster_mode: bool = False
+    answers_subject: str = (
+        "arag.{account}.{agent_id}.{workflow_id}.{session}.{question}.answer"
+    )
+    oauth_subject: str = "arag.{account}.{agent_id}.{workflow_id}.{session}.{question}.oauth.{oauth_uuid}"
+    activate_subject: str = "arag.activate"
+    pubsub_keepalive_seconds: float = 20
+
+    load_modules: list[str] = []
+
+    # Hydra settings for MCP Oauth
+    hydra_public_url: str = "https://oauth.progress.cloud"
+    hydra_scopes_supported: list[str] = ["offline_access", "openid"]