点击链接,立即下载通义灵码插件:https://tongyi.aliyun.com/lingma/
安装和登陆指南
兼容 IDE 和系统
本文介绍通义灵码 IDE 插件兼容的 IDE、操作系统等。
JetBrains IDEs
- IDE 版本:IntelliJ IDEA、PyCharm、GoLand、WebStorm、Android Studio 等 2020.3 及以上
- 操作系统:Windows 7 及以上、macOS、Linux
- 暂不支持的系统架构:aarch64 windows
Visual Studio Code
- IDE 版本:1.68.0 及以上
- 操作系统:Windows 7 及以上、macOS、Linux
- 暂不支持的系统架构:aarch64 windows
Visual Studio
- IDE 版本:Visual Studio 2022 17.3.0 及以上,或 Visual Studio 2019 16.3.0 及以上
- 操作系统:Windows 10 及以上
其他场景
- Remote SSH、Docker、WSL 等远程连接开发场景
- VS Code 的 WebIDE,并支持 Open VSX 插件市场中下载和使用
- HUAWEI DevEco Studio,参考 JetBrains IDEs 安装手册-方法 2:下载安装包安装后使用
下载安装指南
通义灵码支持 JetBrains IDEs、Visual Studio Code、Visual Studio,及远程开发场景(Remote SSH、Docker、WSL、Web IDE),安装后登录账号即可开始使用。
JetBrains IDEs 中安装指南
本安装步骤适用于 macOS、Windows 或 Linux 的 JetBrains IDEs 中安装通义灵码。
步骤 1:准备工作
- 操作系统:Windows 7 及以上、macOS、Linux;
- 下载并安装兼容的 JetBrains IDEs 2020.3 及以上版本,通义灵码与以下 IDE 兼容:
- IntelliJ IDEA(旗舰版、社区版、教育版)
- Android Studio
- CLion
- GoLand
- PhpStorm
- PyCharm(专业版、社区版、教育版)
- Rider
- RubyMine
- RustRover
- WebStorm
- ...
更多详细信息,请参阅JetBrains IDE工具查找器。
步骤 2:在 JetBrains IDEs 中安装通义灵码
Tips:以在 IntelliJ IDEA 中安装通义灵码为例。
说明:鉴于很多开发者感兴趣我使用的 IDEA 的主题,分享一下信息:
我使用的 IDEA 的主题是 JetBrains IDEs 的 New UI,需要将 IDEA 升级到最新版哦,打开设置后,在 Appearance & Behavior 中即可看到 New UI 的配置入口。
方法 1:从插件市场安装
- 打开 IntelliJ IDEA 设置窗口,在插件市场中搜索 TONGYI Lingma,找到通义灵码后单击安装。
- 安装完成后,请重启 IntelliJ IDEA。
方法 2:下载安装包安装
- 单击下方链接,下载 JetBrains IDEs 的 zip 安装包;
- 下载完安装包后,打开 IntelliJ IDEA 后,打开设置,在插件管理的设置下拉菜单中单击从本地安装插件,选择下载的 zip 文件后安装。
- 安装完成后,请重启 IntelliJ IDEA。
步骤 3:登录并开启智能编码之旅
- 重启 IntelliJ IDEA 后,单击侧边导航的通义灵码,在通义灵码助手的窗口单击登录按钮。
- 单击登录后,将前往登录页面,完成登录后可进入 IDE 客户端开始使用。登录相关具体操作,可参考:登录通义灵码插件端。
Visual Studio Code 中安装指南
本安装步骤适用于 macOS、Windows 或 Linux 的 Visual Studio Code 中安装通义灵码。
步骤 1:准备工作
- 操作系统:Windows 7 及以上、macOS、Linux;
- 下载并安装 Visual Studio Code 1.68.0 及以上版本。
步骤 2:在 Visual Studio Code 中安装通义灵码
方法 1:从插件市场安装
说明:单击立即安装,唤起 Visual Studio Code 插件市场直接安装,安装后请重启 IDE,即可开启智能编码之旅。
- 打开 Visual Studio Code 扩展窗口,搜索 TONGYI Lingma,找到通义灵码后单击安装。
- 安装完成后,请重启 Visual Studio Code。
方法 2:下载安装包安装
- 单击下方链接,下载 Visual Studio Code 的 VSIX 安装包;
- 下载完安装包后,打开 Visual Studio Code 后,单击扩展,单击更多按钮,在下拉菜单中单击 从 VSIX 安装,选择下载的 VSIX 文件后安装;
- 安装完成后,请重启 Visual Studio Code。
步骤 3:登录并开启智能编码之旅
- 重启 Visual Studio Code 后,单击侧边导航的通义灵码,在通义灵码助手的窗口单击登录按钮。
Tips:如果安装后在侧边导航上找不到通义灵码入口,可鼠标聚焦在侧边导航后右键查看,勾选通义灵码后即可将插件入口配置在侧边导航上。
- 单击登录后,将前往登录页面,完成登录后可进入 IDE 客户端开始使用。登录相关具体操作,可参考:登录通义灵码插件端。
Visual Studio 中安装指南
本安装步骤适用于 Windows 10 及以上操作系统中安装和使用通义灵码。
步骤 1:准备工作
- 操作系统:Windows 10 及以上;
- 下载并安装 Visual Studio 2022 17.3.0 及以上版本,或 Visual Studio 2019 16.3.0 及以上版本
步骤 2:在 Visual Studio 中安装通义灵码
方法 1:从插件市场安装
- 打开 Visual Studio 顶部扩展-管理扩展窗口,搜索 TONGYI Lingma,找到通义灵码后单击安装。
- 安装完成后,请重启 Visual Studio。
方法 2:下载安装包安装
- 单击下方链接,下载 Visual Studio 的 VSIX 安装包;
⇩ TONGYI Lingma - Visual Studio 2022
⇩ TONGYI Lingma - Visual Studio 2019
- 关闭已经打开的 Visual Studio 2022 或 Visual Studio 2019;
- 下载完安装包后,找到该通义灵码的安装包(以 VSIX 为扩展名),双击安装包,按照安装向导操作即可。
步骤 3:登录并开启智能编码之旅
- 重启 Visual Studio 后,单击顶部导航工具
- 单击登录后,将前往登录页面,完成登录后可前往 IDE 客户端开始使用。登录相关具体操作,可参考:登录通义灵码插件端。
个人版登录通义灵码
通义灵码个人版开发者可以使用阿里云账号登录通义灵码 IDE 端插件,本文介绍个人版开发者登录 IDE 端插件的操作指南。
登录通义灵码
步骤 1:准备工作
- 已成功注册阿里云账号,具体操作可参考:账号注册(PC端)。如果你是某阿里云账号下的 RAM 用户,且你所在的阿里云主账号未开通企业标准版,也可以使用通义灵码个人版;
- 已在 JetBrains IDEs、Visual Studio Code、Visual Studio 中安装通义灵码 IDE 插件,具体操作可参考:下载安装指南。
步骤 2:在 IDE 的通义灵码插件登录
说明:如果你的电脑安装多个 IDE 本地客户端,均安装通义灵码的情况,登录状态在多个 IDE 客户端的通义灵码插件中同步,你只需要登录一次即可。
使用阿里云账号登录通义灵码有两种方式:
- 前往阿里云登录页,登录通义灵码(推荐);
- 使用阿里云账号的 AK/SK 登录通义灵码。
方式 1:前往阿里云登录页,登录通义灵码(推荐)
安装完通义灵码插件后,通常情况下,你可以通过 IDE 客户端的插件上的登录按钮前往阿里云登录页完成登录,操作步骤如下:
- 在 IDE 客户端的通义灵码插件中,找到登录按钮,不同 IDE 客户端中位置不一样(如下图所示),操作步骤如下:
- 在 JetBrains IDEs、Visual Studio Code 中,单击通义灵码智能问答窗口中的登录按钮,即可前往阿里云登录页;
- 在 Visual Studio 中,单击顶部导航工具-通义灵码,单击登录按钮,即可前往阿里云登录页;
- 在阿里云登录页面中,完成阿里云登录(RAM 用户可在 RAM 用户登录页面中登录)后,即可看到登录完成的状态,此时即可前往插件端使用。
方式 2:使用阿里云账号的 AK/SK 登录通义灵码
如果遇到无法打开浏览器的阿里云登录页面时,可使用阿里云账号的 AK/SK 登录通义灵码,情况如下:
- 当你进行远程开发时,如使用 Remote SSH、WSL、Docker 的开发环境,可以使用 AK/SK 的方式登录通义灵码;
- 当你使用 Visual Studio Code 的 Web IDE 时,可以使用 AK/SK 的方式登录通义灵码;
- 当你使用基于 Visual Studio Code 的 Web IDE 开源版本构建的 IDE 时,如果 IDE 提供方对接了 Open VSX 时,可以使用 AK/SK 的方式登录通义灵码,直达插件地址:https://open-vsx.org/extension/Alibaba-Cloud/tongyi-lingma;
- 其他无法打开阿里云登录页面的情况。
操作步骤如下:
- 前往阿里云控制台获取 AccessKey,具体操作可参考:创建AccessKey。
- 在插件中输入 AccessKey ID、AccessKey Secret 进行登录,不同 IDE 客户端中操作不一样(如下图所示),操作如下:
- VS Code:在 IDE 中使用快捷键⌘ ⇧ P (CtlShiftP)打开命令面板,搜索 TONGYI Lingma,即可看到使用 AK/SK 登录通义灵码,单击后分步输入 AccessKey ID、AccessKey Secret,选择身份(未加入任何企业时将跳过)单击Enter/Return键,即可完成登录;
- JetBrains IDEs:打开 IDE 的设置页面,找到通义灵码插件设置,在未登录状态即可看到 AK/SK 登录入口,输入 AccessKey ID、AccessKey Secret 后,选择身份(未加入任何企业无需选择),然后单击登录即可;
- 暂不支持在 Visual Studio 中使用 AK/SK 登录。
登出通义灵码
如果需要登出通义灵码,可以分别:
- 在 JetBrains IDEs、Visual Studio Code 中,单击通义灵码智能问答窗口中的用户名旁下拉箭头,单击推登出,即可退出通义灵码登录状态;
- 在 Visual Studio 中,单击顶部导航工具-通义灵码,单击登出按钮,即可退出通义灵码登录状态。
退出后你将:
- 无法使用通义灵码的智能问答、云端大模型生成能力;
- 可继续使用本地离线模型的代码补全、技术文档和代码片段搜索(IntelliJ IDEA)。
企业标准版登录通义灵码
通义灵码企业标准版开发者可以使用阿里云账号登录通义灵码 IDE 端插件,本文介绍企业标准版开发者登录 IDE 端插件的操作指南。
登录通义灵码
步骤 1:准备工作
- 已成功注册阿里云账号,具体操作可参考:账号注册(PC端);
- 已在企业中被授权开发者权限,如为获得权限,可联系企业内的通义灵码管理员添加权限,可参考:授权管理;
- 已在 JetBrains IDEs、Visual Studio Code、Visual Studio 中安装通义灵码 IDE 插件,具体操作可参考:下载安装指南。
步骤 2:在 IDE 的通义灵码插件登录
说明:如果你的电脑安装多个 IDE 本地客户端,均安装通义灵码的情况,登录状态在多个 IDE 客户端的通义灵码插件中同步,你只需要登录一次即可。
使用阿里云账号登录通义灵码有两种方式:
- 前往阿里云登录页,登录通义灵码(推荐);
- 使用阿里云账号的 AK/SK 登录通义灵码。
方式 1:前往阿里云登录页,登录通义灵码(推荐)
安装完通义灵码插件后,通常情况下,可以通过 IDE 客户端的插件上的登录按钮前往阿里云登录页完成登录,操作步骤如下:
- 在 IDE 客户端的通义灵码插件中,找到登录按钮,不同 IDE 客户端中位置不一样(如下图所示),操作步骤如下:
- 在 JetBrains IDEs、Visual Studio Code 中,单击通义灵码智能问答窗口中的登录按钮,即可前往阿里云登录页;
- 在 Visual Studio 中,单击顶部导航工具-通义灵码,单击登录按钮,即可前往阿里云登录页;
- 在阿里云登录页面中,完成阿里云登录(RAM 用户可在 RAM 用户登录页面中登录)后,将根据当前登录账号与企业关系情况不同,可选择不同的身份,情况如下:
- 情况 1:如果当前登录账号为阿里云账号,可选择以个人身份登录或企业内开发者身份登录,此时需选择以企业开发者身份登录;
- 情况 2:如果当前登录账号为 RAM 用户,当你仅加入1个标准版企业且被授予开发者权限时,将默认选择该企业开发者身份并进入下一步;当你加入了多个标准版企业,同时被为多个企业授予开发者权限时,需要选择一个企业开发者身份登录。
- 选择身份后,即可看到登录完成的状态,此时即可前往插件端使用。
方式 2:使用个人访问令牌登录通义灵码(VS Code)
说明:如需使用个人访问令牌登录,请确保将通义灵码 IDE 插件升级到 V1.4.1 及以上;
当使用 VS Code 本地 IDE、WebIDE、远程开发模式(如 Remote SSH、WSL、Docker 的开发环境)时,企业标准版的开发者均可以使用个人访问令牌(Access Token)进行登录。操作步骤如下:
- 前往企业标准版的个人访问令牌管理,直达链接:获取个人访问令牌;
- 创建个人访问令牌,并选择权限为:通义灵码-开发者-只读,新建完成后复制个人访问令牌;
-
打开 VS Code 的命令面板;
-
在命令面板中输入Lingma,选择使用个人访问令牌登录,黏贴第二步复制的个人令牌,单击回车键(Enter 键):
- 如果当前账号仅有一个企业的授权,则单击回车键后即可完成登录;
- 如果当前账号有多个企业已授权使用通义灵码 IDE 插件,则回车键后,单击选择需要使用的企业即可完成登录。
方式三:使用阿里云账号的 AK/SK 登录通义灵码(不推荐)
如果遇到无法打开浏览器的阿里云登录页面时,可使用阿里云账号的 AK/SK 登录通义灵码,操作步骤如下:
- 前往阿里云控制台获取 AccessKey,具体操作可参考:创建AccessKey。
- 在插件中输入 AccessKey ID、AccessKey Secret 进行登录,不同 IDE 客户端中操作不一样(如下图所示),操作如下:
- VS Code:在 IDE 中使用快捷键⌘ ⇧ P (CtlShiftP)打开命令面板,搜索 TONGYI Lingma,即可看到使用 AK/SK 登录通义灵码,单击后分步输入 AccessKey ID、AccessKey Secret、选择身份,单击Enter/Return键,即可完成登录;
- JetBrains IDEs:打开 IDE 的设置页面,找到通义灵码插件设置,在未登录状态即可看到 AK/SK 登录入口,输入 AccessKey ID、AccessKey Secret 后,选择身份,然后单击登录即可;
- 暂不支持在 Visual Studio 中使用 AK/SK 登录。
登出通义灵码
如果需要登出通义灵码,可以分别:
- 在 JetBrains IDEs、Visual Studio Code 中,单击通义灵码智能问答窗口中的用户名旁下拉箭头,单击推登出,即可退出通义灵码登录状态;
- 在 Visual Studio 中,单击顶部导航工具-通义灵码,单击登出按钮,即可退出通义灵码登录状态。
退出后你将:
- 无法使用通义灵码的智能问答、云端大模型生成能力;
- 可继续使用本地离线模型的代码补全、技术文档和代码片段搜索(IntelliJ IDEA)。
企业专属版登录通义灵码
通义灵码企业专属版开发者可以使用专属版的账号登录通义灵码 IDE 端插件,本文介绍企业专属版开发者登录 IDE 端插件的操作指南。
登录通义灵码
步骤 1:准备工作
- 已成功获得通义灵码企业专属版的用户账号,如果尚未获得专属版的用户账号,可联系企业管理员获取;如果企业内已完成用户身份 SSO 配置,可根据企业账号使用方式进行登录;
- 已在企业中被授权通义灵码开发者权限,如为获得权限,可联系企业内的通义灵码管理员添加权限,可参考:授权管理;
- 已在 JetBrains IDEs、Visual Studio Code、Visual Studio 中安装通义灵码 IDE 插件,具体操作可参考:下载安装指南。
- 已获得企业专属版的登录地址。
步骤 2:配置专属版的登录地址
以企业专属版的开发者登录之前,需要先配置专属版的登录地址,操作步骤如下:
- 联系企业管理员,获取专属版的登录地址,企业管理员可登录阿里云控制台,前往阿里云云效控制台,单击左侧导航企业管理,进入专属版企业实例详情页面进行获取;
- 在 IDE 端通义灵码插件中配置专属域地址。
- 在 Visual Studio Code 中,单击侧边导航的通义灵码,在通义灵码助手的窗口单击设置按钮,打开插件设置后,将下方 URL 配置在专属域地址输入框中。 ⚠️ 配置完成后,记得要 重新加载或重启 Visual Studio Code。
在 JetBrains IDEs 中,单击菜单下设置,打开插件设置后,账号处选择专属域账号的方式 ,将下方 URL 配置在专属域地址输入框中。 ⚠️ 配置完成后,记得要 重启 IntelliJ IDEA。
步骤 3:在 IDE 的通义灵码插件登录
完成企业专属版的登录地址配置后,账号登录通义灵码有两种方式:
- 前往通义灵码登录页,登录通义灵码(如果企业已完成用户身份 SSO 配置,可根据企业账号使用方式进行登录);
- 使用企业专属版的个人令牌登录通义灵码。
方式 1: 前往通义灵码登录页登录
安装完通义灵码插件后,通常情况下,你可以通过 IDE 客户端的插件上的登录按钮前往通义灵码登录页完成登录,操作步骤如下:
- 在 IDE 客户端的通义灵码插件中,找到登录按钮,不同 IDE 客户端中位置不一样(如下图所示),操作步骤如下:
- 在 JetBrains IDEs、Visual Studio Code 中,单击通义灵码智能问答窗口中的登录按钮,即可前往通义灵码登录页;
- 在 Visual Studio 中,单击顶部导航工具-通义灵码,单击登录按钮,即可前通义灵码登录页;
- 在通义灵码登录页面中完成登录后,根据当前登录账号与组织关系情况不同决定是否直接登录完成,情况如下:
- 情况 1:如果当前登录账号仅加入了企业内的单个组织,将默认选择该组织的开发者身份并直接登录完成;
- 情况 2:如果当前登录账号仅加入了企业内的多个组织,需要选择一个组织的开发者身份登录。
- 选择身份后,即可看到登录完成的状态,此时即可前往插件端使用。
方式 2: 使用企业专属版账号个人访问令牌登录通义灵码
当你在 Visual Studio Code 远程开发场景中,如使用 Remote SSH、WSL、Docker 的开发环境,可以使用 个人访问令牌登录通义灵码,操作步骤如下:
- 通义灵码助手的智能问答窗口单击登录,将看到填写和获取 个人访问令牌 的入口,单击后前往获取个人访问令牌页面;
- 获取访问令牌:个人访问令牌页面中单击创建访问令牌,输入令牌名称,权限点需选择:基础服务>用户>只读,创建完成后复制访问令牌;
- 在 IDE 上输入访问令牌,单击 Enter 即可。
备注:JetBrains IDEs 中无需使用个人访问令牌的方式,直接本地客户端登录后,前往远程开发场景即可。
登出通义灵码
如果需要登出通义灵码,可以分别:
- 在 JetBrains IDEs、Visual Studio Code 中,单击通义灵码智能问答窗口中的用户名旁下拉箭头,单击推登出,即可退出通义灵码登录状态;
- 在 Visual Studio 中,单击顶部导航工具-通义灵码,单击登出按钮,即可退出通义灵码登录状态。
退出后你将:
- 无法使用通义灵码的智能问答、云端大模型生成能力;
- 可继续使用本地离线模型的代码补全、技术文档和代码片段搜索(IntelliJ IDEA)。
插件使用指南
通义灵码,作为智能编码助手,可以在你进行编码工作时,为你提供行级/函数级实时续写、注释生成代码、单元测试生成、代码优化、注释生成、代码解释、研发智能问答、代码问题修复等辅助编码工作的功能。
说明:在 IDE 环境中使用通义灵码,需要先完成通义灵码插件安装及阿里云账号登录。详细信息可查看下载安装指南。
代码智能补全
行级/函数级实时补全
当你在 IDE 编辑器区进行代码编写时,在开启自动云端生成的模式下,通义灵码会根据当前代码文件及相关代码文件的上下文,自动为你生成行级/函数级的代码建议,此时你可以使用快捷键采纳、废弃,或查看不同的代码建议。
同时,当你在编码的过程中,也可以通过快捷键 ⌥ P 手动触发生成代码建议。
编辑器中代码建议相关操作的快捷键如下:
Tips:不同操作系统的快捷键配置可查看插件配置指南。
自然语言生成代码
在编辑器中,可以直接通过自然语言的方式描述需要实现的需求,通义灵码可以在编辑器中生成代码建议,单击 Tab 可直接采纳。
研发智能问答
使用通义灵码的智能问答时,为了通义灵码与你的对话能够更友好、高效,希望你能够在输入问题时:
- 选中代码,开始输入你的问题,通义灵码将围绕着选中代码与你开展对话;
- 精准表达问题,以及给出相对详细的上下文输入, 比如选中的代码、日志、报错信息等;
- 多多互动,告诉通义灵码,所给出代码建议或回答是否满足你的预期,或生成内容存在的具体瑕疵,通义灵码也会不断改进。
研发自由问答
当你编码遇到问题,缺乏具体解决思路时,可单击 IDE 侧边工具导航或使用⌘ ⇧ L唤起通义灵码智能问答助手,无需离开 IDE 客户端,即可快速获得答案和解决思路。
代码问答
当你对某段代码有疑问或期望针对代码进行一些问题解决时,选中代码后,在智能问答窗口的输入框中输入你的问题,通义灵码将围绕选中代码与你开展对话。
@workspace 本地工程问答
当你需要快速了解一个工程、查找工程内的实现逻辑,或有新的诉求需要进行代码变更时,可以在智能问答窗口中通过 @ 可唤起 @workspace,选中后输入你的问题或诉求,通义灵码可快速结合当前仓库进行工程理解、代码查询、代码问答等,同时可以通过自然语言描述需求,结合当前工程生成简单需求或缺陷的整体修改建议和相关建议代码。
@terminal 问答
当你遇到执行指令不知道如何写,或者不清楚某个指令的意思时,可以在智能问答窗口中通过 @ 可唤起 @terminal,选择后使用自然语言描述你的需要指令诉求,通义灵码将可以生成你需要的命令。生成指令后,你可以一键插入到 teminal 中进行执行或让通义灵码继续解释。当然,你也可以在选择 @terminal 后,输入指令让通义灵码生成指令解释。
#team docs 知识库问答(企业版)
当你需要结合企业内私域知识信息让通义灵码进行回答时,可以在智能问答窗口中通过 # 唤起 #team docs,并输入问题,通义灵码将结合企业知识库(当前用户有权限的知识库)对问题进行回答,在回复中也可以单击查看引用的企业知识库内容。
清空会话上下文历史记忆
当你在会话中是,在智能问答输入框中输入 / 即可看到 /clear context 指令,选择后即可清空当前会话的上下文历史记忆。
新建会话
在智能问答窗口中,单击右上角的新建按钮即可新建会话窗口,单击后会话窗口将回到默认状态。
查看会话历史
历史会话功能帮助你检索和回顾与通义灵码的交流记录,方便针对多次的建议进行对比和选择。不管你在哪个 IDE 客户端上、哪个工程中,均可以查看或搜索你和通义灵码的历史会话。
智能生成指令
指令触发方式
通义灵码提供多处触发单元测试生成、代码解释、生成代码注释、代码优化功能的入口,当你选中的代码后,有 3 种触发方式:
- 在编辑器中,单击右键找到通义灵码功能操作入口,单击对应功能操作;
- 在智能问答中,直接单击对应功能操作;
- 在智能问答中,使用 / 查看快捷指令,单击对应功能操作。
当需要针对一个方法实现生成单元测试、代码注释、代码解释、代码优化时,无需选中代码,可直接单击函数上方的快捷入口触发相关功能操作。
选择指令后输入回答要求
当你选中代码后,并通过在智能问答窗口的输入框输入 / 的方式选中指令后,可以继续输入附加的要求,比如:
- 选择 /generate unit test后,继续输入你对单元测试生成的要求,比如使用 JUnit 5生成;
- 选择 /generate comment后,继续输入生成注释的要求,比如开头标明日期,并用英文注释。
指令一:解释代码
覆盖各种编程语言,选中代码后可自动识别编程语言并生成代码解释。跨越语言的边界,让你阅读代码更高效。
指令二:生成单元测试
支持根据 JUnit、Mockito、Spring Test、unit test、pytest 等框架生成单元测试。
指令三:生成注释
一键生成方法注释及行间注释,节省你写代码注释的时间,并能够有效提升代码可读性。
指令四:代码优化
深度分析代码及其上下文,迅速识别潜在的编码问题,从简单的语法错误到复杂的性能瓶颈,均能够指出问题所在,并提供具体的优化建议代码。
生成回答后快捷操作
针对不同的指令生成回答后,在智能问答区中,可以继续根据诉求进行操作,不同功能的对应操作如下:
-
生成单元测试:
- 采纳单元测试代码建议:支持一键插入、复制、或者新建代码文件,可快速采纳生成的单元测试代码建议;
- 更换单元测试框架:提供基于 JUnit、Mockito、Spring Test、unit test、pytest 等框架生成单元测试代码建议,在回答完成后,可以根据需要切换框架重新生成;
- 新建文件:支持一键保存单元测试代码为新文件,方便进行查看和修改。
-
生成代码优化建议
- 采纳代码优化建议:针对优化建议中的建议代码,支持一键插入、复制,快速采纳生成的建议代码;
- 查看 Diff:单击查看 Diff 按钮,将快速唤起 IDE Diff 查看窗口,快速了解建议和源代码的变更;
-
生成代码注释:
- 采纳代码注释建议:支持一键插入、复制,可快速采纳生成的代码注释建议;
- 查看 Diff:单击查看 Diff 按钮,将快速唤起 IDE Diff 查看窗口,快速了解建议和源代码的变更。
-
解释代码:
- 支持重试、更详细、更简单、中文/英文解释的追问。
问题修复建议
代码问题(Problem)一键修复
当你在编码过程中出现代码问题(Problem)需要进行修复时,通义灵码可以一键给出修复建议,帮你快速修复代码问题。可以通过编辑器中报错图标中下拉菜单中或 Problem 窗口中聚焦到报错信息后右键菜单中,单击通义灵码一键修复菜单,即可生成修复建议和相关建议代码。
异常报错排查(IntelliJ IDEA)
在 IntelliJ IDEA 中,当运行出现异常报错时,在运行标准输出窗口中,即可看到通义灵码的快捷操作按钮,单击后,通义灵码将结合运行代码、异常堆栈等报错上下文,快速给出排查思路或修复建议。
执行报错、编译报错排查(Visual Studio Code)
在 Visual Studio Code 中,当 terminal 中执行指令后报错、编译或运行后有大量报错,需要进行解释或修复时,可以选中报错信息,右键选择使用通义灵码一键解释,也会为你生成相关命令解释及问题解决建议。
提交信息生成
当你有代码变更需要提交,需要写提交信息时,可以通过通义灵码一键生成 Git 提交信息,同时可以在插件设置中配置生成的语言(英文/中文)。
离线单行补全
通义灵码代码补全默认使用云端大模型进行智能续写,当网络情况有限制时,可使用本地补全模式,单击状态栏图标切换至本地补全模式后,编辑器中进行编码时,通义灵码会给出单行的代码建议。
IntelliJ IDEA 中技术文档和代码片段搜索
在 IntelliJ IDEA 客户端内,如果你在编码过程中有需要进行技术资料检索、代码片段搜索时,无须离开 IDE,单击侧边导航的通义灵码,单击搜索,即可开始搜索。
查看帮助和分享反馈
查看使用帮助
通义灵码的智能问答窗口中,可以通过 2 种方式查看使用帮助:
- 通过智能问答的 /help 指令快捷查看使用帮助;
- 单击智能问答窗口的帮助文档入口,可以快速来到当前帮助文档知识库。
反馈回答质量
在智能问答中,你可以对通义灵码所生成的回答内容进行评价,支持点赞和点踩,以不断优化回答效果。
使用问题反馈
当你在使用的过程有任何疑问、优化建议、功能诉求等,均可在通义灵码的智能问答窗口单击提交反馈,即可前往阿里云开发者社区-通义灵码问答专区向我们提出问题。
参与体验调研
为了给你提供更好的智能编码体验,我们也期待收到你的使用体验反馈、优化建议以及你的期待,我们会不断努力和优化产品体验。
插件配置指南
通义灵码支持在 Visual Studio Code、JetBrains IDEs 中修改常用快捷键、进行行间生成的启用/禁用等功能开关配置。
Visual Studio Code 中配置通义灵码
准备工作
如果需要在 Visual Studio Code 中使用通义灵码,必须完成通义灵码插件安装及阿里云账号登录。有关详细信息,可查看下载安装指南。
查看快捷键
重新绑定快捷键
步骤 1:在 Visual Studio Code 的首选项中,单击快捷键的设置入口;
步骤 2:在快捷键管理窗口中,输入 TONGYI Lingma 搜索,单击编辑。在弹出的窗口中输入用于命令的按键,然后单击Enter/Return。
启用或禁用行间生成
可以通过 2 个方法启用或禁用行间生成功能:
方法 1:单击状态栏的通义灵码图标,在弹出的窗口中可快速启用或禁用行间生成功能:
- 可以配置本地离线模型、云端大模型是否启用;
- 开启本地离线模型、云端大模型同时开启的情况下,行间生成时优先推荐云端大模型的代码建议;
方法 2:插件设置页面启用或禁用行间生成,并支持设置生成的长度。
启用或禁用函数的行间快捷入口
通义灵码的智能问答窗口中,单击设置,找到函数的行间快捷入口设置,可以进行启用或禁用该功能。
配置 IDE 原生补全和行间生成的展示规则
打开插件设置页面,可以设置是否同时展示行间自动生成建议和 IDE 原生下拉补全,默认不勾选。
JetBrains IDEs 中配置通义灵码
使用通义灵码时,可以在 JetBrains IDE 中使用默认快捷键使用通义灵码相关功能。同时,你也可以重新修改命令的快捷键。有关在 JetBrains IDE 中重新绑定快捷键的详细信息,可参阅 JetBrains 文档,如可以查看IntelliJ IDEA文档。
准备工作
如果需要在 JetBrains IDE 中使用通义灵码,必须完成通义灵码插件安装及阿里云账号登录。 有关详细信息,可查看下载安装指南。
查看快捷键
重新绑定快捷键
步骤 1:打开 JetBrains IDEs 偏好设置,如下图以 IntelliJ IDEA 为例:
步骤 2:在设置窗口中单击快捷键,输入面板(英文:Panel)后搜索,找到 TONGYI Lingma 快捷键,右键后单击修改键盘快捷键。在弹出的窗口中输入用于命令的按键后,单击确定即可。
启用或禁用行间生成
方法 1:单击状态栏的通义灵码图标,在弹出的窗口中可快速启用或禁用行间生成功能:
- 可以配置本地离线模型、云端大模型是否启用;
- 开启本地离线模型、云端大模型同时开启的情况下,行间生成时优先推荐云端大模型的代码建议;
方法 2:打开插件设置页面,支持启用或禁用行间生成,以及设置生成的长度。
启用或禁用函数的行间快捷入口
打开插件设置页面,支持启用或禁用函数的行间快捷入口。
配置 IDE 原生补全和行间生成的展示规则
打开插件设置页面,可以设置是否同时展示行间自动生成建议和 IDE 原生下拉补全,默认不勾选。
网络代理配置
在公司网络环境下,无法访问公共网络时,可在插件端配置网络代理后使用通义灵码。
配置网络代理
公司网络通常使用 HTTP 代理服务器在网络流量发送到目标位置之前进行拦截,以便检测可疑流量或者限制进入公司内网络的内容。如果你使用的公司网络,你可能需要将通义灵码配置为通过网络代理进行连接。
打开通义灵码的插件设置,即可看到配置网络代理的入口,如下图所示:
- 使用系统全局配置:默认选择为自动获取使用电脑操作系统配置的全局环境变量中的网络代理;
- 手动配置网络代理:选择手动配置后,可在输入框中输入需要配置的网络代理,目前支持 HTTP、HTTPS、Socks5 的网络协议,请确保填写完整的网络代理配置;
- 无需网络代理:选择手动配置后,不填写网络代理 URL 即为不进行任何网络代理。
重要:确保输入完整的网络代理 URL,如:https://127.0.0.xxx:8080。
企业版
企业版快速入门
通义灵码企业版,提供用户管理、授权管理、企业个性化等相关能力,方便企业管理者为开发者统一进行通义灵码使用的授权,以及企业内智能研发的规模化落地。
通义灵码企业版分为 2 个版本:
- 通义灵码企业标准版:提供开箱即用的企业管理服务,支持统一账号和授权管理、统计报表、操作日志等能力,满足企业快速规模化推广、统一授权管理的诉求。
- 通义灵码企业专属版:提供用户管理并支持用户账号集成、统一授权管理、企业知识库问答、企业代码库生成增强等能力,并提供 VPC 部署模式,满足企业安全合规要求及个性化使用场景的需求。
详细版本功能内容,可参考:计费说明。
说明:
本文重点介绍企业标准版快速入门。
前提条件
- 已成功注册阿里云账号,并完成实名认证,具体操作可参考:账号注册(PC端)、个人实名认证或企业实名认证;
- 登录账号为阿里云主账号或其账号下已授权的 RAM 用户(RAM 需包含权限策略AliyunRDCFullAccess),可以创建企业、购买服务等相关操作;
- 登录账号为企业所属的阿里云主账号,可以为已有标准版企业开通通义灵码服务。
说明:阿里云主账号下首次开通通义灵码企业标准版,可享受 30 天免费体验(许可证数 100 个)。
步骤 1:创建企业并开启通义灵码
方式 1:创建新企业开通通义灵码
阿里云主账号或其账号下已授权的 RAM 用户:
- 登录阿里云控制台,前往阿里云云效控制台;
- 单击左侧导航企业管理,在企业管理-标准版企业模块中,单击创建企业;
- 选择通义灵码,单击立即开启;
- 填写企业名称、研发组织规模、所在行业后,单击立即创建,即可进去通义灵码企业版管理控制台。
方式 2:从云效 DevOps 企业直接开通
企业所属的阿里云主账号:
- 登录阿里云控制台,前往阿里云云效控制台;
- 单击左侧导航企业管理,在企业管理-标准版企业模块中,找到需要开通通义灵码服务的企业,单击企业名称,进入企业实例详情页后,在通义灵码服务卡片中单击前往开通;
- 确认企业名称后,单击立即开通后,等待服务开通约3~5秒后,即可进去通义灵码企业版管理控制台。
重要:每个阿里云账号首次开通通义灵码企业标准版,可享受 30 天免费体验:
- 情况1:如果新建企业开通通义灵码企业标准版服务且有 30 天免费体验,进入步骤2;
- 情况2:如果从 DevOps 企业开通通义灵码企业标准版服务且有 30 天免费体验,进入步骤3;
- 情况3:如果新创建或新开通通义灵码企业标准版服务后,需要购买后使用,进入步骤5。
步骤 2:为企业添加成员
通义灵码基于阿里云云效的企业管理服务,当步骤一中创建企业完成后、支持在企业中添加 RAM 用户为企业成员,或通过邀请链接邀请其他阿里云账号用户:
方式一:添加 RAM 用户为成员
前提条件:参照步骤一创建企业完成,并在阿里云RAM用户管理中创建 RAM 用户完成。
- 单击直达企业管理后台:https://devops.aliyun.com/org-admin/;
- 单击成员管理-成员,单击添加成员-邀请企业成员;
- 单击添加 RAM 用户,添加并同步 RAM 用户到企业成员,支持自动同步和手动同步两种方式:
小提示:如果期望能够自动同步用户,建议开启自动同步。
-
自动同步:使用前请根据页面提示完成授权,授权后即可使用自动同步:
- 支持自动同步新增 RAM 用户:在 RAM 控制台创建 RAM 新用户后无需在云效中操作添加,该用户将自动添加至对应企业。
- 支持自动清理已删除 RAM 用户:在 RAM 控制台删除 RAM 用户后,该用户将自动从对应企业中移除,同时立即回收该成员的访问权限。
-
手动同步
- 手动选择添加 RAM 用户:单独选择并添加 RAM 用户,RAM 控制台新增用户不自动加入对应企业。
- 支持自动清理已删除 RAM 用户:在 RAM 控制台删除 RAM 用户后,该用户将自动移除出对应云效企业,同时立即回收该成员的访问权限。
方式二:通过邀请链接添加企业成员
前提条件:参照步骤一创建企业完成。
- 单击直达企业管理后台:https://devops.aliyun.com/org-admin/;
- 单击成员管理-成员,单击添加成员-邀请企业成员;
- 单击通过链接邀请,可以选择:
- 不需要审批,直接加入:点击邀请链接的用户登录云效后可直接加入企业;
- 通过审批,审批通过后加入:点击邀请链接的用户登录云效后,需等待企业管理员审批通过后才可加入企业;
- 单击创建并复制邀请链接后,发送给需要邀请的阿里云账号或 RAM 用户。
步骤 3:为企业成员授权使用通义灵码 IDE 插件
企业拥有者或通义灵码管理员在通义灵码控制台-授权管理中,可从企业成员中添加需要授权的开发者,详细操作可参考:授权管理。
- 单击直达通义灵码控制台授权管理页面,https://devops.aliyun.com/lingma/auth;
- 单击左侧导航授权管理,单击添加开发者,即可在弹窗中添加需要授权的开发者。
步骤 4:企业内开发者登录并使用通义灵码 IDE 插件
- 企业内开发者从各 IDE 插件市场下载通义灵码 IDE 插件,版本更新到最新版(至少 1.2.0 以上),详细操作可参考:下载安装指南;
- 单击通义灵码智能问答窗口中的登录按钮,进入阿里云账号登录页面;
- 登录完成后选择需要的企业开发者身份后(如果只有 1 个企业成员身份时,无需选择),如果当前登录用户有权限即可看到登录成功页面,此时前往 IDE 端可开始使用,详细操作可参考:企业标准版登录通义灵码。
步骤 5:购买通义灵码企业标准版服务
当已开通通义灵码企业标准版服务后,有 2 种情况需要购买通义灵码:
- 开通后,当前企业无 30 天免费体验,需要购买后再进行步骤 3 的授权管理;
- 开通后,当前企业有 30 天免费体验,免费体验期间或即将到期时,需要购买以便开始正式使用通义灵码企业标准版服务;
购买操作步骤:
方式一:从阿里云控制台进入购买页面
阿里云主账号或其账号下已授权的 RAM 用户:
- 登录阿里云控制台,前往阿里云云效控制台;
- 单击左侧导航企业管理,在企业管理-标准版企业模块中,找到需要开通通义灵码服务的企业;
- 单击企业名称进入企业详情页;
- 单击通义灵码服务卡片中的前往购买,即可前往购买页面。
方式二:从通义灵码管理控制台进入购买页面
企业所属的阿里云主账号:
- 前往通义灵码企业标准版控制台;
- 概览页面中,确认清楚企业名称,单击基本信息卡片中的前往购买,即可前往购买页面。
登录通义灵码插件
企业标准版中的企业成员,在给其授权使用通义灵码时,开发者可以在 IDE 端使用通义灵码智能编码助手插件,登录流程可参考:企业标准版登录通义灵码。
企业成员与组织管理
企业标准版,可参考:企业成员与组织
企业专属版,可参考:用户与部门管理
授权管理
企业拥有者、通义灵码管理员可在通义灵码控制台中进行开发者的授权管理,已授权的企业成员可以使用通义灵码 IDE 插件。
重要:使用通义灵码企业版,需要确保开发者将通义灵码 IDE 插件更新到 v1.2.0,前往下载和安装指南。
准备工作
- 在企业管理后台中已经完成企业成员导入,操作详情可参考:企业成员与组织;
- 确认当前登录用户为企业拥有者或通义灵码管理员。
从企业成员添加开发者
企业拥有者或通义灵码管理员在通义灵码控制台-授权管理中,可从企业成员中添加需要授权的开发者。
移除开发者
企业拥有者或通义灵码管理员在授权管理中移除不需要使用通义灵码 IDE 插件的开发者,支持勾选后批量移除相关成员、或单个移除。
知识管理和检索增强
通义灵码提供了基于企业知识库的问答检索增强的能力,在开发者使用通义灵码 IDE 插件时,可以结合企业知识库内上传的文档、文件等内容作为上下文进行回答,使得通义灵码生成的回答更加贴合企业特点。
适用版本:通义灵码企业标准版、通义灵码企业专属版
通义灵码管理员、组织内全局管理员(专属版)可以在通义灵码管理控制台的知识管理中进行知识文档的添加或删除、开启或关闭检索增强功能。
快速了解企业知识库问答实践,立即前往:5 大场景上手通义灵码企业知识库问答。
企业知识库管理
通义灵码管理员、组织内全局管理员(专属版)可以进行企业知识库的管理,包括新建知识库、编辑/删除知识库、添加/移除知识库可见成员、添加或移除知识库内知识文档等。
知识库创建、编辑与删除
新建知识库
- 通过单击侧边栏上的知识管理按钮,进入知识管理页面;
- 在知识管理页面,点击新建知识库按钮;
- 在弹出的创建知识库表单中,输入以下信息:
- 设定应用场景为智能问答;
- 填写知识库名称,建议命名清晰,便于识别;
- (可选)提供一段描述以概述知识库的内容或用途;
- 选择知识库成员的可见范围,默认设置为私有,即仅对知识库成员可见。
- 完成上述信息填写后,点击确定按钮提交;
- 创建成功后,返回知识管理页面,将在知识库列表中看到新建的知识库。
编辑知识库
可通过以下两种方式修改知识库的基本信息,包括知识库的名称、描述与可见范围:
- 从知识管理页面编辑:在知识库列表中选择对应知识库,点击编辑图标,即可进入知识库编辑模式;
- 知识库内页面:进入对应知识库内,点击编辑按钮,进入编辑模式。
删除知识库
进入对应知识库内,点击删除按钮,通过输入知识库名称进行二次确认,可删除该知识库。
重要:知识库删除后不可恢复,如有需要可重新创建知识库并添加数据。
上传文档
通义灵码管理员、组织内全局管理员(专属版)可以进行知识库内知识数据的管理,上传步骤如下:
-
单击添加数据按钮,即可进入添加数据页面;
-
数据类型为文档,单击或拖拽文件到上传区域(灰色区域)即可上传知识库文档,上传文件时需要注意以下要求:
- 一次最多上传 10 个文件;
- 文件格式支持:pdf、docx、txt、markdown、csv(企业专属版);
- 单个文件大小不超过 5MB;
- 文件名称不得超过 200 个字符,文件编码仅支持 utf-8、gbk编码;
- 推荐使用有层级的结构化文档,避免检索信息内容的缺失。
- 上传完成后,单击确认添加即可成功添加,相关文档会进入数据处理流程。
开启或关闭智能问答的检索增强
完成文件的数据处理后,可通过以下两种方式开启或关闭对应知识库的智能问答检索增强功能:
- 知识管理页面:在知识库列表中选择对应知识库,开启检索增强功能开关;
- 知识库内页面:进入对应知识库,开启检索增强功能开关。
开启后,已授权开发者在 IDE 客户端中使用智能问答的功能时,通义灵码将结合开发者可见范围内的知识库数据进行回答。反之,如需关闭检索增强可关闭开关。
知识库可见范围管理
通义灵码管理员、组织内全局管理员(专属版)可以变更企业知识库的可见范围,有以下两种方式:
- 通过编辑知识库,修改知识库的可见范围;
- 进入知识库,点击可见成员标签,添加或移除该知识库可见成员。
说明:当知识库开启检索增强功能后,企业开发者在IDE端使用#team docs功能进行问答时,通义灵码仅会结合该企业开发者可见范围内知识库的知识数据进行回答。
查看文档的数据处理进展
文档上传后,系统将对数据进行向量持久化处理,以将文档处理成可以供用户检索增强的格式,并且可在文档列表中查看数据处理的进展。文档处理的状态分别为:
- 等待处理:系统将有序对上传的文件进行处理,未开始处理的进入排队状态;
- 处理中:正在对文件进行分析和向量化处理;
- 已完成:该文档已完成分析并向量持久化;
- 异常:文档处理出现异常,聚焦在状态标记上可查看原因,此时可结合不同的情况进行重新处理或删除异常文件;
- 重复文件:文件内容重复,不进行重复处理,可删除重复文件;
更新文档
如果文档有更新,可直接通过添加数据的操作上传新的文档,上传后将进行重新处理。
删除文档
处理异常、重复或不再需要的文档,可单击删除操作进行单个文档的删除。如需批量删除,可在文档列表中勾选后进行批量删除。
防火墙配置
在公司网络环境下,可能会采用防火墙或代理服务器等安全措施,可以将以下通义灵码服务相关的 URL 配置到防火墙的白名单中,并打开特定端口,即可允许公司网络环境下使用通义灵码。
标签:指南,插件,通义,单击,登录,IDE,灵码 From: https://www.cnblogs.com/tongyilingma/p/18474164