InvokePlugin - 调用插件_大模型服务平台百炼(Model Studio)-阿里云帮助中心

调用插件，获取插件返回结果。

接口说明

前提条件

已开通百炼服务和通义点金服务。

获取到 workspaceId：获取 workspace 标识。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /{workspaceId}/api/plugin/invoke

请求参数

名称	类型	必填	描述	示例值
workspaceId	string	是	路径参数，业务空间 id	llm-xxxxx
body	object	否	请求体参数。
params	object	否	请求参数	{ "query": "介绍一下贵金属业务", "filters": [ { "libraryId": "9xznrxw" } ], "topK": 1 }
pluginId	string	否	插件标识符	3mj87da7zr

返回参数

名称	类型	描述	示例值
	object	ResultCode
cost	long	耗时	null
data	object	响应数据	{'jobWaiting': [0, 0], 'timestamps': [1713383820, 1713383880], 'jobUsage': [0, 0], 'quotaUsage': [123, 32]}
dataType	string	数据类型	null
errCode	string	错误码	0
message	string	错误信息	ok
requestId	string	请求 id	915AAAB9-4908-5224-9E53-9E9D7D0AA94B
success	boolean	是否成功	true
time	string	时间戳	2024-04-24 11:54:34

示例

正常返回示例

JSON格式

{
  "cost": 0,
  "data": {
    "test": "test",
    "test2": 1
  },
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "915AAAB9-4908-5224-9E53-9E9D7D0AA94B",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

错误码

访问错误中心查看更多错误码。