Merge branch 'feat/llm-struct-output' of https://github.com/langgenius/dify into feat/llm-struct-output

web/app/components/workflow/nodes/_base/components/variable/object-child-tree-panel/picker/field.tsx

@@ -8,22 +8,27 @@ import cn from '@/utils/classnames'
 import TreeIndentLine from '../tree-indent-line'
 import { RiMoreFill } from '@remixicon/react'
 import Tooltip from '@/app/components/base/tooltip'
+import type { ValueSelector } from '@/app/components/workflow/types'
 import { useTranslation } from 'react-i18next'
 
 const MAX_DEPTH = 10
 
 type Props = {
+  valueSelector: ValueSelector
   name: string,
   payload: FieldType,
   depth?: number
   readonly?: boolean
+  onSelect?: (valueSelector: ValueSelector) => void
 }
 
 const Field: FC<Props> = ({
+  valueSelector,
   name,
   payload,
   depth = 1,
   readonly,
+  onSelect,
 }) => {
   const { t } = useTranslation()
   const isLastFieldHighlight = readonly
@@ -34,7 +39,10 @@ const Field: FC<Props> = ({
   return (
     <div>
       <Tooltip popupContent={t('app.structOutput.moreFillTip')} disabled={depth !== MAX_DEPTH + 1}>
-        <div className={cn('flex pr-2 items-center justify-between rounded-md', !readonly && 'hover:bg-state-base-hover', depth !== MAX_DEPTH + 1 && 'cursor-pointer')}>
+        <div
+          className={cn('flex pr-2 items-center justify-between rounded-md', !readonly && 'hover:bg-state-base-hover', depth !== MAX_DEPTH + 1 && 'cursor-pointer')}
+          onClick={() => !readonly && onSelect?.([...valueSelector, name])}
+        >
           <div className='grow flex items-stretch'>
             <TreeIndentLine depth={depth} />
             {depth === MAX_DEPTH + 1 ? (
@@ -57,6 +65,8 @@ const Field: FC<Props> = ({
               payload={payload.properties?.[name] as FieldType}
               depth={depth + 1}
               readonly={readonly}
+              valueSelector={[...valueSelector, name]}
+              onSelect={onSelect}
             />
           ))}
         </div>

web/app/components/workflow/nodes/_base/components/variable/object-child-tree-panel/picker/index.tsx

@@ -1,16 +1,19 @@
 'use client'
 import type { FC } from 'react'
-import React from 'react'
-import type { Field as FieldType, StructuredOutput } from '../../../../../llm/types'
+import React, { useRef } from 'react'
+import type { StructuredOutput } from '../../../../../llm/types'
 import Field from './field'
 import cn from '@/utils/classnames'
+import { useHover } from 'ahooks'
+import type { ValueSelector } from '@/app/components/workflow/types'
 
 type Props = {
   className?: string
-  root: { nodeName?: string, attrName: string }
+  root: { nodeId?: string, nodeName?: string, attrName: string }
   payload: StructuredOutput
   readonly?: boolean
-  onSelect?: (field: FieldType) => void
+  onSelect?: (valueSelector: ValueSelector) => void
+  onHovering?: (value: boolean) => void
 }
 
 export const PickerPanelMain: FC<Props> = ({
@@ -18,11 +21,26 @@ export const PickerPanelMain: FC<Props> = ({
   root,
   payload,
   readonly,
+  onHovering,
+  onSelect,
 }) => {
+  const ref = useRef<HTMLDivElement>(null)
+  useHover(ref, {
+    onChange: (hovering) => {
+      if (hovering) {
+        onHovering?.(true)
+      }
+      else {
+        setTimeout(() => {
+          onHovering?.(false)
+        }, 100)
+      }
+    },
+  })
   const schema = payload.schema
   const fieldNames = Object.keys(schema.properties)
   return (
-    <div className={cn(className)}>
+    <div className={cn(className)} ref={ref}>
       {/* Root info */}
       <div className='px-2 py-1 flex justify-between items-center'>
         <div className='flex'>
@@ -43,6 +61,8 @@ export const PickerPanelMain: FC<Props> = ({
           name={name}
           payload={schema.properties[name]}
           readonly={readonly}
+          valueSelector={[root.nodeId!, root.attrName]}
+          onSelect={onSelect}
         />
       ))}
     </div>

web/app/components/workflow/nodes/_base/components/variable/utils.ts

@@ -3,7 +3,7 @@ import { isArray, uniq } from 'lodash-es'
 import type { CodeNodeType } from '../../../code/types'
 import type { EndNodeType } from '../../../end/types'
 import type { AnswerNodeType } from '../../../answer/types'
-import type { LLMNodeType, StructuredOutput } from '../../../llm/types'
+import { type LLMNodeType, type StructuredOutput, Type } from '../../../llm/types'
 import type { KnowledgeRetrievalNodeType } from '../../../knowledge-retrieval/types'
 import type { IfElseNodeType } from '../../../if-else/types'
 import type { TemplateTransformNodeType } from '../../../template-transform/types'
@@ -21,6 +21,7 @@ import type { StartNodeType } from '@/app/components/workflow/nodes/start/types'
 import type { ConversationVariable, EnvironmentVariable, Node, NodeOutPutVar, ValueSelector, Var } from '@/app/components/workflow/types'
 import type { VariableAssignerNodeType } from '@/app/components/workflow/nodes/variable-assigner/types'
 import mockStructData from '@/app/components/workflow/nodes/llm/mock-struct-data'
+import type { Field as StructField } from '@/app/components/workflow/nodes/llm/types'
 
 import {
   HTTP_REQUEST_OUTPUT_STRUCT,
@@ -56,23 +57,72 @@ const inputVarTypeToVarType = (type: InputVarType): VarType => {
   } as any)[type] || VarType.string
 }
 
+const structTypeToVarType = (type: Type): VarType => {
+  return ({
+    [Type.string]: VarType.string,
+    [Type.number]: VarType.number,
+    [Type.boolean]: VarType.boolean,
+    [Type.object]: VarType.object,
+    [Type.array]: VarType.array,
+  } as any)[type] || VarType.string
+}
+
+const findExceptVarInStructuredProperties = (properties: Record<string, StructField>, filterVar: (payload: Var, selector: ValueSelector) => boolean): Record<string, StructField> => {
+  const res = produce(properties, (draft) => {
+    Object.keys(properties).forEach((key) => {
+      const item = properties[key]
+      const isObj = item.type === Type.object
+      if (!isObj && !filterVar({
+        variable: key,
+        type: structTypeToVarType(item.type),
+      }, [key])) {
+        delete properties[key]
+        return
+      }
+      if (item.type === Type.object && item.properties)
+        item.properties = findExceptVarInStructuredProperties(item.properties, filterVar)
+    })
+    return draft
+  })
+  return res
+}
+
+const findExceptVarInStructuredOutput = (structuredOutput: StructuredOutput, filterVar: (payload: Var, selector: ValueSelector) => boolean): StructuredOutput => {
+  const res = produce(structuredOutput, (draft) => {
+    const properties = draft.schema.properties
+    Object.keys(properties).forEach((key) => {
+      const item = properties[key]
+      const isObj = item.type === Type.object
+      if (!isObj && !filterVar({
+        variable: key,
+        type: structTypeToVarType(item.type),
+      }, [key])) {
+        delete properties[key]
+        return
+      }
+      if (item.type === Type.object && item.properties)
+        item.properties = findExceptVarInStructuredProperties(item.properties, filterVar)
+    })
+    return draft
+  })
+  return res
+}
+
 const findExceptVarInObject = (obj: any, filterVar: (payload: Var, selector: ValueSelector) => boolean, value_selector: ValueSelector, isFile?: boolean): Var => {
   const { children } = obj
+  const isStructuredOutput = !!(children as StructuredOutput)?.schema?.properties
+
   const res: Var = {
     variable: obj.variable,
     type: isFile ? VarType.file : VarType.object,
-    children: children.length > 0 ? children.filter((item: Var) => {
+    children: isStructuredOutput ? findExceptVarInStructuredOutput(children, filterVar) : children.filter((item: Var) => {
       const { children } = item
-      const isStructuredOutput = !!(children as StructuredOutput)?.schema
-      if (!isStructuredOutput) {
-        const currSelector = [...value_selector, item.variable]
-        if (!children)
-          return filterVar(item, currSelector)
-        const obj = findExceptVarInObject(item, filterVar, currSelector, false) // File doesn't contains file children
-        return obj.children && (obj.children as Var[])?.length > 0
-      }
-      return true // TODO: handle structured output
-    }) : (children || []),
+      const currSelector = [...value_selector, item.variable]
+      if (!children)
+        return filterVar(item, currSelector)
+      const obj = findExceptVarInObject(item, filterVar, currSelector, false) // File doesn't contains file children
+      return obj.children && (obj.children as Var[])?.length > 0
+    }),
   }
   return res
 }
@@ -440,8 +490,8 @@ const formatItem = (
     return findExceptVarInObject(isFile ? { ...v, children } : v, filterVar, selector, isFile)
   })
 
-  if (res.nodeId === 'llm')
-    console.log(res)
+  // if (res.nodeId === 'llm')
+  //   console.log(res)
 
   return res
 }
@@ -1103,18 +1153,26 @@ export const updateNodeVars = (oldNode: Node, oldVarSelector: ValueSelector, new
   })
   return newNode
 }
+
 const varToValueSelectorList = (v: Var, parentValueSelector: ValueSelector, res: ValueSelector[]) => {
   if (!v.variable)
     return
 
   res.push([...parentValueSelector, v.variable])
-  if (v.children) {
-    if ((v.children as Var[])?.length > 0) {
-      (v.children as Var[]).forEach((child) => {
-        varToValueSelectorList(child, [...parentValueSelector, v.variable], res)
-      })
-    }
-    // TODO: handle structured output
+  const isStructuredOutput = !!(v.children as StructuredOutput)?.schema?.properties
+
+  if ((v.children as Var[])?.length > 0) {
+    (v.children as Var[]).forEach((child) => {
+      varToValueSelectorList(child, [...parentValueSelector, v.variable], res)
+    })
+  }
+  if (isStructuredOutput) {
+    Object.keys((v.children as StructuredOutput)?.schema?.properties || {}).forEach((key) => {
+      varToValueSelectorList({
+        variable: key,
+        type: structTypeToVarType((v.children as StructuredOutput)?.schema?.properties[key].type),
+      }, [...parentValueSelector, v.variable], res)
+    })
   }
 }
 
@@ -1149,7 +1207,15 @@ export const getNodeOutputVars = (node: Node, isChatMode: boolean): ValueSelecto
     }
 
     case BlockEnum.LLM: {
-      varsToValueSelectorList(LLM_OUTPUT_STRUCT, [id], res)
+      varsToValueSelectorList([
+        ...LLM_OUTPUT_STRUCT,
+        {
+          variable: 'structured_output',
+          type: VarType.object,
+          children: mockStructData,
+        },
+      ], [id], res)
+      console.log(res)
       break
     }
 

web/app/components/workflow/nodes/_base/components/variable/var-reference-vars.tsx

@@ -67,7 +67,7 @@ const Item: FC<ItemProps> = ({
         setIsItemHovering(true)
       }
       else {
-        if (isObj) {
+        if (isObj || isStructureOutput) {
           setTimeout(() => {
             setIsItemHovering(false)
           }, 100)
@@ -107,8 +107,8 @@ const Item: FC<ItemProps> = ({
         <div
           ref={itemRef}
           className={cn(
-            isObj ? ' pr-1' : 'pr-[18px]',
-            isHovering && (isObj ? 'bg-primary-50' : 'bg-state-base-hover'),
+            (isObj || isStructureOutput) ? ' pr-1' : 'pr-[18px]',
+            isHovering && ((isObj || isStructureOutput) ? 'bg-primary-50' : 'bg-state-base-hover'),
             'relative w-full flex items-center h-6 pl-3  rounded-md cursor-pointer')
           }
           onClick={handleChosen}
@@ -137,7 +137,14 @@ const Item: FC<ItemProps> = ({
         zIndex: 100,
       }}>
         {isStructureOutput && (
-          <PickerStructurePanel root={{ attrName: itemData.variable }} payload={itemData.children as StructuredOutput} />
+          <PickerStructurePanel
+            root={{ nodeId, nodeName: title, attrName: itemData.variable }}
+            payload={itemData.children as StructuredOutput}
+            onHovering={setIsChildrenHovering}
+            onSelect={(valueSelector) => {
+              onChange(valueSelector, itemData)
+            }}
+          />
         )}
         {(isObj && !isFile) && (
           // eslint-disable-next-line ts/no-use-before-define