文档

操作说明

更新时间:
一键部署

您可以根据业务场景的需要,选择官方插件或自定义插件,以增强大语言模型的交互能力。开启插件功能后,大语言模型将根据输入的内容来判断是否调用插件。

插件是应用的一个重要功能,能够增强大语言模型的生成能力,更好地在您的业务场景下落地。我们提供两类插件:官方插件和自定义插件。您可在控制台使用插件来构建应用,也可以通过Assistant API来调用插件

官方插件

阿里云百炼平台提供官方插件,您可直接调用预置的官方插件,对接您的业务系统。

官方插件名称

插件说明

计价方案

图片生成

为通义千问大语言模型提供良好的文生图、图生图的能力。

限时免费,需申请开通

夸克搜索

能够查询公开的网络信息,为大语言模型提供获取实时信息的能力。该插件能力由Quark团队提供。

限时免费,需申请开通

Python代码解释器

为通义千问大语言模型提供执行Python代码的能力,可用于数学计算、数据分析、数据可视化、数据处理等任务。

限时免费

计算器

为通义千问大模型提供良好的计算能力,适用于教育等应用场景。

限时免费

说明

目前,官方插件提供限时免费服务。后续计费方案可能发生变动,请及时关注最新官方通告。如有疑问,请联系阿里云客服团队。

自定义插件

根据业务需求,您可以注册自定义插件,并在应用中使用这些插件。本节简要介绍了自定义插件的配置方式。

创建自定义插件

应用组件中选择插件管理,点击新建自定义插件按钮,进入插件创建页面。

image

填写插件信息

在自定义插件中,编辑插件信息,包括:

  • 插件名称:自定义插件的名称。

  • 插件ID:建议您输入具有语义的英文名称,例如:search、weather等。在您点击“创建完成”后,系统将为您生成全局唯一的插件ID。

  • 插件描述:请使用自然语言描述插件的功能,尽量给出使用示例。例如:“此插件用于获取指定时间和指定地点的天气和温度。例如杭州明天是否下雨”。 API时,请使用系统最终生成的ID。

  • 是否鉴权:当阿里云百炼调用您的自定义插件时是否进行鉴权,系统支持无鉴权、服务级鉴权和用户级鉴权三种方式。

image

说明

您可以在Assistant API中使用该插件ID调用您的自定义插件。

说明

两种鉴权方式的详细说明如下:

  • 服务级鉴权:您的所有终端用户调用时使用相同的Token。

    • 位置:支持将鉴权信息放在Header和Query中。

      • Header:将鉴权信息放在HTTP请求头列表中,这些信息在URL中不可见。

      • Query:将鉴权信息放在URL中,例如https://example.com?api_key=123456。

    • 参数名:您系统鉴权时使用的参数,如“Authorization”。

    • Type:支持basic和bearer两种,区别是basic不会在您提供的token前加任何内容,bearer则会在token前增加“Bearer”,两种type都会放在Authorization字段中。例如:选择bearer,则调用插件时会变成(“Authorization”: “Bearer <YOUR_TOKEN>”)。

    • Token:您的鉴权token。

  • 用户级鉴权:您的终端用户的Token,适用于对每个终端用户进行鉴权。

    • 位置:同服务级鉴权。

    • Type:同服务级鉴权。

填写接口信息

在代码框中定义您的接口信息,支持OpenAPI v3协议,提供对插件接口的描述。关于OpenAPI v3的详细字段,您可以参见:OpenAPI v3.0.3。详细写法请参考:如何定义插件接口协议

以下是系统默认提供的参考示例。

openapi: 3.0.1
info:
    title: 寝室公约查询工具
    description: 寝室公约查询工具,可以根据序号查询特定条目。
    version: "v2"
servers:
    - url: https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run
paths:
    /article:
        post:
            operationId: get_article
            summary: 查询寝室公约第几条,用整数数字
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            required: [article_index]
                            properties:
                                article_index:
                                    type: integer
                                    description: 寝室公约第几条,用整数数字
            responses:
                "200":
                    description: 查询成功
                    content:
                        application/json:
                            schema:
                                type: object
                                required: [article]
                                properties:
                                    article:
                                        type: string
                                        description: 寝室公约条款