Code 组件

概述

Code组件是RAGFlow 数据库和代码组件，代码执行组件，在沙箱环境中安全执行Python/JavaScript代码。

主要功能

💻 沙箱代码执行
📊 支持多种配置选项和参数调节
🔧 与其他组件无缝集成
⚡ 高性能处理和错误恢复

适用场景

数据计算和处理
算法验证
动态脚本执行
自定义逻辑实现

参数配置

基础参数

参数名	类型	必填	默认值	说明
`code`	string	是		要执行的代码
`language`	string	否	python	编程语言
`timeout`	number	否	30	执行超时时间

详细说明

主要参数说明

code

类型: string
描述: 要执行的代码
默认值:
是否必填: 是

language

类型: string
描述: 编程语言
默认值: python
是否必填: 否

timeout

类型: number
描述: 执行超时时间
默认值: 30
是否必填: 否

输入输出

输入格式

Code组件接受上游组件的标准输出：

json

{
  "content": "输入内容",
  "component_id": "upstream_component_id",
  "reference": []
}

输出格式

json

{
  "content": "处理后的输出内容",
  "component_id": "code_component_id",
  "metadata": {
    "processing_time": 0.123,
    "success": true
  },
  "reference": []
}

使用示例

示例1: 基础配置

json

{
  "component_name": "Code",
  "params": {
    "code": 
  }
}

示例2: 高级配置

json

{
  "component_name": "Code",
  "params": {
    "code": "",
    "language": "python",
    "timeout": 30
  }
}

前端实现

节点组件

typescript

// web/src/pages/flow/canvas/node/code-node.tsx
export function CodeNode({ id, data, isConnectable, selected }: NodeProps) {
  return (
    <section className={`${styles.ragNode} ${selected ? styles.selectedNode : ''}`}>
      <Handle type="target" position={Position.Left} isConnectable={isConnectable} />
      <Handle type="source" position={Position.Right} isConnectable={isConnectable} />
      
      <NodeHeader id={id} name={data.name} label={data.label} />
      
      <div className={styles.nodeBody}>
        <div className={styles.nodeInfo}>
          <span className={styles.nodeDescription}>代码执行组件，在沙箱环境中安全执行Python/JavaScript代码</span>
        </div>
      </div>
    </section>
  );
}

配置表单

typescript

// web/src/pages/flow/form/code-form/index.tsx
const CodeForm: React.FC<IOperatorForm> = ({ onValuesChange, form }) => {
  return (
    <Form form={form} layout="vertical" onValuesChange={onValuesChange}>

      <Form.Item
        name="code"
        label="要执行的代码"
        rules={[{ required: true, message: '请输入要执行的代码' }]}
      >
        <Input placeholder="请输入要执行的代码" />
      </Form.Item>

      <Form.Item
        name="language"
        label="编程语言"
        rules={[{ required: false, message: '请输入编程语言' }]}
      >
        <Input placeholder="请输入编程语言" />
      </Form.Item>

      <Form.Item
        name="timeout"
        label="执行超时时间"
      >
        <InputNumber style={{ width: '100%' }} placeholder="30" />
      </Form.Item>

    </Form>
  );
};

后端实现

参数类

python

# agent/component/code.py
class CodeParam(ComponentParamBase):
    """
    Code组件参数
    """
    
    def __init__(self):
        super().__init__()
        self.code = ""  # 要执行的代码
        self.language = "python"  # 编程语言
        self.timeout = 30  # 执行超时时间
        
    def check(self):
        """参数验证"""
        # 验证必填参数
        self.check_empty(["code"], "必填参数不能为空")

class Code(ComponentBase):
    """
    Code组件实现
    """
    
    component_name = "Code"
    
    def _run(self, history, **kwargs):
        """
        执行Code组件逻辑
        """
        # 获取输入
        input_df = self.get_input()
        
        if input_df.empty:
            raise ValueError("Code组件需要输入数据")
        
        input_content = input_df.iloc[0]["content"]
        
        # 执行核心处理逻辑
        result = self._process_content(input_content)
        
        # 返回结果
        return pd.DataFrame([{
            "content": result,
            "component_id": self._id,
            "metadata": {
                "processing_time": time.time() - start_time,
                "success": True
            },
            "reference": input_df.iloc[0].get("reference", [])
        }])
    
    def _process_content(self, content):
        """
        处理内容的核心逻辑
        """
        # TODO: 实现具体的处理逻辑
        return f"已处理: {content}"

最佳实践

1. 参数配置建议

根据具体使用场景调整参数
注意参数之间的依赖关系
合理设置超时和重试机制

2. 错误处理

python

def robust_processing(self, content):
    """
    带错误处理的处理方法
    """
    try:
        return self._process_content(content)
    except Exception as e:
        logger.error(f"Code组件处理失败: {str(e)}")
        return f"处理失败: {str(e)}"

3. 性能优化

合理使用缓存机制
优化处理算法
控制资源使用

常见问题

Q1: 组件配置后不生效怎么办？

A: 检查参数格式和必填项是否正确配置。

Q2: 处理大量数据时性能较慢？

A: 可以调整批处理大小或使用异步处理。

Q3: 如何调试组件执行过程？

A: 使用调试模式和日志功能查看详细执行信息。

Code 组件

概述

主要功能

适用场景

参数配置

基础参数

详细说明

主要参数说明

code

language

timeout

输入输出

输入格式

输出格式

使用示例

示例1: 基础配置

示例2: 高级配置

前端实现

节点组件

配置表单

后端实现

参数类

最佳实践

1. 参数配置建议

2. 错误处理

3. 性能优化

常见问题

Q1: 组件配置后不生效怎么办？

Q2: 处理大量数据时性能较慢？

Q3: 如何调试组件执行过程？

相关组件

推荐搭配组件

典型工作流模式

Code 组件 ​

概述 ​

主要功能 ​

适用场景 ​

参数配置 ​

基础参数 ​

详细说明 ​

主要参数说明 ​

code ​

language ​

timeout ​

输入输出 ​

输入格式 ​

输出格式 ​

使用示例 ​

示例1: 基础配置 ​

示例2: 高级配置 ​

前端实现 ​

节点组件 ​

配置表单 ​

后端实现 ​

参数类 ​

最佳实践 ​

1. 参数配置建议 ​

2. 错误处理 ​

3. 性能优化 ​

常见问题 ​

Q1: 组件配置后不生效怎么办？ ​

Q2: 处理大量数据时性能较慢？ ​

Q3: 如何调试组件执行过程？ ​

相关组件 ​

推荐搭配组件 ​

典型工作流模式 ​

Code 组件

概述

主要功能

适用场景

参数配置

基础参数

详细说明

主要参数说明

code

language

timeout

输入输出

输入格式

输出格式

使用示例

示例1: 基础配置

示例2: 高级配置

前端实现

节点组件

配置表单

后端实现

参数类

最佳实践

1. 参数配置建议

2. 错误处理

3. 性能优化

常见问题

Q1: 组件配置后不生效怎么办？

Q2: 处理大量数据时性能较慢？

Q3: 如何调试组件执行过程？

相关组件

推荐搭配组件

典型工作流模式