pyxecm 3.0.1__py3-none-any.whl → 3.1.0__py3-none-any.whl

pyxecm_api/agents/__init__.py

@@ -1,7 +0,0 @@
-"""init Module."""
-
-from .otcm_knowledgegraph.router import router as otcm_knowledgegraph_router
-from .otcm_user_agent.router import router as otcm_user_agent_router
-from .otcm_workspace_agent.router import router as otcm_workspace_agent_router
-
-__all__ = ["otcm_knowledgegraph_router", "otcm_user_agent_router", "otcm_workspace_agent_router"]

pyxecm_api/agents/app.py

@@ -1,13 +0,0 @@
-"""List of all routers for the csai agents."""
-
-import logging
-
-from fastapi import APIRouter
-
-from . import otcm_knowledgegraph_router, otcm_user_agent_router, otcm_workspace_agent_router
-
-logger = logging.getLogger("pyxecm_api.agents")
-
-router = APIRouter(tags=["csai agents"])
-
-agent_routers = [router, otcm_workspace_agent_router, otcm_user_agent_router, otcm_knowledgegraph_router]

pyxecm_api/agents/functions.py

@@ -1,119 +0,0 @@
-"""List of all routers for the csai agents."""
-
-import logging
-from importlib.metadata import version
-from threading import Thread
-
-from fastapi.openapi.utils import get_openapi
-from fastapi.routing import APIRoute
-from pyxecm import OTCA, OTCS
-from pyxecm_customizer.settings import Settings
-
-from pyxecm_api.common.functions import get_k8s_object, get_otcs_object
-
-logger = logging.getLogger("pyxecm_api.agents")
-
-SETTINGS = Settings()
-
-
-def get_otca_object(otcs_object: OTCS | None = None) -> OTCA:
-    """Get the OTCA object."""
-
-    k8s_object = get_k8s_object()
-    content_system = {}
-    for service in ["chat", "embed"]:
-        cm = k8s_object.get_config_map(f"csai-{service}-svc")
-        if cm:
-            content_system[service] = cm.data.get("CONTENT_SYSTEM", "none")
-
-    otca = OTCA(
-        chat_url=str(SETTINGS.aviator.chat_svc_url),
-        embed_url=str(SETTINGS.aviator.embed_svc_url),
-        studio_url=str(SETTINGS.aviator.studio_url),
-        otds_url=str(SETTINGS.otds.url_internal),
-        client_id=SETTINGS.aviator.oauth_client,
-        client_secret=SETTINGS.aviator.oauth_secret,
-        otcs_object=otcs_object,
-        content_system=content_system,
-        logger=logger.getChild("otca"),
-    )
-
-    return otca
-
-
-# end function
-
-
-def register_tool_body(route: APIRoute, agents: list[str] | None = None) -> dict:
-    """Generate the request body for the CSAI Studio integration.
-
-    Args:
-        route (APIRoute):
-            The API routes.
-        agents (list[str] | None, optional):
-            A list of agents this tool is associated with.
-            Defaults to ["retrieverAgent"].
-
-    Returns:
-        dict:
-            The body for the REST API call to register a tool in Content Aviator.
-
-    """
-
-    if agents is None:
-        agents = ["retrieverAgent"]
-
-    return {
-        "name": route.name,
-        "description": route.description,
-        "APISchema": get_openapi(
-            title=route.name,
-            openapi_version="3.0.0",
-            version=version("pyxecm"),
-            servers=[{"url": "http://customizer:8000"}],
-            routes=[route],
-        ),
-        "requestTemplate": {
-            "data": {"context": {"where": "memory.input.where", "query": "memory.input.query"}},
-        },
-        "responseTemplate": {},  # Optional response template used to filter the response from the API.
-        "agents": agents,
-    }
-
-
-# end function
-
-
-def register_all() -> None:
-    """Register all tools."""
-
-    def register_all_routes() -> None:
-        otca = get_otca_object(otcs_object=get_otcs_object())
-        response = otca.do_request(
-            method="POST",
-            url=str(SETTINGS.aviator.studio_url) + "studio/v1/import",
-            show_error=False,
-            parse_request_response=False,
-        )
-        if not response or response.text != "Accepted":
-            logger.error("Failed to import tools!")
-            return
-        get_k8s_object().restart_deployment(deployment_name="csai-chat-svc")
-
-        for route in routes:
-            logger.info("Registering Content Aviator tool -> '%s'...", route.name)
-            request_body = register_tool_body(route=route)
-            result = otca.register_tool(request_body=request_body)
-            if result:
-                logger.info("Tool got registered successfully -> %s", route.name)
-                logger.debug("%s", result)
-
-    from pyxecm_api.app import app
-
-    # Get all FastAPI routes and register them as tools:
-    routes: list[APIRoute] = [route for route in app.routes if route.path.startswith("/agents")]
-
-    Thread(target=register_all_routes, name="RegisterTools").start()
-
-
-# end function

pyxecm_api/agents/models.py

@@ -1,10 +0,0 @@
-"""Define commonly used models."""
-
-from pydantic import BaseModel
-
-
-class Context(BaseModel):
-    """Define Model that is used to provide static context information for tools."""
-
-    where: list[dict]
-    query: str

pyxecm_api/agents/otcm_knowledgegraph/__init__.py

@@ -1 +0,0 @@
-"""init module."""

pyxecm_api/agents/otcm_knowledgegraph/functions.py

@@ -1,85 +0,0 @@
-"""Function to build a knowledge graph from the OTCS object."""
-
-import logging
-import time
-from datetime import UTC, datetime
-
-from pyxecm_customizer.knowledge_graph import KnowledgeGraph
-
-from pyxecm_api.common.functions import get_otcs_object
-
-logger = logging.getLogger("pyxecm_api.agent.otcm_knowledge_graph")
-
-KNOWLEDGEGRAPH_OBJECT: KnowledgeGraph = None
-KNOWLEDGEGRAPH_ONTOLOGY = {
-    ("Vendor", "Material", "child"): ["offers", "supplies", "provides"],
-    ("Vendor", "Purchase Order", "child"): ["supplies", "provides"],
-    ("Vendor", "Purchase Contract", "child"): ["signs", "owns"],
-    ("Material", "Vendor", "parent"): ["is supplied by"],
-    ("Purchase Order", "Material", "child"): ["includes", "is part of"],
-    ("Customer", "Sales Order", "child"): ["has ordered"],
-    ("Customer", "Sales Contract", "child"): ["signs", "owns"],
-    ("Sales Order", "Customer", "parent"): ["belongs to", "is initiated by"],
-    ("Sales Order", "Material", "child"): ["includes", "consists of"],
-    ("Sales Order", "Delivery", "child"): ["triggers", "is followed by"],
-    ("Sales Order", "Production Order", "child"): ["triggers", "is followed by"],
-    ("Sales Contract", "Material", "child"): ["includes", "consists of"],
-    ("Production Order", "Material", "child"): ["includes", "consists of"],
-    ("Production Order", "Delivery", "child"): ["triggers", "is followed by"],
-    ("Production Order", "Goods Movement", "child"): ["triggers", "is followed by"],
-    ("Delivery", "Goods Movement", "child"): ["triggers", "is followed by"],
-    ("Delivery", "Material", "child"): ["triggers", "is followed by"],
-}
-
-
-def build_graph() -> None:
-    """Build the knowledgeGraph. And keep it updated every hour."""
-
-    def build() -> None:
-        knowledge_graph = KnowledgeGraph(otcs_object=get_otcs_object(), ontology=KNOWLEDGEGRAPH_ONTOLOGY)
-
-        start_time = datetime.now(UTC)
-        result = knowledge_graph.build_graph(
-            workspace_type_exclusions=None,
-            workspace_type_inclusions=[
-                "Vendor",
-                "Purchase Contract",
-                "Purchase Order",
-                "Material",
-                "Customer",
-                "Sales Order",
-                "Sales Contract",
-                "Delivery",
-                "Goods Movement",
-            ],
-            workers=20,
-            filter_at_traversal=True,  # also filter for workspace types if following relationships
-            relationship_types=["child"],  # only go from parent to child
-            strategy="BFS",
-            metadata=False,
-        )
-        end_time = datetime.now(UTC)
-        logger.info(
-            "Knowledge Graph completed in %s. Processed %d workspace nodes and traversed %d workspace relationships.",
-            str(end_time - start_time),
-            result["processed"],
-            result["traversed"],
-        )
-
-        global KNOWLEDGEGRAPH_OBJECT  # noqa: PLW0603
-        KNOWLEDGEGRAPH_OBJECT = knowledge_graph
-
-    while True:
-        logger.info("Building knowledge graph...")
-        build()
-        logger.info("Knowledge graph build complete. Waiting for 1 hour before rebuilding...")
-        time.sleep(3600)
-
-
-###
-
-
-def get_knowledgegraph_object() -> KnowledgeGraph:
-    """Get the OTCA object."""
-
-    return KNOWLEDGEGRAPH_OBJECT

pyxecm_api/agents/otcm_knowledgegraph/models.py

@@ -1,61 +0,0 @@
-"""Define Models for KnowledgeGraph."""
-
-from typing import Annotated, Literal
-
-from pydantic import BaseModel, Field
-
-from pyxecm_api.agents.models import Context
-from pyxecm_api.agents.otcm_workspace_agent.models import WorkspaceModel
-
-
-class KnowledgeGraphQueryModel(BaseModel):
-    """Defines Model for describing workspaces in OTCM (Opentext Content Management).
-
-    To display an instance of this model, please display the link.
-    """
-
-    source_type: Annotated[
-        str,
-        Field(
-            description="Source workspace type name provided in the user query. This provides the start point of the query in the Knowledge Graph."
-        ),
-    ]
-    source_value: Annotated[
-        str,
-        Field(
-            description="Name of the source workspace instance (of the type provided by source_type). This is NOT optional. If it is missing then you need to switch source and target. The source always needs to have a specific value!"
-        ),
-    ]
-    target_type: Annotated[
-        str,
-        Field(
-            description="Target workspace type name provided in the user query. This defines the result workspace types of the Knolwedge Graph query."
-        ),
-    ] = None
-    target_value: Annotated[
-        str,
-        Field(
-            description="Name of the target workspace instance (of the type provided by the target_type). This value is optionalis an additional / optional selection criteria."
-        ),
-    ] = None
-    intermediate_types: Annotated[
-        list[str],
-        Field(
-            description="List of workspace types (entities) that are on the path between the source workspace type and target workspace type. These are typically additional relational conditions the user is giving in the query. The start type and target types should never be in intermediate types!"
-        ),
-    ] = None
-    direction: Annotated[
-        Literal["child", "parent"],
-        Field(
-            description="The direction the graph should be traversed in. This is either 'child' (the default) or 'parent'. 'child' is typically used if traversing from main entities to related sub-entities thus following a '1 -> many' relationship (top-down). 'parent' is typically used if traversing bottom-up. This should reflect the relationship between the source type of the workspace and the requested target type. A 'child' relationship is e.g. 'Customer' -> 'Sales Order'. A 'parent' relationship is e.g. 'Material' -> 'Sales Order'."
-        ),
-    ] = None
-
-
-class KnowledgeGraphResponseModel(BaseModel):
-    """Response of the Knowledge Graph tool."""
-
-    results: Annotated[list[WorkspaceModel], Field(description="A list of workspaces matching the query.")]
-    context_update: Annotated[
-        Context, Field(description="An update for the LLM context. Update the graph state with this information!")
-    ]

pyxecm_api/agents/otcm_knowledgegraph/router.py

@@ -1,74 +0,0 @@
-"""Define router for workspace endpoints."""
-
-import logging
-from typing import Annotated
-
-from fastapi import APIRouter, Body, Depends, HTTPException
-from pyxecm_customizer.knowledge_graph import KnowledgeGraph
-
-from pyxecm_api.agents.models import Context
-from pyxecm_api.agents.otcm_workspace_agent.models import WorkspaceModel
-
-from .functions import (
-    KNOWLEDGEGRAPH_ONTOLOGY,
-    get_knowledgegraph_object,
-)
-from .models import (
-    KnowledgeGraphQueryModel,
-)
-
-router = APIRouter(prefix="/otcm_knowledgegraph_agent", tags=["csai agents"])
-
-logger = logging.getLogger("pyxecm_api.agents.otcm_knowledgegraph_agent")
-
-
-@router.post(
-    path="/query",
-    summary="Query the knowledge graph for a list of workspaces matching the user query.",
-    description=f"Use the following ontology to understand the relationship between workspace types and the direction of the relationships (either 'parent' or 'child'): {KNOWLEDGEGRAPH_ONTOLOGY}",
-    responses={
-        200: {"description": "Workspaces found"},
-        403: {"description": "Invalid credentials"},
-        404: {"description": "No matching workspaces found"},
-        500: {"description": "Knowledge Graph is not available"},
-    },
-    #    response_model=ToolResponse,
-    # response_model=list[WorkspaceModel],
-    response_description="List of workspaces that match the query. Best presented as a list with hyperlinks to the workspace.",
-)
-def otcm_knowledgegraph_query(
-    context: Context,
-    knowledge_graph: Annotated[KnowledgeGraph, Depends(get_knowledgegraph_object)],
-    knowledge_graph_query: Annotated[KnowledgeGraphQueryModel, Body()],
-) -> dict | None:  # ToolResponse | None:  # list[WorkspaceModel] | None:
-    # ) -> list[WorkspaceModel] | None:
-    """Query the knowledge graph for a list of workspaces matching the user query. Workspaces are entities and workspace types are entitiy types."""
-
-    if not knowledge_graph:
-        raise HTTPException(status_code=500, detail="Knowledge Graph is not available")
-
-    logger.info("Got context -> %s", context)
-    results = knowledge_graph.graph_query(
-        source_type=knowledge_graph_query.source_type,
-        source_value=knowledge_graph_query.source_value,
-        intermediate_types=knowledge_graph_query.intermediate_types,
-        target_type=knowledge_graph_query.target_type,
-        target_value=knowledge_graph_query.target_value,
-        direction=knowledge_graph_query.direction,
-        max_hops=4,
-    )
-    if not results:
-        raise HTTPException(status_code=404, detail="No result found")
-
-    where_clause = [{"workspaceID": str(workspace[1])} for workspace in results]
-    context_update = Context(where=where_clause, query=context.query)
-    logger.info("Return context -> %s", context_update)
-
-    results = [WorkspaceModel(name=n, id=i, type=knowledge_graph_query.target_type) for n, i in results]
-
-    return {"where": where_clause}
-
-    #    return results
-
-
-#    return ToolResponse(results=results, context_update=context_update)

pyxecm_api/agents/otcm_user_agent/__init__.py

@@ -1 +0,0 @@
-"""init module."""

pyxecm_api/agents/otcm_user_agent/models.py

@@ -1,20 +0,0 @@
-"""Define Models for users."""
-
-from typing import Annotated
-
-from pydantic import BaseModel, Field
-
-
-class UserModel(BaseModel):
-    """Defines Model for describing users in OTCS.
-
-    To display the user data as a markdown table, use the `UserModel` class.
-    """
-
-    user_id: Annotated[int, Field(description="ID of the user")] = None
-    login: Annotated[str, Field(description="Login name of the user")] = None
-    first_name: Annotated[str, Field(description="First name of the user")] = None
-    last_name: Annotated[str, Field(description="Last name of the user")] = None
-    email: Annotated[str, Field(description="Email address of the user")] = None
-    department: Annotated[str, Field(description="Department of the user")] = None
-    business_phone: Annotated[str, Field(description="Business phone number of the user")] = None

pyxecm_api/agents/otcm_user_agent/router.py

@@ -1,65 +0,0 @@
-"""Define router for User endpoints."""
-
-import logging
-from typing import Annotated
-
-from fastapi import APIRouter, Body, Depends, HTTPException, status
-from pyxecm.otcs import OTCS
-
-from pyxecm_api.common.functions import get_otcs_object_from_otcsticket
-
-from .models import UserModel
-
-router = APIRouter(prefix="/otcm_user_agent", tags=["csai agents"])
-
-logger = logging.getLogger("pyxecm_api.agents.otcm_user_agent")
-
-
-@router.post(
-    "/user",
-    summary="Find a user by name or user attributes",
-    responses={
-        200: {"description": "User found"},
-        403: {"description": "Invalid credentials"},
-        400: {"description": "User not found"},
-    },
-    response_model=UserModel,
-    response_description="Details about a user. Best presented as a table with each user property in a row.",
-)
-def otcm_user_agent_find_user(
-    otcs: Annotated[OTCS, Depends(get_otcs_object_from_otcsticket)],
-    user: Annotated[UserModel, Body()],
-) -> UserModel | None:
-    """Find a user by by its name or other attributes.
-
-    The user ID, the user name (login), user first name, user last name and user email will be returned.
-    When a user is returned, display the user data as a markdown table.
-    """
-
-    response = otcs.get_users(
-        where_name=user.login,
-        where_first_name=user.first_name,
-        where_last_name=user.last_name,
-        where_business_email=user.email,
-    )
-
-    if not response or not response["results"]:
-        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="User not found")
-
-    try:
-        department_id = otcs.get_result_value(response=response, key="group_id")
-        department = otcs.get_group(group_id=department_id) if department_id else None
-        department_name = otcs.get_result_value(response=department, key="name") if department else None
-        return UserModel(
-            user_id=otcs.get_result_value(response=response, key="id"),
-            login=otcs.get_result_value(response=response, key="name"),
-            first_name=otcs.get_result_value(response=response, key="first_name"),
-            last_name=otcs.get_result_value(response=response, key="last_name"),
-            email=otcs.get_result_value(response=response, key="business_email"),
-            department=department_name,
-        )
-    except Exception as e:
-        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="User not found") from e
-
-
-# end function definition

pyxecm_api/agents/otcm_workspace_agent/__init__.py

@@ -1 +0,0 @@
-"""init module."""

pyxecm_api/agents/otcm_workspace_agent/models.py

@@ -1,40 +0,0 @@
-"""Define Models for workspaces."""
-
-from typing import Annotated, Any
-
-from pydantic import BaseModel, Field
-
-
-class WorkspaceAttributeModel(BaseModel):
-    """Model for a workspace attribute."""
-
-    category: Annotated[str, Field(description="Category for the workspace attributes")]
-    attribute: Annotated[str, Field(description="Name of the attribute")]
-    value: Annotated[str, Field(description="Value of the attribute")]
-    set: Annotated[str, Field(description="Optional attribute group or set name")]
-
-
-class WorkspaceModel(BaseModel):
-    """Defines Model for describing workspaces in OTCM (Opentext Content Management).
-
-    To display an instance of this model, please display the link.
-    """
-
-    id: Annotated[int, Field(description="ID of the workspace")] = None
-    name: Annotated[str, Field(description="Name of the workspace")] = None
-    type: Annotated[str, Field(description="Name of the workspace type")] = None
-    description: Annotated[str, Field(description="Description of the workspace")] = None
-
-    link: Annotated[str, Field(description="Link to the workspace, should be used when the instance is displayed")] = (
-        None
-    )
-
-    # attributes: Annotated[
-    #     list[WorkspaceAttributeModel] | None,
-    #     Body(description="List of custom attributes associated with the workspace"),
-    # ] = None
-
-    def model_post_init(self, context: Any) -> None:  # noqa: ARG002, ANN401
-        """Post model initialization."""
-        # this could also be done with `default_factory`:
-        self.link = f"[{self.name}](/cs/cs/app/nodes/{self.id})"