You need to enable JavaScript to run this app.
导航

标签结果同步

最近更新时间2022.09.15 18:59:09

首次发布时间2021.08.17 20:03:22

概述

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

说明

  • 接口请求时间: 间隔至少需超过 2s
  • 接口查询范围: 仅支持 7日 内的数据查询,因无穷回溯影响性能;
标签同步

调前准备

  1. 该接口可按需对接
  2. 接口鉴权
    详见:接口鉴权
  3. 调用接口
    注意参数 是否必填,并确保 ServiceName、Action、Version 等url信息正确
    详见:下方接口信息

请求接口

请求方式

post

请求url

https://cms.volcengineapi.com?Action=ArticleEventNotify&Version=2021-01-01

请求header

ServiceName: volc_content_platform

url组成:

Host: https://cms.volcengineapi.com

Action: ArticleEventNotify

Version: 2021-01-01

请求参数

字段名
字段类型
是否必填
说明
GenerateType
string
查询指定Api来源的内容的同步状态,不传则不进行筛选查询
EventType
string
事件类型,该接口应该固定为""ArticleTagUpdate""
CursorTime
int64
时间锚

说明

  • CursorTime使用方式: 首次请求传 0,根据时间排序,返回前100条有关的数据;返回结果包含下次请求的 CursorTime 值,循环上述操作;若返回无数据,则继续使用上次请求的 CursorTime 值,直到有数据返回,再使用返回的 CursorTime 值。

响应字段

字段名
字段类型
是否必填
说明
ResponseMetadata
ResponseMetadata
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": "20210817172003010225243100020C45D8",
        "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": "202108171722050102252431470309E4A8",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 600400,
            "Code": "600400",
            "Message": "参数错误"
        }
    },
    "Result": null
}

请求频率超过限制

{
    "ResponseMetadata": {
        "RequestId": "202108171722360102251421420709B9A0",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 600466,
            "Code": "600466",
            "Message": "OverRateLimitError"
        }
    }
}

错误代码

详见:错误代码表 - volc_content_platform

注意

若需排查日志,请提供接口返回的 RequestId