CategoryExpandTopics
Allows you to expand a query that might contain category topic names into a full query, which replaces the category names with the queries that they represent.
NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the Admin
standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.
NOTE: CategoryExpandTopics
works only with categories that have Boolean training. For example, if you have a category A with training cat AND dog
and category B with training apples AND bananas
, sending the CategoryExpandTopics
action with Expand set to A AND B
would result in IDOL Category Component expanding this string to cat AND dog AND apples AND bananas
.
Example
http://localhost:9020/action=CategoryExpandTopics&Expand=genome
This action returns the expanded query represented by the topic genome
.
Optional Parameters
This action accepts the following optional parameters.
Parameter | Description |
---|---|
AndQuery | Whether to query the data index with the expanded query. |
Expand | The query text to expand. |
Explicit | Whether to expand only those topics that have explicit topic syntax. |
Schema | Restrict the expansion to topics in a specific category and its descendants. |
UserName | The name of the user that sends the action. |
This action accepts the following standard ACI action parameters.
Parameter | Description |
---|---|
ActionID | A string to use to identify an ACI action. |
EncryptResponse | Encrypt the output. |
FileName | The file to write output to. |
ForceTemplateRefresh | Forces the server to load the template from disk. |
Output | Writes output to a file. |
ResponseFormat | The format of the action output. |
Template | The template to use for the action output. |
TemplateParamCSVs | A list of variables to use for the specified template. |