创建一个查询分析规则。当 dryRun=true 时,表示进行查询分析规则校验,默认 dryRun 不传为 false。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId]/query-processors HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
appGroupIdentity String Path my_app_group_name

应用名称

appId Integer Path 110157886

版本号

dryRun Boolean Query true

是否为空运行请求

请求体

字段

类型

是否必要

示例值

描述

name

String

"test"

规则名称

processors[]

Object

--

分析规则

参考:Processor

domain

String

"GENERAL"

行业类型

  • GENERAL 通用行业
  • ECOMMERCE 电商
  • IT_CONTENT IT行业

indexes

Array

["default"]

应用的索引范围

active

Boolean

true

是否设置为有效

参考:QueryProcessor

返回数据

名称 类型 示例值 描述
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF

请求ID

result Struct

规则信息

active Boolean true

是否默认规则

created Integer 1587398402

创建时间

domain String GENERAL

行业类型

  • GENERAL 通用
  • ECOMMERCE 电商
  • IT_CONTENT IT内容
indexes List "default"

应用的索引范围

name String query_filter

规则名称

processors List {}

包含功能

updated Integer 1587398402

更新时间

示例

请求示例

POST /v4/openapi/app-groups/os_function_test_v1/apps/110157886/query-processors

{
    "name": "query_filter",
    "domain": "GENERAL",
    "indexes": ["default"],
    "processors": [
        {
            "name": "synonym",
            "useSystemDictionary": true
        },
        {
            "name": "stop_word",
            "useSystemDictionary": true,
            "interventionDictionary": "helo"
        }
    ]
}

正常返回示例

XML格式

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<result>
    <name>query_filter</name>
    <active>true</active>
    <indexes>default</indexes>
    <processors>
        <name>synonym</name>
        <useSystemDictionary>true</useSystemDictionary>
    </processors>
    <processors>
        <name>stop_word</name>
        <useSystemDictionary>true</useSystemDictionary>
        <interventionDictionary>980</interventionDictionary>
    </processors>
    <domain>GENERAL</domain>
    <created>1587398402</created>
    <updated>1587398402</updated>
</result>

JSON格式

{
    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "result": {
        "name": "query_filter",
        "active": true,
        "indexes": "default",
        "processors": [
            {
                "name": "synonym",
                "useSystemDictionary": true
            },
            {
                "name": "stop_word",
                "useSystemDictionary": true,
                "interventionDictionary": 980
            }
        ],
        "domain": "GENERAL",
        "created": 1587398402,
        "updated": 1587398402
    }
}

错误码

访问错误中心查看更多错误码。