通义灵码提供了扩展管理,支持自定义指令,满足企业编码场景的扩展诉求。
适用版本 | 企业标准版、企业专属版 |
通义灵码管理员、组织内全局管理员(专属版)在通义灵码控制台-扩展管理中,进行自定义指令的管理、查看自定义指令的相关信息和数据。自定义指令可见范围内的开发者,在通义灵码 IDE 插件中使用/
唤起时,即可看到有权限使用的指令。
重要
-
如需使用企业级自定义指令功能,请确保将通义灵码 IDE 插件升级到 V1.4.0;
-
指令启用或修改后,预计需要 5~10 分钟生效,开发者可在通义灵码 IDE 插件中使用。
自定指令管理
查看自定义指令
通义灵码管理员、组织内全局管理员(专属版)进入通义灵码控制台,单击左侧扩展管理模块,即可看到已创建的自定义指令、通义灵码官方指令信息。
单击指令卡片,即可进入指令详情页面,查看指令的基本信息、可见成员范围、对话配置等信息。同时还可以查看指令的使用数据。
创建自定义指令
扩展管理中,单击新建指令,即进入新建自定义指令页面:
第一步:基本信息填写
-
指令名称:指令的显示名称,1~64个字符,中文、英文、数字等均可;
-
指令名称(英文):指令的英文名称,1~64个字符,必须为大小写字母、数字、下划线、空格,此名称为开发者在通义灵码 IDE 插件中问答窗口使用
/
唤起指令时看到的名称,请确保规范性、可读性 -
指令描述:200个字符以内即可,描述指令的使用场景、作用等;
-
指令图标:指令的识别图标,提供了颜色、图标选择,可自由组合;
-
指令可见范围:
-
公开·企业内已授权开发者:选择后,企业内已授权使用通义灵码 IDE 插件的开发者均可使用该指令;
-
私有·仅指令的可见成员可用:选择后,可在指令新建完成后,添加可见成员;
-
第二步:对话配置
-
提示词:5000个字符以内,可输入系统身份提示、要求提示等,如上图中对于做代码命名的提示词设计示意;
-
上下文组装:目前提供了
#userInput
、#selectedCode
的上下文选择,并可进行 Prompt 组装的设计,如上图中对上下文进行组装的示例; -
引入对话历史:开启后,将在触发本指令时,引入当前对话的上下文内容。
设置可用范围
指令新建完成后,可在指令详情页中进行可见范围的配置或修改。
-
当为公开·企业内已授权开发者时,单击查看可前往授权管理页面中查看已授权开发者;
-
当为私有·仅指令的可见成员可用,单击后将打开可见成员管理抽屉,可进行添加、移除可见成员,注意此处仅允许添加授权管理中已授权的开发者。
启用或关闭指令
重要
-
记得一定要启用指令,可用范围内的开发者才可以在通义灵码 IDE 插件中使用
/
唤起指令; -
指令启用后,预计需要 5~10 分钟生效,开发者可在通义灵码 IDE 插件中使用。
指令新建完成后,建议进行测试后再开启比较大范围的使用者,具体可参考:
-
修改指令的可见范围为:私有·仅指令的可见成员可用;
-
添加指令的可见成员,仅添加需要参与测试的开发者即可;
-
打开开启指令的开关;
-
可见范围的开发者在通义灵码 IDE 插件端测试该指令。
当测试完成后,可根据最终需要使用该指令的开发者范围进行可用范围的配置。
当你需要关闭该指令时,单击开关关闭即可,关闭后,开发者在通义灵码 IDE 插件中使用/
唤起指令时,将不可看到该指令。
修改指令信息和配置
在指令详情中,单击右上角修改按钮,即可修改指令的信息。
删除指令
在指令详情中,单击右上角删除按钮,确认后即可删除指令的信息,删除后不可恢复,请谨慎操作。
开发者使用指令
在指令可见范围内的开发者,可在通义灵码 IDE 插件的智能问答窗口中,输入 /
唤起即可。
场景示例
自定义指令配置
指令名称 | API 开发文档自动生成 |
指令名称(英文) | generate api docs |
指令描述 | 在分布式系统、前后端分离架构(SOA模式)中的需求开发都是面向 API 的,所以在 API 开发完成后还要提供与之配套的 API 使用文档,让服务接入方能快速进行开发与联调,本指令可以帮助开发者快速进行 API 开发文档的生成。 |
指令图标 | 选择一个即可 |
指令可见范围 | 根据诉求选择 |
提示词 | 你是一个 Java 专家,有多年的 Java 开发经验,并且是一个文档编写的专家,请按照指定的 Spring MVC 中 RestController 的代码,以及代码内可以获取的注释和你对接口的理解,生成 API 文档。 请按照如下模板生成对应的 API 文档: 标题:接口名 类型:API 的类型(如 GET or POST or PUT)以及 URl 入参:一个表格,第一列参数,第二列类型,第三列说明 出参:一个表格,第一列参数,第二列类型,第三列说明 错误码:一个表格,第一列错误码,第二列错误码说明 |
上下文组装 | 请为如下的代码 |