You need to enable JavaScript to run this app.
导航
ArticleEventNotify-标签结果同步
最近更新时间:2024.03.01 10:48:24首次发布时间:2021.08.17 20:03:22

内容在同步到内容管理平台后,会被多个内容理解模型消费,该过程是异步的,因此需要调用该接口获取内容最新的特征标签集合。

注意事项

  • 使用限制:
    • 接口查询范围: 无穷回溯影响性能,因此接口仅支持7日内的数据查询;
  • 请求频率:
    • 接口请求时间:间隔至少需超过 2s

请求说明

  • 请求方式:POST
  • 请求地址:https://cms.volcengineapi.com?Action=ArticleEventNotify&Version=2021-01-01
  • 请求头:ServiceName: volc_content_platform

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必填
示例值
描述
Action
String

ArticleEventNotify

要执行的操作,取值:ArticleEventNotify

Version
String

2021-01-01

API的版本,取值:2021-01-01

Body

参数
类型
是否必填
示例值
描述
GenerateType
String

toutiao_api

查询指定Api来源的内容的同步状态,不传则不进行筛选查询,取值路径:控制台 - 内容引入 - 内容源管理 - Api源标识。

EventType
String

ArticleTagUpdate

事件类型,固定值"ArticleTagUpdate"。

CursorTime
Long

1638283523

时间锚。

说明

CursorTime使用方式:

  • 首次请求传 0,根据时间排序,返回前100条有关的数据;
  • 返回结果包含下次请求的 CursorTime 值,循环上述操作;
  • 当返回结果数据量不足100条时,说明已没有更多数据。

注意

  • CursorTime的初次请求传0或其他值,也会计算为一次请求,下一次请间隔至少2s再请求。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Result
ArticleEventNotifyResult

请求结果。

EventDetail

EventDetail类型为字符串,由以下结构JsonEncode得到。

{
    "article_origin_id": "xxx", // 内容原始id,即内容引入接口内容OpenId
    "tag_list": [
        {
          "Tag": "xxx", // 标签名
          "Weight": xxx, // 置信度
          "Source": "xxx", // 来源:nlp,user
          "Type": "xxx", // 类型
          "Frequency": xxx  // 频率
        },
        ...
    ]
}

请求示例

{
    "CursorTime": 1628569971,
    "EventType": "ArticleTagUpdate",
}

返回示例

  • 返回成功
{
    "ResponseMetadata": {
        "RequestId": "20210817172003010225243100020C4***",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "Items": [
            {
                "EventType": "ArticleTagUpdate",
                "SubEventType": "",
                "EventTime": 1628601201,
                "ArticleId": 1707680519986206,
                "GenerateType": "zhihu",
                "EventDetail": "\"{\\\"article_origin_id\\\":\\\"\\\",\\\"tag_list\\\":[{\\\"Tag\\\":\\\"成都\\\",\\\"Weight\\\":1,\\\"Source\\\":\\\"user\\\",\\\"Type\\\":\\\"\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"资阳\\\",\\\"Weight\\\":1,\\\"Source\\\":\\\"user\\\",\\\"Type\\\":\\\"\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"知识改变生活\\\",\\\"Weight\\\":1,\\\"Source\\\":\\\"user\\\",\\\"Type\\\":\\\"\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"鞋\\\",\\\"Weight\\\":1,\\\"Source\\\":\\\"user\\\",\\\"Type\\\":\\\"\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"四川\\\",\\\"Weight\\\":1,\\\"Source\\\":\\\"user\\\",\\\"Type\\\":\\\"\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"不完美妈妈\\\",\\\"Weight\\\":1,\\\"Source\\\":\\\"user\\\",\\\"Type\\\":\\\"\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"熊猫宝来\\\",\\\"Weight\\\":1,\\\"Source\\\":\\\"user\\\",\\\"Type\\\":\\\"\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"情感偏正向\\\",\\\"Weight\\\":0.81617,\\\"Source\\\":\\\"nlp\\\",\\\"Type\\\":\\\"nlp.nature.sentiment\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"鞋子\\\",\\\"Weight\\\":0.79507,\\\"Source\\\":\\\"nlp\\\",\\\"Type\\\":\\\"cv.image.goods\\\",\\\"Frequency\\\":0},{\\\"Tag\\\":\\\"鞋底\\\",\\\"Weight\\\":0.77071,\\\"Source\\\":\\\"nlp\\\",\\\"Type\\\":\\\"nlp.nature.keyword\\\",\\\"Frequency\\\":0}]}\""
            }
        ],
        "CursorTime": 1628601201
    }
}
  • 参数错误
{
    "ResponseMetadata": {
        "RequestId": "20210817172205010225243147030tt***",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 600400,
            "Code": "600400",
            "Message": "参数错误"
        }
    },
    "Result": null
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
600400
参数错误

内容为空,或者是入参的类型是否与文档中不一致

200
600500
服务未知错误

服务内部异常,请联系商务