企业自定义扩展指令使用场景
本文介绍了自定义扩展指令的应用场景,例如代码规范检查、代码变量命名以及API开发文档自动生成等。旨在扩展企业个性化能力宽度,同时简化企业开发者在智能问答的使用复杂度。
关于如何创建并使用自定义指令,具体请参见扩展管理。
场景示例
场景1:代码规范检查
应用场景
传统上,代码在提交后通过扫描工具检测问题,但这种方式滞后且成本高。现在可以通过向模型提供技术和业务背景,以及自定义代码规范细则,来提前进行代码检查,并输出检测结果。以下是一个金融业务场景下的Java代码检查示例。
指令配置
指令名称 | 代码规范检查 |
指令名称(英文) | my code scan |
指令图标 | 任意图标 |
指令描述 | 提前进行代码检查,并输出检测结果。 |
指令可见范围 | 根据诉求选择 |
提示词 |
|
上下文组装 | 请为如下的代码 |
使用效果
场景2:API开发文档自动生成
应用场景
在分布式系统、前后端分离架构( SOA 模式)中的需求开发都是面向API的,所以在API开发完成后还要提供与之配套的API使用文档,让服务接入方能快速进行开发与联调。
指令配置
指令名称 | API开发文档自动生成 |
指令名称(英文) | generate api docs |
指令图标 | 任意图标 |
指令描述 | API开发完成后提供的配套API使用文档。 |
指令可见范围 | 根据诉求选择 |
提示词 |
|
上下文组装 | 请为如下的代码 |
使用效果
场景3:代码变量命名
应用场景
在日常开发过程中,只要编写代码就不可避免要为代码变量取名,一个表述准确、可读性强且符合规范的命名是体现一个开发者专业素养和代码质量的重要方面,它不仅能够提高代码的可维护性和可读性,还能促进团队成员之间的高效协作。
指令配置
指令名称 | 代码变量命名 |
指令名称(英文) | variable naming assistant |
指令图标 | 任意图标 |
指令描述 | 结合公司和团队的代码规范,根据用户的描述来生成合适的变量名。 |
指令可见范围 | 根据诉求选择 |
提示词 |
|
上下文组装 | 使用:通过自定义指令 |
使用效果
指令执行流程
通过自定义扩展指令/
+框选代码片段,触发该指令后的执行流程如下:
获取圈选的代码片段并设置到上下文中,并根据指令类型选择合适的模板和提示词。
通过提示词来让模型进行检查推理,生成符合规范的代码检查建议、API文档或变量命名建议等,并返回给用户。