GetExperimentPlan - 查询实验计划

更新时间:
复制 MD 格式

查询实验计划

接口说明

调用 GetExperimentPlan 查询指定实验计划的完整配置,包括实验分组、数据源、评估器和时间戳。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

agentloop:GetExperimentPlan

get

*Workspace

acs:agentloop:{#regionId}:{#accountId}:agentspace/{#AgentSpaceName}

无 无

请求语法

GET /api/v1/experiments/{agentSpace}/plans/{planId} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

agentSpace

string

否

AgentSpace 名称。

al-playground-cn-hongkong

planId

string

否

实验计划 ID。

exp-plan-0242d983f5d340fd8479cf2c19eb279e

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

请传入目标 agentSpace 和 planId。仅可查询当前账号创建的计划。

返回参数

名称

类型

描述

示例值

object

实验计划详情响应。

createdAt

integer

创建时间,毫秒级 Unix 时间戳。

1782816000000

datasetId

string

关联的数据集 ID。

arms_customer_agent_level1

description

string

描述信息。

对比 checkout Agent 基线与优化版本

evaluators

array

评估器列表。

[{"evaluatorRef": "Builtin.agent_task_completion"}]

Evaluator

单个评估器配置对象。

{"evaluatorRef":"Builtin.agent_task_completion"}

experimentType

string

实验类型。

枚举值:

  • offline :

    offline

  • online :

    online

online

experiments

array

实验配置列表。

[{"label": "A", "name": "baseline", "modelName": "qwen-max"}]

ExperimentConfig

单个实验分组配置。

input

object

可选。

{"question": "如何退款?"}

pipelineName

string

关联的数据处理 Pipeline 名称(未关联时为空)

planId

string

实验计划 ID。

exp-plan-0242d983f5d340fd8479cf2c19eb279e

planName

string

实验计划名称。

arms_agent_experiment

querySql

string

部分数据集模式下的自定义查询 SQL 子句。

status='OK'

requestId

string

请求 ID。

3FE4CD1E-FF41-56BE-B590-7A021D9C1524

selectedItemIds

array

部分数据集模式下选定的数据项 ID 列表。

["019ef4d5-a0f0-7114-832d-5542d771cd8c"]

string

数据集中的单条数据项 ID。

019ef4d5-a0f0-7114-832d-5542d771cd8c

status

string

计划状态。

枚举值:

  • running :

    running

  • stopped :

    stopped

  • pending :

    pending

stopped

updatedAt

integer

更新时间,毫秒级 Unix 时间戳。

1782816600000

计划不存在或不属于当前账号时,可能返回空对象。请根据响应中是否包含 planId 判断。时间戳为毫秒。

示例

正常返回示例

JSON格式

{
  "createdAt": 1782816000000,
  "datasetId": "arms_customer_agent_level1",
  "description": "对比 checkout Agent 基线与优化版本",
  "evaluators": [
    {
      "evaluatorRef": "Builtin.agent_task_completion",
      "name": "agent_task_completion",
      "type": "AGENT",
      "resultName": "agent_task_completion",
      "resultType": "score",
      "config": {
        "version": "1.0.0"
      },
      "filters": {
        "query": "serviceName='checkout-service'"
      },
      "variableMapping": {
        "key": "trace.input"
      },
      "variableExtractorMapping": {
        "key": {
          "originField": "trace.output",
          "type": "jsonpath",
          "expression": "$.order.expected"
        }
      }
    }
  ],
  "experimentType": "online",
  "experiments": [
    {
      "endpointConnectorId": "",
      "label": "",
      "modelName": "",
      "modelParameters": {
        "temperature": 0,
        "maxTokens": 0,
        "topP": 0,
        "topK": 0,
        "frequencyPenalty": 0,
        "presencePenalty": 0,
        "stopSequences": [
          ""
        ]
      },
      "modelProvider": "",
      "name": "",
      "promptTemplate": [
        {
          "role": "",
          "content": ""
        }
      ],
      "requestBodyTemplate": "",
      "requestHeaderTemplate": "{\"Content-Type: application/json\" }",
      "requestMethod": ""
    }
  ],
  "input": {
    "question": "如何退款?"
  },
  "pipelineName": "",
  "planId": "exp-plan-0242d983f5d340fd8479cf2c19eb279e",
  "planName": "arms_agent_experiment",
  "querySql": "status='OK'",
  "requestId": "3FE4CD1E-FF41-56BE-B590-7A021D9C1524",
  "selectedItemIds": [
    "019ef4d5-a0f0-7114-832d-5542d771cd8c"
  ],
  "status": "stopped",
  "updatedAt": 1782816600000
}

错误码

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

变更历史

更多信息,参考变更详情。