本文档介绍内容洞察提供的数据检索接口的调用方式

内容洞察平台在客户针对新场景做数据测试时，提供数据检索接口，客户侧在面向用户侧做数据演示时，可以通过该接口实时查询内容洞察的数据情况。

备注：
接口调用前置操作，详见：调用指南

基本信息

请求参数

Hearder请求参数

Body请求参数

返回参数

调用示例

请求示例

POST  /openapi/item/search

Header:
X-Insight-Biz-Name: $biz_name
X-Insight-Access-Token: $token
Content-Type: application/json

Body:
{
    "rule": [
        "and",
        [
            "or",
            [
                "in",
                "关键词A",
                {
                    "fl": [
                        "title",
                        "asr",
                        "ocr"
                    ]
                }
            ]
        ],
        [
            "or",
            [
                "in",
                "关键词B",
                {
                    "fl": [
                        "title",
                        "asr",
                        "ocr"
                    ]
                }
            ]
        ]
    ],
    "page_size": 10,
    "page_number": 1,
    "start_time": "2023-11-28 10:00:00",
    "end_time": "2023-11-28 11:00:00",
    "snapshot_id": ""
}

curl --location 'https://insight.volcengineapi.com/openapi/item/search' \
--header 'X-Insight-Biz-Name: $biz_name' \
--header 'X-Insight-Access-Token: $token' \
--header 'Content-Type: application/json' \
--data '{
    "rule": [
        "and",
        [
            "or",
            [
                "in",
                "关键词A",
                {
                    "fl": [
                        "title",
                        "asr",
                        "ocr"
                    ]
                }
            ]
        ],
        [
            "or",
            [
                "in",
                "关键词B",
                {
                    "fl": [
                        "title",
                        "asr",
                        "ocr"
                    ]
                }
            ]
        ]
    ],
    "page_size": 10,
    "page_number": 1,
    "start_time": "2023-11-28 10:00:00",
    "end_time": "2023-11-28 11:00:00",
    "snapshot_id": ""
}'

返回示例

{
    "data": {
        "items": [
            {
                // post_details
            }
        ],
        "snapshot_id": "74e1ef64952a3d210118c00badb469bc",
        "count": 10000
    },
    "message": "succeed",
    "status": 0
}

检索规则

• 支持的运算方法：

  操作类型	规则名称	参数说明
  逻辑运算：与	and	多个规则同时满足时命中
  逻辑运算：或	or	存在一个规则满足时命中
  字符串匹配	in	参数1是被匹配的文本，参数2是字符串

• 支持的参数： title, ocr, asr

• 参数配置方式：

  参数key	英文名称	示例	说明
  f	field	{"f": "title"}	表示这个参数需要从原始输入数据中去获取“title”特征
  fl	field list	{"fl": ["title", "ocr"]}	表示这个参数从原始数据中获取多个特征，并且组装成list。

• 规则限制：

  • 规则层数不能超过两层；

  • 关键词总长度不能超过50；

  • 关键词会有敏感词校验，敏感词校验&预览具体可参考：订阅任务配置；

  • 不同数据套餐对应的调用次数限制：套餐一2500次/天，套餐二6000次/天，套餐三10000次，套餐四25000次，套餐五35000次，定制算法/标准字段套餐按2500次/天，测试账号无次数限制。

• 一个两层的规则配置示例：

  "rule": [
          "and",
          [
              "or",
              [
                  "in",
                  "关键词A",
                  {
                      "fl": [
                          "title",
                          "asr",
                          "ocr"
                      ]
                  }
              ]
          ],
          [
              "or",
              [
                  "in",
                  "关键词B",
                  {
                      "f": "ocr"
                  }
              ]
          ]
      ]