5 大场景上手通义灵码企业知识库 RAG

简介: 大家好,我是通义灵码,你的智能编程助手!今天就跟大家分享下企业知识库能帮开发者做些什么。

大家好,我是通义灵码,你的智能编程助手!最近我又升级啦,智能问答功能全面升级至 Qwen2,新版本在各个方面的性能和准确性都得到了显著提升。此外,行间代码补全效果也全面优化,多种编程语言生成性能及准确性大幅提升,如前端、Java、Go、Python、C++ 等。此外,灵码新增代码提交信息(Commit Message)生成,支持 Visual Studio 端。


我还在企业版里还引入了一个超酷的新技能:RAG(Retrieval-Augmented Generation)检索增强生成的能力,今天就跟大家分享下企业知识库能帮开发者做些什么。


可能有些朋友还不太明白这是啥,别急,我来通俗解释一下。想象一下,你有个超级聪明的研发助手,它除了通过大语言模型,记得自己学过海量知识外,还能随时外挂一个更懂你或者企业的“百科全书”知识库。检索增强生成能力能够即时访问、引用深入的知识体系,让我(通义灵码)为你提供更加精准、全面的研发问答和智能编码服务,避免模型幻觉哦~


说完这么多概念,你是不是迫不及待的想试试呢?本期就从通义灵码企业知识库的问答,带你一起感受下。Let's go。


1. 基于知识库的内容,帮你精准回答问题


1.1 新人入职场景


假如你是一位入职新人,我们可以使用通义灵码企业知识库的问答能力,更快速地学习企业编码规范、安全规范、环境准备等。


第一步:需要通义灵码的企业管理员,在通义灵码的知识库管理后台添加相关知识文档。


image.png


第二步:在通义灵码插件端的问答面板上,就可以直接提问咨询了。举例来说,在问答输入框,输入:#team docs 这段代码是否符合代码规范,帮我优化


image.png


这个时候,通义灵码就给你召回相关文档片段(原文档切块后片段),并针对文档的内容进行总结回答。这快准狠的效率是不是比你肉眼查阅、学习快多了。


2. 基于知识库的内容,帮我精准生成代码


2.1 根据组件库文档生成代码


在软件开发,尤其是前端开发中,我们需要从一个产品需求开始,完成具体的产品界面的实现,这个过程,面临将抽象的需求文档,转化为具体、可用的产品界面的挑战。这个过程,不仅需要深刻理解需求,还要熟练掌握所选技术栈的组件库,同时还要确保开发的速度和代码质量。使用通义灵码企业知识库,可以让这个过程事半功倍。


首先,通过上传关键组件库的帮助文档到通义灵码的知识管理中。然后,在遇到具体需求时,在通义灵码问答区域通过 #team docs 调用企业知识库,快速获得咱们自己技术栈的代码建议和示例,加速开发流程。


下面,我们通过一个例子,如何基于企业知识库,快速实现“显示未读消息计数”的需求:


  1. 理解需求:以“显示未读消息数量”为例,识别关键组件为数字显示单元(可能含图标指示)及数据更新逻辑。
  2. 组件选择:在灵码知识库中,查找适用的组件,如 badge 组件,用于高亮显示未读消息数量,利用 Vue 的数据绑定机制实现数据动态更新。
  3. 代码生成:直接在通义灵码中,以自然语言形式表述需求,如:“创建 Element-UI 的 Badge 组件,展示未读消息数量,并随数据变动实时刷新。”通义灵码将理解这个需求,快速生成代码框架,后续做简单调整,以适应设计细节。


第一步:上传文档到知识库


为了丰富你的智能化开发资源库,请登录通义灵码企业管理后台,在“知识管理”区域下点击“文档”,上传关键的前端组件文档。以《Badge.md[1]》为例,此文档聚焦于使用 React,结合自研组件库开发的右上角圆形数字徽章组件,内容全面,包括详细的使用教程、实战代码示例以及 API 接口说明。


备注:请参考示例文档链接以深入了解查阅示例文档 [ 2]


image.png


文档处理与配置:上传完成后,系统将自动处理这些文档,当状态显示为“已完成”,表明你的知识库已经准备就绪,在列表右上角点击“开启检索增强”按钮,即可体验。


image.png

第二步:智能化实现,需求转代码


当通义灵码企业管理员已经提前在灵码企业知识库,上传好前端组件文档后,我们就可以上手了。你可以在 VSCode、JetBrains IDEs、Visual Studio 这些 IDE 上安装通义灵码插件,如未安装,参考文档[3]


我们再看下需求:“显示未读消息数量”,即为消息图标添上计数徽标。


于是,你可以在通义灵码问答面板提问:#team docs 如何给图标添加数字徽标?


备注:必须使用 #team docs 标签确保调用企业内部知识库资源


image.png


提交问题后,通义灵码将迅速根据你的 Badge.md 组件文档,提供精确的代码片段和使用指南,确保代码既符合团队编码规范,又能快速高效实现功能。


以下是通义灵码从文档中提取的一个使用 Badge 组件的例子,它展示了如何在 React 中使用 @teamix/ui 库的 Badge 组件来给图标添加数字徽标:


image.png


第三步:如何应对需求变更


如果你还想继续变更需求,通义灵码也能帮忙。如新需求“只需标记未读而不展示具体数字”,我们就继续基于 #team docs 来提问,输入:#team docs 能否将徽标改为小红点而非数字


通义灵码会立即根据你的新需求和已有的知识库内容,提供 API 调用调整的建议及相应的代码示例,确保你能迅速适应需求变动,保持开发的灵活性和效率。


我们来看看通义灵码给的代码建议与示例:


image.png


2.2 根据接口文档生成示例代码


程度员在开发程序的过程中,需要调用相应的接口,但苦于找不到帮助文档和示例代码,特别是一些内部的非通用的接口实现。使用通义灵码,可以将知识检索增强生成能力,应用到程序员高频使用的 API 调用场景中。


首先,上传接口文档至企业知识库,如,“OpenAI-对话 Chat.md”文档,包含了接口的调用方式、请求参数、返回参数等。这样,通义灵码就懂得了该文档中描述的知识。


接下来,我们可以在通义灵码问答区输入:#team docs 根据openai对话chat请求和响应体生成对应的go语言示例


这时通义灵码就给你召回相关文档片段(原文档切块后片段)。


image.png


根据接口文档,生成示例代码如下:


package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    // OpenAI API endpoint
    apiEndpoint := "https://api.openai.com/v1/chat/completions"

    // API key
    apiKey := "YOUR_API_KEY"

    // Request body
    requestBody := map[string]interface{}{
    "model": "gpt-3.5-turbo",
    "messages": []map[string]interface{}{
    {"role": "user", "content": "Hello!"},
    },
    }

    // Convert request body to JSON
    jsonBody, err := json.Marshal(requestBody)
    if err != nil {
    fmt.Println("Error marshaling request body:", err)
    return
    }

    // Create request
    req, err := http.NewRequest("POST", apiEndpoint, bytes.NewBuffer(jsonBody))
    if err != nil {
    fmt.Println("Error creating request:", err)
    return
    }

    // Set headers
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer "+apiKey)

    // Send request
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
    fmt.Println("Error sending request:", err)
    return
    }
    defer resp.Body.Close()

    // Read response body
    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
    fmt.Println("Error reading response body:", err)
    return
    }

    // Parse response body
    var response map[string]interface{}
    err = json.Unmarshal(body, &response)
    if err != nil {
    fmt.Println("Error parsing response body:", err)
    return
    }

    // Print response
    fmt.Println("Response:")
    fmt.Println(response)
}


根据文档名和接口名清晰的定义,可以从对话中召回对应信息,并根据模型的推理能力生成不同语言的处理方式,以下为使用知识检索增强前后的对比效果,是不是一目了然。


image.png


3. 基于知识库的内容,帮我优化框选代码


3.1 前端老旧工程代码升级场景


前端技术领域发展特别快速,老旧项目的依赖库版本升级,对于维持竞争力也至关重要。当前端团队计划将现有业务代码从 React 15 升级至新版本 16.8 时,通过智能编码工具可以显著加速这一升级过程。以下是通过企业知识库,在通义灵码中,实现老旧工程代码升级的详细步骤。


第一步:构建企业知识库


首先,企业管理者将框架最新版本的编码指南上传至通义灵码企业知识库。比如,这份详尽的表单组件使用说明文档:表单组件文档[4],为接下来的组件框架版本的升级提供权威指导和参考依据。


第二步:识别并准备升级目标代码


手头上恰好有一个基于 React 版本 15 的旧项目,这时,你需识别出待升级的代码片段。例如,一个传统的类组件写法如下:


class Demo extends React.Component {
  handleSubmit= (values, errors) => {
    console.log('value & errors', values, errors);
  };

  render() {
    return (
      <Form style={{ width: '60%' }} {...formItemLayout} colon>
      </Form>
  );
}
}


第三步:智能辅助代码转换


在编辑器里选中以上代码片段,并在灵码的问答面板提出问题:#team docs 转换为符合新规范的React函数式组件写法


image.png


第四步:自动完成代码升级


通义灵码将运用其智能算法,基于 React 的新版函数式编程范式,自动将旧代码重构成更简洁的函数组件。这一过程不仅显著缩短了手动重构的时间,还确保了代码风格与团队最新编码标准的一致性,提升了代码质量和执行效率。


image.png


通过企业知识库检索增强,老旧工程代码的升级过程变得高效且精确,前端团队得以以最小的投入,实现项目从旧框架到新框架的平稳迁移。这样的升级策略确保了代码能够紧跟技术发展趋势,持续保持项目的行业竞争力和技术前沿地位。


3.2 代码规范场景


代码编写好了,如果需要确定是否符合企业或业内编码规范,这时候你就可以上传企业编程规范,例如:


image.png

参考资料


框选同样的代码内容,有检索增强,模型则会以知识库召回的数据作为上下文,进行辅助生成。效率和质量也是立竿见影。


image.png

无检索增强效果


image.png

有检索增强效果


4. 如何开通和使用通义灵码企业知识检索增强?


首先,你必须是通义灵码企业版的用户,现在通义灵码企业标准版有 30 天的免费试用,立即开通和试用[5]

其次,你需要是企业版组织的管理员,即可开通企业知识库管理了,立即开通[6]


最后,开通好后,立即邀请开发者们,在问答区域唤起 #team docs 吧。


相关链接:


[1] Badge.md

[2] 查阅示例文档

[3] 参考文档

[4] 表单组件文档

[5] 立即开通和试用

[6] 立即开通


点击此处,体验通义灵码新能力。

作者介绍
目录