Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

Feat/prompt studio ux improvements (#1182)

Athulb77d541c5546
diff --git a/backend/tool_instance_v2/tool_processor.py b/backend/tool_instance_v2/tool_processor.py
index 8ed658d73..0a88a5004 100644
--- a/backend/tool_instance_v2/tool_processor.py
+++ b/backend/tool_instance_v2/tool_processor.py
@@ -1,8 +1,10 @@
import logging
+import uuid
from typing import Any, Optional
from account_v2.models import User
from adapter_processor_v2.adapter_processor import AdapterProcessor
+from prompt_studio.prompt_studio_registry_v2.models import PromptStudioRegistry
from prompt_studio.prompt_studio_registry_v2.prompt_studio_registry_helper import (
PromptStudioRegistryHelper,
)
@@ -127,3 +129,19 @@ class ToolProcessor:
tool_list: list[dict[str, Any]] = tool_registry.fetch_tools_descriptions()
tool_list = tool_list + prompt_studio_tools
return tool_list
+
+ @staticmethod
+ def get_prompt_studio_tool_count(user: User) -> int:
+ """Get count of valid prompt studio tools."""
+ # Filter the Prompt studio registry based on the users.
+ prompt_studio_tools = PromptStudioRegistry.objects.list_tools(user)
+ valid_tools = 0
+
+ for tool in prompt_studio_tools:
+ try:
+ uuid.UUID(str(tool.prompt_registry_id))
+ valid_tools += 1
+ except ValueError:
+ continue
+
+ return valid_tools
diff --git a/backend/tool_instance_v2/urls.py b/backend/tool_instance_v2/urls.py
index 411725079..0866ecc4c 100644
--- a/backend/tool_instance_v2/urls.py
+++ b/backend/tool_instance_v2/urls.py
@@ -42,5 +42,10 @@ urlpatterns = format_suffix_patterns(
name="tool_instance_reorder",
),
path("tool/", views.get_tool_list, name="tool_list"),
+ path(
+ "tool/prompt-studio/count/",
+ views.prompt_studio_tool_count,
+ name="prompt_studio_tool_count",
+ ),
]
)
diff --git a/backend/tool_instance_v2/views.py b/backend/tool_instance_v2/views.py
index 98183ea7e..4067474ee 100644
--- a/backend/tool_instance_v2/views.py
+++ b/backend/tool_instance_v2/views.py
@@ -61,6 +61,27 @@ def get_tool_list(request: Request) -> Response:
raise FetchToolListFailed
+# Only GET is allowed, and this is safe.
+@api_view(["GET"])
+def prompt_studio_tool_count(request: Request) -> Response: # NOSONAR
+ """Get count of prompt studio tools.
+
+ Returns count of valid prompt studio tools available in the Tool registry.
+ Only counts tools that have UUID as function names.
+ """
+ if request.method == "GET":
+ try:
+ logger.info("Fetching prompt studio tool count from the tool.")
+ tool_count = ToolProcessor.get_prompt_studio_tool_count(request.user)
+ return Response(
+ data={"count": tool_count},
+ status=status.HTTP_200_OK,
+ )
+ except Exception as exc:
+ logger.error(f"Failed to fetch prompt studio tools: {exc}")
+ raise FetchToolListFailed
+
+
class ToolInstanceViewSet(viewsets.ModelViewSet):
versioning_class = URLPathVersioning
serializer_class = ToolInstanceSerializer
diff --git a/frontend/src/components/api/prompt-studio-service.js b/frontend/src/components/api/prompt-studio-service.js
new file mode 100644
index 000000000..407726fab
--- /dev/null
+++ b/frontend/src/components/api/prompt-studio-service.js
@@ -0,0 +1,17 @@
+import { useCallback } from "react";
+import useRequestUrl from "../../hooks/useRequestUrl";
+import { useAxiosPrivate } from "../../hooks/useAxiosPrivate";
+
+export const usePromptStudioService = () => {
+ const axiosPrivate = useAxiosPrivate();
+ const { getUrl } = useRequestUrl();
+ const getPromptStudioCount = useCallback(async () => {
+ const response = await axiosPrivate({
+ method: "GET",
+ url: getUrl("/tool/prompt-studio/count/"),
+ });
+ return response.data.count;
+ }, [axiosPrivate, getUrl]);
+
+ return { getPromptStudioCount };
+};
diff --git a/frontend/src/components/common/PromptStudioModal.css b/frontend/src/components/common/PromptStudioModal.css
new file mode 100644
index 000000000..ec597b644
--- /dev/null
+++ b/frontend/src/components/common/PromptStudioModal.css
@@ -0,0 +1,144 @@
+/* Modal styles */
+.prompt-studio-modal {
+ padding:10px;
+ top: 20px;
+}
+
+.prompt-studio-modal .ant-modal-content {
+ padding: 0;
+ border-radius: 8px;
+ box-shadow: 0 6px 16px 0 rgba(0, 0, 0, 0.08), 0 3px 6px -4px rgba(0, 0, 0, 0.12), 0 9px 28px 8px rgba(0, 0, 0, 0.05);
+}
+
+.prompt-studio-modal .ant-modal-header {
+ padding-top: 16px;
+ padding-bottom: 0;
+ margin-bottom: 0;
+ padding-right: 20px;
+ border-bottom: none;
+ padding-left: 20px;
+}
+
+.prompt-studio-modal .ant-modal-body {
+ padding: 16px 20px 20px;
+}
+
+.prompt-studio-modal .ant-modal-close {
+ top: 16px;
+ right: 16px;
+}
+
+.prompt-studio-modal .ant-modal-close-x {
+ font-size: 20px;
+ color: rgba(0, 0, 0, 0.45);
+ font-weight: 300;
+ width: 32px;
+ height: 32px;
+ line-height: 32px;
+ display: flex;
+ align-items: center;
+ justify-content: center;
+}
+
+/* Title styles */
+.prompt-studio-title {
+ font-size: 16px;
+ font-weight: 500;
+ color: rgba(0, 0, 0, 0.88);
+ padding: 0;
+ margin-bottom: -4px;
+}
+
+/* Description styles */
+.prompt-studio-description {
+ margin-bottom: 24px;
+ font-size: 14px;
+ color: rgba(0, 0, 0, 0.65);
+ line-height: 22px;
+}
+
+/* Button container */
+.prompt-studio-buttons {
+ display: flex;
+ flex-direction: column;
+ gap: 0;
+}
+
+/* Button styles */
+.prompt-studio-create-btn {
+ transition: all 0.2s ease-in-out !important;
+ background-color: #1677FF !important;
+ border-color: #1677FF !important;
+ height: 32px !important;
+ font-size: 14px !important;
+ display: flex !important;
+ align-items: center !important;
+ justify-content: center !important;
+ gap: 4px !important;
+ box-shadow: none !important;
+ font-weight: normal !important;
+ border-radius: 6px !important;
+ margin: 0 !important;
+ padding: 4px 15px !important;
+}
+
+.prompt-studio-create-btn:hover {
+ background-color: #4096FF !important;
+ border-color: #4096FF !important;
+}
+
+.prompt-studio-create-btn .plus-icon {
+ font-size: 12px;
+ margin-right: 4px;
+ font-weight: normal;
+ line-height: 1;
+}
+
+.prompt-studio-guide-btn {
+ transition: all 0.2s ease-in-out !important;
+ margin-top: 8px !important;
+ height: 32px !important;
+ font-size: 14px !important;
+ padding: 4px 0 !important;
+ margin: 0 !important;
+ font-weight: normal !important;
+ color: #1677FF !important;
+ border-radius: 6px !important;
+}
+
+.prompt-studio-guide-btn:hover {
+ color: #4096FF !important;
+ background-color: transparent !important;
+}
+
+.prompt-studio-cancel-btn {
+ transition: all 0.2s ease-in-out !important;
+ margin-top: 8px !important;
+ height: 32px !important;
+ font-size: 14px !important;
+ padding: 4px 0 !important;
+ margin: 0 !important;
+ color: rgba(0, 0, 0, 0.45) !important;
+ font-weight: normal !important;
+ border-radius: 6px !important;
+}
+
+.prompt-studio-cancel-btn:hover {
+ color: rgba(0, 0, 0, 0.88) !important;
+ background-color: rgba(0, 0, 0, 0.06) !important;
+}
+
+/* Close button hover state */
+.prompt-studio-modal .ant-modal-close:hover {
+ background-color: rgba(0, 0, 0, 0.06) !important;
+ border-radius: 4px !important;
+}
+
+.prompt-studio-modal .ant-modal-close:hover .ant-modal-close-x {
+ color: rgba(0, 0, 0, 0.88) !important;
+}
+
+/* Mask styles */
+.prompt-studio-modal .ant-modal-mask {
+ background-color: rgba(0, 0, 0, 0.45) !important;
+}
diff --git a/frontend/src/components/common/PromptStudioModal.jsx b/frontend/src/components/common/PromptStudioModal.jsx
new file mode 100644
index 000000000..4233df319
--- /dev/null
+++ b/frontend/src/components/common/PromptStudioModal.jsx
@@ -0,0 +1,72 @@
+import { Button, Modal } from "antd";
+import PropTypes from "prop-types";
+import { useNavigate } from "react-router-dom";
+import { useSessionStore } from "../../store/session-store";
+import { usePromptStudioStore } from "../../store/prompt-studio-store";
+import "./PromptStudioModal.css";
+
+export function PromptStudioModal({ onClose }) {
+ const navigate = useNavigate();
+ const { sessionDetails } = useSessionStore();
+ const { count } = usePromptStudioStore();
+
+ const handleClose = () => {
+ if (onClose) onClose();
+ };
+
+ const handleCreateClick = () => {
+ navigate(`/${sessionDetails?.orgName}/tools`);
+ handleClose();
+ };
+
+ return (
+ <Modal
+ title="Create Prompt Studio"
+ open={count === 0}
+ onCancel={handleClose}
+ footer={null}
+ centered
+ width={500}
+ maskClosable={false}
+ className="prompt-studio-modal"
+ closeIcon={<span>×</span>}
+ >
+ <div className="prompt-studio-description">
+ You first need to create and export a Prompt Studio project or export an
+ existing sample Prompt Studio project before you can create a workflow.
+ </div>
+ <div className="prompt-studio-buttons">
+ <Button
+ type="link"
+ onClick={handleCreateClick}
+ className="prompt-studio-guide-btn"
+ >
+ + Create Prompt Studio
+ </Button>
+ <Button
+ type="link"
+ href="https://docs.unstract.com/unstract/unstract_platform/quick_start/"
+ target="_blank"
+ className="prompt-studio-guide-btn"
+ >
+ Quick Start Guide
+ </Button>
+ <Button
+ type="text"
+ onClick={handleClose}
+ className="prompt-studio-cancel-btn"
+ >
+ Cancel
+ </Button>
+ </div>
+ </Modal>
+ );
+}
+
+PromptStudioModal.propTypes = {
+ onClose: PropTypes.func,
+};
+
+PromptStudioModal.defaultProps = {
+ onClose: null,
+};
diff --git a/frontend/src/components/deployments/api-deployment/ApiDeployment.jsx b/frontend/src/components/deployments/api-deployment/ApiDeployment.jsx
index d9b174a1a..f1e128a24 100644
--- a/frontend/src/components/deployments/api-deployment/ApiDeployment.jsx
+++ b/frontend/src/components/deployments/api-deployment/ApiDeployment.jsx
@@ -10,18 +10,20 @@ import {
NotificationOutlined,
} from "@ant-design/icons";
import { Button, Dropdown, Space, Switch, Tooltip, Typography } from "antd";
-import { useEffect, useState } from "react";
+import { useEffect, useState, useCallback } from "react";
import { useNavigate } from "react-router-dom";
import { deploymentApiTypes, displayURL } from "../../../helpers/GetStaticData";
import { useAlertStore } from "../../../store/alert-store";
import { useSessionStore } from "../../../store/session-store";
+import { usePromptStudioStore } from "../../../store/prompt-studio-store";
import { workflowService } from "../../workflows/workflow/workflow-service.js";
import { CreateApiDeploymentModal } from "../create-api-deployment-modal/CreateApiDeploymentModal";
import { DeleteModal } from "../delete-modal/DeleteModal";
import { DisplayCode } from "../display-code/DisplayCode";
import { Layout } from "../layout/Layout";
import { ManageKeys } from "../manage-keys/ManageKeys";
+import { PromptStudioModal } from "../../common/PromptStudioModal";
import { apiDeploymentsService } from "./api-deployments-service";
import { useExceptionHandler } from "../../../hooks/useExceptionHandler.jsx";
import { LogsModal } from "../../pipelines-or-deployments/log-modal/LogsModal.jsx";
@@ -29,6 +31,7 @@ import { fetchExecutionLogs } from "../../pipelines-or-deployments/log-modal/fet
import { useAxiosPrivate } from "../../../hooks/useAxiosPrivate.js";
import usePipelineHelper from "../../../hooks/usePipelineHelper.js";
import { NotificationModal } from "../../pipelines-or-deployments/notification-modal/NotificationModal.jsx";
+import { usePromptStudioService } from "../../api/prompt-studio-service";
function ApiDeployment() {
const { sessionDetails } = useSessionStore();
@@ -54,6 +57,14 @@ function ApiDeployment() {
const { getApiKeys, downloadPostmanCollection, copyUrl } =
usePipelineHelper();
const [openNotificationModal, setOpenNotificationModal] = useState(false);
+ const { count, isLoading, fetchCount } = usePromptStudioStore();
+ const [showModal, setShowModal] = useState(false);
+ const [modalDismissed, setModalDismissed] = useState(false);
+ const { getPromptStudioCount } = usePromptStudioService();
+
+ useEffect(() => {
+ fetchCount(getPromptStudioCount);
+ }, [fetchCount]);
const handleFetchLogs = (page, pageSize) => {
fetchExecutionLogs(
@@ -375,8 +386,20 @@ function ApiDeployment() {
},
];
+ useEffect(() => {
+ if (!isLoading && count === 0 && !modalDismissed) {
+ setShowModal(true);
+ }
+ }, [isLoading, count, modalDismissed]);
+
+ const handleModalClose = useCallback(() => {
+ setShowModal(false);
+ setModalDismissed(true); // Prevent modal reopen.
+ }, []); // Prevents re-renders.
+
return (
<>
+ {showModal && <PromptStudioModal onClose={handleModalClose} />}
<Layout
type="api"
columns={columns}
diff --git a/frontend/src/components/pipelines-or-deployments/etl-task-deploy/EtlTaskDeploy.jsx b/frontend/src/components/pipelines-or-deployments/etl-task-deploy/EtlTaskDeploy.jsx
index 2d6446b62..812965813 100644
--- a/frontend/src/components/pipelines-or-deployments/etl-task-deploy/EtlTaskDeploy.jsx
+++ b/frontend/src/components/pipelines-or-deployments/etl-task-deploy/EtlTaskDeploy.jsx
@@ -7,6 +7,7 @@ import cronstrue from "cronstrue";
import { useAxiosPrivate } from "../../../hooks/useAxiosPrivate.js";
import { useAlertStore } from "../../../store/alert-store";
import { useSessionStore } from "../../../store/session-store";
+import { usePromptStudioStore } from "../../../store/prompt-studio-store";
import CronGenerator from "../../cron-generator/CronGenerator.jsx";
import { workflowService } from "../../workflows/workflow/workflow-service.js";
import "./EtlTaskDeploy.css";
@@ -14,6 +15,8 @@ import { useExceptionHandler } from "../../../hooks/useExceptionHandler.jsx";
import { useWorkflowStore } from "../../../store/workflow-store.js";
import { getBackendErrorDetail } from "../../../helpers/GetStaticData.js";
import usePostHogEvents from "../../../hooks/usePostHogEvents.js";
+import { PromptStudioModal } from "../../common/PromptStudioModal";
+import { useCallback } from "react";
const defaultFromDetails = {
pipeline_name: "",
@@ -53,6 +56,18 @@ const EtlTaskDeploy = ({
const { posthogDeploymentEventText, setPostHogCustomEvent } =
usePostHogEvents();
+ const { count, isLoadingModal, fetchCount } = usePromptStudioStore();
+ const [showModal, setShowModal] = useState(false);
+ const [modalDismissed, setModalDismissed] = useState(false);
+
+ const fetchPromptCount = useCallback(() => {
+ fetchCount();
+ }, [fetchCount]);
+
+ useEffect(() => {
+ fetchPromptCount();
+ }, [fetchPromptCount]);
+
useEffect(() => {
if (workflowId) {
setFormDetails({ ...formDetails, workflow: workflowId });
@@ -128,7 +143,8 @@ const EtlTaskDeploy = ({
} else {
getWorkflows();
}
- }, [type]);
+ fetchCount();
+ }, [type, fetchCount]);
const clearFormDetails = () => {
setFormDetails({ ...defaultFromDetails });
@@ -251,8 +267,21 @@ const EtlTaskDeploy = ({
});
};
+ useEffect(() => {
+ if (!isLoadingModal && count === 0 && !modalDismissed) {
+ setShowModal(true);
+ }
+ }, [isLoadingModal, count, modalDismissed]);
+
+ const handleModalClose = () => {
+ setShowModal(false);
+ setModalDismissed(true);
+ fetchPromptCount();
+ };
+
return (
<>
+ {showModal && <PromptStudioModal onClose={handleModalClose} />}
<Modal
title={isEdit ? `Update ${title}` : `Add ${title}`}
centered
diff --git a/frontend/src/components/pipelines-or-deployments/pipelines/Pipelines.jsx b/frontend/src/components/pipelines-or-deployments/pipelines/Pipelines.jsx
index 9cb823e78..1e30cd214 100644
--- a/frontend/src/components/pipelines-or-deployments/pipelines/Pipelines.jsx
+++ b/frontend/src/components/pipelines-or-deployments/pipelines/Pipelines.jsx
@@ -22,7 +22,7 @@ import {
Typography,
} from "antd";
import PropTypes from "prop-types";
-import { useEffect, useState } from "react";
+import { useEffect, useState, useCallback } from "react";
import cronstrue from "cronstrue";
import {
@@ -44,6 +44,9 @@ import { pipelineService } from "../pipeline-service.js";
import { ManageKeys } from "../../deployments/manage-keys/ManageKeys.jsx";
import usePipelineHelper from "../../../hooks/usePipelineHelper.js";
import { NotificationModal } from "../notification-modal/NotificationModal.jsx";
+import { usePromptStudioStore } from "../../../store/prompt-studio-store";
+import { PromptStudioModal } from "../../common/PromptStudioModal";
+import { usePromptStudioService } from "../../api/prompt-studio-service";
function Pipelines({ type }) {
const [tableData, setTableData] = useState([]);
@@ -66,6 +69,14 @@ function Pipelines({ type }) {
const { getApiKeys, downloadPostmanCollection, copyUrl } =
usePipelineHelper();
const [openNotificationModal, setOpenNotificationModal] = useState(false);
+ const { count, isLoading, fetchCount } = usePromptStudioStore();
+ const [showModal, setShowModal] = useState(false);
+ const [modalDismissed, setModalDismissed] = useState(false);
+ const { getPromptStudioCount } = usePromptStudioService();
+
+ useEffect(() => {
+ fetchCount(getPromptStudioCount);
+ }, [fetchCount]);
const handleFetchLogs = (page, pageSize) => {
fetchExecutionLogs(
@@ -597,8 +608,20 @@ function Pipelines({ type }) {
},
];
+ useEffect(() => {
+ if (!isLoading && count === 0 && !modalDismissed) {
+ setShowModal(true);
+ }
+ }, [isLoading, count, modalDismissed]);
+
+ const handleModalClose = useCallback(() => {
+ setShowModal(false);
+ setModalDismissed(true); // Prevent modal reopen.
+ }, []); // Prevents re-renders.
+
return (
<div className="p-or-d-layout">
+ {showModal && <PromptStudioModal onClose={handleModalClose} />}
<Layout
type={type}
columns={columns}
diff --git a/frontend/src/components/workflows/workflow/Workflows.jsx b/frontend/src/components/workflows/workflow/Workflows.jsx
index 08839404f..84ff35763 100644
--- a/frontend/src/components/workflows/workflow/Workflows.jsx
+++ b/frontend/src/components/workflows/workflow/Workflows.jsx
@@ -2,12 +2,13 @@ import { PlusOutlined, UserOutlined } from "@ant-design/icons";
import { Typography } from "antd";
import isEmpty from "lodash/isEmpty";
import PropTypes from "prop-types";
-import { useEffect, useRef, useState } from "react";
+import { useEffect, useRef, useState, useCallback } from "react";
import { useLocation, useNavigate } from "react-router-dom";
import { useAlertStore } from "../../../store/alert-store";
import { useSessionStore } from "../../../store/session-store";
import { useWorkflowStore } from "../../../store/workflow-store";
+import { usePromptStudioStore } from "../../../store/prompt-studio-store";
import { CustomButton } from "../../widgets/custom-button/CustomButton.jsx";
import { EmptyState } from "../../widgets/empty-state/EmptyState.jsx";
import { LazyLoader } from "../../widgets/lazy-loader/LazyLoader.jsx";
@@ -18,6 +19,8 @@ import { useExceptionHandler } from "../../../hooks/useExceptionHandler.jsx";
import { ToolNavBar } from "../../navigations/tool-nav-bar/ToolNavBar.jsx";
import { ViewTools } from "../../custom-tools/view-tools/ViewTools.jsx";
import usePostHogEvents from "../../../hooks/usePostHogEvents.js";
+import { PromptStudioModal } from "../../common/PromptStudioModal";
+import { usePromptStudioService } from "../../api/prompt-studio-service";
const PROJECT_FILTER_OPTIONS = [
{ label: "My Workflows", value: "mine" },
@@ -32,6 +35,14 @@ function Workflows() {
const projectApiService = workflowService();
const handleException = useExceptionHandler();
const { setPostHogCustomEvent } = usePostHogEvents();
+ const { count, isLoading, fetchCount } = usePromptStudioStore();
+ const [showModal, setShowModal] = useState(false);
+ const [modalDismissed, setModalDismissed] = useState(false);
+ const { getPromptStudioCount } = usePromptStudioService();
+
+ useEffect(() => {
+ fetchCount(getPromptStudioCount);
+ }, [fetchCount]);
const [projectList, setProjectList] = useState();
const [editingProject, setEditProject] = useState();
@@ -189,8 +200,20 @@ function Workflows() {
);
};
+ useEffect(() => {
+ if (!isLoading && count === 0 && !modalDismissed) {
+ setShowModal(true);
+ }
+ }, [isLoading, count, modalDismissed]);
+
+ const handleModalClose = useCallback(() => {
+ setShowModal(false);
+ setModalDismissed(true); // Prevent modal reopen.
+ }, []); // Prevents re-renders.
+
return (
<>
+ {showModal && <PromptStudioModal onClose={handleModalClose} />}
<ToolNavBar
enableSearch
searchList={projectList}
diff --git a/frontend/src/store/prompt-studio-store.js b/frontend/src/store/prompt-studio-store.js
new file mode 100644
index 000000000..7e545c3f1
--- /dev/null
+++ b/frontend/src/store/prompt-studio-store.js
@@ -0,0 +1,29 @@
+import { create } from "zustand";
+
+const STORE_VARIABLES = {
+ count: 0,
+ isLoading: false,
+ error: null,
+};
+
+const usePromptStudioStore = create((set, get) => {
+ return {
+ ...STORE_VARIABLES,
+ fetchCount: async (getPromptStudioCount) => {
+ if (get().isLoading) return;
+
+ set({ isLoading: true });
+ try {
+ const count = await getPromptStudioCount();
+ set({ count, isLoading: false, error: null });
+ } catch (error) {
+ set({ error, isLoading: false });
+ }
+ },
+ resetStore: () => {
+ set(STORE_VARIABLES);
+ },
+ };
+});
+
+export { usePromptStudioStore };