CPP_API 接口文档

所有功能均通过Python SDK实现 (CPP.py)

用户注册

参数

参数类型说明
usernamestring注册用户名,必填且不可重复
passwordstring注册密码,必填
phone_numberstring注册手机号,必填且不可重复
invite_codestring注册时所需来自已注册用户的邀请码

返回值

数据以json字符串格式返回,包含code、mas、msg三个字符串对

数据类型说明
codestring请求返回状态
masstring请求返回信息说明
msgstring请求返回用户信息,包含用户名、密码、手机号、生成专属于用户的token和邀请码

请求示例

from CPP import CPP_API
cb = CPP_API()
r = cb.user_register('test_account1', 'hahaha123', '12312341232', 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InJvb3QiLCJwdyI6ImNwcGFwaTIzMyJ9.NkwQh3Rn1YYIBkQyW1Rb5qOogPwqV0to7jwKKKR7iNo')

返回示例

{
    'code': 0, 
    'mas': 'REGISTER_SUCCESSED', 
    'msg': {
        'username': 'test_account1', 
        'password': 'hahaha123', 
        'phone_number': '12312341232', 
        'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3RfYWNjb3VudDEiLCJwdyI6ImhhaGFoYTEyMyJ9.evpZxXz-WUBGgtopQIYaGQcWN18r1FUuUCvSSt-bGRg', 
        'invite_code': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3RfYWNjb3VudDEiLCJwdyI6ImhhaGFoYTEyMyJ9.k3kn5_Q_V5emji8g3PG4-IaNJZ6iDT3G_z-xuaNbV-Y'
    }
}

用户登录

参数

参数类型说明
usernamestring用户名,必填
passwordstring密码,必填

返回值

数据以json字符串格式返回,包含code、mas、msg三个字符串对

数据类型说明
codestring请求返回状态
masstring请求返回信息说明
msgstring请求返回信息,空json串

请求示例

from CPP import CPP_API
cb = CPP_API()
r = cb.user_login('test_account','hahaha123')

返回示例

{
    'code': 0, 
    'mas': 'LOGIN_SUCCESSED', 
    'msg': {}
}

刷新token

参数

参数类型说明
usernamestring用户名,必填
passwordstring密码,必填

返回值

数据以json字符串格式返回,包含code、mas、msg三个字符串对

数据类型说明
codestring请求返回状态
masstring请求返回信息说明
msgstring请求返回用户信息,包含用户新生成的token值

请求示例

from CPP import CPP_API
cb = CPP_API()
r = cb.generate_token('test_account1', 'hahaha123')

返回示例

{
    'code': 0, 
    'mas': 'LOGIN_SUCCESSED', 
    'msg': {
        'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3RfYWNjb3VudDEiLCJwdyI6ImhhaGFoYTEyMyJ9.fjWO-SKAk9r6vLSnGlUGdq7lZLJV5TgwxHvHy_uhS4s'
    }
}

获取模型数据

参数

参数类型说明可选参数
slidingstring模型滑窗时长,必填"1" , "7"
modelstring选用模型,必填"rf","svr","nn","ridge","lasso","com1","com2","com3","com4"
tokenstring用户专属token,必填无可选值,用户注册信息或刷新token时获得
  • 参数解释

    • sliding

      • sliding = "1": 选用滑窗长度为1的预测模型,可以预测未来一天的数据
      • sliding = "7": 选用滑窗长度为7的预测模型,可以预测未来七天的数据
    • model

      • model = "rf": 随机森林
      • model = "svr": 支持向量机
      • model = "nn": 神经网络
      • model = "ridge": 岭回归
      • model = "lasso": lasso回归
      • model = "com1": 集成模型1:基于方差倒数法
      • model = "com2": 集成模型2:基于算数平均法
      • model = "com3": 集成模型3:基于均方倒数法
      • model = "com4": 集成模型4:基于简单加权法

返回值

数据以json字符串格式返回,包含code、mas、msg三个字符串对

数据类型说明
codestring请求返回状态
masstring请求返回信息说明
msgstring请求返回模型预测结果信息,包括模型预测值、模型误差和模型最近一次更新时间
  • 返回值解释

    • model_name: 模型名称
    • pred: 未来 x 天的预测值
    • error

      • rmse: 均方根误差
      • mae: 平均绝对误差
      • mre:平均绝对百分比误差
    • last_day: 模型最近一次更新时间

请求示例 1

from CPP import CPP_API
token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InJvb3QiLCJwdyI6ImNwcGFwaTIzMyJ9.g9-FGFr1_ua0mOjFFNkyPALCDp3xI4Jf4FuS6VZKAo8"
cb = CPP_API(token)
r = cb.get_cppapi(1, 'rf')

返回示例 1

{
    "code": 0,
    "mas": "EXECUTION_SUCCESSED",
    'msg': {
        'model_name': 'rf', 
        'pred': [
            {
                'next_1_day': '59.0672541666667'
            }
        ], 
        'error': [
            {
                'rmse': '0.713015060283074', 
                'mae': '0.529263492063492', 
                'mre': '0.0089571428571428'
            }
        ], 
        'last_day': '2022-06-16'
    }
}

请求示例 2

from CPP import CPP_API
token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InJvb3QiLCJwdyI6ImNwcGFwaTIzMyJ9.g9-FGFr1_ua0mOjFFNkyPALCDp3xI4Jf4FuS6VZKAo8"
cb = CPP_API(token)
r = cb.get_cppapi(7, 'com1')

返回示例 2

{
    'code': 0, 
    'mas': 'EXECUTION_SUCCESSED', 
    'msg': {
        'model_name': 'com1', 
        'pred': [
            {
                'next_1_day': '55.5415563873219',
                'next_2_day': '55.2827886431594', 
                'next_3_day': '55.9349406901479', 
                'next_4_day': '55.9036233624959', 
                'next_5_day': '56.1097400404367', 
                'next_6_day': '56.0745152593416', 
                'next_7_day': '56.1468199705682'
            }
        ], 
        'error': [
            {
                'rmse': '3.13757544226656',
                'mae': '2.15833723493415', 
                'mre': '0.0397474840103932'
            }
        ],
        'last_day': '2022-06-16'
    }
}
Last modification:June 17th, 2022 at 09:27 am
如果觉得我的文章对你有用,请随意赞赏