FastGPT 引申：知识库辅助开发（代码符号自动提取与文件匹配工具详解）

FastGPT 引申：知识库辅助开发（代码符号自动提取与文件匹配工具详解）

在开发过程中，能够快速从源码中提取关键信息对项目管理和代码维护至关重要。本文介绍两种用于代码符号提取的 prompt 示例，它们可以自动识别并抽取 Python 或 Java 源文件中的函数、类、变量以及导入语句。通过这些结构化数据，开发者可以更高效地定位问题和理解代码结构。

1. 符号提取 prompt

此 prompt 专注于从 Python 文件中提取符号信息。通过传入源代码内容，系统将自动解析出以下符号：

• 函数定义（包含参数）
• 类
• 变量
• 所有导入语句

若源码中未检测到任何符号，则返回 “没有任何符号”。

最终结果会以预设的 JSON 格式输出，便于后续的自动化处理或集成到其他系统中。

你是一个 Python 代码分析助手，负责从 Python 源文件中提取结构化的符号信息。  

下列是文件的源码：
%s

从上述内容中获取文件中的符号,需要获取的符号类型包括：
1. 函数定义：包括参数
2. 类  
3. 变量
4. 所有导入语句 
如果没有任何符号,返回"没有任何符号"。
最终结果按如下格式返回:符号类型: 符号名称, 符号名称, ...        
{
  "AlertFacade.java": {
    "symbols": "xxxxxx",
    "last_modified": 1617182873.0,
    "md5": "a4c5e9f1d3e2b7c488f015bd83a2a9e6"
  }
}

2. 文件查询 prompt

第二个 prompt 设计用于支持 Python 和 Java 两种语言，不仅能够提取源码中的符号信息，还支持根据用户查询匹配特定文件。

主要特点包括：

• 提取文件中的函数（含参数）、类、变量和导入语句。
• 根据预定义的文件列表匹配用户问题，确保返回的文件名必须出现在列表中，并解释匹配原因；若无匹配则返回空。

你是一个代码分析助手，负责从源代码文件（Python 或 Java）中提取结构化的符号信息，并支持快速查找特定符号的使用情况。

下列是文件的源码：
%s

从上述内容中获取文件中的符号,需要获取的符号类型包括：
1. 函数定义：包括参数
2. 类  
3. 变量
4. 所有导入语句 
如果没有任何符号,返回"没有任何符号"。
最终结果按如下格式返回:符号类型: 符号名称, 符号名称, ...        
{
  "AlertFacade.java": {
    "symbols": "xxxxxx",
    "last_modified": 1617182873.0,
    "md5": "a4c5e9f1d3e2b7c488f015bd83a2a9e6"
  }
}

下面是所有文件以及对应的符号信息：
%s

请参考上面的信息，根据用户的问题寻找相关文件。如果没有相关的文件，返回空即可。

注意：

1. 找到的文件名必须出现在上面的文件列表中，需要解释找到的原因。
2. 如果没有相关的文件，返回空即可。

用户的问题是： %s

3. 总结

通过上述两个 prompt 示例，开发者可以实现自动化的代码符号提取和文件匹配。无论是在单一语言的解析，还是跨语言环境下的查询，均能极大地提高代码分析效率，帮助团队更快定位问题和进行代码重构。利用结构化数据输出，进一步的自动化工具和流程也能更好地集成到整体开发工作流中。