modelscope中Agent调用自定义API需要什么样格式的数据？

在ModelScope中，Agent调用自定义API时需要遵循特定的数据格式和配置要求。以下是详细的说明：

1. 请求方法与协议

• 自定义API支持的HTTP协议方法为GET和POST。
• URL地址必须附带HTTP或HTTPS协议头。
• 注意：API节点不支持application/x-www-form-urlencoded类型的POST请求。如果需要使用该类型，建议通过工作流应用完成任务。

2. 输入参数的传递方式

• 手工输入：根据变量类型的不同，从相应的结果中获取。变量需以包裹，例如`${bizVars.abc}`。如果输入不在内，则会被识别为常量。
• 联想提示：在界面输入/后会弹出提示，直接选中变量即可，选中后的效果与手工输入一致。

3. 请求体结构

调用自定义API时，请求体需要包含以下内容： - biz_params（可选）：用于通过自定义节点或插件传递参数。在Java SDK中为bizParams，通过HTTP调用时需将biz_params放入input对象中。 - user_defined_params（可选）：表示自定义插件参数信息，具体包括： - plugin_id：插件ID，依据具体的插件变化。 - ${plugin_params}：对象最内侧包含的多个键值对，每个键值对表示用户自定义的待传递参数名及其指定值。例如： json "article_index": 2 - user_defined_tokens（可选）：表示自定义插件的用户级鉴权信息，具体包括： - plugin_id：插件ID，可在插件卡片中获取。 - user_token：传递该插件需要的用户鉴权信息，如实际的DASHSCOPE_API_KEY值。

4. 鉴权信息

• 服务级鉴权：
  • 鉴权信息可以放在Header或Query中。
  • 如果选择Header，鉴权信息将默认放在Authorization字段中。
  • 如果选择Query，需填写鉴权时使用的参数名，例如api_key。
  • 支持的鉴权类型包括：
  • basic：不会在Token前加任何内容。
  • bearer：会在Token前增加Bearer。
  • appcode：会在Token前增加APPCODE。
• 用户级鉴权：
  • 每次调用插件时都需要传入Token。
  • 鉴权信息的位置和参数名与服务级鉴权相同。

5. 返回结果的处理

• JSON对象返回值：
  • 如果返回的数据是一个JSON对象（例如：{"a":1,"b":"cc"}），可以通过表达式${svcVars.Api_xxx.response.a}获取字段a。
• JSON数组返回值：
  • 如果返回的数据是一个JSON数组（例如：[{"a":1},{"a":3,"b":"cc"}]），可以通过${svcVars.Api_xxx.response.list[0].a}获取第一条数据中的字段a。
  • 如果需要获取所有数据中的字段a，则使用${svcVars.Api_xxx.response.list.a}。
• 非JSON返回值：
  • 对于非JSON格式的返回值（例如："这个问题怎么样"），可以通过${svcVars.Api_xxx.response.text}获取完整的数据。

6. 重要提醒

• 鉴权方式的选择：根据实际需求选择服务级鉴权或用户级鉴权，并确保正确配置鉴权信息的位置和类型。
• 请求体的完整性：确保biz_params、user_defined_params和user_defined_tokens等字段的正确传递，避免因参数缺失导致调用失败。
• 返回结果的解析：根据返回值的类型（JSON对象、JSON数组或非JSON格式），使用对应的表达式提取所需信息。

通过以上步骤和配置，您可以成功调用ModelScope中的自定义API并处理返回结果。