插件参数说明
模型插件调用需"申请体验"并通过后才可使用,否则API调用将返回错误状态码。
DashScope插件在使用SDK或HTTP调用方式体验时,需要通过参数X-DashScope-Plugin显式地指明可以使用的候选插件集合。
插件参数示例
插件无额外参数
若某个插件不需要额外的参数,则传入插件时保持插件参数为空即可。
比如万豪酒店预定推荐插件,其英文名为haozhu_recommend_hotel
,您可以将参数X-DashScope-Plugin设为
{"haozhu_recommend_hotel":{}}
插件有额外参数
若某个插件需要额外的参数时,可通过参数传入。
例如某信息检索插件(英文名为information_retrieval
)需要用户token关联个人数据信息的增、删、改、查。则需要将参数X-DashScope-Plugin设为
{"information_retrieval":{"user_token": "$your_general_info_token"}}'
其中$your_general_info_token
为您个人在该信息检索插件中使用的私有token。
多个插件示例
当您需要使用多个插件功能时,仅需要将多个插件的插件参数分别传入即可,例如您可以将X-DashScope-Plugin设置为
{"haozhu_recommend_hotel":{},"information_retrieval":{"user_token":"eyJhbG……"}}
鉴权参数列表
以下是平台支持的几个插件的参数列表,以及相关插件参数示例
插件中文名 | 插件英文名 | 插件鉴权参数 | 描述 | 示例值 |
文字识别 | ocr | 无 | 使用空字典 | {} |
计算器 | calculator | 无 | 使用空字典 | {} |
图片生成 | text_to_image | 无 | 使用空字典 | {} |
万豪酒店预定推荐 | haozhu_recommend_hotel | 无 | 使用空字典 | {} |
PDF解析 | pdf_extracter | 无 | 使用空字典 | {} |
Python代码解释器 | code_interpreter | 无 | 使用空字典 | {} |