Open topic with navigation

# CategorySuggestFromText

Returns categories that are similar to text that you specify.

## Example

    http://12.3.4.56:9000/action=CategorySuggestFromText&QueryText=Caring for passiflora incarnata

This action uses port `9000` to request categories that are conceptually similar to the text Caring for passiflora incarnata from IDOL Server, which is located on a machine with the IP address `12.3.4.56`.

    http://12.3.4.56:9000/action=CategorySuggestFromText&TaxonomyName=RecipesTaxonomy&QueryText=summer dinner party

This action requests categories within `RecipesTaxonomy` that are conceptually similar to summer dinner party.

By default, this action operates by sending a Query action to the Agentstore, but it can send a SuggestOnText action instead, by using the UseSuggestOnText parameter. SuggestOnText and Query work slightly differently. SuggestOnText is faster, but Query is more accurate. Reducing the MaxQueryTerms when UseSuggestOnText is set to `False` (the default) speeds up the `CategorySuggestFromText` action, but reduces accuracy.

## Parameters

Parameter | Description | Required
--- | --- | ---
AgentBoolean | Whether to use Boolean restrictions for a category. |
AnyLanguage | Whether to retrieve categories that were stored in all languages. |
Databases | Restricts results to a specific category database. |
DocRef | The references of the documents to suggest on. |
FieldText | A field restriction to apply to results. |
FullPathOnly | Whether to return only the full path from the schema root to the category. This parameter applies only when you set ShowCategoryPath to `True`. |
IgnoreSpecials | Whether to ignore special characters in the query. |
IncludeTopLevel | Whether to include the top level category in a path that shows the position of the category. This parameter applies only when you set ShowCategoryPath to `True`. |
MaxQueryTerms | The maximum number of terms to use in the query. |
NumResults | The number of results to return. |
Params | Query action parameters to add. |
PrintFields | Whether to display category fields. |
QueryText | The text that you want to use to suggest categories. | Yes
Schema | The ID of the category to set as the root for the hierarchy, to restrict the results to this category and its descendants. |
ShowCategoryPath | Whether to show each returned category in its place in the category hierarchy. |
TaxonomyName | Restricts the results to a category within the specified taxonomy. |
TextParse | Whether to treat the document as XML or IDX. |
Threshold | The relevance threshold of the result categories. |
UserName | The name of the user that sends the action. |
UseSuggestOnText | Whether to send a SuggestOnText action to Agentstore instead of a Query action. |
Values | Values for the specified Params. |

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.

© 2017 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm