参数生成器 API 文档

基础信息

基础路径:

1. 生成配置文件接口

接口描述

根据指令生成指定省份的新的config.xml文件,目前支持山东省(shandong)和甘肃省(gansu)。

请求信息

请求路径:/generate_config/{province_name}

请求方法:POST

Content-Type:application/json

请求参数

参数名 类型 必填 描述
province_name string 路径参数,省份名称
config_data string 请求体参数,原始config.xml文件内容
request_text string 请求体参数,修改需求描述

请求示例

{
    "config_data": "<Province>\n    <Attribute>\n        <node name=\"聊城山东.聊城站/500kV.#1母线\" interval=\"1d\"/>\n    </Attribute>\n    <Stages></Stages>\n    <Weight>\n        <label name=\"TargetBus_diff\" update=\"T\" DateTime=\"[0, 719, 720]\" weight=\"[1, 0]\"/>\n    </Weight>\n    <Weather></Weather>\n    <Produce></Produce>\n    <Process></Process>\n    <Cut></Cut>\n    <Reg_Method></Reg_Method>\n    <Class_Method></Class_Method>\n    <Bi_Class_Method></Bi_Class_Method>\n    <Delta_Day></Delta_Day>\n</Province>",
    "request_text": "修改TargetBus_diff的样本权重,让最近一周的权重变为3"
}

响应信息

{
    "generated_xml": "<Province>\n    <Attribute>\n        <node name=\"聊城山东.聊城站/500kV.#1母线\" interval=\"1d\"/>\n    </Attribute>\n    <Stages></Stages>\n    <Weight>\n        <label name=\"TargetBus_diff\" update=\"T\" DateTime=\"[0, 7, 719, 720]\" weight=\"[3, 1, 0]\"/>\n    </Weight>\n    <Weather></Weather>\n    <Produce></Produce>\n    <Process></Process>\n    <Cut></Cut>\n    <Reg_Method></Reg_Method>\n    <Class_Method></Class_Method>\n    <Bi_Class_Method></Bi_Class_Method>\n    <Delta_Day></Delta_Day>\n</Province>"
}

错误响应

{
    "error": "缺少必要参数"
}

2. 生成超参数接口

接口描述

根据指令生成指定省份的超参数CSV文件,目前支持山东省(shandong)和甘肃省(gansu)。如果请求的超参数在base中不存在,系统会先通过新建config.xml的方式处理。

请求信息

请求路径:/generate_hyper/{province_name}

请求方法:POST

Content-Type:application/json

请求参数

参数名 类型 必填 描述
province_name string 路径参数,省份名称
request_text string 请求体参数,调整需求描述

请求示例

{
    "request_text": "请对TargetBus新能源竞价空间特征的系数在0.6到0.95范围内进行参数寻优,该参数命名为re_ratio"
}

响应信息

{
    "generated_xml": "<Province>\n    <Attribute>\n        <node name=\"TargetBus\" interval=\"1d\"/>\n    </Attribute>\n    <Stages></Stages>\n    <Weight></Weight>\n    <Weather></Weather>\n    <Produce>\n        <label name=\"TargetBus\" update=\"T\">\n            <feature name=\"新能源竞价空间\">\n                <var name=\"风电总加预测\" order=\"1\" coef=\"re_ratio\"/>\n                <var name=\"光伏总加预测\" order=\"2\" coef=\"re_ratio\"/>\n            </feature>\n        </label>\n    </Produce>\n    <Process></Process>\n    <Cut></Cut>\n    <Reg_Method></Reg_Method>\n    <Class_Method></Class_Method>\n    <Bi_Class_Method></Bi_Class_Method>\n    <Delta_Day></Delta_Day>\n</Province>",
    "generated_csv": "grid_xpath,grid_attribute,grid_param_range\n/Produce/label[@name='TargetBus']/feature[@name='新能源竞价空间']/var[@name='风电总加预测'],coef,\"[0.6,0.7,0.8,0.85,0.9,0.95]\"\n/Produce/label[@name='TargetBus']/feature[@name='新能源竞价空间']/var[@name='光伏总加预测'],coef,\"[0.6,0.7,0.8,0.85,0.9,0.95]\""
}

错误响应

{
    "error": "缺少必要参数"
}

3. 自定义配置文件接口

接口描述

根据指令生成基于自定义base.xml配置文件的新的config.xml文件。

请求信息

请求路径:/generate_config/custom

请求方法:POST

Content-Type:application/json

请求参数

参数名 类型 必填 描述
base_data string 请求体参数,自定义 base.xml 文件内容
config_data string 请求体参数,原始 config.xml 文件内容
request_text string 请求体参数,修改需求描述

请求示例

{
"base_data": "<Province>...</Province>",
"config_data": "<Province>...</Province>",
"request_text": "修改需求描述"
}

响应信息

{
"generated_xml": "<Province>...</Province>"
}

错误响应

{
"error": "缺少必要参数"
}

4. 自定义超参数接口

接口描述

根据指令生成自定义 base.xml 的超参数CSV文件。

请求信息

请求路径:/generate_hyper/custom

请求方法:POST

Content-Type:application/json

请求参数

参数名 类型 必填 描述
base_data string 请求体参数,自定义 base.xml 文件内容
request_text string 请求体参数,调整需求描述

请求示例

{
"base_data": "<Province>...</Province>",
"request_text": "调整需求描述"
}

响应信息

{
"generated_xml": "<Province>...</Province>",
"generated_csv": "grid_xpath,grid_attribute,grid_param_range\n..."
}

错误响应

{
"error": "缺少必要参数"
}