SDK介绍
更新时间：2024-11-15
一、介绍
百度智能云千帆AppBuilder平台提供了AppBuilder-SDK，开发者可使用SDK，快捷的开发功能，提升开发效率。AppBuilder-SDK提供了完整的AI原生应用开发套件，包括丰富的开发组件和应用示例代码。开发组件包括大模型组件、AI能力组件、基础云组件和软硬一体组件，满足各类高灵活度定制开发需求；应用示例代码提供了丰富灵活的应用框架最佳实践，基于业内主流大模型应用框架搭建，包含如支持知识增强的应用框架（RAG）、文本生成应用框架、具备思维链及工具使用能力的框架、生成式数据分析框架等。
二、开源说明
AppBuilder-SDK已开源，欢迎广大开发者加入交流，详见AppBuilder-SDK开源说明。
三、语言及版本
AppBuilder-SDK目前提供了 Python（Python版本>=3.9)、Java (Java版本>=8)、Go (Go版本>=1.18.1)等语言的SDK。AppBuilder-SDK对其他语言的支持将陆续上线。
四、使用说明
AppBuilder-SDK提供了完整的AI原生应用开发套件，支持调用console端已发布应用和直接调用工具组件。
4.1调用console端已发布应用
| 功能点 | 功能简介 | 查看详情 |
|---|---|---|
| 应用调用 | 在百度智能云千帆AppBuilder官网创建并发布应用后，通过SDK调用应用。 | 查看详情 |
| 知识库修改 | 通过SDK实现创建知识库、添加知识文档、查询知识库文档、删除知识文档等操作。 | 查看详情 |
| 千帆模型列表获取 | 获取用户可用的不同类型的千帆大模型名称。 | 查看详情 |
4.2直接调用工具组件
- 步骤1：安装SDK
- 步骤2：获取密钥
- 步骤3：开通组件服务
- 步骤4：调用组件
1、安装SDK
执行如下命令，快速安装Python语言的最新版本AppBuilder-SDK，支持 Python >= 3.9版本。
pip install --upgrade appbuilder-sdk2、获取密钥
前往API密钥，点击【新增密钥】按钮创建密钥，可自定义备注，支持一键复制操作。
- 密钥为使用AppBuilder平台的重要凭证，用于AppBuilder-SDK开发，支持调用全部组件。因密钥长期有效，请勿放在浏览器或外部客户端代码中，请妥善管理分发。如意外泄露，在本页面删除密钥即可关闭对应访问入口。
- 删除密钥后，已删除密钥和旧地址将无法继续请求服务，并无法恢复，请谨慎操作。
3、开通组件服务
在调用AppBuilder-SDK服务前，需开通组件服务。领取免费额度
| 组件名称 | 组件描述 | 接口文档 | 购买入口及配额查看 |
|---|---|---|---|
| 多轮改写 | 多轮改写组件（QueryRewrite）是一款用于处理多轮对话和查询改写的组件。它主要用于理解和优化用户与机器人的交互过程，进行指代消解及省略补全。该组件支持不同的改写类型，可根据对话历史生成更准确的用户查询。 | 查看详细说明 | 点击进入 |
| 相似问生成 | 相似问生成组件（SimilarQuestion）可以基于输入的问题，挖掘出与该问题相关的类似问题。广泛用于客服、问答等场景。 | 查看详细说明 | 点击进入 |
| 自然语言转pandas | 自然语言转pandas组件（Nl2pandas）可以通过理解对表格信息的提问，生成对应语义的可执行Python代码，主要使用Pandas库。它可以用于基于表格的查询，问答等多种场景。 | 查看详细说明 | 点击进入 |
| 标签抽取 | 标签抽取组件（TagExtraction）是一款高效的标签抽取组件，基于生成式大模型，专门用于从文本中提取关键标签。它适用于各种文本分析场景，如内容分类、关键词提取等。 | 查看详细说明 | 点击进入 |
| 会话小结 | 会话小结组件（DialogSummary）可以基于生成式大模型对一段用户与坐席的对话生成总结，结果按{"诉求": "", "回应": "", "解决情况": ""}格式输出。适用于运营商、金融、汽车等多种场景的对话总结。 | 查看详细说明 | 点击进入 |
| 口语化Query生成 | 口语化Query生成组件（OralQueryGeneration）可以基于输入文本生成与文档内容相关的Query。可用于增强文档索引等场景。 | 查看详细说明 | 点击进入 |
| 复杂Query分解 | 复杂Query分解组件（QueryDecomposition）可以将已经确定为复杂问题的原始问题拆解为一个个简单问题。广泛应用在知识问答场景。 | 查看详细说明 | 点击进入 |
| 复杂Query判定 | 复杂Query判定组件（IsComplexQuery）可以根据输入的提问进行初步的分类，区分简单问题和复杂问题，以便后续运用不同的处理流程处理。可应用于知识问答场景。 | 查看详细说明 | 点击进入 |
| 风格转写 | 风格转写组件（StyleRewrite） 可以基于生成式大模型对文本的风格进行改写。支持多种文本风格，包括营销、客服、直播、激励及教学话术。 | 查看详细说明 | 点击进入 |
| 风格写作 | 风格写作组件（StyleWriting）是一款基于生成式大模型进行文本创作的工具，支持多种风格，包括B站、小红书等，适用于编写文案、广告等多种场景。 | 查看详细说明 | 点击进入 |
| 问答对挖掘 | 问答对挖掘（QAPairMining）可以基于输入文本内容，快速生成多个问题及对应答案，极大提高信息提炼的效率和准确性。广泛用于在线客服、智能问答等领域。 | 查看详细说明 | 点击进入 |
| 阅读理解问答 | 阅读理解问答（MRC）组件是基于生成式大模型的阅读理解问答系统。该组件支持拒答、澄清、重点强调、友好性提升、溯源等多种功能，可用于回答用户提出的问题。 | 查看详细说明 | 点击进入 |
| 空应用 | 空应用（Playground）是一款灵活的组件，允许用户自定义prompt模板并执行。它适用于各种场景，特别是在需要自定义输入模板和使用预训练模型进行交互的情况下。 | 查看详细说明 | 点击进入 |
| GBI 选表 | GBI 选表，根据提供的多个 MySql 表名 以及 表名对应的描述信息，通过query 选择一个或多个最合适的表来回答该query。一般的试用场景是，当有数据库有多个表的时候，但是实际只有1个表能回答该query，那么，通过该能力将该表选择出来，用于后面的 问表环节。 | 查看详细说明 | 点击进入 |
| GBI 问表 | GBI 问表，根据提供的 mysql 表的 schema 信息，生成对应问题的 sql 语句。 | 查看详细说明 | 点击进入 |
| 文本翻译-通用版 | 文本翻译组件（Translation）提供多种语言互译的在线文本翻译服务。支持术语定制功能，用户可对翻译结果进行干预，快速提高翻译质量。可广泛应用于移动端、PC网站、智能硬件等不同产品形态中，满足多领域、多场景的翻译需求。 | 查看详细说明 | 点击进入 |
| 文生图 | 文生图（AI作画-高级版）（Text2Image）基于文心大模型，可以根据用户输入的文本，自动创作不限定风格的图，为内容创作者提供灵感和高质量配图。 | 查看详细说明 | 点击进入 |
| 通用物体和场景识别-高级版 | 通用物体和场景识别组件（ObjectRecognition）可以识别超过10万类常见物体和场景，接口返回大类及细分类的名称。广泛适用于图像或视频内容分析、拍照识图等业务场景 | 查看详细说明 | 点击进入 |
| 通用文字识别-高精度版 | 通用文字识别组件（GeneralOCR）支持多场景、多语种、高精度的文字识别服务，对图片全部文字内容进行检测识别。 | 查看详细说明 | 点击进入 |
| 菜品识别 | 菜品识别组件（DishRecognition）可以识别超过9千种菜品，可准确识别图片中的菜品名称、卡路里，适用于多种客户识别菜品的业务场景中。 | 查看详细说明 | 点击进入 |
| 地标识别 | 地标识别组件（LandmarkRecognition）可以识别12万中外著名地标、热门景点，可返回地标名称。 | 查看详细说明 | 点击进入 |
| 短语音识别-极速版 | 短语音识别（ASR）可以将音频流实时识别为文字，并返回每句话的开始和结束时间，适用于手机语音输入、语音搜索、人机对话等语音交互场景。 | 查看详细说明 | 点击进入 |
| 短文本在线合成 | 短文本在线合成（TTS）提供高度拟人、流畅自然的语音合成服务，将文本朗读出来，精品音库听感更逼真。 | 查看详细说明 | 点击进入 |
| 文档解析 | 文档解析组件（DocParser）可以用于文档内容解析，支持PDF、JPG、DOC、TXT、XLS、PPT等17种文档格式，可解析出文档版式、位置坐标、表格结构等内容。 | 查看详细说明 | 免费使用 |
| 文档切分 | 文档切分组件（DocSplitter）可以用于对文档进行段落切分。支持将文档划分为多个段落，便于后续处理和分析。 | 查看详细说明 | 免费使用 |
| 语义匹配 | 语义匹配组件（Matching）可以计算query与文本列表之间的相似度关系，并根据其进行排序。 | 查看详细说明 | 点击进入 |
| 向量计算 | 向量计算组件（Embedding）支持将文本转化为用数值表示的向量形式，用于文本检索、信息推荐、知识挖掘等场景。 | 查看详细说明 | 点击进入 |
| 表格抽取 | 表格抽取组件（ExtractTableFromDoc）是用于文档表格处理的组件，从文档中抽取表格。支持对文档表格大小进行限制，限制后自动进行拆分、跨页合并等处理；支持合并表格上文，提取的表格为Markdown格式。 | 查看详细说明 | 免费使用 |
| 百度Elasticsearch | 百度Elasticsearch组件（BES）可以提供高性能、灵活扩展的向量与标量混合存储检索服务，支持多种索引类型和相似度计算方法，帮助提升召回率和检索效率，仅支持V7.x版本。 | 查看详细说明 | 点击进入 |
| 向量检索-BES | 向量检索-BES组件（BaiduElasticSearchRetriever）基于一款Baidu ElasticSearch的内容检索组件，支持根据文本的向量的相似度进行内容检索。 | 查看详细说明 | 点击进入 |
| Excel转图表 | Excel转图表（Excel2Figure）组件通过理解对表格信息的提问，生成对应语义的图表。 | 查看详细说明 | 点击进入 |
| 动物识别 | 动物识别 (AnimalRecognition) 可用于识别一张图片，即对于输入的一张图片（可正常解码，且长宽比较合适），输出动物识别结果。 | 查看详细说明 | 点击进入 |
| 植物识别 | 植物识别（PlantRecognition），即对于输入的一张图片（可正常解码，且长宽比较合适），输出植物识别结果。 | 查看详细说明 | 点击进入 |
| 表格文字识别 | 表格文字识别 (TableOCR) 可支持识别图片中的表格内容，返回各表格的表头表尾内容、单元格文字内容及其行列位置信息，全面覆盖各类表格样式，包括常规有线表格、无线表格、含合并单元格表格。同时，支持多表格内容识别。 | 查看详细说明 | 点击进入 |
| 手写文字识别 | 手写文字识别 （HandwriteOCR），图片中的手写中文、手写数字进行检测和识别，针对不规则的手写字体进行专项优化，识别准确率可达90%以上。 | 查看详细说明 | 点击进入 |
| 二维码识别 | 二维码识别 (QRcodeOCR) 可对图片中的二维码、条形码进行检测和识别，返回存储的文字信息及其位置信息。 | 查看详细说明 | 点击进入 |
| 身份证混贴识别 | 身份证混贴识别（MixCardOCR），身份证混贴识别支持自动检测与识别身份证正反面在同一张图片上的场景，一次识别图片中身份证正反面所有字段。 | 查看详细说明 | 点击进入 |
| 文档矫正增强 | 文档矫正增强 (DocEnhance) 可对图片中的文件、卡证、票据等内容进行四角点检测定位，提取主体内容并对其进行矫正，同时可选图片增强效果进一步提升图片清晰度，达到主体检测矫正并增强的目的，提升图片整体质量。 | 查看详细说明 | 点击进入 |
| 文档格式转换 | 文档格式转换 (DocFormatConverter)：识别文档内文字及版面布局，可将多种类型的版式文档转换为流式文档。 | 查看详细说明 | 点击进入 |
| 图像内容理解 | 图像内容理解 （ImageUnderstand），输出理解图片后的文本信息。 | 查看详细说明 | 公测阶段，仅支持领取免费额度 试用，暂不支持购买 |
| 向量检索-VectorDB | 向量检索-VectorDB（BaiduVectorDBRetriever）基于一款百度向量数据库的内容检索组件，支持根据文本的向量的相似度进行内容检索。 | 查看详细说明 | 点击进入 |
| 幻觉检测 | 幻觉检测（Hallucination Detection）针对问答场景，检测答案中是否存在幻觉。 | 查看详细说明 | 点击进入 |
4、调用组件
根据每个组件提供的接口文档进行API调用。