Queries the resources that are associated with an intervention dictionary. If the intervention dictionary is referenced by query analysis rules, this operation returns all applications that use the intervention dictionary and the information about the query analysis rules.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/intervention-dictionaries/[name]/related HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
name String Path Yes my_dict

The name of the intervention dictionary.

Response parameters

Parameter Type Example Description
requestId String D77D0DAF-790D-F5F5-A9C0-133738165014

The ID of the request.

result List []

The information about each application and each query analysis rule. If no query analysis rule references the intervention dictionary, the value of the result parameter is an empty list.

Parameter

Type

Description

result[].appGroup

String

The name of the application.

result[].queryProcessor

Object

The information about the query analysis rule.

For more information, see QueryProcessor.

Examples

Sample requests

GET /v4/openapi/intervention-dictionaries/my_test/related

Sample success responses

XML format

<requestId>65956EC5-71B8-8A21-2F2E-FBE7E7292AD6</requestId>
<result>
    <appGroup>test_srn_mysql</appGroup>
    <queryProcessor>
        <name>it_content</name>
        <active>true</active>
        <indexes>short_text</indexes>
        <indexes>text_pack</indexes>
        <indexes>short_text_pack</indexes>
        <processors>
            <useSystemDictionary>true</useSystemDictionary>
            <interventionDictionary>tst</interventionDictionary>
            <name>stop_word</name>
        </processors>
        <processors>
            <useSystemDictionary>true</useSystemDictionary>
            <interventionDictionary>test_han_jiuduo_2</interventionDictionary>
            <name>spell_check</name>
        </processors>
        <processors>
            <useSystemDictionary>true</useSystemDictionary>
            <interventionDictionary>test_han_tongyici</interventionDictionary>
            <name>synonym</name>
        </processors>
        <processors>
            <useSystemDictionary>true</useSystemDictionary>
            <interventionDictionary/>
            <name>term_weighting</name>
        </processors>
        <domain>IT_CONTENT</domain>
        <created>1585714793</created>
        <updated>1591163738</updated>
    </queryProcessor>
</result>

JSON format

{
    "requestId": "65956EC5-71B8-8A21-2F2E-FBE7E7292AD6",
    "result": {
        "appGroup": "test_srn_mysql",
        "queryProcessor": {
            "name": "it_content",
            "active": true,
            "indexes": [
                "short_text",
                "text_pack",
                "short_text_pack"
            ],
            "processors": [
                {
                    "useSystemDictionary": true,
                    "interventionDictionary": "tst",
                    "name": "stop_word"
                },
                {
                    "useSystemDictionary": true,
                    "interventionDictionary": "test_han_jiuduo_2",
                    "name": "spell_check"
                },
                {
                    "useSystemDictionary": true,
                    "interventionDictionary": "test_han_tongyici",
                    "name": "synonym"
                },
                {
                    "useSystemDictionary": true,
                    "interventionDictionary": "",
                    "name": "term_weighting"
                }
            ],
            "domain": "IT_CONTENT",
            "created": 1585714793,
            "updated": 1591163738
        }
    }
}

Sample response for no associated resources

**No query analysis rule references the intervention dictionary.**
`{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": []
}`

Error codes

For a list of error codes, visit the API Error Center.