Skip to content

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

FIX: Optimization and UI/UX Improvement of Output Analyzer (#790)

Tahier Hussainba4e931be505
diff --git a/frontend/src/components/custom-tools/combined-output/CombinedOutput.jsx b/frontend/src/components/custom-tools/combined-output/CombinedOutput.jsx
index bc11ce594..36c043d0d 100644
--- a/frontend/src/components/custom-tools/combined-output/CombinedOutput.jsx
+++ b/frontend/src/components/custom-tools/combined-output/CombinedOutput.jsx
@@ -2,7 +2,7 @@ import "prismjs/components/prism-json";
import "prismjs/plugins/line-numbers/prism-line-numbers.css";
import "prismjs/plugins/line-numbers/prism-line-numbers.js";
import "prismjs/themes/prism.css";
-import { useEffect, useState } from "react";
+import { useEffect, useState, useCallback } from "react";
import { useParams } from "react-router-dom";
import PropTypes from "prop-types";
@@ -15,7 +15,6 @@ import { useAxiosPrivate } from "../../../hooks/useAxiosPrivate";
import { useAlertStore } from "../../../store/alert-store";
import { useCustomToolStore } from "../../../store/custom-tool-store";
import { useSessionStore } from "../../../store/session-store";
-import { SpinnerLoader } from "../../widgets/spinner-loader/SpinnerLoader";
import "./CombinedOutput.css";
import { useExceptionHandler } from "../../../hooks/useExceptionHandler";
import { JsonView } from "./JsonView";
@@ -28,8 +27,9 @@ try {
promptOutputApiSps =
require("../../../plugins/simple-prompt-studio/helper").promptOutputApiSps;
} catch {
- // The component will remain null of it is not available
+ // The component will remain null if it is not available
}
+
let publicOutputsApi;
let publicAdapterApi;
let publicDefaultOutputApi;
@@ -41,9 +41,10 @@ try {
publicDefaultOutputApi =
require("../../../plugins/prompt-studio-public-share/helpers/PublicShareAPIs").publicDefaultOutputApi;
} catch {
- // The component will remain null of it is not available
+ // The component will remain null if it is not available
}
-function CombinedOutput({ docId, setFilledFields }) {
+
+function CombinedOutput({ docId, setFilledFields, selectedPrompts }) {
const {
details,
defaultLlmProfile,
@@ -53,94 +54,99 @@ function CombinedOutput({ docId, setFilledFields }) {
isSimplePromptStudio,
isPublicSource,
} = useCustomToolStore();
+
const [combinedOutput, setCombinedOutput] = useState({});
const [isOutputLoading, setIsOutputLoading] = useState(false);
const [adapterData, setAdapterData] = useState([]);
const [activeKey, setActiveKey] = useState(
singlePassExtractMode ? defaultLlmProfile : "0"
);
+ const [selectedProfile, setSelectedProfile] = useState(defaultLlmProfile);
+ const [filteredCombinedOutput, setFilteredCombinedOutput] = useState({});
+
const { id } = useParams();
const { sessionDetails } = useSessionStore();
const { setAlertDetails } = useAlertStore();
const axiosPrivate = useAxiosPrivate();
const handleException = useExceptionHandler();
- const [selectedProfile, setSelectedProfile] = useState(defaultLlmProfile);
useEffect(() => {
- getAdapterInfo();
+ if (isSimplePromptStudio) return;
+
+ const fetchAdapterInfo = async () => {
+ let url = `/api/v1/unstract/${sessionDetails?.orgId}/adapter/?adapter_type=LLM`;
+ if (isPublicSource) {
+ url = publicAdapterApi(id, "LLM");
+ }
+ try {
+ const res = await axiosPrivate.get(url);
+ const adapterList = res?.data;
+ setAdapterData(getLLMModelNamesForProfiles(llmProfiles, adapterList));
+ } catch (err) {
+ setAlertDetails(
+ handleException(err, "Failed to fetch adapter information")
+ );
+ }
+ };
+ fetchAdapterInfo();
}, []);
useEffect(() => {
- setActiveKey(singlePassExtractMode ? defaultLlmProfile : "0");
+ const key = singlePassExtractMode ? defaultLlmProfile : "0";
+ setActiveKey(key);
setSelectedProfile(singlePassExtractMode ? defaultLlmProfile : null);
}, [singlePassExtractMode]);
useEffect(() => {
- if (!docId || isSinglePassExtractLoading) {
- return;
- }
- let filledFields = 0;
- setIsOutputLoading(true);
- setCombinedOutput({});
- handleOutputApiRequest()
- .then((res) => {
+ if (!docId || isSinglePassExtractLoading) return;
+
+ const fetchCombinedOutput = async () => {
+ setIsOutputLoading(true);
+ setCombinedOutput({});
+
+ try {
+ const res = await handleOutputApiRequest();
const data = res?.data || [];
- const prompts = details?.prompts;
+ const prompts = details?.prompts || [];
+
if (activeKey === "0" && !isSimplePromptStudio) {
- const output = {};
- for (const key in data) {
- if (Object.hasOwn(data, key)) {
- output[key] = displayPromptResult(data[key], false);
+ const output = Object.entries(data).reduce((acc, [key, value]) => {
+ acc[key] = displayPromptResult(value, false);
+ return acc;
+ }, {});
+ setCombinedOutput(output);
+ } else {
+ const output = prompts.reduce((acc, item) => {
+ if (item?.prompt_type !== promptType.notes) {
+ const profileManager = selectedProfile || item?.profile_manager;
+ const outputDetails = data.find(
+ (outputValue) =>
+ outputValue?.prompt_id === item?.prompt_id &&
+ outputValue?.profile_manager === profileManager
+ );
+
+ acc[item?.prompt_key] =
+ outputDetails?.output?.length > 0
+ ? displayPromptResult(outputDetails?.output, false)
+ : "";
}
- }
+ return acc;
+ }, {});
setCombinedOutput(output);
- return;
}
- const output = {};
- prompts.forEach((item) => {
- if (item?.prompt_type === promptType.notes) {
- return;
- }
- output[item?.prompt_key] = "";
-
- const profileManager = selectedProfile || item?.profile_manager;
- const outputDetails = data.find(
- (outputValue) =>
- outputValue?.prompt_id === item?.prompt_id &&
- outputValue?.profile_manager === profileManager
- );
-
- if (!outputDetails) {
- return;
- }
-
- output[item?.prompt_key] = displayPromptResult(
- outputDetails?.output,
- false
- );
-
- if (outputDetails?.output?.length > 0) {
- filledFields++;
- }
- });
-
- setCombinedOutput(output);
-
- if (setFilledFields) {
- setFilledFields(filledFields);
- }
- })
- .catch((err) => {
+ } catch (err) {
setAlertDetails(
handleException(err, "Failed to generate combined output")
);
- })
- .finally(() => {
+ } finally {
setIsOutputLoading(false);
- });
- }, [docId, isSinglePassExtractLoading, activeKey]);
+ }
+ };
+
+ fetchCombinedOutput();
+ }, [docId, activeKey]);
- const handleOutputApiRequest = async () => {
+ const handleOutputApiRequest = useCallback(async () => {
let url;
if (isSimplePromptStudio) {
url = promptOutputApiSps(details?.tool_id, null, docId);
@@ -156,15 +162,12 @@ function CombinedOutput({ docId, setFilledFields }) {
url = publicDefaultOutputApi(id, docId);
}
} else {
- url = `/api/v1/unstract/${
- sessionDetails?.orgId
- }/prompt-studio/prompt-output/?tool_id=${
- details?.tool_id
- }&document_manager=${docId}&is_single_pass_extract=${singlePassExtractMode}&profile_manager=${
- selectedProfile || defaultLlmProfile
- }`;
+ const orgId = sessionDetails?.orgId;
+ const toolId = details?.tool_id;
+ const profileManager = selectedProfile || defaultLlmProfile;
+ url = `/api/v1/unstract/${orgId}/prompt-studio/prompt-output/?tool_id=${toolId}&document_manager=${docId}&is_single_pass_extract=${singlePassExtractMode}&profile_manager=${profileManager}`;
if (activeKey === "0") {
- url = `/api/v1/unstract/${sessionDetails?.orgId}/prompt-studio/prompt-output/prompt-default-profile/?tool_id=${details?.tool_id}&document_manager=${docId}`;
+ url = `/api/v1/unstract/${orgId}/prompt-studio/prompt-output/prompt-default-profile/?tool_id=${toolId}&document_manager=${docId}`;
}
}
const requestOptions = {
@@ -174,58 +177,66 @@ function CombinedOutput({ docId, setFilledFields }) {
"X-CSRFToken": sessionDetails?.csrfToken,
},
};
- return axiosPrivate(requestOptions)
- .then((res) => res)
- .catch((err) => {
- throw err;
- });
- };
-
- const getAdapterInfo = () => {
- if (isSimplePromptStudio) return;
- let url = `/api/v1/unstract/${sessionDetails?.orgId}/adapter/?adapter_type=LLM`;
- if (isPublicSource) {
- url = publicAdapterApi(id, "LLM");
- }
- axiosPrivate.get(url).then((res) => {
- const adapterList = res?.data;
- setAdapterData(getLLMModelNamesForProfiles(llmProfiles, adapterList));
- });
- };
-
- if (isOutputLoading) {
- return <SpinnerLoader />;
- }
+ const res = await axiosPrivate(requestOptions);
+ return res;
+ }, [
+ singlePassExtractMode,
+ docId,
+ selectedProfile,
+ defaultLlmProfile,
+ activeKey,
+ ]);
+
+ const handleTabChange = useCallback(
+ (key) => {
+ setActiveKey(key);
+ setSelectedProfile(key === "0" ? defaultLlmProfile : key);
+ },
+ [defaultLlmProfile]
+ );
- const handleTabChange = (key) => {
- if (key === "0") {
- setSelectedProfile(defaultLlmProfile);
- } else {
- setSelectedProfile(key);
+ // Filter combined output based on selectedPrompts
+ useEffect(() => {
+ const filteredCombinedOutput = Object.fromEntries(
+ Object.entries(combinedOutput).filter(
+ ([key]) => !selectedPrompts || selectedPrompts[key]
+ )
+ );
+
+ const filledFields = Object.values(filteredCombinedOutput).filter(
+ (value) => value === 0 || (value && value.length > 0)
+ ).length;
+
+ if (setFilledFields) {
+ setFilledFields(filledFields);
}
- setActiveKey(key);
- };
+ setFilteredCombinedOutput(filteredCombinedOutput);
+ }, [selectedPrompts, combinedOutput]);
if (isSimplePromptStudio && TableView) {
- return <TableView combinedOutput={combinedOutput} />;
+ return (
+ <TableView combinedOutput={combinedOutput} isLoading={isOutputLoading} />
+ );
}
return (
<JsonView
- combinedOutput={combinedOutput}
+ combinedOutput={filteredCombinedOutput}
handleTabChange={handleTabChange}
selectedProfile={selectedProfile}
llmProfiles={llmProfiles}
activeKey={activeKey}
adapterData={adapterData}
isSinglePass={singlePassExtractMode}
+ isLoading={isOutputLoading}
/>
);
}
CombinedOutput.propTypes = {
- docId: PropTypes.string,
+ docId: PropTypes.string.isRequired,
setFilledFields: PropTypes.func,
+ selectedPrompts: PropTypes.object.isRequired,
};
export { CombinedOutput };
diff --git a/frontend/src/components/custom-tools/combined-output/JsonView.jsx b/frontend/src/components/custom-tools/combined-output/JsonView.jsx
index ddf36777f..aee6c297a 100644
--- a/frontend/src/components/custom-tools/combined-output/JsonView.jsx
+++ b/frontend/src/components/custom-tools/combined-output/JsonView.jsx
@@ -1,10 +1,11 @@
import PropTypes from "prop-types";
import Prism from "prismjs";
import { useEffect } from "react";
-import { ProfileInfoBar } from "../profile-info-bar/ProfileInfoBar";
import TabPane from "antd/es/tabs/TabPane";
import { Tabs } from "antd";
+import { JsonViewBody } from "./JsonViewBody";
+
function JsonView({
combinedOutput,
handleTabChange,
@@ -13,6 +14,7 @@ function JsonView({
selectedProfile,
llmProfiles,
isSinglePass,
+ isLoading,
}) {
useEffect(() => {
Prism.highlightAll();
@@ -35,18 +37,13 @@ function JsonView({
<div className="combined-op-segment"></div>
</div>
<div className="combined-op-divider" />
- {activeKey !== "0" && (
- <ProfileInfoBar profileId={selectedProfile} profiles={llmProfiles} />
- )}
- <div className="combined-op-body code-snippet">
- {combinedOutput && (
- <pre className="line-numbers width-100">
- <code className="language-javascript width-100">
- {JSON.stringify(combinedOutput, null, 2)}
- </code>
- </pre>
- )}
- </div>
+ <JsonViewBody
+ activeKey={activeKey}
+ selectedProfile={selectedProfile}
+ llmProfiles={llmProfiles}
+ combinedOutput={combinedOutput}
+ isLoading={isLoading}
+ />
<div className="gap" />
</div>
);
@@ -60,6 +57,7 @@ JsonView.propTypes = {
llmProfiles: PropTypes.array,
activeKey: PropTypes.string,
isSinglePass: PropTypes.bool,
+ isLoading: PropTypes.bool.isRequired,
};
export { JsonView };
diff --git a/frontend/src/components/custom-tools/combined-output/JsonViewBody.jsx b/frontend/src/components/custom-tools/combined-output/JsonViewBody.jsx
new file mode 100644
index 000000000..97ddcd212
--- /dev/null
+++ b/frontend/src/components/custom-tools/combined-output/JsonViewBody.jsx
@@ -0,0 +1,43 @@
+import PropTypes from "prop-types";
+
+import { ProfileInfoBar } from "../profile-info-bar/ProfileInfoBar";
+import { SpinnerLoader } from "../../widgets/spinner-loader/SpinnerLoader";
+
+function JsonViewBody({
+ activeKey,
+ selectedProfile,
+ llmProfiles,
+ combinedOutput,
+ isLoading,
+}) {
+ if (isLoading) {
+ return <SpinnerLoader />;
+ }
+
+ return (
+ <>
+ {activeKey !== "0" && (
+ <ProfileInfoBar profileId={selectedProfile} profiles={llmProfiles} />
+ )}
+ <div className="combined-op-body code-snippet">
+ {combinedOutput && (
+ <pre className="line-numbers width-100">
+ <code className="language-javascript width-100">
+ {JSON.stringify(combinedOutput, null, 2)}
+ </code>
+ </pre>
+ )}
+ </div>
+ </>
+ );
+}
+
+JsonViewBody.propTypes = {
+ activeKey: PropTypes.string.isRequired,
+ selectedProfile: PropTypes.string,
+ llmProfiles: PropTypes.string,
+ combinedOutput: PropTypes.object,
+ isLoading: PropTypes.bool.isRequired,
+};
+
+export { JsonViewBody };
diff --git a/frontend/src/components/custom-tools/output-analyzer-header/OutputAnalyzerHeader.jsx b/frontend/src/components/custom-tools/output-analyzer-header/OutputAnalyzerHeader.jsx
deleted file mode 100644
index 7c847a297..000000000
--- a/frontend/src/components/custom-tools/output-analyzer-header/OutputAnalyzerHeader.jsx
+++ /dev/null
@@ -1,48 +0,0 @@
-import { Button, Space, Typography } from "antd";
-import { ArrowLeftOutlined } from "@ant-design/icons";
-import { useNavigate, useParams } from "react-router-dom";
-
-import { useSessionStore } from "../../../store/session-store";
-import { useCustomToolStore } from "../../../store/custom-tool-store";
-
-let HeaderPublic;
-try {
- HeaderPublic =
- require("../../../plugins/prompt-studio-public-share/header-public/HeaderPublic.jsx").HeaderPublic;
-} catch (err) {
- // Do nothing if plugins are not loaded.
-}
-
-function OutputAnalyzerHeader() {
- const { sessionDetails } = useSessionStore();
- const { id } = useParams();
- const navigate = useNavigate();
- const { isPublicSource } = useCustomToolStore();
- const handleNavigate = () => {
- if (isPublicSource) {
- navigate(`/promptStudio/share/${id}`);
- } else {
- navigate(`/${sessionDetails?.orgName}/tools/${id}`);
- }
- };
- return (
- <div>
- {isPublicSource && HeaderPublic && <HeaderPublic />}
- <div className="output-analyzer-header">
- <div>
- <Space>
- <Button size="small" type="text" onClick={handleNavigate}>
- <ArrowLeftOutlined />
- </Button>
- <Typography.Text className="font-size-16" strong>
- Output Analyzer
- </Typography.Text>
- </Space>
- </div>
- <div></div>
- </div>
- </div>
- );
-}
-
-export { OutputAnalyzerHeader };
diff --git a/frontend/src/components/custom-tools/output-analyzer-list/OutputAnalyzerList.css b/frontend/src/components/custom-tools/output-analyzer-list/OutputAnalyzerList.css
deleted file mode 100644
index 0c95db270..000000000
--- a/frontend/src/components/custom-tools/output-analyzer-list/OutputAnalyzerList.css
+++ /dev/null
@@ -1,77 +0,0 @@
-/* Styles for OutputAnalyzerList */
-
-.output-analyzer-layout {
- height: 100%;
- display: flex;
- flex-direction: column;
- background-color: var(--page-bg-2);
- overflow-y: hidden;
-}
-
-.output-analyzer-header {
- padding: 8px;
- background-color: #F5F7F9;
- display: flex;
- justify-content: space-between;
- align-items: center;
-}
-
-.output-analyzer-header .title {
- font-size: 16px;
-}
-
-.output-analyzer-body {
- padding: 12px;
- height: 100%;
- overflow-y: auto;
-}
-
-.public-output-analyzer-body {
- padding: 12px;
- overflow-y: auto;
- width:100vw;
-}
-
-.output-analyzer-body2 {
- height: 700px;
- display: flex;
- flex-direction: column;
-}
-
-.output-analyzer-card-head {
- padding: 12px;
- display: flex;
- justify-content: space-between;
- background-color: #ECEFF3;
-}
-
-.output-analyzer-main {
- flex: 1;
- overflow-y: hidden;
-}
-
-.output-analyzer-left-box {
- padding-right: 6px;
- height: 100%;
- overflow-y: auto;
-}
-
-.output-analyzer-left-box > div {
- height: 100%;
- background-color: var(--white);
-}
-
-.output-analyzer-right-box {
- padding-left: 6px;
- height: 100%;
-}
-
-.output-analyzer-right-box > div {
- height: 100%;
- background-color: var(--white);
- padding: 0px 12px;
-}
-
-.output-analyzer-card-gap {
- margin-bottom: 12px;
-}
diff --git a/frontend/src/components/custom-tools/output-analyzer-list/OutputAnalyzerList.jsx b/frontend/src/components/custom-tools/output-analyzer-list/OutputAnalyzerList.jsx
deleted file mode 100644
index 92b3083e1..000000000
--- a/frontend/src/components/custom-tools/output-analyzer-list/OutputAnalyzerList.jsx
+++ /dev/null
@@ -1,45 +0,0 @@
-import { useEffect, useState } from "react";
-
-import { OutputAnalyzerHeader } from "../output-analyzer-header/OutputAnalyzerHeader";
-import "./OutputAnalyzerList.css";
-import { OutputAnalyzerCard } from "../output-analyzer-card/OutputAnalyzerCard";
-import { useCustomToolStore } from "../../../store/custom-tool-store";
-import { promptType } from "../../../helpers/GetStaticData";
-
-function OutputAnalyzerList() {
- const [totalFields, setTotalFields] = useState(0);
- const { listOfDocs, details, isPublicSource } = useCustomToolStore();
-
- useEffect(() => {
- const prompts = [...(details?.prompts || [])];
- const promptsFiltered = prompts.filter(
- (item) => item?.prompt_type === promptType.prompt
- );
- setTotalFields(promptsFiltered.length || 0);
- }, [details]);
-
- return (
- <div className="output-analyzer-layout">
- <div>
- <OutputAnalyzerHeader />
- </div>
- <div
- className={
- isPublicSource
- ? "public-output-analyzer-body"
- : "output-analyzer-body"
- }
- >
- {listOfDocs.map((doc) => {
- return (
- <div className="output-analyzer-card-gap" key={doc?.document_id}>
- <OutputAnalyzerCard doc={doc} totalFields={totalFields} />
- </div>
- );
- })}
- </div>
- </div>
- );
-}
-
-export { OutputAnalyzerList };
diff --git a/frontend/src/components/custom-tools/output-analyzer/FilterPromptFields.jsx b/frontend/src/components/custom-tools/output-analyzer/FilterPromptFields.jsx
new file mode 100644
index 000000000..4fe966268
--- /dev/null
+++ b/frontend/src/components/custom-tools/output-analyzer/FilterPromptFields.jsx
@@ -0,0 +1,48 @@
+import { Form, Checkbox } from "antd";
+import PropTypes from "prop-types";
+import React, { useEffect, useState, useCallback } from "react";
+
+const FilterPromptFields = React.memo(
+ ({ isOpen, selectedPrompts, setSelectedPrompts }) => {
+ const [localSelectedPrompts, setLocalSelectedPrompts] =
+ useState(selectedPrompts);
+ const [hasChanges, setHasChanges] = useState(false);
+ const [form] = Form.useForm();
+
+ useEffect(() => {
+ if (!isOpen && hasChanges) {
+ // Update parent state when the Drawer is closed and changes were made
+ setSelectedPrompts(localSelectedPrompts);
+ }
+ }, [isOpen, hasChanges, setSelectedPrompts, localSelectedPrompts]);
+
+ const handleValuesChange = useCallback((_, allValues) => {
+ setHasChanges(true);
+ setLocalSelectedPrompts(allValues);
+ }, []);
+
+ return (
+ <Form
+ form={form}
+ initialValues={localSelectedPrompts}
+ onValuesChange={handleValuesChange}
+ >
+ {Object.keys(localSelectedPrompts).map((key) => (
+ <Form.Item key={key} name={key} valuePropName="checked">
+ <Checkbox>{key}</Checkbox>
+ </Form.Item>
+ ))}
+ </Form>
+ );
+ }
+);
+
+FilterPromptFields.displayName = "FilterPromptFields";
+
+FilterPromptFields.propTypes = {
+ isOpen: PropTypes.bool.isRequired,
+ selectedPrompts: PropTypes.object.isRequired,
+ setSelectedPrompts: PropTypes.func.isRequired,
+};
+
+export { FilterPromptFields };
diff --git a/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzer.css b/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzer.css
new file mode 100644
index 000000000..842fd9430
--- /dev/null
+++ b/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzer.css
@@ -0,0 +1,73 @@
+/* Styles for OutputAnalyzer */
+
+.output-analyzer-layout {
+ height: 100%;
+ display: flex;
+ flex-direction: column;
+ background-color: var(--page-bg-2);
+ overflow-y: hidden;
+}
+
+.output-analyzer-header {
+ padding: 10px;
+ background-color: #f5f7f9;
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+}
+
+.output-analyzer-header .title {
+ font-size: 16px;
+}
+
+.output-analyzer-body {
+ padding: 12px;
+ height: 100%;
+ overflow-y: auto;
+}
+
+.public-output-analyzer-body {
+ padding: 12px;
+ overflow-y: auto;
+ width: 100vw;
+}
+
+.output-analyzer-body2 {
+ height: 100%;
+ display: flex;
+ flex-direction: column;
+}
+
+.output-analyzer-card-head {
+ padding: 12px;
+ display: flex;
+ justify-content: space-between;
+ background-color: #eceff3;
+}
+
+.output-analyzer-main {
+ flex: 1;
+ overflow-y: hidden;
+}
+
+.output-analyzer-left-box {
+ padding-right: 6px;
+ height: 100%;
+ overflow-y: auto;
+}
+
+.output-analyzer-left-box > div {
+ height: 100%;
+ background-color: var(--white);
+ padding: 0px 12px;
+}
+
+.output-analyzer-right-box {
+ padding-left: 6px;
+ height: 100%;
+}
+
+.output-analyzer-right-box > div {
+ height: 100%;
+ background-color: var(--white);
+}
diff --git a/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzer.jsx b/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzer.jsx
new file mode 100644
index 000000000..904eaa6ab
--- /dev/null
+++ b/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzer.jsx
@@ -0,0 +1,96 @@
+import { useEffect, useState, useMemo, useCallback } from "react";
+import { Drawer } from "antd";
+
+import { OutputAnalyzerHeader } from "./OutputAnalyzerHeader";
+import "./OutputAnalyzer.css";
+import { OutputAnalyzerCard } from "./OutputAnalyzerCard";
+import { useCustomToolStore } from "../../../store/custom-tool-store";
+import { promptType } from "../../../helpers/GetStaticData";
+import { FilterPromptFields } from "./FilterPromptFields";
+
+function OutputAnalyzer() {
+ const [currentDocIndex, setCurrentDocIndex] = useState(-1);
+ const { listOfDocs, details, isPublicSource, selectedDoc } =
+ useCustomToolStore();
+ const [selectedPrompts, setSelectedPrompts] = useState({});
+ const [isFilterDrawerOpen, setIsFilterDrawerOpen] = useState(false);
+
+ useEffect(() => {
+ const allPrompts = details?.prompts || [];
+ const promptFields = allPrompts.filter(
+ (item) => item?.prompt_type === promptType.prompt
+ );
+
+ const initialSelectedPrompts = promptFields.reduce((acc, item) => {
+ acc[item?.prompt_key] = true;
+ return acc;
+ }, {});
+
+ setSelectedPrompts(initialSelectedPrompts);
+
+ const selectedDocIndex =
+ listOfDocs.findIndex(
+ (doc) => doc?.document_id === selectedDoc?.document_id
+ ) || 0;
+ setCurrentDocIndex(selectedDocIndex);
+ }, []);
+
+ const totalFields = useMemo(() => {
+ return Object.values(selectedPrompts).filter(Boolean).length;
+ }, [selectedPrompts]);
+
+ const openFilterDrawer = useCallback(() => {
+ setIsFilterDrawerOpen(true);
+ }, []);
+
+ const closeFilterDrawer = useCallback(() => {
+ setIsFilterDrawerOpen(false);
+ }, []);
+
+ const currentDoc = useMemo(() => {
+ if (currentDocIndex === -1) return null;
+ return listOfDocs[currentDocIndex];
+ }, [listOfDocs, currentDocIndex]);
+
+ return (
+ <div className="output-analyzer-layout">
+ <div>
+ <OutputAnalyzerHeader
+ docs={listOfDocs}
+ currentDocIndex={currentDocIndex}
+ setCurrentDocIndex={setCurrentDocIndex}
+ selectedPrompts={selectedPrompts}
+ openFilterDrawer={openFilterDrawer}
+ />
+ </div>
+ <div
+ className={
+ isPublicSource
+ ? "public-output-analyzer-body"
+ : "output-analyzer-body"
+ }
+ >
+ <div className="height-100" key={currentDoc?.document_id}>
+ <OutputAnalyzerCard
+ doc={currentDoc}
+ selectedPrompts={selectedPrompts}
+ totalFields={totalFields}
+ />
+ </div>
+ </div>
+ <Drawer
+ title="Filter Prompt Fields"
+ open={isFilterDrawerOpen}
+ onClose={closeFilterDrawer}
+ >
+ <FilterPromptFields
+ isOpen={isFilterDrawerOpen}
+ selectedPrompts={selectedPrompts}
+ setSelectedPrompts={setSelectedPrompts}
+ />
+ </Drawer>
+ </div>
+ );
+}
+
+export { OutputAnalyzer };
diff --git a/frontend/src/components/custom-tools/output-analyzer-card/OutputAnalyzerCard.jsx b/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzerCard.jsx
similarity index 74%
rename from frontend/src/components/custom-tools/output-analyzer-card/OutputAnalyzerCard.jsx
rename to frontend/src/components/custom-tools/output-analyzer/OutputAnalyzerCard.jsx
index 949b775d2..20769fd1b 100644
--- a/frontend/src/components/custom-tools/output-analyzer-card/OutputAnalyzerCard.jsx
+++ b/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzerCard.jsx
@@ -1,6 +1,7 @@
import { Col, Divider, Flex, Row, Space, Typography } from "antd";
import PropTypes from "prop-types";
-import { useEffect, useState } from "react";
+import { useEffect, useState, useMemo } from "react";
+import { useParams } from "react-router-dom";
import { base64toBlob } from "../../../helpers/GetStaticData";
import { useAxiosPrivate } from "../../../hooks/useAxiosPrivate";
@@ -11,19 +12,20 @@ import { useSessionStore } from "../../../store/session-store";
import { CombinedOutput } from "../combined-output/CombinedOutput";
import { DocumentViewer } from "../document-viewer/DocumentViewer";
import { PdfViewer } from "../pdf-viewer/PdfViewer";
-import { useParams } from "react-router-dom";
let publicDocumentApi;
try {
publicDocumentApi =
require("../../../plugins/prompt-studio-public-share/helpers/PublicShareAPIs").publicDocumentApi;
} catch {
- // The component will remain null of it is not available
+ // The component will remain null if it is not available
}
-function OutputAnalyzerCard({ doc, totalFields }) {
+
+function OutputAnalyzerCard({ doc, selectedPrompts, totalFields }) {
const [fileUrl, setFileUrl] = useState("");
const [isDocLoading, setIsDocLoading] = useState(false);
const [filledFields, setFilledFields] = useState(0);
+
const { details, isPublicSource } = useCustomToolStore();
const { sessionDetails } = useSessionStore();
const { setAlertDetails } = useAlertStore();
@@ -31,34 +33,46 @@ function OutputAnalyzerCard({ doc, totalFields }) {
const handleException = useExceptionHandler();
const { id } = useParams();
+ // Memoize the file URL endpoint to prevent unnecessary recalculations
+ const fileUrlEndpoint = useMemo(() => {
+ if (!doc) return null;
+
+ if (isPublicSource) {
+ return publicDocumentApi?.(id, doc.document_id, null);
+ } else {
+ return `/api/v1/unstract/${sessionDetails?.orgId}/prompt-studio/file/${details?.tool_id}?document_id=${doc?.document_id}`;
+ }
+ }, [doc]);
+
+ // Fetch the document file when the endpoint changes
useEffect(() => {
- if (!doc) {
+ if (!fileUrlEndpoint) {
setFileUrl("");
return;
}
- let url = `/api/v1/unstract/${sessionDetails?.orgId}/prompt-studio/file/${details?.tool_id}?document_id=${doc?.document_id}`;
- if (isPublicSource) {
- url = publicDocumentApi(id, doc?.document_id, null);
- }
- const requestOptions = {
- method: "GET",
- url,
- };
- setIsDocLoading(true);
- axiosPrivate(requestOptions)
- .then((res) => {
+ const fetchFile = async () => {
+ setIsDocLoading(true);
+ try {
+ const res = await axiosPrivate.get(fileUrlEndpoint);
const base64String = res?.data?.data || "";
const blob = base64toBlob(base64String);
setFileUrl(URL.createObjectURL(blob));
- })
- .catch((err) => {
+ } catch (err) {
setAlertDetails(handleException(err, "Failed to load the document"));
- })
- .finally(() => {
+ } finally {
setIsDocLoading(false);
- });
- }, [doc]);
+ }
+ };
+
+ fetchFile();
+ }, [fileUrlEndpoint]);
+
+ // Calculate fill rate
+ const fillRate = useMemo(() => {
+ if (totalFields === 0) return "0";
+ return ((filledFields / totalFields) * 100).toFixed(2);
+ }, [filledFields, totalFields]);
return (
<div className="output-analyzer-body2">
@@ -75,7 +89,7 @@ function OutputAnalyzerCard({ doc, totalFields }) {
</div>
<div>
<Typography.Text>
- Fill rate: <strong>NA</strong>
+ Fill rate: <strong>{`${fillRate}%`}</strong>
</Typography.Text>
<Divider type="vertical" />
</div>
@@ -96,23 +110,24 @@ function OutputAnalyzerCard({ doc, totalFields }) {
<Row className="height-100">
<Col span={12} className="height-100">
<div className="output-analyzer-left-box">
+ <CombinedOutput
+ docId={doc?.document_id}
+ selectedPrompts={selectedPrompts}
+ setFilledFields={setFilledFields}
+ />
+ </div>
+ </Col>
+ <Col span={12} className="height-100">
+ <div className="output-analyzer-right-box">
<DocumentViewer
doc={doc}
isLoading={isDocLoading}
- isContentAvailable={fileUrl?.length > 0}
+ isContentAvailable={Boolean(fileUrl)}
>
<PdfViewer fileUrl={fileUrl} />
</DocumentViewer>
</div>
</Col>
- <Col span={12} className="height-100">
- <div className="output-analyzer-right-box">
- <CombinedOutput
- docId={doc?.document_id}
- setFilledFields={setFilledFields}
- />
- </div>
- </Col>
</Row>
</div>
</div>
@@ -121,6 +136,7 @@ function OutputAnalyzerCard({ doc, totalFields }) {
OutputAnalyzerCard.propTypes = {
doc: PropTypes.object.isRequired,
+ selectedPrompts: PropTypes.object.isRequired,
totalFields: PropTypes.number.isRequired,
};
diff --git a/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzerHeader.jsx b/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzerHeader.jsx
new file mode 100644
index 000000000..ae8c49414
--- /dev/null
+++ b/frontend/src/components/custom-tools/output-analyzer/OutputAnalyzerHeader.jsx
@@ -0,0 +1,150 @@
+import { Button, Drawer, Menu, Space, Typography } from "antd";
+import {
+ ArrowLeftOutlined,
+ FilePdfOutlined,
+ FilterOutlined,
+ LeftOutlined,
+ RightOutlined,
+} from "@ant-design/icons";
+import { useNavigate, useParams } from "react-router-dom";
+import PropTypes from "prop-types";
+import { useMemo, useCallback, useState } from "react";
+
+import { useSessionStore } from "../../../store/session-store";
+import { useCustomToolStore } from "../../../store/custom-tool-store";
+
+let HeaderPublic;
+try {
+ HeaderPublic =
+ require("../../../plugins/prompt-studio-public-share/header-public/HeaderPublic.jsx").HeaderPublic;
+} catch (err) {
+ // Do nothing if plugins are not loaded.
+}
+
+const PAGINATION_ACTIONS = {
+ PREV: "PREV",
+ NEXT: "NEXT",
+};
+
+function OutputAnalyzerHeader({
+ docs,
+ currentDocIndex,
+ setCurrentDocIndex,
+ selectedPrompts,
+ openFilterDrawer,
+}) {
+ const { sessionDetails } = useSessionStore();
+ const { id } = useParams();
+ const navigate = useNavigate();
+ const { isPublicSource } = useCustomToolStore();
+ const [openDocListDrawer, setOpenDocListDrawer] = useState(false);
+
+ const docsLength = docs?.length || 0;
+
+ const selectedPromptFields = useMemo(() => {
+ return Object.values(selectedPrompts).filter(Boolean).length;
+ }, [selectedPrompts]);
+
+ const menuItems = useMemo(
+ () =>
+ docs.map((doc, docIndex) => ({
+ key: docIndex.toString(),
+ label: doc?.document_name,
+ })),
+ [docs]
+ );
+
+ const handleNavigate = useCallback(() => {
+ const path = isPublicSource
+ ? `/promptStudio/share/${id}`
+ : `/${sessionDetails?.orgName}/tools/${id}`;
+ navigate(path);
+ }, []);
+
+ const handlePagination = useCallback((action) => {
+ setCurrentDocIndex((prevIndex) => {
+ let delta = 0;
+
+ if (action === PAGINATION_ACTIONS.PREV) {
+ delta = -1;
+ } else if (action === PAGINATION_ACTIONS.NEXT) {
+ delta = 1;
+ }
+
+ return Math.max(0, Math.min(prevIndex + delta, docsLength - 1));
+ });
+ }, []);
+
+ const handleSelectionOfDoc = useCallback((selectedDoc) => {
+ setCurrentDocIndex(parseInt(selectedDoc.key, 10));
+ }, []);
+
+ return (
+ <div>
+ {isPublicSource && HeaderPublic && <HeaderPublic />}
+ <div className="output-analyzer-header">
+ <div>
+ <Space>
+ <Button size="small" type="text" onClick={handleNavigate}>
+ <ArrowLeftOutlined />
+ </Button>
+ <Typography.Text className="font-size-16" strong>
+ Output Analyzer
+ </Typography.Text>
+ </Space>
+ </div>
+ <div>
+ <Space>
+ <Button
+ type="text"
+ icon={<FilterOutlined />}
+ onClick={openFilterDrawer}
+ >{`${selectedPromptFields} of ${
+ Object.keys(selectedPrompts).length
+ } fields selected`}</Button>
+ <Button
+ type="primary"
+ icon={<FilePdfOutlined />}
+ onClick={() => setOpenDocListDrawer(true)}
+ />
+ <div>
+ <Button
+ type="text"
+ icon={<LeftOutlined />}
+ onClick={() => handlePagination(PAGINATION_ACTIONS.PREV)}
+ disabled={currentDocIndex === 0}
+ />
+ <Button
+ type="text"
+ icon={<RightOutlined />}
+ onClick={() => handlePagination(PAGINATION_ACTIONS.NEXT)}
+ disabled={currentDocIndex === docsLength - 1}
+ />
+ </div>
+ </Space>
+ </div>
+ </div>
+ <Drawer
+ title="Document List"
+ open={openDocListDrawer}
+ onClose={() => setOpenDocListDrawer(false)}
+ >
+ <Menu
+ selectedKeys={[currentDocIndex.toString()]}
+ items={menuItems}
+ onSelect={handleSelectionOfDoc}
+ />
+ </Drawer>
+ </div>
+ );
+}
+
+OutputAnalyzerHeader.propTypes = {
+ docs: PropTypes.array.isRequired,
+ currentDocIndex: PropTypes.number.isRequired,
+ setCurrentDocIndex: PropTypes.func.isRequired,
+ selectedPrompts: PropTypes.object.isRequired,
+ openFilterDrawer: PropTypes.func.isRequired,
+};
+
+export { OutputAnalyzerHeader };
diff --git a/frontend/src/pages/OutputAnalyzerPage.jsx b/frontend/src/pages/OutputAnalyzerPage.jsx
index af89f315d..ec3dcffc7 100644
--- a/frontend/src/pages/OutputAnalyzerPage.jsx
+++ b/frontend/src/pages/OutputAnalyzerPage.jsx
@@ -1,7 +1,7 @@
-import { OutputAnalyzerList } from "../components/custom-tools/output-analyzer-list/OutputAnalyzerList";
+import { OutputAnalyzer } from "../components/custom-tools/output-analyzer/OutputAnalyzer";
function OutputAnalyzerPage() {
- return <OutputAnalyzerList />;
+ return <OutputAnalyzer />;
}
export { OutputAnalyzerPage };