通义灵码操作指南——企业版
点击链接，立即下载通义灵码插件：https://tongyi.aliyun.com/lingma/
企业版快速入门
通义灵码企业版，提供用户管理、授权管理、企业个性化等相关能力，方便企业管理者为开发者统一进行通义灵码使用的授权，以及企业内智能研发的规模化落地。
通义灵码企业版分为 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 配置到防火墙的白名单中，并打开特定端口，即可允许公司网络环境下使用通义灵码。
