文档首页/ 推荐系统 RES/ API参考/ API（V1不推荐）/ 作业相关API/ 提交召回作业
更新时间：2023-05-24 GMT+08:00
查看PDF
分享

提交召回作业

功能介绍

该接口用于提交召回作业。

URI

POST /v1/{project_id}/recall-job

参数说明请参见表1。

表1 URI参数说明

名称

是否必选

类型

说明

project_id

是

String

项目编号，用于资源隔离。获取方法请参见获取项目ID。

请求消息

请求参数请参见表2。

表2 请求参数说明

参数名称

是否必选

参数类型

说明

workspace_id

否

String

工作空间ID，默认为0

job_name

是

String

训练作业名称，最大长度为20字符。

job_description

否

String

训练作业描述，最大长度为256字符。

offline_platform

是

JSON

请参见表3，离线计算平台信息。

storage

是

JSON

请参见表8，信息存储。

strategy

是

JSON

请参见表5，策略信息
表3 offline_platform参数说明

参数名称

是否必选

参数类型

说明

platform

是

String

平台名称，最大长度64，支持DLI。

platform_parameter

是

JSON

请参见表4，平台参数。

computing_resource

否

String

指定DLI运行任务的资源规格。

config_load_path

是

String

读取配置源路径。
表4 platform_parameter参数说明

参数名称

是否必选

参数类型

说明

cluster_name

是

String

集群名称。

cluster_id

否

String

集群ID。
表5 strategy参数说明

参数名称

是否必选

参数类型

说明

strategy_type

是

String

策略类型（可选值）

  • 召回策略：recall。

name

是

String

策略别名，最大长度60字符。

algorithm_type

是

String

算法类型。

parameter

是

JSON

请参见策略参数说明，算法参数，JSON字符串。

data_source

是

List

请参见表6，数据源。

响应消息

响应参数请参见表6。

表6 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

是

Boolean

是否成功。

strategy

是

List

请参见表7，返回策略结果。

job_id

是

String

作业ID。
表7 strategy参数说明

参数名称

是否必选

参数类型

说明

strategy_type

是

String

策略类型（可选值）

  • 召回策略：recall

name

是

String

策略别名，由汉字、数字、字母、下划线、中划线、空格组成。

algorithm_type

是

String

算法类型。

parameter

是

String

请参见策略参数说明，算法参数，JSON字符串。
表8 candidate_set参数说明

参数名称

是否必选

参数类型

说明

uuid

是

String

候选集ID。

description

是

String

候选集描述。

示例

  • 请求示例 
    {
  "job_name": "ddddddddddddd",
  "job_description": "",
  "offline_platform": {
       "platform": "DLI",
"platform_parameter": {"cluster_name":"res_cluster"},
"config_load_path":"<读取配置源路径>"
    },
  "storage": {
      "platform": "CloudTable",
      "platform_parameter": {"cluster_name":"cloudtable-e596","cluster_id":"ec55161b-06e3-4871-af2a-2a6ec29e60f3","table_name":"res_yang0918"}
    },
  "strategy": 
        {
"name": "默认推荐-特定行为热度",
"algorithm_type": "SpecificBehavior",
"strategy_type": "recall",
"parameter": {
"data_source_config":{
"retain_days":30,
"behavior_type":"uncollect",
"start_time":"1533571200000",
"end_time":"3155328000000"
},
"algorithm_config":{},
"candidate_set_config":{
"is_recommended_by_category":true
}
},
"data_source": [
        {
          "table_type_id": "ITEM_META",
          "data_format": "csv",
          "data_source_url": "<数据源存储路径>",
          "data_param": {
            "header": false,
            "delimiter": ",",
            "quote": "\"",
            "escape": "\\"
          }
        },
        {
          "table_type_id": "ITEM_META_CONF",
          "data_format": "csv",
          "data_source_url": "<数据源存储路径>",
          "data_param": {
            "header": true,
            "delimiter": ",",
            "quote": "\"",
            "escape": "\\"
          }
        },
        {
          "table_type_id": "USER_BEHAVIOR",
          "data_format": "csv",
          "data_source_url": "<数据源存储路径>",
          "data_param": {
            "header": false,
            "delimiter": ",",
            "quote": "\"",
            "escape": "\\"
          }
}
    ]
  }
}
  • 成功响应示例 
    {
    "is_success": true,
    "strategy": {
        "name": "默认推荐-特定行为热度",
        "strategy_type": "recall",
        "algorithm_type": "SpecificBehavior",
        "parameter": {
            "data_source_config": {
                "retain_days": 30,
                "behavior_type": "uncollect",
                "start_time": "1533571200000",
                "end_time": "3155328000000"
            },
            "algorithm_config": {},
            "candidate_set_config": {
                "is_recommended_by_category": true
            }
        },
        "candidate_set": [
            {
                "uuid": "6de41841ff904e75b35657dd4323876f",
                "description": "[默认推荐-特定行为热度]特定行为热度推荐算法生成的候选集"
            }
        ],
        "data_source": [
            {
                "table_type_id": "ITEM_META",
                "data_format": "csv",
                "data_source_url": "<数据源存储路径>",
                "data_param": {
                    "header": "false",
                    "delimiter": ",",
                    "quote": "\"",
                    "escape": "\\"
                }
            },
            {
                "table_type_id": "ITEM_META_CONF",
                "data_format": "csv",
                "data_source_url": "<数据源存储路径>",
                "data_param": {
                    "header": "true",
                    "delimiter": ",",
                    "quote": "\"",
                    "escape": "\\"
                }
            },
            {
                "table_type_id": "USER_BEHAVIOR",
                "data_format": "csv",
                "data_source_url": "<数据源存储路径>",
                "data_param": {
                    "header": "false",
                    "delimiter": ",",
                    "quote": "\"",
                    "escape": "\\"
                }
            }
        ],
        "strategy_id": 0
    },
    "job_id": "1e9bf244ebdc41f0b5ee5c1dd0fa07c3"
}
  • 失败响应示例 
    {
    "is_success": false,
    "error_code": "res.2006",
    "error_msg": "The datasourceUrl(<数据源存储路径>) is not match Bucket structure."
}

状态码

状态码请参见状态码。

父主题： 作业相关API

相关文档