Feat: Add a switch to control the display of structured output to the agent form.

This commit is contained in:
bill 2025-11-18 18:02:29 +08:00
parent ba10b64637
commit 756ead0a20
5 changed files with 84 additions and 38 deletions

View file

@ -463,21 +463,14 @@ export const initialAgentValues = {
tools: [],
mcp: [],
cite: true,
showStructuredOutput: false,
[AgentStructuredOutputField]: {},
outputs: {
// structured_output: {
// topic: {
// type: 'string',
// description:
// 'default:general. The category of the search.news is useful for retrieving real-time updates, particularly about politics, sports, and major current events covered by mainstream media sources. general is for broader, more general-purpose searches that may include a wide range of sources.',
// enum: ['general', 'news'],
// default: 'general',
// },
// },
content: {
type: 'string',
value: '',
},
[AgentStructuredOutputField]: {},
// [AgentStructuredOutputField]: {},
},
};

View file

@ -6,6 +6,7 @@ import {
import { LlmSettingSchema } from '@/components/llm-setting-items/next';
import { MessageHistoryWindowSizeFormField } from '@/components/message-history-window-size-item';
import { SelectWithSearch } from '@/components/originui/select-with-search';
import { RAGFlowFormItem } from '@/components/ragflow-form';
import { Button } from '@/components/ui/button';
import {
Form,
@ -15,6 +16,7 @@ import {
FormLabel,
} from '@/components/ui/form';
import { Input, NumberInput } from '@/components/ui/input';
import { Label } from '@/components/ui/label';
import { Separator } from '@/components/ui/separator';
import { Switch } from '@/components/ui/switch';
import { LlmModelType } from '@/constants/knowledge';
@ -26,9 +28,9 @@ import { useTranslation } from 'react-i18next';
import { z } from 'zod';
import {
AgentExceptionMethod,
AgentStructuredOutputField,
NodeHandleId,
VariableType,
initialAgentValues,
} from '../../constant';
import { INextOperatorForm } from '../../interface';
import useGraphStore from '../../store';
@ -71,18 +73,20 @@ const FormSchema = z.object({
exception_default_value: z.string().optional(),
...LargeModelFilterFormSchema,
cite: z.boolean().optional(),
showStructuredOutput: z.boolean().optional(),
[AgentStructuredOutputField]: z.record(z.any()),
});
export type AgentFormSchemaType = z.infer<typeof FormSchema>;
const outputList = buildOutputList(initialAgentValues.outputs);
function AgentForm({ node }: INextOperatorForm) {
const { t } = useTranslation();
const { edges, deleteEdgesBySourceAndSourceHandle } = useGraphStore(
(state) => state,
);
const outputList = buildOutputList(node?.data.form.outputs);
const defaultValues = useValues(node);
const { extraOptions } = useBuildPromptExtraPromptOptions(edges, node?.id);
@ -112,13 +116,18 @@ function AgentForm({ node }: INextOperatorForm) {
name: 'exception_method',
});
const showStructuredOutput = useWatch({
control: form.control,
name: 'showStructuredOutput',
});
const {
initialStructuredOutput,
showStructuredOutputDialog,
structuredOutputDialogVisible,
hideStructuredOutputDialog,
handleStructuredOutputDialogOk,
} = useShowStructuredOutputDialog(node?.id);
} = useShowStructuredOutputDialog(form);
useEffect(() => {
if (exceptionMethod !== AgentExceptionMethod.Goto) {
@ -275,18 +284,42 @@ function AgentForm({ node }: INextOperatorForm) {
)}
</section>
</Collapse>
<Output list={outputList}></Output>
<section className="space-y-2">
<div className="flex justify-between items-center">
{t('flow.structuredOutput.structuredOutput')}
<Button variant={'outline'} onClick={showStructuredOutputDialog}>
{t('flow.structuredOutput.configuration')}
</Button>
</div>
<StructuredOutputPanel
value={initialStructuredOutput}
></StructuredOutputPanel>
</section>
<RAGFlowFormItem name={AgentStructuredOutputField} className="hidden">
<Input></Input>
</RAGFlowFormItem>
<Output list={outputList}>
<RAGFlowFormItem name="showStructuredOutput">
{(field) => (
<div className="flex items-center space-x-2">
<Label htmlFor="airplane-mode">
{t('flow.structuredOutput.structuredOutput')}
</Label>
<Switch
id="airplane-mode"
checked={field.value}
onCheckedChange={field.onChange}
/>
</div>
)}
</RAGFlowFormItem>
</Output>
{showStructuredOutput && (
<section className="space-y-2">
<div className="flex justify-between items-center">
{t('flow.structuredOutput.structuredOutput')}
<Button
variant={'outline'}
onClick={showStructuredOutputDialog}
>
{t('flow.structuredOutput.configuration')}
</Button>
</div>
<StructuredOutputPanel
value={initialStructuredOutput}
></StructuredOutputPanel>
</section>
)}
</FormWrapper>
</Form>
{structuredOutputDialogVisible && (

View file

@ -1,27 +1,25 @@
import { JSONSchema } from '@/components/jsonjoy-builder';
import { AgentStructuredOutputField } from '@/constants/agent';
import { useSetModalState } from '@/hooks/common-hooks';
import { useCallback } from 'react';
import useGraphStore from '../../store';
import { UseFormReturn } from 'react-hook-form';
export function useShowStructuredOutputDialog(nodeId?: string) {
export function useShowStructuredOutputDialog(form: UseFormReturn<any>) {
const {
visible: structuredOutputDialogVisible,
showModal: showStructuredOutputDialog,
hideModal: hideStructuredOutputDialog,
} = useSetModalState();
const { updateNodeForm, getNode } = useGraphStore((state) => state);
const initialStructuredOutput = getNode(nodeId)?.data.form.outputs.structured;
const initialStructuredOutput = form.getValues(AgentStructuredOutputField);
const handleStructuredOutputDialogOk = useCallback(
(values: JSONSchema) => {
// Sync data to canvas
if (nodeId) {
updateNodeForm(nodeId, values, ['outputs', 'structured']);
}
form.setValue(AgentStructuredOutputField, values);
hideStructuredOutputDialog();
},
[hideStructuredOutputDialog, nodeId, updateNodeForm],
[form, hideStructuredOutputDialog],
);
return {

View file

@ -1,6 +1,7 @@
import { omit } from 'lodash';
import { useEffect } from 'react';
import { UseFormReturn, useWatch } from 'react-hook-form';
import { PromptRole } from '../../constant';
import { AgentStructuredOutputField, PromptRole } from '../../constant';
import useGraphStore from '../../store';
export function useWatchFormChange(id?: string, form?: UseFormReturn<any>) {
@ -16,6 +17,20 @@ export function useWatchFormChange(id?: string, form?: UseFormReturn<any>) {
prompts: [{ role: PromptRole.User, content: values.prompts }],
};
if (values.showStructuredOutput) {
nextValues = {
...nextValues,
outputs: {
...values.outputs,
[AgentStructuredOutputField]: values[AgentStructuredOutputField],
},
};
} else {
nextValues = {
...nextValues,
outputs: omit(values.outputs, [AgentStructuredOutputField]),
};
}
updateNodeForm(id, nextValues);
}
}, [form?.formState.isDirty, id, updateNodeForm, values]);

View file

@ -1,6 +1,7 @@
import { RAGFlowFormItem } from '@/components/ragflow-form';
import { Input } from '@/components/ui/input';
import { t } from 'i18next';
import { PropsWithChildren } from 'react';
import { z } from 'zod';
export type OutputType = {
@ -11,7 +12,7 @@ export type OutputType = {
type OutputProps = {
list: Array<OutputType>;
isFormRequired?: boolean;
};
} & PropsWithChildren;
export function transferOutputs(outputs: Record<string, any>) {
return Object.entries(outputs).map(([key, value]) => ({
@ -24,10 +25,16 @@ export const OutputSchema = {
outputs: z.record(z.any()),
};
export function Output({ list, isFormRequired = false }: OutputProps) {
export function Output({
list,
isFormRequired = false,
children,
}: OutputProps) {
return (
<section className="space-y-2">
<div className="text-sm">{t('flow.output')}</div>
<div className="text-sm flex items-center justify-between">
{t('flow.output')} <span>{children}</span>
</div>
<ul>
{list.map((x, idx) => (
<li