ModifyQueryProcessor - 开放搜索

调试

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

请求头

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

请求语法

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

请求参数


名称	类型	位置	是否必选	示例值	描述
appGroupIdentity	String	Path	是	“my_app_group_name”	应用名称
appId	Integer	Path	是	110157886	版本号
name	String	Path	是	“test”	规则名称
dryRun	Boolean	Query	否	true	是否为空运行请求

请求体


字段	类型	是否必要	示例值	描述
domain	String	否	"GENERAL"	行业类型 GENERAL 通用行业 ECOMMERCE 电商 IT_CONTENT IT行业
indexes	Array	否	["default"]	应用的索引范围
processors[]	Object	否		分析规则
active	Boolean	否	true	是否设置为有效

参考：QueryProcessor

返回数据


名称	类型	示例值	描述
requestId	String	D77D0DAF-790D-F5F5-A9C0-133738165014	请求ID
result	Struct		规则信息
active	Boolean	true	是否默认规则
created	Integer	0
domain	String	GENERAL	行业类型 GENERAL 通用 ECOMMERCE 电商 IT_CONTENT IT内容
indexes	List	[ "default" ]	应用的索引范围
name	String	synonym	规则名称
processors	List	[ "default" ]
updated	Integer	1

返回参数


字段	类型	描述
requestId	String	请求ID
result	Object	规则信息参考：QueryProcessor

示例

请求示例

PUT /v4/openapi/app-groups/os_function_test_v1/apps/110157886/query-processors/query_filter


{
    "domain": "GENERAL",
    "processors": [
        {
            "name": "synonym",
            "useSystemDictionary": true
        },
        {
            "name": "stop_word",
            "useSystemDictionary": true
        }
    ]
}

正常返回示例

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>
    </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
            }
        ],
        "domain": "GENERAL",
        "created": 1587398402,
        "updated": 1587398402
    }
}

错误码

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