hyperforge 1.0.0.post19__py3-none-any.whl

hyperforge/api/v1/prompt.py

@@ -0,0 +1,129 @@
+from fastapi import Header
+from starlette.requests import Request
+
+from hyperforge.api.authentication import requires_one
+from hyperforge.api.models import PromptID, StashRoles
+from hyperforge.api.v1.router import router
+from hyperforge.db.agents import AgentManager
+from hyperforge.prompts import PromptConfig
+
+
+@router.post(
+    "/api/v1/agent/{agent_id}/prompts",
+    status_code=200,
+    description="Add Prompt to Agent",
+    tags=["Prompt Management"],
+)
+@requires_one([StashRoles.OWNER])
+async def add_prompt(
+    request: Request,
+    agent_id: str,
+    item: PromptConfig,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+) -> PromptID:
+    agent_manager: AgentManager = request.app.agent_manager
+    prompt_id = await agent_manager.add_prompt(
+        account=x_stf_account,
+        agent_id=agent_id,
+        prompt=item,
+    )
+    return PromptID(id=prompt_id)
+
+
+@router.patch(
+    "/api/v1/agent/{agent_id}/prompt/{prompt_id}",
+    status_code=200,
+    description="Update Prompt of Agent",
+    tags=["Prompt Management"],
+)
+@requires_one([StashRoles.OWNER])
+async def patch_prompt(
+    request: Request,
+    agent_id: str,
+    prompt_id: str,
+    item: PromptConfig,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+):
+    agent_manager: AgentManager = request.app.agent_manager
+
+    await agent_manager.set_prompt(
+        account=x_stf_account, agent_id=agent_id, prompt=item, prompt_id=prompt_id
+    )
+
+
+@router.delete(
+    "/api/v1/agent/{agent_id}/prompt/{prompt_id}",
+    status_code=200,
+    description="Delete prompt id",
+    tags=["Prompt Management"],
+)
+@requires_one([StashRoles.OWNER])
+async def delete_prompt(
+    request: Request,
+    agent_id: str,
+    prompt_id: str,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+):
+    agent_manager: AgentManager = request.app.agent_manager
+
+    return await agent_manager.delete_prompt(
+        account=x_stf_account, agent_id=agent_id, prompt_id=prompt_id
+    )
+
+
+@router.get(
+    "/api/v1/agent/{agent_id}/prompts",
+    status_code=200,
+    description="Get Agent Configuration",
+    tags=["Prompt Management"],
+)
+@requires_one([StashRoles.OWNER])
+async def get_prompts(
+    request: Request,
+    agent_id: str,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+) -> list[PromptConfig]:
+    agent_manager: AgentManager = request.app.agent_manager
+
+    # TODO: This returns PromptConfig while the rest of APIs use PromptConfigs
+    # Standardize (into the simpler PromptConfigs?) for consistency
+    # Same for the `get_prompt` function
+    prompts = await agent_manager.get_prompts(
+        account=x_stf_account,
+        agent_id=agent_id,
+    )
+    return prompts
+
+
+@router.get(
+    "/api/v1/agent/{agent_id}/prompt/{prompt_id}",
+    status_code=200,
+    description="Get Agent Configuration",
+    tags=["Prompt Management"],
+)
+@requires_one([StashRoles.OWNER])
+async def get_prompt(
+    request: Request,
+    agent_id: str,
+    prompt_id: str,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+) -> PromptConfig:
+    agent_manager: AgentManager = request.app.agent_manager
+
+    # TODO: This returns PromptConfig while the rest of APIs use PromptConfigs
+    # Standardize (into the simpler PromptConfigs?) for consistency
+    # Same for the `get_prompt` function
+    prompt = await agent_manager.get_prompt(
+        account=x_stf_account, agent_id=agent_id, prompt_id=prompt_id
+    )
+    return prompt

hyperforge/api/v1/router.py

@@ -0,0 +1,3 @@
+from fastapi.routing import APIRouter
+
+router = APIRouter()

hyperforge/api/v1/schema.py

@@ -0,0 +1,56 @@
+from fastapi import Header
+from starlette.requests import Request
+
+from hyperforge.api.authentication import requires_one
+from hyperforge.api.models import StashRoles
+from hyperforge.api.v1.router import router
+from hyperforge.configure import (
+    get_context_agent_schemas,
+    get_driver_agent_schemas,
+    get_generation_agent_schemas,
+    get_postprocess_agent_schemas,
+    get_preprocess_agent_schemas,
+)
+
+
+@router.get(
+    "/api/v1/agent/{agent_id}/schema",
+    status_code=200,
+    description="Get Agent Schema",
+    tags=["Retrieval Agent"],
+    include_in_schema=False,
+)
+@requires_one([StashRoles.OWNER])
+async def get_schema(
+    request: Request,
+    agent_id: str,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+):
+    schema = {
+        "agents": {
+            "context": get_context_agent_schemas(
+                running_environment=request.app.settings.running_environment,
+                account_id=x_stf_account,
+            ),
+            "preprocess": get_preprocess_agent_schemas(
+                running_environment=request.app.settings.running_environment,
+                account_id=x_stf_account,
+            ),
+            "generation": get_generation_agent_schemas(
+                running_environment=request.app.settings.running_environment,
+                account_id=x_stf_account,
+            ),
+            "postprocess": get_postprocess_agent_schemas(
+                running_environment=request.app.settings.running_environment,
+                account_id=x_stf_account,
+            ),
+        },
+        "drivers": get_driver_agent_schemas(
+            running_environment=request.app.settings.running_environment,
+            account_id=x_stf_account,
+        ),
+    }
+
+    return schema

hyperforge/api/v1/session.py

@@ -0,0 +1,182 @@
+from typing import TYPE_CHECKING
+
+from fastapi import Header, HTTPException, Query
+from nucliadb_models import ResourceCreated
+from nucliadb_models.resource import Resource, ResourceList
+from nucliadb_sdk import NucliaDBAsync
+from starlette.requests import Request
+
+from hyperforge import logger
+from hyperforge.api.authentication import requires_one
+
+if TYPE_CHECKING:
+    from hyperforge.api.app import HTTPApplication
+from nucliadb_sdk.v2.exceptions import NotFoundError
+
+from hyperforge.api.models import (
+    DEFAULT_RESOURCE_LIST_PAGE_SIZE,
+    SessionData,
+    StashRoles,
+)
+from hyperforge.api.session import (
+    create_session_resource,
+    delete_session_resource,
+    get_session_resource,
+    list_session_resources,
+    update_session_resource,
+)
+from hyperforge.api.utils import requires_nucliadb_memory
+from hyperforge.api.v1.router import router
+
+
+@router.post(
+    "/api/v1/agent/{agent_id}/sessions",
+    status_code=200,
+    description="Create session",
+    tags=["Retrieval Agent"],
+)
+@requires_one([StashRoles.OWNER])
+@requires_nucliadb_memory
+async def create_session(
+    request: Request,
+    item: SessionData,
+    agent_id: str,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+) -> ResourceCreated:
+    app: HTTPApplication = request.app
+    ndb: NucliaDBAsync = app.arag_writer
+
+    try:
+        created = await create_session_resource(
+            ndb=ndb,
+            agent_id=agent_id,
+            slug=item.slug,
+            title=item.name,
+            summary=item.summary,
+            data=item.data,
+            format=item.format,
+        )
+        return created
+    except Exception as e:
+        logger.exception(f"Error creating session on nucliadb: {e}")
+        raise HTTPException(status_code=422, detail="Failed to create session")
+
+
+@router.patch(
+    "/api/v1/agent/{agent_id}/session/{session}",
+    status_code=200,
+    description="Create session",
+    tags=["Retrieval Agent"],
+)
+@requires_one([StashRoles.OWNER])
+@requires_nucliadb_memory
+async def patch_session(
+    request: Request,
+    agent_id: str,
+    session: str,
+    item: SessionData,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+):
+    app: HTTPApplication = request.app
+    ndb: NucliaDBAsync = app.arag_writer
+    try:
+        await update_session_resource(
+            ndb=ndb,
+            agent_id=agent_id,
+            session_id=session,
+            title=item.name,
+            summary=item.summary,
+            data=item.data,
+            format=item.format,
+        )
+    except NotFoundError:
+        raise HTTPException(status_code=404, detail="Session not found")
+
+
+@router.delete(
+    "/api/v1/agent/{agent_id}/session/{session}",
+    status_code=200,
+    description="Delete session",
+    tags=["Retrieval Agent"],
+)
+@requires_one([StashRoles.OWNER])
+@requires_nucliadb_memory
+async def delete_session(
+    request: Request,
+    agent_id: str,
+    session: str,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+):
+    app: HTTPApplication = request.app
+    ndb: NucliaDBAsync = app.arag_writer
+    try:
+        await delete_session_resource(
+            ndb=ndb,
+            agent_id=agent_id,
+            session_id=session,
+        )
+    except NotFoundError:
+        raise HTTPException(status_code=404, detail="Session not found")
+
+
+@router.get(
+    "/api/v1/agent/{agent_id}/sessions",
+    status_code=200,
+    description="Create session",
+    tags=["Retrieval Agent"],
+)
+@requires_one([StashRoles.OWNER])
+@requires_nucliadb_memory
+async def get_sessions(
+    request: Request,
+    agent_id: str,
+    page: int = Query(0, description="Requested page number (0-based)"),
+    size: int = Query(DEFAULT_RESOURCE_LIST_PAGE_SIZE, description="Page size"),
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+) -> ResourceList:
+    app: HTTPApplication = request.app
+    ndb: NucliaDBAsync = app.arag_reader
+
+    return await list_session_resources(
+        ndb=ndb,
+        agent_id=agent_id,
+        page=page,
+        size=size,
+    )
+
+
+@router.get(
+    "/api/v1/agent/{agent_id}/session/{session}",
+    status_code=200,
+    description="Create session",
+    tags=["Retrieval Agent"],
+)
+@requires_one([StashRoles.OWNER])
+@requires_nucliadb_memory
+async def get_session(
+    request: Request,
+    agent_id: str,
+    session: str,
+    x_stf_user: str = Header(..., include_in_schema=False),
+    x_stf_account: str = Header(..., include_in_schema=False),
+    x_stf_account_type: str = Header(..., include_in_schema=False),
+) -> Resource:
+    app: HTTPApplication = request.app
+    ndb: NucliaDBAsync = app.arag_reader
+    try:
+        return await get_session_resource(
+            ndb=ndb,
+            agent_id=agent_id,
+            session_id=session,
+            show=["basic", "values"],
+        )
+    except NotFoundError:
+        raise HTTPException(status_code=404, detail="Session not found")

hyperforge/api/v1/utils.py

@@ -0,0 +1,12 @@
+from nucliadb_telemetry.utils import get_telemetry
+from opentelemetry import trace
+
+from hyperforge.api import SERVICE_NAME
+
+
+def tracer():
+    provider = get_telemetry(SERVICE_NAME)
+    if provider:
+        return provider.get_tracer(__name__)
+    else:
+        return trace.NoOpTracer()