API插件配置

前提条件

在大模型场景中调用API能力，需要提前开通函数计算服务并且在函数计算服务中创建对应的服务，若业务需求需要使用自有API也必须使用阿里云的函数计算，在函数计算中再调用自有的API。

功能入口

进入智能外呼机器人实例后，选择大模型场景管理，进入全局配置中，点击选择API插件。

功能说明

新建API插件

进入API插件页面后，选择左上角新建API插件按钮，并且进行配置。

新建AP插件I的具体参数如下：

• 服务名称：自定义插件名称，最多可填入50个字。

• 服务描述：描述API插件的用途，提升模型识别效果。

• API调用时间较长时，用户对话窗提示：即为API调用前播报话术，在API结果返回前，会先播报该话术，减少用户等待时间。

• API配置：支持通过使用函数计算方式或者HTTP服务进行调用。

  • 函数计算方式：

    • 进入函数计算服务找到需要配置到大模型场景中的函数服务，将其对应参数填入。

      • 函数计算方式

      • Region：选择对应函数计算的地域。

      • 函数名称：填入函数计算中对应的函数名称。

      • 备用Region：选择对应的备用Region。

  • HTTP方式：则需要填写请求方式和接口url。

  • 输入参数：填写调用API插件所需参数，参数可通过变量上传或模型对话产生。

    • 当输入参数的取值来源选择为变量，则字段值需要与已配置的变量名称保持一致，否则会报错提示。

      说明

      注意：API插件中所用的参数与类型需与函数计算中的参数或HTTP服务的请求参数类型保持一致。

  • 输出参数：直接返回API结果，并且作为提示词输入给模型。

  • 签名认证：当选择HTTP服务时，可支持保证服务的安全使用，相关使用教程可参考签名计算使用指引

相关信息配置完成后点击确认即可。

发布API插件

在刚刚新建API插件或者刚刚修改API插件后，此时API插件状态为草稿或者已编辑状态，无法在场景中使用最新的API插件，需要点击发布按钮，即可完成发布，并可以在Prompt中调用。

编辑API插件

若需要对已存在的插件进行修改，可以通过点击操作菜单中的编辑按钮对API插件进行编辑。

• 若当前插件为草稿状态可直接编辑当前插件。

  

• 若当前状态是已发布状态，点击编辑按钮，可查看草稿版与正式版，若在草稿中修改完成后，在点击确认，再点击发布即可覆盖到正式版本，若在草稿中修改完后，想要返回到正式版内容，可点击重置为正式版，将正式版本内容覆盖到草稿版本。再点击发布即可。

调试API插件

在新建API插件或者编辑API后，可以点击调试按钮，并且配置对应的调试模拟值进行测试，输出返回值。

删除API插件

在实际业务中，若不需要某个API插件时，可以点击删除按钮，即可删除对应的API插件。