模型批量预测

模型批量预测

  • 接口描述

    利用模型,针对未标注的数据集进行批量预测,预测结果会以文本形式存储在用户的bos目录下。

  • 请求(Request)

    • 请求语法:
    POST /v{version}/modelBatchPredict HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
modelId String 必选 模型ID
datasetId String 必选 预测数据集的ID
outPath String 必选 预测结果在BOS上的存储路径
batchPredictPara AlgoPara 必选 模型的批量预测参数,具体模型的批量预测参数参考对应算法的算法文档
若该模型对应的算法没有特殊的批量预测参数,可以为空
  • 响应(Response)

    • 响应头域:无特殊Header参数

    • 响应参数:

参数 参数类型 参数描述
batchPredictId String 批量预测Id
  • 示例

    • 请求示例
    POST /v1/modelBatchPredict HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    {
        "modelId": "model-fdslkj454jd3",
        "datasetId":"dataset-cgfd32fdmt01",
        "outPath":"bos://bucketName/objectName/predictout",
        "batchPredictPara": {
        }
    }
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8 
    {
        "batchPredictId": "batchPredict-a0x532fdmt01",
    }
    

查询模型批量预测信息

  • 接口描述

    查询模型批量预测详细信息

  • 请求(Request)

    • 请求语法:
    GET /v{version}/modelBatchPredict/{batchPredictId} HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
batchPredictId String 必选 模型批量预测ID
  • 响应(Response)

    • 响应头域:无特殊Header参数
    • 响应参数:
参数 参数类型 参数描述
batchPredictId String 模型批量预测ID
modelId String 用来批量预测的模型ID
datasetId String 被批量预测的数据集ID
outPath String 预测结果在BOS上的存储路径
batchPredictPara AlgoPara 模型的批量预测参数,具体模型的批量预测参数参考对应算法的算法文档
若该模型对应的算法没有特殊的批量预测参数,可以为空
status Status 当前批量预测状态,
status的value大0为正在进行预测,等于0为预测成功,小于0为预测失败
history List 预测历史状态
createTime String 创建时间,符合日期时间格式约束
finishTime String 完成时间,符合日期时间格式约束,未完成时为空
  • 示例

    • 请求示例
    GET /v1/modelBatchPredict/batchPredict-a0x532fdmt01 HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8 
    {
        "batchPredictId": "batchPredict-a0x532fdmt01",
        "modelId": "model-fdslkj454jd3",
        "datasetId": "dataset-cgfd32fdmt01",
        "outPath": "bos://bucketName/objectName/predictout",
        "batchPredictPara": {
        },
        "status": {
            "value": 0,
            "message": "BML job completed successful",
            "time": "2015-07-09T15:00:38Z"
        },
        "history": [
        {
            "value": 1,
            "message": "BML job submit successful",
            "time": "2015-07-09T14:53:53Z"
        },
        {
            "value": 2,
            "message": "BML job startup",
            "time": "2015-07-09T14:55:13Z"
        },
        {
            "value": 3001,
            "message": "LR batch predict:startup",
            "time": "2015-07-09T14:55:15Z"
        },
        {
            "value": 3002,
            "message": "LR batch predict:loading configure data",
            "time": "2015-07-09T14:55:17Z"
        },
        ......
        {
            "value": 0,
            "message": "BML job completed successfull",
            "time": "2015-07-09T15:00:38Z"
        }           
        ],
        "createTime" : "2015-07-09T14:53:53Z",
        "finishTime" : "2015-07-09T15:00:38Z" 
    
    }
    

查询模型批量预测列表

  • 接口描述

    查询用户某个模型的批量预测信息列表

  • 请求(Request)

    • 请求语法:
    GET /v{version}/modelBatchPredict?&modelId={modelId}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
modelId String 必选 要查询批量预测列表的模型ID
marker String 可选 批量获取列表的查询的起始位置,是一个由系统生成的字符串
maxKeys Int 可选 每页包含的最大数量,
最大数量不能超过1000。大于1000的会被修正为1000。缺省值为1000
  • 响应(Response)

    • 响应头域:无特殊Header参数

    • 响应参数:

参数名 参数类型 参数描述
marker String 标记查询的起始位置
truncated Boolean true表示后面还有数据,false表示已经是最后一页
nextMarker String 获取下一页所需要传递的marker值。
当truncated为false时,该域不出现
modelBatchPredictList List 返回的该模型的批量预测信息列表
  • 示例

    • 请求示例
    GET /v1/modelBatchPredict?modelId=model-fdslkj454jd3&marker=9e0c8cf1-690c-444a-8727-04241f3beaa5&maxKeys=30 HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8 
    {
        "modelBatchPredictList": [
        {
            "batchPredictId": "batchPredict-a0x532fdmt01",
            "modelId": "model-fdslkj454jd3",
            "datasetId": "dataset-cgfd32fdmt01",
            "outPath": "bos://bucketName/objectName/predictout",
            "batchPredictPara": {
            },
            "status": {
                "value": 0,
                "message": "BML job completed successful",
                "time": "2015-07-09T15:00:38Z"
            },
            "createTime" : "2015-07-09T14:53:53Z",
            "finishTime" : "2015-07-09T15:00:38Z" 
    
        },
        {
            "batchPredictId": "batchPredict-e3b312zanmi30",
            "modelId": "model-fdslkj454jd3",
            "datasetId": "dataset-zlls42lfye83",
            "outPath": "bos://bucketName/objectName/lda_predictout",
            "batchPredictPara": {
                topicNum: 4
            },
            "status": {
                "value": 5001,
                "message": "LDA batch predict:startup",
                "time": "2015-07-10T03:24:32Z"
            },
            "createTime" : "2015-07-09T14:53:53Z",
            "finishTime" : ""
        },
        ...... 
        ],
        "truncated": false,
        "marker": "9e0c8cf1-690c-444a-8727-04241f3beaa5"
    }
    

终止模型批量预测

  • 接口描述

    对于正在预测过程中的模型批量预测,进行终止操作。

  • 请求(Request)

    • 请求语法:
    PUT /v{version}/modelBatchPredict/{batchPredictId} HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
batchPredictId String 必选 要终止预测的模型批量预测ID。
该模型批量预测必须为正在预测中的状态,即当前status的value字段大于0
  • 响应(Response)

    • 响应头域:无特殊Header参数
    • 响应参数:
参数 参数类型 参数描述
batchPredictId String 模型批量预测ID
  • 示例

    • 请求示例
    PUT /v1/modelBatchPredict/batchPredict-cciw07wxjl27 HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8
    {
        "batchPredictId" : "batchPredict-cciw07wxjl27"
    }